diff --git a/discovery/admin-directory_v1.json b/discovery/admin-directory_v1.json index ed5692ad74..3ef2d60f39 100644 --- a/discovery/admin-directory_v1.json +++ b/discovery/admin-directory_v1.json @@ -4671,7 +4671,7 @@ } } }, - "revision": "20250930", + "revision": "20251021", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Alias": { @@ -5059,6 +5059,24 @@ }, "type": "object" }, + "BluetoothAdapterInfo": { + "description": "Information about a device's Bluetooth adapter.", + "id": "BluetoothAdapterInfo", + "properties": { + "address": { + "description": "Output only. The MAC address of the adapter.", + "readOnly": true, + "type": "string" + }, + "numConnectedDevices": { + "description": "Output only. The number of devices connected to this adapter.", + "format": "int32", + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, "Building": { "description": "Public API: Resources.buildings", "id": "Building", @@ -5440,6 +5458,14 @@ "readOnly": true, "type": "array" }, + "bluetoothAdapterInfo": { + "description": "Output only. Information about bluetooth adapters of the device.", + "items": { + "$ref": "BluetoothAdapterInfo" + }, + "readOnly": true, + "type": "array" + }, "bootMode": { "description": "The boot mode for the device. The possible values are: * `Verified`: The device is running a valid version of the Chrome OS. * `Dev`: The devices's developer hardware switch is enabled. When booted, the device has a command line shell. For an example of a developer switch, see the [Chromebook developer information](https://www.chromium.org/chromium-os/developer-information-for-chrome-os-devices/samsung-series-5-chromebook#TOC-Developer-switch).", "type": "string" diff --git a/discovery/aiplatform-v1.json b/discovery/aiplatform-v1.json index 10cf6bf149..2a1baf3fbf 100644 --- a/discovery/aiplatform-v1.json +++ b/discovery/aiplatform-v1.json @@ -431,362 +431,315 @@ } } }, - "datasets": { - "methods": { - "create": { - "description": "Creates a Dataset.", - "flatPath": "v1/datasets", - "httpMethod": "POST", - "id": "aiplatform.datasets.create", - "parameterOrder": [], - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the Dataset in. Format: `projects/{project}/locations/{location}`", - "location": "query", - "type": "string" - } - }, - "path": "v1/datasets", - "request": { - "$ref": "GoogleCloudAiplatformV1Dataset" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a Dataset.", - "flatPath": "v1/datasets/{datasetsId}", - "httpMethod": "DELETE", - "id": "aiplatform.datasets.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The resource name of the Dataset to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", - "location": "path", - "pattern": "^datasets/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets a Dataset.", - "flatPath": "v1/datasets/{datasetsId}", - "httpMethod": "GET", - "id": "aiplatform.datasets.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the Dataset resource.", - "location": "path", - "pattern": "^datasets/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1Dataset" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists Datasets in a Location.", - "flatPath": "v1/datasets", - "httpMethod": "GET", - "id": "aiplatform.datasets.list", - "parameterOrder": [], - "parameters": { - "filter": { - "description": "An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `display_name`: supports = and != * `metadata_schema_uri`: supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. Some examples: * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"`", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time`", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The name of the Dataset's parent resource. Format: `projects/{project}/locations/{location}`", - "location": "query", - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1/datasets", - "response": { - "$ref": "GoogleCloudAiplatformV1ListDatasetsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "patch": { - "description": "Updates a Dataset.", - "flatPath": "v1/datasets/{datasetsId}", - "httpMethod": "PATCH", - "id": "aiplatform.datasets.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", - "location": "path", - "pattern": "^datasets/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` * `description` * `labels`", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1Dataset" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1Dataset" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, + "customJobs": { "resources": { - "datasetVersions": { + "operations": { "methods": { - "create": { - "description": "Create a version from a Dataset.", - "flatPath": "v1/datasets/{datasetsId}/datasetVersions", + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/customJobs/{customJobsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.datasets.datasetVersions.create", + "id": "aiplatform.customJobs.operations.cancel", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "parent": { - "description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", + "name": { + "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^datasets/[^/]+$", + "pattern": "^customJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+parent}/datasetVersions", - "request": { - "$ref": "GoogleCloudAiplatformV1DatasetVersion" - }, + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { - "description": "Deletes a Dataset version.", - "flatPath": "v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}", + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/customJobs/{customJobsId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.datasets.datasetVersions.delete", + "id": "aiplatform.customJobs.operations.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", + "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^datasets/[^/]+/datasetVersions/[^/]+$", + "pattern": "^customJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { - "description": "Gets a Dataset version.", - "flatPath": "v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}", + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/customJobs/{customJobsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.datasets.datasetVersions.get", + "id": "aiplatform.customJobs.operations.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", + "description": "The name of the operation resource.", "location": "path", - "pattern": "^datasets/[^/]+/datasetVersions/[^/]+$", + "pattern": "^customJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1DatasetVersion" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists DatasetVersions in a Dataset.", - "flatPath": "v1/datasets/{datasetsId}/datasetVersions", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/customJobs/{customJobsId}/operations", "httpMethod": "GET", - "id": "aiplatform.datasets.datasetVersions.list", + "id": "aiplatform.customJobs.operations.list", "parameterOrder": [ - "parent" + "name" ], "parameters": { "filter": { - "description": "Optional. The standard list filter.", + "description": "The standard list filter.", "location": "query", "type": "string" }, - "orderBy": { - "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", - "location": "query", + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^customJobs/[^/]+$", + "required": true, "type": "string" }, "pageSize": { - "description": "Optional. The standard list page size.", + "description": "The standard list page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. The standard list page token.", + "description": "The standard list page token.", "location": "query", "type": "string" }, - "parent": { - "description": "Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/customJobs/{customJobsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.customJobs.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^datasets/[^/]+$", + "pattern": "^customJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, - "readMask": { - "description": "Optional. Mask specifying which fields to read.", - "format": "google-fieldmask", + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", "location": "query", "type": "string" } }, - "path": "v1/{+parent}/datasetVersions", + "path": "v1/{+name}:wait", "response": { - "$ref": "GoogleCloudAiplatformV1ListDatasetVersionsResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "patch": { - "description": "Updates a DatasetVersion.", - "flatPath": "v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}", - "httpMethod": "PATCH", - "id": "aiplatform.datasets.datasetVersions.patch", + } + } + } + } + }, + "dataLabelingJobs": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.dataLabelingJobs.operations.cancel", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", + "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^datasets/[^/]+/datasetVersions/[^/]+$", + "pattern": "^dataLabelingJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" - }, - "updateMask": { - "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name`", - "format": "google-fieldmask", - "location": "query", + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.dataLabelingJobs.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^dataLabelingJobs/[^/]+/operations/[^/]+$", + "required": true, "type": "string" } }, "path": "v1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1DatasetVersion" + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.dataLabelingJobs.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^dataLabelingJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } }, + "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1DatasetVersion" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "restore": { - "description": "Restores a dataset version.", - "flatPath": "v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore", + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/dataLabelingJobs/{dataLabelingJobsId}/operations", "httpMethod": "GET", - "id": "aiplatform.datasets.datasetVersions.restore", + "id": "aiplatform.dataLabelingJobs.operations.list", "parameterOrder": [ "name" ], "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, "name": { - "description": "Required. The name of the DatasetVersion resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", + "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^datasets/[^/]+/datasetVersions/[^/]+$", + "pattern": "^dataLabelingJobs/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.dataLabelingJobs.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^dataLabelingJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" } }, - "path": "v1/{+name}:restore", + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, @@ -798,426 +751,700 @@ } } }, - "endpoints": { + "datasets": { "methods": { - "computeTokens": { - "description": "Return a list of tokens based on the input text.", - "flatPath": "v1/endpoints/{endpointsId}:computeTokens", + "create": { + "description": "Creates a Dataset.", + "flatPath": "v1/datasets", "httpMethod": "POST", - "id": "aiplatform.endpoints.computeTokens", - "parameterOrder": [ - "endpoint" - ], + "id": "aiplatform.datasets.create", + "parameterOrder": [], "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.", - "location": "path", - "pattern": "^endpoints/[^/]+$", - "required": true, + "parent": { + "description": "Required. The resource name of the Location to create the Dataset in. Format: `projects/{project}/locations/{location}`", + "location": "query", "type": "string" } }, - "path": "v1/{+endpoint}:computeTokens", + "path": "v1/datasets", "request": { - "$ref": "GoogleCloudAiplatformV1ComputeTokensRequest" + "$ref": "GoogleCloudAiplatformV1Dataset" }, "response": { - "$ref": "GoogleCloudAiplatformV1ComputeTokensResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "countTokens": { - "description": "Perform a token counting.", - "flatPath": "v1/endpoints/{endpointsId}:countTokens", - "httpMethod": "POST", - "id": "aiplatform.endpoints.countTokens", + "delete": { + "description": "Deletes a Dataset.", + "flatPath": "v1/datasets/{datasetsId}", + "httpMethod": "DELETE", + "id": "aiplatform.datasets.delete", "parameterOrder": [ - "endpoint" + "name" ], "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "name": { + "description": "Required. The resource name of the Dataset to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", "location": "path", - "pattern": "^endpoints/[^/]+$", + "pattern": "^datasets/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+endpoint}:countTokens", - "request": { - "$ref": "GoogleCloudAiplatformV1CountTokensRequest" - }, + "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1CountTokensResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "fetchPredictOperation": { - "description": "Fetch an asynchronous online prediction operation.", - "flatPath": "v1/endpoints/{endpointsId}:fetchPredictOperation", - "httpMethod": "POST", - "id": "aiplatform.endpoints.fetchPredictOperation", + "get": { + "description": "Gets a Dataset.", + "flatPath": "v1/datasets/{datasetsId}", + "httpMethod": "GET", + "id": "aiplatform.datasets.get", "parameterOrder": [ - "endpoint" + "name" ], "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`", + "name": { + "description": "Required. The name of the Dataset resource.", "location": "path", - "pattern": "^endpoints/[^/]+$", + "pattern": "^datasets/[^/]+$", "required": true, "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, - "path": "v1/{+endpoint}:fetchPredictOperation", - "request": { - "$ref": "GoogleCloudAiplatformV1FetchPredictOperationRequest" - }, + "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1Dataset" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" + "https://www.googleapis.com/auth/cloud-platform" ] }, - "generateContent": { - "description": "Generate content with multimodal inputs.", - "flatPath": "v1/endpoints/{endpointsId}:generateContent", - "httpMethod": "POST", - "id": "aiplatform.endpoints.generateContent", - "parameterOrder": [ - "model" - ], + "list": { + "description": "Lists Datasets in a Location.", + "flatPath": "v1/datasets", + "httpMethod": "GET", + "id": "aiplatform.datasets.list", + "parameterOrder": [], "parameters": { - "model": { - "description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "location": "path", - "pattern": "^endpoints/[^/]+$", - "required": true, + "filter": { + "description": "An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `display_name`: supports = and != * `metadata_schema_uri`: supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. Some examples: * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"`", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the Dataset's parent resource. Format: `projects/{project}/locations/{location}`", + "location": "query", + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", "type": "string" } }, - "path": "v1/{+model}:generateContent", - "request": { - "$ref": "GoogleCloudAiplatformV1GenerateContentRequest" - }, + "path": "v1/datasets", "response": { - "$ref": "GoogleCloudAiplatformV1GenerateContentResponse" + "$ref": "GoogleCloudAiplatformV1ListDatasetsResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" + "https://www.googleapis.com/auth/cloud-platform" ] }, - "predict": { - "description": "Perform an online prediction.", - "flatPath": "v1/endpoints/{endpointsId}:predict", - "httpMethod": "POST", - "id": "aiplatform.endpoints.predict", + "patch": { + "description": "Updates a Dataset.", + "flatPath": "v1/datasets/{datasetsId}", + "httpMethod": "PATCH", + "id": "aiplatform.datasets.patch", "parameterOrder": [ - "endpoint" + "name" ], "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "name": { + "description": "Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", "location": "path", - "pattern": "^endpoints/[^/]+$", + "pattern": "^datasets/[^/]+$", "required": true, "type": "string" - } - }, - "path": "v1/{+endpoint}:predict", - "request": { - "$ref": "GoogleCloudAiplatformV1PredictRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1PredictResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "predictLongRunning": { - "description": "", - "flatPath": "v1/endpoints/{endpointsId}:predictLongRunning", - "httpMethod": "POST", - "id": "aiplatform.endpoints.predictLongRunning", - "parameterOrder": [ - "endpoint" - ], - "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`", - "location": "path", - "pattern": "^endpoints/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+endpoint}:predictLongRunning", - "request": { - "$ref": "GoogleCloudAiplatformV1PredictLongRunningRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "streamGenerateContent": { - "description": "Generate content with multimodal inputs with streaming support.", - "flatPath": "v1/endpoints/{endpointsId}:streamGenerateContent", - "httpMethod": "POST", - "id": "aiplatform.endpoints.streamGenerateContent", - "parameterOrder": [ - "model" - ], - "parameters": { - "model": { - "description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "location": "path", - "pattern": "^endpoints/[^/]+$", - "required": true, + }, + "updateMask": { + "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` * `description` * `labels`", + "format": "google-fieldmask", + "location": "query", "type": "string" } }, - "path": "v1/{+model}:streamGenerateContent", + "path": "v1/{+name}", "request": { - "$ref": "GoogleCloudAiplatformV1GenerateContentRequest" + "$ref": "GoogleCloudAiplatformV1Dataset" }, "response": { - "$ref": "GoogleCloudAiplatformV1GenerateContentResponse" + "$ref": "GoogleCloudAiplatformV1Dataset" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" + "https://www.googleapis.com/auth/cloud-platform" ] } }, "resources": { - "chat": { - "methods": { - "completions": { - "description": "Exposes an OpenAI-compatible endpoint for chat completions.", - "flatPath": "v1/endpoints/{endpointsId}/chat/completions", - "httpMethod": "POST", - "id": "aiplatform.endpoints.chat.completions", - "parameterOrder": [ - "endpoint" - ], - "parameters": { - "endpoint": { - "description": "Required. The name of the endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "location": "path", - "pattern": "^endpoints/[^/]+$", - "required": true, - "type": "string" + "annotationSpecs": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.datasets.annotationSpecs.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.datasets.annotationSpecs.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.datasets.annotationSpecs.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.datasets.annotationSpecs.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^datasets/[^/]+/annotationSpecs/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.datasets.annotationSpecs.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } - }, - "path": "v1/{+endpoint}/chat/completions", - "request": { - "$ref": "GoogleApiHttpBody" - }, - "response": { - "$ref": "GoogleApiHttpBody" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - } - } - } - } - }, - "media": { - "methods": { - "upload": { - "description": "Upload a file into a RagCorpus.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles:upload", - "httpMethod": "POST", - "id": "aiplatform.media.upload", - "mediaUpload": { - "accept": [ - "*/*" - ], - "protocols": { - "simple": { - "multipart": true, - "path": "/upload/v1/{+parent}/ragFiles:upload" } } - }, - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The name of the RagCorpus resource into which to upload the file. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/ragFiles:upload", - "request": { - "$ref": "GoogleCloudAiplatformV1UploadRagFileRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1UploadRagFileResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "supportsMediaUpload": true - } - } - }, - "projects": { - "methods": { - "getCacheConfig": { - "description": "Gets a GenAI cache config.", - "flatPath": "v1/projects/{projectsId}/cacheConfig", - "httpMethod": "GET", - "id": "aiplatform.projects.getCacheConfig", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. Name of the cache config. Format: - `projects/{project}/cacheConfig`.", - "location": "path", - "pattern": "^projects/[^/]+/cacheConfig$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1CacheConfig" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + } }, - "updateCacheConfig": { - "description": "Updates a cache config.", - "flatPath": "v1/projects/{projectsId}/cacheConfig", - "httpMethod": "PATCH", - "id": "aiplatform.projects.updateCacheConfig", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Identifier. Name of the cache config. Format: - `projects/{project}/cacheConfig`.", - "location": "path", - "pattern": "^projects/[^/]+/cacheConfig$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1CacheConfig" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "locations": { - "methods": { - "augmentPrompt": { - "description": "Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:augmentPrompt", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.augmentPrompt", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the Location from which to augment prompt. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" + "dataItems": { + "resources": { + "annotations": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.datasets.dataItems.annotations.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.datasets.dataItems.annotations.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.datasets.dataItems.annotations.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.datasets.dataItems.annotations.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.datasets.dataItems.annotations.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } - }, - "path": "v1/{+parent}:augmentPrompt", - "request": { - "$ref": "GoogleCloudAiplatformV1AugmentPromptRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1AugmentPromptResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + } }, - "corroborateContent": { - "description": "Given an input text, it returns a score that evaluates the factuality of the text. It also extracts and returns claims from the text and provides supporting facts.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:corroborateContent", + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.datasets.dataItems.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.datasets.dataItems.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.datasets.dataItems.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/datasets/{datasetsId}/dataItems/{dataItemsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.datasets.dataItems.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^datasets/[^/]+/dataItems/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.datasets.dataItems.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "datasetVersions": { + "methods": { + "create": { + "description": "Create a version from a Dataset.", + "flatPath": "v1/datasets/{datasetsId}/datasetVersions", "httpMethod": "POST", - "id": "aiplatform.projects.locations.corroborateContent", + "id": "aiplatform.datasets.datasetVersions.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { - "description": "Required. The resource name of the Location from which to corroborate text. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.", + "description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^datasets/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+parent}:corroborateContent", + "path": "v1/{+parent}/datasetVersions", "request": { - "$ref": "GoogleCloudAiplatformV1CorroborateContentRequest" + "$ref": "GoogleCloudAiplatformV1DatasetVersion" }, "response": { - "$ref": "GoogleCloudAiplatformV1CorroborateContentResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "deploy": { - "description": "Deploys a model to a new endpoint.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:deploy", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.deploy", + "delete": { + "description": "Deletes a Dataset version.", + "flatPath": "v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}", + "httpMethod": "DELETE", + "id": "aiplatform.datasets.datasetVersions.delete", "parameterOrder": [ - "destination" + "name" ], "parameters": { - "destination": { - "description": "Required. The resource name of the Location to deploy the model in. Format: `projects/{project}/locations/{location}`", + "name": { + "description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^datasets/[^/]+/datasetVersions/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+destination}:deploy", - "request": { - "$ref": "GoogleCloudAiplatformV1DeployRequest" - }, + "path": "v1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, @@ -1225,264 +1452,297 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "evaluateDataset": { - "description": "Evaluates a dataset based on a set of given metrics.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:evaluateDataset", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.evaluateDataset", + "get": { + "description": "Gets a Dataset version.", + "flatPath": "v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}", + "httpMethod": "GET", + "id": "aiplatform.datasets.datasetVersions.get", "parameterOrder": [ - "location" + "name" ], "parameters": { - "location": { - "description": "Required. The resource name of the Location to evaluate the dataset. Format: `projects/{project}/locations/{location}`", + "name": { + "description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^datasets/[^/]+/datasetVersions/[^/]+$", "required": true, "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, - "path": "v1/{+location}:evaluateDataset", - "request": { - "$ref": "GoogleCloudAiplatformV1EvaluateDatasetRequest" - }, + "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1DatasetVersion" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "evaluateInstances": { - "description": "Evaluates instances based on a given metric.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:evaluateInstances", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.evaluateInstances", + "list": { + "description": "Lists DatasetVersions in a Dataset.", + "flatPath": "v1/datasets/{datasetsId}/datasetVersions", + "httpMethod": "GET", + "id": "aiplatform.datasets.datasetVersions.list", "parameterOrder": [ - "location" + "parent" ], "parameters": { - "location": { - "description": "Required. The resource name of the Location to evaluate the instances. Format: `projects/{project}/locations/{location}`", + "filter": { + "description": "Optional. The standard list filter.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^datasets/[^/]+$", "required": true, "type": "string" + }, + "readMask": { + "description": "Optional. Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, - "path": "v1/{+location}:evaluateInstances", - "request": { - "$ref": "GoogleCloudAiplatformV1EvaluateInstancesRequest" - }, + "path": "v1/{+parent}/datasetVersions", "response": { - "$ref": "GoogleCloudAiplatformV1EvaluateInstancesResponse" + "$ref": "GoogleCloudAiplatformV1ListDatasetVersionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "generateInstanceRubrics": { - "description": "Generates rubrics for a given prompt. A rubric represents a single testable criterion for evaluation. One input prompt could have multiple rubrics This RPC allows users to get suggested rubrics based on provided prompt, which can then be reviewed and used for subsequent evaluations.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:generateInstanceRubrics", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.generateInstanceRubrics", + "patch": { + "description": "Updates a DatasetVersion.", + "flatPath": "v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}", + "httpMethod": "PATCH", + "id": "aiplatform.datasets.datasetVersions.patch", "parameterOrder": [ - "location" + "name" ], "parameters": { - "location": { - "description": "Required. The resource name of the Location to generate rubrics from. Format: `projects/{project}/locations/{location}`", + "name": { + "description": "Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^datasets/[^/]+/datasetVersions/[^/]+$", "required": true, "type": "string" + }, + "updateMask": { + "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name`", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, - "path": "v1/{+location}:generateInstanceRubrics", + "path": "v1/{+name}", "request": { - "$ref": "GoogleCloudAiplatformV1GenerateInstanceRubricsRequest" + "$ref": "GoogleCloudAiplatformV1DatasetVersion" }, "response": { - "$ref": "GoogleCloudAiplatformV1GenerateInstanceRubricsResponse" + "$ref": "GoogleCloudAiplatformV1DatasetVersion" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "generateSyntheticData": { - "description": "Generates synthetic data based on the provided configuration.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:generateSyntheticData", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.generateSyntheticData", + "restore": { + "description": "Restores a dataset version.", + "flatPath": "v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore", + "httpMethod": "GET", + "id": "aiplatform.datasets.datasetVersions.restore", "parameterOrder": [ - "location" + "name" ], "parameters": { - "location": { - "description": "Required. The resource name of the Location to run the job. Format: `projects/{project}/locations/{location}`", + "name": { + "description": "Required. The name of the DatasetVersion resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^datasets/[^/]+/datasetVersions/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+location}:generateSyntheticData", - "request": { - "$ref": "GoogleCloudAiplatformV1GenerateSyntheticDataRequest" + "path": "v1/{+name}:restore", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/datasets/{datasetsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.datasets.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^datasets/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } }, + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleCloudAiplatformV1GenerateSyntheticDataResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "get": { - "description": "Gets information about a location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.get", + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/datasets/{datasetsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.datasets.operations.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Resource name for the location.", + "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^datasets/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudLocationLocation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "getRagEngineConfig": { - "description": "Gets a RagEngineConfig.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig", + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/datasets/{datasetsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.getRagEngineConfig", + "id": "aiplatform.datasets.operations.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the RagEngineConfig resource. Format: `projects/{project}/locations/{location}/ragEngineConfig`", + "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig$", + "pattern": "^datasets/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1RagEngineConfig" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists information about the supported locations for this service.", - "flatPath": "v1/projects/{projectsId}/locations", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/datasets/{datasetsId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.list", + "id": "aiplatform.datasets.operations.list", "parameterOrder": [ "name" ], "parameters": { - "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", - "location": "query", - "repeated": true, - "type": "string" - }, "filter": { - "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", + "description": "The standard list filter.", "location": "query", "type": "string" }, "name": { - "description": "The resource that owns the locations collection, if applicable.", + "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+$", + "pattern": "^datasets/[^/]+$", "required": true, "type": "string" }, "pageSize": { - "description": "The maximum number of results to return. If not set, the service selects a default.", + "description": "The standard list page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", + "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, - "path": "v1/{+name}/locations", + "path": "v1/{+name}/operations", "response": { - "$ref": "GoogleCloudLocationListLocationsResponse" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "retrieveContexts": { - "description": "Retrieves relevant contexts for a query.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:retrieveContexts", + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/datasets/{datasetsId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.retrieveContexts", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}:retrieveContexts", - "request": { - "$ref": "GoogleCloudAiplatformV1RetrieveContextsRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1RetrieveContextsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "updateRagEngineConfig": { - "description": "Updates a RagEngineConfig.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.updateRagEngineConfig", + "id": "aiplatform.datasets.operations.wait", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Identifier. The name of the RagEngineConfig. Format: `projects/{project}/locations/{location}/ragEngineConfig`", + "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig$", + "pattern": "^datasets/[^/]+/operations/[^/]+$", "required": true, "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" } }, - "path": "v1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1RagEngineConfig" - }, + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, @@ -1490,31 +1750,30 @@ "https://www.googleapis.com/auth/cloud-platform" ] } - }, + } + }, + "savedQueries": { "resources": { - "batchPredictionJobs": { + "operations": { "methods": { "cancel": { - "description": "Cancels a BatchPredictionJob. Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetBatchPredictionJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its BatchPredictionJob.state is set to `CANCELLED`. Any files already outputted by the job are not deleted.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}:cancel", + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.batchPredictionJobs.cancel", + "id": "aiplatform.datasets.savedQueries.operations.cancel", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the BatchPredictionJob to cancel. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`", + "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$", + "pattern": "^datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}:cancel", - "request": { - "$ref": "GoogleCloudAiplatformV1CancelBatchPredictionJobRequest" - }, "response": { "$ref": "GoogleProtobufEmpty" }, @@ -1522,98 +1781,77 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "create": { - "description": "Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.batchPredictionJobs.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the BatchPredictionJob in. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/batchPredictionJobs", - "request": { - "$ref": "GoogleCloudAiplatformV1BatchPredictionJob" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1BatchPredictionJob" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "delete": { - "description": "Deletes a BatchPredictionJob. Can only be called on jobs that already finished.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}", + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.batchPredictionJobs.delete", + "id": "aiplatform.datasets.savedQueries.operations.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the BatchPredictionJob resource to be deleted. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`", + "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$", + "pattern": "^datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { - "description": "Gets a BatchPredictionJob", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}", + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.batchPredictionJobs.get", + "id": "aiplatform.datasets.savedQueries.operations.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the BatchPredictionJob resource. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`", + "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$", + "pattern": "^datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1BatchPredictionJob" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists BatchPredictionJobs in a Location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.batchPredictionJobs.list", + "id": "aiplatform.datasets.savedQueries.operations.list", "parameterOrder": [ - "parent" + "name" ], "parameters": { "filter": { - "description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `model_display_name` supports `=`, `!=` comparisons. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`", + "description": "The standard list filter.", "location": "query", "type": "string" }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^datasets/[^/]+/savedQueries/[^/]+$", + "required": true, + "type": "string" + }, "pageSize": { "description": "The standard list page size.", "format": "int32", @@ -1621,626 +1859,692 @@ "type": "integer" }, "pageToken": { - "description": "The standard list page token. Typically obtained via ListBatchPredictionJobsResponse.next_page_token of the previous JobService.ListBatchPredictionJobs call.", + "description": "The standard list page token.", "location": "query", "type": "string" }, - "parent": { - "description": "Required. The resource name of the Location to list the BatchPredictionJobs from. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+parent}/batchPredictionJobs", - "response": { - "$ref": "GoogleCloudAiplatformV1ListBatchPredictionJobsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, - "cachedContents": { - "methods": { - "create": { - "description": "Creates cached content, this call will initialize the cached content in the data storage, and users need to pay for the cache data storage.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cachedContents", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.cachedContents.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The parent resource where the cached content will be created", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/cachedContents", - "request": { - "$ref": "GoogleCloudAiplatformV1CachedContent" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1CachedContent" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes cached content", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.cachedContents.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The resource name referring to the cached content", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/cachedContents/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets cached content configurations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.cachedContents.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The resource name referring to the cached content", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/cachedContents/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1CachedContent" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists cached contents in a project", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cachedContents", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.cachedContents.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "Optional. The maximum number of cached contents to return. The service may return fewer than this value. If unspecified, some default (under maximum) number of items will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. A page token, received from a previous `ListCachedContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCachedContents` must match the call that provided the page token.", + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent, which owns this collection of cached contents.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" + "type": "boolean" } }, - "path": "v1/{+parent}/cachedContents", + "path": "v1/{+name}/operations", "response": { - "$ref": "GoogleCloudAiplatformV1ListCachedContentsResponse" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "patch": { - "description": "Updates cached content configurations", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.cachedContents.patch", + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.datasets.savedQueries.operations.wait", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content}", + "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/cachedContents/[^/]+$", + "pattern": "^datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, - "updateMask": { - "description": "Required. The list of fields to update.", - "format": "google-fieldmask", + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", "location": "query", "type": "string" } }, - "path": "v1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1CachedContent" - }, + "path": "v1/{+name}:wait", "response": { - "$ref": "GoogleCloudAiplatformV1CachedContent" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } + } + } + } + } + }, + "deploymentResourcePools": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.deploymentResourcePools.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^deploymentResourcePools/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "customJobs": { - "methods": { - "cancel": { - "description": "Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetCustomJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the CustomJob is not deleted; instead it becomes a job with a CustomJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and CustomJob.state is set to `CANCELLED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.customJobs.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the CustomJob to cancel. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:cancel", - "request": { - "$ref": "GoogleCloudAiplatformV1CancelCustomJobRequest" - }, - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.deploymentResourcePools.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^deploymentResourcePools/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.deploymentResourcePools.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^deploymentResourcePools/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/deploymentResourcePools/{deploymentResourcePoolsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.deploymentResourcePools.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" }, - "create": { - "description": "Creates a CustomJob. A created CustomJob right away will be attempted to be run.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.customJobs.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/customJobs", - "request": { - "$ref": "GoogleCloudAiplatformV1CustomJob" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1CustomJob" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^deploymentResourcePools/[^/]+$", + "required": true, + "type": "string" }, - "delete": { - "description": "Deletes a CustomJob.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.customJobs.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the CustomJob resource to be deleted. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" }, - "get": { - "description": "Gets a CustomJob.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.customJobs.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the CustomJob resource. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1CustomJob" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" }, - "list": { - "description": "Lists CustomJobs in a Location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.customJobs.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token. Typically obtained via ListCustomJobsResponse.next_page_token of the previous JobService.ListCustomJobs call.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Location to list the CustomJobs from. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+parent}/customJobs", - "response": { - "$ref": "GoogleCloudAiplatformV1ListCustomJobsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.customJobs.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.customJobs.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.customJobs.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.customJobs.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.customJobs.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.deploymentResourcePools.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^deploymentResourcePools/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" } - } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "endpoints": { + "methods": { + "computeTokens": { + "description": "Return a list of tokens based on the input text.", + "flatPath": "v1/endpoints/{endpointsId}:computeTokens", + "httpMethod": "POST", + "id": "aiplatform.endpoints.computeTokens", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.", + "location": "path", + "pattern": "^endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:computeTokens", + "request": { + "$ref": "GoogleCloudAiplatformV1ComputeTokensRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1ComputeTokensResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "countTokens": { + "description": "Perform a token counting.", + "flatPath": "v1/endpoints/{endpointsId}:countTokens", + "httpMethod": "POST", + "id": "aiplatform.endpoints.countTokens", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:countTokens", + "request": { + "$ref": "GoogleCloudAiplatformV1CountTokensRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1CountTokensResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "fetchPredictOperation": { + "description": "Fetch an asynchronous online prediction operation.", + "flatPath": "v1/endpoints/{endpointsId}:fetchPredictOperation", + "httpMethod": "POST", + "id": "aiplatform.endpoints.fetchPredictOperation", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`", + "location": "path", + "pattern": "^endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:fetchPredictOperation", + "request": { + "$ref": "GoogleCloudAiplatformV1FetchPredictOperationRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "generateContent": { + "description": "Generate content with multimodal inputs.", + "flatPath": "v1/endpoints/{endpointsId}:generateContent", + "httpMethod": "POST", + "id": "aiplatform.endpoints.generateContent", + "parameterOrder": [ + "model" + ], + "parameters": { + "model": { + "description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+model}:generateContent", + "request": { + "$ref": "GoogleCloudAiplatformV1GenerateContentRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1GenerateContentResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "predict": { + "description": "Perform an online prediction.", + "flatPath": "v1/endpoints/{endpointsId}:predict", + "httpMethod": "POST", + "id": "aiplatform.endpoints.predict", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:predict", + "request": { + "$ref": "GoogleCloudAiplatformV1PredictRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1PredictResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "predictLongRunning": { + "description": "", + "flatPath": "v1/endpoints/{endpointsId}:predictLongRunning", + "httpMethod": "POST", + "id": "aiplatform.endpoints.predictLongRunning", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`", + "location": "path", + "pattern": "^endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:predictLongRunning", + "request": { + "$ref": "GoogleCloudAiplatformV1PredictLongRunningRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "streamGenerateContent": { + "description": "Generate content with multimodal inputs with streaming support.", + "flatPath": "v1/endpoints/{endpointsId}:streamGenerateContent", + "httpMethod": "POST", + "id": "aiplatform.endpoints.streamGenerateContent", + "parameterOrder": [ + "model" + ], + "parameters": { + "model": { + "description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+model}:streamGenerateContent", + "request": { + "$ref": "GoogleCloudAiplatformV1GenerateContentRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1GenerateContentResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + }, + "resources": { + "chat": { + "methods": { + "completions": { + "description": "Exposes an OpenAI-compatible endpoint for chat completions.", + "flatPath": "v1/endpoints/{endpointsId}/chat/completions", + "httpMethod": "POST", + "id": "aiplatform.endpoints.chat.completions", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}/chat/completions", + "request": { + "$ref": "GoogleApiHttpBody" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/endpoints/{endpointsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.endpoints.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^endpoints/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "dataLabelingJobs": { - "methods": { - "cancel": { - "description": "Cancels a DataLabelingJob. Success of cancellation is not guaranteed.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.dataLabelingJobs.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:cancel", - "request": { - "$ref": "GoogleCloudAiplatformV1CancelDataLabelingJobRequest" - }, - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/endpoints/{endpointsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.endpoints.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^endpoints/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/endpoints/{endpointsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.endpoints.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^endpoints/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/endpoints/{endpointsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.endpoints.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" }, - "create": { - "description": "Creates a DataLabelingJob.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.dataLabelingJobs.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The parent of the DataLabelingJob. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/dataLabelingJobs", - "request": { - "$ref": "GoogleCloudAiplatformV1DataLabelingJob" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1DataLabelingJob" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^endpoints/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/endpoints/{endpointsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.endpoints.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^endpoints/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "featureGroups": { + "resources": { + "features": { + "resources": { + "operations": { + "methods": { "delete": { - "description": "Deletes a DataLabelingJob.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}", + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.dataLabelingJobs.delete", + "id": "aiplatform.featureGroups.features.operations.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the DataLabelingJob to be deleted. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`", + "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$", + "pattern": "^featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { - "description": "Gets a DataLabelingJob.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}", + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.dataLabelingJobs.get", + "id": "aiplatform.featureGroups.features.operations.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`", + "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$", + "pattern": "^featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1DataLabelingJob" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "list": { - "description": "Lists DataLabelingJobs in a Location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs", + "listWait": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait", "httpMethod": "GET", - "id": "aiplatform.projects.locations.dataLabelingJobs.list", + "id": "aiplatform.featureGroups.features.operations.listWait", "parameterOrder": [ - "parent" + "name" ], "parameters": { "filter": { - "description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`", + "description": "The standard list filter.", "location": "query", "type": "string" }, - "orderBy": { - "description": "A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.", - "location": "query", + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", + "required": true, "type": "string" }, "pageSize": { @@ -2254,37 +2558,471 @@ "location": "query", "type": "string" }, - "parent": { - "description": "Required. The parent of the DataLabelingJob. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.featureGroups.features.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, - "readMask": { - "description": "Mask specifying which fields to read. FieldMask represents a set of symbolic field paths. For example, the mask can be `paths: \"name\"`. The \"name\" here is a field in DataLabelingJob. If this field is not set, all fields of the DataLabelingJob are returned.", - "format": "google-fieldmask", + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", "location": "query", "type": "string" } }, - "path": "v1/{+parent}/dataLabelingJobs", + "path": "v1/{+name}:wait", "response": { - "$ref": "GoogleCloudAiplatformV1ListDataLabelingJobsResponse" + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "operations": { + "methods": { + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/featureGroups/{featureGroupsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.featureGroups.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^featureGroups/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/featureGroups/{featureGroupsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.featureGroups.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^featureGroups/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "listWait": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/featureGroups/{featureGroupsId}/operations/{operationsId}:wait", + "httpMethod": "GET", + "id": "aiplatform.featureGroups.operations.listWait", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^featureGroups/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/featureGroups/{featureGroupsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.featureGroups.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^featureGroups/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "featureOnlineStores": { + "resources": { + "featureViews": { + "resources": { + "operations": { + "methods": { + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.featureOnlineStores.featureViews.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.featureOnlineStores.featureViews.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "listWait": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}:wait", + "httpMethod": "GET", + "id": "aiplatform.featureOnlineStores.featureViews.operations.listWait", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.featureOnlineStores.featureViews.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } + } + } + } + }, + "operations": { + "methods": { + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.featureOnlineStores.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^featureOnlineStores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.featureOnlineStores.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^featureOnlineStores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "listWait": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}:wait", + "httpMethod": "GET", + "id": "aiplatform.featureOnlineStores.operations.listWait", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^featureOnlineStores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.featureOnlineStores.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^featureOnlineStores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "featurestores": { + "resources": { + "entityTypes": { + "resources": { + "features": { "resources": { "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:cancel", + "flatPath": "v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.dataLabelingJobs.operations.cancel", + "id": "aiplatform.featurestores.entityTypes.features.operations.cancel", "parameterOrder": [ "name" ], @@ -2292,7 +3030,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$", + "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -2307,9 +3045,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}", + "flatPath": "v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.dataLabelingJobs.operations.delete", + "id": "aiplatform.featurestores.entityTypes.features.operations.delete", "parameterOrder": [ "name" ], @@ -2317,7 +3055,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$", + "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -2332,9 +3070,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}", + "flatPath": "v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.dataLabelingJobs.operations.get", + "id": "aiplatform.featurestores.entityTypes.features.operations.get", "parameterOrder": [ "name" ], @@ -2342,7 +3080,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$", + "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -2357,9 +3095,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations", + "flatPath": "v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.dataLabelingJobs.operations.list", + "id": "aiplatform.featurestores.entityTypes.features.operations.list", "parameterOrder": [ "name" ], @@ -2372,7 +3110,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$", + "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$", "required": true, "type": "string" }, @@ -2403,9 +3141,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:wait", + "flatPath": "v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.dataLabelingJobs.operations.wait", + "id": "aiplatform.featurestores.entityTypes.features.operations.wait", "parameterOrder": [ "name" ], @@ -2413,7 +3151,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$", + "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -2436,82 +3174,76 @@ } } }, - "datasets": { + "operations": { "methods": { - "create": { - "description": "Creates a Dataset.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets", + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.datasets.create", + "id": "aiplatform.featurestores.entityTypes.operations.cancel", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the Dataset in. Format: `projects/{project}/locations/{location}`", + "name": { + "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+parent}/datasets", - "request": { - "$ref": "GoogleCloudAiplatformV1Dataset" - }, + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { - "description": "Deletes a Dataset.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}", + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.datasets.delete", + "id": "aiplatform.featurestores.entityTypes.operations.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The resource name of the Dataset to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", + "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "export": { - "description": "Exports data from a Dataset.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:export", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.datasets.export", + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.featurestores.entityTypes.operations.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", + "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+name}:export", - "request": { - "$ref": "GoogleCloudAiplatformV1ExportDataRequest" - }, + "path": "v1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, @@ -2519,4290 +3251,8722 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "get": { - "description": "Gets a Dataset.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}", + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.datasets.get", + "id": "aiplatform.featurestores.entityTypes.operations.list", "parameterOrder": [ "name" ], "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, "name": { - "description": "Required. The name of the Dataset resource.", + "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "pattern": "^featurestores/[^/]+/entityTypes/[^/]+$", "required": true, "type": "string" }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, - "path": "v1/{+name}", + "path": "v1/{+name}/operations", "response": { - "$ref": "GoogleCloudAiplatformV1Dataset" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "import": { - "description": "Imports data into a Dataset.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:import", + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.datasets.import", + "id": "aiplatform.featurestores.entityTypes.operations.wait", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", + "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", "required": true, "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" } }, - "path": "v1/{+name}:import", - "request": { - "$ref": "GoogleCloudAiplatformV1ImportDataRequest" - }, + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + } + } + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/featurestores/{featurestoresId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.featurestores.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^featurestores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/featurestores/{featurestoresId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.featurestores.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^featurestores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/featurestores/{featurestoresId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.featurestores.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^featurestores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/featurestores/{featurestoresId}/operations", + "httpMethod": "GET", + "id": "aiplatform.featurestores.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" }, - "list": { - "description": "Lists Datasets in a Location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.datasets.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `display_name`: supports = and != * `metadata_schema_uri`: supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. Some examples: * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"`", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time`", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The name of the Dataset's parent resource. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+parent}/datasets", - "response": { - "$ref": "GoogleCloudAiplatformV1ListDatasetsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "patch": { - "description": "Updates a Dataset.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.datasets.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` * `description` * `labels`", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1Dataset" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1Dataset" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^featurestores/[^/]+$", + "required": true, + "type": "string" }, - "searchDataItems": { - "description": "Searches DataItems in a Dataset.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:searchDataItems", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.datasets.searchDataItems", - "parameterOrder": [ - "dataset" - ], - "parameters": { - "annotationFilters": { - "description": "An expression that specifies what Annotations will be returned per DataItem. Annotations satisfied either of the conditions will be returned. * `annotation_spec_id` - for = or !=. Must specify `saved_query_id=` - saved query id that annotations should belong to.", - "location": "query", - "repeated": true, - "type": "string" - }, - "annotationsFilter": { - "deprecated": true, - "description": "An expression for filtering the Annotations that will be returned per DataItem. * `annotation_spec_id` - for = or !=.", - "location": "query", - "type": "string" - }, - "annotationsLimit": { - "description": "If set, only up to this many of Annotations will be returned per DataItemView. The maximum value is 1000. If not set, the maximum value will be used.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "dataItemFilter": { - "description": "An expression for filtering the DataItem that will be returned. * `data_item_id` - for = or !=. * `labeled` - for = or !=. * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that have at least one annotation with annotation_spec_id = `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob. For example: * `data_item=1` * `has_annotation(5)`", - "location": "query", - "type": "string" - }, - "dataLabelingJob": { - "description": "The resource name of a DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` If this field is set, all of the search will be done in the context of this DataLabelingJob.", - "location": "query", - "type": "string" - }, - "dataset": { - "description": "Required. The resource name of the Dataset from which to search DataItems. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", - "required": true, - "type": "string" - }, - "fieldMask": { - "description": "Mask specifying which fields of DataItemView to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - }, - "orderBy": { - "deprecated": true, - "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", - "location": "query", - "type": "string" - }, - "orderByAnnotation.orderBy": { - "description": "A comma-separated list of annotation fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Must also specify saved_query.", - "location": "query", - "type": "string" - }, - "orderByAnnotation.savedQuery": { - "description": "Required. Saved query of the Annotation. Only Annotations belong to this saved query will be considered for ordering.", - "location": "query", - "type": "string" - }, - "orderByDataItem": { - "description": "A comma-separated list of data item fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Requested page size. Server may return fewer results than requested. Default and maximum page size is 100.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A token identifying a page of results for the server to return Typically obtained via SearchDataItemsResponse.next_page_token of the previous DatasetService.SearchDataItems call.", - "location": "query", - "type": "string" - }, - "savedQuery": { - "deprecated": true, - "description": "The resource name of a SavedQuery(annotation set in UI). Format: `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}` All of the search will be done in the context of this SavedQuery.", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+dataset}:searchDataItems", - "response": { - "$ref": "GoogleCloudAiplatformV1SearchDataItemsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, - "resources": { - "annotationSpecs": { - "methods": { - "get": { - "description": "Gets an AnnotationSpec.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.datasets.annotationSpecs.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the AnnotationSpec resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1AnnotationSpec" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/featurestores/{featurestoresId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.featurestores.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^featurestores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" }, - "dataItems": { - "methods": { - "list": { - "description": "Lists DataItems in a Dataset.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.datasets.dataItems.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Dataset to list DataItems from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+parent}/dataItems", - "response": { - "$ref": "GoogleCloudAiplatformV1ListDataItemsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "annotations": { - "methods": { - "list": { - "description": "Lists Annotations belongs to a dataitem.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.datasets.dataItems.annotations.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the DataItem to list Annotations from. Format: `projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+parent}/annotations", - "response": { - "$ref": "GoogleCloudAiplatformV1ListAnnotationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - }, - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.datasets.dataItems.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.datasets.dataItems.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.datasets.dataItems.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.datasets.dataItems.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.datasets.dataItems.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "hyperparameterTuningJobs": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.hyperparameterTuningJobs.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^hyperparameterTuningJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.hyperparameterTuningJobs.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^hyperparameterTuningJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.hyperparameterTuningJobs.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^hyperparameterTuningJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.hyperparameterTuningJobs.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" }, - "datasetVersions": { - "methods": { - "create": { - "description": "Create a version from a Dataset.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.datasets.datasetVersions.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/datasetVersions", - "request": { - "$ref": "GoogleCloudAiplatformV1DatasetVersion" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a Dataset version.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.datasets.datasetVersions.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets a Dataset version.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.datasets.datasetVersions.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1DatasetVersion" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists DatasetVersions in a Dataset.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.datasets.datasetVersions.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Optional. The standard list filter.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The standard list page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Optional. Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+parent}/datasetVersions", - "response": { - "$ref": "GoogleCloudAiplatformV1ListDatasetVersionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "patch": { - "description": "Updates a DatasetVersion.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.datasets.datasetVersions.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name`", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1DatasetVersion" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1DatasetVersion" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "restore": { - "description": "Restores a dataset version.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.datasets.datasetVersions.restore", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the DatasetVersion resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:restore", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^hyperparameterTuningJobs/[^/]+$", + "required": true, + "type": "string" }, - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.datasets.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.datasets.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.datasets.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.datasets.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.datasets.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" }, - "savedQueries": { - "methods": { - "delete": { - "description": "Deletes a SavedQuery.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.datasets.savedQueries.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The resource name of the SavedQuery to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists SavedQueries in a Dataset.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.datasets.savedQueries.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Dataset to list SavedQueries from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+parent}/savedQueries", - "response": { - "$ref": "GoogleCloudAiplatformV1ListSavedQueriesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.datasets.savedQueries.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.datasets.savedQueries.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.datasets.savedQueries.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.datasets.savedQueries.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.datasets.savedQueries.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } - } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "deploymentResourcePools": { + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.hyperparameterTuningJobs.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^hyperparameterTuningJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "indexEndpoints": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.indexEndpoints.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^indexEndpoints/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/indexEndpoints/{indexEndpointsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.indexEndpoints.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^indexEndpoints/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/indexEndpoints/{indexEndpointsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.indexEndpoints.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^indexEndpoints/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/indexEndpoints/{indexEndpointsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.indexEndpoints.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^indexEndpoints/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.indexEndpoints.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^indexEndpoints/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "indexes": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/indexes/{indexesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.indexes.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^indexes/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/indexes/{indexesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.indexes.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^indexes/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/indexes/{indexesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.indexes.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^indexes/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/indexes/{indexesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.indexes.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^indexes/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/indexes/{indexesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.indexes.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^indexes/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "media": { + "methods": { + "upload": { + "description": "Upload a file into a RagCorpus.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles:upload", + "httpMethod": "POST", + "id": "aiplatform.media.upload", + "mediaUpload": { + "accept": [ + "*/*" + ], + "protocols": { + "simple": { + "multipart": true, + "path": "/upload/v1/{+parent}/ragFiles:upload" + } + } + }, + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the RagCorpus resource into which to upload the file. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/ragFiles:upload", + "request": { + "$ref": "GoogleCloudAiplatformV1UploadRagFileRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1UploadRagFileResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "supportsMediaUpload": true + } + } + }, + "metadataStores": { + "resources": { + "artifacts": { + "resources": { + "operations": { "methods": { - "create": { - "description": "Create a DeploymentResourcePool.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools", + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.deploymentResourcePools.create", + "id": "aiplatform.metadataStores.artifacts.operations.cancel", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "parent": { - "description": "Required. The parent location resource where this DeploymentResourcePool will be created. Format: `projects/{project}/locations/{location}`", + "name": { + "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+parent}/deploymentResourcePools", - "request": { - "$ref": "GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest" - }, + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { - "description": "Delete a DeploymentResourcePool.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}", + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.deploymentResourcePools.delete", + "id": "aiplatform.metadataStores.artifacts.operations.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the DeploymentResourcePool to delete. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", + "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$", + "pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { - "description": "Get a DeploymentResourcePool.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}", + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.deploymentResourcePools.get", + "id": "aiplatform.metadataStores.artifacts.operations.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the DeploymentResourcePool to retrieve. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", + "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$", + "pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1DeploymentResourcePool" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "List DeploymentResourcePools in a location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.deploymentResourcePools.list", + "id": "aiplatform.metadataStores.artifacts.operations.list", "parameterOrder": [ - "parent" + "name" ], "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^metadataStores/[^/]+/artifacts/[^/]+$", + "required": true, + "type": "string" + }, "pageSize": { - "description": "The maximum number of DeploymentResourcePools to return. The service may return fewer than this value.", + "description": "The standard list page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A page token, received from a previous `ListDeploymentResourcePools` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDeploymentResourcePools` must match the call that provided the page token.", + "description": "The standard list page token.", "location": "query", "type": "string" }, - "parent": { - "description": "Required. The parent Location which owns this collection of DeploymentResourcePools. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, - "path": "v1/{+parent}/deploymentResourcePools", + "path": "v1/{+name}/operations", "response": { - "$ref": "GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "patch": { - "description": "Update a DeploymentResourcePool.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.deploymentResourcePools.patch", + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.metadataStores.artifacts.operations.wait", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", + "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$", + "pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, - "updateMask": { - "description": "Required. The list of fields to update.", - "format": "google-fieldmask", + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", "location": "query", "type": "string" } }, - "path": "v1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1DeploymentResourcePool" - }, + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + } + } + } + } + }, + "contexts": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.metadataStores.contexts.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "queryDeployedModels": { - "description": "List DeployedModels that have been deployed on this DeploymentResourcePool.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}:queryDeployedModels", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.deploymentResourcePools.queryDeployedModels", + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.metadataStores.contexts.operations.delete", "parameterOrder": [ - "deploymentResourcePool" + "name" ], "parameters": { - "deploymentResourcePool": { - "description": "Required. The name of the target DeploymentResourcePool to query. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", + "name": { + "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$", + "pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", "required": true, "type": "string" - }, - "pageSize": { - "description": "The maximum number of DeployedModels to return. The service may return fewer than this value.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous `QueryDeployedModels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryDeployedModels` must match the call that provided the page token.", - "location": "query", + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.metadataStores.contexts.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", + "required": true, "type": "string" } }, - "path": "v1/{+deploymentResourcePool}:queryDeployedModels", + "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1QueryDeployedModelsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.deploymentResourcePools.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.deploymentResourcePools.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.deploymentResourcePools.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.deploymentResourcePools.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.deploymentResourcePools.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - }, - "endpoints": { - "methods": { - "computeTokens": { - "description": "Return a list of tokens based on the input text.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:computeTokens", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.computeTokens", - "parameterOrder": [ - "endpoint" - ], - "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+endpoint}:computeTokens", - "request": { - "$ref": "GoogleCloudAiplatformV1ComputeTokensRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1ComputeTokensResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "countTokens": { - "description": "Perform a token counting.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:countTokens", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.countTokens", - "parameterOrder": [ - "endpoint" - ], - "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+endpoint}:countTokens", - "request": { - "$ref": "GoogleCloudAiplatformV1CountTokensRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1CountTokensResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "create": { - "description": "Creates an Endpoint.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.create", + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.metadataStores.contexts.operations.list", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "endpointId": { - "description": "Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are `[0-9]` with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as `?endpoint_id=12345`. This is the fallback for fields that are not included in either the URI or the body.", + "filter": { + "description": "The standard list filter.", "location": "query", "type": "string" }, - "parent": { - "description": "Required. The resource name of the Location to create the Endpoint in. Format: `projects/{project}/locations/{location}`", + "name": { + "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^metadataStores/[^/]+/contexts/[^/]+$", "required": true, "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, - "path": "v1/{+parent}/endpoints", - "request": { - "$ref": "GoogleCloudAiplatformV1Endpoint" - }, + "path": "v1/{+name}/operations", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "delete": { - "description": "Deletes an Endpoint.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.endpoints.delete", + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.metadataStores.contexts.operations.wait", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the Endpoint resource to be deleted. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", "required": true, "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "deployModel": { - "description": "Deploys a Model into this Endpoint, creating a DeployedModel within it.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:deployModel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.deployModel", - "parameterOrder": [ - "endpoint" - ], - "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint resource into which to deploy a Model. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", - "required": true, + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", "type": "string" } }, - "path": "v1/{+endpoint}:deployModel", - "request": { - "$ref": "GoogleCloudAiplatformV1DeployModelRequest" - }, + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "directPredict": { - "description": "Perform an unary online prediction request to a gRPC model server for Vertex first-party products and frameworks.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directPredict", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.directPredict", - "parameterOrder": [ - "endpoint" - ], - "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+endpoint}:directPredict", - "request": { - "$ref": "GoogleCloudAiplatformV1DirectPredictRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1DirectPredictResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "directRawPredict": { - "description": "Perform an unary online prediction request to a gRPC model server for custom containers.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directRawPredict", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.directRawPredict", - "parameterOrder": [ - "endpoint" - ], - "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+endpoint}:directRawPredict", - "request": { - "$ref": "GoogleCloudAiplatformV1DirectRawPredictRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1DirectRawPredictResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "explain": { - "description": "Perform an online explanation. If deployed_model_id is specified, the corresponding DeployModel must have explanation_spec populated. If deployed_model_id is not specified, all DeployedModels must have explanation_spec populated.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:explain", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.explain", - "parameterOrder": [ - "endpoint" - ], - "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the explanation. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+endpoint}:explain", - "request": { - "$ref": "GoogleCloudAiplatformV1ExplainRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1ExplainResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "fetchPredictOperation": { - "description": "Fetch an asynchronous online prediction operation.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:fetchPredictOperation", + } + } + } + } + }, + "executions": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.fetchPredictOperation", + "id": "aiplatform.metadataStores.executions.operations.cancel", "parameterOrder": [ - "endpoint" + "name" ], "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`", + "name": { + "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+endpoint}:fetchPredictOperation", - "request": { - "$ref": "GoogleCloudAiplatformV1FetchPredictOperationRequest" - }, + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningOperation" + "$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" ] }, - "generateContent": { - "description": "Generate content with multimodal inputs.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:generateContent", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.generateContent", + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.metadataStores.executions.operations.delete", "parameterOrder": [ - "model" + "name" ], "parameters": { - "model": { - "description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "name": { + "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+model}:generateContent", - "request": { - "$ref": "GoogleCloudAiplatformV1GenerateContentRequest" - }, + "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1GenerateContentResponse" + "$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": { - "description": "Gets an Endpoint.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}", + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.endpoints.get", + "id": "aiplatform.metadataStores.executions.operations.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the Endpoint resource. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1Endpoint" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists Endpoints in a Location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.endpoints.list", + "id": "aiplatform.metadataStores.executions.operations.list", "parameterOrder": [ - "parent" + "name" ], "parameters": { "filter": { - "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports `=` and `!=`. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * `display_name` supports `=` and `!=`. * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:*` or `labels:key` - key existence * A key including a space must be quoted. `labels.\"a key\"`. * `base_model_name` only supports `=`. Some examples: * `endpoint=1` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"` * `baseModelName=\"text-bison\"`", - "location": "query", - "type": "string" - }, - "gdcZone": { - "description": "Optional. Configures the Google Distributed Cloud (GDC) environment for online prediction. Only set this field when the Endpoint is to be deployed in a GDC environment.", + "description": "The standard list filter.", "location": "query", "type": "string" }, - "orderBy": { - "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.", - "location": "query", + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^metadataStores/[^/]+/executions/[^/]+$", + "required": true, "type": "string" }, "pageSize": { - "description": "Optional. The standard list page size.", + "description": "The standard list page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. The standard list page token. Typically obtained via ListEndpointsResponse.next_page_token of the previous EndpointService.ListEndpoints call.", + "description": "The standard list page token.", "location": "query", "type": "string" }, - "parent": { - "description": "Required. The resource name of the Location from which to list the Endpoints. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Optional. Mask specifying which fields to read.", - "format": "google-fieldmask", + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", - "type": "string" + "type": "boolean" } }, - "path": "v1/{+parent}/endpoints", + "path": "v1/{+name}/operations", "response": { - "$ref": "GoogleCloudAiplatformV1ListEndpointsResponse" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "mutateDeployedModel": { - "description": "Updates an existing deployed model. Updatable fields include `min_replica_count`, `max_replica_count`, `required_replica_count`, `autoscaling_metric_specs`, `disable_container_logging` (v1 only), and `enable_container_logging` (v1beta1 only).", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:mutateDeployedModel", + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.mutateDeployedModel", + "id": "aiplatform.metadataStores.executions.operations.wait", "parameterOrder": [ - "endpoint" + "name" ], "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint resource into which to mutate a DeployedModel. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", "required": true, "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" } }, - "path": "v1/{+endpoint}:mutateDeployedModel", - "request": { - "$ref": "GoogleCloudAiplatformV1MutateDeployedModelRequest" - }, + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + } + } + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/metadataStores/{metadataStoresId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.metadataStores.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^metadataStores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/metadataStores/{metadataStoresId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.metadataStores.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^metadataStores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/metadataStores/{metadataStoresId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.metadataStores.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^metadataStores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/metadataStores/{metadataStoresId}/operations", + "httpMethod": "GET", + "id": "aiplatform.metadataStores.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" }, - "patch": { - "description": "Updates an Endpoint.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.endpoints.patch", + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^metadataStores/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/metadataStores/{metadataStoresId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.metadataStores.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^metadataStores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "migratableResources": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/migratableResources/{migratableResourcesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.migratableResources.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^migratableResources/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/migratableResources/{migratableResourcesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.migratableResources.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^migratableResources/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/migratableResources/{migratableResourcesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.migratableResources.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^migratableResources/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/migratableResources/{migratableResourcesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.migratableResources.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^migratableResources/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/migratableResources/{migratableResourcesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.migratableResources.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^migratableResources/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "modelDeploymentMonitoringJobs": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.modelDeploymentMonitoringJobs.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.modelDeploymentMonitoringJobs.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.modelDeploymentMonitoringJobs.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.modelDeploymentMonitoringJobs.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^modelDeploymentMonitoringJobs/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.modelDeploymentMonitoringJobs.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "models": { + "resources": { + "evaluations": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.models.evaluations.operations.cancel", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Output only. The resource name of the Endpoint.", + "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", "required": true, "type": "string" - }, - "updateMask": { - "description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask.", - "format": "google-fieldmask", - "location": "query", - "type": "string" } }, - "path": "v1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1Endpoint" - }, + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleCloudAiplatformV1Endpoint" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "predict": { - "description": "Perform an online prediction.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predict", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.predict", + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.models.evaluations.operations.delete", "parameterOrder": [ - "endpoint" + "name" ], "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "name": { + "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+endpoint}:predict", - "request": { - "$ref": "GoogleCloudAiplatformV1PredictRequest" - }, + "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1PredictResponse" + "$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" ] }, - "predictLongRunning": { - "description": "", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predictLongRunning", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.predictLongRunning", + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.models.evaluations.operations.get", "parameterOrder": [ - "endpoint" + "name" ], "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`", + "name": { + "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+endpoint}:predictLongRunning", - "request": { - "$ref": "GoogleCloudAiplatformV1PredictLongRunningRequest" - }, + "path": "v1/{+name}", "response": { "$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" ] }, - "rawPredict": { - "description": "Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's DeployedModel that served this prediction.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:rawPredict", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.rawPredict", + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/models/{modelsId}/evaluations/{evaluationsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.models.evaluations.operations.list", "parameterOrder": [ - "endpoint" + "name" ], "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "pattern": "^models/[^/]+/evaluations/[^/]+$", "required": true, "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, - "path": "v1/{+endpoint}:rawPredict", - "request": { - "$ref": "GoogleCloudAiplatformV1RawPredictRequest" - }, + "path": "v1/{+name}/operations", "response": { - "$ref": "GoogleApiHttpBody" + "$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" ] }, - "serverStreamingPredict": { - "description": "Perform a server-side streaming online prediction request for Vertex LLM streaming.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:serverStreamingPredict", + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.serverStreamingPredict", + "id": "aiplatform.models.evaluations.operations.wait", "parameterOrder": [ - "endpoint" + "name" ], "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "name": { + "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", "required": true, "type": "string" - } - }, - "path": "v1/{+endpoint}:serverStreamingPredict", - "request": { - "$ref": "GoogleCloudAiplatformV1StreamingPredictRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1StreamingPredictResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "streamGenerateContent": { - "description": "Generate content with multimodal inputs with streaming support.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamGenerateContent", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.streamGenerateContent", - "parameterOrder": [ - "model" - ], - "parameters": { - "model": { - "description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+model}:streamGenerateContent", - "request": { - "$ref": "GoogleCloudAiplatformV1GenerateContentRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1GenerateContentResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "streamRawPredict": { - "description": "Perform a streaming online prediction with an arbitrary HTTP payload.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamRawPredict", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.streamRawPredict", - "parameterOrder": [ - "endpoint" - ], - "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+endpoint}:streamRawPredict", - "request": { - "$ref": "GoogleCloudAiplatformV1StreamRawPredictRequest" - }, - "response": { - "$ref": "GoogleApiHttpBody" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "undeployModel": { - "description": "Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:undeployModel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.undeployModel", - "parameterOrder": [ - "endpoint" - ], - "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint resource from which to undeploy a Model. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", - "required": true, + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", "type": "string" } }, - "path": "v1/{+endpoint}:undeployModel", - "request": { - "$ref": "GoogleCloudAiplatformV1UndeployModelRequest" - }, + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + } + } + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/models/{modelsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.models.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^models/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/models/{modelsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.models.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^models/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/models/{modelsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.models.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^models/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/models/{modelsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.models.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" }, - "update": { - "description": "Updates an Endpoint with a long running operation.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:update", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.update", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Output only. The resource name of the Endpoint.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:update", - "request": { - "$ref": "GoogleCloudAiplatformV1UpdateEndpointLongRunningRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^models/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, - "resources": { - "chat": { - "methods": { - "completions": { - "description": "Exposes an OpenAI-compatible endpoint for chat completions.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/chat/completions", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.chat.completions", - "parameterOrder": [ - "endpoint" - ], - "parameters": { - "endpoint": { - "description": "Required. The name of the endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+endpoint}/chat/completions", - "request": { - "$ref": "GoogleApiHttpBody" - }, - "response": { - "$ref": "GoogleApiHttpBody" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - } - } + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/models/{modelsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.models.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^models/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" }, - "deployedModels": { - "resources": { - "invoke": { - "methods": { - "invoke": { - "description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/deployedModels/{deployedModelId}/invoke/{invokeId}", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.deployedModels.invoke.invoke", - "parameterOrder": [ - "endpoint", - "deployedModelId", - "invokeId" - ], - "parameters": { - "deployedModelId": { - "description": "ID of the DeployedModel that serves the invoke request.", - "location": "path", - "required": true, - "type": "string" - }, - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", - "required": true, - "type": "string" - }, - "invokeId": { - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1/{+endpoint}/deployedModels/{deployedModelId}/invoke/{+invokeId}", - "request": { - "$ref": "GoogleCloudAiplatformV1InvokeRequest" - }, - "response": { - "$ref": "GoogleApiHttpBody" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - } - } - } - } + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "notebookExecutionJobs": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.notebookExecutionJobs.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.notebookExecutionJobs.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.notebookExecutionJobs.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/notebookExecutionJobs/{notebookExecutionJobsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.notebookExecutionJobs.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" }, - "invoke": { - "methods": { - "invoke": { - "description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/invoke/{invokeId}", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.invoke.invoke", - "parameterOrder": [ - "endpoint", - "invokeId" - ], - "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", - "required": true, - "type": "string" - }, - "invokeId": { - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1/{+endpoint}/invoke/{+invokeId}", - "request": { - "$ref": "GoogleCloudAiplatformV1InvokeRequest" - }, - "response": { - "$ref": "GoogleApiHttpBody" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - } - } + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^notebookExecutionJobs/[^/]+$", + "required": true, + "type": "string" }, - "openapi": { - "methods": { - "embeddings": { - "description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/openapi/embeddings", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.openapi.embeddings", - "parameterOrder": [ - "endpoint" - ], - "parameters": { - "deployedModelId": { - "description": "ID of the DeployedModel that serves the invoke request.", - "location": "query", - "type": "string" - }, - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/openapi$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+endpoint}/embeddings", - "request": { - "$ref": "GoogleApiHttpBody" - }, - "response": { - "$ref": "GoogleApiHttpBody" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - } - } + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" }, - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.endpoints.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.endpoints.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.endpoints.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } - } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "evaluationItems": { - "methods": { - "create": { - "description": "Creates an Evaluation Item.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationItems", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.evaluationItems.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the Evaluation Item in. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/evaluationItems", - "request": { - "$ref": "GoogleCloudAiplatformV1EvaluationItem" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1EvaluationItem" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes an Evaluation Item.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.evaluationItems.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the EvaluationItem resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets an Evaluation Item.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.evaluationItems.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the EvaluationItem resource. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1EvaluationItem" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.notebookExecutionJobs.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" }, - "list": { - "description": "Lists Evaluation Items.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationItems", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.evaluationItems.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Optional. Filter expression that matches a subset of the EvaluationItems to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. The maximum number of Evaluation Items to return.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. A page token, received from a previous `ListEvaluationItems` call. Provide this to retrieve the subsequent page.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Location from which to list the Evaluation Items. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/evaluationItems", - "response": { - "$ref": "GoogleCloudAiplatformV1ListEvaluationItemsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" } - } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "notebookRuntimeTemplates": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.notebookRuntimeTemplates.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "evaluationRuns": { - "methods": { - "cancel": { - "description": "Cancels an Evaluation Run. Attempts to cancel a running Evaluation Run asynchronously. Status of run can be checked via GetEvaluationRun.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.evaluationRuns.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the EvaluationRun resource to be cancelled. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:cancel", - "request": { - "$ref": "GoogleCloudAiplatformV1CancelEvaluationRunRequest" - }, - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.notebookRuntimeTemplates.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.notebookRuntimeTemplates.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.notebookRuntimeTemplates.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" }, - "create": { - "description": "Creates an Evaluation Run.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.evaluationRuns.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the Evaluation Run in. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/evaluationRuns", - "request": { - "$ref": "GoogleCloudAiplatformV1EvaluationRun" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1EvaluationRun" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^notebookRuntimeTemplates/[^/]+$", + "required": true, + "type": "string" }, - "delete": { - "description": "Deletes an Evaluation Run.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.evaluationRuns.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the EvaluationRun resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" }, - "get": { - "description": "Gets an Evaluation Run.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.evaluationRuns.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the EvaluationRun resource. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1EvaluationRun" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" }, - "list": { - "description": "Lists Evaluation Runs.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.evaluationRuns.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Optional. Filter expression that matches a subset of the EvaluationRuns to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. The maximum number of Evaluation Runs to return.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. A page token, received from a previous `ListEvaluationRuns` call. Provide this to retrieve the subsequent page.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Location from which to list the Evaluation Runs. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/evaluationRuns", - "response": { - "$ref": "GoogleCloudAiplatformV1ListEvaluationRunsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } - } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "evaluationSets": { - "methods": { - "create": { - "description": "Creates an Evaluation Set.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.evaluationSets.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the Evaluation Set in. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/evaluationSets", - "request": { - "$ref": "GoogleCloudAiplatformV1EvaluationSet" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1EvaluationSet" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes an Evaluation Set.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.evaluationSets.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the EvaluationSet resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets an Evaluation Set.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.evaluationSets.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the EvaluationSet resource. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1EvaluationSet" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists Evaluation Sets.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.evaluationSets.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Optional. Filter expression that matches a subset of the EvaluationSets to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. The maximum number of Evaluation Sets to return.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. A page token, received from a previous `ListEvaluationSets` call. Provide this to retrieve the subsequent page.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Location from which to list the Evaluation Sets. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/evaluationSets", - "response": { - "$ref": "GoogleCloudAiplatformV1ListEvaluationSetsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.notebookRuntimeTemplates.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" }, - "patch": { - "description": "Updates an Evaluation Set.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.evaluationSets.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Identifier. The resource name of the EvaluationSet. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Optional. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1EvaluationSet" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1EvaluationSet" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" } - } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "notebookRuntimes": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.notebookRuntimes.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "featureGroups": { - "methods": { - "create": { - "description": "Creates a new FeatureGroup in a given project and location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureGroups.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "featureGroupId": { - "description": "Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Location to create FeatureGroups. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/featureGroups", - "request": { - "$ref": "GoogleCloudAiplatformV1FeatureGroup" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a single FeatureGroup.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.featureGroups.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "force": { - "description": "If set to true, any Features under this FeatureGroup will also be deleted. (Otherwise, the request will only work if the FeatureGroup has no Features.)", - "location": "query", - "type": "boolean" - }, - "name": { - "description": "Required. The name of the FeatureGroup to be deleted. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets details of a single FeatureGroup.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureGroups.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the FeatureGroup resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1FeatureGroup" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.notebookRuntimes.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.notebookRuntimes.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/notebookRuntimes/{notebookRuntimesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.notebookRuntimes.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:getIamPolicy", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureGroups.getIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "options.requestedPolicyVersion": { - "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", - "format": "int32", - "location": "query", - "type": "integer" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:getIamPolicy", - "response": { - "$ref": "GoogleIamV1Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^notebookRuntimes/[^/]+$", + "required": true, + "type": "string" }, - "list": { - "description": "Lists FeatureGroups in a given project and location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureGroups.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Lists the FeatureGroups that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > \"2020-01-01\" OR update_time > \"2020-01-01\"` FeatureGroups created or updated after 2020-01-01. * `labels.env = \"prod\"` FeatureGroups with label \"env\" set to \"prod\".", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported Fields: * `create_time` * `update_time`", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of FeatureGroups to return. The service may return fewer than this value. If unspecified, at most 100 FeatureGroups will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous FeatureRegistryService.ListFeatureGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureGroups must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Location to list FeatureGroups. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/featureGroups", - "response": { - "$ref": "GoogleCloudAiplatformV1ListFeatureGroupsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" }, - "patch": { - "description": "Updates the parameters of a single FeatureGroup.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.featureGroups.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Identifier. Name of the FeatureGroup. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` * `service_agent_type`", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1FeatureGroup" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" }, - "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}/featureGroups/{featureGroupsId}:setIamPolicy", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureGroups.setIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:setIamPolicy", - "request": { - "$ref": "GoogleIamV1SetIamPolicyRequest" - }, - "response": { - "$ref": "GoogleIamV1Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.notebookRuntimes.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:testIamPermissions", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureGroups.testIamPermissions", - "parameterOrder": [ - "resource" - ], - "parameters": { - "permissions": { - "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", - "location": "query", - "repeated": true, - "type": "string" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:testIamPermissions", - "response": { - "$ref": "GoogleIamV1TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" } }, - "resources": { - "features": { - "methods": { - "batchCreate": { - "description": "Creates a batch of Features in a given FeatureGroup.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features:batchCreate", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureGroups.features.batchCreate", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/features:batchCreate", - "request": { - "$ref": "GoogleCloudAiplatformV1BatchCreateFeaturesRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "create": { - "description": "Creates a new Feature in a given FeatureGroup.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureGroups.features.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "featureId": { - "description": "Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/features", - "request": { - "$ref": "GoogleCloudAiplatformV1Feature" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a single Feature.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.featureGroups.features.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the Features to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets details of a single Feature.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureGroups.features.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1Feature" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists Features in a given FeatureGroup.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureGroups.features.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --> Features whose type is DOUBLE. * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any Feature which has a label with 'env' as the key.", - "location": "query", - "type": "string" - }, - "latestStatsCount": { - "description": "Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "orderBy": { - "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time`", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+parent}/features", - "response": { - "$ref": "GoogleCloudAiplatformV1ListFeaturesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "patch": { - "description": "Updates the parameters of a single Feature.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.featureGroups.features.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore)", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1Feature" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "operations": { - "methods": { - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.featureGroups.features.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureGroups.features.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "listWait": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureGroups.features.operations.listWait", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureGroups.features.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - }, - "operations": { - "methods": { - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.featureGroups.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureGroups.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "listWait": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}:wait", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureGroups.operations.listWait", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureGroups.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - }, - "featureOnlineStores": { - "methods": { - "create": { - "description": "Creates a new FeatureOnlineStore in a given project and location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureOnlineStores.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "featureOnlineStoreId": { - "description": "Required. The ID to use for this FeatureOnlineStore, which will become the final component of the FeatureOnlineStore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/featureOnlineStores", - "request": { - "$ref": "GoogleCloudAiplatformV1FeatureOnlineStore" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not contain any FeatureViews.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.featureOnlineStores.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "force": { - "description": "If set to true, any FeatureViews and Features for this FeatureOnlineStore will also be deleted. (Otherwise, the request will only work if the FeatureOnlineStore has no FeatureViews.)", - "location": "query", - "type": "boolean" - }, - "name": { - "description": "Required. The name of the FeatureOnlineStore to be deleted. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets details of a single FeatureOnlineStore.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureOnlineStores.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the FeatureOnlineStore resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1FeatureOnlineStore" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/operations", + "httpMethod": "GET", + "id": "aiplatform.operations.list", + "parameterOrder": [], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "persistentResources": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/persistentResources/{persistentResourcesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.persistentResources.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^persistentResources/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/persistentResources/{persistentResourcesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.persistentResources.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^persistentResources/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/persistentResources/{persistentResourcesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.persistentResources.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^persistentResources/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/persistentResources/{persistentResourcesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.persistentResources.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:getIamPolicy", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureOnlineStores.getIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "options.requestedPolicyVersion": { - "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", - "format": "int32", - "location": "query", - "type": "integer" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:getIamPolicy", - "response": { - "$ref": "GoogleIamV1Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^persistentResources/[^/]+$", + "required": true, + "type": "string" }, - "list": { - "description": "Lists FeatureOnlineStores in a given project and location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureOnlineStores.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Lists the FeatureOnlineStores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > \"2020-01-01\" OR update_time > \"2020-01-01\"` FeatureOnlineStores created or updated after 2020-01-01. * `labels.env = \"prod\"` FeatureOnlineStores with label \"env\" set to \"prod\".", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported Fields: * `create_time` * `update_time`", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of FeatureOnlineStores to return. The service may return fewer than this value. If unspecified, at most 100 FeatureOnlineStores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureOnlineStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureOnlineStores must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Location to list FeatureOnlineStores. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/featureOnlineStores", - "response": { - "$ref": "GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" }, - "patch": { - "description": "Updates the parameters of a single FeatureOnlineStore.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.featureOnlineStores.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Identifier. Name of the FeatureOnlineStore. Format: `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `bigtable` * `bigtable.auto_scaling` * `bigtable.enable_multi_region_replica`", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1FeatureOnlineStore" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" }, - "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}/featureOnlineStores/{featureOnlineStoresId}:setIamPolicy", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureOnlineStores.setIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:setIamPolicy", - "request": { - "$ref": "GoogleIamV1SetIamPolicyRequest" - }, - "response": { - "$ref": "GoogleIamV1Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/persistentResources/{persistentResourcesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.persistentResources.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^persistentResources/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:testIamPermissions", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureOnlineStores.testIamPermissions", - "parameterOrder": [ - "resource" - ], - "parameters": { - "permissions": { - "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", - "location": "query", - "repeated": true, - "type": "string" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:testIamPermissions", - "response": { - "$ref": "GoogleIamV1TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" } }, - "resources": { - "featureViews": { - "methods": { - "create": { - "description": "Creates a new FeatureView in a given FeatureOnlineStore.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "featureViewId": { - "description": "Required. The ID to use for the FeatureView, which will become the final component of the FeatureView's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a FeatureOnlineStore.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the FeatureOnlineStore to create FeatureViews. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", - "required": true, - "type": "string" - }, - "runSyncImmediately": { - "description": "Immutable. If set to true, one on demand sync will be run immediately, regardless whether the FeatureView.sync_config is configured or not.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1/{+parent}/featureViews", - "request": { - "$ref": "GoogleCloudAiplatformV1FeatureView" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a single FeatureView.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the FeatureView to be deleted. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "pipelineJobs": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.pipelineJobs.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^pipelineJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.pipelineJobs.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^pipelineJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.pipelineJobs.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^pipelineJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/pipelineJobs/{pipelineJobsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.pipelineJobs.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^pipelineJobs/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.pipelineJobs.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^pipelineJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "projects": { + "methods": { + "getCacheConfig": { + "description": "Gets a GenAI cache config.", + "flatPath": "v1/projects/{projectsId}/cacheConfig", + "httpMethod": "GET", + "id": "aiplatform.projects.getCacheConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the cache config. Format: - `projects/{project}/cacheConfig`.", + "location": "path", + "pattern": "^projects/[^/]+/cacheConfig$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1CacheConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "updateCacheConfig": { + "description": "Updates a cache config.", + "flatPath": "v1/projects/{projectsId}/cacheConfig", + "httpMethod": "PATCH", + "id": "aiplatform.projects.updateCacheConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. Name of the cache config. Format: - `projects/{project}/cacheConfig`.", + "location": "path", + "pattern": "^projects/[^/]+/cacheConfig$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1CacheConfig" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "locations": { + "methods": { + "augmentPrompt": { + "description": "Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:augmentPrompt", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.augmentPrompt", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location from which to augment prompt. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}:augmentPrompt", + "request": { + "$ref": "GoogleCloudAiplatformV1AugmentPromptRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1AugmentPromptResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "corroborateContent": { + "description": "Given an input text, it returns a score that evaluates the factuality of the text. It also extracts and returns claims from the text and provides supporting facts.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:corroborateContent", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.corroborateContent", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location from which to corroborate text. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}:corroborateContent", + "request": { + "$ref": "GoogleCloudAiplatformV1CorroborateContentRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1CorroborateContentResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "deploy": { + "description": "Deploys a model to a new endpoint.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:deploy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.deploy", + "parameterOrder": [ + "destination" + ], + "parameters": { + "destination": { + "description": "Required. The resource name of the Location to deploy the model in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+destination}:deploy", + "request": { + "$ref": "GoogleCloudAiplatformV1DeployRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "evaluateDataset": { + "description": "Evaluates a dataset based on a set of given metrics.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:evaluateDataset", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.evaluateDataset", + "parameterOrder": [ + "location" + ], + "parameters": { + "location": { + "description": "Required. The resource name of the Location to evaluate the dataset. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+location}:evaluateDataset", + "request": { + "$ref": "GoogleCloudAiplatformV1EvaluateDatasetRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "evaluateInstances": { + "description": "Evaluates instances based on a given metric.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:evaluateInstances", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.evaluateInstances", + "parameterOrder": [ + "location" + ], + "parameters": { + "location": { + "description": "Required. The resource name of the Location to evaluate the instances. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+location}:evaluateInstances", + "request": { + "$ref": "GoogleCloudAiplatformV1EvaluateInstancesRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1EvaluateInstancesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "generateInstanceRubrics": { + "description": "Generates rubrics for a given prompt. A rubric represents a single testable criterion for evaluation. One input prompt could have multiple rubrics This RPC allows users to get suggested rubrics based on provided prompt, which can then be reviewed and used for subsequent evaluations.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:generateInstanceRubrics", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.generateInstanceRubrics", + "parameterOrder": [ + "location" + ], + "parameters": { + "location": { + "description": "Required. The resource name of the Location to generate rubrics from. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+location}:generateInstanceRubrics", + "request": { + "$ref": "GoogleCloudAiplatformV1GenerateInstanceRubricsRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1GenerateInstanceRubricsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "generateSyntheticData": { + "description": "Generates synthetic data based on the provided configuration.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:generateSyntheticData", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.generateSyntheticData", + "parameterOrder": [ + "location" + ], + "parameters": { + "location": { + "description": "Required. The resource name of the Location to run the job. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+location}:generateSyntheticData", + "request": { + "$ref": "GoogleCloudAiplatformV1GenerateSyntheticDataRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1GenerateSyntheticDataResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets information about a location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Resource name for the location.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudLocationLocation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getRagEngineConfig": { + "description": "Gets a RagEngineConfig.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.getRagEngineConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the RagEngineConfig resource. Format: `projects/{project}/locations/{location}/ragEngineConfig`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1RagEngineConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists information about the supported locations for this service.", + "flatPath": "v1/projects/{projectsId}/locations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "extraLocationTypes": { + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "location": "query", + "repeated": true, + "type": "string" + }, + "filter": { + "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "name": { + "description": "The resource that owns the locations collection, if applicable.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The maximum number of results to return. If not set, the service selects a default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}/locations", + "response": { + "$ref": "GoogleCloudLocationListLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "retrieveContexts": { + "description": "Retrieves relevant contexts for a query.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:retrieveContexts", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.retrieveContexts", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}:retrieveContexts", + "request": { + "$ref": "GoogleCloudAiplatformV1RetrieveContextsRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1RetrieveContextsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "updateRagEngineConfig": { + "description": "Updates a RagEngineConfig.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.updateRagEngineConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The name of the RagEngineConfig. Format: `projects/{project}/locations/{location}/ragEngineConfig`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1RagEngineConfig" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "batchPredictionJobs": { + "methods": { + "cancel": { + "description": "Cancels a BatchPredictionJob. Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetBatchPredictionJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its BatchPredictionJob.state is set to `CANCELLED`. Any files already outputted by the job are not deleted.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.batchPredictionJobs.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the BatchPredictionJob to cancel. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "request": { + "$ref": "GoogleCloudAiplatformV1CancelBatchPredictionJobRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.batchPredictionJobs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the BatchPredictionJob in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/batchPredictionJobs", + "request": { + "$ref": "GoogleCloudAiplatformV1BatchPredictionJob" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1BatchPredictionJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a BatchPredictionJob. Can only be called on jobs that already finished.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.batchPredictionJobs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the BatchPredictionJob resource to be deleted. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a BatchPredictionJob", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.batchPredictionJobs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the BatchPredictionJob resource. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1BatchPredictionJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists BatchPredictionJobs in a Location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.batchPredictionJobs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `model_display_name` supports `=`, `!=` comparisons. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token. Typically obtained via ListBatchPredictionJobsResponse.next_page_token of the previous JobService.ListBatchPredictionJobs call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list the BatchPredictionJobs from. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/batchPredictionJobs", + "response": { + "$ref": "GoogleCloudAiplatformV1ListBatchPredictionJobsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "cachedContents": { + "methods": { + "create": { + "description": "Creates cached content, this call will initialize the cached content in the data storage, and users need to pay for the cache data storage.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cachedContents", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.cachedContents.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource where the cached content will be created", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/cachedContents", + "request": { + "$ref": "GoogleCloudAiplatformV1CachedContent" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1CachedContent" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes cached content", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.cachedContents.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name referring to the cached content", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/cachedContents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets cached content configurations", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.cachedContents.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name referring to the cached content", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/cachedContents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1CachedContent" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists cached contents in a project", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cachedContents", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.cachedContents.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of cached contents to return. The service may return fewer than this value. If unspecified, some default (under maximum) number of items will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListCachedContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCachedContents` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent, which owns this collection of cached contents.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/cachedContents", + "response": { + "$ref": "GoogleCloudAiplatformV1ListCachedContentsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates cached content configurations", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.cachedContents.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/cachedContents/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1CachedContent" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1CachedContent" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "customJobs": { + "methods": { + "cancel": { + "description": "Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetCustomJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the CustomJob is not deleted; instead it becomes a job with a CustomJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and CustomJob.state is set to `CANCELLED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.customJobs.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the CustomJob to cancel. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "request": { + "$ref": "GoogleCloudAiplatformV1CancelCustomJobRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a CustomJob. A created CustomJob right away will be attempted to be run.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.customJobs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/customJobs", + "request": { + "$ref": "GoogleCloudAiplatformV1CustomJob" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1CustomJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a CustomJob.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.customJobs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the CustomJob resource to be deleted. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a CustomJob.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.customJobs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the CustomJob resource. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1CustomJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists CustomJobs in a Location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.customJobs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token. Typically obtained via ListCustomJobsResponse.next_page_token of the previous JobService.ListCustomJobs call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list the CustomJobs from. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/customJobs", + "response": { + "$ref": "GoogleCloudAiplatformV1ListCustomJobsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.customJobs.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.customJobs.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.customJobs.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.customJobs.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.customJobs.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "dataLabelingJobs": { + "methods": { + "cancel": { + "description": "Cancels a DataLabelingJob. Success of cancellation is not guaranteed.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.dataLabelingJobs.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "request": { + "$ref": "GoogleCloudAiplatformV1CancelDataLabelingJobRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a DataLabelingJob.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.dataLabelingJobs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent of the DataLabelingJob. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/dataLabelingJobs", + "request": { + "$ref": "GoogleCloudAiplatformV1DataLabelingJob" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1DataLabelingJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a DataLabelingJob.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.dataLabelingJobs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the DataLabelingJob to be deleted. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a DataLabelingJob.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.dataLabelingJobs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1DataLabelingJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists DataLabelingJobs in a Location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.dataLabelingJobs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent of the DataLabelingJob. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read. FieldMask represents a set of symbolic field paths. For example, the mask can be `paths: \"name\"`. The \"name\" here is a field in DataLabelingJob. If this field is not set, all fields of the DataLabelingJob are returned.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/dataLabelingJobs", + "response": { + "$ref": "GoogleCloudAiplatformV1ListDataLabelingJobsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.dataLabelingJobs.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.dataLabelingJobs.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.dataLabelingJobs.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.dataLabelingJobs.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.dataLabelingJobs.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "datasets": { + "methods": { + "create": { + "description": "Creates a Dataset.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the Dataset in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/datasets", + "request": { + "$ref": "GoogleCloudAiplatformV1Dataset" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a Dataset.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.datasets.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Dataset to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "export": { + "description": "Exports data from a Dataset.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:export", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.export", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:export", + "request": { + "$ref": "GoogleCloudAiplatformV1ExportDataRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a Dataset.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Dataset resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1Dataset" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "import": { + "description": "Imports data into a Dataset.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:import", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.import", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:import", + "request": { + "$ref": "GoogleCloudAiplatformV1ImportDataRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Datasets in a Location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `display_name`: supports = and != * `metadata_schema_uri`: supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. Some examples: * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"`", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the Dataset's parent resource. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/datasets", + "response": { + "$ref": "GoogleCloudAiplatformV1ListDatasetsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a Dataset.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.datasets.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` * `description` * `labels`", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1Dataset" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1Dataset" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "searchDataItems": { + "description": "Searches DataItems in a Dataset.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:searchDataItems", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.searchDataItems", + "parameterOrder": [ + "dataset" + ], + "parameters": { + "annotationFilters": { + "description": "An expression that specifies what Annotations will be returned per DataItem. Annotations satisfied either of the conditions will be returned. * `annotation_spec_id` - for = or !=. Must specify `saved_query_id=` - saved query id that annotations should belong to.", + "location": "query", + "repeated": true, + "type": "string" + }, + "annotationsFilter": { + "deprecated": true, + "description": "An expression for filtering the Annotations that will be returned per DataItem. * `annotation_spec_id` - for = or !=.", + "location": "query", + "type": "string" + }, + "annotationsLimit": { + "description": "If set, only up to this many of Annotations will be returned per DataItemView. The maximum value is 1000. If not set, the maximum value will be used.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "dataItemFilter": { + "description": "An expression for filtering the DataItem that will be returned. * `data_item_id` - for = or !=. * `labeled` - for = or !=. * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that have at least one annotation with annotation_spec_id = `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob. For example: * `data_item=1` * `has_annotation(5)`", + "location": "query", + "type": "string" + }, + "dataLabelingJob": { + "description": "The resource name of a DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` If this field is set, all of the search will be done in the context of this DataLabelingJob.", + "location": "query", + "type": "string" + }, + "dataset": { + "description": "Required. The resource name of the Dataset from which to search DataItems. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + }, + "fieldMask": { + "description": "Mask specifying which fields of DataItemView to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "orderBy": { + "deprecated": true, + "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", + "location": "query", + "type": "string" + }, + "orderByAnnotation.orderBy": { + "description": "A comma-separated list of annotation fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Must also specify saved_query.", + "location": "query", + "type": "string" + }, + "orderByAnnotation.savedQuery": { + "description": "Required. Saved query of the Annotation. Only Annotations belong to this saved query will be considered for ordering.", + "location": "query", + "type": "string" + }, + "orderByDataItem": { + "description": "A comma-separated list of data item fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Server may return fewer results than requested. Default and maximum page size is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results for the server to return Typically obtained via SearchDataItemsResponse.next_page_token of the previous DatasetService.SearchDataItems call.", + "location": "query", + "type": "string" + }, + "savedQuery": { + "deprecated": true, + "description": "The resource name of a SavedQuery(annotation set in UI). Format: `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}` All of the search will be done in the context of this SavedQuery.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+dataset}:searchDataItems", + "response": { + "$ref": "GoogleCloudAiplatformV1SearchDataItemsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "annotationSpecs": { + "methods": { + "get": { + "description": "Gets an AnnotationSpec.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.annotationSpecs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the AnnotationSpec resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1AnnotationSpec" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "dataItems": { + "methods": { + "list": { + "description": "Lists DataItems in a Dataset.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.dataItems.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Dataset to list DataItems from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/dataItems", + "response": { + "$ref": "GoogleCloudAiplatformV1ListDataItemsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "annotations": { + "methods": { + "list": { + "description": "Lists Annotations belongs to a dataitem.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.dataItems.annotations.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the DataItem to list Annotations from. Format: `projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/annotations", + "response": { + "$ref": "GoogleCloudAiplatformV1ListAnnotationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.dataItems.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.datasets.dataItems.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.dataItems.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.dataItems.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.dataItems.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "datasetVersions": { + "methods": { + "create": { + "description": "Create a version from a Dataset.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.datasetVersions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/datasetVersions", + "request": { + "$ref": "GoogleCloudAiplatformV1DatasetVersion" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a Dataset version.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.datasets.datasetVersions.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a Dataset version.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.datasetVersions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1DatasetVersion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists DatasetVersions in a Dataset.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.datasetVersions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The standard list filter.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Optional. Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/datasetVersions", + "response": { + "$ref": "GoogleCloudAiplatformV1ListDatasetVersionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a DatasetVersion.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.datasets.datasetVersions.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name`", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1DatasetVersion" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1DatasetVersion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "restore": { + "description": "Restores a dataset version.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.datasetVersions.restore", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the DatasetVersion resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:restore", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.datasets.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "savedQueries": { + "methods": { + "delete": { + "description": "Deletes a SavedQuery.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.datasets.savedQueries.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the SavedQuery to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists SavedQueries in a Dataset.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.savedQueries.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Dataset to list SavedQueries from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/savedQueries", + "response": { + "$ref": "GoogleCloudAiplatformV1ListSavedQueriesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.savedQueries.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.datasets.savedQueries.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.savedQueries.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.savedQueries.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.savedQueries.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + }, + "deploymentResourcePools": { + "methods": { + "create": { + "description": "Create a DeploymentResourcePool.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.deploymentResourcePools.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent location resource where this DeploymentResourcePool will be created. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/deploymentResourcePools", + "request": { + "$ref": "GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Delete a DeploymentResourcePool.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.deploymentResourcePools.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the DeploymentResourcePool to delete. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get a DeploymentResourcePool.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.deploymentResourcePools.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the DeploymentResourcePool to retrieve. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1DeploymentResourcePool" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List DeploymentResourcePools in a location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.deploymentResourcePools.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of DeploymentResourcePools to return. The service may return fewer than this value.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListDeploymentResourcePools` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDeploymentResourcePools` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent Location which owns this collection of DeploymentResourcePools. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/deploymentResourcePools", + "response": { + "$ref": "GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Update a DeploymentResourcePool.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.deploymentResourcePools.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1DeploymentResourcePool" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "queryDeployedModels": { + "description": "List DeployedModels that have been deployed on this DeploymentResourcePool.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}:queryDeployedModels", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.deploymentResourcePools.queryDeployedModels", + "parameterOrder": [ + "deploymentResourcePool" + ], + "parameters": { + "deploymentResourcePool": { + "description": "Required. The name of the target DeploymentResourcePool to query. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The maximum number of DeployedModels to return. The service may return fewer than this value.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `QueryDeployedModels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryDeployedModels` must match the call that provided the page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+deploymentResourcePool}:queryDeployedModels", + "response": { + "$ref": "GoogleCloudAiplatformV1QueryDeployedModelsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.deploymentResourcePools.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.deploymentResourcePools.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.deploymentResourcePools.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.deploymentResourcePools.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.deploymentResourcePools.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "endpoints": { + "methods": { + "computeTokens": { + "description": "Return a list of tokens based on the input text.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:computeTokens", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.computeTokens", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:computeTokens", + "request": { + "$ref": "GoogleCloudAiplatformV1ComputeTokensRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1ComputeTokensResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "countTokens": { + "description": "Perform a token counting.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:countTokens", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.countTokens", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:countTokens", + "request": { + "$ref": "GoogleCloudAiplatformV1CountTokensRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1CountTokensResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates an Endpoint.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "endpointId": { + "description": "Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are `[0-9]` with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as `?endpoint_id=12345`. This is the fallback for fields that are not included in either the URI or the body.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to create the Endpoint in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/endpoints", + "request": { + "$ref": "GoogleCloudAiplatformV1Endpoint" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an Endpoint.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.endpoints.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Endpoint resource to be deleted. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "deployModel": { + "description": "Deploys a Model into this Endpoint, creating a DeployedModel within it.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:deployModel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.deployModel", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint resource into which to deploy a Model. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:deployModel", + "request": { + "$ref": "GoogleCloudAiplatformV1DeployModelRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "directPredict": { + "description": "Perform an unary online prediction request to a gRPC model server for Vertex first-party products and frameworks.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directPredict", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.directPredict", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:directPredict", + "request": { + "$ref": "GoogleCloudAiplatformV1DirectPredictRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1DirectPredictResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "directRawPredict": { + "description": "Perform an unary online prediction request to a gRPC model server for custom containers.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directRawPredict", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.directRawPredict", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:directRawPredict", + "request": { + "$ref": "GoogleCloudAiplatformV1DirectRawPredictRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1DirectRawPredictResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "explain": { + "description": "Perform an online explanation. If deployed_model_id is specified, the corresponding DeployModel must have explanation_spec populated. If deployed_model_id is not specified, all DeployedModels must have explanation_spec populated.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:explain", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.explain", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the explanation. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:explain", + "request": { + "$ref": "GoogleCloudAiplatformV1ExplainRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1ExplainResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "fetchPredictOperation": { + "description": "Fetch an asynchronous online prediction operation.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:fetchPredictOperation", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.fetchPredictOperation", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:fetchPredictOperation", + "request": { + "$ref": "GoogleCloudAiplatformV1FetchPredictOperationRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "generateContent": { + "description": "Generate content with multimodal inputs.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:generateContent", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.generateContent", + "parameterOrder": [ + "model" + ], + "parameters": { + "model": { + "description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+model}:generateContent", + "request": { + "$ref": "GoogleCloudAiplatformV1GenerateContentRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1GenerateContentResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "get": { + "description": "Gets an Endpoint.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.endpoints.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Endpoint resource. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1Endpoint" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Endpoints in a Location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.endpoints.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports `=` and `!=`. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * `display_name` supports `=` and `!=`. * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:*` or `labels:key` - key existence * A key including a space must be quoted. `labels.\"a key\"`. * `base_model_name` only supports `=`. Some examples: * `endpoint=1` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"` * `baseModelName=\"text-bison\"`", + "location": "query", + "type": "string" + }, + "gdcZone": { + "description": "Optional. Configures the Google Distributed Cloud (GDC) environment for online prediction. Only set this field when the Endpoint is to be deployed in a GDC environment.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token. Typically obtained via ListEndpointsResponse.next_page_token of the previous EndpointService.ListEndpoints call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location from which to list the Endpoints. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Optional. Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/endpoints", + "response": { + "$ref": "GoogleCloudAiplatformV1ListEndpointsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "mutateDeployedModel": { + "description": "Updates an existing deployed model. Updatable fields include `min_replica_count`, `max_replica_count`, `required_replica_count`, `autoscaling_metric_specs`, `disable_container_logging` (v1 only), and `enable_container_logging` (v1beta1 only).", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:mutateDeployedModel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.mutateDeployedModel", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint resource into which to mutate a DeployedModel. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:mutateDeployedModel", + "request": { + "$ref": "GoogleCloudAiplatformV1MutateDeployedModelRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an Endpoint.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.endpoints.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The resource name of the Endpoint.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1Endpoint" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1Endpoint" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "predict": { + "description": "Perform an online prediction.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predict", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.predict", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:predict", + "request": { + "$ref": "GoogleCloudAiplatformV1PredictRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1PredictResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "predictLongRunning": { + "description": "", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predictLongRunning", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.predictLongRunning", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:predictLongRunning", + "request": { + "$ref": "GoogleCloudAiplatformV1PredictLongRunningRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "rawPredict": { + "description": "Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's DeployedModel that served this prediction.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:rawPredict", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.rawPredict", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:rawPredict", + "request": { + "$ref": "GoogleCloudAiplatformV1RawPredictRequest" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "serverStreamingPredict": { + "description": "Perform a server-side streaming online prediction request for Vertex LLM streaming.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:serverStreamingPredict", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.serverStreamingPredict", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:serverStreamingPredict", + "request": { + "$ref": "GoogleCloudAiplatformV1StreamingPredictRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1StreamingPredictResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "streamGenerateContent": { + "description": "Generate content with multimodal inputs with streaming support.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamGenerateContent", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.streamGenerateContent", + "parameterOrder": [ + "model" + ], + "parameters": { + "model": { + "description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+model}:streamGenerateContent", + "request": { + "$ref": "GoogleCloudAiplatformV1GenerateContentRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1GenerateContentResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "streamRawPredict": { + "description": "Perform a streaming online prediction with an arbitrary HTTP payload.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamRawPredict", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.streamRawPredict", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:streamRawPredict", + "request": { + "$ref": "GoogleCloudAiplatformV1StreamRawPredictRequest" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "undeployModel": { + "description": "Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:undeployModel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.undeployModel", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint resource from which to undeploy a Model. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:undeployModel", + "request": { + "$ref": "GoogleCloudAiplatformV1UndeployModelRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "update": { + "description": "Updates an Endpoint with a long running operation.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:update", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.update", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The resource name of the Endpoint.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:update", + "request": { + "$ref": "GoogleCloudAiplatformV1UpdateEndpointLongRunningRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "chat": { + "methods": { + "completions": { + "description": "Exposes an OpenAI-compatible endpoint for chat completions.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/chat/completions", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.chat.completions", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}/chat/completions", + "request": { + "$ref": "GoogleApiHttpBody" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + }, + "deployedModels": { + "resources": { + "invoke": { + "methods": { + "invoke": { + "description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/deployedModels/{deployedModelId}/invoke/{invokeId}", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.deployedModels.invoke.invoke", + "parameterOrder": [ + "endpoint", + "deployedModelId", + "invokeId" + ], + "parameters": { + "deployedModelId": { + "description": "ID of the DeployedModel that serves the invoke request.", + "location": "path", + "required": true, + "type": "string" + }, + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + }, + "invokeId": { + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}/deployedModels/{deployedModelId}/invoke/{+invokeId}", + "request": { + "$ref": "GoogleCloudAiplatformV1InvokeRequest" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + } + } + }, + "invoke": { + "methods": { + "invoke": { + "description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/invoke/{invokeId}", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.invoke.invoke", + "parameterOrder": [ + "endpoint", + "invokeId" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + }, + "invokeId": { + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}/invoke/{+invokeId}", + "request": { + "$ref": "GoogleCloudAiplatformV1InvokeRequest" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + }, + "openapi": { + "methods": { + "embeddings": { + "description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/openapi/embeddings", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.openapi.embeddings", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "deployedModelId": { + "description": "ID of the DeployedModel that serves the invoke request.", + "location": "query", + "type": "string" + }, + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/openapi$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}/embeddings", + "request": { + "$ref": "GoogleApiHttpBody" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.endpoints.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.endpoints.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.endpoints.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "evaluationItems": { + "methods": { + "create": { + "description": "Creates an Evaluation Item.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationItems", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.evaluationItems.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the Evaluation Item in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/evaluationItems", + "request": { + "$ref": "GoogleCloudAiplatformV1EvaluationItem" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1EvaluationItem" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an Evaluation Item.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.evaluationItems.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the EvaluationItem resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets an Evaluation Item.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.evaluationItems.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the EvaluationItem resource. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1EvaluationItem" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Evaluation Items.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationItems", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.evaluationItems.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter expression that matches a subset of the EvaluationItems to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of Evaluation Items to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListEvaluationItems` call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location from which to list the Evaluation Items. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/evaluationItems", + "response": { + "$ref": "GoogleCloudAiplatformV1ListEvaluationItemsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "evaluationRuns": { + "methods": { + "cancel": { + "description": "Cancels an Evaluation Run. Attempts to cancel a running Evaluation Run asynchronously. Status of run can be checked via GetEvaluationRun.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.evaluationRuns.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the EvaluationRun resource to be cancelled. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "request": { + "$ref": "GoogleCloudAiplatformV1CancelEvaluationRunRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates an Evaluation Run.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.evaluationRuns.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the Evaluation Run in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/evaluationRuns", + "request": { + "$ref": "GoogleCloudAiplatformV1EvaluationRun" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1EvaluationRun" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an Evaluation Run.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.evaluationRuns.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the EvaluationRun resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets an Evaluation Run.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.evaluationRuns.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the EvaluationRun resource. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1EvaluationRun" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Evaluation Runs.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.evaluationRuns.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter expression that matches a subset of the EvaluationRuns to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of Evaluation Runs to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListEvaluationRuns` call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location from which to list the Evaluation Runs. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/evaluationRuns", + "response": { + "$ref": "GoogleCloudAiplatformV1ListEvaluationRunsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "evaluationSets": { + "methods": { + "create": { + "description": "Creates an Evaluation Set.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.evaluationSets.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the Evaluation Set in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/evaluationSets", + "request": { + "$ref": "GoogleCloudAiplatformV1EvaluationSet" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1EvaluationSet" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an Evaluation Set.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.evaluationSets.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the EvaluationSet resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets an Evaluation Set.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.evaluationSets.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the EvaluationSet resource. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1EvaluationSet" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Evaluation Sets.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.evaluationSets.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter expression that matches a subset of the EvaluationSets to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of Evaluation Sets to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListEvaluationSets` call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location from which to list the Evaluation Sets. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/evaluationSets", + "response": { + "$ref": "GoogleCloudAiplatformV1ListEvaluationSetsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an Evaluation Set.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.evaluationSets.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the EvaluationSet. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1EvaluationSet" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1EvaluationSet" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "featureGroups": { + "methods": { + "create": { + "description": "Creates a new FeatureGroup in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureGroups.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "featureGroupId": { + "description": "Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to create FeatureGroups. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/featureGroups", + "request": { + "$ref": "GoogleCloudAiplatformV1FeatureGroup" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single FeatureGroup.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featureGroups.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "If set to true, any Features under this FeatureGroup will also be deleted. (Otherwise, the request will only work if the FeatureGroup has no Features.)", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the FeatureGroup to be deleted. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single FeatureGroup.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the FeatureGroup resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1FeatureGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:getIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureGroups.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists FeatureGroups in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Lists the FeatureGroups that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > \"2020-01-01\" OR update_time > \"2020-01-01\"` FeatureGroups created or updated after 2020-01-01. * `labels.env = \"prod\"` FeatureGroups with label \"env\" set to \"prod\".", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported Fields: * `create_time` * `update_time`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of FeatureGroups to return. The service may return fewer than this value. If unspecified, at most 100 FeatureGroups will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous FeatureRegistryService.ListFeatureGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureGroups must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list FeatureGroups. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/featureGroups", + "response": { + "$ref": "GoogleCloudAiplatformV1ListFeatureGroupsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single FeatureGroup.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.featureGroups.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. Name of the FeatureGroup. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` * `service_agent_type`", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1FeatureGroup" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:setIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureGroups.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "GoogleIamV1SetIamPolicyRequest" + }, + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:testIamPermissions", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureGroups.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "permissions": { + "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", + "location": "query", + "repeated": true, + "type": "string" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "response": { + "$ref": "GoogleIamV1TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "features": { + "methods": { + "batchCreate": { + "description": "Creates a batch of Features in a given FeatureGroup.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features:batchCreate", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureGroups.features.batchCreate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/features:batchCreate", + "request": { + "$ref": "GoogleCloudAiplatformV1BatchCreateFeaturesRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a new Feature in a given FeatureGroup.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureGroups.features.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "featureId": { + "description": "Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/features", + "request": { + "$ref": "GoogleCloudAiplatformV1Feature" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single Feature.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featureGroups.features.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Features to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single Feature.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.features.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1Feature" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Features in a given FeatureGroup.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.features.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --> Features whose type is DOUBLE. * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any Feature which has a label with 'env' as the key.", + "location": "query", + "type": "string" + }, + "latestStatsCount": { + "description": "Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "orderBy": { + "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/features", + "response": { + "$ref": "GoogleCloudAiplatformV1ListFeaturesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single Feature.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.featureGroups.features.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore)", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1Feature" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featureGroups.features.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.features.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "listWait": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.features.operations.listWait", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureGroups.features.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "operations": { + "methods": { + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featureGroups.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "listWait": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}:wait", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.operations.listWait", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureGroups.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "featureOnlineStores": { + "methods": { + "create": { + "description": "Creates a new FeatureOnlineStore in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "featureOnlineStoreId": { + "description": "Required. The ID to use for this FeatureOnlineStore, which will become the final component of the FeatureOnlineStore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/featureOnlineStores", + "request": { + "$ref": "GoogleCloudAiplatformV1FeatureOnlineStore" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not contain any FeatureViews.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featureOnlineStores.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "If set to true, any FeatureViews and Features for this FeatureOnlineStore will also be deleted. (Otherwise, the request will only work if the FeatureOnlineStore has no FeatureViews.)", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the FeatureOnlineStore to be deleted. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single FeatureOnlineStore.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureOnlineStores.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the FeatureOnlineStore resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1FeatureOnlineStore" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:getIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists FeatureOnlineStores in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureOnlineStores.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Lists the FeatureOnlineStores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > \"2020-01-01\" OR update_time > \"2020-01-01\"` FeatureOnlineStores created or updated after 2020-01-01. * `labels.env = \"prod\"` FeatureOnlineStores with label \"env\" set to \"prod\".", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported Fields: * `create_time` * `update_time`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of FeatureOnlineStores to return. The service may return fewer than this value. If unspecified, at most 100 FeatureOnlineStores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureOnlineStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureOnlineStores must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list FeatureOnlineStores. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/featureOnlineStores", + "response": { + "$ref": "GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single FeatureOnlineStore.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.featureOnlineStores.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. Name of the FeatureOnlineStore. Format: `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `bigtable` * `bigtable.auto_scaling` * `bigtable.enable_multi_region_replica`", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1FeatureOnlineStore" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:setIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "GoogleIamV1SetIamPolicyRequest" + }, + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:testIamPermissions", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "permissions": { + "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", + "location": "query", + "repeated": true, + "type": "string" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "response": { + "$ref": "GoogleIamV1TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "featureViews": { + "methods": { + "create": { + "description": "Creates a new FeatureView in a given FeatureOnlineStore.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "featureViewId": { + "description": "Required. The ID to use for the FeatureView, which will become the final component of the FeatureView's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a FeatureOnlineStore.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the FeatureOnlineStore to create FeatureViews. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "required": true, + "type": "string" + }, + "runSyncImmediately": { + "description": "Immutable. If set to true, one on demand sync will be run immediately, regardless whether the FeatureView.sync_config is configured or not.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+parent}/featureViews", + "request": { + "$ref": "GoogleCloudAiplatformV1FeatureView" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single FeatureView.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the FeatureView to be deleted. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", "required": true, @@ -15697,6 +20861,35 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "embedContent": { + "description": "Embed content with multimodal inputs.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:embedContent", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.publishers.models.embedContent", + "parameterOrder": [ + "model" + ], + "parameters": { + "model": { + "description": "Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+model}:embedContent", + "request": { + "$ref": "GoogleCloudAiplatformV1EmbedContentRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1EmbedContentResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, "fetchPredictOperation": { "description": "Fetch an asynchronous online prediction operation.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:fetchPredictOperation", @@ -16519,19 +21712,395 @@ } } } - } + } + } + } + }, + "ragEngineConfig": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.ragEngineConfig.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.ragEngineConfig.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.ragEngineConfig.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.ragEngineConfig.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.ragEngineConfig.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "reasoningEngines": { + "methods": { + "create": { + "description": "Creates a reasoning engine.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/reasoningEngines", + "request": { + "$ref": "GoogleCloudAiplatformV1ReasoningEngine" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a reasoning engine.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.reasoningEngines.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a reasoning engine.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the ReasoningEngine resource. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1ReasoningEngine" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists reasoning engines in a location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/reasoningEngines", + "response": { + "$ref": "GoogleCloudAiplatformV1ListReasoningEnginesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a reasoning engine.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.reasoningEngines.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Mask specifying which fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1ReasoningEngine" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "query": { + "description": "Queries using a reasoning engine.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:query", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.query", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:query", + "request": { + "$ref": "GoogleCloudAiplatformV1QueryReasoningEngineRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1QueryReasoningEngineResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "streamQuery": { + "description": "Streams queries using a reasoning engine.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:streamQuery", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.streamQuery", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:streamQuery", + "request": { + "$ref": "GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } - } - }, - "ragEngineConfig": { + }, "resources": { "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}:cancel", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.ragEngineConfig.operations.cancel", + "id": "aiplatform.projects.locations.reasoningEngines.operations.cancel", "parameterOrder": [ "name" ], @@ -16539,7 +22108,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -16554,9 +22123,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.ragEngineConfig.operations.delete", + "id": "aiplatform.projects.locations.reasoningEngines.operations.delete", "parameterOrder": [ "name" ], @@ -16564,7 +22133,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -16579,9 +22148,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.ragEngineConfig.operations.get", + "id": "aiplatform.projects.locations.reasoningEngines.operations.get", "parameterOrder": [ "name" ], @@ -16589,7 +22158,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -16604,9 +22173,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.ragEngineConfig.operations.list", + "id": "aiplatform.projects.locations.reasoningEngines.operations.list", "parameterOrder": [ "name" ], @@ -16619,7 +22188,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string" }, @@ -16650,9 +22219,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}:wait", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.ragEngineConfig.operations.wait", + "id": "aiplatform.projects.locations.reasoningEngines.operations.wait", "parameterOrder": [ "name" ], @@ -16660,7 +22229,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -16683,54 +22252,49 @@ } } }, - "reasoningEngines": { + "schedules": { "methods": { "create": { - "description": "Creates a reasoning engine.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines", + "description": "Creates a Schedule.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules", "httpMethod": "POST", - "id": "aiplatform.projects.locations.reasoningEngines.create", + "id": "aiplatform.projects.locations.schedules.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { - "description": "Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project}/locations/{location}`", + "description": "Required. The resource name of the Location to create the Schedule in. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+parent}/reasoningEngines", + "path": "v1/{+parent}/schedules", "request": { - "$ref": "GoogleCloudAiplatformV1ReasoningEngine" + "$ref": "GoogleCloudAiplatformV1Schedule" }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1Schedule" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { - "description": "Deletes a reasoning engine.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}", + "description": "Deletes a Schedule.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.reasoningEngines.delete", + "id": "aiplatform.projects.locations.schedules.delete", "parameterOrder": [ "name" ], "parameters": { - "force": { - "description": "Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources.", - "location": "query", - "type": "boolean" - }, "name": { - "description": "Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "description": "Required. The name of the Schedule resource to be deleted. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", "required": true, "type": "string" } @@ -16744,89 +22308,94 @@ ] }, "get": { - "description": "Gets a reasoning engine.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}", + "description": "Gets a Schedule.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.reasoningEngines.get", + "id": "aiplatform.projects.locations.schedules.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the ReasoningEngine resource. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "description": "Required. The name of the Schedule resource. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1ReasoningEngine" + "$ref": "GoogleCloudAiplatformV1Schedule" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists reasoning engines in a location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines", + "description": "Lists Schedules in a Location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules", "httpMethod": "GET", - "id": "aiplatform.projects.locations.reasoningEngines.list", + "id": "aiplatform.projects.locations.schedules.list", "parameterOrder": [ "parent" ], "parameters": { "filter": { - "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", + "description": "Lists the Schedules that match the filter expression. The following fields are supported: * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `state`: Supports `=` and `!=` comparisons. * `request`: Supports existence of the check. (e.g. `create_pipeline_job_request:*` --> Schedule has create_pipeline_job_request). * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `start_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, `>=` comparisons and `:*` existence check. Values must be in RFC 3339 format. * `next_run_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. Filter expressions can be combined together using logical operators (`NOT`, `AND` & `OR`). The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `state=\"ACTIVE\" AND display_name:\"my_schedule_*\"` * `NOT display_name=\"my_schedule\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `end_time>\"2021-05-18T00:00:00Z\" OR NOT end_time:*` * `create_pipeline_job_request:*`", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "A comma-separated list of fields to order by. The default sort order is in ascending order. Use \"desc\" after a field name for descending. You can have multiple order_by fields provided. For example, using \"create_time desc, end_time\" will order results by create time in descending order, and if there are multiple schedules having the same create time, order them by the end time in ascending order. If order_by is not specified, it will order by default with create_time in descending order. Supported fields: * `create_time` * `start_time` * `end_time` * `next_run_time`", "location": "query", "type": "string" }, "pageSize": { - "description": "Optional. The standard list page size.", + "description": "The standard list page size. Default to 100 if not specified.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. The standard list page token.", + "description": "The standard list page token. Typically obtained via ListSchedulesResponse.next_page_token of the previous ScheduleService.ListSchedules call.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project}/locations/{location}`", + "description": "Required. The resource name of the Location to list the Schedules from. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+parent}/reasoningEngines", + "path": "v1/{+parent}/schedules", "response": { - "$ref": "GoogleCloudAiplatformV1ListReasoningEnginesResponse" + "$ref": "GoogleCloudAiplatformV1ListSchedulesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { - "description": "Updates a reasoning engine.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}", + "description": "Updates an active or paused Schedule. When the Schedule is updated, new runs will be scheduled starting from the updated next execution time after the update time based on the time_specification in the updated Schedule. All unstarted runs before the update time will be skipped while already created runs will NOT be paused or canceled.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}", "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.reasoningEngines.patch", + "id": "aiplatform.projects.locations.schedules.patch", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "description": "Immutable. The resource name of the Schedule.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", "required": true, "type": "string" }, "updateMask": { - "description": "Optional. Mask specifying which fields to update.", + "description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -16834,66 +22403,387 @@ }, "path": "v1/{+name}", "request": { - "$ref": "GoogleCloudAiplatformV1ReasoningEngine" + "$ref": "GoogleCloudAiplatformV1Schedule" }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1Schedule" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "query": { - "description": "Queries using a reasoning engine.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:query", + "pause": { + "description": "Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:pause", "httpMethod": "POST", - "id": "aiplatform.projects.locations.reasoningEngines.query", + "id": "aiplatform.projects.locations.schedules.pause", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "description": "Required. The name of the Schedule resource to be paused. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+name}:query", + "path": "v1/{+name}:pause", "request": { - "$ref": "GoogleCloudAiplatformV1QueryReasoningEngineRequest" + "$ref": "GoogleCloudAiplatformV1PauseScheduleRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "resume": { + "description": "Resumes a paused Schedule to start scheduling new runs. Will mark Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed. When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If Schedule.catch_up is set up true, all missed runs will be scheduled for backfill first.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:resume", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.schedules.resume", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Schedule resource to be resumed. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:resume", + "request": { + "$ref": "GoogleCloudAiplatformV1ResumeScheduleRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.schedules.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.schedules.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.schedules.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.schedules.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.schedules.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "specialistPools": { + "methods": { + "create": { + "description": "Creates a SpecialistPool.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.specialistPools.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent Project name for the new SpecialistPool. The form is `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/specialistPools", + "request": { + "$ref": "GoogleCloudAiplatformV1SpecialistPool" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a SpecialistPool as well as all Specialists in the pool.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.specialistPools.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "If set to true, any specialist managers in this SpecialistPool will also be deleted. (Otherwise, the request will only work if the SpecialistPool has no specialist managers.)", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The resource name of the SpecialistPool to delete. Format: `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a SpecialistPool.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.specialistPools.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the SpecialistPool resource. The form is `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1SpecialistPool" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists SpecialistPools in a Location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.specialistPools.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token. Typically obtained by ListSpecialistPoolsResponse.next_page_token of the previous SpecialistPoolService.ListSpecialistPools call. Return first page if empty.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the SpecialistPool's parent resource. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read. FieldMask represents a set of", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } }, + "path": "v1/{+parent}/specialistPools", "response": { - "$ref": "GoogleCloudAiplatformV1QueryReasoningEngineResponse" + "$ref": "GoogleCloudAiplatformV1ListSpecialistPoolsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "streamQuery": { - "description": "Streams queries using a reasoning engine.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:streamQuery", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.reasoningEngines.streamQuery", + "patch": { + "description": "Updates a SpecialistPool.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.specialistPools.patch", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "description": "Required. The resource name of the SpecialistPool.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", "required": true, "type": "string" + }, + "updateMask": { + "description": "Required. The update mask applies to the resource.", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, - "path": "v1/{+name}:streamQuery", + "path": "v1/{+name}", "request": { - "$ref": "GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest" + "$ref": "GoogleCloudAiplatformV1SpecialistPool" }, "response": { - "$ref": "GoogleApiHttpBody" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -16905,9 +22795,9 @@ "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:cancel", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.reasoningEngines.operations.cancel", + "id": "aiplatform.projects.locations.specialistPools.operations.cancel", "parameterOrder": [ "name" ], @@ -16915,7 +22805,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -16930,9 +22820,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.reasoningEngines.operations.delete", + "id": "aiplatform.projects.locations.specialistPools.operations.delete", "parameterOrder": [ "name" ], @@ -16940,7 +22830,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -16955,9 +22845,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.reasoningEngines.operations.get", + "id": "aiplatform.projects.locations.specialistPools.operations.get", "parameterOrder": [ "name" ], @@ -16965,7 +22855,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -16980,9 +22870,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.reasoningEngines.operations.list", + "id": "aiplatform.projects.locations.specialistPools.operations.list", "parameterOrder": [ "name" ], @@ -16995,7 +22885,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", "required": true, "type": "string" }, @@ -17026,9 +22916,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:wait", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.reasoningEngines.operations.wait", + "id": "aiplatform.projects.locations.specialistPools.operations.wait", "parameterOrder": [ "name" ], @@ -17036,7 +22926,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -17059,217 +22949,145 @@ } } }, - "schedules": { + "studies": { "methods": { "create": { - "description": "Creates a Schedule.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules", + "description": "Creates a Study. A resource name will be generated after creation of the Study.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies", "httpMethod": "POST", - "id": "aiplatform.projects.locations.schedules.create", + "id": "aiplatform.projects.locations.studies.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { - "description": "Required. The resource name of the Location to create the Schedule in. Format: `projects/{project}/locations/{location}`", + "description": "Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+parent}/schedules", + "path": "v1/{+parent}/studies", "request": { - "$ref": "GoogleCloudAiplatformV1Schedule" + "$ref": "GoogleCloudAiplatformV1Study" }, "response": { - "$ref": "GoogleCloudAiplatformV1Schedule" + "$ref": "GoogleCloudAiplatformV1Study" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { - "description": "Deletes a Schedule.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}", + "description": "Deletes a Study.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.schedules.delete", + "id": "aiplatform.projects.locations.studies.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the Schedule resource to be deleted. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", + "description": "Required. The name of the Study resource to be deleted. Format: `projects/{project}/locations/{location}/studies/{study}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { - "description": "Gets a Schedule.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}", + "description": "Gets a Study by name.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.schedules.get", + "id": "aiplatform.projects.locations.studies.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the Schedule resource. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", + "description": "Required. The name of the Study resource. Format: `projects/{project}/locations/{location}/studies/{study}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1Schedule" + "$ref": "GoogleCloudAiplatformV1Study" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists Schedules in a Location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules", + "description": "Lists all the studies in a region for an associated project.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies", "httpMethod": "GET", - "id": "aiplatform.projects.locations.schedules.list", + "id": "aiplatform.projects.locations.studies.list", "parameterOrder": [ "parent" ], "parameters": { - "filter": { - "description": "Lists the Schedules that match the filter expression. The following fields are supported: * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `state`: Supports `=` and `!=` comparisons. * `request`: Supports existence of the check. (e.g. `create_pipeline_job_request:*` --> Schedule has create_pipeline_job_request). * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `start_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, `>=` comparisons and `:*` existence check. Values must be in RFC 3339 format. * `next_run_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. Filter expressions can be combined together using logical operators (`NOT`, `AND` & `OR`). The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `state=\"ACTIVE\" AND display_name:\"my_schedule_*\"` * `NOT display_name=\"my_schedule\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `end_time>\"2021-05-18T00:00:00Z\" OR NOT end_time:*` * `create_pipeline_job_request:*`", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "A comma-separated list of fields to order by. The default sort order is in ascending order. Use \"desc\" after a field name for descending. You can have multiple order_by fields provided. For example, using \"create_time desc, end_time\" will order results by create time in descending order, and if there are multiple schedules having the same create time, order them by the end time in ascending order. If order_by is not specified, it will order by default with create_time in descending order. Supported fields: * `create_time` * `start_time` * `end_time` * `next_run_time`", - "location": "query", - "type": "string" - }, "pageSize": { - "description": "The standard list page size. Default to 100 if not specified.", + "description": "Optional. The maximum number of studies to return per \"page\" of results. If unspecified, service will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "The standard list page token. Typically obtained via ListSchedulesResponse.next_page_token of the previous ScheduleService.ListSchedules call.", + "description": "Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the Location to list the Schedules from. Format: `projects/{project}/locations/{location}`", + "description": "Required. The resource name of the Location to list the Study from. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+parent}/schedules", - "response": { - "$ref": "GoogleCloudAiplatformV1ListSchedulesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "patch": { - "description": "Updates an active or paused Schedule. When the Schedule is updated, new runs will be scheduled starting from the updated next execution time after the update time based on the time_specification in the updated Schedule. All unstarted runs before the update time will be skipped while already created runs will NOT be paused or canceled.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.schedules.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Immutable. The resource name of the Schedule.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1Schedule" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1Schedule" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "pause": { - "description": "Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:pause", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.schedules.pause", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the Schedule resource to be paused. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:pause", - "request": { - "$ref": "GoogleCloudAiplatformV1PauseScheduleRequest" - }, + "path": "v1/{+parent}/studies", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleCloudAiplatformV1ListStudiesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "resume": { - "description": "Resumes a paused Schedule to start scheduling new runs. Will mark Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed. When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If Schedule.catch_up is set up true, all missed runs will be scheduled for backfill first.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:resume", + "lookup": { + "description": "Looks a study up using the user-defined display_name field instead of the fully qualified resource name.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies:lookup", "httpMethod": "POST", - "id": "aiplatform.projects.locations.schedules.resume", + "id": "aiplatform.projects.locations.studies.lookup", "parameterOrder": [ - "name" + "parent" ], "parameters": { - "name": { - "description": "Required. The name of the Schedule resource to be resumed. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", + "parent": { + "description": "Required. The resource name of the Location to get the Study from. Format: `projects/{project}/locations/{location}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+name}:resume", + "path": "v1/{+parent}/studies:lookup", "request": { - "$ref": "GoogleCloudAiplatformV1ResumeScheduleRequest" + "$ref": "GoogleCloudAiplatformV1LookupStudyRequest" }, "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleCloudAiplatformV1Study" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -17281,9 +23099,9 @@ "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:cancel", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.schedules.operations.cancel", + "id": "aiplatform.projects.locations.studies.operations.cancel", "parameterOrder": [ "name" ], @@ -17291,7 +23109,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -17306,124 +23124,410 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.schedules.operations.delete", + "id": "aiplatform.projects.locations.studies.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.studies.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.studies.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.studies.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "trials": { + "methods": { + "addTrialMeasurement": { + "description": "Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:addTrialMeasurement", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.studies.trials.addTrialMeasurement", + "parameterOrder": [ + "trialName" + ], + "parameters": { + "trialName": { + "description": "Required. The name of the trial to add measurement. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+trialName}:addTrialMeasurement", + "request": { + "$ref": "GoogleCloudAiplatformV1AddTrialMeasurementRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1Trial" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "checkTrialEarlyStoppingState": { + "description": "Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:checkTrialEarlyStoppingState", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.studies.trials.checkTrialEarlyStoppingState", + "parameterOrder": [ + "trialName" + ], + "parameters": { + "trialName": { + "description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+trialName}:checkTrialEarlyStoppingState", + "request": { + "$ref": "GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "complete": { + "description": "Marks a Trial as complete.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:complete", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.studies.trials.complete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:complete", + "request": { + "$ref": "GoogleCloudAiplatformV1CompleteTrialRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1Trial" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Adds a user provided Trial to a Study.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.studies.trials.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Study to create the Trial in. Format: `projects/{project}/locations/{location}/studies/{study}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/trials", + "request": { + "$ref": "GoogleCloudAiplatformV1Trial" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1Trial" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a Trial.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.studies.trials.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a Trial.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.studies.trials.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Trial resource. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1Trial" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists the Trials associated with a Study.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.studies.trials.list", "parameterOrder": [ - "name" + "parent" ], "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", + "pageSize": { + "description": "Optional. The number of Trials to retrieve per \"page\" of results. If unspecified, the service will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Study to list the Trial from. Format: `projects/{project}/locations/{location}/studies/{study}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+name}", + "path": "v1/{+parent}/trials", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleCloudAiplatformV1ListTrialsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.schedules.operations.get", + "listOptimalTrials": { + "description": "Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:listOptimalTrials", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.studies.trials.listOptimalTrials", "parameterOrder": [ - "name" + "parent" ], "parameters": { - "name": { - "description": "The name of the operation resource.", + "parent": { + "description": "Required. The name of the Study that the optimal Trial belongs to.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+name}", + "path": "v1/{+parent}/trials:listOptimalTrials", + "request": { + "$ref": "GoogleCloudAiplatformV1ListOptimalTrialsRequest" + }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1ListOptimalTrialsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.schedules.operations.list", + "stop": { + "description": "Stops a Trial.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:stop", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.studies.trials.stop", "parameterOrder": [ "name" ], "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, "name": { - "description": "The name of the operation's parent resource.", + "description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", "required": true, "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" } }, - "path": "v1/{+name}/operations", + "path": "v1/{+name}:stop", + "request": { + "$ref": "GoogleCloudAiplatformV1StopTrialRequest" + }, "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleCloudAiplatformV1Trial" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:wait", + "suggest": { + "description": "Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier. Returns a long-running operation associated with the generation of Trial suggestions. When this long-running operation succeeds, it will contain a SuggestTrialsResponse.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:suggest", "httpMethod": "POST", - "id": "aiplatform.projects.locations.schedules.operations.wait", + "id": "aiplatform.projects.locations.studies.trials.suggest", "parameterOrder": [ - "name" + "parent" ], "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", + "parent": { + "description": "Required. The project and location that the Study belongs to. Format: `projects/{project}/locations/{location}/studies/{study}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", "required": true, "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" } }, - "path": "v1/{+name}:wait", + "path": "v1/{+parent}/trials:suggest", + "request": { + "$ref": "GoogleCloudAiplatformV1SuggestTrialsRequest" + }, "response": { "$ref": "GoogleLongrunningOperation" }, @@ -17431,32 +23535,221 @@ "https://www.googleapis.com/auth/cloud-platform" ] } + }, + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.studies.trials.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.studies.trials.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.studies.trials.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.studies.trials.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.studies.trials.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } } } } }, - "specialistPools": { + "tensorboards": { "methods": { + "batchRead": { + "description": "Reads multiple TensorboardTimeSeries' data. The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:batchRead", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.batchRead", + "parameterOrder": [ + "tensorboard" + ], + "parameters": { + "tensorboard": { + "description": "Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`. The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", + "required": true, + "type": "string" + }, + "timeSeries": { + "description": "Required. The resource names of the TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", + "location": "query", + "repeated": true, + "type": "string" + } + }, + "path": "v1/{+tensorboard}:batchRead", + "response": { + "$ref": "GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "create": { - "description": "Creates a SpecialistPool.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools", + "description": "Creates a Tensorboard.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards", "httpMethod": "POST", - "id": "aiplatform.projects.locations.specialistPools.create", + "id": "aiplatform.projects.locations.tensorboards.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { - "description": "Required. The parent Project name for the new SpecialistPool. The form is `projects/{project}/locations/{location}`.", + "description": "Required. The resource name of the Location to create the Tensorboard in. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+parent}/specialistPools", + "path": "v1/{+parent}/tensorboards", "request": { - "$ref": "GoogleCloudAiplatformV1SpecialistPool" + "$ref": "GoogleCloudAiplatformV1Tensorboard" }, "response": { "$ref": "GoogleLongrunningOperation" @@ -17466,23 +23759,18 @@ ] }, "delete": { - "description": "Deletes a SpecialistPool as well as all Specialists in the pool.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}", + "description": "Deletes a Tensorboard.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.specialistPools.delete", + "id": "aiplatform.projects.locations.tensorboards.delete", "parameterOrder": [ "name" ], "parameters": { - "force": { - "description": "If set to true, any specialist managers in this SpecialistPool will also be deleted. (Otherwise, the request will only work if the SpecialistPool has no specialist managers.)", - "location": "query", - "type": "boolean" - }, "name": { - "description": "Required. The resource name of the SpecialistPool to delete. Format: `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`", + "description": "Required. The name of the Tensorboard to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", "required": true, "type": "string" } @@ -17496,90 +23784,102 @@ ] }, "get": { - "description": "Gets a SpecialistPool.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}", + "description": "Gets a Tensorboard.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.specialistPools.get", + "id": "aiplatform.projects.locations.tensorboards.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the SpecialistPool resource. The form is `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`.", + "description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1SpecialistPool" + "$ref": "GoogleCloudAiplatformV1Tensorboard" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" ] }, "list": { - "description": "Lists SpecialistPools in a Location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools", + "description": "Lists Tensorboards in a Location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards", "httpMethod": "GET", - "id": "aiplatform.projects.locations.specialistPools.list", + "id": "aiplatform.projects.locations.tensorboards.list", "parameterOrder": [ "parent" ], "parameters": { + "filter": { + "description": "Lists the Tensorboards that match the filter expression.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field to use to sort the list.", + "location": "query", + "type": "string" + }, "pageSize": { - "description": "The standard list page size.", + "description": "The maximum number of Tensorboards to return. The service may return fewer than this value. If unspecified, at most 100 Tensorboards are returned. The maximum value is 100; values above 100 are coerced to 100.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "The standard list page token. Typically obtained by ListSpecialistPoolsResponse.next_page_token of the previous SpecialistPoolService.ListSpecialistPools call. Return first page if empty.", + "description": "A page token, received from a previous TensorboardService.ListTensorboards call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboards must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The name of the SpecialistPool's parent resource. Format: `projects/{project}/locations/{location}`", + "description": "Required. The resource name of the Location to list Tensorboards. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, "readMask": { - "description": "Mask specifying which fields to read. FieldMask represents a set of", + "description": "Mask specifying which fields to read.", "format": "google-fieldmask", "location": "query", "type": "string" } }, - "path": "v1/{+parent}/specialistPools", + "path": "v1/{+parent}/tensorboards", "response": { - "$ref": "GoogleCloudAiplatformV1ListSpecialistPoolsResponse" + "$ref": "GoogleCloudAiplatformV1ListTensorboardsResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" ] }, "patch": { - "description": "Updates a SpecialistPool.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}", + "description": "Updates a Tensorboard.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}", "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.specialistPools.patch", + "id": "aiplatform.projects.locations.tensorboards.patch", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The resource name of the SpecialistPool.", + "description": "Output only. Name of the Tensorboard. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", "required": true, "type": "string" }, "updateMask": { - "description": "Required. The update mask applies to the resource.", + "description": "Required. Field mask is used to specify the fields to be overwritten in the Tensorboard resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -17587,7 +23887,7 @@ }, "path": "v1/{+name}", "request": { - "$ref": "GoogleCloudAiplatformV1SpecialistPool" + "$ref": "GoogleCloudAiplatformV1Tensorboard" }, "response": { "$ref": "GoogleLongrunningOperation" @@ -17595,320 +23895,1274 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "readSize": { + "description": "Returns the storage size for a given TensorBoard instance.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readSize", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.readSize", + "parameterOrder": [ + "tensorboard" + ], + "parameters": { + "tensorboard": { + "description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+tensorboard}:readSize", + "response": { + "$ref": "GoogleCloudAiplatformV1ReadTensorboardSizeResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "readUsage": { + "description": "Returns a list of monthly active users for a given TensorBoard instance.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readUsage", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.readUsage", + "parameterOrder": [ + "tensorboard" + ], + "parameters": { + "tensorboard": { + "description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+tensorboard}:readUsage", + "response": { + "$ref": "GoogleCloudAiplatformV1ReadTensorboardUsageResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { - "operations": { + "experiments": { "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:cancel", + "batchCreate": { + "description": "Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:batchCreate", "httpMethod": "POST", - "id": "aiplatform.projects.locations.specialistPools.operations.cancel", + "id": "aiplatform.projects.locations.tensorboards.experiments.batchCreate", "parameterOrder": [ - "name" + "parent" ], "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", + "parent": { + "description": "Required. The resource name of the TensorboardExperiment to create the TensorboardTimeSeries in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` The TensorboardRuns referenced by the parent fields in the CreateTensorboardTimeSeriesRequest messages must be sub resources of this TensorboardExperiment.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+name}:cancel", + "path": "v1/{+parent}:batchCreate", + "request": { + "$ref": "GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest" + }, "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a TensorboardExperiment.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tensorboards.experiments.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", + "required": true, + "type": "string" + }, + "tensorboardExperimentId": { + "description": "Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/experiments", + "request": { + "$ref": "GoogleCloudAiplatformV1TensorboardExperiment" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1TensorboardExperiment" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}", + "description": "Deletes a TensorboardExperiment.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.specialistPools.operations.delete", + "id": "aiplatform.projects.locations.tensorboards.experiments.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", + "description": "Required. The name of the TensorboardExperiment to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}", + "description": "Gets a TensorboardExperiment.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.specialistPools.operations.get", + "id": "aiplatform.projects.locations.tensorboards.experiments.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "The name of the operation resource.", + "description": "Required. The name of the TensorboardExperiment resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1TensorboardExperiment" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" ] }, "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations", + "description": "Lists TensorboardExperiments in a Location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments", "httpMethod": "GET", - "id": "aiplatform.projects.locations.specialistPools.operations.list", + "id": "aiplatform.projects.locations.tensorboards.experiments.list", "parameterOrder": [ - "name" + "parent" ], "parameters": { "filter": { - "description": "The standard list filter.", + "description": "Lists the TensorboardExperiments that match the filter expression.", "location": "query", "type": "string" }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", - "required": true, + "orderBy": { + "description": "Field to use to sort the list.", + "location": "query", "type": "string" }, "pageSize": { - "description": "The standard list page size.", + "description": "The maximum number of TensorboardExperiments to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardExperiments are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "The standard list page token.", + "description": "A page token, received from a previous TensorboardService.ListTensorboardExperiments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardExperiments must match the call that provided the page token.", "location": "query", "type": "string" }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "parent": { + "description": "Required. The resource name of the Tensorboard to list TensorboardExperiments. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", "location": "query", - "type": "boolean" + "type": "string" + } + }, + "path": "v1/{+parent}/experiments", + "response": { + "$ref": "GoogleCloudAiplatformV1ListTensorboardExperimentsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "patch": { + "description": "Updates a TensorboardExperiment.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.tensorboards.experiments.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Name of the TensorboardExperiment. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. Field mask is used to specify the fields to be overwritten in the TensorboardExperiment resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1TensorboardExperiment" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1TensorboardExperiment" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "write": { + "description": "Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. If any data fail to be ingested, an error is returned.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:write", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tensorboards.experiments.write", + "parameterOrder": [ + "tensorboardExperiment" + ], + "parameters": { + "tensorboardExperiment": { + "description": "Required. The resource name of the TensorboardExperiment to write data to. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+tensorboardExperiment}:write", + "request": { + "$ref": "GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tensorboards.experiments.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.tensorboards.experiments.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.experiments.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.experiments.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tensorboards.experiments.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "runs": { + "methods": { + "batchCreate": { + "description": "Batch create TensorboardRuns.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs:batchCreate", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.batchCreate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the TensorboardExperiment to create the TensorboardRuns in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` The parent field in the CreateTensorboardRunRequest messages must match this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/runs:batchCreate", + "request": { + "$ref": "GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a TensorboardRun.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", + "required": true, + "type": "string" + }, + "tensorboardRunId": { + "description": "Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/runs", + "request": { + "$ref": "GoogleCloudAiplatformV1TensorboardRun" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1TensorboardRun" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a TensorboardRun.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the TensorboardRun to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a TensorboardRun.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the TensorboardRun resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1TensorboardRun" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "list": { + "description": "Lists TensorboardRuns in a Location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Lists the TensorboardRuns that match the filter expression.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field to use to sort the list.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of TensorboardRuns to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardRuns are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous TensorboardService.ListTensorboardRuns call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardRuns must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/runs", + "response": { + "$ref": "GoogleCloudAiplatformV1ListTensorboardRunsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "patch": { + "description": "Updates a TensorboardRun.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Name of the TensorboardRun. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. Field mask is used to specify the fields to be overwritten in the TensorboardRun resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1TensorboardRun" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1TensorboardRun" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "write": { + "description": "Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}:write", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.write", + "parameterOrder": [ + "tensorboardRun" + ], + "parameters": { + "tensorboardRun": { + "description": "Required. The resource name of the TensorboardRun to write data to. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+tensorboardRun}:write", + "request": { + "$ref": "GoogleCloudAiplatformV1WriteTensorboardRunDataRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1WriteTensorboardRunDataResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, - "path": "v1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.specialistPools.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" + "timeSeries": { + "methods": { + "create": { + "description": "Creates a TensorboardTimeSeries.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the TensorboardRun to create the TensorboardTimeSeries in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", + "required": true, + "type": "string" + }, + "tensorboardTimeSeriesId": { + "description": "Optional. The user specified unique ID to use for the TensorboardTimeSeries, which becomes the final component of the TensorboardTimeSeries's resource name. This value should match \"a-z0-9{0, 127}\"", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/timeSeries", + "request": { + "$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a TensorboardTimeSeries.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the TensorboardTimeSeries to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "exportTensorboardTimeSeries": { + "description": "Exports a TensorboardTimeSeries' data. Data is returned in paginated responses.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:exportTensorboardTimeSeries", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.exportTensorboardTimeSeries", + "parameterOrder": [ + "tensorboardTimeSeries" + ], + "parameters": { + "tensorboardTimeSeries": { + "description": "Required. The resource name of the TensorboardTimeSeries to export data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+tensorboardTimeSeries}:exportTensorboardTimeSeries", + "request": { + "$ref": "GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a TensorboardTimeSeries.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the TensorboardTimeSeries resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "list": { + "description": "Lists TensorboardTimeSeries in a Location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Lists the TensorboardTimeSeries that match the filter expression.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field to use to sort the list.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of TensorboardTimeSeries to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardTimeSeries are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous TensorboardService.ListTensorboardTimeSeries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardTimeSeries must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/timeSeries", + "response": { + "$ref": "GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "patch": { + "description": "Updates a TensorboardTimeSeries.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Name of the TensorboardTimeSeries.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. Field mask is used to specify the fields to be overwritten in the TensorboardTimeSeries resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "read": { + "description": "Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:read", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.read", + "parameterOrder": [ + "tensorboardTimeSeries" + ], + "parameters": { + "filter": { + "description": "Reads the TensorboardTimeSeries' data that match the filter expression.", + "location": "query", + "type": "string" + }, + "maxDataPoints": { + "description": "The maximum number of TensorboardTimeSeries' data to return. This value should be a positive integer. This value can be set to -1 to return all data.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "tensorboardTimeSeries": { + "description": "Required. The resource name of the TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+tensorboardTimeSeries}:read", + "response": { + "$ref": "GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "readBlobData": { + "description": "Gets bytes of TensorboardBlobs. This is to allow reading blob data stored in consumer project's Cloud Storage bucket without users having to obtain Cloud Storage access permission.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:readBlobData", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.readBlobData", + "parameterOrder": [ + "timeSeries" + ], + "parameters": { + "blobIds": { + "description": "IDs of the blobs to read.", + "location": "query", + "repeated": true, + "type": "string" + }, + "timeSeries": { + "description": "Required. The resource name of the TensorboardTimeSeries to list Blobs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+timeSeries}:readBlobData", + "response": { + "$ref": "GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + }, + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } } - }, - "path": "v1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + } } } - } - } - }, - "studies": { - "methods": { - "create": { - "description": "Creates a Study. A resource name will be generated after creation of the Study.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.studies.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/studies", - "request": { - "$ref": "GoogleCloudAiplatformV1Study" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1Study" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a Study.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.studies.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the Study resource to be deleted. Format: `projects/{project}/locations/{location}/studies/{study}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets a Study by name.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.studies.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the Study resource. Format: `projects/{project}/locations/{location}/studies/{study}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1Study" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists all the studies in a region for an associated project.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.studies.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "Optional. The maximum number of studies to return per \"page\" of results. If unspecified, service will pick an appropriate default.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Location to list the Study from. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/studies", - "response": { - "$ref": "GoogleCloudAiplatformV1ListStudiesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] }, - "lookup": { - "description": "Looks a study up using the user-defined display_name field instead of the fully qualified resource name.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies:lookup", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.studies.lookup", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to get the Study from. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/studies:lookup", - "request": { - "$ref": "GoogleCloudAiplatformV1LookupStudyRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1Study" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:cancel", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.studies.operations.cancel", + "id": "aiplatform.projects.locations.tensorboards.operations.cancel", "parameterOrder": [ "name" ], @@ -17916,7 +25170,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -17931,9 +25185,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.studies.operations.delete", + "id": "aiplatform.projects.locations.tensorboards.operations.delete", "parameterOrder": [ "name" ], @@ -17941,250 +25195,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.studies.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.studies.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.studies.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, - "trials": { - "methods": { - "addTrialMeasurement": { - "description": "Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:addTrialMeasurement", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.studies.trials.addTrialMeasurement", - "parameterOrder": [ - "trialName" - ], - "parameters": { - "trialName": { - "description": "Required. The name of the trial to add measurement. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+trialName}:addTrialMeasurement", - "request": { - "$ref": "GoogleCloudAiplatformV1AddTrialMeasurementRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1Trial" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "checkTrialEarlyStoppingState": { - "description": "Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:checkTrialEarlyStoppingState", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.studies.trials.checkTrialEarlyStoppingState", - "parameterOrder": [ - "trialName" - ], - "parameters": { - "trialName": { - "description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+trialName}:checkTrialEarlyStoppingState", - "request": { - "$ref": "GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "complete": { - "description": "Marks a Trial as complete.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:complete", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.studies.trials.complete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:complete", - "request": { - "$ref": "GoogleCloudAiplatformV1CompleteTrialRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1Trial" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "create": { - "description": "Adds a user provided Trial to a Study.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.studies.trials.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the Study to create the Trial in. Format: `projects/{project}/locations/{location}/studies/{study}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/trials", - "request": { - "$ref": "GoogleCloudAiplatformV1Trial" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1Trial" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a Trial.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.studies.trials.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -18198,143 +25209,100 @@ ] }, "get": { - "description": "Gets a Trial.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}", + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.studies.trials.get", + "id": "aiplatform.projects.locations.tensorboards.operations.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the Trial resource. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", + "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1Trial" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists the Trials associated with a Study.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.studies.trials.list", + "id": "aiplatform.projects.locations.tensorboards.operations.list", "parameterOrder": [ - "parent" + "name" ], "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", + "required": true, + "type": "string" + }, "pageSize": { - "description": "Optional. The number of Trials to retrieve per \"page\" of results. If unspecified, the service will pick an appropriate default.", + "description": "The standard list page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.", + "description": "The standard list page token.", "location": "query", "type": "string" }, - "parent": { - "description": "Required. The resource name of the Study to list the Trial from. Format: `projects/{project}/locations/{location}/studies/{study}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/trials", - "response": { - "$ref": "GoogleCloudAiplatformV1ListTrialsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "listOptimalTrials": { - "description": "Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:listOptimalTrials", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.studies.trials.listOptimalTrials", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The name of the Study that the optimal Trial belongs to.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", - "required": true, - "type": "string" + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, - "path": "v1/{+parent}/trials:listOptimalTrials", - "request": { - "$ref": "GoogleCloudAiplatformV1ListOptimalTrialsRequest" - }, + "path": "v1/{+name}/operations", "response": { - "$ref": "GoogleCloudAiplatformV1ListOptimalTrialsResponse" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "stop": { - "description": "Stops a Trial.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:stop", + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.studies.trials.stop", + "id": "aiplatform.projects.locations.tensorboards.operations.wait", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", + "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", "required": true, "type": "string" - } - }, - "path": "v1/{+name}:stop", - "request": { - "$ref": "GoogleCloudAiplatformV1StopTrialRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1Trial" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "suggest": { - "description": "Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier. Returns a long-running operation associated with the generation of Trial suggestions. When this long-running operation succeeds, it will contain a SuggestTrialsResponse.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:suggest", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.studies.trials.suggest", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The project and location that the Study belongs to. Format: `projects/{project}/locations/{location}/studies/{study}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", - "required": true, + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", "type": "string" } }, - "path": "v1/{+parent}/trials:suggest", - "request": { - "$ref": "GoogleCloudAiplatformV1SuggestTrialsRequest" - }, + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, @@ -18342,242 +25310,81 @@ "https://www.googleapis.com/auth/cloud-platform" ] } - }, - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.studies.trials.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.studies.trials.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.studies.trials.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.studies.trials.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.studies.trials.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } } } } }, - "tensorboards": { + "trainingPipelines": { "methods": { - "batchRead": { - "description": "Reads multiple TensorboardTimeSeries' data. The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:batchRead", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.batchRead", + "cancel": { + "description": "Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetTrainingPipeline or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead it becomes a pipeline with a TrainingPipeline.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TrainingPipeline.state is set to `CANCELLED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.trainingPipelines.cancel", "parameterOrder": [ - "tensorboard" + "name" ], "parameters": { - "tensorboard": { - "description": "Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`. The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard.", + "name": { + "description": "Required. The name of the TrainingPipeline to cancel. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", "required": true, "type": "string" - }, - "timeSeries": { - "description": "Required. The resource names of the TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", - "location": "query", - "repeated": true, - "type": "string" } }, - "path": "v1/{+tensorboard}:batchRead", + "path": "v1/{+name}:cancel", + "request": { + "$ref": "GoogleCloudAiplatformV1CancelTrainingPipelineRequest" + }, "response": { - "$ref": "GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { - "description": "Creates a Tensorboard.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards", + "description": "Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines", "httpMethod": "POST", - "id": "aiplatform.projects.locations.tensorboards.create", + "id": "aiplatform.projects.locations.trainingPipelines.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { - "description": "Required. The resource name of the Location to create the Tensorboard in. Format: `projects/{project}/locations/{location}`", + "description": "Required. The resource name of the Location to create the TrainingPipeline in. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+parent}/tensorboards", + "path": "v1/{+parent}/trainingPipelines", "request": { - "$ref": "GoogleCloudAiplatformV1Tensorboard" + "$ref": "GoogleCloudAiplatformV1TrainingPipeline" }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1TrainingPipeline" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { - "description": "Deletes a Tensorboard.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}", + "description": "Deletes a TrainingPipeline.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.tensorboards.delete", + "id": "aiplatform.projects.locations.trainingPipelines.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the Tensorboard to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", + "description": "Required. The name of the TrainingPipeline resource to be deleted. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", "required": true, "type": "string" } @@ -18591,1559 +25398,2136 @@ ] }, "get": { - "description": "Gets a Tensorboard.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}", + "description": "Gets a TrainingPipeline.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.get", + "id": "aiplatform.projects.locations.trainingPipelines.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", + "description": "Required. The name of the TrainingPipeline resource. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1Tensorboard" + "$ref": "GoogleCloudAiplatformV1TrainingPipeline" }, "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": { - "description": "Lists Tensorboards in a Location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards", + "description": "Lists TrainingPipelines in a Location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines", "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.list", + "id": "aiplatform.projects.locations.trainingPipelines.list", "parameterOrder": [ "parent" ], "parameters": { "filter": { - "description": "Lists the Tensorboards that match the filter expression.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "Field to use to sort the list.", + "description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `training_task_definition` `=`, `!=` comparisons, and `:` wildcard. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"PIPELINE_STATE_SUCCEEDED\" AND display_name:\"my_pipeline_*\"` * `state!=\"PIPELINE_STATE_FAILED\" OR display_name=\"my_pipeline\"` * `NOT display_name=\"my_pipeline\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `training_task_definition:\"*automl_text_classification*\"`", "location": "query", "type": "string" }, "pageSize": { - "description": "The maximum number of Tensorboards to return. The service may return fewer than this value. If unspecified, at most 100 Tensorboards are returned. The maximum value is 100; values above 100 are coerced to 100.", + "description": "The standard list page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A page token, received from a previous TensorboardService.ListTensorboards call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboards must match the call that provided the page token.", + "description": "The standard list page token. Typically obtained via ListTrainingPipelinesResponse.next_page_token of the previous PipelineService.ListTrainingPipelines call.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the Location to list Tensorboards. Format: `projects/{project}/locations/{location}`", + "description": "Required. The resource name of the Location to list the TrainingPipelines from. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+parent}/tensorboards", - "response": { - "$ref": "GoogleCloudAiplatformV1ListTensorboardsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "patch": { - "description": "Updates a Tensorboard.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.tensorboards.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Output only. Name of the Tensorboard. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Required. Field mask is used to specify the fields to be overwritten in the Tensorboard resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1Tensorboard" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "readSize": { - "description": "Returns the storage size for a given TensorBoard instance.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readSize", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.readSize", - "parameterOrder": [ - "tensorboard" - ], - "parameters": { - "tensorboard": { - "description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+tensorboard}:readSize", - "response": { - "$ref": "GoogleCloudAiplatformV1ReadTensorboardSizeResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "readUsage": { - "description": "Returns a list of monthly active users for a given TensorBoard instance.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readUsage", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.readUsage", - "parameterOrder": [ - "tensorboard" - ], - "parameters": { - "tensorboard": { - "description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+tensorboard}:readUsage", - "response": { - "$ref": "GoogleCloudAiplatformV1ReadTensorboardUsageResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "experiments": { - "methods": { - "batchCreate": { - "description": "Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:batchCreate", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.tensorboards.experiments.batchCreate", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the TensorboardExperiment to create the TensorboardTimeSeries in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` The TensorboardRuns referenced by the parent fields in the CreateTensorboardTimeSeriesRequest messages must be sub resources of this TensorboardExperiment.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}:batchCreate", - "request": { - "$ref": "GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "required": true, + "type": "string" }, - "create": { - "description": "Creates a TensorboardExperiment.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments", + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/trainingPipelines", + "response": { + "$ref": "GoogleCloudAiplatformV1ListTrainingPipelinesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.tensorboards.experiments.create", + "id": "aiplatform.projects.locations.trainingPipelines.operations.cancel", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "parent": { - "description": "Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", + "name": { + "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", "required": true, "type": "string" - }, - "tensorboardExperimentId": { - "description": "Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`.", - "location": "query", - "type": "string" } }, - "path": "v1/{+parent}/experiments", - "request": { - "$ref": "GoogleCloudAiplatformV1TensorboardExperiment" - }, + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleCloudAiplatformV1TensorboardExperiment" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { - "description": "Deletes a TensorboardExperiment.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}", + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.tensorboards.experiments.delete", + "id": "aiplatform.projects.locations.trainingPipelines.operations.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the TensorboardExperiment to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", + "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { - "description": "Gets a TensorboardExperiment.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}", + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.experiments.get", + "id": "aiplatform.projects.locations.trainingPipelines.operations.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the TensorboardExperiment resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", + "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1TensorboardExperiment" + "$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": { - "description": "Lists TensorboardExperiments in a Location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.experiments.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Lists the TensorboardExperiments that match the filter expression.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "Field to use to sort the list.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of TensorboardExperiments to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardExperiments are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous TensorboardService.ListTensorboardExperiments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardExperiments must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Tensorboard to list TensorboardExperiments. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+parent}/experiments", - "response": { - "$ref": "GoogleCloudAiplatformV1ListTensorboardExperimentsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "patch": { - "description": "Updates a TensorboardExperiment.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.tensorboards.experiments.patch", + "id": "aiplatform.projects.locations.trainingPipelines.operations.list", "parameterOrder": [ "name" ], "parameters": { - "name": { - "description": "Output only. Name of the TensorboardExperiment. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Required. Field mask is used to specify the fields to be overwritten in the TensorboardExperiment resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1TensorboardExperiment" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1TensorboardExperiment" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "write": { - "description": "Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. If any data fail to be ingested, an error is returned.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:write", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.tensorboards.experiments.write", - "parameterOrder": [ - "tensorboardExperiment" - ], - "parameters": { - "tensorboardExperiment": { - "description": "Required. The resource name of the TensorboardExperiment to write data to. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+tensorboardExperiment}:write", - "request": { - "$ref": "GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.tensorboards.experiments.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.tensorboards.experiments.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.experiments.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.experiments.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.tensorboards.experiments.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, - "runs": { - "methods": { - "batchCreate": { - "description": "Batch create TensorboardRuns.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs:batchCreate", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.batchCreate", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the TensorboardExperiment to create the TensorboardRuns in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` The parent field in the CreateTensorboardRunRequest messages must match this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/runs:batchCreate", - "request": { - "$ref": "GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "create": { - "description": "Creates a TensorboardRun.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", - "required": true, - "type": "string" - }, - "tensorboardRunId": { - "description": "Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`.", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+parent}/runs", - "request": { - "$ref": "GoogleCloudAiplatformV1TensorboardRun" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1TensorboardRun" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a TensorboardRun.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the TensorboardRun to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets a TensorboardRun.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the TensorboardRun resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1TensorboardRun" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "list": { - "description": "Lists TensorboardRuns in a Location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Lists the TensorboardRuns that match the filter expression.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "Field to use to sort the list.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of TensorboardRuns to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardRuns are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous TensorboardService.ListTensorboardRuns call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardRuns must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+parent}/runs", - "response": { - "$ref": "GoogleCloudAiplatformV1ListTensorboardRunsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" }, - "patch": { - "description": "Updates a TensorboardRun.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Output only. Name of the TensorboardRun. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Required. Field mask is used to specify the fields to be overwritten in the TensorboardRun resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1TensorboardRun" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1TensorboardRun" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", + "required": true, + "type": "string" }, - "write": { - "description": "Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}:write", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.write", - "parameterOrder": [ - "tensorboardRun" - ], - "parameters": { - "tensorboardRun": { - "description": "Required. The resource name of the TensorboardRun to write data to. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+tensorboardRun}:write", - "request": { - "$ref": "GoogleCloudAiplatformV1WriteTensorboardRunDataRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1WriteTensorboardRunDataResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.trainingPipelines.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "tuningJobs": { + "methods": { + "cancel": { + "description": "Cancels a TuningJob. Starts asynchronous cancellation on the TuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use GenAiTuningService.GetTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the TuningJob is not deleted; instead it becomes a job with a TuningJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TuningJob.state is set to `CANCELLED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tuningJobs.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the TuningJob to cancel. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "request": { + "$ref": "GoogleCloudAiplatformV1CancelTuningJobRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a TuningJob. A created TuningJob right away will be attempted to be run.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tuningJobs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the TuningJob in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/tuningJobs", + "request": { + "$ref": "GoogleCloudAiplatformV1TuningJob" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1TuningJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a TuningJob.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tuningJobs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the TuningJob resource. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1TuningJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists TuningJobs in a Location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tuningJobs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The standard list filter.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token. Typically obtained via ListTuningJobsResponse.next_page_token of the previous GenAiTuningService.ListTuningJob][] call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list the TuningJobs from. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/tuningJobs", + "response": { + "$ref": "GoogleCloudAiplatformV1ListTuningJobsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "rebaseTunedModel": { + "description": "Rebase a TunedModel.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs:rebaseTunedModel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tuningJobs.rebaseTunedModel", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location into which to rebase the Model. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/tuningJobs:rebaseTunedModel", + "request": { + "$ref": "GoogleCloudAiplatformV1RebaseTunedModelRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tuningJobs.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.tuningJobs.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tuningJobs.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tuningJobs.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" }, - "timeSeries": { - "methods": { - "create": { - "description": "Creates a TensorboardTimeSeries.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the TensorboardRun to create the TensorboardTimeSeries in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", - "required": true, - "type": "string" - }, - "tensorboardTimeSeriesId": { - "description": "Optional. The user specified unique ID to use for the TensorboardTimeSeries, which becomes the final component of the TensorboardTimeSeries's resource name. This value should match \"a-z0-9{0, 127}\"", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+parent}/timeSeries", - "request": { - "$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a TensorboardTimeSeries.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the TensorboardTimeSeries to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "exportTensorboardTimeSeries": { - "description": "Exports a TensorboardTimeSeries' data. Data is returned in paginated responses.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:exportTensorboardTimeSeries", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.exportTensorboardTimeSeries", - "parameterOrder": [ - "tensorboardTimeSeries" - ], - "parameters": { - "tensorboardTimeSeries": { - "description": "Required. The resource name of the TensorboardTimeSeries to export data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+tensorboardTimeSeries}:exportTensorboardTimeSeries", - "request": { - "$ref": "GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets a TensorboardTimeSeries.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the TensorboardTimeSeries resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "list": { - "description": "Lists TensorboardTimeSeries in a Location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Lists the TensorboardTimeSeries that match the filter expression.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "Field to use to sort the list.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of TensorboardTimeSeries to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardTimeSeries are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous TensorboardService.ListTensorboardTimeSeries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardTimeSeries must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+parent}/timeSeries", - "response": { - "$ref": "GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "patch": { - "description": "Updates a TensorboardTimeSeries.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Output only. Name of the TensorboardTimeSeries.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Required. Field mask is used to specify the fields to be overwritten in the TensorboardTimeSeries resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "read": { - "description": "Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:read", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.read", - "parameterOrder": [ - "tensorboardTimeSeries" - ], - "parameters": { - "filter": { - "description": "Reads the TensorboardTimeSeries' data that match the filter expression.", - "location": "query", - "type": "string" - }, - "maxDataPoints": { - "description": "The maximum number of TensorboardTimeSeries' data to return. This value should be a positive integer. This value can be set to -1 to return all data.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "tensorboardTimeSeries": { - "description": "Required. The resource name of the TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+tensorboardTimeSeries}:read", - "response": { - "$ref": "GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "readBlobData": { - "description": "Gets bytes of TensorboardBlobs. This is to allow reading blob data stored in consumer project's Cloud Storage bucket without users having to obtain Cloud Storage access permission.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:readBlobData", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.readBlobData", - "parameterOrder": [ - "timeSeries" - ], - "parameters": { - "blobIds": { - "description": "IDs of the blobs to read.", - "location": "query", - "repeated": true, - "type": "string" - }, - "timeSeries": { - "description": "Required. The resource name of the TensorboardTimeSeries to list Blobs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+timeSeries}:readBlobData", - "response": { - "$ref": "GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - } - }, - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } - } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + } + }, + "publishers": { + "resources": { + "models": { + "methods": { + "computeTokens": { + "description": "Return a list of tokens based on the input text.", + "flatPath": "v1/publishers/{publishersId}/models/{modelsId}:computeTokens", + "httpMethod": "POST", + "id": "aiplatform.publishers.models.computeTokens", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.", + "location": "path", + "pattern": "^publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:computeTokens", + "request": { + "$ref": "GoogleCloudAiplatformV1ComputeTokensRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1ComputeTokensResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "countTokens": { + "description": "Perform a token counting.", + "flatPath": "v1/publishers/{publishersId}/models/{modelsId}:countTokens", + "httpMethod": "POST", + "id": "aiplatform.publishers.models.countTokens", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:countTokens", + "request": { + "$ref": "GoogleCloudAiplatformV1CountTokensRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1CountTokensResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "fetchPredictOperation": { + "description": "Fetch an asynchronous online prediction operation.", + "flatPath": "v1/publishers/{publishersId}/models/{modelsId}:fetchPredictOperation", + "httpMethod": "POST", + "id": "aiplatform.publishers.models.fetchPredictOperation", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`", + "location": "path", + "pattern": "^publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:fetchPredictOperation", + "request": { + "$ref": "GoogleCloudAiplatformV1FetchPredictOperationRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "generateContent": { + "description": "Generate content with multimodal inputs.", + "flatPath": "v1/publishers/{publishersId}/models/{modelsId}:generateContent", + "httpMethod": "POST", + "id": "aiplatform.publishers.models.generateContent", + "parameterOrder": [ + "model" + ], + "parameters": { + "model": { + "description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+model}:generateContent", + "request": { + "$ref": "GoogleCloudAiplatformV1GenerateContentRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1GenerateContentResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "get": { + "description": "Gets a Model Garden publisher model.", + "flatPath": "v1/publishers/{publishersId}/models/{modelsId}", + "httpMethod": "GET", + "id": "aiplatform.publishers.models.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "huggingFaceToken": { + "description": "Optional. Token used to access Hugging Face gated models.", + "location": "query", + "type": "string" + }, + "isHuggingFaceModel": { + "description": "Optional. Boolean indicates whether the requested model is a Hugging Face model.", + "location": "query", + "type": "boolean" + }, + "languageCode": { + "description": "Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}`", + "location": "path", + "pattern": "^publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "Optional. PublisherModel view specifying which fields to read.", + "enum": [ + "PUBLISHER_MODEL_VIEW_UNSPECIFIED", + "PUBLISHER_MODEL_VIEW_BASIC", + "PUBLISHER_MODEL_VIEW_FULL", + "PUBLISHER_MODEL_VERSION_VIEW_BASIC" + ], + "enumDescriptions": [ + "The default / unset value. The API will default to the BASIC view.", + "Include basic metadata about the publisher model, but not the full contents.", + "Include everything.", + "Include: VersionId, ModelVersionExternalName, and SupportedActions." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1PublisherModel" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "predict": { + "description": "Perform an online prediction.", + "flatPath": "v1/publishers/{publishersId}/models/{modelsId}:predict", + "httpMethod": "POST", + "id": "aiplatform.publishers.models.predict", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:predict", + "request": { + "$ref": "GoogleCloudAiplatformV1PredictRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1PredictResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "predictLongRunning": { + "description": "", + "flatPath": "v1/publishers/{publishersId}/models/{modelsId}:predictLongRunning", + "httpMethod": "POST", + "id": "aiplatform.publishers.models.predictLongRunning", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`", + "location": "path", + "pattern": "^publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}:predictLongRunning", + "request": { + "$ref": "GoogleCloudAiplatformV1PredictLongRunningRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "streamGenerateContent": { + "description": "Generate content with multimodal inputs with streaming support.", + "flatPath": "v1/publishers/{publishersId}/models/{modelsId}:streamGenerateContent", + "httpMethod": "POST", + "id": "aiplatform.publishers.models.streamGenerateContent", + "parameterOrder": [ + "model" + ], + "parameters": { + "model": { + "description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+model}:streamGenerateContent", + "request": { + "$ref": "GoogleCloudAiplatformV1GenerateContentRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1GenerateContentResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + } + } + }, + "ragCorpora": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/ragCorpora/{ragCorporaId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.ragCorpora.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^ragCorpora/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/ragCorpora/{ragCorporaId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.ragCorpora.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^ragCorpora/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/ragCorpora/{ragCorporaId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.ragCorpora.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^ragCorpora/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/ragCorpora/{ragCorporaId}/operations", + "httpMethod": "GET", + "id": "aiplatform.ragCorpora.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^ragCorpora/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/ragCorpora/{ragCorporaId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.ragCorpora.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^ragCorpora/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "ragFiles": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.ragCorpora.ragFiles.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" } - } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.ragCorpora.ragFiles.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.ragCorpora.ragFiles.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.ragCorpora.ragFiles.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.ragCorpora.ragFiles.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + }, + "ragEngineConfig": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/ragEngineConfig/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.ragEngineConfig.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^ragEngineConfig/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/ragEngineConfig/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.ragEngineConfig.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^ragEngineConfig/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/ragEngineConfig/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.ragEngineConfig.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^ragEngineConfig/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/ragEngineConfig/operations", + "httpMethod": "GET", + "id": "aiplatform.ragEngineConfig.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^ragEngineConfig$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/ragEngineConfig/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.ragEngineConfig.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^ragEngineConfig/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "reasoningEngines": { + "methods": { + "create": { + "description": "Creates a reasoning engine.", + "flatPath": "v1/reasoningEngines", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.create", + "parameterOrder": [], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project}/locations/{location}`", + "location": "query", + "type": "string" + } + }, + "path": "v1/reasoningEngines", + "request": { + "$ref": "GoogleCloudAiplatformV1ReasoningEngine" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a reasoning engine.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}", + "httpMethod": "DELETE", + "id": "aiplatform.reasoningEngines.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a reasoning engine.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the ReasoningEngine resource. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1ReasoningEngine" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists reasoning engines in a location.", + "flatPath": "v1/reasoningEngines", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.list", + "parameterOrder": [], + "parameters": { + "filter": { + "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project}/locations/{location}`", + "location": "query", + "type": "string" + } + }, + "path": "v1/reasoningEngines", + "response": { + "$ref": "GoogleCloudAiplatformV1ListReasoningEnginesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a reasoning engine.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}", + "httpMethod": "PATCH", + "id": "aiplatform.reasoningEngines.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Mask specifying which fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1ReasoningEngine" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "query": { + "description": "Queries using a reasoning engine.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}:query", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.query", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:query", + "request": { + "$ref": "GoogleCloudAiplatformV1QueryReasoningEngineRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1QueryReasoningEngineResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "streamQuery": { + "description": "Streams queries using a reasoning engine.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}:streamQuery", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.streamQuery", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:streamQuery", + "request": { + "$ref": "GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.reasoningEngines.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "schedules": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/schedules/{schedulesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.schedules.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^schedules/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/schedules/{schedulesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.schedules.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^schedules/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/schedules/{schedulesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.schedules.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^schedules/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/schedules/{schedulesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.schedules.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^schedules/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" }, - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.tensorboards.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.tensorboards.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.tensorboards.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } - } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "trainingPipelines": { + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/schedules/{schedulesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.schedules.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^schedules/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "specialistPools": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/specialistPools/{specialistPoolsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.specialistPools.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^specialistPools/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/specialistPools/{specialistPoolsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.specialistPools.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^specialistPools/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/specialistPools/{specialistPoolsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.specialistPools.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^specialistPools/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/specialistPools/{specialistPoolsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.specialistPools.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^specialistPools/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/specialistPools/{specialistPoolsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.specialistPools.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^specialistPools/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "studies": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/studies/{studiesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.studies.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^studies/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/studies/{studiesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.studies.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^studies/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/studies/{studiesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.studies.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^studies/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/studies/{studiesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.studies.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^studies/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/studies/{studiesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.studies.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^studies/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "trials": { + "resources": { + "operations": { "methods": { "cancel": { - "description": "Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetTrainingPipeline or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead it becomes a pipeline with a TrainingPipeline.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TrainingPipeline.state is set to `CANCELLED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}:cancel", + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.trainingPipelines.cancel", + "id": "aiplatform.studies.trials.operations.cancel", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the TrainingPipeline to cancel. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`", + "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", + "pattern": "^studies/[^/]+/trials/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}:cancel", - "request": { - "$ref": "GoogleCloudAiplatformV1CancelTrainingPipelineRequest" - }, "response": { "$ref": "GoogleProtobufEmpty" }, @@ -20151,98 +27535,77 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "create": { - "description": "Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.trainingPipelines.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the TrainingPipeline in. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/trainingPipelines", - "request": { - "$ref": "GoogleCloudAiplatformV1TrainingPipeline" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1TrainingPipeline" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "delete": { - "description": "Deletes a TrainingPipeline.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}", + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.trainingPipelines.delete", + "id": "aiplatform.studies.trials.operations.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the TrainingPipeline resource to be deleted. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`", + "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", + "pattern": "^studies/[^/]+/trials/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { - "description": "Gets a TrainingPipeline.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}", + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.trainingPipelines.get", + "id": "aiplatform.studies.trials.operations.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the TrainingPipeline resource. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`", + "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", + "pattern": "^studies/[^/]+/trials/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1TrainingPipeline" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists TrainingPipelines in a Location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/studies/{studiesId}/trials/{trialsId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.trainingPipelines.list", + "id": "aiplatform.studies.trials.operations.list", "parameterOrder": [ - "parent" + "name" ], "parameters": { "filter": { - "description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `training_task_definition` `=`, `!=` comparisons, and `:` wildcard. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"PIPELINE_STATE_SUCCEEDED\" AND display_name:\"my_pipeline_*\"` * `state!=\"PIPELINE_STATE_FAILED\" OR display_name=\"my_pipeline\"` * `NOT display_name=\"my_pipeline\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `training_task_definition:\"*automl_text_classification*\"`", + "description": "The standard list filter.", "location": "query", "type": "string" }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^studies/[^/]+/trials/[^/]+$", + "required": true, + "type": "string" + }, "pageSize": { "description": "The standard list page size.", "format": "int32", @@ -20250,215 +27613,85 @@ "type": "integer" }, "pageToken": { - "description": "The standard list page token. Typically obtained via ListTrainingPipelinesResponse.next_page_token of the previous PipelineService.ListTrainingPipelines call.", + "description": "The standard list page token.", "location": "query", "type": "string" }, - "parent": { - "description": "Required. The resource name of the Location to list the TrainingPipelines from. Format: `projects/{project}/locations/{location}`", + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.studies.trials.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^studies/[^/]+/trials/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", "location": "query", "type": "string" } }, - "path": "v1/{+parent}/trainingPipelines", + "path": "v1/{+name}:wait", "response": { - "$ref": "GoogleCloudAiplatformV1ListTrainingPipelinesResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } - }, - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.trainingPipelines.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.trainingPipelines.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.trainingPipelines.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.trainingPipelines.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.trainingPipelines.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } } - }, - "tuningJobs": { + } + } + } + } + }, + "tensorboards": { + "resources": { + "experiments": { + "resources": { + "operations": { "methods": { "cancel": { - "description": "Cancels a TuningJob. Starts asynchronous cancellation on the TuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use GenAiTuningService.GetTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the TuningJob is not deleted; instead it becomes a job with a TuningJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TuningJob.state is set to `CANCELLED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}:cancel", + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.tuningJobs.cancel", + "id": "aiplatform.tensorboards.experiments.operations.cancel", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the TuningJob to cancel. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`", + "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}:cancel", - "request": { - "$ref": "GoogleCloudAiplatformV1CancelTuningJobRequest" - }, "response": { "$ref": "GoogleProtobufEmpty" }, @@ -20466,121 +27699,126 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "create": { - "description": "Creates a TuningJob. A created TuningJob right away will be attempted to be run.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.tuningJobs.create", + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.tensorboards.experiments.operations.delete", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the TuningJob in. Format: `projects/{project}/locations/{location}`", + "name": { + "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+parent}/tuningJobs", - "request": { - "$ref": "GoogleCloudAiplatformV1TuningJob" - }, + "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1TuningJob" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { - "description": "Gets a TuningJob.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}", + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.tuningJobs.get", + "id": "aiplatform.tensorboards.experiments.operations.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the TuningJob resource. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`", + "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1TuningJob" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists TuningJobs in a Location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.tuningJobs.list", + "id": "aiplatform.tensorboards.experiments.operations.list", "parameterOrder": [ - "parent" + "name" ], "parameters": { "filter": { - "description": "Optional. The standard list filter.", + "description": "The standard list filter.", "location": "query", "type": "string" }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+$", + "required": true, + "type": "string" + }, "pageSize": { - "description": "Optional. The standard list page size.", + "description": "The standard list page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. The standard list page token. Typically obtained via ListTuningJobsResponse.next_page_token of the previous GenAiTuningService.ListTuningJob][] call.", + "description": "The standard list page token.", "location": "query", "type": "string" }, - "parent": { - "description": "Required. The resource name of the Location to list the TuningJobs from. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, - "path": "v1/{+parent}/tuningJobs", + "path": "v1/{+name}/operations", "response": { - "$ref": "GoogleCloudAiplatformV1ListTuningJobsResponse" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "rebaseTunedModel": { - "description": "Rebase a TunedModel.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs:rebaseTunedModel", + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.tuningJobs.rebaseTunedModel", + "id": "aiplatform.tensorboards.experiments.operations.wait", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "parent": { - "description": "Required. The resource name of the Location into which to rebase the Model. Format: `projects/{project}/locations/{location}`", + "name": { + "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", "required": true, "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" } }, - "path": "v1/{+parent}/tuningJobs:rebaseTunedModel", - "request": { - "$ref": "GoogleCloudAiplatformV1RebaseTunedModelRequest" - }, + "path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, @@ -20588,15 +27826,17 @@ "https://www.googleapis.com/auth/cloud-platform" ] } - }, + } + }, + "runs": { "resources": { "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}:cancel", + "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.tuningJobs.operations.cancel", + "id": "aiplatform.tensorboards.experiments.runs.operations.cancel", "parameterOrder": [ "name" ], @@ -20604,7 +27844,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -20619,9 +27859,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}", + "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.tuningJobs.operations.delete", + "id": "aiplatform.tensorboards.experiments.runs.operations.delete", "parameterOrder": [ "name" ], @@ -20629,7 +27869,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -20644,9 +27884,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}", + "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.tuningJobs.operations.get", + "id": "aiplatform.tensorboards.experiments.runs.operations.get", "parameterOrder": [ "name" ], @@ -20654,7 +27894,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -20669,9 +27909,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations", + "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.tuningJobs.operations.list", + "id": "aiplatform.tensorboards.experiments.runs.operations.list", "parameterOrder": [ "name" ], @@ -20684,7 +27924,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", "required": true, "type": "string" }, @@ -20712,493 +27952,653 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.tensorboards.experiments.runs.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "timeSeries": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.tensorboards.experiments.runs.timeSeries.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.tensorboards.experiments.runs.timeSeries.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.tensorboards.experiments.runs.timeSeries.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.tensorboards.experiments.runs.timeSeries.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.tensorboards.experiments.runs.timeSeries.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } } } } } } - } - } - }, - "publishers": { - "resources": { - "models": { + }, + "operations": { "methods": { - "computeTokens": { - "description": "Return a list of tokens based on the input text.", - "flatPath": "v1/publishers/{publishersId}/models/{modelsId}:computeTokens", + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/tensorboards/{tensorboardsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.publishers.models.computeTokens", + "id": "aiplatform.tensorboards.operations.cancel", "parameterOrder": [ - "endpoint" + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^tensorboards/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/tensorboards/{tensorboardsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.tensorboards.operations.delete", + "parameterOrder": [ + "name" ], "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.", + "name": { + "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^publishers/[^/]+/models/[^/]+$", + "pattern": "^tensorboards/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+endpoint}:computeTokens", - "request": { - "$ref": "GoogleCloudAiplatformV1ComputeTokensRequest" - }, + "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1ComputeTokensResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "countTokens": { - "description": "Perform a token counting.", - "flatPath": "v1/publishers/{publishersId}/models/{modelsId}:countTokens", - "httpMethod": "POST", - "id": "aiplatform.publishers.models.countTokens", + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/tensorboards/{tensorboardsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.tensorboards.operations.get", "parameterOrder": [ - "endpoint" + "name" ], "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "name": { + "description": "The name of the operation resource.", "location": "path", - "pattern": "^publishers/[^/]+/models/[^/]+$", + "pattern": "^tensorboards/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+endpoint}:countTokens", - "request": { - "$ref": "GoogleCloudAiplatformV1CountTokensRequest" + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/tensorboards/{tensorboardsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.tensorboards.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^tensorboards/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } }, + "path": "v1/{+name}/operations", "response": { - "$ref": "GoogleCloudAiplatformV1CountTokensResponse" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "fetchPredictOperation": { - "description": "Fetch an asynchronous online prediction operation.", - "flatPath": "v1/publishers/{publishersId}/models/{modelsId}:fetchPredictOperation", + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/tensorboards/{tensorboardsId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.publishers.models.fetchPredictOperation", + "id": "aiplatform.tensorboards.operations.wait", "parameterOrder": [ - "endpoint" + "name" ], "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`", + "name": { + "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^publishers/[^/]+/models/[^/]+$", + "pattern": "^tensorboards/[^/]+/operations/[^/]+$", "required": true, "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" } }, - "path": "v1/{+endpoint}:fetchPredictOperation", - "request": { - "$ref": "GoogleCloudAiplatformV1FetchPredictOperationRequest" - }, + "path": "v1/{+name}:wait", "response": { "$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" ] - }, - "generateContent": { - "description": "Generate content with multimodal inputs.", - "flatPath": "v1/publishers/{publishersId}/models/{modelsId}:generateContent", + } + } + } + } + }, + "trainingPipelines": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.publishers.models.generateContent", + "id": "aiplatform.trainingPipelines.operations.cancel", "parameterOrder": [ - "model" + "name" ], "parameters": { - "model": { - "description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "name": { + "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^publishers/[^/]+/models/[^/]+$", + "pattern": "^trainingPipelines/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+model}:generateContent", - "request": { - "$ref": "GoogleCloudAiplatformV1GenerateContentRequest" + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.trainingPipelines.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^trainingPipelines/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } }, + "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1GenerateContentResponse" + "$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": { - "description": "Gets a Model Garden publisher model.", - "flatPath": "v1/publishers/{publishersId}/models/{modelsId}", + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.publishers.models.get", + "id": "aiplatform.trainingPipelines.operations.get", "parameterOrder": [ "name" ], "parameters": { - "huggingFaceToken": { - "description": "Optional. Token used to access Hugging Face gated models.", + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^trainingPipelines/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/trainingPipelines/{trainingPipelinesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.trainingPipelines.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", "location": "query", "type": "string" }, - "isHuggingFaceModel": { - "description": "Optional. Boolean indicates whether the requested model is a Hugging Face model.", + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^trainingPipelines/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", "location": "query", - "type": "boolean" + "type": "integer" }, - "languageCode": { - "description": "Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in.", + "pageToken": { + "description": "The standard list page token.", "location": "query", "type": "string" }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.trainingPipelines.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { "name": { - "description": "Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}`", + "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^publishers/[^/]+/models/[^/]+$", + "pattern": "^trainingPipelines/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, - "view": { - "description": "Optional. PublisherModel view specifying which fields to read.", - "enum": [ - "PUBLISHER_MODEL_VIEW_UNSPECIFIED", - "PUBLISHER_MODEL_VIEW_BASIC", - "PUBLISHER_MODEL_VIEW_FULL", - "PUBLISHER_MODEL_VERSION_VIEW_BASIC" - ], - "enumDescriptions": [ - "The default / unset value. The API will default to the BASIC view.", - "Include basic metadata about the publisher model, but not the full contents.", - "Include everything.", - "Include: VersionId, ModelVersionExternalName, and SupportedActions." - ], + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", "location": "query", "type": "string" } }, - "path": "v1/{+name}", + "path": "v1/{+name}:wait", "response": { - "$ref": "GoogleCloudAiplatformV1PublisherModel" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "predict": { - "description": "Perform an online prediction.", - "flatPath": "v1/publishers/{publishersId}/models/{modelsId}:predict", + } + } + } + } + }, + "tuningJobs": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/tuningJobs/{tuningJobsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.publishers.models.predict", + "id": "aiplatform.tuningJobs.operations.cancel", "parameterOrder": [ - "endpoint" + "name" ], "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "name": { + "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^publishers/[^/]+/models/[^/]+$", + "pattern": "^tuningJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+endpoint}:predict", - "request": { - "$ref": "GoogleCloudAiplatformV1PredictRequest" - }, + "path": "v1/{+name}:cancel", "response": { - "$ref": "GoogleCloudAiplatformV1PredictResponse" + "$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" ] }, - "predictLongRunning": { - "description": "", - "flatPath": "v1/publishers/{publishersId}/models/{modelsId}:predictLongRunning", - "httpMethod": "POST", - "id": "aiplatform.publishers.models.predictLongRunning", + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/tuningJobs/{tuningJobsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.tuningJobs.operations.delete", "parameterOrder": [ - "endpoint" + "name" ], "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`", + "name": { + "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^publishers/[^/]+/models/[^/]+$", + "pattern": "^tuningJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+endpoint}:predictLongRunning", - "request": { - "$ref": "GoogleCloudAiplatformV1PredictLongRunningRequest" + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/tuningJobs/{tuningJobsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.tuningJobs.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^tuningJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } }, + "path": "v1/{+name}", "response": { "$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" ] }, - "streamGenerateContent": { - "description": "Generate content with multimodal inputs with streaming support.", - "flatPath": "v1/publishers/{publishersId}/models/{modelsId}:streamGenerateContent", - "httpMethod": "POST", - "id": "aiplatform.publishers.models.streamGenerateContent", + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/tuningJobs/{tuningJobsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.tuningJobs.operations.list", "parameterOrder": [ - "model" + "name" ], "parameters": { - "model": { - "description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^publishers/[^/]+/models/[^/]+$", + "pattern": "^tuningJobs/[^/]+$", "required": true, "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, - "path": "v1/{+model}:streamGenerateContent", - "request": { - "$ref": "GoogleCloudAiplatformV1GenerateContentRequest" - }, + "path": "v1/{+name}/operations", "response": { - "$ref": "GoogleCloudAiplatformV1GenerateContentResponse" + "$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" ] } } } } - }, - "reasoningEngines": { - "methods": { - "create": { - "description": "Creates a reasoning engine.", - "flatPath": "v1/reasoningEngines", - "httpMethod": "POST", - "id": "aiplatform.reasoningEngines.create", - "parameterOrder": [], - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project}/locations/{location}`", - "location": "query", - "type": "string" - } - }, - "path": "v1/reasoningEngines", - "request": { - "$ref": "GoogleCloudAiplatformV1ReasoningEngine" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a reasoning engine.", - "flatPath": "v1/reasoningEngines/{reasoningEnginesId}", - "httpMethod": "DELETE", - "id": "aiplatform.reasoningEngines.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "force": { - "description": "Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources.", - "location": "query", - "type": "boolean" - }, - "name": { - "description": "Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", - "location": "path", - "pattern": "^reasoningEngines/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets a reasoning engine.", - "flatPath": "v1/reasoningEngines/{reasoningEnginesId}", - "httpMethod": "GET", - "id": "aiplatform.reasoningEngines.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the ReasoningEngine resource. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", - "location": "path", - "pattern": "^reasoningEngines/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1ReasoningEngine" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists reasoning engines in a location.", - "flatPath": "v1/reasoningEngines", - "httpMethod": "GET", - "id": "aiplatform.reasoningEngines.list", - "parameterOrder": [], - "parameters": { - "filter": { - "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The standard list page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project}/locations/{location}`", - "location": "query", - "type": "string" - } - }, - "path": "v1/reasoningEngines", - "response": { - "$ref": "GoogleCloudAiplatformV1ListReasoningEnginesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "patch": { - "description": "Updates a reasoning engine.", - "flatPath": "v1/reasoningEngines/{reasoningEnginesId}", - "httpMethod": "PATCH", - "id": "aiplatform.reasoningEngines.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", - "location": "path", - "pattern": "^reasoningEngines/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Optional. Mask specifying which fields to update.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1ReasoningEngine" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "query": { - "description": "Queries using a reasoning engine.", - "flatPath": "v1/reasoningEngines/{reasoningEnginesId}:query", - "httpMethod": "POST", - "id": "aiplatform.reasoningEngines.query", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", - "location": "path", - "pattern": "^reasoningEngines/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:query", - "request": { - "$ref": "GoogleCloudAiplatformV1QueryReasoningEngineRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1QueryReasoningEngineResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "streamQuery": { - "description": "Streams queries using a reasoning engine.", - "flatPath": "v1/reasoningEngines/{reasoningEnginesId}:streamQuery", - "httpMethod": "POST", - "id": "aiplatform.reasoningEngines.streamQuery", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", - "location": "path", - "pattern": "^reasoningEngines/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:streamQuery", - "request": { - "$ref": "GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest" - }, - "response": { - "$ref": "GoogleApiHttpBody" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } } }, - "revision": "20251003", + "revision": "20251027", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -24271,7 +31671,9 @@ "GETTING_CONTAINER_IMAGE", "STARTING_MODEL_SERVER", "FINISHING_UP", - "DEPLOYMENT_TERMINATED" + "DEPLOYMENT_TERMINATED", + "SUCCESSFULLY_DEPLOYED", + "FAILED_TO_DEPLOY" ], "enumDescriptions": [ "Default value. This value is unused.", @@ -24282,7 +31684,9 @@ "The deployment is getting the container image for the model server.", "The deployment is starting the model server.", "The deployment is performing finalization steps.", - "The deployment has terminated." + "The deployment has terminated.", + "The deployment has succeeded.", + "The deployment has failed." ], "readOnly": true, "type": "string" @@ -25364,7 +32768,9 @@ "GETTING_CONTAINER_IMAGE", "STARTING_MODEL_SERVER", "FINISHING_UP", - "DEPLOYMENT_TERMINATED" + "DEPLOYMENT_TERMINATED", + "SUCCESSFULLY_DEPLOYED", + "FAILED_TO_DEPLOY" ], "enumDescriptions": [ "Default value. This value is unused.", @@ -25375,7 +32781,9 @@ "The deployment is getting the container image for the model server.", "The deployment is starting the model server.", "The deployment is performing finalization steps.", - "The deployment has terminated." + "The deployment has terminated.", + "The deployment has succeeded.", + "The deployment has failed." ], "readOnly": true, "type": "string" @@ -26063,6 +33471,90 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1EmbedContentRequest": { + "description": "Request message for PredictionService.EmbedContent.", + "id": "GoogleCloudAiplatformV1EmbedContentRequest", + "properties": { + "autoTruncate": { + "description": "Optional. Whether to silently truncate the input content if it's longer than the maximum sequence length.", + "type": "boolean" + }, + "content": { + "$ref": "GoogleCloudAiplatformV1Content", + "description": "Required. Input content to be embedded. Required." + }, + "outputDimensionality": { + "description": "Optional. Optional reduced dimension for the output embedding. If set, excessive values in the output embedding are truncated from the end.", + "format": "int32", + "type": "integer" + }, + "taskType": { + "description": "Optional. The task type of the embedding.", + "enum": [ + "UNSPECIFIED", + "RETRIEVAL_QUERY", + "RETRIEVAL_DOCUMENT", + "SEMANTIC_SIMILARITY", + "CLASSIFICATION", + "CLUSTERING", + "QUESTION_ANSWERING", + "FACT_VERIFICATION", + "CODE_RETRIEVAL_QUERY" + ], + "enumDescriptions": [ + "Unset value, which will default to one of the other enum values.", + "Specifies the given text is a query in a search/retrieval setting.", + "Specifies the given text is a document from the corpus being searched.", + "Specifies the given text will be used for STS.", + "Specifies that the given text will be classified.", + "Specifies that the embeddings will be used for clustering.", + "Specifies that the embeddings will be used for question answering.", + "Specifies that the embeddings will be used for fact verification.", + "Specifies that the embeddings will be used for code retrieval." + ], + "type": "string" + }, + "title": { + "description": "Optional. An optional title for the text.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1EmbedContentResponse": { + "description": "Response message for PredictionService.EmbedContent.", + "id": "GoogleCloudAiplatformV1EmbedContentResponse", + "properties": { + "embedding": { + "$ref": "GoogleCloudAiplatformV1EmbedContentResponseEmbedding", + "description": "The embedding generated from the input content." + }, + "truncated": { + "description": "Whether the input content was truncated before generating the embedding.", + "type": "boolean" + }, + "usageMetadata": { + "$ref": "GoogleCloudAiplatformV1UsageMetadata", + "description": "Metadata about the response(s)." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1EmbedContentResponseEmbedding": { + "description": "A list of floats representing an embedding.", + "id": "GoogleCloudAiplatformV1EmbedContentResponseEmbedding", + "properties": { + "values": { + "description": "Embedding vector values.", + "items": { + "format": "float", + "type": "number" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1EncryptionSpec": { "description": "Represents a customer-managed encryption key spec that can be applied to a top-level resource.", "id": "GoogleCloudAiplatformV1EncryptionSpec", @@ -26785,6 +34277,10 @@ "description": "A single instance to be evaluated. Instances are used to specify the input data for evaluation, from simple string comparisons to complex, multi-turn model evaluations", "id": "GoogleCloudAiplatformV1EvaluationInstance", "properties": { + "agentData": { + "$ref": "GoogleCloudAiplatformV1EvaluationInstanceAgentData", + "description": "Optional. Data used for agent evaluation." + }, "otherData": { "$ref": "GoogleCloudAiplatformV1EvaluationInstanceMapInstance", "description": "Optional. Other data used to populate placeholders based on their key." @@ -26811,6 +34307,102 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1EvaluationInstanceAgentConfig": { + "description": "Configuration for an Agent.", + "id": "GoogleCloudAiplatformV1EvaluationInstanceAgentConfig", + "properties": { + "developerInstruction": { + "$ref": "GoogleCloudAiplatformV1EvaluationInstanceInstanceData", + "description": "Optional. A field containing instructions from the developer for the agent." + }, + "tools": { + "$ref": "GoogleCloudAiplatformV1EvaluationInstanceAgentConfigTools", + "description": "List of tools." + }, + "toolsText": { + "description": "A JSON string containing a list of tools available to an agent with info such as name, description, parameters and required parameters.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1EvaluationInstanceAgentConfigTools": { + "description": "Represents a list of tools for an agent.", + "id": "GoogleCloudAiplatformV1EvaluationInstanceAgentConfigTools", + "properties": { + "tool": { + "description": "Optional. List of tools: each tool can have multiple function declarations.", + "items": { + "$ref": "GoogleCloudAiplatformV1Tool" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1EvaluationInstanceAgentData": { + "description": "Contains data specific to agent evaluations.", + "id": "GoogleCloudAiplatformV1EvaluationInstanceAgentData", + "properties": { + "agentConfig": { + "$ref": "GoogleCloudAiplatformV1EvaluationInstanceAgentConfig", + "description": "Optional. Agent configuration." + }, + "developerInstruction": { + "$ref": "GoogleCloudAiplatformV1EvaluationInstanceInstanceData", + "deprecated": true, + "description": "Optional. A field containing instructions from the developer for the agent." + }, + "events": { + "$ref": "GoogleCloudAiplatformV1EvaluationInstanceAgentDataEvents", + "description": "A list of events." + }, + "eventsText": { + "description": "A JSON string containing a sequence of events.", + "type": "string" + }, + "tools": { + "$ref": "GoogleCloudAiplatformV1EvaluationInstanceAgentDataTools", + "deprecated": true, + "description": "List of tools." + }, + "toolsText": { + "deprecated": true, + "description": "A JSON string containing a list of tools available to an agent with info such as name, description, parameters and required parameters. Example: [ { \"name\": \"search_actors\", \"description\": \"Search for actors in a movie. Returns a list of actors, their roles, their birthdate, and their place of birth.\", \"parameters\": [ { \"name\": \"movie_name\", \"description\": \"The name of the movie.\" }, { \"name\": \"character_name\", \"description\": \"The name of the character.\" } ], \"required\": [\"movie_name\", \"character_name\"] } ]", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1EvaluationInstanceAgentDataEvents": { + "description": "Represents a list of events for an agent.", + "id": "GoogleCloudAiplatformV1EvaluationInstanceAgentDataEvents", + "properties": { + "event": { + "description": "Optional. A list of events.", + "items": { + "$ref": "GoogleCloudAiplatformV1Content" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1EvaluationInstanceAgentDataTools": { + "description": "Represents a list of tools for an agent.", + "id": "GoogleCloudAiplatformV1EvaluationInstanceAgentDataTools", + "properties": { + "tool": { + "deprecated": true, + "description": "Optional. List of tools: each tool can have multiple function declarations.", + "items": { + "$ref": "GoogleCloudAiplatformV1Tool" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1EvaluationInstanceInstanceData": { "description": "Instance data used to populate placeholders in a metric prompt template.", "id": "GoogleCloudAiplatformV1EvaluationInstanceInstanceData", @@ -27266,6 +34858,10 @@ "description": "Required. The name of the metric.", "type": "string" }, + "metricConfig": { + "$ref": "GoogleCloudAiplatformV1Metric", + "description": "The metric config." + }, "predefinedMetricSpec": { "$ref": "GoogleCloudAiplatformV1EvaluationRunMetricPredefinedMetricSpec", "description": "Spec for a pre-defined metric." @@ -30353,6 +37949,13 @@ "description": "Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].", "type": "string" }, + "parts": { + "description": "Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.", + "items": { + "$ref": "GoogleCloudAiplatformV1FunctionResponsePart" + }, + "type": "array" + }, "response": { "additionalProperties": { "description": "Properties of the object.", @@ -30364,6 +37967,60 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1FunctionResponseBlob": { + "description": "Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field.", + "id": "GoogleCloudAiplatformV1FunctionResponseBlob", + "properties": { + "data": { + "description": "Required. Raw bytes.", + "format": "byte", + "type": "string" + }, + "displayName": { + "description": "Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.", + "type": "string" + }, + "mimeType": { + "description": "Required. The IANA standard MIME type of the source data.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1FunctionResponseFileData": { + "description": "URI based data for function response.", + "id": "GoogleCloudAiplatformV1FunctionResponseFileData", + "properties": { + "displayName": { + "description": "Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.", + "type": "string" + }, + "fileUri": { + "description": "Required. URI.", + "type": "string" + }, + "mimeType": { + "description": "Required. The IANA standard MIME type of the source data.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1FunctionResponsePart": { + "description": "A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.", + "id": "GoogleCloudAiplatformV1FunctionResponsePart", + "properties": { + "fileData": { + "$ref": "GoogleCloudAiplatformV1FunctionResponseFileData", + "description": "URI based data." + }, + "inlineData": { + "$ref": "GoogleCloudAiplatformV1FunctionResponseBlob", + "description": "Inline media bytes." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1GcsDestination": { "description": "The Google Cloud Storage location where the output is to be written to.", "id": "GoogleCloudAiplatformV1GcsDestination", @@ -30675,6 +38332,10 @@ "description": "Request message for EvaluationService.GenerateInstanceRubrics.", "id": "GoogleCloudAiplatformV1GenerateInstanceRubricsRequest", "properties": { + "agentConfig": { + "$ref": "GoogleCloudAiplatformV1EvaluationInstanceAgentConfig", + "description": "Optional. Agent configuration, required for agent-based rubric generation." + }, "contents": { "description": "Required. The prompt to generate rubrics from. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.", "items": { @@ -31538,6 +39199,42 @@ "aspectRatio": { "description": "Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: \"1:1\" \"2:3\", \"3:2\" \"3:4\", \"4:3\" \"4:5\", \"5:4\" \"9:16\", \"16:9\" \"21:9\"", "type": "string" + }, + "imageOutputOptions": { + "$ref": "GoogleCloudAiplatformV1ImageConfigImageOutputOptions", + "description": "Optional. The image output format for generated images." + }, + "personGeneration": { + "description": "Optional. Controls whether the model can generate people.", + "enum": [ + "PERSON_GENERATION_UNSPECIFIED", + "ALLOW_ALL", + "ALLOW_ADULT", + "ALLOW_NONE" + ], + "enumDescriptions": [ + "Generation images of people unspecified.", + "Generate images that include adults and children.", + "Generate images of adults, but not children.", + "Block generation of images of people." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ImageConfigImageOutputOptions": { + "description": "The image output format for generated images.", + "id": "GoogleCloudAiplatformV1ImageConfigImageOutputOptions", + "properties": { + "compressionQuality": { + "description": "Optional. The compression quality of the output image.", + "format": "int32", + "type": "integer" + }, + "mimeType": { + "description": "Optional. The image format that the output should be saved as.", + "type": "string" } }, "type": "object" @@ -35518,7 +43215,7 @@ "properties": { "deployedModel": { "$ref": "GoogleCloudAiplatformV1DeployedModel", - "description": "Required. The DeployedModel to be mutated within the Endpoint. Only the following fields can be mutated: * `min_replica_count` in either DedicatedResources or AutomaticResources * `max_replica_count` in either DedicatedResources or AutomaticResources * `required_replica_count` in DedicatedResources * autoscaling_metric_specs * `disable_container_logging` (v1 only) * `enable_container_logging` (v1beta1 only)" + "description": "Required. The DeployedModel to be mutated within the Endpoint. Only the following fields can be mutated: * `min_replica_count` in either DedicatedResources or AutomaticResources * `max_replica_count` in either DedicatedResources or AutomaticResources * `required_replica_count` in DedicatedResources * autoscaling_metric_specs * `disable_container_logging` (v1 only) * `enable_container_logging` (v1beta1 only) * `scale_to_zero_spec` in DedicatedResources (v1beta1 only) * `initial_replica_count` in DedicatedResources (v1beta1 only)" }, "updateMask": { "description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask.", @@ -38080,6 +45777,13 @@ }, "type": "array" }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The user labels for Imagen billing usage only. Only Imagen supports labels. For other use cases, it will be ignored.", + "type": "object" + }, "parameters": { "description": "The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' Model's PredictSchemata's parameters_schema_uri.", "type": "any" @@ -39694,7 +47398,7 @@ }, "scaled": { "$ref": "GoogleCloudAiplatformV1RagManagedDbConfigScaled", - "description": "Sets the RagManagedDb to the Scaled tier." + "description": "Sets the RagManagedDb to the Scaled tier. This is the default tier if not explicitly chosen." }, "unprovisioned": { "$ref": "GoogleCloudAiplatformV1RagManagedDbConfigUnprovisioned", @@ -40268,6 +47972,10 @@ "serviceAccount": { "description": "Optional. The service account that the Reasoning Engine artifact runs as. It should have \"roles/storage.objectViewer\" for reading the user project's Cloud Storage and \"roles/aiplatform.user\" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used.", "type": "string" + }, + "sourceCodeSpec": { + "$ref": "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpec", + "description": "Deploy from source code files with a defined entrypoint." } }, "type": "object" @@ -40342,6 +48050,56 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpec": { + "description": "Specification for deploying from source code.", + "id": "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpec", + "properties": { + "inlineSource": { + "$ref": "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecInlineSource", + "description": "Source code is provided directly in the request." + }, + "pythonSpec": { + "$ref": "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecPythonSpec", + "description": "Configuration for a Python application." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecInlineSource": { + "description": "Specifies source code provided as a byte stream.", + "id": "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecInlineSource", + "properties": { + "sourceArchive": { + "description": "Required. Input only. The application source code archive, provided as a compressed tarball (.tar.gz) file.", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecPythonSpec": { + "description": "Specification for running a Python application from source.", + "id": "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecPythonSpec", + "properties": { + "entrypointModule": { + "description": "Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to \"agent\". The project root will be added to Python sys.path, allowing imports to be specified relative to the root.", + "type": "string" + }, + "entrypointObject": { + "description": "Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to \"root_agent\".", + "type": "string" + }, + "requirementsFile": { + "description": "Optional. The path to the requirements file, relative to the source root. If not specified, defaults to \"requirements.txt\".", + "type": "string" + }, + "version": { + "description": "Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, default value is 3.10.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1RebaseTunedModelRequest": { "description": "Request message for GenAiTuningService.RebaseTunedModel.", "id": "GoogleCloudAiplatformV1RebaseTunedModelRequest", @@ -48248,6 +56006,10 @@ "$ref": "GoogleCloudAiplatformV1ToolCodeExecution", "description": "Optional. CodeExecution tool type. Enables the model to execute code as part of generation." }, + "computerUse": { + "$ref": "GoogleCloudAiplatformV1ToolComputerUse", + "description": "Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations." + }, "enterpriseWebSearch": { "$ref": "GoogleCloudAiplatformV1EnterpriseWebSearch", "description": "Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance." @@ -48371,6 +56133,32 @@ "properties": {}, "type": "object" }, + "GoogleCloudAiplatformV1ToolComputerUse": { + "description": "Tool to support computer use.", + "id": "GoogleCloudAiplatformV1ToolComputerUse", + "properties": { + "environment": { + "description": "Required. The environment being operated.", + "enum": [ + "ENVIRONMENT_UNSPECIFIED", + "ENVIRONMENT_BROWSER" + ], + "enumDescriptions": [ + "Defaults to browser.", + "Operates in a web browser." + ], + "type": "string" + }, + "excludedPredefinedFunctions": { + "description": "Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1ToolConfig": { "description": "Tool config. This config is shared for all tools provided in the request.", "id": "GoogleCloudAiplatformV1ToolConfig", @@ -49940,6 +57728,93 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1UsageMetadata": { + "description": "Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics.", + "id": "GoogleCloudAiplatformV1UsageMetadata", + "properties": { + "cacheTokensDetails": { + "description": "Output only. A detailed breakdown of the token count for each modality in the cached content.", + "items": { + "$ref": "GoogleCloudAiplatformV1ModalityTokenCount" + }, + "readOnly": true, + "type": "array" + }, + "cachedContentTokenCount": { + "description": "Output only. The number of tokens in the cached content that was used for this request.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "candidatesTokenCount": { + "description": "The total number of tokens in the generated candidates.", + "format": "int32", + "type": "integer" + }, + "candidatesTokensDetails": { + "description": "Output only. A detailed breakdown of the token count for each modality in the generated candidates.", + "items": { + "$ref": "GoogleCloudAiplatformV1ModalityTokenCount" + }, + "readOnly": true, + "type": "array" + }, + "promptTokenCount": { + "description": "The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content.", + "format": "int32", + "type": "integer" + }, + "promptTokensDetails": { + "description": "Output only. A detailed breakdown of the token count for each modality in the prompt.", + "items": { + "$ref": "GoogleCloudAiplatformV1ModalityTokenCount" + }, + "readOnly": true, + "type": "array" + }, + "thoughtsTokenCount": { + "description": "Output only. The number of tokens that were part of the model's generated \"thoughts\" output, if applicable.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "toolUsePromptTokenCount": { + "description": "Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "toolUsePromptTokensDetails": { + "description": "Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.", + "items": { + "$ref": "GoogleCloudAiplatformV1ModalityTokenCount" + }, + "readOnly": true, + "type": "array" + }, + "totalTokenCount": { + "description": "The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`.", + "format": "int32", + "type": "integer" + }, + "trafficType": { + "description": "Output only. The traffic type for this request.", + "enum": [ + "TRAFFIC_TYPE_UNSPECIFIED", + "ON_DEMAND", + "PROVISIONED_THROUGHPUT" + ], + "enumDescriptions": [ + "Unspecified request traffic type.", + "Type for Pay-As-You-Go traffic.", + "Type for Provisioned Throughput traffic." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1UserActionReference": { "description": "References an API call. It contains more information about long running operation and Jobs that are triggered by the API call.", "id": "GoogleCloudAiplatformV1UserActionReference", diff --git a/discovery/aiplatform-v1beta1.json b/discovery/aiplatform-v1beta1.json index 3679899919..cbd325365f 100644 --- a/discovery/aiplatform-v1beta1.json +++ b/discovery/aiplatform-v1beta1.json @@ -335,6 +335,326 @@ }, "protocol": "rest", "resources": { + "agents": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/agents/{agentsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.agents.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^agents/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/agents/{agentsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.agents.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^agents/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/agents/{agentsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.agents.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^agents/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/agents/{agentsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.agents.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^agents/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/agents/{agentsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.agents.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^agents/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "apps": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/apps/{appsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.apps.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^apps/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/apps/{appsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.apps.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^apps/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/apps/{appsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.apps.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^apps/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/apps/{appsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.apps.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^apps/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/apps/{appsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.apps.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^apps/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, "batchPredictionJobs": { "methods": { "create": { @@ -431,6 +751,326 @@ } } }, + "customJobs": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/customJobs/{customJobsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.customJobs.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^customJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/customJobs/{customJobsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.customJobs.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^customJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/customJobs/{customJobsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.customJobs.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^customJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/customJobs/{customJobsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.customJobs.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^customJobs/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/customJobs/{customJobsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.customJobs.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^customJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "dataLabelingJobs": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.dataLabelingJobs.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^dataLabelingJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.dataLabelingJobs.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^dataLabelingJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.dataLabelingJobs.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^dataLabelingJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/dataLabelingJobs/{dataLabelingJobsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.dataLabelingJobs.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^dataLabelingJobs/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.dataLabelingJobs.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^dataLabelingJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, "datasets": { "methods": { "create": { @@ -597,46 +1237,526 @@ } }, "resources": { - "datasetVersions": { - "methods": { - "create": { - "description": "Create a version from a Dataset.", - "flatPath": "v1beta1/datasets/{datasetsId}/datasetVersions", - "httpMethod": "POST", - "id": "aiplatform.datasets.datasetVersions.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", - "location": "path", - "pattern": "^datasets/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/datasetVersions", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1DatasetVersion" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a Dataset version.", - "flatPath": "v1beta1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}", - "httpMethod": "DELETE", - "id": "aiplatform.datasets.datasetVersions.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { + "annotationSpecs": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.datasets.annotationSpecs.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.datasets.annotationSpecs.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.datasets.annotationSpecs.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.datasets.annotationSpecs.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^datasets/[^/]+/annotationSpecs/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.datasets.annotationSpecs.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "dataItems": { + "resources": { + "annotations": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.datasets.dataItems.annotations.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.datasets.dataItems.annotations.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.datasets.dataItems.annotations.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.datasets.dataItems.annotations.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.datasets.dataItems.annotations.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.datasets.dataItems.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.datasets.dataItems.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.datasets.dataItems.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/datasets/{datasetsId}/dataItems/{dataItemsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.datasets.dataItems.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^datasets/[^/]+/dataItems/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.datasets.dataItems.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "datasetVersions": { + "methods": { + "create": { + "description": "Create a version from a Dataset.", + "flatPath": "v1beta1/datasets/{datasetsId}/datasetVersions", + "httpMethod": "POST", + "id": "aiplatform.datasets.datasetVersions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", + "location": "path", + "pattern": "^datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/datasetVersions", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1DatasetVersion" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a Dataset version.", + "flatPath": "v1beta1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}", + "httpMethod": "DELETE", + "id": "aiplatform.datasets.datasetVersions.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { "description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", "location": "path", "pattern": "^datasets/[^/]+/datasetVersions/[^/]+$", @@ -795,483 +1915,77 @@ ] } } - } - } - }, - "endpoints": { - "methods": { - "computeTokens": { - "description": "Return a list of tokens based on the input text.", - "flatPath": "v1beta1/endpoints/{endpointsId}:computeTokens", - "httpMethod": "POST", - "id": "aiplatform.endpoints.computeTokens", - "parameterOrder": [ - "endpoint" - ], - "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.", - "location": "path", - "pattern": "^endpoints/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+endpoint}:computeTokens", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1ComputeTokensRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ComputeTokensResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] }, - "countTokens": { - "description": "Perform a token counting.", - "flatPath": "v1beta1/endpoints/{endpointsId}:countTokens", - "httpMethod": "POST", - "id": "aiplatform.endpoints.countTokens", - "parameterOrder": [ - "endpoint" - ], - "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "location": "path", - "pattern": "^endpoints/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+endpoint}:countTokens", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1CountTokensRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1CountTokensResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "fetchPredictOperation": { - "description": "Fetch an asynchronous online prediction operation.", - "flatPath": "v1beta1/endpoints/{endpointsId}:fetchPredictOperation", - "httpMethod": "POST", - "id": "aiplatform.endpoints.fetchPredictOperation", - "parameterOrder": [ - "endpoint" - ], - "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`", - "location": "path", - "pattern": "^endpoints/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+endpoint}:fetchPredictOperation", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1FetchPredictOperationRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "generateContent": { - "description": "Generate content with multimodal inputs.", - "flatPath": "v1beta1/endpoints/{endpointsId}:generateContent", - "httpMethod": "POST", - "id": "aiplatform.endpoints.generateContent", - "parameterOrder": [ - "model" - ], - "parameters": { - "model": { - "description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "location": "path", - "pattern": "^endpoints/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+model}:generateContent", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "predict": { - "description": "Perform an online prediction.", - "flatPath": "v1beta1/endpoints/{endpointsId}:predict", - "httpMethod": "POST", - "id": "aiplatform.endpoints.predict", - "parameterOrder": [ - "endpoint" - ], - "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "location": "path", - "pattern": "^endpoints/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+endpoint}:predict", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1PredictRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1PredictResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "predictLongRunning": { - "description": "", - "flatPath": "v1beta1/endpoints/{endpointsId}:predictLongRunning", - "httpMethod": "POST", - "id": "aiplatform.endpoints.predictLongRunning", - "parameterOrder": [ - "endpoint" - ], - "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`", - "location": "path", - "pattern": "^endpoints/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+endpoint}:predictLongRunning", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1PredictLongRunningRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "streamGenerateContent": { - "description": "Generate content with multimodal inputs with streaming support.", - "flatPath": "v1beta1/endpoints/{endpointsId}:streamGenerateContent", - "httpMethod": "POST", - "id": "aiplatform.endpoints.streamGenerateContent", - "parameterOrder": [ - "model" - ], - "parameters": { - "model": { - "description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "location": "path", - "pattern": "^endpoints/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+model}:streamGenerateContent", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - } - }, - "resources": { - "chat": { - "methods": { - "completions": { - "description": "Exposes an OpenAI-compatible endpoint for chat completions.", - "flatPath": "v1beta1/endpoints/{endpointsId}/chat/completions", - "httpMethod": "POST", - "id": "aiplatform.endpoints.chat.completions", - "parameterOrder": [ - "endpoint" - ], - "parameters": { - "endpoint": { - "description": "Required. The name of the endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "location": "path", - "pattern": "^endpoints/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+endpoint}/chat/completions", - "request": { - "$ref": "GoogleApiHttpBody" - }, - "response": { - "$ref": "GoogleApiHttpBody" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - } - } - } - } - }, - "media": { - "methods": { - "upload": { - "description": "Upload a file into a RagCorpus.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles:upload", - "httpMethod": "POST", - "id": "aiplatform.media.upload", - "mediaUpload": { - "accept": [ - "*/*" - ], - "protocols": { - "simple": { - "multipart": true, - "path": "/upload/v1beta1/{+parent}/ragFiles:upload" - } - } - }, - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The name of the RagCorpus resource into which to upload the file. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/ragFiles:upload", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1UploadRagFileRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1UploadRagFileResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "supportsMediaUpload": true - } - } - }, - "projects": { - "methods": { - "fetchPublisherModelConfig": { - "description": "Fetches the configs of publisher models.", - "flatPath": "v1beta1/projects/{projectsId}:fetchPublisherModelConfig", - "httpMethod": "GET", - "id": "aiplatform.projects.fetchPublisherModelConfig", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the publisher model, in the format of `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`.", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:fetchPublisherModelConfig", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1PublisherModelConfig" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "getCacheConfig": { - "description": "Gets a GenAI cache config.", - "flatPath": "v1beta1/projects/{projectsId}/cacheConfig", - "httpMethod": "GET", - "id": "aiplatform.projects.getCacheConfig", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. Name of the cache config. Format: - `projects/{project}/cacheConfig`.", - "location": "path", - "pattern": "^projects/[^/]+/cacheConfig$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1CacheConfig" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "setPublisherModelConfig": { - "description": "Sets (creates or updates) configs of publisher models. For example, sets the request/response logging config.", - "flatPath": "v1beta1/projects/{projectsId}:setPublisherModelConfig", - "httpMethod": "POST", - "id": "aiplatform.projects.setPublisherModelConfig", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the publisher model, in the format of `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`.", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:setPublisherModelConfig", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1SetPublisherModelConfigRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "updateCacheConfig": { - "description": "Updates a cache config.", - "flatPath": "v1beta1/projects/{projectsId}/cacheConfig", - "httpMethod": "PATCH", - "id": "aiplatform.projects.updateCacheConfig", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Identifier. Name of the cache config. Format: - `projects/{project}/cacheConfig`.", - "location": "path", - "pattern": "^projects/[^/]+/cacheConfig$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1CacheConfig" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "locations": { + "operations": { "methods": { - "augmentPrompt": { - "description": "Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:augmentPrompt", + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/datasets/{datasetsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.augmentPrompt", + "id": "aiplatform.datasets.operations.cancel", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "parent": { - "description": "Required. The resource name of the Location from which to augment prompt. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.", + "name": { + "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^datasets/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}:augmentPrompt", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1AugmentPromptRequest" - }, + "path": "v1beta1/{+name}:cancel", "response": { - "$ref": "GoogleCloudAiplatformV1beta1AugmentPromptResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "corroborateContent": { - "description": "Given an input text, it returns a score that evaluates the factuality of the text. It also extracts and returns claims from the text and provides supporting facts.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:corroborateContent", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.corroborateContent", + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/datasets/{datasetsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.datasets.operations.delete", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "parent": { - "description": "Required. The resource name of the Location from which to corroborate text. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.", + "name": { + "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^datasets/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}:corroborateContent", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1CorroborateContentRequest" - }, + "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1CorroborateContentResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "deploy": { - "description": "Deploys a model to a new endpoint.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:deploy", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.deploy", + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/datasets/{datasetsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.datasets.operations.get", "parameterOrder": [ - "destination" + "name" ], "parameters": { - "destination": { - "description": "Required. The resource name of the Location to deploy the model in. Format: `projects/{project}/locations/{location}`", + "name": { + "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^datasets/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+destination}:deploy", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1DeployRequest" - }, + "path": "v1beta1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, @@ -1279,321 +1993,556 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "deployPublisherModel": { - "deprecated": true, - "description": "Deploys publisher models.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:deployPublisherModel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.deployPublisherModel", + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/datasets/{datasetsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.datasets.operations.list", "parameterOrder": [ - "destination" + "name" ], "parameters": { - "destination": { - "description": "Required. The resource name of the Location to deploy the model in. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, + "filter": { + "description": "The standard list filter.", + "location": "query", "type": "string" - } - }, - "path": "v1beta1/{+destination}:deployPublisherModel", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1DeployPublisherModelRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "evaluateDataset": { - "description": "Evaluates a dataset based on a set of given metrics.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:evaluateDataset", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.evaluateDataset", - "parameterOrder": [ - "location" - ], - "parameters": { - "location": { - "description": "Required. The resource name of the Location to evaluate the dataset. Format: `projects/{project}/locations/{location}`", + }, + "name": { + "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^datasets/[^/]+$", "required": true, "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, - "path": "v1beta1/{+location}:evaluateDataset", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1EvaluateDatasetRequest" - }, + "path": "v1beta1/{+name}/operations", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "evaluateInstances": { - "description": "Evaluates instances based on a given metric.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:evaluateInstances", + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/datasets/{datasetsId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.evaluateInstances", + "id": "aiplatform.datasets.operations.wait", "parameterOrder": [ - "location" + "name" ], "parameters": { - "location": { - "description": "Required. The resource name of the Location to evaluate the instances. Format: `projects/{project}/locations/{location}`", + "name": { + "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^datasets/[^/]+/operations/[^/]+$", "required": true, "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" } }, - "path": "v1beta1/{+location}:evaluateInstances", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1EvaluateInstancesRequest" - }, + "path": "v1beta1/{+name}:wait", "response": { - "$ref": "GoogleCloudAiplatformV1beta1EvaluateInstancesResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "generateInstanceRubrics": { - "description": "Generates rubrics for a given prompt. A rubric represents a single testable criterion for evaluation. One input prompt could have multiple rubrics This RPC allows users to get suggested rubrics based on provided prompt, which can then be reviewed and used for subsequent evaluations.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:generateInstanceRubrics", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.generateInstanceRubrics", - "parameterOrder": [ - "location" - ], - "parameters": { - "location": { - "description": "Required. The resource name of the Location to generate rubrics from. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+location}:generateInstanceRubrics", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1GenerateInstanceRubricsRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1GenerateInstanceRubricsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "generateSyntheticData": { - "description": "Generates synthetic data based on the provided configuration.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:generateSyntheticData", + } + } + }, + "savedQueries": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.datasets.savedQueries.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.datasets.savedQueries.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.datasets.savedQueries.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.datasets.savedQueries.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^datasets/[^/]+/savedQueries/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.datasets.savedQueries.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + }, + "deploymentResourcePools": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.generateSyntheticData", + "id": "aiplatform.deploymentResourcePools.operations.cancel", "parameterOrder": [ - "location" + "name" ], "parameters": { - "location": { - "description": "Required. The resource name of the Location to run the job. Format: `projects/{project}/locations/{location}`", + "name": { + "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^deploymentResourcePools/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+location}:generateSyntheticData", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1GenerateSyntheticDataRequest" - }, + "path": "v1beta1/{+name}:cancel", "response": { - "$ref": "GoogleCloudAiplatformV1beta1GenerateSyntheticDataResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "get": { - "description": "Gets information about a location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.get", + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.deploymentResourcePools.operations.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Resource name for the location.", + "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^deploymentResourcePools/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudLocationLocation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "getRagEngineConfig": { - "description": "Gets a RagEngineConfig.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig", + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.getRagEngineConfig", + "id": "aiplatform.deploymentResourcePools.operations.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the RagEngineConfig resource. Format: `projects/{project}/locations/{location}/ragEngineConfig`", + "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig$", + "pattern": "^deploymentResourcePools/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1RagEngineConfig" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists information about the supported locations for this service.", - "flatPath": "v1beta1/projects/{projectsId}/locations", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/deploymentResourcePools/{deploymentResourcePoolsId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.list", + "id": "aiplatform.deploymentResourcePools.operations.list", "parameterOrder": [ "name" ], "parameters": { - "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", - "location": "query", - "repeated": true, - "type": "string" - }, "filter": { - "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", + "description": "The standard list filter.", "location": "query", "type": "string" }, "name": { - "description": "The resource that owns the locations collection, if applicable.", + "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+$", + "pattern": "^deploymentResourcePools/[^/]+$", "required": true, "type": "string" }, "pageSize": { - "description": "The maximum number of results to return. If not set, the service selects a default.", + "description": "The standard list page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", + "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, - "path": "v1beta1/{+name}/locations", + "path": "v1beta1/{+name}/operations", "response": { - "$ref": "GoogleCloudLocationListLocationsResponse" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "recommendSpec": { - "description": "Gets a Model's spec recommendations. This API is called by UI, SDK, and internal.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:recommendSpec", + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.recommendSpec", + "id": "aiplatform.deploymentResourcePools.operations.wait", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "parent": { - "description": "Required. The resource name of the Location from which to recommend specs. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.", + "name": { + "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^deploymentResourcePools/[^/]+/operations/[^/]+$", "required": true, "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" } }, - "path": "v1beta1/{+parent}:recommendSpec", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1RecommendSpecRequest" - }, + "path": "v1beta1/{+name}:wait", "response": { - "$ref": "GoogleCloudAiplatformV1beta1RecommendSpecResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "retrieveContexts": { - "description": "Retrieves relevant contexts for a query.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:retrieveContexts", + } + } + } + } + }, + "edgeDevices": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/edgeDevices/{edgeDevicesId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.retrieveContexts", + "id": "aiplatform.edgeDevices.operations.cancel", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "parent": { - "description": "Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.", + "name": { + "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^edgeDevices/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}:retrieveContexts", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1RetrieveContextsRequest" + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/edgeDevices/{edgeDevicesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.edgeDevices.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^edgeDevices/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } }, + "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1RetrieveContextsResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "updateRagEngineConfig": { - "description": "Updates a RagEngineConfig.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.updateRagEngineConfig", + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/edgeDevices/{edgeDevicesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.edgeDevices.operations.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Identifier. The name of the RagEngineConfig. Format: `projects/{project}/locations/{location}/ragEngineConfig`", + "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig$", + "pattern": "^edgeDevices/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1RagEngineConfig" + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/edgeDevices/{edgeDevicesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.edgeDevices.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^edgeDevices/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/edgeDevices/{edgeDevicesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.edgeDevices.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^edgeDevices/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } }, + "path": "v1beta1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, @@ -1601,1857 +2550,2192 @@ "https://www.googleapis.com/auth/cloud-platform" ] } + } + } + } + }, + "endpoints": { + "methods": { + "computeTokens": { + "description": "Return a list of tokens based on the input text.", + "flatPath": "v1beta1/endpoints/{endpointsId}:computeTokens", + "httpMethod": "POST", + "id": "aiplatform.endpoints.computeTokens", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.", + "location": "path", + "pattern": "^endpoints/[^/]+$", + "required": true, + "type": "string" + } }, - "resources": { - "agents": { - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.agents.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.agents.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.agents.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.agents.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.agents.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } + "path": "v1beta1/{+endpoint}:computeTokens", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1ComputeTokensRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ComputeTokensResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "countTokens": { + "description": "Perform a token counting.", + "flatPath": "v1beta1/endpoints/{endpointsId}:countTokens", + "httpMethod": "POST", + "id": "aiplatform.endpoints.countTokens", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}:countTokens", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1CountTokensRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1CountTokensResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "fetchPredictOperation": { + "description": "Fetch an asynchronous online prediction operation.", + "flatPath": "v1beta1/endpoints/{endpointsId}:fetchPredictOperation", + "httpMethod": "POST", + "id": "aiplatform.endpoints.fetchPredictOperation", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`", + "location": "path", + "pattern": "^endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}:fetchPredictOperation", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1FetchPredictOperationRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "generateContent": { + "description": "Generate content with multimodal inputs.", + "flatPath": "v1beta1/endpoints/{endpointsId}:generateContent", + "httpMethod": "POST", + "id": "aiplatform.endpoints.generateContent", + "parameterOrder": [ + "model" + ], + "parameters": { + "model": { + "description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+model}:generateContent", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "predict": { + "description": "Perform an online prediction.", + "flatPath": "v1beta1/endpoints/{endpointsId}:predict", + "httpMethod": "POST", + "id": "aiplatform.endpoints.predict", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}:predict", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1PredictRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1PredictResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "predictLongRunning": { + "description": "", + "flatPath": "v1beta1/endpoints/{endpointsId}:predictLongRunning", + "httpMethod": "POST", + "id": "aiplatform.endpoints.predictLongRunning", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`", + "location": "path", + "pattern": "^endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}:predictLongRunning", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1PredictLongRunningRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "streamGenerateContent": { + "description": "Generate content with multimodal inputs with streaming support.", + "flatPath": "v1beta1/endpoints/{endpointsId}:streamGenerateContent", + "httpMethod": "POST", + "id": "aiplatform.endpoints.streamGenerateContent", + "parameterOrder": [ + "model" + ], + "parameters": { + "model": { + "description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+model}:streamGenerateContent", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + }, + "resources": { + "chat": { + "methods": { + "completions": { + "description": "Exposes an OpenAI-compatible endpoint for chat completions.", + "flatPath": "v1beta1/endpoints/{endpointsId}/chat/completions", + "httpMethod": "POST", + "id": "aiplatform.endpoints.chat.completions", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^endpoints/[^/]+$", + "required": true, + "type": "string" } - } + }, + "path": "v1beta1/{+endpoint}/chat/completions", + "request": { + "$ref": "GoogleApiHttpBody" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/endpoints/{endpointsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.endpoints.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^endpoints/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "apps": { - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.apps.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.apps.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.apps.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.apps.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.apps.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/endpoints/{endpointsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.endpoints.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^endpoints/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" } - } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "batchPredictionJobs": { - "methods": { - "cancel": { - "description": "Cancels a BatchPredictionJob. Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetBatchPredictionJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its BatchPredictionJob.state is set to `CANCELLED`. Any files already outputted by the job are not deleted.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.batchPredictionJobs.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the BatchPredictionJob to cancel. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1CancelBatchPredictionJobRequest" - }, - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "create": { - "description": "Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.batchPredictionJobs.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the BatchPredictionJob in. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/batchPredictionJobs", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1BatchPredictionJob" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1BatchPredictionJob" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/endpoints/{endpointsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.endpoints.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^endpoints/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/endpoints/{endpointsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.endpoints.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" }, - "delete": { - "description": "Deletes a BatchPredictionJob. Can only be called on jobs that already finished.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.batchPredictionJobs.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the BatchPredictionJob resource to be deleted. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^endpoints/[^/]+$", + "required": true, + "type": "string" }, - "get": { - "description": "Gets a BatchPredictionJob", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.batchPredictionJobs.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the BatchPredictionJob resource. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1BatchPredictionJob" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" }, - "list": { - "description": "Lists BatchPredictionJobs in a Location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.batchPredictionJobs.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `model_display_name` supports `=`, `!=` comparisons. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token. Typically obtained via ListBatchPredictionJobsResponse.next_page_token of the previous JobService.ListBatchPredictionJobs call.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Location to list the BatchPredictionJobs from. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+parent}/batchPredictionJobs", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListBatchPredictionJobsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } - } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "cachedContents": { - "methods": { - "create": { - "description": "Creates cached content, this call will initialize the cached content in the data storage, and users need to pay for the cache data storage.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/cachedContents", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.cachedContents.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The parent resource where the cached content will be created", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/cachedContents", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1CachedContent" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1CachedContent" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes cached content", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.cachedContents.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The resource name referring to the cached content", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/cachedContents/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets cached content configurations", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.cachedContents.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The resource name referring to the cached content", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/cachedContents/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1CachedContent" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists cached contents in a project", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/cachedContents", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.cachedContents.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "Optional. The maximum number of cached contents to return. The service may return fewer than this value. If unspecified, some default (under maximum) number of items will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. A page token, received from a previous `ListCachedContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCachedContents` must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent, which owns this collection of cached contents.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/cachedContents", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListCachedContentsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/endpoints/{endpointsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.endpoints.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^endpoints/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" }, - "patch": { - "description": "Updates cached content configurations", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.cachedContents.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content}", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/cachedContents/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Required. The list of fields to update.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1CachedContent" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1CachedContent" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" } - } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "evaluationItems": { + "resources": { + "operations": { + "methods": { + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/evaluationItems/{evaluationItemsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.evaluationItems.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^evaluationItems/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "customJobs": { - "methods": { - "cancel": { - "description": "Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetCustomJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the CustomJob is not deleted; instead it becomes a job with a CustomJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and CustomJob.state is set to `CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.customJobs.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the CustomJob to cancel. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1CancelCustomJobRequest" - }, - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/evaluationItems/{evaluationItemsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.evaluationItems.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^evaluationItems/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/evaluationItems/{evaluationItemsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.evaluationItems.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" }, - "create": { - "description": "Creates a CustomJob. A created CustomJob right away will be attempted to be run.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.customJobs.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/customJobs", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1CustomJob" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1CustomJob" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^evaluationItems/[^/]+$", + "required": true, + "type": "string" }, - "delete": { - "description": "Deletes a CustomJob.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.customJobs.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the CustomJob resource to be deleted. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" }, - "get": { - "description": "Gets a CustomJob.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.customJobs.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the CustomJob resource. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1CustomJob" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" }, - "list": { - "description": "Lists CustomJobs in a Location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.customJobs.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token. Typically obtained via ListCustomJobsResponse.next_page_token of the previous JobService.ListCustomJobs call.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Location to list the CustomJobs from. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+parent}/customJobs", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListCustomJobsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.customJobs.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.customJobs.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.customJobs.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.customJobs.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.customJobs.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/evaluationItems/{evaluationItemsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.evaluationItems.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^evaluationItems/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" } - } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "evaluationRuns": { + "resources": { + "operations": { + "methods": { + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/evaluationRuns/{evaluationRunsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.evaluationRuns.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^evaluationRuns/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "dataLabelingJobs": { - "methods": { - "cancel": { - "description": "Cancels a DataLabelingJob. Success of cancellation is not guaranteed.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.dataLabelingJobs.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1CancelDataLabelingJobRequest" - }, - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/evaluationRuns/{evaluationRunsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.evaluationRuns.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^evaluationRuns/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/evaluationRuns/{evaluationRunsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.evaluationRuns.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" }, - "create": { - "description": "Creates a DataLabelingJob.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.dataLabelingJobs.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The parent of the DataLabelingJob. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/dataLabelingJobs", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1DataLabelingJob" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1DataLabelingJob" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^evaluationRuns/[^/]+$", + "required": true, + "type": "string" }, - "delete": { - "description": "Deletes a DataLabelingJob.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.dataLabelingJobs.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the DataLabelingJob to be deleted. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" }, - "get": { - "description": "Gets a DataLabelingJob.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.dataLabelingJobs.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1DataLabelingJob" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" }, - "list": { - "description": "Lists DataLabelingJobs in a Location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.dataLabelingJobs.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent of the DataLabelingJob. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read. FieldMask represents a set of symbolic field paths. For example, the mask can be `paths: \"name\"`. The \"name\" here is a field in DataLabelingJob. If this field is not set, all fields of the DataLabelingJob are returned.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+parent}/dataLabelingJobs", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListDataLabelingJobsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.dataLabelingJobs.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.dataLabelingJobs.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.dataLabelingJobs.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.dataLabelingJobs.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.dataLabelingJobs.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/evaluationRuns/{evaluationRunsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.evaluationRuns.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^evaluationRuns/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" } - } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "evaluationSets": { + "resources": { + "operations": { + "methods": { + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/evaluationSets/{evaluationSetsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.evaluationSets.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^evaluationSets/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "datasets": { - "methods": { - "assemble": { - "description": "Assembles each row of a multimodal dataset and writes the result into a BigQuery table.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:assemble", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.datasets.assemble", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the Dataset resource (used only for MULTIMODAL datasets). Format: `projects/{project}/locations/{location}/datasets/{dataset}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:assemble", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1AssembleDataRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/evaluationSets/{evaluationSetsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.evaluationSets.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^evaluationSets/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/evaluationSets/{evaluationSetsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.evaluationSets.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" }, - "assess": { - "description": "Assesses the state or validity of the dataset with respect to a given use case.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:assess", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.datasets.assess", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the Dataset resource. Used only for MULTIMODAL datasets. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:assess", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1AssessDataRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^evaluationSets/[^/]+$", + "required": true, + "type": "string" }, - "create": { - "description": "Creates a Dataset.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.datasets.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the Dataset in. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/datasets", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1Dataset" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" }, - "delete": { - "description": "Deletes a Dataset.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.datasets.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The resource name of the Dataset to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" }, - "export": { - "description": "Exports data from a Dataset.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:export", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.datasets.export", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:export", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1ExportDataRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/evaluationSets/{evaluationSetsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.evaluationSets.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^evaluationSets/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" }, - "get": { - "description": "Gets a Dataset.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.datasets.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the Dataset resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1Dataset" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "evaluationTasks": { + "resources": { + "operations": { + "methods": { + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/evaluationTasks/{evaluationTasksId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.evaluationTasks.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^evaluationTasks/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/evaluationTasks/{evaluationTasksId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.evaluationTasks.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^evaluationTasks/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/evaluationTasks/{evaluationTasksId}/operations", + "httpMethod": "GET", + "id": "aiplatform.evaluationTasks.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" }, - "import": { - "description": "Imports data into a Dataset.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:import", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.datasets.import", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:import", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1ImportDataRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^evaluationTasks/[^/]+$", + "required": true, + "type": "string" }, - "list": { - "description": "Lists Datasets in a Location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.datasets.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `display_name`: supports = and != * `metadata_schema_uri`: supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. Some examples: * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"`", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time`", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The name of the Dataset's parent resource. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+parent}/datasets", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListDatasetsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" }, - "patch": { - "description": "Updates a Dataset.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.datasets.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` * `description` * `labels`", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1Dataset" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1Dataset" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" }, - "searchDataItems": { - "description": "Searches DataItems in a Dataset.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:searchDataItems", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.datasets.searchDataItems", - "parameterOrder": [ - "dataset" - ], - "parameters": { - "annotationFilters": { - "description": "An expression that specifies what Annotations will be returned per DataItem. Annotations satisfied either of the conditions will be returned. * `annotation_spec_id` - for = or !=. Must specify `saved_query_id=` - saved query id that annotations should belong to.", - "location": "query", - "repeated": true, - "type": "string" - }, - "annotationsFilter": { - "deprecated": true, - "description": "An expression for filtering the Annotations that will be returned per DataItem. * `annotation_spec_id` - for = or !=.", - "location": "query", - "type": "string" - }, - "annotationsLimit": { - "description": "If set, only up to this many of Annotations will be returned per DataItemView. The maximum value is 1000. If not set, the maximum value will be used.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "dataItemFilter": { - "description": "An expression for filtering the DataItem that will be returned. * `data_item_id` - for = or !=. * `labeled` - for = or !=. * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that have at least one annotation with annotation_spec_id = `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob. For example: * `data_item=1` * `has_annotation(5)`", - "location": "query", - "type": "string" - }, - "dataLabelingJob": { - "description": "The resource name of a DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` If this field is set, all of the search will be done in the context of this DataLabelingJob.", - "location": "query", - "type": "string" - }, - "dataset": { - "description": "Required. The resource name of the Dataset from which to search DataItems. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/evaluationTasks/{evaluationTasksId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.evaluationTasks.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^evaluationTasks/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "exampleStores": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/exampleStores/{exampleStoresId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.exampleStores.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^exampleStores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/exampleStores/{exampleStoresId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.exampleStores.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^exampleStores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/exampleStores/{exampleStoresId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.exampleStores.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^exampleStores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/exampleStores/{exampleStoresId}/operations", + "httpMethod": "GET", + "id": "aiplatform.exampleStores.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^exampleStores/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/exampleStores/{exampleStoresId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.exampleStores.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^exampleStores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "extensionControllers": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/extensionControllers/{extensionControllersId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.extensionControllers.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^extensionControllers/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/extensionControllers/{extensionControllersId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.extensionControllers.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^extensionControllers/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/extensionControllers/{extensionControllersId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.extensionControllers.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^extensionControllers/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/extensionControllers/{extensionControllersId}/operations", + "httpMethod": "GET", + "id": "aiplatform.extensionControllers.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^extensionControllers/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/extensionControllers/{extensionControllersId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.extensionControllers.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^extensionControllers/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "extensions": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/extensions/{extensionsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.extensions.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^extensions/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/extensions/{extensionsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.extensions.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^extensions/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/extensions/{extensionsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.extensions.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^extensions/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/extensions/{extensionsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.extensions.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^extensions/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/extensions/{extensionsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.extensions.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^extensions/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "featureGroups": { + "resources": { + "featureMonitors": { + "resources": { + "operations": { + "methods": { + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.featureGroups.featureMonitors.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "pattern": "^featureGroups/[^/]+/featureMonitors/[^/]+/operations/[^/]+$", "required": true, "type": "string" - }, - "fieldMask": { - "description": "Mask specifying which fields of DataItemView to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - }, - "orderBy": { - "deprecated": true, - "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", - "location": "query", - "type": "string" - }, - "orderByAnnotation.orderBy": { - "description": "A comma-separated list of annotation fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Must also specify saved_query.", - "location": "query", + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.featureGroups.featureMonitors.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^featureGroups/[^/]+/featureMonitors/[^/]+/operations/[^/]+$", + "required": true, "type": "string" - }, - "orderByAnnotation.savedQuery": { - "description": "Required. Saved query of the Annotation. Only Annotations belong to this saved query will be considered for ordering.", + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.featureGroups.featureMonitors.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", "location": "query", "type": "string" }, - "orderByDataItem": { - "description": "A comma-separated list of data item fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", - "location": "query", + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^featureGroups/[^/]+/featureMonitors/[^/]+$", + "required": true, "type": "string" }, "pageSize": { - "description": "Requested page size. Server may return fewer results than requested. Default and maximum page size is 100.", + "description": "The standard list page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results for the server to return Typically obtained via SearchDataItemsResponse.next_page_token of the previous DatasetService.SearchDataItems call.", + "description": "The standard list page token.", "location": "query", "type": "string" }, - "savedQuery": { - "deprecated": true, - "description": "The resource name of a SavedQuery(annotation set in UI). Format: `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}` All of the search will be done in the context of this SavedQuery.", + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", - "type": "string" + "type": "boolean" } }, - "path": "v1beta1/{+dataset}:searchDataItems", + "path": "v1beta1/{+name}/operations", "response": { - "$ref": "GoogleCloudAiplatformV1beta1SearchDataItemsResponse" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - } - }, + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.featureGroups.featureMonitors.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^featureGroups/[^/]+/featureMonitors/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "features": { + "resources": { + "operations": { + "methods": { + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.featureGroups.features.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.featureGroups.features.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/featureGroups/{featureGroupsId}/features/{featuresId}/operations", + "httpMethod": "GET", + "id": "aiplatform.featureGroups.features.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^featureGroups/[^/]+/features/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.featureGroups.features.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "operations": { + "methods": { + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/featureGroups/{featureGroupsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.featureGroups.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^featureGroups/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/featureGroups/{featureGroupsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.featureGroups.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^featureGroups/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/featureGroups/{featureGroupsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.featureGroups.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^featureGroups/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/featureGroups/{featureGroupsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.featureGroups.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^featureGroups/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "featureOnlineStores": { + "resources": { + "featureViews": { + "resources": { + "operations": { + "methods": { + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.featureOnlineStores.featureViews.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.featureOnlineStores.featureViews.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.featureOnlineStores.featureViews.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^featureOnlineStores/[^/]+/featureViews/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.featureOnlineStores.featureViews.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "operations": { + "methods": { + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.featureOnlineStores.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^featureOnlineStores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.featureOnlineStores.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^featureOnlineStores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/featureOnlineStores/{featureOnlineStoresId}/operations", + "httpMethod": "GET", + "id": "aiplatform.featureOnlineStores.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^featureOnlineStores/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.featureOnlineStores.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^featureOnlineStores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "featurestores": { + "resources": { + "entityTypes": { + "resources": { + "features": { "resources": { - "annotationSpecs": { + "operations": { "methods": { - "get": { - "description": "Gets an AnnotationSpec.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.datasets.annotationSpecs.get", + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.featurestores.entityTypes.features.operations.cancel", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the AnnotationSpec resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}`", + "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+$", + "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", "required": true, "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" } }, - "path": "v1beta1/{+name}", + "path": "v1beta1/{+name}:cancel", "response": { - "$ref": "GoogleCloudAiplatformV1beta1AnnotationSpec" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - } - }, - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.featurestores.entityTypes.features.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" } - } - } - } - }, - "dataItems": { - "methods": { + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.featurestores.entityTypes.features.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { - "description": "Lists DataItems in a Dataset.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.datasets.dataItems.list", + "id": "aiplatform.featurestores.entityTypes.features.operations.list", "parameterOrder": [ - "parent" + "name" ], "parameters": { "filter": { @@ -3459,9 +4743,11 @@ "location": "query", "type": "string" }, - "orderBy": { - "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", - "location": "query", + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$", + "required": true, "type": "string" }, "pageSize": { @@ -3475,1642 +4761,1129 @@ "location": "query", "type": "string" }, - "parent": { - "description": "Required. The resource name of the Dataset to list DataItems from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.featurestores.entityTypes.features.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", "location": "query", "type": "string" } }, - "path": "v1beta1/{+parent}/dataItems", + "path": "v1beta1/{+name}:wait", "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListDataItemsResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } + } + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.featurestores.entityTypes.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } }, - "resources": { - "annotations": { - "methods": { - "list": { - "description": "Lists Annotations belongs to a dataitem.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.datasets.dataItems.annotations.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the DataItem to list Annotations from. Format: `projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+parent}/annotations", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListAnnotationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - }, - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.datasets.dataItems.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.datasets.dataItems.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.datasets.dataItems.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.datasets.dataItems.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.datasets.dataItems.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.featurestores.entityTypes.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" } - } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "datasetVersions": { - "methods": { - "create": { - "description": "Create a version from a Dataset.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.datasets.datasetVersions.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/datasetVersions", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1DatasetVersion" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a Dataset version.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.datasets.datasetVersions.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.featurestores.entityTypes.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.featurestores.entityTypes.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" }, - "get": { - "description": "Gets a Dataset version.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.datasets.datasetVersions.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1DatasetVersion" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^featurestores/[^/]+/entityTypes/[^/]+$", + "required": true, + "type": "string" }, - "list": { - "description": "Lists DatasetVersions in a Dataset.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.datasets.datasetVersions.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Optional. The standard list filter.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The standard list page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Optional. Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+parent}/datasetVersions", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListDatasetVersionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" }, - "patch": { - "description": "Updates a DatasetVersion.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.datasets.datasetVersions.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name`", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1DatasetVersion" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1DatasetVersion" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" }, - "restore": { - "description": "Restores a dataset version.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.datasets.datasetVersions.restore", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the DatasetVersion resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:restore", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } - } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.datasets.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.datasets.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.datasets.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.featurestores.entityTypes.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.datasets.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.datasets.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, - "savedQueries": { - "methods": { - "delete": { - "description": "Deletes a SavedQuery.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.datasets.savedQueries.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The resource name of the SavedQuery to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists SavedQueries in a Dataset.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.datasets.savedQueries.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Dataset to list SavedQueries from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+parent}/savedQueries", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListSavedQueriesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.datasets.savedQueries.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.datasets.savedQueries.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.datasets.savedQueries.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.datasets.savedQueries.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.datasets.savedQueries.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - } - } - }, - "deploymentResourcePools": { - "methods": { - "create": { - "description": "Create a DeploymentResourcePool.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.deploymentResourcePools.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The parent location resource where this DeploymentResourcePool will be created. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", "type": "string" } }, - "path": "v1beta1/{+parent}/deploymentResourcePools", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1CreateDeploymentResourcePoolRequest" - }, + "path": "v1beta1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + } + } + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/featurestores/{featurestoresId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.featurestores.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^featurestores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/featurestores/{featurestoresId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.featurestores.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^featurestores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/featurestores/{featurestoresId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.featurestores.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^featurestores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/featurestores/{featurestoresId}/operations", + "httpMethod": "GET", + "id": "aiplatform.featurestores.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" }, - "delete": { - "description": "Delete a DeploymentResourcePool.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.deploymentResourcePools.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the DeploymentResourcePool to delete. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^featurestores/[^/]+$", + "required": true, + "type": "string" }, - "get": { - "description": "Get a DeploymentResourcePool.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.deploymentResourcePools.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the DeploymentResourcePool to retrieve. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1DeploymentResourcePool" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" }, - "list": { - "description": "List DeploymentResourcePools in a location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.deploymentResourcePools.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "The maximum number of DeploymentResourcePools to return. The service may return fewer than this value.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous `ListDeploymentResourcePools` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDeploymentResourcePools` must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent Location which owns this collection of DeploymentResourcePools. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/deploymentResourcePools", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListDeploymentResourcePoolsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" }, - "patch": { - "description": "Update a DeploymentResourcePool.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.deploymentResourcePools.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Required. The list of fields to update.", - "format": "google-fieldmask", - "location": "query", + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/featurestores/{featurestoresId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.featurestores.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^featurestores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "hyperparameterTuningJobs": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.hyperparameterTuningJobs.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^hyperparameterTuningJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.hyperparameterTuningJobs.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^hyperparameterTuningJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.hyperparameterTuningJobs.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^hyperparameterTuningJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.hyperparameterTuningJobs.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^hyperparameterTuningJobs/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.hyperparameterTuningJobs.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^hyperparameterTuningJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "indexEndpoints": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.indexEndpoints.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^indexEndpoints/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/indexEndpoints/{indexEndpointsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.indexEndpoints.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^indexEndpoints/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/indexEndpoints/{indexEndpointsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.indexEndpoints.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^indexEndpoints/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/indexEndpoints/{indexEndpointsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.indexEndpoints.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^indexEndpoints/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.indexEndpoints.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^indexEndpoints/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "indexes": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/indexes/{indexesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.indexes.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^indexes/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/indexes/{indexesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.indexes.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^indexes/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/indexes/{indexesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.indexes.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^indexes/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/indexes/{indexesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.indexes.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^indexes/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/indexes/{indexesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.indexes.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^indexes/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "media": { + "methods": { + "upload": { + "description": "Upload a file into a RagCorpus.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles:upload", + "httpMethod": "POST", + "id": "aiplatform.media.upload", + "mediaUpload": { + "accept": [ + "*/*" + ], + "protocols": { + "simple": { + "multipart": true, + "path": "/upload/v1beta1/{+parent}/ragFiles:upload" + } + } + }, + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the RagCorpus resource into which to upload the file. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/ragFiles:upload", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1UploadRagFileRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1UploadRagFileResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "supportsMediaUpload": true + } + } + }, + "metadataStores": { + "resources": { + "artifacts": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.metadataStores.artifacts.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", + "required": true, "type": "string" } }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1DeploymentResourcePool" + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.metadataStores.artifacts.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } }, + "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "queryDeployedModels": { - "description": "List DeployedModels that have been deployed on this DeploymentResourcePool.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}:queryDeployedModels", + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.deploymentResourcePools.queryDeployedModels", + "id": "aiplatform.metadataStores.artifacts.operations.get", "parameterOrder": [ - "deploymentResourcePool" + "name" ], "parameters": { - "deploymentResourcePool": { - "description": "Required. The name of the target DeploymentResourcePool to query. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", + "name": { + "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$", + "pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", "required": true, "type": "string" - }, - "pageSize": { - "description": "The maximum number of DeployedModels to return. The service may return fewer than this value.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous `QueryDeployedModels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryDeployedModels` must match the call that provided the page token.", - "location": "query", - "type": "string" } }, - "path": "v1beta1/{+deploymentResourcePool}:queryDeployedModels", + "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1QueryDeployedModelsResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - } - }, - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.deploymentResourcePools.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.deploymentResourcePools.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.deploymentResourcePools.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.deploymentResourcePools.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.deploymentResourcePools.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - }, - "edgeDevices": { - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/edgeDevices/{edgeDevicesId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.edgeDevices.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/edgeDevices/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/edgeDevices/{edgeDevicesId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.edgeDevices.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/edgeDevices/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/edgeDevices/{edgeDevicesId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.edgeDevices.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/edgeDevices/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/edgeDevices/{edgeDevicesId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.edgeDevices.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/edgeDevices/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/edgeDevices/{edgeDevicesId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.edgeDevices.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/edgeDevices/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - }, - "endpoints": { - "methods": { - "computeTokens": { - "description": "Return a list of tokens based on the input text.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:computeTokens", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.computeTokens", + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.metadataStores.artifacts.operations.list", "parameterOrder": [ - "endpoint" + "name" ], "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.", + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "pattern": "^metadataStores/[^/]+/artifacts/[^/]+$", "required": true, "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, - "path": "v1beta1/{+endpoint}:computeTokens", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1ComputeTokensRequest" - }, + "path": "v1beta1/{+name}/operations", "response": { - "$ref": "GoogleCloudAiplatformV1beta1ComputeTokensResponse" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "countTokens": { - "description": "Perform a token counting.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:countTokens", + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.countTokens", + "id": "aiplatform.metadataStores.artifacts.operations.wait", "parameterOrder": [ - "endpoint" + "name" ], "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "name": { + "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", "required": true, "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" } }, - "path": "v1beta1/{+endpoint}:countTokens", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1CountTokensRequest" - }, + "path": "v1beta1/{+name}:wait", "response": { - "$ref": "GoogleCloudAiplatformV1beta1CountTokensResponse" + "$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" ] - }, - "create": { - "description": "Creates an Endpoint.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints", + } + } + } + } + }, + "contexts": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.create", + "id": "aiplatform.metadataStores.contexts.operations.cancel", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "endpointId": { - "description": "Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are `[0-9]` with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as `?endpoint_id=12345`. This is the fallback for fields that are not included in either the URI or the body.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Location to create the Endpoint in. Format: `projects/{project}/locations/{location}`", + "name": { + "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/endpoints", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1Endpoint" - }, + "path": "v1beta1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { - "description": "Deletes an Endpoint.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}", + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.endpoints.delete", + "id": "aiplatform.metadataStores.contexts.operations.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the Endpoint resource to be deleted. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "deployModel": { - "description": "Deploys a Model into this Endpoint, creating a DeployedModel within it.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:deployModel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.deployModel", + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.metadataStores.contexts.operations.get", "parameterOrder": [ - "endpoint" + "name" ], "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint resource into which to deploy a Model. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "name": { + "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+endpoint}:deployModel", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1DeployModelRequest" - }, + "path": "v1beta1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, @@ -5118,575 +5891,959 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "directPredict": { - "description": "Perform an unary online prediction request to a gRPC model server for Vertex first-party products and frameworks.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directPredict", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.directPredict", + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.metadataStores.contexts.operations.list", "parameterOrder": [ - "endpoint" + "name" ], "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "pattern": "^metadataStores/[^/]+/contexts/[^/]+$", "required": true, "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, - "path": "v1beta1/{+endpoint}:directPredict", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1DirectPredictRequest" - }, + "path": "v1beta1/{+name}/operations", "response": { - "$ref": "GoogleCloudAiplatformV1beta1DirectPredictResponse" + "$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" ] }, - "directRawPredict": { - "description": "Perform an unary online prediction request to a gRPC model server for custom containers.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directRawPredict", + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.directRawPredict", + "id": "aiplatform.metadataStores.contexts.operations.wait", "parameterOrder": [ - "endpoint" + "name" ], "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "name": { + "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+endpoint}:directRawPredict", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1DirectRawPredictRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1DirectRawPredictResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "explain": { - "description": "Perform an online explanation. If deployed_model_id is specified, the corresponding DeployModel must have explanation_spec populated. If deployed_model_id is not specified, all DeployedModels must have explanation_spec populated.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:explain", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.explain", - "parameterOrder": [ - "endpoint" - ], - "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the explanation. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", "required": true, "type": "string" - } - }, - "path": "v1beta1/{+endpoint}:explain", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1ExplainRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ExplainResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "fetchPredictOperation": { - "description": "Fetch an asynchronous online prediction operation.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:fetchPredictOperation", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.fetchPredictOperation", - "parameterOrder": [ - "endpoint" - ], - "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", - "required": true, + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", "type": "string" } }, - "path": "v1beta1/{+endpoint}:fetchPredictOperation", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1FetchPredictOperationRequest" - }, + "path": "v1beta1/{+name}:wait", "response": { "$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" ] - }, - "generateContent": { - "description": "Generate content with multimodal inputs.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:generateContent", + } + } + } + } + }, + "executions": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.generateContent", + "id": "aiplatform.metadataStores.executions.operations.cancel", "parameterOrder": [ - "model" + "name" ], "parameters": { - "model": { - "description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "name": { + "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+model}:generateContent", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest" - }, + "path": "v1beta1/{+name}:cancel", "response": { - "$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse" + "$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": { - "description": "Gets an Endpoint.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.endpoints.get", + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.metadataStores.executions.operations.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the Endpoint resource. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1Endpoint" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:getIamPolicy", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.getIamPolicy", + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.metadataStores.executions.operations.get", "parameterOrder": [ - "resource" + "name" ], "parameters": { - "options.requestedPolicyVersion": { - "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", - "format": "int32", - "location": "query", - "type": "integer" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "name": { + "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+resource}:getIamPolicy", + "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleIamV1Policy" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists Endpoints in a Location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.endpoints.list", + "id": "aiplatform.metadataStores.executions.operations.list", "parameterOrder": [ - "parent" + "name" ], "parameters": { "filter": { - "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports `=` and `!=`. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * `display_name` supports `=` and `!=`. * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:*` or `labels:key` - key existence * A key including a space must be quoted. `labels.\"a key\"`. * `base_model_name` only supports `=`. Some examples: * `endpoint=1` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"` * `baseModelName=\"text-bison\"`", + "description": "The standard list filter.", "location": "query", "type": "string" }, - "gdcZone": { - "description": "Optional. Configures the Google Distributed Cloud (GDC) environment for online prediction. Only set this field when the Endpoint is to be deployed in a GDC environment.", - "location": "query", + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^metadataStores/[^/]+/executions/[^/]+$", + "required": true, "type": "string" }, "pageSize": { - "description": "Optional. The standard list page size.", + "description": "The standard list page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. The standard list page token. Typically obtained via ListEndpointsResponse.next_page_token of the previous EndpointService.ListEndpoints call.", + "description": "The standard list page token.", "location": "query", "type": "string" }, - "parent": { - "description": "Required. The resource name of the Location from which to list the Endpoints. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Optional. Mask specifying which fields to read.", - "format": "google-fieldmask", + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", - "type": "string" + "type": "boolean" } }, - "path": "v1beta1/{+parent}/endpoints", + "path": "v1beta1/{+name}/operations", "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListEndpointsResponse" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "mutateDeployedModel": { - "description": "Updates an existing deployed model. Updatable fields include `min_replica_count`, `max_replica_count`, `required_replica_count`, `autoscaling_metric_specs`, `disable_container_logging` (v1 only), and `enable_container_logging` (v1beta1 only).", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:mutateDeployedModel", + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.mutateDeployedModel", - "parameterOrder": [ - "endpoint" - ], - "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint resource into which to mutate a DeployedModel. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+endpoint}:mutateDeployedModel", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1MutateDeployedModelRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "patch": { - "description": "Updates an Endpoint.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.endpoints.patch", + "id": "aiplatform.metadataStores.executions.operations.wait", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Output only. The resource name of the Endpoint.", + "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, - "updateMask": { - "description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask.", - "format": "google-fieldmask", + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", "location": "query", "type": "string" } }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1Endpoint" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1Endpoint" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "predict": { - "description": "Perform an online prediction.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predict", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.predict", - "parameterOrder": [ - "endpoint" - ], - "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+endpoint}:predict", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1PredictRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1PredictResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "predictLongRunning": { - "description": "", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predictLongRunning", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.predictLongRunning", - "parameterOrder": [ - "endpoint" - ], - "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+endpoint}:predictLongRunning", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1PredictLongRunningRequest" - }, + "path": "v1beta1/{+name}:wait", "response": { "$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" ] + } + } + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/metadataStores/{metadataStoresId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.metadataStores.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^metadataStores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/metadataStores/{metadataStoresId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.metadataStores.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^metadataStores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/metadataStores/{metadataStoresId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.metadataStores.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^metadataStores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/metadataStores/{metadataStoresId}/operations", + "httpMethod": "GET", + "id": "aiplatform.metadataStores.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" }, - "rawPredict": { - "description": "Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's DeployedModel that served this prediction.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:rawPredict", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.rawPredict", - "parameterOrder": [ - "endpoint" - ], - "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+endpoint}:rawPredict", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1RawPredictRequest" - }, - "response": { - "$ref": "GoogleApiHttpBody" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^metadataStores/[^/]+$", + "required": true, + "type": "string" }, - "serverStreamingPredict": { - "description": "Perform a server-side streaming online prediction request for Vertex LLM streaming.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:serverStreamingPredict", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.serverStreamingPredict", - "parameterOrder": [ - "endpoint" - ], - "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+endpoint}:serverStreamingPredict", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1StreamingPredictRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1StreamingPredictResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" }, - "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": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:setIamPolicy", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.setIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:setIamPolicy", - "request": { - "$ref": "GoogleIamV1SetIamPolicyRequest" - }, - "response": { - "$ref": "GoogleIamV1Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" }, - "streamGenerateContent": { - "description": "Generate content with multimodal inputs with streaming support.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamGenerateContent", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.streamGenerateContent", - "parameterOrder": [ - "model" - ], - "parameters": { - "model": { - "description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+model}:streamGenerateContent", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/metadataStores/{metadataStoresId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.metadataStores.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^metadataStores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" }, - "streamRawPredict": { - "description": "Perform a streaming online prediction with an arbitrary HTTP payload.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamRawPredict", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.streamRawPredict", - "parameterOrder": [ - "endpoint" - ], - "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "migratableResources": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/migratableResources/{migratableResourcesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.migratableResources.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^migratableResources/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/migratableResources/{migratableResourcesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.migratableResources.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^migratableResources/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/migratableResources/{migratableResourcesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.migratableResources.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^migratableResources/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/migratableResources/{migratableResourcesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.migratableResources.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^migratableResources/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/migratableResources/{migratableResourcesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.migratableResources.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^migratableResources/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "modelDeploymentMonitoringJobs": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.modelDeploymentMonitoringJobs.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.modelDeploymentMonitoringJobs.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.modelDeploymentMonitoringJobs.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.modelDeploymentMonitoringJobs.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^modelDeploymentMonitoringJobs/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.modelDeploymentMonitoringJobs.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "modelMonitors": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/modelMonitors/{modelMonitorsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.modelMonitors.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^modelMonitors/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/modelMonitors/{modelMonitorsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.modelMonitors.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^modelMonitors/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/modelMonitors/{modelMonitorsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.modelMonitors.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^modelMonitors/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/modelMonitors/{modelMonitorsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.modelMonitors.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^modelMonitors/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/modelMonitors/{modelMonitorsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.modelMonitors.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^modelMonitors/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "models": { + "resources": { + "evaluations": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.models.evaluations.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+endpoint}:streamRawPredict", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1StreamRawPredictRequest" - }, + "path": "v1beta1/{+name}:cancel", "response": { - "$ref": "GoogleApiHttpBody" + "$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" ] }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:testIamPermissions", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.testIamPermissions", + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.models.evaluations.operations.delete", "parameterOrder": [ - "resource" + "name" ], "parameters": { - "permissions": { - "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", - "location": "query", - "repeated": true, - "type": "string" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "name": { + "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+resource}:testIamPermissions", + "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleIamV1TestIamPermissionsResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "undeployModel": { - "description": "Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:undeployModel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.undeployModel", + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.models.evaluations.operations.get", "parameterOrder": [ - "endpoint" + "name" ], "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint resource from which to undeploy a Model. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "name": { + "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+endpoint}:undeployModel", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1UndeployModelRequest" - }, + "path": "v1beta1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, @@ -5694,27 +6851,76 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "update": { - "description": "Updates an Endpoint with a long running operation.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:update", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.update", + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/models/{modelsId}/evaluations/{evaluationsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.models.evaluations.operations.list", "parameterOrder": [ "name" ], "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, "name": { - "description": "Output only. The resource name of the Endpoint.", + "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "pattern": "^models/[^/]+/evaluations/[^/]+$", "required": true, "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, - "path": "v1beta1/{+name}:update", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1UpdateEndpointLongRunningRequest" + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.models.evaluations.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } }, + "path": "v1beta1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, @@ -5722,2899 +6928,11484 @@ "https://www.googleapis.com/auth/cloud-platform" ] } - }, - "resources": { - "chat": { - "methods": { - "completions": { - "description": "Exposes an OpenAI-compatible endpoint for chat completions.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/chat/completions", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.chat.completions", - "parameterOrder": [ - "endpoint" - ], - "parameters": { - "endpoint": { - "description": "Required. The name of the endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+endpoint}/chat/completions", - "request": { - "$ref": "GoogleApiHttpBody" - }, - "response": { - "$ref": "GoogleApiHttpBody" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - } - } + } + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/models/{modelsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.models.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^models/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/models/{modelsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.models.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^models/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/models/{modelsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.models.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^models/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/models/{modelsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.models.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" }, - "deployedModels": { - "resources": { - "invoke": { - "methods": { - "invoke": { - "description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/deployedModels/{deployedModelId}/invoke/{invokeId}", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.deployedModels.invoke.invoke", - "parameterOrder": [ - "endpoint", - "deployedModelId", - "invokeId" - ], - "parameters": { - "deployedModelId": { - "description": "ID of the DeployedModel that serves the invoke request.", - "location": "path", - "required": true, - "type": "string" - }, - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", - "required": true, - "type": "string" - }, - "invokeId": { - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+endpoint}/deployedModels/{deployedModelId}/invoke/{+invokeId}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1InvokeRequest" - }, - "response": { - "$ref": "GoogleApiHttpBody" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - } - } - } - } + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^models/[^/]+$", + "required": true, + "type": "string" }, - "invoke": { - "methods": { - "invoke": { - "description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/invoke/{invokeId}", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.invoke.invoke", - "parameterOrder": [ - "endpoint", - "invokeId" - ], - "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", - "required": true, - "type": "string" - }, - "invokeId": { - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+endpoint}/invoke/{+invokeId}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1InvokeRequest" - }, - "response": { - "$ref": "GoogleApiHttpBody" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - } - } + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" }, - "openapi": { - "methods": { - "embeddings": { - "description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/openapi/embeddings", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.openapi.embeddings", - "parameterOrder": [ - "endpoint" - ], - "parameters": { - "deployedModelId": { - "description": "ID of the DeployedModel that serves the invoke request.", - "location": "query", - "type": "string" - }, - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/openapi$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+endpoint}/embeddings", - "request": { - "$ref": "GoogleApiHttpBody" - }, - "response": { - "$ref": "GoogleApiHttpBody" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - } - } + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" }, - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.endpoints.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.endpoints.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.endpoints.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.endpoints.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } - } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "evaluationItems": { - "methods": { - "create": { - "description": "Creates an Evaluation Item.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.evaluationItems.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the Evaluation Item in. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/evaluationItems", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1EvaluationItem" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1EvaluationItem" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes an Evaluation Item.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.evaluationItems.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the EvaluationItem resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets an Evaluation Item.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.evaluationItems.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the EvaluationItem resource. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1EvaluationItem" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/models/{modelsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.models.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^models/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" }, - "list": { - "description": "Lists Evaluation Items.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.evaluationItems.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Optional. Filter expression that matches a subset of the EvaluationItems to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. The maximum number of Evaluation Items to return.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. A page token, received from a previous `ListEvaluationItems` call. Provide this to retrieve the subsequent page.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Location from which to list the Evaluation Items. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/evaluationItems", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListEvaluationItemsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" } }, - "resources": { - "operations": { - "methods": { - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.evaluationItems.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.evaluationItems.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.evaluationItems.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.evaluationItems.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "notebookExecutionJobs": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.notebookExecutionJobs.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" } - } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "evaluationRuns": { - "methods": { - "cancel": { - "description": "Cancels an Evaluation Run. Attempts to cancel a running Evaluation Run asynchronously. Status of run can be checked via GetEvaluationRun.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.evaluationRuns.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the EvaluationRun resource to be cancelled. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1CancelEvaluationRunRequest" - }, - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.notebookExecutionJobs.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.notebookExecutionJobs.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/notebookExecutionJobs/{notebookExecutionJobsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.notebookExecutionJobs.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" }, - "create": { - "description": "Creates an Evaluation Run.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.evaluationRuns.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the Evaluation Run in. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/evaluationRuns", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1EvaluationRun" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1EvaluationRun" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^notebookExecutionJobs/[^/]+$", + "required": true, + "type": "string" }, - "delete": { - "description": "Deletes an Evaluation Run.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.evaluationRuns.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the EvaluationRun resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" }, - "get": { - "description": "Gets an Evaluation Run.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.evaluationRuns.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the EvaluationRun resource. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1EvaluationRun" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" }, - "list": { - "description": "Lists Evaluation Runs.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.evaluationRuns.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Optional. Filter expression that matches a subset of the EvaluationRuns to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. The maximum number of Evaluation Runs to return.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. A page token, received from a previous `ListEvaluationRuns` call. Provide this to retrieve the subsequent page.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Location from which to list the Evaluation Runs. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/evaluationRuns", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListEvaluationRunsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, - "resources": { - "operations": { - "methods": { - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.evaluationRuns.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.evaluationRuns.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.evaluationRuns.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.evaluationRuns.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.notebookExecutionJobs.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" } - } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "notebookRuntimeTemplates": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.notebookRuntimeTemplates.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "evaluationSets": { - "methods": { - "create": { - "description": "Creates an Evaluation Set.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.evaluationSets.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the Evaluation Set in. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/evaluationSets", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1EvaluationSet" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1EvaluationSet" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.notebookRuntimeTemplates.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.notebookRuntimeTemplates.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.notebookRuntimeTemplates.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" }, - "delete": { - "description": "Deletes an Evaluation Set.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.evaluationSets.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the EvaluationSet resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^notebookRuntimeTemplates/[^/]+$", + "required": true, + "type": "string" }, - "get": { - "description": "Gets an Evaluation Set.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.evaluationSets.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the EvaluationSet resource. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1EvaluationSet" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" }, - "list": { - "description": "Lists Evaluation Sets.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.evaluationSets.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Optional. Filter expression that matches a subset of the EvaluationSets to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. The maximum number of Evaluation Sets to return.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. A page token, received from a previous `ListEvaluationSets` call. Provide this to retrieve the subsequent page.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Location from which to list the Evaluation Sets. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/evaluationSets", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListEvaluationSetsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" }, - "patch": { - "description": "Updates an Evaluation Set.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.evaluationSets.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Identifier. The resource name of the EvaluationSet. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Optional. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1EvaluationSet" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1EvaluationSet" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, - "resources": { - "operations": { - "methods": { - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.evaluationSets.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.evaluationSets.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.evaluationSets.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.evaluationSets.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.notebookRuntimeTemplates.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" } - } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "notebookRuntimes": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.notebookRuntimes.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "evaluationTasks": { - "resources": { - "operations": { - "methods": { - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationTasks/{evaluationTasksId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.evaluationTasks.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/evaluationTasks/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationTasks/{evaluationTasksId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.evaluationTasks.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/evaluationTasks/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationTasks/{evaluationTasksId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.evaluationTasks.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/evaluationTasks/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationTasks/{evaluationTasksId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.evaluationTasks.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/evaluationTasks/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.notebookRuntimes.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" } - } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "exampleStores": { - "methods": { - "create": { - "description": "Create an ExampleStore.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores:create", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.exampleStores.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "exampleStore.createTime": { - "description": "Output only. Timestamp when this ExampleStore was created.", - "format": "google-datetime", - "location": "query", - "type": "string" - }, - "exampleStore.description": { - "description": "Optional. Description of the ExampleStore.", - "location": "query", - "type": "string" - }, - "exampleStore.displayName": { - "description": "Required. Display name of the ExampleStore.", - "location": "query", - "type": "string" - }, - "exampleStore.exampleStoreConfig.vertexEmbeddingModel": { - "description": "Required. The embedding model to be used for vector embedding. Immutable. Supported models: * \"text-embedding-005\" * \"text-multilingual-embedding-002\"", - "location": "query", - "type": "string" - }, - "exampleStore.name": { - "description": "Identifier. The resource name of the ExampleStore. This is a unique identifier. Format: projects/{project}/locations/{location}/exampleStores/{example_store}", - "location": "query", - "type": "string" - }, - "exampleStore.updateTime": { - "description": "Output only. Timestamp when this ExampleStore was most recently updated.", - "format": "google-datetime", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Location to create the ExampleStore in. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/exampleStores:create", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Delete an ExampleStore.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.exampleStores.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The resource name of the ExampleStore to be deleted. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "fetchExamples": { - "description": "Get Examples from the Example Store.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}:fetchExamples", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.exampleStores.fetchExamples", - "parameterOrder": [ - "exampleStore" - ], - "parameters": { - "exampleStore": { - "description": "Required. The name of the ExampleStore resource that the examples should be fetched from. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+exampleStore}:fetchExamples", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1FetchExamplesRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1FetchExamplesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Get an ExampleStore.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.exampleStores.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The resource name of the ExampleStore. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ExampleStore" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.notebookRuntimes.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/notebookRuntimes/{notebookRuntimesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.notebookRuntimes.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" }, - "list": { - "description": "List ExampleStores in a Location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.exampleStores.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The standard list page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Location to list the ExampleStores from. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/exampleStores", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListExampleStoresResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^notebookRuntimes/[^/]+$", + "required": true, + "type": "string" }, - "patch": { - "description": "Update an ExampleStore.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.exampleStores.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Identifier. The resource name of the ExampleStore. This is a unique identifier. Format: projects/{project}/locations/{location}/exampleStores/{example_store}", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Optional. Mask specifying which fields to update. Supported fields: * `display_name` * `description`", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1ExampleStore" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" }, - "removeExamples": { - "description": "Remove Examples from the Example Store.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}:removeExamples", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.exampleStores.removeExamples", - "parameterOrder": [ - "exampleStore" - ], - "parameters": { - "exampleStore": { - "description": "Required. The name of the ExampleStore resource that the examples should be removed from. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+exampleStore}:removeExamples", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1RemoveExamplesRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1RemoveExamplesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" }, - "searchExamples": { - "description": "Search for similar Examples for given selection criteria.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}:searchExamples", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.exampleStores.searchExamples", - "parameterOrder": [ - "exampleStore" - ], - "parameters": { - "exampleStore": { - "description": "Required. The name of the ExampleStore resource that examples are retrieved from. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+exampleStore}:searchExamples", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1SearchExamplesRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1SearchExamplesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.notebookRuntimes.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" }, - "upsertExamples": { - "description": "Create or update Examples in the Example Store.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}:upsertExamples", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.exampleStores.upsertExamples", - "parameterOrder": [ - "exampleStore" - ], - "parameters": { - "exampleStore": { - "description": "Required. The name of the ExampleStore resource that examples are added to or updated in. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+exampleStore}:upsertExamples", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1UpsertExamplesRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1UpsertExamplesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" } }, - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.exampleStores.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.exampleStores.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.exampleStores.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.exampleStores.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.exampleStores.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/operations", + "httpMethod": "GET", + "id": "aiplatform.operations.list", + "parameterOrder": [], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "persistentResources": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/persistentResources/{persistentResourcesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.persistentResources.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^persistentResources/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" } - } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "extensionControllers": { - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensionControllers/{extensionControllersId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.extensionControllers.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/extensionControllers/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensionControllers/{extensionControllersId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.extensionControllers.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/extensionControllers/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensionControllers/{extensionControllersId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.extensionControllers.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/extensionControllers/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensionControllers/{extensionControllersId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.extensionControllers.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/extensionControllers/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensionControllers/{extensionControllersId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.extensionControllers.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/extensionControllers/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/persistentResources/{persistentResourcesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.persistentResources.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^persistentResources/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" } - } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "extensions": { - "methods": { - "delete": { - "description": "Deletes an Extension.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.extensions.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the Extension resource to be deleted. Format: `projects/{project}/locations/{location}/extensions/{extension}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/persistentResources/{persistentResourcesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.persistentResources.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^persistentResources/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/persistentResources/{persistentResourcesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.persistentResources.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" }, - "execute": { - "description": "Executes the request against a given extension.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}:execute", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.extensions.execute", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. Name (identifier) of the extension; Format: `projects/{project}/locations/{location}/extensions/{extension}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:execute", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1ExecuteExtensionRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ExecuteExtensionResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^persistentResources/[^/]+$", + "required": true, + "type": "string" }, - "get": { - "description": "Gets an Extension.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.extensions.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the Extension resource. Format: `projects/{project}/locations/{location}/extensions/{extension}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1Extension" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "import": { - "description": "Imports an Extension.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions:import", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.extensions.import", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to import the Extension in. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/extensions:import", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1Extension" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" }, - "list": { - "description": "Lists Extensions in a location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.extensions.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Optional. The standard list filter. Supported fields: * `display_name` * `create_time` * `update_time` More detail in [AIP-160](https://google.aip.dev/160).", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The standard list page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Location to list the Extensions from. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/extensions", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListExtensionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" }, - "patch": { - "description": "Updates an Extension.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.extensions.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Identifier. The resource name of the Extension.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Required. Mask specifying which fields to update. Supported fields: * `display_name` * `description` * `runtime_config` * `tool_use_examples` * `manifest.description`", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1Extension" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1Extension" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/persistentResources/{persistentResourcesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.persistentResources.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^persistentResources/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" }, - "query": { - "description": "Queries an extension with a default controller.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}:query", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.extensions.query", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. Name (identifier) of the extension; Format: `projects/{project}/locations/{location}/extensions/{extension}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:query", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1QueryExtensionRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1QueryExtensionResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" } }, - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.extensions.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.extensions.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.extensions.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.extensions.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.extensions.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "pipelineJobs": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.pipelineJobs.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^pipelineJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" } - } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "featureGroups": { - "methods": { - "create": { - "description": "Creates a new FeatureGroup in a given project and location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureGroups.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "featureGroupId": { - "description": "Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Location to create FeatureGroups. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/featureGroups", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1FeatureGroup" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.pipelineJobs.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^pipelineJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.pipelineJobs.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^pipelineJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/pipelineJobs/{pipelineJobsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.pipelineJobs.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" }, - "delete": { - "description": "Deletes a single FeatureGroup.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.featureGroups.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "force": { - "description": "If set to true, any Features under this FeatureGroup will also be deleted. (Otherwise, the request will only work if the FeatureGroup has no Features.)", - "location": "query", - "type": "boolean" - }, - "name": { - "description": "Required. The name of the FeatureGroup to be deleted. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^pipelineJobs/[^/]+$", + "required": true, + "type": "string" }, - "get": { - "description": "Gets details of a single FeatureGroup.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureGroups.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the FeatureGroup resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1FeatureGroup" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:getIamPolicy", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureGroups.getIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "options.requestedPolicyVersion": { - "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", - "format": "int32", - "location": "query", - "type": "integer" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:getIamPolicy", - "response": { - "$ref": "GoogleIamV1Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists FeatureGroups in a given project and location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureGroups.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Lists the FeatureGroups that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > \"2020-01-01\" OR update_time > \"2020-01-01\"` FeatureGroups created or updated after 2020-01-01. * `labels.env = \"prod\"` FeatureGroups with label \"env\" set to \"prod\".", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported Fields: * `create_time` * `update_time`", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of FeatureGroups to return. The service may return fewer than this value. If unspecified, at most 100 FeatureGroups will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous FeatureRegistryService.ListFeatureGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureGroups must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Location to list FeatureGroups. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/featureGroups", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListFeatureGroupsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "patch": { - "description": "Updates the parameters of a single FeatureGroup.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.featureGroups.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Identifier. Name of the FeatureGroup. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` * `service_agent_type`", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1FeatureGroup" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" }, - "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": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:setIamPolicy", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureGroups.setIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:setIamPolicy", - "request": { - "$ref": "GoogleIamV1SetIamPolicyRequest" - }, - "response": { - "$ref": "GoogleIamV1Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.pipelineJobs.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^pipelineJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:testIamPermissions", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureGroups.testIamPermissions", - "parameterOrder": [ - "resource" - ], - "parameters": { - "permissions": { - "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", - "location": "query", - "repeated": true, - "type": "string" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:testIamPermissions", - "response": { - "$ref": "GoogleIamV1TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" } }, - "resources": { - "featureMonitors": { - "methods": { - "create": { - "description": "Creates a new FeatureMonitor in a given project, location and FeatureGroup.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureGroups.featureMonitors.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "featureMonitorId": { - "description": "Required. The ID to use for this FeatureMonitor, which will become the final component of the FeatureGroup's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the FeatureGroup.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of FeatureGroup to create FeatureMonitor. Format: `projects/{project}/locations/{location}/featureGroups/{featuregroup}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/featureMonitors", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1FeatureMonitor" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a single FeatureMonitor.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.featureGroups.featureMonitors.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the FeatureMonitor to be deleted. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets details of a single FeatureMonitor.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureGroups.featureMonitors.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the FeatureMonitor resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1FeatureMonitor" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists FeatureGroups in a given project and location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureGroups.featureMonitors.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Optional. Lists the FeatureMonitors that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > \"2020-01-01\" OR update_time > \"2020-01-01\"` FeatureMonitors created or updated after 2020-01-01. * `labels.env = \"prod\"` FeatureGroups with label \"env\" set to \"prod\".", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported Fields: * `create_time` * `update_time`", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. The maximum number of FeatureGroups to return. The service may return fewer than this value. If unspecified, at most 100 FeatureMonitors will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. A page token, received from a previous FeatureRegistryService.ListFeatureMonitors call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureMonitors must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the FeatureGroup to list FeatureMonitors. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/featureMonitors", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListFeatureMonitorsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "patch": { - "description": "Updates the parameters of a single FeatureMonitor.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.featureGroups.featureMonitors.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Identifier. Name of the FeatureMonitor. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}/featureMonitors/{featureMonitor}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Optional. Field mask is used to specify the fields to be overwritten in the FeatureMonitor resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `schedule_config` * `feature_selection_config`", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1FeatureMonitor" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "featureMonitorJobs": { - "methods": { - "create": { - "description": "Creates a new feature monitor job.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/featureMonitorJobs", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureGroups.featureMonitors.featureMonitorJobs.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "featureMonitorJobId": { - "description": "Optional. Output only. System-generated ID for feature monitor job.", - "format": "int64", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of FeatureMonitor to create FeatureMonitorJob. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/featureMonitorJobs", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1FeatureMonitorJob" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1FeatureMonitorJob" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Get a feature monitor job.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/featureMonitorJobs/{featureMonitorJobsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureGroups.featureMonitors.featureMonitorJobs.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the FeatureMonitorJob resource. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}/featureMonitorJobs/{feature_monitor_job}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+/featureMonitorJobs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1FeatureMonitorJob" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "List feature monitor jobs.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/featureMonitorJobs", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureGroups.featureMonitors.featureMonitorJobs.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Optional. Lists the FeatureMonitorJobs that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be Examples: * `create_time > \"2020-01-01\"` FeatureMonitorJobs created after 2020-01-01.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported Fields: * `create_time`", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. The maximum number of FeatureMonitorJobs to return. The service may return fewer than this value. If unspecified, at most 100 FeatureMonitorJobs will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. A page token, received from a previous FeatureRegistryService.ListFeatureMonitorJobs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureMonitorJobs must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the FeatureMonitor to list FeatureMonitorJobs. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/featureMonitorJobs", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListFeatureMonitorJobsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, - "operations": { - "methods": { - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.featureGroups.featureMonitors.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureGroups.featureMonitors.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureGroups.featureMonitors.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "projects": { + "methods": { + "fetchPublisherModelConfig": { + "description": "Fetches the configs of publisher models.", + "flatPath": "v1beta1/projects/{projectsId}:fetchPublisherModelConfig", + "httpMethod": "GET", + "id": "aiplatform.projects.fetchPublisherModelConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the publisher model, in the format of `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:fetchPublisherModelConfig", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1PublisherModelConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getCacheConfig": { + "description": "Gets a GenAI cache config.", + "flatPath": "v1beta1/projects/{projectsId}/cacheConfig", + "httpMethod": "GET", + "id": "aiplatform.projects.getCacheConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the cache config. Format: - `projects/{project}/cacheConfig`.", + "location": "path", + "pattern": "^projects/[^/]+/cacheConfig$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1CacheConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setPublisherModelConfig": { + "description": "Sets (creates or updates) configs of publisher models. For example, sets the request/response logging config.", + "flatPath": "v1beta1/projects/{projectsId}:setPublisherModelConfig", + "httpMethod": "POST", + "id": "aiplatform.projects.setPublisherModelConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the publisher model, in the format of `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:setPublisherModelConfig", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1SetPublisherModelConfigRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "updateCacheConfig": { + "description": "Updates a cache config.", + "flatPath": "v1beta1/projects/{projectsId}/cacheConfig", + "httpMethod": "PATCH", + "id": "aiplatform.projects.updateCacheConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. Name of the cache config. Format: - `projects/{project}/cacheConfig`.", + "location": "path", + "pattern": "^projects/[^/]+/cacheConfig$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1CacheConfig" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "locations": { + "methods": { + "augmentPrompt": { + "description": "Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:augmentPrompt", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.augmentPrompt", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location from which to augment prompt. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}:augmentPrompt", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1AugmentPromptRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1AugmentPromptResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "corroborateContent": { + "description": "Given an input text, it returns a score that evaluates the factuality of the text. It also extracts and returns claims from the text and provides supporting facts.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:corroborateContent", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.corroborateContent", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location from which to corroborate text. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}:corroborateContent", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1CorroborateContentRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1CorroborateContentResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "deploy": { + "description": "Deploys a model to a new endpoint.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:deploy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.deploy", + "parameterOrder": [ + "destination" + ], + "parameters": { + "destination": { + "description": "Required. The resource name of the Location to deploy the model in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+destination}:deploy", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1DeployRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "deployPublisherModel": { + "deprecated": true, + "description": "Deploys publisher models.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:deployPublisherModel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.deployPublisherModel", + "parameterOrder": [ + "destination" + ], + "parameters": { + "destination": { + "description": "Required. The resource name of the Location to deploy the model in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+destination}:deployPublisherModel", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1DeployPublisherModelRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "evaluateDataset": { + "description": "Evaluates a dataset based on a set of given metrics.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:evaluateDataset", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.evaluateDataset", + "parameterOrder": [ + "location" + ], + "parameters": { + "location": { + "description": "Required. The resource name of the Location to evaluate the dataset. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+location}:evaluateDataset", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluateDatasetRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "evaluateInstances": { + "description": "Evaluates instances based on a given metric.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:evaluateInstances", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.evaluateInstances", + "parameterOrder": [ + "location" + ], + "parameters": { + "location": { + "description": "Required. The resource name of the Location to evaluate the instances. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+location}:evaluateInstances", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluateInstancesRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluateInstancesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "generateInstanceRubrics": { + "description": "Generates rubrics for a given prompt. A rubric represents a single testable criterion for evaluation. One input prompt could have multiple rubrics This RPC allows users to get suggested rubrics based on provided prompt, which can then be reviewed and used for subsequent evaluations.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:generateInstanceRubrics", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.generateInstanceRubrics", + "parameterOrder": [ + "location" + ], + "parameters": { + "location": { + "description": "Required. The resource name of the Location to generate rubrics from. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+location}:generateInstanceRubrics", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1GenerateInstanceRubricsRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1GenerateInstanceRubricsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "generateSyntheticData": { + "description": "Generates synthetic data based on the provided configuration.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:generateSyntheticData", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.generateSyntheticData", + "parameterOrder": [ + "location" + ], + "parameters": { + "location": { + "description": "Required. The resource name of the Location to run the job. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+location}:generateSyntheticData", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1GenerateSyntheticDataRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1GenerateSyntheticDataResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets information about a location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Resource name for the location.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudLocationLocation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getRagEngineConfig": { + "description": "Gets a RagEngineConfig.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.getRagEngineConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the RagEngineConfig resource. Format: `projects/{project}/locations/{location}/ragEngineConfig`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1RagEngineConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists information about the supported locations for this service.", + "flatPath": "v1beta1/projects/{projectsId}/locations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "extraLocationTypes": { + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "location": "query", + "repeated": true, + "type": "string" + }, + "filter": { + "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "name": { + "description": "The resource that owns the locations collection, if applicable.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The maximum number of results to return. If not set, the service selects a default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}/locations", + "response": { + "$ref": "GoogleCloudLocationListLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "recommendSpec": { + "description": "Gets a Model's spec recommendations. This API is called by UI, SDK, and internal.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:recommendSpec", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.recommendSpec", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location from which to recommend specs. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}:recommendSpec", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1RecommendSpecRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1RecommendSpecResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "retrieveContexts": { + "description": "Retrieves relevant contexts for a query.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:retrieveContexts", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.retrieveContexts", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}:retrieveContexts", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1RetrieveContextsRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1RetrieveContextsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "updateRagEngineConfig": { + "description": "Updates a RagEngineConfig.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.updateRagEngineConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The name of the RagEngineConfig. Format: `projects/{project}/locations/{location}/ragEngineConfig`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1RagEngineConfig" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "agents": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.agents.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.agents.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.agents.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.agents.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.agents.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "apps": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.apps.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.apps.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.apps.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.apps.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.apps.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "batchPredictionJobs": { + "methods": { + "cancel": { + "description": "Cancels a BatchPredictionJob. Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetBatchPredictionJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its BatchPredictionJob.state is set to `CANCELLED`. Any files already outputted by the job are not deleted.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.batchPredictionJobs.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the BatchPredictionJob to cancel. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1CancelBatchPredictionJobRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.batchPredictionJobs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the BatchPredictionJob in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/batchPredictionJobs", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1BatchPredictionJob" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1BatchPredictionJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a BatchPredictionJob. Can only be called on jobs that already finished.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.batchPredictionJobs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the BatchPredictionJob resource to be deleted. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a BatchPredictionJob", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.batchPredictionJobs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the BatchPredictionJob resource. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1BatchPredictionJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists BatchPredictionJobs in a Location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.batchPredictionJobs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `model_display_name` supports `=`, `!=` comparisons. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token. Typically obtained via ListBatchPredictionJobsResponse.next_page_token of the previous JobService.ListBatchPredictionJobs call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list the BatchPredictionJobs from. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/batchPredictionJobs", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListBatchPredictionJobsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "cachedContents": { + "methods": { + "create": { + "description": "Creates cached content, this call will initialize the cached content in the data storage, and users need to pay for the cache data storage.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/cachedContents", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.cachedContents.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource where the cached content will be created", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/cachedContents", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1CachedContent" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1CachedContent" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes cached content", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.cachedContents.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name referring to the cached content", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/cachedContents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets cached content configurations", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.cachedContents.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name referring to the cached content", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/cachedContents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1CachedContent" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists cached contents in a project", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/cachedContents", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.cachedContents.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of cached contents to return. The service may return fewer than this value. If unspecified, some default (under maximum) number of items will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListCachedContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCachedContents` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent, which owns this collection of cached contents.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/cachedContents", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListCachedContentsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates cached content configurations", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.cachedContents.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/cachedContents/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1CachedContent" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1CachedContent" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "customJobs": { + "methods": { + "cancel": { + "description": "Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetCustomJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the CustomJob is not deleted; instead it becomes a job with a CustomJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and CustomJob.state is set to `CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.customJobs.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the CustomJob to cancel. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1CancelCustomJobRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a CustomJob. A created CustomJob right away will be attempted to be run.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.customJobs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/customJobs", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1CustomJob" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1CustomJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a CustomJob.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.customJobs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the CustomJob resource to be deleted. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a CustomJob.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.customJobs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the CustomJob resource. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1CustomJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists CustomJobs in a Location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.customJobs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token. Typically obtained via ListCustomJobsResponse.next_page_token of the previous JobService.ListCustomJobs call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list the CustomJobs from. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/customJobs", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListCustomJobsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.customJobs.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.customJobs.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.customJobs.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.customJobs.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.customJobs.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "dataLabelingJobs": { + "methods": { + "cancel": { + "description": "Cancels a DataLabelingJob. Success of cancellation is not guaranteed.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.dataLabelingJobs.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1CancelDataLabelingJobRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a DataLabelingJob.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.dataLabelingJobs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent of the DataLabelingJob. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/dataLabelingJobs", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1DataLabelingJob" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1DataLabelingJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a DataLabelingJob.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.dataLabelingJobs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the DataLabelingJob to be deleted. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a DataLabelingJob.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.dataLabelingJobs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1DataLabelingJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists DataLabelingJobs in a Location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.dataLabelingJobs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent of the DataLabelingJob. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read. FieldMask represents a set of symbolic field paths. For example, the mask can be `paths: \"name\"`. The \"name\" here is a field in DataLabelingJob. If this field is not set, all fields of the DataLabelingJob are returned.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/dataLabelingJobs", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListDataLabelingJobsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.dataLabelingJobs.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.dataLabelingJobs.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.dataLabelingJobs.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.dataLabelingJobs.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.dataLabelingJobs.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "datasets": { + "methods": { + "assemble": { + "description": "Assembles each row of a multimodal dataset and writes the result into a BigQuery table.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:assemble", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.assemble", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Dataset resource (used only for MULTIMODAL datasets). Format: `projects/{project}/locations/{location}/datasets/{dataset}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:assemble", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1AssembleDataRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "assess": { + "description": "Assesses the state or validity of the dataset with respect to a given use case.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:assess", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.assess", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Dataset resource. Used only for MULTIMODAL datasets. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:assess", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1AssessDataRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a Dataset.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the Dataset in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/datasets", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Dataset" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a Dataset.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.datasets.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Dataset to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "export": { + "description": "Exports data from a Dataset.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:export", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.export", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:export", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1ExportDataRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a Dataset.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Dataset resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1Dataset" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "import": { + "description": "Imports data into a Dataset.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:import", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.import", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:import", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1ImportDataRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Datasets in a Location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `display_name`: supports = and != * `metadata_schema_uri`: supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. Some examples: * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"`", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the Dataset's parent resource. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/datasets", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListDatasetsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a Dataset.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.datasets.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` * `description` * `labels`", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Dataset" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1Dataset" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "searchDataItems": { + "description": "Searches DataItems in a Dataset.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:searchDataItems", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.searchDataItems", + "parameterOrder": [ + "dataset" + ], + "parameters": { + "annotationFilters": { + "description": "An expression that specifies what Annotations will be returned per DataItem. Annotations satisfied either of the conditions will be returned. * `annotation_spec_id` - for = or !=. Must specify `saved_query_id=` - saved query id that annotations should belong to.", + "location": "query", + "repeated": true, + "type": "string" + }, + "annotationsFilter": { + "deprecated": true, + "description": "An expression for filtering the Annotations that will be returned per DataItem. * `annotation_spec_id` - for = or !=.", + "location": "query", + "type": "string" + }, + "annotationsLimit": { + "description": "If set, only up to this many of Annotations will be returned per DataItemView. The maximum value is 1000. If not set, the maximum value will be used.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "dataItemFilter": { + "description": "An expression for filtering the DataItem that will be returned. * `data_item_id` - for = or !=. * `labeled` - for = or !=. * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that have at least one annotation with annotation_spec_id = `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob. For example: * `data_item=1` * `has_annotation(5)`", + "location": "query", + "type": "string" + }, + "dataLabelingJob": { + "description": "The resource name of a DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` If this field is set, all of the search will be done in the context of this DataLabelingJob.", + "location": "query", + "type": "string" + }, + "dataset": { + "description": "Required. The resource name of the Dataset from which to search DataItems. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + }, + "fieldMask": { + "description": "Mask specifying which fields of DataItemView to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "orderBy": { + "deprecated": true, + "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", + "location": "query", + "type": "string" + }, + "orderByAnnotation.orderBy": { + "description": "A comma-separated list of annotation fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Must also specify saved_query.", + "location": "query", + "type": "string" + }, + "orderByAnnotation.savedQuery": { + "description": "Required. Saved query of the Annotation. Only Annotations belong to this saved query will be considered for ordering.", + "location": "query", + "type": "string" + }, + "orderByDataItem": { + "description": "A comma-separated list of data item fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Server may return fewer results than requested. Default and maximum page size is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results for the server to return Typically obtained via SearchDataItemsResponse.next_page_token of the previous DatasetService.SearchDataItems call.", + "location": "query", + "type": "string" + }, + "savedQuery": { + "deprecated": true, + "description": "The resource name of a SavedQuery(annotation set in UI). Format: `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}` All of the search will be done in the context of this SavedQuery.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+dataset}:searchDataItems", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1SearchDataItemsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "annotationSpecs": { + "methods": { + "get": { + "description": "Gets an AnnotationSpec.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.annotationSpecs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the AnnotationSpec resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1AnnotationSpec" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "dataItems": { + "methods": { + "list": { + "description": "Lists DataItems in a Dataset.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.dataItems.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Dataset to list DataItems from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/dataItems", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListDataItemsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "annotations": { + "methods": { + "list": { + "description": "Lists Annotations belongs to a dataitem.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.dataItems.annotations.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the DataItem to list Annotations from. Format: `projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/annotations", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListAnnotationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.dataItems.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.datasets.dataItems.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.dataItems.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.dataItems.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.dataItems.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "datasetVersions": { + "methods": { + "create": { + "description": "Create a version from a Dataset.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.datasetVersions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/datasetVersions", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1DatasetVersion" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a Dataset version.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.datasets.datasetVersions.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a Dataset version.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.datasetVersions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1DatasetVersion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists DatasetVersions in a Dataset.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.datasetVersions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The standard list filter.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Optional. Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/datasetVersions", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListDatasetVersionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a DatasetVersion.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.datasets.datasetVersions.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name`", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1DatasetVersion" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1DatasetVersion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "restore": { + "description": "Restores a dataset version.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.datasetVersions.restore", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the DatasetVersion resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:restore", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.datasets.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "savedQueries": { + "methods": { + "delete": { + "description": "Deletes a SavedQuery.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.datasets.savedQueries.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the SavedQuery to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists SavedQueries in a Dataset.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.savedQueries.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Dataset to list SavedQueries from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/savedQueries", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListSavedQueriesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.savedQueries.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.datasets.savedQueries.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.savedQueries.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.savedQueries.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.savedQueries.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + }, + "deploymentResourcePools": { + "methods": { + "create": { + "description": "Create a DeploymentResourcePool.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.deploymentResourcePools.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent location resource where this DeploymentResourcePool will be created. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/deploymentResourcePools", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1CreateDeploymentResourcePoolRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Delete a DeploymentResourcePool.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.deploymentResourcePools.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the DeploymentResourcePool to delete. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get a DeploymentResourcePool.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.deploymentResourcePools.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the DeploymentResourcePool to retrieve. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1DeploymentResourcePool" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List DeploymentResourcePools in a location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.deploymentResourcePools.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of DeploymentResourcePools to return. The service may return fewer than this value.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListDeploymentResourcePools` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDeploymentResourcePools` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent Location which owns this collection of DeploymentResourcePools. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/deploymentResourcePools", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListDeploymentResourcePoolsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Update a DeploymentResourcePool.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.deploymentResourcePools.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1DeploymentResourcePool" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "queryDeployedModels": { + "description": "List DeployedModels that have been deployed on this DeploymentResourcePool.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}:queryDeployedModels", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.deploymentResourcePools.queryDeployedModels", + "parameterOrder": [ + "deploymentResourcePool" + ], + "parameters": { + "deploymentResourcePool": { + "description": "Required. The name of the target DeploymentResourcePool to query. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The maximum number of DeployedModels to return. The service may return fewer than this value.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `QueryDeployedModels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryDeployedModels` must match the call that provided the page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+deploymentResourcePool}:queryDeployedModels", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1QueryDeployedModelsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.deploymentResourcePools.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.deploymentResourcePools.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.deploymentResourcePools.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.deploymentResourcePools.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.deploymentResourcePools.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "edgeDevices": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/edgeDevices/{edgeDevicesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.edgeDevices.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/edgeDevices/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/edgeDevices/{edgeDevicesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.edgeDevices.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/edgeDevices/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/edgeDevices/{edgeDevicesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.edgeDevices.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/edgeDevices/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/edgeDevices/{edgeDevicesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.edgeDevices.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/edgeDevices/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/edgeDevices/{edgeDevicesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.edgeDevices.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/edgeDevices/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "endpoints": { + "methods": { + "computeTokens": { + "description": "Return a list of tokens based on the input text.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:computeTokens", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.computeTokens", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}:computeTokens", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1ComputeTokensRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ComputeTokensResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "countTokens": { + "description": "Perform a token counting.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:countTokens", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.countTokens", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}:countTokens", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1CountTokensRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1CountTokensResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "create": { + "description": "Creates an Endpoint.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "endpointId": { + "description": "Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are `[0-9]` with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as `?endpoint_id=12345`. This is the fallback for fields that are not included in either the URI or the body.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to create the Endpoint in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/endpoints", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Endpoint" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an Endpoint.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.endpoints.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Endpoint resource to be deleted. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "deployModel": { + "description": "Deploys a Model into this Endpoint, creating a DeployedModel within it.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:deployModel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.deployModel", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint resource into which to deploy a Model. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}:deployModel", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1DeployModelRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "directPredict": { + "description": "Perform an unary online prediction request to a gRPC model server for Vertex first-party products and frameworks.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directPredict", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.directPredict", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}:directPredict", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1DirectPredictRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1DirectPredictResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "directRawPredict": { + "description": "Perform an unary online prediction request to a gRPC model server for custom containers.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directRawPredict", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.directRawPredict", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}:directRawPredict", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1DirectRawPredictRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1DirectRawPredictResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "explain": { + "description": "Perform an online explanation. If deployed_model_id is specified, the corresponding DeployModel must have explanation_spec populated. If deployed_model_id is not specified, all DeployedModels must have explanation_spec populated.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:explain", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.explain", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the explanation. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}:explain", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1ExplainRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ExplainResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "fetchPredictOperation": { + "description": "Fetch an asynchronous online prediction operation.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:fetchPredictOperation", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.fetchPredictOperation", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}:fetchPredictOperation", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1FetchPredictOperationRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "generateContent": { + "description": "Generate content with multimodal inputs.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:generateContent", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.generateContent", + "parameterOrder": [ + "model" + ], + "parameters": { + "model": { + "description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+model}:generateContent", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "get": { + "description": "Gets an Endpoint.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.endpoints.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Endpoint resource. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1Endpoint" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:getIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:getIamPolicy", + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Endpoints in a Location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.endpoints.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports `=` and `!=`. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * `display_name` supports `=` and `!=`. * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:*` or `labels:key` - key existence * A key including a space must be quoted. `labels.\"a key\"`. * `base_model_name` only supports `=`. Some examples: * `endpoint=1` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"` * `baseModelName=\"text-bison\"`", + "location": "query", + "type": "string" + }, + "gdcZone": { + "description": "Optional. Configures the Google Distributed Cloud (GDC) environment for online prediction. Only set this field when the Endpoint is to be deployed in a GDC environment.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token. Typically obtained via ListEndpointsResponse.next_page_token of the previous EndpointService.ListEndpoints call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location from which to list the Endpoints. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Optional. Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/endpoints", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListEndpointsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "mutateDeployedModel": { + "description": "Updates an existing deployed model. Updatable fields include `min_replica_count`, `max_replica_count`, `required_replica_count`, `autoscaling_metric_specs`, `disable_container_logging` (v1 only), and `enable_container_logging` (v1beta1 only).", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:mutateDeployedModel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.mutateDeployedModel", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint resource into which to mutate a DeployedModel. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}:mutateDeployedModel", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1MutateDeployedModelRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an Endpoint.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.endpoints.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The resource name of the Endpoint.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Endpoint" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1Endpoint" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "predict": { + "description": "Perform an online prediction.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predict", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.predict", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}:predict", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1PredictRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1PredictResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "predictLongRunning": { + "description": "", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predictLongRunning", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.predictLongRunning", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}:predictLongRunning", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1PredictLongRunningRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "rawPredict": { + "description": "Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's DeployedModel that served this prediction.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:rawPredict", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.rawPredict", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}:rawPredict", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1RawPredictRequest" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "serverStreamingPredict": { + "description": "Perform a server-side streaming online prediction request for Vertex LLM streaming.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:serverStreamingPredict", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.serverStreamingPredict", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}:serverStreamingPredict", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1StreamingPredictRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1StreamingPredictResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "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": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:setIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:setIamPolicy", + "request": { + "$ref": "GoogleIamV1SetIamPolicyRequest" + }, + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "streamGenerateContent": { + "description": "Generate content with multimodal inputs with streaming support.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamGenerateContent", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.streamGenerateContent", + "parameterOrder": [ + "model" + ], + "parameters": { + "model": { + "description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+model}:streamGenerateContent", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "streamRawPredict": { + "description": "Perform a streaming online prediction with an arbitrary HTTP payload.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamRawPredict", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.streamRawPredict", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}:streamRawPredict", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1StreamRawPredictRequest" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:testIamPermissions", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "permissions": { + "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", + "location": "query", + "repeated": true, + "type": "string" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:testIamPermissions", + "response": { + "$ref": "GoogleIamV1TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "undeployModel": { + "description": "Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:undeployModel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.undeployModel", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint resource from which to undeploy a Model. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}:undeployModel", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1UndeployModelRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "update": { + "description": "Updates an Endpoint with a long running operation.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:update", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.update", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The resource name of the Endpoint.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:update", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1UpdateEndpointLongRunningRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "chat": { + "methods": { + "completions": { + "description": "Exposes an OpenAI-compatible endpoint for chat completions.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/chat/completions", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.chat.completions", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}/chat/completions", + "request": { + "$ref": "GoogleApiHttpBody" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + }, + "deployedModels": { + "resources": { + "invoke": { + "methods": { + "invoke": { + "description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/deployedModels/{deployedModelId}/invoke/{invokeId}", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.deployedModels.invoke.invoke", + "parameterOrder": [ + "endpoint", + "deployedModelId", + "invokeId" + ], + "parameters": { + "deployedModelId": { + "description": "ID of the DeployedModel that serves the invoke request.", + "location": "path", + "required": true, + "type": "string" + }, + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + }, + "invokeId": { + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}/deployedModels/{deployedModelId}/invoke/{+invokeId}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1InvokeRequest" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + } + } + }, + "invoke": { + "methods": { + "invoke": { + "description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/invoke/{invokeId}", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.invoke.invoke", + "parameterOrder": [ + "endpoint", + "invokeId" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + }, + "invokeId": { + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}/invoke/{+invokeId}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1InvokeRequest" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + }, + "openapi": { + "methods": { + "embeddings": { + "description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/openapi/embeddings", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.openapi.embeddings", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "deployedModelId": { + "description": "ID of the DeployedModel that serves the invoke request.", + "location": "query", + "type": "string" + }, + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/openapi$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}/embeddings", + "request": { + "$ref": "GoogleApiHttpBody" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.endpoints.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.endpoints.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.endpoints.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.endpoints.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "evaluationItems": { + "methods": { + "create": { + "description": "Creates an Evaluation Item.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.evaluationItems.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the Evaluation Item in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/evaluationItems", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationItem" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationItem" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an Evaluation Item.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.evaluationItems.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the EvaluationItem resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets an Evaluation Item.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.evaluationItems.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the EvaluationItem resource. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationItem" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Evaluation Items.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.evaluationItems.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter expression that matches a subset of the EvaluationItems to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of Evaluation Items to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListEvaluationItems` call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location from which to list the Evaluation Items. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/evaluationItems", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListEvaluationItemsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.evaluationItems.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.evaluationItems.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.evaluationItems.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.evaluationItems.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "evaluationRuns": { + "methods": { + "cancel": { + "description": "Cancels an Evaluation Run. Attempts to cancel a running Evaluation Run asynchronously. Status of run can be checked via GetEvaluationRun.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.evaluationRuns.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the EvaluationRun resource to be cancelled. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1CancelEvaluationRunRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates an Evaluation Run.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.evaluationRuns.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the Evaluation Run in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/evaluationRuns", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationRun" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationRun" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an Evaluation Run.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.evaluationRuns.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the EvaluationRun resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets an Evaluation Run.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.evaluationRuns.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the EvaluationRun resource. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationRun" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Evaluation Runs.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.evaluationRuns.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter expression that matches a subset of the EvaluationRuns to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of Evaluation Runs to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListEvaluationRuns` call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location from which to list the Evaluation Runs. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/evaluationRuns", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListEvaluationRunsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.evaluationRuns.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.evaluationRuns.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.evaluationRuns.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.evaluationRuns.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "evaluationSets": { + "methods": { + "create": { + "description": "Creates an Evaluation Set.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.evaluationSets.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the Evaluation Set in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/evaluationSets", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationSet" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationSet" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an Evaluation Set.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.evaluationSets.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the EvaluationSet resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets an Evaluation Set.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.evaluationSets.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the EvaluationSet resource. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationSet" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Evaluation Sets.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.evaluationSets.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter expression that matches a subset of the EvaluationSets to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of Evaluation Sets to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListEvaluationSets` call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location from which to list the Evaluation Sets. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/evaluationSets", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListEvaluationSetsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an Evaluation Set.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.evaluationSets.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the EvaluationSet. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationSet" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationSet" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.evaluationSets.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.evaluationSets.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.evaluationSets.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.evaluationSets.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "evaluationTasks": { + "resources": { + "operations": { + "methods": { + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationTasks/{evaluationTasksId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.evaluationTasks.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationTasks/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationTasks/{evaluationTasksId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.evaluationTasks.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationTasks/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationTasks/{evaluationTasksId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.evaluationTasks.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationTasks/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationTasks/{evaluationTasksId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.evaluationTasks.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationTasks/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "exampleStores": { + "methods": { + "create": { + "description": "Create an ExampleStore.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores:create", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.exampleStores.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "exampleStore.createTime": { + "description": "Output only. Timestamp when this ExampleStore was created.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, + "exampleStore.description": { + "description": "Optional. Description of the ExampleStore.", + "location": "query", + "type": "string" + }, + "exampleStore.displayName": { + "description": "Required. Display name of the ExampleStore.", + "location": "query", + "type": "string" + }, + "exampleStore.exampleStoreConfig.vertexEmbeddingModel": { + "description": "Required. The embedding model to be used for vector embedding. Immutable. Supported models: * \"text-embedding-005\" * \"text-multilingual-embedding-002\"", + "location": "query", + "type": "string" + }, + "exampleStore.name": { + "description": "Identifier. The resource name of the ExampleStore. This is a unique identifier. Format: projects/{project}/locations/{location}/exampleStores/{example_store}", + "location": "query", + "type": "string" + }, + "exampleStore.updateTime": { + "description": "Output only. Timestamp when this ExampleStore was most recently updated.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to create the ExampleStore in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/exampleStores:create", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Delete an ExampleStore.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.exampleStores.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the ExampleStore to be deleted. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "fetchExamples": { + "description": "Get Examples from the Example Store.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}:fetchExamples", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.exampleStores.fetchExamples", + "parameterOrder": [ + "exampleStore" + ], + "parameters": { + "exampleStore": { + "description": "Required. The name of the ExampleStore resource that the examples should be fetched from. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+exampleStore}:fetchExamples", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1FetchExamplesRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1FetchExamplesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get an ExampleStore.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.exampleStores.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the ExampleStore. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ExampleStore" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List ExampleStores in a Location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.exampleStores.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list the ExampleStores from. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/exampleStores", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListExampleStoresResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Update an ExampleStore.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.exampleStores.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the ExampleStore. This is a unique identifier. Format: projects/{project}/locations/{location}/exampleStores/{example_store}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Mask specifying which fields to update. Supported fields: * `display_name` * `description`", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1ExampleStore" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "removeExamples": { + "description": "Remove Examples from the Example Store.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}:removeExamples", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.exampleStores.removeExamples", + "parameterOrder": [ + "exampleStore" + ], + "parameters": { + "exampleStore": { + "description": "Required. The name of the ExampleStore resource that the examples should be removed from. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+exampleStore}:removeExamples", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1RemoveExamplesRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1RemoveExamplesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "searchExamples": { + "description": "Search for similar Examples for given selection criteria.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}:searchExamples", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.exampleStores.searchExamples", + "parameterOrder": [ + "exampleStore" + ], + "parameters": { + "exampleStore": { + "description": "Required. The name of the ExampleStore resource that examples are retrieved from. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+exampleStore}:searchExamples", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1SearchExamplesRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1SearchExamplesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "upsertExamples": { + "description": "Create or update Examples in the Example Store.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}:upsertExamples", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.exampleStores.upsertExamples", + "parameterOrder": [ + "exampleStore" + ], + "parameters": { + "exampleStore": { + "description": "Required. The name of the ExampleStore resource that examples are added to or updated in. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+exampleStore}:upsertExamples", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1UpsertExamplesRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1UpsertExamplesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.exampleStores.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.exampleStores.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.exampleStores.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.exampleStores.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.exampleStores.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "extensionControllers": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensionControllers/{extensionControllersId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.extensionControllers.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/extensionControllers/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensionControllers/{extensionControllersId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.extensionControllers.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/extensionControllers/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensionControllers/{extensionControllersId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.extensionControllers.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/extensionControllers/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensionControllers/{extensionControllersId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.extensionControllers.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/extensionControllers/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensionControllers/{extensionControllersId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.extensionControllers.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/extensionControllers/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "extensions": { + "methods": { + "delete": { + "description": "Deletes an Extension.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.extensions.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Extension resource to be deleted. Format: `projects/{project}/locations/{location}/extensions/{extension}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "execute": { + "description": "Executes the request against a given extension.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}:execute", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.extensions.execute", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name (identifier) of the extension; Format: `projects/{project}/locations/{location}/extensions/{extension}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:execute", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1ExecuteExtensionRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ExecuteExtensionResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets an Extension.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.extensions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Extension resource. Format: `projects/{project}/locations/{location}/extensions/{extension}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1Extension" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "import": { + "description": "Imports an Extension.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions:import", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.extensions.import", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to import the Extension in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/extensions:import", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Extension" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Extensions in a location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.extensions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The standard list filter. Supported fields: * `display_name` * `create_time` * `update_time` More detail in [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list the Extensions from. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/extensions", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListExtensionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "patch": { + "description": "Updates an Extension.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.extensions.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the Extension.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. Mask specifying which fields to update. Supported fields: * `display_name` * `description` * `runtime_config` * `tool_use_examples` * `manifest.description`", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Extension" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1Extension" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "query": { + "description": "Queries an extension with a default controller.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}:query", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.extensions.query", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name (identifier) of the extension; Format: `projects/{project}/locations/{location}/extensions/{extension}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:query", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1QueryExtensionRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1QueryExtensionResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.extensions.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.extensions.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.extensions.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.extensions.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.extensions.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "featureGroups": { + "methods": { + "create": { + "description": "Creates a new FeatureGroup in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureGroups.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "featureGroupId": { + "description": "Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to create FeatureGroups. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/featureGroups", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureGroup" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single FeatureGroup.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featureGroups.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "If set to true, any Features under this FeatureGroup will also be deleted. (Otherwise, the request will only work if the FeatureGroup has no Features.)", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the FeatureGroup to be deleted. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single FeatureGroup.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the FeatureGroup resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:getIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureGroups.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:getIamPolicy", + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists FeatureGroups in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Lists the FeatureGroups that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > \"2020-01-01\" OR update_time > \"2020-01-01\"` FeatureGroups created or updated after 2020-01-01. * `labels.env = \"prod\"` FeatureGroups with label \"env\" set to \"prod\".", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported Fields: * `create_time` * `update_time`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of FeatureGroups to return. The service may return fewer than this value. If unspecified, at most 100 FeatureGroups will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous FeatureRegistryService.ListFeatureGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureGroups must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list FeatureGroups. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/featureGroups", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListFeatureGroupsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single FeatureGroup.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.featureGroups.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. Name of the FeatureGroup. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` * `service_agent_type`", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureGroup" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:setIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureGroups.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:setIamPolicy", + "request": { + "$ref": "GoogleIamV1SetIamPolicyRequest" + }, + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:testIamPermissions", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureGroups.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "permissions": { + "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", + "location": "query", + "repeated": true, + "type": "string" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:testIamPermissions", + "response": { + "$ref": "GoogleIamV1TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "featureMonitors": { + "methods": { + "create": { + "description": "Creates a new FeatureMonitor in a given project, location and FeatureGroup.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureGroups.featureMonitors.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "featureMonitorId": { + "description": "Required. The ID to use for this FeatureMonitor, which will become the final component of the FeatureGroup's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the FeatureGroup.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of FeatureGroup to create FeatureMonitor. Format: `projects/{project}/locations/{location}/featureGroups/{featuregroup}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/featureMonitors", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureMonitor" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single FeatureMonitor.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featureGroups.featureMonitors.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the FeatureMonitor to be deleted. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single FeatureMonitor.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.featureMonitors.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the FeatureMonitor resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureMonitor" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists FeatureGroups in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.featureMonitors.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Lists the FeatureMonitors that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > \"2020-01-01\" OR update_time > \"2020-01-01\"` FeatureMonitors created or updated after 2020-01-01. * `labels.env = \"prod\"` FeatureGroups with label \"env\" set to \"prod\".", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported Fields: * `create_time` * `update_time`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of FeatureGroups to return. The service may return fewer than this value. If unspecified, at most 100 FeatureMonitors will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous FeatureRegistryService.ListFeatureMonitors call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureMonitors must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the FeatureGroup to list FeatureMonitors. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/featureMonitors", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListFeatureMonitorsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single FeatureMonitor.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.featureGroups.featureMonitors.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. Name of the FeatureMonitor. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}/featureMonitors/{featureMonitor}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask is used to specify the fields to be overwritten in the FeatureMonitor resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `schedule_config` * `feature_selection_config`", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureMonitor" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "featureMonitorJobs": { + "methods": { + "create": { + "description": "Creates a new feature monitor job.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/featureMonitorJobs", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureGroups.featureMonitors.featureMonitorJobs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "featureMonitorJobId": { + "description": "Optional. Output only. System-generated ID for feature monitor job.", + "format": "int64", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of FeatureMonitor to create FeatureMonitorJob. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/featureMonitorJobs", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureMonitorJob" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureMonitorJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get a feature monitor job.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/featureMonitorJobs/{featureMonitorJobsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.featureMonitors.featureMonitorJobs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the FeatureMonitorJob resource. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}/featureMonitorJobs/{feature_monitor_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+/featureMonitorJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureMonitorJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List feature monitor jobs.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/featureMonitorJobs", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.featureMonitors.featureMonitorJobs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Lists the FeatureMonitorJobs that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be Examples: * `create_time > \"2020-01-01\"` FeatureMonitorJobs created after 2020-01-01.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported Fields: * `create_time`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of FeatureMonitorJobs to return. The service may return fewer than this value. If unspecified, at most 100 FeatureMonitorJobs will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous FeatureRegistryService.ListFeatureMonitorJobs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureMonitorJobs must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the FeatureMonitor to list FeatureMonitorJobs. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/featureMonitorJobs", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListFeatureMonitorJobsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "operations": { + "methods": { + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featureGroups.featureMonitors.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.featureMonitors.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.featureMonitors.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureGroups.featureMonitors.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "features": { + "methods": { + "batchCreate": { + "description": "Creates a batch of Features in a given FeatureGroup.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features:batchCreate", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureGroups.features.batchCreate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/features:batchCreate", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1BatchCreateFeaturesRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a new Feature in a given FeatureGroup.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureGroups.features.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "featureId": { + "description": "Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/features", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Feature" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single Feature.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featureGroups.features.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Features to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single Feature.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.features.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "featureStatsAndAnomalySpec.latestStatsCount": { + "description": "Optional. If set, returns the most recent count of stats. Valid value is [0, 100]. If stats_time_range is set, return most recent count of stats within the stats_time_range.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "featureStatsAndAnomalySpec.statsTimeRange.endTime": { + "description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, + "featureStatsAndAnomalySpec.statsTimeRange.startTime": { + "description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1Feature" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Features in a given FeatureGroup.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.features.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --> Features whose type is DOUBLE. * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any Feature which has a label with 'env' as the key.", + "location": "query", + "type": "string" + }, + "latestStatsCount": { + "description": "Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "orderBy": { + "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/features", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListFeaturesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single Feature.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.featureGroups.features.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore)", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Feature" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featureGroups.features.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.features.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.features.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureGroups.features.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "operations": { + "methods": { + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featureGroups.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureGroups.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "featureOnlineStores": { + "methods": { + "create": { + "description": "Creates a new FeatureOnlineStore in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "featureOnlineStoreId": { + "description": "Required. The ID to use for this FeatureOnlineStore, which will become the final component of the FeatureOnlineStore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/featureOnlineStores", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureOnlineStore" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not contain any FeatureViews.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featureOnlineStores.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "If set to true, any FeatureViews and Features for this FeatureOnlineStore will also be deleted. (Otherwise, the request will only work if the FeatureOnlineStore has no FeatureViews.)", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the FeatureOnlineStore to be deleted. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single FeatureOnlineStore.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureOnlineStores.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the FeatureOnlineStore resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureOnlineStore" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:getIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:getIamPolicy", + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists FeatureOnlineStores in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureOnlineStores.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Lists the FeatureOnlineStores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > \"2020-01-01\" OR update_time > \"2020-01-01\"` FeatureOnlineStores created or updated after 2020-01-01. * `labels.env = \"prod\"` FeatureOnlineStores with label \"env\" set to \"prod\".", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported Fields: * `create_time` * `update_time`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of FeatureOnlineStores to return. The service may return fewer than this value. If unspecified, at most 100 FeatureOnlineStores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureOnlineStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureOnlineStores must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list FeatureOnlineStores. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/featureOnlineStores", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListFeatureOnlineStoresResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single FeatureOnlineStore.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.featureOnlineStores.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. Name of the FeatureOnlineStore. Format: `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `bigtable` * `bigtable.auto_scaling` * `bigtable.enable_multi_region_replica`", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureOnlineStore" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:setIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:setIamPolicy", + "request": { + "$ref": "GoogleIamV1SetIamPolicyRequest" + }, + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:testIamPermissions", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "permissions": { + "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", + "location": "query", + "repeated": true, + "type": "string" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:testIamPermissions", + "response": { + "$ref": "GoogleIamV1TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "featureViews": { + "methods": { + "create": { + "description": "Creates a new FeatureView in a given FeatureOnlineStore.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "featureViewId": { + "description": "Required. The ID to use for the FeatureView, which will become the final component of the FeatureView's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a FeatureOnlineStore.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the FeatureOnlineStore to create FeatureViews. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "required": true, + "type": "string" + }, + "runSyncImmediately": { + "description": "Immutable. If set to true, one on demand sync will be run immediately, regardless whether the FeatureView.sync_config is configured or not.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+parent}/featureViews", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureView" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single FeatureView.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the FeatureView to be deleted. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "directWrite": { + "description": "Bidirectional streaming RPC to directly write to feature values in a feature view. Requests may not have a one-to-one mapping to responses and responses may be returned out-of-order to reduce latency.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:directWrite", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.directWrite", + "parameterOrder": [ + "featureView" + ], + "parameters": { + "featureView": { + "description": "FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+featureView}:directWrite", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "fetchFeatureValues": { + "description": "Fetch feature values under a FeatureView.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:fetchFeatureValues", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.fetchFeatureValues", + "parameterOrder": [ + "featureView" + ], + "parameters": { + "featureView": { + "description": "Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+featureView}:fetchFeatureValues", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1FetchFeatureValuesRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1FetchFeatureValuesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "generateFetchAccessToken": { + "description": "RPC to generate an access token for the given feature view. FeatureViews under the same FeatureOnlineStore share the same access token.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:generateFetchAccessToken", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.generateFetchAccessToken", + "parameterOrder": [ + "featureView" + ], + "parameters": { + "featureView": { + "description": "FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+featureView}:generateFetchAccessToken", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1GenerateFetchAccessTokenRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1GenerateFetchAccessTokenResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single FeatureView.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the FeatureView resource. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureView" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:getIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:getIamPolicy", + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists FeatureViews in a given FeatureOnlineStore.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Lists the FeatureViews that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> FeatureViews created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> FeatureViews having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any FeatureView which has a label with 'env' as the key.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `feature_view_id` * `create_time` * `update_time`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of FeatureViews to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViews will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViews call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViews must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the FeatureOnlineStore to list FeatureViews. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/featureViews", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListFeatureViewsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single FeatureView.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `service_agent_type` * `big_query_source` * `big_query_source.uri` * `big_query_source.entity_id_columns` * `feature_registry_source` * `feature_registry_source.feature_groups` * `sync_config` * `sync_config.cron` * `optimized_config.automatic_resources`", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureView" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "searchNearestEntities": { + "description": "Search the nearest entities under a FeatureView. Search only works for indexable feature view; if a feature view isn't indexable, returns Invalid argument response.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:searchNearestEntities", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.searchNearestEntities", + "parameterOrder": [ + "featureView" + ], + "parameters": { + "featureView": { + "description": "Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+featureView}:searchNearestEntities", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1SearchNearestEntitiesRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1SearchNearestEntitiesResponse" + }, + "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": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:setIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:setIamPolicy", + "request": { + "$ref": "GoogleIamV1SetIamPolicyRequest" + }, + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "streamingFetchFeatureValues": { + "description": "Bidirectional streaming RPC to fetch feature values under a FeatureView. Requests may not have a one-to-one mapping to responses and responses may be returned out-of-order to reduce latency.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:streamingFetchFeatureValues", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.streamingFetchFeatureValues", + "parameterOrder": [ + "featureView" + ], + "parameters": { + "featureView": { + "description": "Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+featureView}:streamingFetchFeatureValues", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1StreamingFetchFeatureValuesRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1StreamingFetchFeatureValuesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "sync": { + "description": "Triggers on-demand sync for the FeatureView.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:sync", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.sync", + "parameterOrder": [ + "featureView" + ], + "parameters": { + "featureView": { + "description": "Required. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+featureView}:sync", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1SyncFeatureViewRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1SyncFeatureViewResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:testIamPermissions", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "permissions": { + "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", + "location": "query", + "repeated": true, + "type": "string" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:testIamPermissions", + "response": { + "$ref": "GoogleIamV1TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "featureViewSyncs": { + "methods": { + "get": { + "description": "Gets details of a single FeatureViewSync.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs/{featureViewSyncsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the FeatureViewSync resource. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/featureViewSyncs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureViewSync" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists FeatureViewSyncs in a given FeatureView.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Lists the FeatureViewSyncs that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. Examples: * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> FeatureViewSyncs created after 2020-01-31T15:30:00.000000Z.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `create_time`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of FeatureViewSyncs to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViewSyncs will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViewSyncs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViewSyncs must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the FeatureView to list FeatureViewSyncs. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/featureViewSyncs", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListFeatureViewSyncsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "operations": { + "methods": { + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "operations": { + "methods": { + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featureOnlineStores.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureOnlineStores.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureOnlineStores.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "featurestores": { + "methods": { + "batchReadFeatureValues": { + "description": "Batch reads Feature values from a Featurestore. This API enables batch reading Feature values, where each read instance in the batch may read Feature values of entities from one or more EntityTypes. Point-in-time correctness is guaranteed for Feature values of each read instance as of each instance's read timestamp.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:batchReadFeatureValues", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.batchReadFeatureValues", + "parameterOrder": [ + "featurestore" + ], + "parameters": { + "featurestore": { + "description": "Required. The resource name of the Featurestore from which to query Feature values. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+featurestore}:batchReadFeatureValues", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1BatchReadFeatureValuesRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a new Featurestore in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "featurestoreId": { + "description": "Required. The ID to use for this Featurestore, which will become the final component of the Featurestore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to create Featurestores. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/featurestores", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Featurestore" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or `force` must be set to true for the request to succeed.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featurestores.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "If set to true, any EntityTypes and Features for this Featurestore will also be deleted. (Otherwise, the request will only work if the Featurestore has no EntityTypes.)", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the Featurestore to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single Featurestore.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featurestores.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Featurestore resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1Featurestore" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:getIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:getIamPolicy", + "request": { + "$ref": "GoogleIamV1GetIamPolicyRequest" + }, + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Featurestores in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featurestores.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Lists the featurestores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `online_serving_config.fixed_node_count`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > \"2020-01-01\" OR update_time > \"2020-01-01\"` Featurestores created or updated after 2020-01-01. * `labels.env = \"prod\"` Featurestores with label \"env\" set to \"prod\".", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported Fields: * `create_time` * `update_time` * `online_serving_config.fixed_node_count`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of Featurestores to return. The service may return fewer than this value. If unspecified, at most 100 Featurestores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous FeaturestoreService.ListFeaturestores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeaturestores must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list Featurestores. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/featurestores", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListFeaturestoresResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single Featurestore.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.featurestores.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Name of the Featurestore. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Field mask is used to specify the fields to be overwritten in the Featurestore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `online_serving_config.fixed_node_count` * `online_serving_config.scaling` * `online_storage_ttl_days`", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Featurestore" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "searchFeatures": { + "description": "Searches Features matching a query in a given project.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores:searchFeatures", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featurestores.searchFeatures", + "parameterOrder": [ + "location" + ], + "parameters": { + "location": { + "description": "Required. The resource name of the Location to search Features. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 100 Features will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous FeaturestoreService.SearchFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.SearchFeatures, except `page_size`, must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "query": { + "description": "Query string that is a conjunction of field-restricted queries and/or field-restricted filters. Field-restricted queries and filters can be combined using `AND` to form a conjunction. A field query is in the form FIELD:QUERY. This implicitly checks if QUERY exists as a substring within Feature's FIELD. The QUERY and the FIELD are converted to a sequence of words (i.e. tokens) for comparison. This is done by: * Removing leading/trailing whitespace and tokenizing the search value. Characters that are not one of alphanumeric `[a-zA-Z0-9]`, underscore `_`, or asterisk `*` are treated as delimiters for tokens. `*` is treated as a wildcard that matches characters within a token. * Ignoring case. * Prepending an asterisk to the first and appending an asterisk to the last token in QUERY. A QUERY must be either a singular token or a phrase. A phrase is one or multiple words enclosed in double quotation marks (\"). With phrases, the order of the words is important. Words in the phrase must be matching in order and consecutively. Supported FIELDs for field-restricted queries: * `feature_id` * `description` * `entity_type_id` Examples: * `feature_id: foo` --> Matches a Feature with ID containing the substring `foo` (eg. `foo`, `foofeature`, `barfoo`). * `feature_id: foo*feature` --> Matches a Feature with ID containing the substring `foo*feature` (eg. `foobarfeature`). * `feature_id: foo AND description: bar` --> Matches a Feature with ID containing the substring `foo` and description containing the substring `bar`. Besides field queries, the following exact-match filters are supported. The exact-match filters do not support wildcards. Unlike field-restricted queries, exact-match filters are case-sensitive. * `feature_id`: Supports = comparisons. * `description`: Supports = comparisons. Multi-token filters should be enclosed in quotes. * `entity_type_id`: Supports = comparisons. * `value_type`: Supports = and != comparisons. * `labels`: Supports key-value equality as well as key presence. * `featurestore_id`: Supports = comparisons. Examples: * `description = \"foo bar\"` --> Any Feature with description exactly equal to `foo bar` * `value_type = DOUBLE` --> Features whose type is DOUBLE. * `labels.active = yes AND labels.env = prod` --> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any Feature which has a label with `env` as the key.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+location}/featurestores:searchFeatures", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1SearchFeaturesResponse" + }, + "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": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:setIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:setIamPolicy", + "request": { + "$ref": "GoogleIamV1SetIamPolicyRequest" + }, + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:testIamPermissions", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:testIamPermissions", + "request": { + "$ref": "GoogleIamV1TestIamPermissionsRequest" + }, + "response": { + "$ref": "GoogleIamV1TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "entityTypes": { + "methods": { + "create": { + "description": "Creates a new EntityType in a given Featurestore.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.entityTypes.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "entityTypeId": { + "description": "Required. The ID to use for the EntityType, which will become the final component of the EntityType's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a featurestore.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Featurestore to create EntityTypes. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/entityTypes", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1EntityType" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single EntityType. The EntityType must not have any Features or `force` must be set to true for the request to succeed.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featurestores.entityTypes.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "If set to true, any Features for this EntityType will also be deleted. (Otherwise, the request will only work if the EntityType has no Features.)", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the EntityType to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "deleteFeatureValues": { + "description": "Delete Feature values from Featurestore. The progress of the deletion is tracked by the returned operation. The deleted feature values are guaranteed to be invisible to subsequent read operations after the operation is marked as successfully done. If a delete feature values operation fails, the feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same delete request again and wait till the new operation returned is marked as successfully done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:deleteFeatureValues", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.entityTypes.deleteFeatureValues", + "parameterOrder": [ + "entityType" + ], + "parameters": { + "entityType": { + "description": "Required. The resource name of the EntityType grouping the Features for which values are being deleted from. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+entityType}:deleteFeatureValues", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1DeleteFeatureValuesRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "exportFeatureValues": { + "description": "Exports Feature values from all the entities of a target EntityType.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:exportFeatureValues", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.entityTypes.exportFeatureValues", + "parameterOrder": [ + "entityType" + ], + "parameters": { + "entityType": { + "description": "Required. The resource name of the EntityType from which to export Feature values. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+entityType}:exportFeatureValues", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1ExportFeatureValuesRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single EntityType.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featurestores.entityTypes.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the EntityType resource. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1EntityType" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:getIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.entityTypes.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:getIamPolicy", + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "importFeatureValues": { + "description": "Imports Feature values into the Featurestore from a source storage. The progress of the import is tracked by the returned operation. The imported features are guaranteed to be visible to subsequent read operations after the operation is marked as successfully done. If an import operation fails, the Feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same import request again and wait till the new operation returned is marked as successfully done. There are also scenarios where the caller can cause inconsistency. - Source data for import contains multiple distinct Feature values for the same entity ID and timestamp. - Source is modified during an import. This includes adding, updating, or removing source data and/or metadata. Examples of updating metadata include but are not limited to changing storage location, storage class, or retention policy. - Online serving cluster is under-provisioned.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:importFeatureValues", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.entityTypes.importFeatureValues", + "parameterOrder": [ + "entityType" + ], + "parameters": { + "entityType": { + "description": "Required. The resource name of the EntityType grouping the Features for which values are being imported. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+entityType}:importFeatureValues", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1ImportFeatureValuesRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists EntityTypes in a given Featurestore.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featurestores.entityTypes.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Lists the EntityTypes that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> EntityTypes having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any EntityType which has a label with 'env' as the key.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `entity_type_id` * `create_time` * `update_time`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of EntityTypes to return. The service may return fewer than this value. If unspecified, at most 1000 EntityTypes will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous FeaturestoreService.ListEntityTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListEntityTypes must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Featurestore to list EntityTypes. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/entityTypes", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListEntityTypesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single EntityType.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.featurestores.entityTypes.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. Name of the EntityType. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` The last part entity_type is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Field mask is used to specify the fields to be overwritten in the EntityType resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `monitoring_config.snapshot_analysis.disabled` * `monitoring_config.snapshot_analysis.monitoring_interval_days` * `monitoring_config.snapshot_analysis.staleness_days` * `monitoring_config.import_features_analysis.state` * `monitoring_config.import_features_analysis.anomaly_detection_baseline` * `monitoring_config.numerical_threshold_config.value` * `monitoring_config.categorical_threshold_config.value` * `offline_storage_ttl_days`", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1EntityType" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1EntityType" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "readFeatureValues": { + "description": "Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:readFeatureValues", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.entityTypes.readFeatureValues", + "parameterOrder": [ + "entityType" + ], + "parameters": { + "entityType": { + "description": "Required. The resource name of the EntityType for the entity being read. Value format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+entityType}:readFeatureValues", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1ReadFeatureValuesRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ReadFeatureValuesResponse" + }, + "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": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:setIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.entityTypes.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:setIamPolicy", + "request": { + "$ref": "GoogleIamV1SetIamPolicyRequest" + }, + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "streamingReadFeatureValues": { + "description": "Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:streamingReadFeatureValues", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.entityTypes.streamingReadFeatureValues", + "parameterOrder": [ + "entityType" + ], + "parameters": { + "entityType": { + "description": "Required. The resource name of the entities' type. Value format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+entityType}:streamingReadFeatureValues", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1StreamingReadFeatureValuesRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ReadFeatureValuesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:testIamPermissions", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.entityTypes.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "permissions": { + "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", + "location": "query", + "repeated": true, + "type": "string" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:testIamPermissions", + "response": { + "$ref": "GoogleIamV1TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "writeFeatureValues": { + "description": "Writes Feature values of one or more entities of an EntityType. The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:writeFeatureValues", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.entityTypes.writeFeatureValues", + "parameterOrder": [ + "entityType" + ], + "parameters": { + "entityType": { + "description": "Required. The resource name of the EntityType for the entities being written. Value format: `projects/{project}/locations/{location}/featurestores/ {featurestore}/entityTypes/{entityType}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+entityType}:writeFeatureValues", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1WriteFeatureValuesRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1WriteFeatureValuesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "features": { + "methods": { + "batchCreate": { + "description": "Creates a batch of Features in a given EntityType.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features:batchCreate", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.entityTypes.features.batchCreate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/features:batchCreate", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1BatchCreateFeaturesRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a new Feature in a given EntityType.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.entityTypes.features.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "featureId": { + "description": "Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/features", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Feature" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single Feature.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featurestores.entityTypes.features.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Features to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single Feature.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featurestores.entityTypes.features.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "featureStatsAndAnomalySpec.latestStatsCount": { + "description": "Optional. If set, returns the most recent count of stats. Valid value is [0, 100]. If stats_time_range is set, return most recent count of stats within the stats_time_range.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "featureStatsAndAnomalySpec.statsTimeRange.endTime": { + "description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, + "featureStatsAndAnomalySpec.statsTimeRange.startTime": { + "description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1Feature" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Features in a given EntityType.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featurestores.entityTypes.features.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --> Features whose type is DOUBLE. * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any Feature which has a label with 'env' as the key.", + "location": "query", + "type": "string" + }, + "latestStatsCount": { + "description": "Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "orderBy": { + "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/features", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListFeaturesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single Feature.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.featurestores.entityTypes.features.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore)", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Feature" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1Feature" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.entityTypes.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featurestores.entityTypes.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featurestores.entityTypes.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featurestores.entityTypes.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { "description": "The standard list filter.", "location": "query", "type": "string" @@ -8622,7 +18413,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "required": true, "type": "string" }, @@ -8653,9 +18444,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations/{operationsId}:wait", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureGroups.featureMonitors.operations.wait", + "id": "aiplatform.projects.locations.featurestores.entityTypes.operations.wait", "parameterOrder": [ "name" ], @@ -8663,7 +18454,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -8686,222 +18477,468 @@ } } }, - "features": { + "operations": { "methods": { - "batchCreate": { - "description": "Creates a batch of Features in a given FeatureGroup.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features:batchCreate", + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureGroups.features.batchCreate", + "id": "aiplatform.projects.locations.featurestores.operations.cancel", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "parent": { - "description": "Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`", + "name": { + "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/features:batchCreate", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1BatchCreateFeaturesRequest" + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featurestores.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featurestores.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featurestores.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } }, + "path": "v1beta1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + } + } + } + } + }, + "hyperparameterTuningJobs": { + "methods": { + "cancel": { + "description": "Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetHyperparameterTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a HyperparameterTuningJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and HyperparameterTuningJob.state is set to `CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.hyperparameterTuningJobs.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the HyperparameterTuningJob to cancel. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1CancelHyperparameterTuningJobRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a HyperparameterTuningJob", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.hyperparameterTuningJobs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the HyperparameterTuningJob in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/hyperparameterTuningJobs", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1HyperparameterTuningJob" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1HyperparameterTuningJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a HyperparameterTuningJob.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.hyperparameterTuningJobs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the HyperparameterTuningJob resource to be deleted. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a HyperparameterTuningJob", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.hyperparameterTuningJobs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the HyperparameterTuningJob resource. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1HyperparameterTuningJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists HyperparameterTuningJobs in a Location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.hyperparameterTuningJobs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token. Typically obtained via ListHyperparameterTuningJobsResponse.next_page_token of the previous JobService.ListHyperparameterTuningJobs call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list the HyperparameterTuningJobs from. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" }, - "create": { - "description": "Creates a new Feature in a given FeatureGroup.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features", + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/hyperparameterTuningJobs", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListHyperparameterTuningJobsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureGroups.features.create", + "id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.cancel", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "featureId": { - "description": "Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", + "name": { + "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/features", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1Feature" - }, + "path": "v1beta1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { - "description": "Deletes a single Feature.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}", + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.featureGroups.features.delete", + "id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the Features to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}`", + "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { - "description": "Gets details of a single Feature.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}", + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureGroups.features.get", + "id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.get", "parameterOrder": [ "name" ], "parameters": { - "featureStatsAndAnomalySpec.latestStatsCount": { - "description": "Optional. If set, returns the most recent count of stats. Valid value is [0, 100]. If stats_time_range is set, return most recent count of stats within the stats_time_range.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "featureStatsAndAnomalySpec.statsTimeRange.endTime": { - "description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", - "format": "google-datetime", - "location": "query", - "type": "string" - }, - "featureStatsAndAnomalySpec.statsTimeRange.startTime": { - "description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.", - "format": "google-datetime", - "location": "query", - "type": "string" - }, "name": { - "description": "Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", + "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1Feature" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists Features in a given FeatureGroup.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureGroups.features.list", + "id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.list", "parameterOrder": [ - "parent" + "name" ], "parameters": { "filter": { - "description": "Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --> Features whose type is DOUBLE. * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any Feature which has a label with 'env' as the key.", + "description": "The standard list filter.", "location": "query", "type": "string" }, - "latestStatsCount": { - "description": "Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "orderBy": { - "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time`", - "location": "query", + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$", + "required": true, "type": "string" }, "pageSize": { - "description": "The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.", + "description": "The standard list page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token.", + "description": "The standard list page token.", "location": "query", "type": "string" }, - "parent": { - "description": "Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", - "type": "string" + "type": "boolean" } }, - "path": "v1beta1/{+parent}/features", + "path": "v1beta1/{+name}/operations", "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListFeaturesResponse" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "patch": { - "description": "Updates the parameters of a single Feature.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.featureGroups.features.patch", + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.wait", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type.", + "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, - "updateMask": { - "description": "Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore)", - "format": "google-fieldmask", + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", "location": "query", "type": "string" } }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1Feature" - }, + "path": "v1beta1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, @@ -8909,148 +18946,345 @@ "https://www.googleapis.com/auth/cloud-platform" ] } + } + } + } + }, + "indexEndpoints": { + "methods": { + "create": { + "description": "Creates an IndexEndpoint.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.indexEndpoints.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the IndexEndpoint in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } }, - "resources": { - "operations": { - "methods": { - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.featureGroups.features.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureGroups.features.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureGroups.features.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureGroups.features.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } + "path": "v1beta1/{+parent}/indexEndpoints", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1IndexEndpoint" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an IndexEndpoint.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.indexEndpoints.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the IndexEndpoint resource to be deleted. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "deployIndex": { + "description": "Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:deployIndex", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.indexEndpoints.deployIndex", + "parameterOrder": [ + "indexEndpoint" + ], + "parameters": { + "indexEndpoint": { + "description": "Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+indexEndpoint}:deployIndex", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1DeployIndexRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "findNeighbors": { + "description": "Finds the nearest neighbors of each vector within the request.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:findNeighbors", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.indexEndpoints.findNeighbors", + "parameterOrder": [ + "indexEndpoint" + ], + "parameters": { + "indexEndpoint": { + "description": "Required. The name of the index endpoint. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+indexEndpoint}:findNeighbors", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1FindNeighborsRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1FindNeighborsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets an IndexEndpoint.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.indexEndpoints.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the IndexEndpoint resource. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1IndexEndpoint" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists IndexEndpoints in a Location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.indexEndpoints.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `index_endpoint` supports = and !=. `index_endpoint` represents the IndexEndpoint ID, ie. the last segment of the IndexEndpoint's resourcename. * `display_name` supports =, != and regex() (uses [re2](https://github.com/google/re2/wiki/Syntax) syntax) * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* or labels:key - key existence A key including a space must be quoted. `labels.\"a key\"`. Some examples: * `index_endpoint=\"1\"` * `display_name=\"myDisplayName\"` * `regex(display_name, \"^A\") -> The display name starts with an A. * `labels.myKey=\"myValue\"`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token. Typically obtained via ListIndexEndpointsResponse.next_page_token of the previous IndexEndpointService.ListIndexEndpoints call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location from which to list the IndexEndpoints. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Optional. Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/indexEndpoints", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListIndexEndpointsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "mutateDeployedIndex": { + "description": "Update an existing DeployedIndex under an IndexEndpoint.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:mutateDeployedIndex", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.indexEndpoints.mutateDeployedIndex", + "parameterOrder": [ + "indexEndpoint" + ], + "parameters": { + "indexEndpoint": { + "description": "Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+indexEndpoint}:mutateDeployedIndex", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1DeployedIndex" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an IndexEndpoint.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.indexEndpoints.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The resource name of the IndexEndpoint.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask.", + "format": "google-fieldmask", + "location": "query", + "type": "string" } - } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1IndexEndpoint" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1IndexEndpoint" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "readIndexDatapoints": { + "description": "Reads the datapoints/vectors of the given IDs. A maximum of 1000 datapoints can be retrieved in a batch.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:readIndexDatapoints", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.indexEndpoints.readIndexDatapoints", + "parameterOrder": [ + "indexEndpoint" + ], + "parameters": { + "indexEndpoint": { + "description": "Required. The name of the index endpoint. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+indexEndpoint}:readIndexDatapoints", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1ReadIndexDatapointsRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ReadIndexDatapointsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, + "undeployIndex": { + "description": "Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:undeployIndex", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.indexEndpoints.undeployIndex", + "parameterOrder": [ + "indexEndpoint" + ], + "parameters": { + "indexEndpoint": { + "description": "Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+indexEndpoint}:undeployIndex", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1UndeployIndexRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { "operations": { "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.indexEndpoints.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.featureGroups.operations.delete", + "id": "aiplatform.projects.locations.indexEndpoints.operations.delete", "parameterOrder": [ "name" ], @@ -9058,7 +19292,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -9073,9 +19307,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureGroups.operations.get", + "id": "aiplatform.projects.locations.indexEndpoints.operations.get", "parameterOrder": [ "name" ], @@ -9083,7 +19317,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -9098,9 +19332,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureGroups.operations.list", + "id": "aiplatform.projects.locations.indexEndpoints.operations.list", "parameterOrder": [ "name" ], @@ -9113,7 +19347,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", "required": true, "type": "string" }, @@ -9144,9 +19378,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}:wait", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureGroups.operations.wait", + "id": "aiplatform.projects.locations.indexEndpoints.operations.wait", "parameterOrder": [ "name" ], @@ -9154,7 +19388,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -9177,33 +19411,28 @@ } } }, - "featureOnlineStores": { + "indexes": { "methods": { "create": { - "description": "Creates a new FeatureOnlineStore in a given project and location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores", + "description": "Creates an Index.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureOnlineStores.create", + "id": "aiplatform.projects.locations.indexes.create", "parameterOrder": [ "parent" ], "parameters": { - "featureOnlineStoreId": { - "description": "Required. The ID to use for this FeatureOnlineStore, which will become the final component of the FeatureOnlineStore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location.", - "location": "query", - "type": "string" - }, "parent": { - "description": "Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project}/locations/{location}`", + "description": "Required. The resource name of the Location to create the Index in. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/featureOnlineStores", + "path": "v1beta1/{+parent}/indexes", "request": { - "$ref": "GoogleCloudAiplatformV1beta1FeatureOnlineStore" + "$ref": "GoogleCloudAiplatformV1beta1Index" }, "response": { "$ref": "GoogleLongrunningOperation" @@ -9213,23 +19442,18 @@ ] }, "delete": { - "description": "Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not contain any FeatureViews.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}", + "description": "Deletes an Index. An Index can only be deleted when all its DeployedIndexes had been undeployed.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.featureOnlineStores.delete", + "id": "aiplatform.projects.locations.indexes.delete", "parameterOrder": [ "name" ], "parameters": { - "force": { - "description": "If set to true, any FeatureViews and Features for this FeatureOnlineStore will also be deleted. (Otherwise, the request will only work if the FeatureOnlineStore has no FeatureViews.)", - "location": "query", - "type": "boolean" - }, "name": { - "description": "Required. The name of the FeatureOnlineStore to be deleted. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`", + "description": "Required. The name of the Index resource to be deleted. Format: `projects/{project}/locations/{location}/indexes/{index}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", "required": true, "type": "string" } @@ -9243,134 +19467,414 @@ ] }, "get": { - "description": "Gets details of a single FeatureOnlineStore.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}", + "description": "Gets an Index.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureOnlineStores.get", + "id": "aiplatform.projects.locations.indexes.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the FeatureOnlineStore resource.", + "description": "Required. The name of the Index resource. Format: `projects/{project}/locations/{location}/indexes/{index}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1FeatureOnlineStore" + "$ref": "GoogleCloudAiplatformV1beta1Index" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:getIamPolicy", + "import": { + "description": "Imports an Index from an external source (e.g., BigQuery).", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:import", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureOnlineStores.getIamPolicy", + "id": "aiplatform.projects.locations.indexes.import", "parameterOrder": [ - "resource" + "name" ], "parameters": { - "options.requestedPolicyVersion": { - "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", - "format": "int32", - "location": "query", - "type": "integer" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "name": { + "description": "Required. The name of the Index resource to import data to. Format: `projects/{project}/locations/{location}/indexes/{index}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+resource}:getIamPolicy", + "path": "v1beta1/{+name}:import", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1ImportIndexRequest" + }, "response": { - "$ref": "GoogleIamV1Policy" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists FeatureOnlineStores in a given project and location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores", + "description": "Lists Indexes in a Location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes", "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureOnlineStores.list", + "id": "aiplatform.projects.locations.indexes.list", "parameterOrder": [ "parent" ], "parameters": { "filter": { - "description": "Lists the FeatureOnlineStores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > \"2020-01-01\" OR update_time > \"2020-01-01\"` FeatureOnlineStores created or updated after 2020-01-01. * `labels.env = \"prod\"` FeatureOnlineStores with label \"env\" set to \"prod\".", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported Fields: * `create_time` * `update_time`", + "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { - "description": "The maximum number of FeatureOnlineStores to return. The service may return fewer than this value. If unspecified, at most 100 FeatureOnlineStores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.", + "description": "The standard list page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureOnlineStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureOnlineStores must match the call that provided the page token.", + "description": "The standard list page token. Typically obtained via ListIndexesResponse.next_page_token of the previous IndexService.ListIndexes call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location from which to list the Indexes. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/indexes", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListIndexesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an Index.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.indexes.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The resource name of the Index.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Index" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "removeDatapoints": { + "description": "Remove Datapoints from an Index.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:removeDatapoints", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.indexes.removeDatapoints", + "parameterOrder": [ + "index" + ], + "parameters": { + "index": { + "description": "Required. The name of the Index resource to be updated. Format: `projects/{project}/locations/{location}/indexes/{index}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+index}:removeDatapoints", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1RemoveDatapointsRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1RemoveDatapointsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "upsertDatapoints": { + "description": "Add/update Datapoints into an Index.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:upsertDatapoints", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.indexes.upsertDatapoints", + "parameterOrder": [ + "index" + ], + "parameters": { + "index": { + "description": "Required. The name of the Index resource to be updated. Format: `projects/{project}/locations/{location}/indexes/{index}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+index}:upsertDatapoints", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1UpsertDatapointsRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1UpsertDatapointsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.indexes.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.indexes.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.indexes.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.indexes.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.indexes.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "metadataStores": { + "methods": { + "create": { + "description": "Initializes a MetadataStore, including allocation of resources.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.metadataStores.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "metadataStoreId": { + "description": "The {metadatastore} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all MetadataStores in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataStore.)", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the Location to list FeatureOnlineStores. Format: `projects/{project}/locations/{location}`", + "description": "Required. The resource name of the Location where the MetadataStore should be created. Format: `projects/{project}/locations/{location}/`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/featureOnlineStores", + "path": "v1beta1/{+parent}/metadataStores", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1MetadataStore" + }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListFeatureOnlineStoresResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "patch": { - "description": "Updates the parameters of a single FeatureOnlineStore.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.featureOnlineStores.patch", + "delete": { + "description": "Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts).", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.metadataStores.delete", "parameterOrder": [ "name" ], "parameters": { + "force": { + "deprecated": true, + "description": "Deprecated: Field is no longer supported.", + "location": "query", + "type": "boolean" + }, "name": { - "description": "Identifier. Name of the FeatureOnlineStore. Format: `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}`", + "description": "Required. The resource name of the MetadataStore to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", "required": true, "type": "string" - }, - "updateMask": { - "description": "Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `bigtable` * `bigtable.auto_scaling` * `bigtable.enable_multi_region_replica`", - "format": "google-fieldmask", - "location": "query", - "type": "string" } }, "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1FeatureOnlineStore" - }, "response": { "$ref": "GoogleLongrunningOperation" }, @@ -9378,60 +19882,62 @@ "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": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:setIamPolicy", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureOnlineStores.setIamPolicy", + "get": { + "description": "Retrieves a specific MetadataStore.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.metadataStores.get", "parameterOrder": [ - "resource" + "name" ], "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "name": { + "description": "Required. The resource name of the MetadataStore to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+resource}:setIamPolicy", - "request": { - "$ref": "GoogleIamV1SetIamPolicyRequest" - }, + "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleIamV1Policy" + "$ref": "GoogleCloudAiplatformV1beta1MetadataStore" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:testIamPermissions", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureOnlineStores.testIamPermissions", + "list": { + "description": "Lists MetadataStores for a Location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.metadataStores.list", "parameterOrder": [ - "resource" + "parent" ], "parameters": { - "permissions": { - "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", + "pageSize": { + "description": "The maximum number of Metadata Stores to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous MetadataService.ListMetadataStores call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.)", "location": "query", - "repeated": true, "type": "string" }, - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "parent": { + "description": "Required. The Location whose MetadataStores should be listed. Format: `projects/{project}/locations/{location}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+resource}:testIamPermissions", + "path": "v1beta1/{+parent}/metadataStores", "response": { - "$ref": "GoogleIamV1TestIamPermissionsResponse" + "$ref": "GoogleCloudAiplatformV1beta1ListMetadataStoresResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -9439,59 +19945,59 @@ } }, "resources": { - "featureViews": { + "artifacts": { "methods": { "create": { - "description": "Creates a new FeatureView in a given FeatureOnlineStore.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews", + "description": "Creates an Artifact associated with a MetadataStore.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.create", + "id": "aiplatform.projects.locations.metadataStores.artifacts.create", "parameterOrder": [ "parent" ], "parameters": { - "featureViewId": { - "description": "Required. The ID to use for the FeatureView, which will become the final component of the FeatureView's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a FeatureOnlineStore.", + "artifactId": { + "description": "The {artifact} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` If not provided, the Artifact's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Artifacts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Artifact.)", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the FeatureOnlineStore to create FeatureViews. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`", + "description": "Required. The resource name of the MetadataStore where the Artifact should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", "required": true, "type": "string" - }, - "runSyncImmediately": { - "description": "Immutable. If set to true, one on demand sync will be run immediately, regardless whether the FeatureView.sync_config is configured or not.", - "location": "query", - "type": "boolean" } }, - "path": "v1beta1/{+parent}/featureViews", + "path": "v1beta1/{+parent}/artifacts", "request": { - "$ref": "GoogleCloudAiplatformV1beta1FeatureView" + "$ref": "GoogleCloudAiplatformV1beta1Artifact" }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1beta1Artifact" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { - "description": "Deletes a single FeatureView.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}", + "description": "Deletes an Artifact.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.delete", + "id": "aiplatform.projects.locations.metadataStores.artifacts.delete", "parameterOrder": [ "name" ], "parameters": { + "etag": { + "description": "Optional. The etag of the Artifact to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION.", + "location": "query", + "type": "string" + }, "name": { - "description": "Required. The name of the FeatureView to be deleted. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", + "description": "Required. The resource name of the Artifact to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$", "required": true, "type": "string" } @@ -9504,210 +20010,100 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "directWrite": { - "description": "Bidirectional streaming RPC to directly write to feature values in a feature view. Requests may not have a one-to-one mapping to responses and responses may be returned out-of-order to reduce latency.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:directWrite", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.directWrite", - "parameterOrder": [ - "featureView" - ], - "parameters": { - "featureView": { - "description": "FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+featureView}:directWrite", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "fetchFeatureValues": { - "description": "Fetch feature values under a FeatureView.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:fetchFeatureValues", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.fetchFeatureValues", - "parameterOrder": [ - "featureView" - ], - "parameters": { - "featureView": { - "description": "Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+featureView}:fetchFeatureValues", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1FetchFeatureValuesRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1FetchFeatureValuesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "generateFetchAccessToken": { - "description": "RPC to generate an access token for the given feature view. FeatureViews under the same FeatureOnlineStore share the same access token.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:generateFetchAccessToken", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.generateFetchAccessToken", - "parameterOrder": [ - "featureView" - ], - "parameters": { - "featureView": { - "description": "FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+featureView}:generateFetchAccessToken", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1GenerateFetchAccessTokenRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1GenerateFetchAccessTokenResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "get": { - "description": "Gets details of a single FeatureView.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}", + "description": "Retrieves a specific Artifact.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.get", + "id": "aiplatform.projects.locations.metadataStores.artifacts.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the FeatureView resource. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", + "description": "Required. The resource name of the Artifact to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1FeatureView" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:getIamPolicy", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.getIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "options.requestedPolicyVersion": { - "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", - "format": "int32", - "location": "query", - "type": "integer" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:getIamPolicy", - "response": { - "$ref": "GoogleIamV1Policy" + "$ref": "GoogleCloudAiplatformV1beta1Artifact" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists FeatureViews in a given FeatureOnlineStore.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews", + "description": "Lists Artifacts in the MetadataStore.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts", "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.list", + "id": "aiplatform.projects.locations.metadataStores.artifacts.list", "parameterOrder": [ "parent" ], "parameters": { "filter": { - "description": "Lists the FeatureViews that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> FeatureViews created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> FeatureViews having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any FeatureView which has a label with 'env' as the key.", + "description": "Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = \"test\"`. Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = \"2020-11-19T11:30:00-04:00\"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata.\"field:1\".number_value = 10.0` * **Context based filtering**: To filter Artifacts based on the contexts to which they belong, use the function operator with the full resource name `in_context()`. For example: `in_context(\"projects//locations//metadataStores//contexts/\")` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = \"test\" AND metadata.field1.bool_value = true`.", "location": "query", "type": "string" }, "orderBy": { - "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `feature_view_id` * `create_time` * `update_time`", + "description": "How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a \" desc\" suffix; for example: \"foo desc, bar\". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.", "location": "query", "type": "string" }, "pageSize": { - "description": "The maximum number of FeatureViews to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViews will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.", + "description": "The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViews call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViews must match the call that provided the page token.", + "description": "A page token, received from a previous MetadataService.ListArtifacts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.)", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the FeatureOnlineStore to list FeatureViews. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`", + "description": "Required. The MetadataStore whose Artifacts should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/featureViews", + "path": "v1beta1/{+parent}/artifacts", "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListFeatureViewsResponse" + "$ref": "GoogleCloudAiplatformV1beta1ListArtifactsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { - "description": "Updates the parameters of a single FeatureView.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}", + "description": "Updates a stored Artifact.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}", "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.patch", + "id": "aiplatform.projects.locations.metadataStores.artifacts.patch", "parameterOrder": [ "name" ], "parameters": { + "allowMissing": { + "description": "If set to true, and the Artifact is not found, a new Artifact is created.", + "location": "query", + "type": "boolean" + }, "name": { - "description": "Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", + "description": "Output only. The resource name of the Artifact.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$", "required": true, "type": "string" }, "updateMask": { - "description": "Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `service_agent_type` * `big_query_source` * `big_query_source.uri` * `big_query_source.entity_id_columns` * `feature_registry_source` * `feature_registry_source.feature_groups` * `sync_config` * `sync_config.cron` * `optimized_config.automatic_resources`", + "description": "Optional. A FieldMask indicating which fields should be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -9715,153 +20111,74 @@ }, "path": "v1beta1/{+name}", "request": { - "$ref": "GoogleCloudAiplatformV1beta1FeatureView" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "searchNearestEntities": { - "description": "Search the nearest entities under a FeatureView. Search only works for indexable feature view; if a feature view isn't indexable, returns Invalid argument response.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:searchNearestEntities", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.searchNearestEntities", - "parameterOrder": [ - "featureView" - ], - "parameters": { - "featureView": { - "description": "Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+featureView}:searchNearestEntities", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1SearchNearestEntitiesRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1SearchNearestEntitiesResponse" - }, - "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": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:setIamPolicy", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.setIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:setIamPolicy", - "request": { - "$ref": "GoogleIamV1SetIamPolicyRequest" + "$ref": "GoogleCloudAiplatformV1beta1Artifact" }, "response": { - "$ref": "GoogleIamV1Policy" + "$ref": "GoogleCloudAiplatformV1beta1Artifact" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "streamingFetchFeatureValues": { - "description": "Bidirectional streaming RPC to fetch feature values under a FeatureView. Requests may not have a one-to-one mapping to responses and responses may be returned out-of-order to reduce latency.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:streamingFetchFeatureValues", + "purge": { + "description": "Purges Artifacts.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts:purge", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.streamingFetchFeatureValues", + "id": "aiplatform.projects.locations.metadataStores.artifacts.purge", "parameterOrder": [ - "featureView" + "parent" ], "parameters": { - "featureView": { - "description": "Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`", + "parent": { + "description": "Required. The metadata store to purge Artifacts from. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+featureView}:streamingFetchFeatureValues", + "path": "v1beta1/{+parent}/artifacts:purge", "request": { - "$ref": "GoogleCloudAiplatformV1beta1StreamingFetchFeatureValuesRequest" + "$ref": "GoogleCloudAiplatformV1beta1PurgeArtifactsRequest" }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1StreamingFetchFeatureValuesResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "sync": { - "description": "Triggers on-demand sync for the FeatureView.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:sync", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.sync", + "queryArtifactLineageSubgraph": { + "description": "Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}:queryArtifactLineageSubgraph", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.metadataStores.artifacts.queryArtifactLineageSubgraph", "parameterOrder": [ - "featureView" + "artifact" ], "parameters": { - "featureView": { - "description": "Required. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", + "artifact": { + "description": "Required. The resource name of the Artifact whose Lineage needs to be retrieved as a LineageSubgraph. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$", "required": true, "type": "string" - } - }, - "path": "v1beta1/{+featureView}:sync", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1SyncFeatureViewRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1SyncFeatureViewResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:testIamPermissions", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.testIamPermissions", - "parameterOrder": [ - "resource" - ], - "parameters": { - "permissions": { - "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", + }, + "filter": { + "description": "Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the Lineage Subgraph. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = \"test\"` Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = \"2020-11-19T11:30:00-04:00\"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata.\"field:1\".number_value = 10.0` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = \"test\" AND metadata.field1.bool_value = true`.", "location": "query", - "repeated": true, "type": "string" }, - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", - "required": true, - "type": "string" + "maxHops": { + "description": "Specifies the size of the lineage graph in terms of number of hops from the specified artifact. Negative Value: INVALID_ARGUMENT error is returned 0: Only input artifact is returned. No value: Transitive closure is performed to return the complete graph.", + "format": "int32", + "location": "query", + "type": "integer" } }, - "path": "v1beta1/{+resource}:testIamPermissions", + "path": "v1beta1/{+artifact}:queryArtifactLineageSubgraph", "response": { - "$ref": "GoogleIamV1TestIamPermissionsResponse" + "$ref": "GoogleCloudAiplatformV1beta1LineageSubgraph" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -9869,88 +20186,38 @@ } }, "resources": { - "featureViewSyncs": { + "operations": { "methods": { - "get": { - "description": "Gets details of a single FeatureViewSync.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs/{featureViewSyncsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.get", + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.metadataStores.artifacts.operations.cancel", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the FeatureViewSync resource. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/featureViewSyncs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1FeatureViewSync" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists FeatureViewSyncs in a given FeatureView.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Lists the FeatureViewSyncs that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. Examples: * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> FeatureViewSyncs created after 2020-01-31T15:30:00.000000Z.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `create_time`", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of FeatureViewSyncs to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViewSyncs will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViewSyncs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViewSyncs must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the FeatureView to list FeatureViewSyncs. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", + "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/featureViewSyncs", + "path": "v1beta1/{+name}:cancel", "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListFeatureViewSyncsResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - } - } - }, - "operations": { - "methods": { + }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.delete", + "id": "aiplatform.projects.locations.metadataStores.artifacts.operations.delete", "parameterOrder": [ "name" ], @@ -9958,7 +20225,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -9973,9 +20240,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.get", + "id": "aiplatform.projects.locations.metadataStores.artifacts.operations.get", "parameterOrder": [ "name" ], @@ -9983,7 +20250,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -9998,9 +20265,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.list", + "id": "aiplatform.projects.locations.metadataStores.artifacts.operations.list", "parameterOrder": [ "name" ], @@ -10013,7 +20280,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$", "required": true, "type": "string" }, @@ -10044,9 +20311,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}:wait", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.wait", + "id": "aiplatform.projects.locations.metadataStores.artifacts.operations.wait", "parameterOrder": [ "name" ], @@ -10054,7 +20321,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -10077,583 +20344,262 @@ } } }, - "operations": { + "contexts": { "methods": { - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.featureOnlineStores.operations.delete", + "addContextArtifactsAndExecutions": { + "description": "Adds a set of Artifacts and Executions to a Context. If any of the Artifacts or Executions have already been added to a Context, they are simply skipped.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:addContextArtifactsAndExecutions", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.metadataStores.contexts.addContextArtifactsAndExecutions", "parameterOrder": [ - "name" + "context" ], "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", + "context": { + "description": "Required. The resource name of the Context that the Artifacts and Executions belong to. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+name}", + "path": "v1beta1/{+context}:addContextArtifactsAndExecutions", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1AddContextArtifactsAndExecutionsRequest" + }, "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleCloudAiplatformV1beta1AddContextArtifactsAndExecutionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureOnlineStores.operations.get", + "addContextChildren": { + "description": "Adds a set of Contexts as children to a parent Context. If any of the child Contexts have already been added to the parent Context, they are simply skipped. If this call would create a cycle or cause any Context to have more than 10 parents, the request will fail with an INVALID_ARGUMENT error.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:addContextChildren", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.metadataStores.contexts.addContextChildren", "parameterOrder": [ - "name" + "context" ], "parameters": { - "name": { - "description": "The name of the operation resource.", + "context": { + "description": "Required. The resource name of the parent Context. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+name}", + "path": "v1beta1/{+context}:addContextChildren", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1AddContextChildrenRequest" + }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1beta1AddContextChildrenResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureOnlineStores.operations.list", + "create": { + "description": "Creates a Context associated with a MetadataStore.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.metadataStores.contexts.create", "parameterOrder": [ - "name" + "parent" ], "parameters": { - "filter": { - "description": "The standard list filter.", + "contextId": { + "description": "The {context} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`. If not provided, the Context's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Contexts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Context.)", "location": "query", "type": "string" }, - "name": { - "description": "The name of the operation's parent resource.", + "parent": { + "description": "Required. The resource name of the MetadataStore where the Context should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", "required": true, "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" } }, - "path": "v1beta1/{+name}/operations", + "path": "v1beta1/{+parent}/contexts", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Context" + }, "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleCloudAiplatformV1beta1Context" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureOnlineStores.operations.wait", + "delete": { + "description": "Deletes a stored Context.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.metadataStores.contexts.delete", "parameterOrder": [ "name" ], "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$", - "required": true, + "etag": { + "description": "Optional. The etag of the Context to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION.", + "location": "query", "type": "string" }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", + "force": { + "description": "The force deletion semantics is still undefined. Users should not use this field.", "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The resource name of the Context to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$", + "required": true, "type": "string" } }, - "path": "v1beta1/{+name}:wait", + "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - }, - "featurestores": { - "methods": { - "batchReadFeatureValues": { - "description": "Batch reads Feature values from a Featurestore. This API enables batch reading Feature values, where each read instance in the batch may read Feature values of entities from one or more EntityTypes. Point-in-time correctness is guaranteed for Feature values of each read instance as of each instance's read timestamp.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:batchReadFeatureValues", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.batchReadFeatureValues", - "parameterOrder": [ - "featurestore" - ], - "parameters": { - "featurestore": { - "description": "Required. The resource name of the Featurestore from which to query Feature values. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+featurestore}:batchReadFeatureValues", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1BatchReadFeatureValuesRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "create": { - "description": "Creates a new Featurestore in a given project and location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "featurestoreId": { - "description": "Required. The ID to use for this Featurestore, which will become the final component of the Featurestore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Location to create Featurestores. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/featurestores", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1Featurestore" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or `force` must be set to true for the request to succeed.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.featurestores.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "force": { - "description": "If set to true, any EntityTypes and Features for this Featurestore will also be deleted. (Otherwise, the request will only work if the Featurestore has no EntityTypes.)", - "location": "query", - "type": "boolean" - }, - "name": { - "description": "Required. The name of the Featurestore to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets details of a single Featurestore.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featurestores.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the Featurestore resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1Featurestore" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:getIamPolicy", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.getIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:getIamPolicy", - "request": { - "$ref": "GoogleIamV1GetIamPolicyRequest" - }, - "response": { - "$ref": "GoogleIamV1Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists Featurestores in a given project and location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featurestores.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Lists the featurestores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `online_serving_config.fixed_node_count`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > \"2020-01-01\" OR update_time > \"2020-01-01\"` Featurestores created or updated after 2020-01-01. * `labels.env = \"prod\"` Featurestores with label \"env\" set to \"prod\".", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported Fields: * `create_time` * `update_time` * `online_serving_config.fixed_node_count`", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of Featurestores to return. The service may return fewer than this value. If unspecified, at most 100 Featurestores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous FeaturestoreService.ListFeaturestores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeaturestores must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Location to list Featurestores. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+parent}/featurestores", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListFeaturestoresResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "patch": { - "description": "Updates the parameters of a single Featurestore.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.featurestores.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Output only. Name of the Featurestore. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Field mask is used to specify the fields to be overwritten in the Featurestore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `online_serving_config.fixed_node_count` * `online_serving_config.scaling` * `online_storage_ttl_days`", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1Featurestore" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "searchFeatures": { - "description": "Searches Features matching a query in a given project.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores:searchFeatures", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featurestores.searchFeatures", - "parameterOrder": [ - "location" - ], - "parameters": { - "location": { - "description": "Required. The resource name of the Location to search Features. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 100 Features will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous FeaturestoreService.SearchFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.SearchFeatures, except `page_size`, must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "query": { - "description": "Query string that is a conjunction of field-restricted queries and/or field-restricted filters. Field-restricted queries and filters can be combined using `AND` to form a conjunction. A field query is in the form FIELD:QUERY. This implicitly checks if QUERY exists as a substring within Feature's FIELD. The QUERY and the FIELD are converted to a sequence of words (i.e. tokens) for comparison. This is done by: * Removing leading/trailing whitespace and tokenizing the search value. Characters that are not one of alphanumeric `[a-zA-Z0-9]`, underscore `_`, or asterisk `*` are treated as delimiters for tokens. `*` is treated as a wildcard that matches characters within a token. * Ignoring case. * Prepending an asterisk to the first and appending an asterisk to the last token in QUERY. A QUERY must be either a singular token or a phrase. A phrase is one or multiple words enclosed in double quotation marks (\"). With phrases, the order of the words is important. Words in the phrase must be matching in order and consecutively. Supported FIELDs for field-restricted queries: * `feature_id` * `description` * `entity_type_id` Examples: * `feature_id: foo` --> Matches a Feature with ID containing the substring `foo` (eg. `foo`, `foofeature`, `barfoo`). * `feature_id: foo*feature` --> Matches a Feature with ID containing the substring `foo*feature` (eg. `foobarfeature`). * `feature_id: foo AND description: bar` --> Matches a Feature with ID containing the substring `foo` and description containing the substring `bar`. Besides field queries, the following exact-match filters are supported. The exact-match filters do not support wildcards. Unlike field-restricted queries, exact-match filters are case-sensitive. * `feature_id`: Supports = comparisons. * `description`: Supports = comparisons. Multi-token filters should be enclosed in quotes. * `entity_type_id`: Supports = comparisons. * `value_type`: Supports = and != comparisons. * `labels`: Supports key-value equality as well as key presence. * `featurestore_id`: Supports = comparisons. Examples: * `description = \"foo bar\"` --> Any Feature with description exactly equal to `foo bar` * `value_type = DOUBLE` --> Features whose type is DOUBLE. * `labels.active = yes AND labels.env = prod` --> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any Feature which has a label with `env` as the key.", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+location}/featurestores:searchFeatures", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1SearchFeaturesResponse" - }, - "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": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:setIamPolicy", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.setIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:setIamPolicy", - "request": { - "$ref": "GoogleIamV1SetIamPolicyRequest" - }, - "response": { - "$ref": "GoogleIamV1Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:testIamPermissions", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.testIamPermissions", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:testIamPermissions", - "request": { - "$ref": "GoogleIamV1TestIamPermissionsRequest" - }, - "response": { - "$ref": "GoogleIamV1TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "entityTypes": { - "methods": { - "create": { - "description": "Creates a new EntityType in a given Featurestore.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.entityTypes.create", + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Retrieves a specific Context.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.metadataStores.contexts.get", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "entityTypeId": { - "description": "Required. The ID to use for the EntityType, which will become the final component of the EntityType's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a featurestore.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Featurestore to create EntityTypes. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`", + "name": { + "description": "Required. The resource name of the Context to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/entityTypes", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1EntityType" - }, + "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1beta1Context" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "delete": { - "description": "Deletes a single EntityType. The EntityType must not have any Features or `force` must be set to true for the request to succeed.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.featurestores.entityTypes.delete", + "list": { + "description": "Lists Contexts on the MetadataStore.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.metadataStores.contexts.list", "parameterOrder": [ - "name" + "parent" ], "parameters": { - "force": { - "description": "If set to true, any Features for this EntityType will also be deleted. (Otherwise, the request will only work if the EntityType has no Features.)", + "filter": { + "description": "Filter specifying the boolean condition for the Contexts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = \"test\"`. Supported fields include: `name`, `display_name`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = \"2020-11-19T11:30:00-04:00\"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0`. In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata.\"field:1\".number_value = 10.0` * **Parent Child filtering**: To filter Contexts based on parent-child relationship use the HAS operator as follows: ``` parent_contexts: \"projects//locations//metadataStores//contexts/\" child_contexts: \"projects//locations//metadataStores//contexts/\" ``` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = \"test\" AND metadata.field1.bool_value = true`.", "location": "query", - "type": "boolean" + "type": "string" }, - "name": { - "description": "Required. The name of the EntityType to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`", + "orderBy": { + "description": "How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a \" desc\" suffix; for example: \"foo desc, bar\". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of Contexts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous MetadataService.ListContexts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.)", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The MetadataStore whose Contexts should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+name}", + "path": "v1beta1/{+parent}/contexts", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1beta1ListContextsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "deleteFeatureValues": { - "description": "Delete Feature values from Featurestore. The progress of the deletion is tracked by the returned operation. The deleted feature values are guaranteed to be invisible to subsequent read operations after the operation is marked as successfully done. If a delete feature values operation fails, the feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same delete request again and wait till the new operation returned is marked as successfully done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:deleteFeatureValues", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.entityTypes.deleteFeatureValues", + "patch": { + "description": "Updates a stored Context.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.metadataStores.contexts.patch", "parameterOrder": [ - "entityType" + "name" ], "parameters": { - "entityType": { - "description": "Required. The resource name of the EntityType grouping the Features for which values are being deleted from. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`", + "allowMissing": { + "description": "If set to true, and the Context is not found, a new Context is created.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Immutable. The resource name of the Context.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$", "required": true, "type": "string" + }, + "updateMask": { + "description": "Optional. A FieldMask indicating which fields should be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, - "path": "v1beta1/{+entityType}:deleteFeatureValues", + "path": "v1beta1/{+name}", "request": { - "$ref": "GoogleCloudAiplatformV1beta1DeleteFeatureValuesRequest" + "$ref": "GoogleCloudAiplatformV1beta1Context" }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1beta1Context" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "exportFeatureValues": { - "description": "Exports Feature values from all the entities of a target EntityType.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:exportFeatureValues", + "purge": { + "description": "Purges Contexts.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts:purge", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.entityTypes.exportFeatureValues", + "id": "aiplatform.projects.locations.metadataStores.contexts.purge", "parameterOrder": [ - "entityType" + "parent" ], "parameters": { - "entityType": { - "description": "Required. The resource name of the EntityType from which to export Feature values. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`", + "parent": { + "description": "Required. The metadata store to purge Contexts from. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+entityType}:exportFeatureValues", + "path": "v1beta1/{+parent}/contexts:purge", "request": { - "$ref": "GoogleCloudAiplatformV1beta1ExportFeatureValuesRequest" + "$ref": "GoogleCloudAiplatformV1beta1PurgeContextsRequest" }, "response": { "$ref": "GoogleLongrunningOperation" @@ -10662,314 +20608,470 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "get": { - "description": "Gets details of a single EntityType.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}", + "queryContextLineageSubgraph": { + "description": "Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:queryContextLineageSubgraph", "httpMethod": "GET", - "id": "aiplatform.projects.locations.featurestores.entityTypes.get", + "id": "aiplatform.projects.locations.metadataStores.contexts.queryContextLineageSubgraph", "parameterOrder": [ - "name" + "context" ], "parameters": { - "name": { - "description": "Required. The name of the EntityType resource. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`", + "context": { + "description": "Required. The resource name of the Context whose Artifacts and Executions should be retrieved as a LineageSubgraph. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}` The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+name}", + "path": "v1beta1/{+context}:queryContextLineageSubgraph", "response": { - "$ref": "GoogleCloudAiplatformV1beta1EntityType" + "$ref": "GoogleCloudAiplatformV1beta1LineageSubgraph" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:getIamPolicy", + "removeContextChildren": { + "description": "Remove a set of children contexts from a parent Context. If any of the child Contexts were NOT added to the parent Context, they are simply skipped.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:removeContextChildren", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.entityTypes.getIamPolicy", + "id": "aiplatform.projects.locations.metadataStores.contexts.removeContextChildren", "parameterOrder": [ - "resource" + "context" ], "parameters": { - "options.requestedPolicyVersion": { - "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", - "format": "int32", - "location": "query", - "type": "integer" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "context": { + "description": "Required. The resource name of the parent Context. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+resource}:getIamPolicy", + "path": "v1beta1/{+context}:removeContextChildren", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1RemoveContextChildrenRequest" + }, "response": { - "$ref": "GoogleIamV1Policy" + "$ref": "GoogleCloudAiplatformV1beta1RemoveContextChildrenResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "importFeatureValues": { - "description": "Imports Feature values into the Featurestore from a source storage. The progress of the import is tracked by the returned operation. The imported features are guaranteed to be visible to subsequent read operations after the operation is marked as successfully done. If an import operation fails, the Feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same import request again and wait till the new operation returned is marked as successfully done. There are also scenarios where the caller can cause inconsistency. - Source data for import contains multiple distinct Feature values for the same entity ID and timestamp. - Source is modified during an import. This includes adding, updating, or removing source data and/or metadata. Examples of updating metadata include but are not limited to changing storage location, storage class, or retention policy. - Online serving cluster is under-provisioned.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:importFeatureValues", + } + }, + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.metadataStores.contexts.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.metadataStores.contexts.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.metadataStores.contexts.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.metadataStores.contexts.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.metadataStores.contexts.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "executions": { + "methods": { + "addExecutionEvents": { + "description": "Adds Events to the specified Execution. An Event indicates whether an Artifact was used as an input or output for an Execution. If an Event already exists between the Execution and the Artifact, the Event is skipped.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:addExecutionEvents", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.entityTypes.importFeatureValues", + "id": "aiplatform.projects.locations.metadataStores.executions.addExecutionEvents", "parameterOrder": [ - "entityType" + "execution" ], "parameters": { - "entityType": { - "description": "Required. The resource name of the EntityType grouping the Features for which values are being imported. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`", + "execution": { + "description": "Required. The resource name of the Execution that the Events connect Artifacts with. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+entityType}:importFeatureValues", + "path": "v1beta1/{+execution}:addExecutionEvents", "request": { - "$ref": "GoogleCloudAiplatformV1beta1ImportFeatureValuesRequest" + "$ref": "GoogleCloudAiplatformV1beta1AddExecutionEventsRequest" }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1beta1AddExecutionEventsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "list": { - "description": "Lists EntityTypes in a given Featurestore.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featurestores.entityTypes.list", + "create": { + "description": "Creates an Execution associated with a MetadataStore.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.metadataStores.executions.create", "parameterOrder": [ "parent" ], "parameters": { - "filter": { - "description": "Lists the EntityTypes that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> EntityTypes having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any EntityType which has a label with 'env' as the key.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `entity_type_id` * `create_time` * `update_time`", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of EntityTypes to return. The service may return fewer than this value. If unspecified, at most 1000 EntityTypes will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous FeaturestoreService.ListEntityTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListEntityTypes must match the call that provided the page token.", + "executionId": { + "description": "The {execution} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` If not provided, the Execution's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Executions in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Execution.)", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the Featurestore to list EntityTypes. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`", + "description": "Required. The resource name of the MetadataStore where the Execution should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", "required": true, "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" } }, - "path": "v1beta1/{+parent}/entityTypes", + "path": "v1beta1/{+parent}/executions", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Execution" + }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListEntityTypesResponse" + "$ref": "GoogleCloudAiplatformV1beta1Execution" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "patch": { - "description": "Updates the parameters of a single EntityType.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.featurestores.entityTypes.patch", + "delete": { + "description": "Deletes an Execution.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.metadataStores.executions.delete", "parameterOrder": [ "name" ], "parameters": { + "etag": { + "description": "Optional. The etag of the Execution to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION.", + "location": "query", + "type": "string" + }, "name": { - "description": "Immutable. Name of the EntityType. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` The last part entity_type is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore.", + "description": "Required. The resource name of the Execution to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$", "required": true, "type": "string" - }, - "updateMask": { - "description": "Field mask is used to specify the fields to be overwritten in the EntityType resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `monitoring_config.snapshot_analysis.disabled` * `monitoring_config.snapshot_analysis.monitoring_interval_days` * `monitoring_config.snapshot_analysis.staleness_days` * `monitoring_config.import_features_analysis.state` * `monitoring_config.import_features_analysis.anomaly_detection_baseline` * `monitoring_config.numerical_threshold_config.value` * `monitoring_config.categorical_threshold_config.value` * `offline_storage_ttl_days`", - "format": "google-fieldmask", - "location": "query", - "type": "string" } }, "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1EntityType" - }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1EntityType" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "readFeatureValues": { - "description": "Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:readFeatureValues", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.entityTypes.readFeatureValues", + "get": { + "description": "Retrieves a specific Execution.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.metadataStores.executions.get", "parameterOrder": [ - "entityType" + "name" ], "parameters": { - "entityType": { - "description": "Required. The resource name of the EntityType for the entity being read. Value format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`.", + "name": { + "description": "Required. The resource name of the Execution to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+entityType}:readFeatureValues", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1ReadFeatureValuesRequest" - }, + "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1ReadFeatureValuesResponse" + "$ref": "GoogleCloudAiplatformV1beta1Execution" }, "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": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:setIamPolicy", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.entityTypes.setIamPolicy", + "list": { + "description": "Lists Executions in the MetadataStore.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.metadataStores.executions.list", "parameterOrder": [ - "resource" + "parent" ], "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "filter": { + "description": "Filter specifying the boolean condition for the Executions to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = \"test\"`. Supported fields include: `name`, `display_name`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = \"2020-11-19T11:30:00-04:00\"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..` For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata.\"field:1\".number_value = 10.0` * **Context based filtering**: To filter Executions based on the contexts to which they belong use the function operator with the full resource name: `in_context()`. For example: `in_context(\"projects//locations//metadataStores//contexts/\")` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = \"test\" AND metadata.field1.bool_value = true`.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a \" desc\" suffix; for example: \"foo desc, bar\". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of Executions to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous MetadataService.ListExecutions call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with an INVALID_ARGUMENT error.)", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The MetadataStore whose Executions should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:setIamPolicy", - "request": { - "$ref": "GoogleIamV1SetIamPolicyRequest" + "type": "string" + } }, + "path": "v1beta1/{+parent}/executions", "response": { - "$ref": "GoogleIamV1Policy" + "$ref": "GoogleCloudAiplatformV1beta1ListExecutionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "streamingReadFeatureValues": { - "description": "Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:streamingReadFeatureValues", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.entityTypes.streamingReadFeatureValues", + "patch": { + "description": "Updates a stored Execution.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.metadataStores.executions.patch", "parameterOrder": [ - "entityType" + "name" ], "parameters": { - "entityType": { - "description": "Required. The resource name of the entities' type. Value format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`.", + "allowMissing": { + "description": "If set to true, and the Execution is not found, a new Execution is created.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Output only. The resource name of the Execution.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$", "required": true, "type": "string" + }, + "updateMask": { + "description": "Optional. A FieldMask indicating which fields should be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, - "path": "v1beta1/{+entityType}:streamingReadFeatureValues", + "path": "v1beta1/{+name}", "request": { - "$ref": "GoogleCloudAiplatformV1beta1StreamingReadFeatureValuesRequest" + "$ref": "GoogleCloudAiplatformV1beta1Execution" }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1ReadFeatureValuesResponse" + "$ref": "GoogleCloudAiplatformV1beta1Execution" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:testIamPermissions", + "purge": { + "description": "Purges Executions.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions:purge", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.entityTypes.testIamPermissions", + "id": "aiplatform.projects.locations.metadataStores.executions.purge", "parameterOrder": [ - "resource" + "parent" ], "parameters": { - "permissions": { - "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", - "location": "query", - "repeated": true, - "type": "string" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "parent": { + "description": "Required. The metadata store to purge Executions from. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+resource}:testIamPermissions", + "path": "v1beta1/{+parent}/executions:purge", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1PurgeExecutionsRequest" + }, "response": { - "$ref": "GoogleIamV1TestIamPermissionsResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "writeFeatureValues": { - "description": "Writes Feature values of one or more entities of an EntityType. The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:writeFeatureValues", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.entityTypes.writeFeatureValues", + "queryExecutionInputsAndOutputs": { + "description": "Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:queryExecutionInputsAndOutputs", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.metadataStores.executions.queryExecutionInputsAndOutputs", "parameterOrder": [ - "entityType" + "execution" ], "parameters": { - "entityType": { - "description": "Required. The resource name of the EntityType for the entities being written. Value format: `projects/{project}/locations/{location}/featurestores/ {featurestore}/entityTypes/{entityType}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`.", + "execution": { + "description": "Required. The resource name of the Execution whose input and output Artifacts should be retrieved as a LineageSubgraph. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+entityType}:writeFeatureValues", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1WriteFeatureValuesRequest" - }, + "path": "v1beta1/{+execution}:queryExecutionInputsAndOutputs", "response": { - "$ref": "GoogleCloudAiplatformV1beta1WriteFeatureValuesResponse" + "$ref": "GoogleCloudAiplatformV1beta1LineageSubgraph" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -10977,396 +21079,13 @@ } }, "resources": { - "features": { - "methods": { - "batchCreate": { - "description": "Creates a batch of Features in a given EntityType.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features:batchCreate", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.entityTypes.features.batchCreate", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/features:batchCreate", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1BatchCreateFeaturesRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "create": { - "description": "Creates a new Feature in a given EntityType.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.entityTypes.features.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "featureId": { - "description": "Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/features", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1Feature" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a single Feature.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.featurestores.entityTypes.features.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the Features to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets details of a single Feature.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featurestores.entityTypes.features.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "featureStatsAndAnomalySpec.latestStatsCount": { - "description": "Optional. If set, returns the most recent count of stats. Valid value is [0, 100]. If stats_time_range is set, return most recent count of stats within the stats_time_range.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "featureStatsAndAnomalySpec.statsTimeRange.endTime": { - "description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", - "format": "google-datetime", - "location": "query", - "type": "string" - }, - "featureStatsAndAnomalySpec.statsTimeRange.startTime": { - "description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.", - "format": "google-datetime", - "location": "query", - "type": "string" - }, - "name": { - "description": "Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1Feature" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists Features in a given EntityType.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featurestores.entityTypes.features.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --> Features whose type is DOUBLE. * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any Feature which has a label with 'env' as the key.", - "location": "query", - "type": "string" - }, - "latestStatsCount": { - "description": "Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "orderBy": { - "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time`", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+parent}/features", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListFeaturesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "patch": { - "description": "Updates the parameters of a single Feature.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.featurestores.entityTypes.features.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore)", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1Feature" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1Feature" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - }, "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:cancel", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.entityTypes.operations.cancel", + "id": "aiplatform.projects.locations.metadataStores.executions.operations.cancel", "parameterOrder": [ "name" ], @@ -11374,7 +21093,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -11389,9 +21108,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.featurestores.entityTypes.operations.delete", + "id": "aiplatform.projects.locations.metadataStores.executions.operations.delete", "parameterOrder": [ "name" ], @@ -11399,7 +21118,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -11414,9 +21133,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.featurestores.entityTypes.operations.get", + "id": "aiplatform.projects.locations.metadataStores.executions.operations.get", "parameterOrder": [ "name" ], @@ -11424,7 +21143,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -11439,9 +21158,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.featurestores.entityTypes.operations.list", + "id": "aiplatform.projects.locations.metadataStores.executions.operations.list", "parameterOrder": [ "name" ], @@ -11454,7 +21173,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$", "required": true, "type": "string" }, @@ -11485,9 +21204,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:wait", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.entityTypes.operations.wait", + "id": "aiplatform.projects.locations.metadataStores.executions.operations.wait", "parameterOrder": [ "name" ], @@ -11495,7 +21214,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -11518,328 +21237,116 @@ } } }, - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:cancel", + "metadataSchemas": { + "methods": { + "create": { + "description": "Creates a MetadataSchema.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.operations.cancel", + "id": "aiplatform.projects.locations.metadataStores.metadataSchemas.create", "parameterOrder": [ - "name" + "parent" ], "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$", - "required": true, + "metadataSchemaId": { + "description": "The {metadata_schema} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all MetadataSchemas in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataSchema.)", + "location": "query", "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.featurestores.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", + }, + "parent": { + "description": "Required. The resource name of the MetadataStore where the MetadataSchema should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+name}", + "path": "v1beta1/{+parent}/metadataSchemas", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1MetadataSchema" + }, "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleCloudAiplatformV1beta1MetadataSchema" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}", + "description": "Retrieves a specific MetadataSchema.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas/{metadataSchemasId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.featurestores.operations.get", + "id": "aiplatform.projects.locations.metadataStores.metadataSchemas.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "The name of the operation resource.", + "description": "Required. The resource name of the MetadataSchema to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/metadataSchemas/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1beta1MetadataSchema" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations", + "description": "Lists MetadataSchemas.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas", "httpMethod": "GET", - "id": "aiplatform.projects.locations.featurestores.operations.list", + "id": "aiplatform.projects.locations.metadataStores.metadataSchemas.list", "parameterOrder": [ - "name" + "parent" ], "parameters": { "filter": { - "description": "The standard list filter.", + "description": "A query to filter available MetadataSchemas for matching results.", "location": "query", "type": "string" }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", - "required": true, - "type": "string" - }, "pageSize": { - "description": "The standard list page size.", + "description": "The maximum number of MetadataSchemas to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "The standard list page token.", + "description": "A page token, received from a previous MetadataService.ListMetadataSchemas call. Provide this to retrieve the next page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.)", "location": "query", "type": "string" }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", + "parent": { + "description": "Required. The MetadataStore whose MetadataSchemas should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", "required": true, "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" } }, - "path": "v1beta1/{+name}:wait", + "path": "v1beta1/{+parent}/metadataSchemas", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1beta1ListMetadataSchemasResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } - } - } - }, - "hyperparameterTuningJobs": { - "methods": { - "cancel": { - "description": "Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetHyperparameterTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a HyperparameterTuningJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and HyperparameterTuningJob.state is set to `CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.hyperparameterTuningJobs.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the HyperparameterTuningJob to cancel. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1CancelHyperparameterTuningJobRequest" - }, - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "create": { - "description": "Creates a HyperparameterTuningJob", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.hyperparameterTuningJobs.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the HyperparameterTuningJob in. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/hyperparameterTuningJobs", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1HyperparameterTuningJob" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1HyperparameterTuningJob" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a HyperparameterTuningJob.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.hyperparameterTuningJobs.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the HyperparameterTuningJob resource to be deleted. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets a HyperparameterTuningJob", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.hyperparameterTuningJobs.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the HyperparameterTuningJob resource. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1HyperparameterTuningJob" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] }, - "list": { - "description": "Lists HyperparameterTuningJobs in a Location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.hyperparameterTuningJobs.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token. Typically obtained via ListHyperparameterTuningJobsResponse.next_page_token of the previous JobService.ListHyperparameterTuningJobs call.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Location to list the HyperparameterTuningJobs from. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+parent}/hyperparameterTuningJobs", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListHyperparameterTuningJobsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:cancel", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.cancel", + "id": "aiplatform.projects.locations.metadataStores.operations.cancel", "parameterOrder": [ "name" ], @@ -11847,7 +21354,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -11862,9 +21369,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.delete", + "id": "aiplatform.projects.locations.metadataStores.operations.delete", "parameterOrder": [ "name" ], @@ -11872,7 +21379,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -11887,9 +21394,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.get", + "id": "aiplatform.projects.locations.metadataStores.operations.get", "parameterOrder": [ "name" ], @@ -11897,7 +21404,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -11912,9 +21419,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.list", + "id": "aiplatform.projects.locations.metadataStores.operations.list", "parameterOrder": [ "name" ], @@ -11927,7 +21434,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", "required": true, "type": "string" }, @@ -11951,249 +21458,68 @@ "path": "v1beta1/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - }, - "indexEndpoints": { - "methods": { - "create": { - "description": "Creates an IndexEndpoint.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.indexEndpoints.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the IndexEndpoint in. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/indexEndpoints", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1IndexEndpoint" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes an IndexEndpoint.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.indexEndpoints.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the IndexEndpoint resource to be deleted. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "deployIndex": { - "description": "Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:deployIndex", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.indexEndpoints.deployIndex", - "parameterOrder": [ - "indexEndpoint" - ], - "parameters": { - "indexEndpoint": { - "description": "Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+indexEndpoint}:deployIndex", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1DeployIndexRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "findNeighbors": { - "description": "Finds the nearest neighbors of each vector within the request.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:findNeighbors", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.indexEndpoints.findNeighbors", - "parameterOrder": [ - "indexEndpoint" - ], - "parameters": { - "indexEndpoint": { - "description": "Required. The name of the index endpoint. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+indexEndpoint}:findNeighbors", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1FindNeighborsRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1FindNeighborsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets an IndexEndpoint.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.indexEndpoints.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the IndexEndpoint resource. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1IndexEndpoint" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists IndexEndpoints in a Location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.indexEndpoints.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `index_endpoint` supports = and !=. `index_endpoint` represents the IndexEndpoint ID, ie. the last segment of the IndexEndpoint's resourcename. * `display_name` supports =, != and regex() (uses [re2](https://github.com/google/re2/wiki/Syntax) syntax) * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* or labels:key - key existence A key including a space must be quoted. `labels.\"a key\"`. Some examples: * `index_endpoint=\"1\"` * `display_name=\"myDisplayName\"` * `regex(display_name, \"^A\") -> The display name starts with an A. * `labels.myKey=\"myValue\"`", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The standard list page token. Typically obtained via ListIndexEndpointsResponse.next_page_token of the previous IndexEndpointService.ListIndexEndpoints call.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Location from which to list the IndexEndpoints. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "readMask": { - "description": "Optional. Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.metadataStores.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } - }, - "path": "v1beta1/{+parent}/indexEndpoints", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListIndexEndpointsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "mutateDeployedIndex": { - "description": "Update an existing DeployedIndex under an IndexEndpoint.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:mutateDeployedIndex", + } + } + } + }, + "migratableResources": { + "methods": { + "batchMigrate": { + "description": "Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources:batchMigrate", "httpMethod": "POST", - "id": "aiplatform.projects.locations.indexEndpoints.mutateDeployedIndex", + "id": "aiplatform.projects.locations.migratableResources.batchMigrate", "parameterOrder": [ - "indexEndpoint" + "parent" ], "parameters": { - "indexEndpoint": { - "description": "Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", + "parent": { + "description": "Required. The location of the migrated resource will live in. Format: `projects/{project}/locations/{location}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+indexEndpoint}:mutateDeployedIndex", + "path": "v1beta1/{+parent}/migratableResources:batchMigrate", "request": { - "$ref": "GoogleCloudAiplatformV1beta1DeployedIndex" + "$ref": "GoogleCloudAiplatformV1beta1BatchMigrateResourcesRequest" }, "response": { "$ref": "GoogleLongrunningOperation" @@ -12202,91 +21528,29 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "patch": { - "description": "Updates an IndexEndpoint.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.indexEndpoints.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Output only. The resource name of the IndexEndpoint.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1IndexEndpoint" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1IndexEndpoint" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "readIndexDatapoints": { - "description": "Reads the datapoints/vectors of the given IDs. A maximum of 1000 datapoints can be retrieved in a batch.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:readIndexDatapoints", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.indexEndpoints.readIndexDatapoints", - "parameterOrder": [ - "indexEndpoint" - ], - "parameters": { - "indexEndpoint": { - "description": "Required. The name of the index endpoint. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+indexEndpoint}:readIndexDatapoints", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1ReadIndexDatapointsRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ReadIndexDatapointsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "undeployIndex": { - "description": "Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:undeployIndex", + "search": { + "description": "Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources:search", "httpMethod": "POST", - "id": "aiplatform.projects.locations.indexEndpoints.undeployIndex", + "id": "aiplatform.projects.locations.migratableResources.search", "parameterOrder": [ - "indexEndpoint" + "parent" ], "parameters": { - "indexEndpoint": { - "description": "Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", + "parent": { + "description": "Required. The location that the migratable resources should be searched from. It's the Vertex AI location that the resources can be migrated to, not the resources' original location. Format: `projects/{project}/locations/{location}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+indexEndpoint}:undeployIndex", + "path": "v1beta1/{+parent}/migratableResources:search", "request": { - "$ref": "GoogleCloudAiplatformV1beta1UndeployIndexRequest" + "$ref": "GoogleCloudAiplatformV1beta1SearchMigratableResourcesRequest" }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1beta1SearchMigratableResourcesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -12298,9 +21562,9 @@ "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:cancel", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.indexEndpoints.operations.cancel", + "id": "aiplatform.projects.locations.migratableResources.operations.cancel", "parameterOrder": [ "name" ], @@ -12308,7 +21572,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -12323,9 +21587,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.indexEndpoints.operations.delete", + "id": "aiplatform.projects.locations.migratableResources.operations.delete", "parameterOrder": [ "name" ], @@ -12333,7 +21597,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -12348,9 +21612,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.indexEndpoints.operations.get", + "id": "aiplatform.projects.locations.migratableResources.operations.get", "parameterOrder": [ "name" ], @@ -12358,7 +21622,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -12373,9 +21637,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.indexEndpoints.operations.list", + "id": "aiplatform.projects.locations.migratableResources.operations.list", "parameterOrder": [ "name" ], @@ -12388,7 +21652,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+$", "required": true, "type": "string" }, @@ -12419,9 +21683,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:wait", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.indexEndpoints.operations.wait", + "id": "aiplatform.projects.locations.migratableResources.operations.wait", "parameterOrder": [ "name" ], @@ -12429,7 +21693,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -12452,49 +21716,49 @@ } } }, - "indexes": { + "modelDeploymentMonitoringJobs": { "methods": { "create": { - "description": "Creates an Index.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes", + "description": "Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs", "httpMethod": "POST", - "id": "aiplatform.projects.locations.indexes.create", + "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { - "description": "Required. The resource name of the Location to create the Index in. Format: `projects/{project}/locations/{location}`", + "description": "Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/indexes", + "path": "v1beta1/{+parent}/modelDeploymentMonitoringJobs", "request": { - "$ref": "GoogleCloudAiplatformV1beta1Index" + "$ref": "GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJob" }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJob" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { - "description": "Deletes an Index. An Index can only be deleted when all its DeployedIndexes had been undeployed.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}", + "description": "Deletes a ModelDeploymentMonitoringJob.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.indexes.delete", + "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the Index resource to be deleted. Format: `projects/{project}/locations/{location}/indexes/{index}`", + "description": "Required. The resource name of the model monitoring job to delete. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$", "required": true, "type": "string" } @@ -12508,69 +21772,41 @@ ] }, "get": { - "description": "Gets an Index.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}", + "description": "Gets a ModelDeploymentMonitoringJob.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.indexes.get", + "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the Index resource. Format: `projects/{project}/locations/{location}/indexes/{index}`", + "description": "Required. The resource name of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1Index" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "import": { - "description": "Imports an Index from an external source (e.g., BigQuery).", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:import", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.indexes.import", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the Index resource to import data to. Format: `projects/{project}/locations/{location}/indexes/{index}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:import", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1ImportIndexRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJob" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists Indexes in a Location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes", + "description": "Lists ModelDeploymentMonitoringJobs in a Location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs", "httpMethod": "GET", - "id": "aiplatform.projects.locations.indexes.list", + "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.list", "parameterOrder": [ "parent" ], "parameters": { "filter": { - "description": "The standard list filter.", + "description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`", "location": "query", "type": "string" }, @@ -12581,50 +21817,50 @@ "type": "integer" }, "pageToken": { - "description": "The standard list page token. Typically obtained via ListIndexesResponse.next_page_token of the previous IndexService.ListIndexes call.", + "description": "The standard list page token.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the Location from which to list the Indexes. Format: `projects/{project}/locations/{location}`", + "description": "Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, "readMask": { - "description": "Mask specifying which fields to read.", + "description": "Mask specifying which fields to read", "format": "google-fieldmask", "location": "query", "type": "string" } }, - "path": "v1beta1/{+parent}/indexes", + "path": "v1beta1/{+parent}/modelDeploymentMonitoringJobs", "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListIndexesResponse" + "$ref": "GoogleCloudAiplatformV1beta1ListModelDeploymentMonitoringJobsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { - "description": "Updates an Index.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}", + "description": "Updates a ModelDeploymentMonitoringJob.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}", "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.indexes.patch", + "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.patch", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Output only. The resource name of the Index.", + "description": "Output only. Resource name of a ModelDeploymentMonitoringJob.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$", "required": true, "type": "string" }, "updateMask": { - "description": "The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.", + "description": "Required. The update mask is used to specify the fields to be overwritten in the ModelDeploymentMonitoringJob resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. For the objective config, the user can either provide the update mask for model_deployment_monitoring_objective_configs or any combination of its nested fields, such as: model_deployment_monitoring_objective_configs.objective_config.training_dataset. Updatable fields: * `display_name` * `model_deployment_monitoring_schedule_config` * `model_monitoring_alert_config` * `logging_sampling_strategy` * `labels` * `log_ttl` * `enable_monitoring_pipeline_logs` . and * `model_deployment_monitoring_objective_configs` . or * `model_deployment_monitoring_objective_configs.objective_config.training_dataset` * `model_deployment_monitoring_objective_configs.objective_config.training_prediction_skew_detection_config` * `model_deployment_monitoring_objective_configs.objective_config.prediction_drift_detection_config`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -12632,7 +21868,7 @@ }, "path": "v1beta1/{+name}", "request": { - "$ref": "GoogleCloudAiplatformV1beta1Index" + "$ref": "GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJob" }, "response": { "$ref": "GoogleLongrunningOperation" @@ -12641,57 +21877,85 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "removeDatapoints": { - "description": "Remove Datapoints from an Index.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:removeDatapoints", + "pause": { + "description": "Pauses a ModelDeploymentMonitoringJob. If the job is running, the server makes a best effort to cancel the job. Will mark ModelDeploymentMonitoringJob.state to 'PAUSED'.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:pause", "httpMethod": "POST", - "id": "aiplatform.projects.locations.indexes.removeDatapoints", + "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.pause", "parameterOrder": [ - "index" + "name" ], "parameters": { - "index": { - "description": "Required. The name of the Index resource to be updated. Format: `projects/{project}/locations/{location}/indexes/{index}`", + "name": { + "description": "Required. The resource name of the ModelDeploymentMonitoringJob to pause. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+index}:removeDatapoints", + "path": "v1beta1/{+name}:pause", "request": { - "$ref": "GoogleCloudAiplatformV1beta1RemoveDatapointsRequest" + "$ref": "GoogleCloudAiplatformV1beta1PauseModelDeploymentMonitoringJobRequest" }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1RemoveDatapointsResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "upsertDatapoints": { - "description": "Add/update Datapoints into an Index.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:upsertDatapoints", + "resume": { + "description": "Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:resume", "httpMethod": "POST", - "id": "aiplatform.projects.locations.indexes.upsertDatapoints", + "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.resume", "parameterOrder": [ - "index" + "name" ], "parameters": { - "index": { - "description": "Required. The name of the Index resource to be updated. Format: `projects/{project}/locations/{location}/indexes/{index}`", + "name": { + "description": "Required. The resource name of the ModelDeploymentMonitoringJob to resume. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+index}:upsertDatapoints", + "path": "v1beta1/{+name}:resume", "request": { - "$ref": "GoogleCloudAiplatformV1beta1UpsertDatapointsRequest" + "$ref": "GoogleCloudAiplatformV1beta1ResumeModelDeploymentMonitoringJobRequest" }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1UpsertDatapointsResponse" + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "searchModelDeploymentMonitoringStatsAnomalies": { + "description": "Searches Model Monitoring Statistics generated within a given time window.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:searchModelDeploymentMonitoringStatsAnomalies", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.searchModelDeploymentMonitoringStatsAnomalies", + "parameterOrder": [ + "modelDeploymentMonitoringJob" + ], + "parameters": { + "modelDeploymentMonitoringJob": { + "description": "Required. ModelDeploymentMonitoring Job resource name. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+modelDeploymentMonitoringJob}:searchModelDeploymentMonitoringStatsAnomalies", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1SearchModelDeploymentMonitoringStatsAnomaliesRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1SearchModelDeploymentMonitoringStatsAnomaliesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -12703,9 +21967,9 @@ "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:cancel", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.indexes.operations.cancel", + "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.cancel", "parameterOrder": [ "name" ], @@ -12713,7 +21977,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -12728,9 +21992,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.indexes.operations.delete", + "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.delete", "parameterOrder": [ "name" ], @@ -12738,7 +22002,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -12753,9 +22017,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.indexes.operations.get", + "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.get", "parameterOrder": [ "name" ], @@ -12763,7 +22027,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -12778,9 +22042,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.indexes.operations.list", + "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.list", "parameterOrder": [ "name" ], @@ -12793,7 +22057,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$", "required": true, "type": "string" }, @@ -12824,9 +22088,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:wait", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.indexes.operations.wait", + "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.wait", "parameterOrder": [ "name" ], @@ -12834,7 +22098,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -12857,33 +22121,33 @@ } } }, - "metadataStores": { + "modelMonitors": { "methods": { "create": { - "description": "Initializes a MetadataStore, including allocation of resources.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores", + "description": "Creates a ModelMonitor.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors", "httpMethod": "POST", - "id": "aiplatform.projects.locations.metadataStores.create", + "id": "aiplatform.projects.locations.modelMonitors.create", "parameterOrder": [ "parent" ], "parameters": { - "metadataStoreId": { - "description": "The {metadatastore} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all MetadataStores in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataStore.)", + "modelMonitorId": { + "description": "Optional. The ID to use for the Model Monitor, which will become the final component of the model monitor resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the Location where the MetadataStore should be created. Format: `projects/{project}/locations/{location}/`", + "description": "Required. The resource name of the Location to create the ModelMonitor in. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/metadataStores", + "path": "v1beta1/{+parent}/modelMonitors", "request": { - "$ref": "GoogleCloudAiplatformV1beta1MetadataStore" + "$ref": "GoogleCloudAiplatformV1beta1ModelMonitor" }, "response": { "$ref": "GoogleLongrunningOperation" @@ -12893,29 +22157,134 @@ ] }, "delete": { - "description": "Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts).", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}", + "description": "Deletes a ModelMonitor.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.metadataStores.delete", + "id": "aiplatform.projects.locations.modelMonitors.delete", "parameterOrder": [ "name" ], "parameters": { "force": { - "deprecated": true, - "description": "Deprecated: Field is no longer supported.", + "description": "Optional. Force delete the model monitor with schedules.", "location": "query", "type": "boolean" }, "name": { - "description": "Required. The resource name of the MetadataStore to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", + "description": "Required. The name of the ModelMonitor resource to be deleted. Format: `projects/{project}/locations/{location}/modelMonitords/{model_monitor}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a ModelMonitor.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.modelMonitors.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the ModelMonitor resource. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ModelMonitor" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists ModelMonitors in a Location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.modelMonitors.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list the ModelMonitors from. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/modelMonitors", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListModelMonitorsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a ModelMonitor.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.modelMonitors.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. Resource name of the ModelMonitor. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$", "required": true, "type": "string" + }, + "updateMask": { + "description": "Required. Mask specifying which fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1ModelMonitor" + }, "response": { "$ref": "GoogleLongrunningOperation" }, @@ -12923,62 +22292,57 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "get": { - "description": "Retrieves a specific MetadataStore.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.metadataStores.get", + "searchModelMonitoringAlerts": { + "description": "Returns the Model Monitoring alerts.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}:searchModelMonitoringAlerts", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.modelMonitors.searchModelMonitoringAlerts", "parameterOrder": [ - "name" + "modelMonitor" ], "parameters": { - "name": { - "description": "Required. The resource name of the MetadataStore to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", + "modelMonitor": { + "description": "Required. ModelMonitor resource name. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+name}", + "path": "v1beta1/{+modelMonitor}:searchModelMonitoringAlerts", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1SearchModelMonitoringAlertsRequest" + }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1MetadataStore" + "$ref": "GoogleCloudAiplatformV1beta1SearchModelMonitoringAlertsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "list": { - "description": "Lists MetadataStores for a Location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.metadataStores.list", + "searchModelMonitoringStats": { + "description": "Searches Model Monitoring Stats generated within a given time window.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}:searchModelMonitoringStats", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.modelMonitors.searchModelMonitoringStats", "parameterOrder": [ - "parent" + "modelMonitor" ], "parameters": { - "pageSize": { - "description": "The maximum number of Metadata Stores to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous MetadataService.ListMetadataStores call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.)", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The Location whose MetadataStores should be listed. Format: `projects/{project}/locations/{location}`", + "modelMonitor": { + "description": "Required. ModelMonitor resource name. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/metadataStores", + "path": "v1beta1/{+modelMonitor}:searchModelMonitoringStats", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1SearchModelMonitoringStatsRequest" + }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListMetadataStoresResponse" + "$ref": "GoogleCloudAiplatformV1beta1SearchModelMonitoringStatsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -12986,59 +22350,54 @@ } }, "resources": { - "artifacts": { + "modelMonitoringJobs": { "methods": { "create": { - "description": "Creates an Artifact associated with a MetadataStore.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts", + "description": "Creates a ModelMonitoringJob.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/modelMonitoringJobs", "httpMethod": "POST", - "id": "aiplatform.projects.locations.metadataStores.artifacts.create", + "id": "aiplatform.projects.locations.modelMonitors.modelMonitoringJobs.create", "parameterOrder": [ "parent" ], "parameters": { - "artifactId": { - "description": "The {artifact} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` If not provided, the Artifact's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Artifacts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Artifact.)", + "modelMonitoringJobId": { + "description": "Optional. The ID to use for the Model Monitoring Job, which will become the final component of the model monitoring job resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the MetadataStore where the Artifact should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", + "description": "Required. The parent of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMoniitors/{model_monitor}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/artifacts", + "path": "v1beta1/{+parent}/modelMonitoringJobs", "request": { - "$ref": "GoogleCloudAiplatformV1beta1Artifact" + "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringJob" }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1Artifact" + "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringJob" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { - "description": "Deletes an Artifact.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}", + "description": "Deletes a ModelMonitoringJob.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/modelMonitoringJobs/{modelMonitoringJobsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.metadataStores.artifacts.delete", + "id": "aiplatform.projects.locations.modelMonitors.modelMonitoringJobs.delete", "parameterOrder": [ "name" ], "parameters": { - "etag": { - "description": "Optional. The etag of the Artifact to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION.", - "location": "query", - "type": "string" - }, "name": { - "description": "Required. The resource name of the Artifact to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`", + "description": "Required. The resource name of the model monitoring job to delete. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}/modelMonitoringJobs/{model_monitoring_job}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/modelMonitoringJobs/[^/]+$", "required": true, "type": "string" } @@ -13052,1067 +22411,812 @@ ] }, "get": { - "description": "Retrieves a specific Artifact.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}", + "description": "Gets a ModelMonitoringJob.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/modelMonitoringJobs/{modelMonitoringJobsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.metadataStores.artifacts.get", + "id": "aiplatform.projects.locations.modelMonitors.modelMonitoringJobs.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The resource name of the Artifact to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`", + "description": "Required. The resource name of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}/modelMonitoringJobs/{model_monitoring_job}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/modelMonitoringJobs/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1Artifact" + "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringJob" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists Artifacts in the MetadataStore.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts", + "description": "Lists ModelMonitoringJobs. Callers may choose to read across multiple Monitors as per [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash character) as a wildcard character instead of modelMonitor id in the parent. Format `projects/{project_id}/locations/{location}/moodelMonitors/-/modelMonitoringJobs`", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/modelMonitoringJobs", "httpMethod": "GET", - "id": "aiplatform.projects.locations.metadataStores.artifacts.list", + "id": "aiplatform.projects.locations.modelMonitors.modelMonitoringJobs.list", "parameterOrder": [ "parent" ], "parameters": { "filter": { - "description": "Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = \"test\"`. Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = \"2020-11-19T11:30:00-04:00\"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata.\"field:1\".number_value = 10.0` * **Context based filtering**: To filter Artifacts based on the contexts to which they belong, use the function operator with the full resource name `in_context()`. For example: `in_context(\"projects//locations//metadataStores//contexts/\")` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = \"test\" AND metadata.field1.bool_value = true`.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a \" desc\" suffix; for example: \"foo desc, bar\". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.", + "description": "The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", "location": "query", "type": "string" }, "pageSize": { - "description": "The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.", + "description": "The standard list page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A page token, received from a previous MetadataService.ListArtifacts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.)", + "description": "The standard list page token.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The MetadataStore whose Artifacts should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/artifacts", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListArtifactsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "patch": { - "description": "Updates a stored Artifact.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.metadataStores.artifacts.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "allowMissing": { - "description": "If set to true, and the Artifact is not found, a new Artifact is created.", - "location": "query", - "type": "boolean" - }, - "name": { - "description": "Output only. The resource name of the Artifact.", + "description": "Required. The parent of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$", "required": true, "type": "string" }, - "updateMask": { - "description": "Optional. A FieldMask indicating which fields should be updated.", + "readMask": { + "description": "Mask specifying which fields to read", "format": "google-fieldmask", "location": "query", "type": "string" } }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1Artifact" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1Artifact" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "purge": { - "description": "Purges Artifacts.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts:purge", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.metadataStores.artifacts.purge", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The metadata store to purge Artifacts from. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/artifacts:purge", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1PurgeArtifactsRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "queryArtifactLineageSubgraph": { - "description": "Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}:queryArtifactLineageSubgraph", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.metadataStores.artifacts.queryArtifactLineageSubgraph", - "parameterOrder": [ - "artifact" - ], - "parameters": { - "artifact": { - "description": "Required. The resource name of the Artifact whose Lineage needs to be retrieved as a LineageSubgraph. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$", - "required": true, - "type": "string" - }, - "filter": { - "description": "Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the Lineage Subgraph. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = \"test\"` Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = \"2020-11-19T11:30:00-04:00\"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata.\"field:1\".number_value = 10.0` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = \"test\" AND metadata.field1.bool_value = true`.", - "location": "query", - "type": "string" - }, - "maxHops": { - "description": "Specifies the size of the lineage graph in terms of number of hops from the specified artifact. Negative Value: INVALID_ARGUMENT error is returned 0: Only input artifact is returned. No value: Transitive closure is performed to return the complete graph.", - "format": "int32", - "location": "query", - "type": "integer" - } - }, - "path": "v1beta1/{+artifact}:queryArtifactLineageSubgraph", + "path": "v1beta1/{+parent}/modelMonitoringJobs", "response": { - "$ref": "GoogleCloudAiplatformV1beta1LineageSubgraph" + "$ref": "GoogleCloudAiplatformV1beta1ListModelMonitoringJobsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } - }, - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.metadataStores.artifacts.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.metadataStores.artifacts.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.metadataStores.artifacts.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.metadataStores.artifacts.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.metadataStores.artifacts.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } } }, - "contexts": { + "operations": { "methods": { - "addContextArtifactsAndExecutions": { - "description": "Adds a set of Artifacts and Executions to a Context. If any of the Artifacts or Executions have already been added to a Context, they are simply skipped.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:addContextArtifactsAndExecutions", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.metadataStores.contexts.addContextArtifactsAndExecutions", - "parameterOrder": [ - "context" - ], - "parameters": { - "context": { - "description": "Required. The resource name of the Context that the Artifacts and Executions belong to. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+context}:addContextArtifactsAndExecutions", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1AddContextArtifactsAndExecutionsRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1AddContextArtifactsAndExecutionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "addContextChildren": { - "description": "Adds a set of Contexts as children to a parent Context. If any of the child Contexts have already been added to the parent Context, they are simply skipped. If this call would create a cycle or cause any Context to have more than 10 parents, the request will fail with an INVALID_ARGUMENT error.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:addContextChildren", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.metadataStores.contexts.addContextChildren", - "parameterOrder": [ - "context" - ], - "parameters": { - "context": { - "description": "Required. The resource name of the parent Context. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+context}:addContextChildren", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1AddContextChildrenRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1AddContextChildrenResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "create": { - "description": "Creates a Context associated with a MetadataStore.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts", + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.metadataStores.contexts.create", + "id": "aiplatform.projects.locations.modelMonitors.operations.cancel", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "contextId": { - "description": "The {context} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`. If not provided, the Context's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Contexts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Context.)", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the MetadataStore where the Context should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", + "name": { + "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/contexts", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1Context" - }, + "path": "v1beta1/{+name}:cancel", "response": { - "$ref": "GoogleCloudAiplatformV1beta1Context" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "delete": { - "description": "Deletes a stored Context.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.metadataStores.contexts.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "etag": { - "description": "Optional. The etag of the Context to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION.", - "location": "query", - "type": "string" - }, - "force": { - "description": "The force deletion semantics is still undefined. Users should not use this field.", - "location": "query", - "type": "boolean" - }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.modelMonitors.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { "name": { - "description": "Required. The resource name of the Context to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`", + "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { - "description": "Retrieves a specific Context.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}", + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.metadataStores.contexts.get", + "id": "aiplatform.projects.locations.modelMonitors.operations.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The resource name of the Context to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`", + "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1Context" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists Contexts on the MetadataStore.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.metadataStores.contexts.list", + "id": "aiplatform.projects.locations.modelMonitors.operations.list", "parameterOrder": [ - "parent" + "name" ], "parameters": { "filter": { - "description": "Filter specifying the boolean condition for the Contexts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = \"test\"`. Supported fields include: `name`, `display_name`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = \"2020-11-19T11:30:00-04:00\"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0`. In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata.\"field:1\".number_value = 10.0` * **Parent Child filtering**: To filter Contexts based on parent-child relationship use the HAS operator as follows: ``` parent_contexts: \"projects//locations//metadataStores//contexts/\" child_contexts: \"projects//locations//metadataStores//contexts/\" ``` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = \"test\" AND metadata.field1.bool_value = true`.", + "description": "The standard list filter.", "location": "query", "type": "string" }, - "orderBy": { - "description": "How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a \" desc\" suffix; for example: \"foo desc, bar\". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.", - "location": "query", + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$", + "required": true, "type": "string" }, "pageSize": { - "description": "The maximum number of Contexts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.", + "description": "The standard list page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A page token, received from a previous MetadataService.ListContexts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.)", + "description": "The standard list page token.", "location": "query", "type": "string" }, - "parent": { - "description": "Required. The MetadataStore whose Contexts should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", - "required": true, - "type": "string" + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, - "path": "v1beta1/{+parent}/contexts", + "path": "v1beta1/{+name}/operations", "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListContextsResponse" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "patch": { - "description": "Updates a stored Context.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.metadataStores.contexts.patch", + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.modelMonitors.operations.wait", "parameterOrder": [ "name" ], "parameters": { - "allowMissing": { - "description": "If set to true, and the Context is not found, a new Context is created.", - "location": "query", - "type": "boolean" - }, "name": { - "description": "Immutable. The resource name of the Context.", + "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, - "updateMask": { - "description": "Optional. A FieldMask indicating which fields should be updated.", - "format": "google-fieldmask", + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", "location": "query", "type": "string" } }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1Context" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1Context" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "purge": { - "description": "Purges Contexts.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts:purge", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.metadataStores.contexts.purge", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The metadata store to purge Contexts from. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/contexts:purge", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1PurgeContextsRequest" - }, + "path": "v1beta1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + } + } + } + } + }, + "models": { + "methods": { + "copy": { + "description": "Copies an already existing Vertex AI Model into the specified Location. The source Model must exist in the same Project. When copying custom Models, the users themselves are responsible for Model.metadata content to be region-agnostic, as well as making sure that any resources (e.g. files) it depends on remain accessible.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models:copy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.models.copy", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location into which to copy the Model. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/models:copy", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1CopyModelRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a Model. A model cannot be deleted if any Endpoint resource has a DeployedModel based on the model in its deployed_models field.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.models.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Model resource to be deleted. Format: `projects/{project}/locations/{location}/models/{model}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "deleteVersion": { + "description": "Deletes a Model version. Model version can only be deleted if there are no DeployedModels created from it. Deleting the only version in the Model is not allowed. Use DeleteModel for deleting the Model instead.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:deleteVersion", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.models.deleteVersion", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the model version to be deleted, with a version ID explicitly included. Example: `projects/{project}/locations/{location}/models/{model}@1234`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:deleteVersion", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "export": { + "description": "Exports a trained, exportable Model to a location specified by the user. A Model is considered to be exportable if it has at least one supported export format.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:export", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.models.export", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Model to export. The resource name may contain version id or version alias to specify the version, if no version is specified, the default version will be exported.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:export", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1ExportModelRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a Model.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.models.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Model resource. Format: `projects/{project}/locations/{location}/models/{model}` In order to retrieve a specific version of the model, also provide the version ID or version alias. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` If no version ID or alias is specified, the \"default\" version will be returned. The \"default\" version alias is created for the first version of the model, and can be moved to other versions later on. There will be exactly one default version.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1Model" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:getIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.models.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" }, - "queryContextLineageSubgraph": { - "description": "Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:queryContextLineageSubgraph", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.metadataStores.contexts.queryContextLineageSubgraph", - "parameterOrder": [ - "context" - ], - "parameters": { - "context": { - "description": "Required. The resource name of the Context whose Artifacts and Executions should be retrieved as a LineageSubgraph. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}` The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+context}:queryContextLineageSubgraph", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1LineageSubgraph" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:getIamPolicy", + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Models in a Location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.models.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `model` supports = and !=. `model` represents the Model ID, i.e. the last segment of the Model's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. * `base_model_name` only supports = Some examples: * `model=1234` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"` * `baseModelName=\"text-bison\"`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token. Typically obtained via ListModelsResponse.next_page_token of the previous ModelService.ListModels call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list the Models from. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/models", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListModelsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "listCheckpoints": { + "description": "Lists checkpoints of the specified model version.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:listCheckpoints", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.models.listCheckpoints", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the model version to list checkpoints for. `projects/{project}/locations/{location}/models/{model}@{version}` Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` If no version ID or alias is specified, the latest version will be used.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token. Typically obtained via next_page_token of the previous ListModelVersionCheckpoints call.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:listCheckpoints", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListModelVersionCheckpointsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "listVersions": { + "description": "Lists versions of the specified model.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:listVersions", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.models.listVersions", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. Some examples: * `labels.myKey=\"myValue\"`", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The name of the model to list versions for.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + }, + "orderBy": { + "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `update_time asc, create_time desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token. Typically obtained via next_page_token of the previous ListModelVersions call.", + "location": "query", + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:listVersions", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListModelVersionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "mergeVersionAliases": { + "description": "Merges a set of aliases for a Model version.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:mergeVersionAliases", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.models.mergeVersionAliases", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the model version to merge aliases, with a version ID explicitly included. Example: `projects/{project}/locations/{location}/models/{model}@1234`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:mergeVersionAliases", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1MergeVersionAliasesRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1Model" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a Model.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.models.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The resource name of the Model.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Model" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1Model" + }, + "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": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:setIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.models.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:setIamPolicy", + "request": { + "$ref": "GoogleIamV1SetIamPolicyRequest" + }, + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:testIamPermissions", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.models.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "permissions": { + "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", + "location": "query", + "repeated": true, + "type": "string" }, - "removeContextChildren": { - "description": "Remove a set of children contexts from a parent Context. If any of the child Contexts were NOT added to the parent Context, they are simply skipped.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:removeContextChildren", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.metadataStores.contexts.removeContextChildren", - "parameterOrder": [ - "context" - ], - "parameters": { - "context": { - "description": "Required. The resource name of the parent Context. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+context}:removeContextChildren", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1RemoveContextChildrenRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1RemoveContextChildrenResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", + "required": true, + "type": "string" } }, - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.metadataStores.contexts.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.metadataStores.contexts.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.metadataStores.contexts.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.metadataStores.contexts.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.metadataStores.contexts.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } + "path": "v1beta1/{+resource}:testIamPermissions", + "response": { + "$ref": "GoogleIamV1TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "updateExplanationDataset": { + "description": "Incrementally update the dataset used for an examples model.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:updateExplanationDataset", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.models.updateExplanationDataset", + "parameterOrder": [ + "model" + ], + "parameters": { + "model": { + "description": "Required. The resource name of the Model to update. Format: `projects/{project}/locations/{location}/models/{model}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", + "required": true, + "type": "string" } - } + }, + "path": "v1beta1/{+model}:updateExplanationDataset", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1UpdateExplanationDatasetRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "executions": { + "upload": { + "description": "Uploads a Model artifact into Vertex AI.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models:upload", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.models.upload", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location into which to upload the Model. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/models:upload", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1UploadModelRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "evaluations": { "methods": { - "addExecutionEvents": { - "description": "Adds Events to the specified Execution. An Event indicates whether an Artifact was used as an input or output for an Execution. If an Event already exists between the Execution and the Artifact, the Event is skipped.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:addExecutionEvents", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.metadataStores.executions.addExecutionEvents", - "parameterOrder": [ - "execution" - ], - "parameters": { - "execution": { - "description": "Required. The resource name of the Execution that the Events connect Artifacts with. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+execution}:addExecutionEvents", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1AddExecutionEventsRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1AddExecutionEventsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "create": { - "description": "Creates an Execution associated with a MetadataStore.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.metadataStores.executions.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "executionId": { - "description": "The {execution} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` If not provided, the Execution's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Executions in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Execution.)", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the MetadataStore where the Execution should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/executions", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1Execution" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1Execution" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes an Execution.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.metadataStores.executions.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "etag": { - "description": "Optional. The etag of the Execution to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION.", - "location": "query", - "type": "string" - }, - "name": { - "description": "Required. The resource name of the Execution to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "get": { - "description": "Retrieves a specific Execution.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.metadataStores.executions.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The resource name of the Execution to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1Execution" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists Executions in the MetadataStore.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions", + "description": "Gets a ModelEvaluation.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.metadataStores.executions.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Filter specifying the boolean condition for the Executions to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = \"test\"`. Supported fields include: `name`, `display_name`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = \"2020-11-19T11:30:00-04:00\"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..` For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata.\"field:1\".number_value = 10.0` * **Context based filtering**: To filter Executions based on the contexts to which they belong use the function operator with the full resource name: `in_context()`. For example: `in_context(\"projects//locations//metadataStores//contexts/\")` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = \"test\" AND metadata.field1.bool_value = true`.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a \" desc\" suffix; for example: \"foo desc, bar\". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of Executions to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous MetadataService.ListExecutions call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with an INVALID_ARGUMENT error.)", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The MetadataStore whose Executions should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/executions", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListExecutionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "patch": { - "description": "Updates a stored Execution.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.metadataStores.executions.patch", + "id": "aiplatform.projects.locations.models.evaluations.get", "parameterOrder": [ "name" ], "parameters": { - "allowMissing": { - "description": "If set to true, and the Execution is not found, a new Execution is created.", - "location": "query", - "type": "boolean" - }, "name": { - "description": "Output only. The resource name of the Execution.", + "description": "Required. The name of the ModelEvaluation resource. Format: `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+$", "required": true, "type": "string" - }, - "updateMask": { - "description": "Optional. A FieldMask indicating which fields should be updated.", - "format": "google-fieldmask", - "location": "query", - "type": "string" } }, "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1Execution" - }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1Execution" + "$ref": "GoogleCloudAiplatformV1beta1ModelEvaluation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "purge": { - "description": "Purges Executions.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions:purge", + "import": { + "description": "Imports an externally generated ModelEvaluation.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations:import", "httpMethod": "POST", - "id": "aiplatform.projects.locations.metadataStores.executions.purge", + "id": "aiplatform.projects.locations.models.evaluations.import", "parameterOrder": [ "parent" ], "parameters": { "parent": { - "description": "Required. The metadata store to purge Executions from. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", + "description": "Required. The name of the parent model resource. Format: `projects/{project}/locations/{location}/models/{model}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/executions:purge", + "path": "v1beta1/{+parent}/evaluations:import", "request": { - "$ref": "GoogleCloudAiplatformV1beta1PurgeExecutionsRequest" + "$ref": "GoogleCloudAiplatformV1beta1ImportModelEvaluationRequest" }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1beta1ModelEvaluation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "queryExecutionInputsAndOutputs": { - "description": "Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:queryExecutionInputsAndOutputs", + "list": { + "description": "Lists ModelEvaluations in a Model.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.metadataStores.executions.queryExecutionInputsAndOutputs", + "id": "aiplatform.projects.locations.models.evaluations.list", "parameterOrder": [ - "execution" + "parent" ], "parameters": { - "execution": { - "description": "Required. The resource name of the Execution whose input and output Artifacts should be retrieved as a LineageSubgraph. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`", + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token. Typically obtained via ListModelEvaluationsResponse.next_page_token of the previous ModelService.ListModelEvaluations call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Model to list the ModelEvaluations from. Format: `projects/{project}/locations/{location}/models/{model}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", "required": true, "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, - "path": "v1beta1/{+execution}:queryExecutionInputsAndOutputs", + "path": "v1beta1/{+parent}/evaluations", "response": { - "$ref": "GoogleCloudAiplatformV1beta1LineageSubgraph" + "$ref": "GoogleCloudAiplatformV1beta1ListModelEvaluationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -14124,9 +23228,9 @@ "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:cancel", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.metadataStores.executions.operations.cancel", + "id": "aiplatform.projects.locations.models.evaluations.operations.cancel", "parameterOrder": [ "name" ], @@ -14134,7 +23238,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -14149,9 +23253,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.metadataStores.executions.operations.delete", + "id": "aiplatform.projects.locations.models.evaluations.operations.delete", "parameterOrder": [ "name" ], @@ -14159,7 +23263,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -14174,9 +23278,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.metadataStores.executions.operations.get", + "id": "aiplatform.projects.locations.models.evaluations.operations.get", "parameterOrder": [ "name" ], @@ -14184,7 +23288,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -14199,9 +23303,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.metadataStores.executions.operations.list", + "id": "aiplatform.projects.locations.models.evaluations.operations.list", "parameterOrder": [ "name" ], @@ -14214,7 +23318,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+$", "required": true, "type": "string" }, @@ -14245,9 +23349,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:wait", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.metadataStores.executions.operations.wait", + "id": "aiplatform.projects.locations.models.evaluations.operations.wait", "parameterOrder": [ "name" ], @@ -14255,7 +23359,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -14275,109 +23379,110 @@ ] } } - } - } - }, - "metadataSchemas": { - "methods": { - "create": { - "description": "Creates a MetadataSchema.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.metadataStores.metadataSchemas.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "metadataSchemaId": { - "description": "The {metadata_schema} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all MetadataSchemas in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataSchema.)", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the MetadataStore where the MetadataSchema should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/metadataSchemas", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1MetadataSchema" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1MetadataSchema" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Retrieves a specific MetadataSchema.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas/{metadataSchemasId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.metadataStores.metadataSchemas.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The resource name of the MetadataSchema to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/metadataSchemas/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1MetadataSchema" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] }, - "list": { - "description": "Lists MetadataSchemas.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.metadataStores.metadataSchemas.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "A query to filter available MetadataSchemas for matching results.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of MetadataSchemas to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.", - "format": "int32", - "location": "query", - "type": "integer" + "slices": { + "methods": { + "batchImport": { + "description": "Imports a list of externally generated EvaluatedAnnotations.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}:batchImport", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.models.evaluations.slices.batchImport", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the parent ModelEvaluationSlice resource. Format: `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/slices/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}:batchImport", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1BatchImportEvaluatedAnnotationsRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1BatchImportEvaluatedAnnotationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "pageToken": { - "description": "A page token, received from a previous MetadataService.ListMetadataSchemas call. Provide this to retrieve the next page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.)", - "location": "query", - "type": "string" + "get": { + "description": "Gets a ModelEvaluationSlice.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.models.evaluations.slices.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the ModelEvaluationSlice resource. Format: `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/slices/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ModelEvaluationSlice" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "parent": { - "description": "Required. The MetadataStore whose MetadataSchemas should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", - "required": true, - "type": "string" + "list": { + "description": "Lists ModelEvaluationSlices in a ModelEvaluation.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.models.evaluations.slices.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The standard list filter. * `slice.dimension` - for =.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token. Typically obtained via ListModelEvaluationSlicesResponse.next_page_token of the previous ModelService.ListModelEvaluationSlices call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the ModelEvaluation to list the ModelEvaluationSlices from. Format: `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/slices", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListModelEvaluationSlicesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } - }, - "path": "v1beta1/{+parent}/metadataSchemas", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListMetadataSchemasResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + } } } }, @@ -14385,9 +23490,9 @@ "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}:cancel", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.metadataStores.operations.cancel", + "id": "aiplatform.projects.locations.models.operations.cancel", "parameterOrder": [ "name" ], @@ -14395,7 +23500,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -14410,9 +23515,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.metadataStores.operations.delete", + "id": "aiplatform.projects.locations.models.operations.delete", "parameterOrder": [ "name" ], @@ -14420,7 +23525,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -14435,9 +23540,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.metadataStores.operations.get", + "id": "aiplatform.projects.locations.models.operations.get", "parameterOrder": [ "name" ], @@ -14445,7 +23550,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -14460,9 +23565,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.metadataStores.operations.list", + "id": "aiplatform.projects.locations.models.operations.list", "parameterOrder": [ "name" ], @@ -14475,7 +23580,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", "required": true, "type": "string" }, @@ -14506,9 +23611,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}:wait", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.metadataStores.operations.wait", + "id": "aiplatform.projects.locations.models.operations.wait", "parameterOrder": [ "name" ], @@ -14516,7 +23621,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -14539,267 +23644,77 @@ } } }, - "migratableResources": { + "nasJobs": { "methods": { - "batchMigrate": { - "description": "Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources:batchMigrate", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.migratableResources.batchMigrate", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The location of the migrated resource will live in. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/migratableResources:batchMigrate", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1BatchMigrateResourcesRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "search": { - "description": "Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources:search", + "cancel": { + "description": "Cancels a NasJob. Starts asynchronous cancellation on the NasJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetNasJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the NasJob is not deleted; instead it becomes a job with a NasJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and NasJob.state is set to `CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.migratableResources.search", + "id": "aiplatform.projects.locations.nasJobs.cancel", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "parent": { - "description": "Required. The location that the migratable resources should be searched from. It's the Vertex AI location that the resources can be migrated to, not the resources' original location. Format: `projects/{project}/locations/{location}`", + "name": { + "description": "Required. The name of the NasJob to cancel. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$", "required": true, "type": "string" - } - }, - "path": "v1beta1/{+parent}/migratableResources:search", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1SearchMigratableResourcesRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1SearchMigratableResourcesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.migratableResources.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.migratableResources.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.migratableResources.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.migratableResources.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.migratableResources.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - }, - "modelDeploymentMonitoringJobs": { - "methods": { + } + }, + "path": "v1beta1/{+name}:cancel", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1CancelNasJobRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "create": { - "description": "Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs", + "description": "Creates a NasJob", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs", "httpMethod": "POST", - "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.create", + "id": "aiplatform.projects.locations.nasJobs.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { - "description": "Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}`", + "description": "Required. The resource name of the Location to create the NasJob in. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/modelDeploymentMonitoringJobs", + "path": "v1beta1/{+parent}/nasJobs", "request": { - "$ref": "GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJob" + "$ref": "GoogleCloudAiplatformV1beta1NasJob" }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJob" + "$ref": "GoogleCloudAiplatformV1beta1NasJob" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { - "description": "Deletes a ModelDeploymentMonitoringJob.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}", + "description": "Deletes a NasJob.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.delete", + "id": "aiplatform.projects.locations.nasJobs.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The resource name of the model monitoring job to delete. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`", + "description": "Required. The name of the NasJob resource to be deleted. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$", "required": true, "type": "string" } @@ -14813,35 +23728,36 @@ ] }, "get": { - "description": "Gets a ModelDeploymentMonitoringJob.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}", + "description": "Gets a NasJob", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.get", + "id": "aiplatform.projects.locations.nasJobs.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The resource name of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`", + "description": "Required. The name of the NasJob resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJob" + "$ref": "GoogleCloudAiplatformV1beta1NasJob" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" ] }, "list": { - "description": "Lists ModelDeploymentMonitoringJobs in a Location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs", + "description": "Lists NasJobs in a Location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs", "httpMethod": "GET", - "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.list", + "id": "aiplatform.projects.locations.nasJobs.list", "parameterOrder": [ "parent" ], @@ -14858,59 +23774,154 @@ "type": "integer" }, "pageToken": { - "description": "The standard list page token.", + "description": "The standard list page token. Typically obtained via ListNasJobsResponse.next_page_token of the previous JobService.ListNasJobs call.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}`", + "description": "Required. The resource name of the Location to list the NasJobs from. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, "readMask": { - "description": "Mask specifying which fields to read", + "description": "Mask specifying which fields to read.", "format": "google-fieldmask", "location": "query", "type": "string" } }, - "path": "v1beta1/{+parent}/modelDeploymentMonitoringJobs", + "path": "v1beta1/{+parent}/nasJobs", "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListModelDeploymentMonitoringJobsResponse" + "$ref": "GoogleCloudAiplatformV1beta1ListNasJobsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "nasTrialDetails": { + "methods": { + "get": { + "description": "Gets a NasTrialDetail.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails/{nasTrialDetailsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.nasJobs.nasTrialDetails.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the NasTrialDetail resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}/nasTrialDetails/{nas_trial_detail}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+/nasTrialDetails/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1NasTrialDetail" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List top NasTrialDetails of a NasJob.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.nasJobs.nasTrialDetails.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token. Typically obtained via ListNasTrialDetailsResponse.next_page_token of the previous JobService.ListNasTrialDetails call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the NasJob resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/nasTrialDetails", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListNasTrialDetailsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "notebookExecutionJobs": { + "methods": { + "create": { + "description": "Creates a NotebookExecutionJob.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.notebookExecutionJobs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "notebookExecutionJobId": { + "description": "Optional. User specified ID for the NotebookExecutionJob.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/notebookExecutionJobs", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1NotebookExecutionJob" + }, + "response": { + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "patch": { - "description": "Updates a ModelDeploymentMonitoringJob.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.patch", + "delete": { + "description": "Deletes a NotebookExecutionJob.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.notebookExecutionJobs.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Output only. Resource name of a ModelDeploymentMonitoringJob.", + "description": "Required. The name of the NotebookExecutionJob resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$", "required": true, "type": "string" - }, - "updateMask": { - "description": "Required. The update mask is used to specify the fields to be overwritten in the ModelDeploymentMonitoringJob resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. For the objective config, the user can either provide the update mask for model_deployment_monitoring_objective_configs or any combination of its nested fields, such as: model_deployment_monitoring_objective_configs.objective_config.training_dataset. Updatable fields: * `display_name` * `model_deployment_monitoring_schedule_config` * `model_monitoring_alert_config` * `logging_sampling_strategy` * `labels` * `log_ttl` * `enable_monitoring_pipeline_logs` . and * `model_deployment_monitoring_objective_configs` . or * `model_deployment_monitoring_objective_configs.objective_config.training_dataset` * `model_deployment_monitoring_objective_configs.objective_config.training_prediction_skew_detection_config` * `model_deployment_monitoring_objective_configs.objective_config.prediction_drift_detection_config`", - "format": "google-fieldmask", - "location": "query", - "type": "string" } }, "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJob" - }, "response": { "$ref": "GoogleLongrunningOperation" }, @@ -14918,85 +23929,158 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "pause": { - "description": "Pauses a ModelDeploymentMonitoringJob. If the job is running, the server makes a best effort to cancel the job. Will mark ModelDeploymentMonitoringJob.state to 'PAUSED'.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:pause", + "generateAccessToken": { + "description": "Internal only: Called from Compute Engine instance to obtain EUC for owner Anonymous access: authenticates caller using VM identity JWT. Design doc: go/colab-on-vertex-euc-dd", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}:generateAccessToken", "httpMethod": "POST", - "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.pause", + "id": "aiplatform.projects.locations.notebookExecutionJobs.generateAccessToken", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The resource name of the ModelDeploymentMonitoringJob to pause. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`", + "description": "Required. The name of the resource requesting the OAuth2 token. Format: `projects/{project}/locations/{location}/notebookRuntimes/{notebook_runtime}` `projects/{project}/locations/{location}/notebookExecutionJobs/{notebook_execution_job}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+name}:pause", + "path": "v1beta1/{+name}:generateAccessToken", "request": { - "$ref": "GoogleCloudAiplatformV1beta1PauseModelDeploymentMonitoringJobRequest" + "$ref": "GoogleCloudAiplatformV1beta1GenerateAccessTokenRequest" }, "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleCloudAiplatformV1beta1GenerateAccessTokenResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "resume": { - "description": "Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:resume", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.resume", + "get": { + "description": "Gets a NotebookExecutionJob.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.notebookExecutionJobs.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The resource name of the ModelDeploymentMonitoringJob to resume. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`", + "description": "Required. The name of the NotebookExecutionJob resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$", "required": true, "type": "string" + }, + "view": { + "description": "Optional. The NotebookExecutionJob view. Defaults to BASIC.", + "enum": [ + "NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED", + "NOTEBOOK_EXECUTION_JOB_VIEW_BASIC", + "NOTEBOOK_EXECUTION_JOB_VIEW_FULL" + ], + "enumDescriptions": [ + "When unspecified, the API defaults to the BASIC view.", + "Includes all fields except for direct notebook inputs.", + "Includes all fields." + ], + "location": "query", + "type": "string" } }, - "path": "v1beta1/{+name}:resume", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1ResumeModelDeploymentMonitoringJobRequest" + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1NotebookExecutionJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists NotebookExecutionJobs in a Location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.notebookExecutionJobs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookExecutionJob` supports = and !=. `notebookExecutionJob` represents the NotebookExecutionJob ID. * `displayName` supports = and != and regex. * `schedule` supports = and != and regex. Some examples: * `notebookExecutionJob=\"123\"` * `notebookExecutionJob=\"my-execution-job\"` * `displayName=\"myDisplayName\"` and `displayName=~\"myDisplayNameRegex\"`", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token. Typically obtained via ListNotebookExecutionJobsResponse.next_page_token of the previous NotebookService.ListNotebookExecutionJobs call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location from which to list the NotebookExecutionJobs. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "Optional. The NotebookExecutionJob view. Defaults to BASIC.", + "enum": [ + "NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED", + "NOTEBOOK_EXECUTION_JOB_VIEW_BASIC", + "NOTEBOOK_EXECUTION_JOB_VIEW_FULL" + ], + "enumDescriptions": [ + "When unspecified, the API defaults to the BASIC view.", + "Includes all fields except for direct notebook inputs.", + "Includes all fields." + ], + "location": "query", + "type": "string" + } }, + "path": "v1beta1/{+parent}/notebookExecutionJobs", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleCloudAiplatformV1beta1ListNotebookExecutionJobsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "searchModelDeploymentMonitoringStatsAnomalies": { - "description": "Searches Model Monitoring Statistics generated within a given time window.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:searchModelDeploymentMonitoringStatsAnomalies", + "reportEvent": { + "description": "", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}:reportEvent", "httpMethod": "POST", - "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.searchModelDeploymentMonitoringStatsAnomalies", + "id": "aiplatform.projects.locations.notebookExecutionJobs.reportEvent", "parameterOrder": [ - "modelDeploymentMonitoringJob" + "name" ], "parameters": { - "modelDeploymentMonitoringJob": { - "description": "Required. ModelDeploymentMonitoring Job resource name. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`", + "name": { + "description": "Required. The name of the NotebookExecutionJob resource. Format: `projects/{project}/locations/{location}/notebookExecutionJobs/{notebook_execution_jobs}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+modelDeploymentMonitoringJob}:searchModelDeploymentMonitoringStatsAnomalies", + "path": "v1beta1/{+name}:reportEvent", "request": { - "$ref": "GoogleCloudAiplatformV1beta1SearchModelDeploymentMonitoringStatsAnomaliesRequest" + "$ref": "GoogleCloudAiplatformV1beta1ReportExecutionEventRequest" }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1SearchModelDeploymentMonitoringStatsAnomaliesResponse" + "$ref": "GoogleCloudAiplatformV1beta1ReportExecutionEventResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -15008,9 +24092,9 @@ "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:cancel", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.cancel", + "id": "aiplatform.projects.locations.notebookExecutionJobs.operations.cancel", "parameterOrder": [ "name" ], @@ -15018,7 +24102,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -15033,9 +24117,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.delete", + "id": "aiplatform.projects.locations.notebookExecutionJobs.operations.delete", "parameterOrder": [ "name" ], @@ -15043,7 +24127,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -15058,9 +24142,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.get", + "id": "aiplatform.projects.locations.notebookExecutionJobs.operations.get", "parameterOrder": [ "name" ], @@ -15068,7 +24152,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -15083,9 +24167,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.list", + "id": "aiplatform.projects.locations.notebookExecutionJobs.operations.list", "parameterOrder": [ "name" ], @@ -15098,7 +24182,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$", "required": true, "type": "string" }, @@ -15129,9 +24213,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:wait", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.wait", + "id": "aiplatform.projects.locations.notebookExecutionJobs.operations.wait", "parameterOrder": [ "name" ], @@ -15139,7 +24223,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -15162,33 +24246,33 @@ } } }, - "modelMonitors": { + "notebookRuntimeTemplates": { "methods": { "create": { - "description": "Creates a ModelMonitor.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors", + "description": "Creates a NotebookRuntimeTemplate.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates", "httpMethod": "POST", - "id": "aiplatform.projects.locations.modelMonitors.create", + "id": "aiplatform.projects.locations.notebookRuntimeTemplates.create", "parameterOrder": [ "parent" ], "parameters": { - "modelMonitorId": { - "description": "Optional. The ID to use for the Model Monitor, which will become the final component of the model monitor resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.", + "notebookRuntimeTemplateId": { + "description": "Optional. User specified ID for the notebook runtime template.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the Location to create the ModelMonitor in. Format: `projects/{project}/locations/{location}`", + "description": "Required. The resource name of the Location to create the NotebookRuntimeTemplate. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/modelMonitors", + "path": "v1beta1/{+parent}/notebookRuntimeTemplates", "request": { - "$ref": "GoogleCloudAiplatformV1beta1ModelMonitor" + "$ref": "GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate" }, "response": { "$ref": "GoogleLongrunningOperation" @@ -15198,23 +24282,18 @@ ] }, "delete": { - "description": "Deletes a ModelMonitor.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}", + "description": "Deletes a NotebookRuntimeTemplate.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.modelMonitors.delete", + "id": "aiplatform.projects.locations.notebookRuntimeTemplates.delete", "parameterOrder": [ "name" ], "parameters": { - "force": { - "description": "Optional. Force delete the model monitor with schedules.", - "location": "query", - "type": "boolean" - }, "name": { - "description": "Required. The name of the ModelMonitor resource to be deleted. Format: `projects/{project}/locations/{location}/modelMonitords/{model_monitor}`", + "description": "Required. The name of the NotebookRuntimeTemplate resource to be deleted. Format: `projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$", "required": true, "type": "string" } @@ -15228,95 +24307,131 @@ ] }, "get": { - "description": "Gets a ModelMonitor.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}", + "description": "Gets a NotebookRuntimeTemplate.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.modelMonitors.get", + "id": "aiplatform.projects.locations.notebookRuntimeTemplates.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the ModelMonitor resource. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`", + "description": "Required. The name of the NotebookRuntimeTemplate resource. Format: `projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1ModelMonitor" + "$ref": "GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:getIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.notebookRuntimeTemplates.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:getIamPolicy", + "response": { + "$ref": "GoogleIamV1Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists ModelMonitors in a Location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors", + "description": "Lists NotebookRuntimeTemplates in a Location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates", "httpMethod": "GET", - "id": "aiplatform.projects.locations.modelMonitors.list", + "id": "aiplatform.projects.locations.notebookRuntimeTemplates.list", "parameterOrder": [ "parent" ], "parameters": { "filter": { - "description": "The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", + "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntimeTemplate=notebookRuntimeTemplate123` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4`", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.", "location": "query", "type": "string" }, "pageSize": { - "description": "The standard list page size.", + "description": "Optional. The standard list page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "The standard list page token.", + "description": "Optional. The standard list page token. Typically obtained via ListNotebookRuntimeTemplatesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimeTemplates call.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the Location to list the ModelMonitors from. Format: `projects/{project}/locations/{location}`", + "description": "Required. The resource name of the Location from which to list the NotebookRuntimeTemplates. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, "readMask": { - "description": "Mask specifying which fields to read.", + "description": "Optional. Mask specifying which fields to read.", "format": "google-fieldmask", "location": "query", "type": "string" } }, - "path": "v1beta1/{+parent}/modelMonitors", + "path": "v1beta1/{+parent}/notebookRuntimeTemplates", "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListModelMonitorsResponse" + "$ref": "GoogleCloudAiplatformV1beta1ListNotebookRuntimeTemplatesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { - "description": "Updates a ModelMonitor.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}", + "description": "Updates a NotebookRuntimeTemplate.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}", "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.modelMonitors.patch", + "id": "aiplatform.projects.locations.notebookRuntimeTemplates.patch", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Immutable. Resource name of the ModelMonitor. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`.", + "description": "The resource name of the NotebookRuntimeTemplate.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$", "required": true, "type": "string" }, "updateMask": { - "description": "Required. Mask specifying which fields to update.", + "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Input format: `{paths: \"${updated_filed}\"}` Updatable fields: * `encryption_spec.kms_key_name`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -15324,66 +24439,69 @@ }, "path": "v1beta1/{+name}", "request": { - "$ref": "GoogleCloudAiplatformV1beta1ModelMonitor" + "$ref": "GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate" }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "searchModelMonitoringAlerts": { - "description": "Returns the Model Monitoring alerts.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}:searchModelMonitoringAlerts", + "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": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:setIamPolicy", "httpMethod": "POST", - "id": "aiplatform.projects.locations.modelMonitors.searchModelMonitoringAlerts", + "id": "aiplatform.projects.locations.notebookRuntimeTemplates.setIamPolicy", "parameterOrder": [ - "modelMonitor" + "resource" ], "parameters": { - "modelMonitor": { - "description": "Required. ModelMonitor resource name. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`", + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+modelMonitor}:searchModelMonitoringAlerts", + "path": "v1beta1/{+resource}:setIamPolicy", "request": { - "$ref": "GoogleCloudAiplatformV1beta1SearchModelMonitoringAlertsRequest" + "$ref": "GoogleIamV1SetIamPolicyRequest" }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1SearchModelMonitoringAlertsResponse" + "$ref": "GoogleIamV1Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "searchModelMonitoringStats": { - "description": "Searches Model Monitoring Stats generated within a given time window.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}:searchModelMonitoringStats", + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:testIamPermissions", "httpMethod": "POST", - "id": "aiplatform.projects.locations.modelMonitors.searchModelMonitoringStats", + "id": "aiplatform.projects.locations.notebookRuntimeTemplates.testIamPermissions", "parameterOrder": [ - "modelMonitor" + "resource" ], - "parameters": { - "modelMonitor": { - "description": "Required. ModelMonitor resource name. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`", + "parameters": { + "permissions": { + "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", + "location": "query", + "repeated": true, + "type": "string" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+modelMonitor}:searchModelMonitoringStats", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1SearchModelMonitoringStatsRequest" - }, + "path": "v1beta1/{+resource}:testIamPermissions", "response": { - "$ref": "GoogleCloudAiplatformV1beta1SearchModelMonitoringStatsResponse" + "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -15391,147 +24509,13 @@ } }, "resources": { - "modelMonitoringJobs": { - "methods": { - "create": { - "description": "Creates a ModelMonitoringJob.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/modelMonitoringJobs", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.modelMonitors.modelMonitoringJobs.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "modelMonitoringJobId": { - "description": "Optional. The ID to use for the Model Monitoring Job, which will become the final component of the model monitoring job resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMoniitors/{model_monitor}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/modelMonitoringJobs", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringJob" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringJob" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a ModelMonitoringJob.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/modelMonitoringJobs/{modelMonitoringJobsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.modelMonitors.modelMonitoringJobs.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The resource name of the model monitoring job to delete. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}/modelMonitoringJobs/{model_monitoring_job}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/modelMonitoringJobs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets a ModelMonitoringJob.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/modelMonitoringJobs/{modelMonitoringJobsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.modelMonitors.modelMonitoringJobs.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The resource name of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}/modelMonitoringJobs/{model_monitoring_job}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/modelMonitoringJobs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringJob" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists ModelMonitoringJobs. Callers may choose to read across multiple Monitors as per [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash character) as a wildcard character instead of modelMonitor id in the parent. Format `projects/{project_id}/locations/{location}/moodelMonitors/-/modelMonitoringJobs`", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/modelMonitoringJobs", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.modelMonitors.modelMonitoringJobs.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+parent}/modelMonitoringJobs", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListModelMonitoringJobsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/operations/{operationsId}:cancel", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.modelMonitors.operations.cancel", + "id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.cancel", "parameterOrder": [ "name" ], @@ -15539,7 +24523,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -15554,9 +24538,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.modelMonitors.operations.delete", + "id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.delete", "parameterOrder": [ "name" ], @@ -15564,7 +24548,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -15579,9 +24563,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.modelMonitors.operations.get", + "id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.get", "parameterOrder": [ "name" ], @@ -15589,7 +24573,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -15604,9 +24588,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/operations", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.modelMonitors.operations.list", + "id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.list", "parameterOrder": [ "name" ], @@ -15619,7 +24603,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$", "required": true, "type": "string" }, @@ -15650,9 +24634,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/operations/{operationsId}:wait", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.modelMonitors.operations.wait", + "id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.wait", "parameterOrder": [ "name" ], @@ -15660,7 +24644,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -15683,28 +24667,28 @@ } } }, - "models": { + "notebookRuntimes": { "methods": { - "copy": { - "description": "Copies an already existing Vertex AI Model into the specified Location. The source Model must exist in the same Project. When copying custom Models, the users themselves are responsible for Model.metadata content to be region-agnostic, as well as making sure that any resources (e.g. files) it depends on remain accessible.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models:copy", + "assign": { + "description": "Assigns a NotebookRuntime to a user for a particular Notebook file. This method will either returns an existing assignment or generates a new one.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes:assign", "httpMethod": "POST", - "id": "aiplatform.projects.locations.models.copy", + "id": "aiplatform.projects.locations.notebookRuntimes.assign", "parameterOrder": [ "parent" ], "parameters": { "parent": { - "description": "Required. The resource name of the Location into which to copy the Model. Format: `projects/{project}/locations/{location}`", + "description": "Required. The resource name of the Location to get the NotebookRuntime assignment. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/models:copy", + "path": "v1beta1/{+parent}/notebookRuntimes:assign", "request": { - "$ref": "GoogleCloudAiplatformV1beta1CopyModelRequest" + "$ref": "GoogleCloudAiplatformV1beta1AssignNotebookRuntimeRequest" }, "response": { "$ref": "GoogleLongrunningOperation" @@ -15714,18 +24698,18 @@ ] }, "delete": { - "description": "Deletes a Model. A model cannot be deleted if any Endpoint resource has a DeployedModel based on the model in its deployed_models field.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}", + "description": "Deletes a NotebookRuntime.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.models.delete", + "id": "aiplatform.projects.locations.notebookRuntimes.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the Model resource to be deleted. Format: `projects/{project}/locations/{location}/models/{model}`", + "description": "Required. The name of the NotebookRuntime resource to be deleted. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", "required": true, "type": "string" } @@ -15738,177 +24722,77 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "deleteVersion": { - "description": "Deletes a Model version. Model version can only be deleted if there are no DeployedModels created from it. Deleting the only version in the Model is not allowed. Use DeleteModel for deleting the Model instead.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:deleteVersion", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.models.deleteVersion", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the model version to be deleted, with a version ID explicitly included. Example: `projects/{project}/locations/{location}/models/{model}@1234`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:deleteVersion", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "export": { - "description": "Exports a trained, exportable Model to a location specified by the user. A Model is considered to be exportable if it has at least one supported export format.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:export", + "generateAccessToken": { + "description": "Internal only: Called from Compute Engine instance to obtain EUC for owner Anonymous access: authenticates caller using VM identity JWT. Design doc: go/colab-on-vertex-euc-dd", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:generateAccessToken", "httpMethod": "POST", - "id": "aiplatform.projects.locations.models.export", + "id": "aiplatform.projects.locations.notebookRuntimes.generateAccessToken", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The resource name of the Model to export. The resource name may contain version id or version alias to specify the version, if no version is specified, the default version will be exported.", + "description": "Required. The name of the resource requesting the OAuth2 token. Format: `projects/{project}/locations/{location}/notebookRuntimes/{notebook_runtime}` `projects/{project}/locations/{location}/notebookExecutionJobs/{notebook_execution_job}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+name}:export", + "path": "v1beta1/{+name}:generateAccessToken", "request": { - "$ref": "GoogleCloudAiplatformV1beta1ExportModelRequest" + "$ref": "GoogleCloudAiplatformV1beta1GenerateAccessTokenRequest" }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1beta1GenerateAccessTokenResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { - "description": "Gets a Model.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}", + "description": "Gets a NotebookRuntime.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.models.get", + "id": "aiplatform.projects.locations.notebookRuntimes.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the Model resource. Format: `projects/{project}/locations/{location}/models/{model}` In order to retrieve a specific version of the model, also provide the version ID or version alias. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` If no version ID or alias is specified, the \"default\" version will be returned. The \"default\" version alias is created for the first version of the model, and can be moved to other versions later on. There will be exactly one default version.", + "description": "Required. The name of the NotebookRuntime resource. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1Model" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:getIamPolicy", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.models.getIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "options.requestedPolicyVersion": { - "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", - "format": "int32", - "location": "query", - "type": "integer" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:getIamPolicy", - "response": { - "$ref": "GoogleIamV1Policy" + "$ref": "GoogleCloudAiplatformV1beta1NotebookRuntime" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists Models in a Location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models", + "description": "Lists NotebookRuntimes in a Location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes", "httpMethod": "GET", - "id": "aiplatform.projects.locations.models.list", + "id": "aiplatform.projects.locations.notebookRuntimes.list", "parameterOrder": [ "parent" ], "parameters": { "filter": { - "description": "An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `model` supports = and !=. `model` represents the Model ID, i.e. the last segment of the Model's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. * `base_model_name` only supports = Some examples: * `model=1234` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"` * `baseModelName=\"text-bison\"`", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token. Typically obtained via ListModelsResponse.next_page_token of the previous ModelService.ListModels call.", + "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED, ERROR, INVALID]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntime=\"notebookRuntime123\"` * `displayName=\"myDisplayName\"` and `displayName=~\"myDisplayNameRegex\"` * `notebookRuntimeTemplate=\"notebookRuntimeTemplate321\"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser=\"test@google.com\"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4`", "location": "query", "type": "string" }, - "parent": { - "description": "Required. The resource name of the Location to list the Models from. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.", "location": "query", "type": "string" - } - }, - "path": "v1beta1/{+parent}/models", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListModelsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "listCheckpoints": { - "description": "Lists checkpoints of the specified model version.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:listCheckpoints", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.models.listCheckpoints", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the model version to list checkpoints for. `projects/{project}/locations/{location}/models/{model}@{version}` Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` If no version ID or alias is specified, the latest version will be used.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", - "required": true, - "type": "string" }, "pageSize": { "description": "Optional. The standard list page size.", @@ -15917,212 +24801,108 @@ "type": "integer" }, "pageToken": { - "description": "Optional. The standard list page token. Typically obtained via next_page_token of the previous ListModelVersionCheckpoints call.", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:listCheckpoints", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListModelVersionCheckpointsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "listVersions": { - "description": "Lists versions of the specified model.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:listVersions", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.models.listVersions", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. Some examples: * `labels.myKey=\"myValue\"`", + "description": "Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimes call.", "location": "query", "type": "string" }, - "name": { - "description": "Required. The name of the model to list versions for.", + "parent": { + "description": "Required. The resource name of the Location from which to list the NotebookRuntimes. Format: `projects/{project}/locations/{location}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, - "orderBy": { - "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `update_time asc, create_time desc`.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token. Typically obtained via next_page_token of the previous ListModelVersions call.", - "location": "query", - "type": "string" - }, "readMask": { - "description": "Mask specifying which fields to read.", + "description": "Optional. Mask specifying which fields to read.", "format": "google-fieldmask", "location": "query", "type": "string" } }, - "path": "v1beta1/{+name}:listVersions", + "path": "v1beta1/{+parent}/notebookRuntimes", "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListModelVersionsResponse" + "$ref": "GoogleCloudAiplatformV1beta1ListNotebookRuntimesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "mergeVersionAliases": { - "description": "Merges a set of aliases for a Model version.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:mergeVersionAliases", + "reportEvent": { + "description": "", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:reportEvent", "httpMethod": "POST", - "id": "aiplatform.projects.locations.models.mergeVersionAliases", + "id": "aiplatform.projects.locations.notebookRuntimes.reportEvent", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the model version to merge aliases, with a version ID explicitly included. Example: `projects/{project}/locations/{location}/models/{model}@1234`", + "description": "Required. The name of the NotebookRuntime resource. Format: `projects/{project}/locations/{location}/notebookRuntimes/{notebook_runtime}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+name}:mergeVersionAliases", + "path": "v1beta1/{+name}:reportEvent", "request": { - "$ref": "GoogleCloudAiplatformV1beta1MergeVersionAliasesRequest" + "$ref": "GoogleCloudAiplatformV1beta1ReportRuntimeEventRequest" }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1Model" + "$ref": "GoogleCloudAiplatformV1beta1ReportRuntimeEventResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "patch": { - "description": "Updates a Model.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.models.patch", + "start": { + "description": "Starts a NotebookRuntime.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:start", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.notebookRuntimes.start", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "The resource name of the Model.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1Model" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1Model" - }, - "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": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:setIamPolicy", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.models.setIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "description": "Required. The name of the NotebookRuntime resource to be started. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+resource}:setIamPolicy", + "path": "v1beta1/{+name}:start", "request": { - "$ref": "GoogleIamV1SetIamPolicyRequest" - }, - "response": { - "$ref": "GoogleIamV1Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:testIamPermissions", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.models.testIamPermissions", - "parameterOrder": [ - "resource" - ], - "parameters": { - "permissions": { - "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", - "location": "query", - "repeated": true, - "type": "string" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", - "required": true, - "type": "string" - } + "$ref": "GoogleCloudAiplatformV1beta1StartNotebookRuntimeRequest" }, - "path": "v1beta1/{+resource}:testIamPermissions", "response": { - "$ref": "GoogleIamV1TestIamPermissionsResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "updateExplanationDataset": { - "description": "Incrementally update the dataset used for an examples model.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:updateExplanationDataset", + "stop": { + "description": "Stops a NotebookRuntime.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:stop", "httpMethod": "POST", - "id": "aiplatform.projects.locations.models.updateExplanationDataset", + "id": "aiplatform.projects.locations.notebookRuntimes.stop", "parameterOrder": [ - "model" + "name" ], "parameters": { - "model": { - "description": "Required. The resource name of the Model to update. Format: `projects/{project}/locations/{location}/models/{model}`", + "name": { + "description": "Required. The name of the NotebookRuntime resource to be stopped. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+model}:updateExplanationDataset", + "path": "v1beta1/{+name}:stop", "request": { - "$ref": "GoogleCloudAiplatformV1beta1UpdateExplanationDatasetRequest" + "$ref": "GoogleCloudAiplatformV1beta1StopNotebookRuntimeRequest" }, "response": { "$ref": "GoogleLongrunningOperation" @@ -16131,26 +24911,26 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "upload": { - "description": "Uploads a Model artifact into Vertex AI.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models:upload", + "upgrade": { + "description": "Upgrades a NotebookRuntime.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:upgrade", "httpMethod": "POST", - "id": "aiplatform.projects.locations.models.upload", + "id": "aiplatform.projects.locations.notebookRuntimes.upgrade", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "parent": { - "description": "Required. The resource name of the Location into which to upload the Model. Format: `projects/{project}/locations/{location}`", + "name": { + "description": "Required. The name of the NotebookRuntime resource to be upgrade. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/models:upload", + "path": "v1beta1/{+name}:upgrade", "request": { - "$ref": "GoogleCloudAiplatformV1beta1UploadModelRequest" + "$ref": "GoogleCloudAiplatformV1beta1UpgradeNotebookRuntimeRequest" }, "response": { "$ref": "GoogleLongrunningOperation" @@ -16161,379 +24941,13 @@ } }, "resources": { - "evaluations": { - "methods": { - "get": { - "description": "Gets a ModelEvaluation.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.models.evaluations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the ModelEvaluation resource. Format: `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ModelEvaluation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "import": { - "description": "Imports an externally generated ModelEvaluation.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations:import", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.models.evaluations.import", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The name of the parent model resource. Format: `projects/{project}/locations/{location}/models/{model}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/evaluations:import", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1ImportModelEvaluationRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ModelEvaluation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists ModelEvaluations in a Model.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.models.evaluations.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token. Typically obtained via ListModelEvaluationsResponse.next_page_token of the previous ModelService.ListModelEvaluations call.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Model to list the ModelEvaluations from. Format: `projects/{project}/locations/{location}/models/{model}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+parent}/evaluations", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListModelEvaluationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.models.evaluations.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.models.evaluations.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.models.evaluations.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.models.evaluations.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.models.evaluations.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, - "slices": { - "methods": { - "batchImport": { - "description": "Imports a list of externally generated EvaluatedAnnotations.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}:batchImport", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.models.evaluations.slices.batchImport", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The name of the parent ModelEvaluationSlice resource. Format: `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/slices/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}:batchImport", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1BatchImportEvaluatedAnnotationsRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1BatchImportEvaluatedAnnotationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets a ModelEvaluationSlice.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.models.evaluations.slices.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the ModelEvaluationSlice resource. Format: `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/slices/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ModelEvaluationSlice" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists ModelEvaluationSlices in a ModelEvaluation.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.models.evaluations.slices.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "The standard list filter. * `slice.dimension` - for =.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token. Typically obtained via ListModelEvaluationSlicesResponse.next_page_token of the previous ModelService.ListModelEvaluationSlices call.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the ModelEvaluation to list the ModelEvaluationSlices from. Format: `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+parent}/slices", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListModelEvaluationSlicesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - }, "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}:cancel", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.models.operations.cancel", + "id": "aiplatform.projects.locations.notebookRuntimes.operations.cancel", "parameterOrder": [ "name" ], @@ -16541,7 +24955,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -16556,9 +24970,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.models.operations.delete", + "id": "aiplatform.projects.locations.notebookRuntimes.operations.delete", "parameterOrder": [ "name" ], @@ -16566,7 +24980,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -16581,9 +24995,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.models.operations.get", + "id": "aiplatform.projects.locations.notebookRuntimes.operations.get", "parameterOrder": [ "name" ], @@ -16591,7 +25005,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -16606,9 +25020,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.models.operations.list", + "id": "aiplatform.projects.locations.notebookRuntimes.operations.list", "parameterOrder": [ "name" ], @@ -16621,7 +25035,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", "required": true, "type": "string" }, @@ -16652,9 +25066,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}:wait", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.models.operations.wait", + "id": "aiplatform.projects.locations.notebookRuntimes.operations.wait", "parameterOrder": [ "name" ], @@ -16662,7 +25076,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -16685,29 +25099,26 @@ } } }, - "nasJobs": { + "operations": { "methods": { "cancel": { - "description": "Cancels a NasJob. Starts asynchronous cancellation on the NasJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetNasJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the NasJob is not deleted; instead it becomes a job with a NasJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and NasJob.state is set to `CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}:cancel", + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.nasJobs.cancel", + "id": "aiplatform.projects.locations.operations.cancel", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the NasJob to cancel. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`", + "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}:cancel", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1CancelNasJobRequest" - }, "response": { "$ref": "GoogleProtobufEmpty" }, @@ -16715,99 +25126,77 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "create": { - "description": "Creates a NasJob", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.nasJobs.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the NasJob in. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/nasJobs", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1NasJob" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1NasJob" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "delete": { - "description": "Deletes a NasJob.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}", + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.nasJobs.delete", + "id": "aiplatform.projects.locations.operations.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the NasJob resource to be deleted. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`", + "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { - "description": "Gets a NasJob", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}", + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.nasJobs.get", + "id": "aiplatform.projects.locations.operations.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the NasJob resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`", + "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1NasJob" + "$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": { - "description": "Lists NasJobs in a Location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.nasJobs.list", + "id": "aiplatform.projects.locations.operations.list", "parameterOrder": [ - "parent" + "name" ], "parameters": { "filter": { - "description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`", + "description": "The standard list filter.", "location": "query", "type": "string" }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, "pageSize": { "description": "The standard list page size.", "format": "int32", @@ -16815,128 +25204,84 @@ "type": "integer" }, "pageToken": { - "description": "The standard list page token. Typically obtained via ListNasJobsResponse.next_page_token of the previous JobService.ListNasJobs call.", + "description": "The standard list page token.", "location": "query", "type": "string" }, - "parent": { - "description": "Required. The resource name of the Location to list the NasJobs from. Format: `projects/{project}/locations/{location}`", + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", "location": "query", "type": "string" } }, - "path": "v1beta1/{+parent}/nasJobs", + "path": "v1beta1/{+name}:wait", "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListNasJobsResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } - }, - "resources": { - "nasTrialDetails": { - "methods": { - "get": { - "description": "Gets a NasTrialDetail.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails/{nasTrialDetailsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.nasJobs.nasTrialDetails.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the NasTrialDetail resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}/nasTrialDetails/{nas_trial_detail}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+/nasTrialDetails/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1NasTrialDetail" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "List top NasTrialDetails of a NasJob.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.nasJobs.nasTrialDetails.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token. Typically obtained via ListNasTrialDetailsResponse.next_page_token of the previous JobService.ListNasTrialDetails call.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The name of the NasJob resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/nasTrialDetails", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListNasTrialDetailsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } } }, - "notebookExecutionJobs": { + "persistentResources": { "methods": { "create": { - "description": "Creates a NotebookExecutionJob.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs", + "description": "Creates a PersistentResource.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources", "httpMethod": "POST", - "id": "aiplatform.projects.locations.notebookExecutionJobs.create", + "id": "aiplatform.projects.locations.persistentResources.create", "parameterOrder": [ "parent" ], "parameters": { - "notebookExecutionJobId": { - "description": "Optional. User specified ID for the NotebookExecutionJob.", - "location": "query", - "type": "string" - }, "parent": { - "description": "Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}`", + "description": "Required. The resource name of the Location to create the PersistentResource in. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" + }, + "persistentResourceId": { + "description": "Required. The ID to use for the PersistentResource, which become the final component of the PersistentResource's resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.", + "location": "query", + "type": "string" } }, - "path": "v1beta1/{+parent}/notebookExecutionJobs", + "path": "v1beta1/{+parent}/persistentResources", "request": { - "$ref": "GoogleCloudAiplatformV1beta1NotebookExecutionJob" + "$ref": "GoogleCloudAiplatformV1beta1PersistentResource" }, "response": { "$ref": "GoogleLongrunningOperation" @@ -16946,18 +25291,18 @@ ] }, "delete": { - "description": "Deletes a NotebookExecutionJob.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}", + "description": "Deletes a PersistentResource.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.notebookExecutionJobs.delete", + "id": "aiplatform.projects.locations.persistentResources.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the NotebookExecutionJob resource to be deleted.", + "description": "Required. The name of the PersistentResource to be deleted. Format: `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$", "required": true, "type": "string" } @@ -16970,93 +25315,40 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "generateAccessToken": { - "description": "Internal only: Called from Compute Engine instance to obtain EUC for owner Anonymous access: authenticates caller using VM identity JWT. Design doc: go/colab-on-vertex-euc-dd", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}:generateAccessToken", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.notebookExecutionJobs.generateAccessToken", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the resource requesting the OAuth2 token. Format: `projects/{project}/locations/{location}/notebookRuntimes/{notebook_runtime}` `projects/{project}/locations/{location}/notebookExecutionJobs/{notebook_execution_job}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:generateAccessToken", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1GenerateAccessTokenRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1GenerateAccessTokenResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "get": { - "description": "Gets a NotebookExecutionJob.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}", + "description": "Gets a PersistentResource.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.notebookExecutionJobs.get", + "id": "aiplatform.projects.locations.persistentResources.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the NotebookExecutionJob resource.", + "description": "Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$", "required": true, "type": "string" - }, - "view": { - "description": "Optional. The NotebookExecutionJob view. Defaults to BASIC.", - "enum": [ - "NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED", - "NOTEBOOK_EXECUTION_JOB_VIEW_BASIC", - "NOTEBOOK_EXECUTION_JOB_VIEW_FULL" - ], - "enumDescriptions": [ - "When unspecified, the API defaults to the BASIC view.", - "Includes all fields except for direct notebook inputs.", - "Includes all fields." - ], - "location": "query", - "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1NotebookExecutionJob" + "$ref": "GoogleCloudAiplatformV1beta1PersistentResource" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists NotebookExecutionJobs in a Location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs", + "description": "Lists PersistentResources in a Location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources", "httpMethod": "GET", - "id": "aiplatform.projects.locations.notebookExecutionJobs.list", + "id": "aiplatform.projects.locations.persistentResources.list", "parameterOrder": [ "parent" ], "parameters": { - "filter": { - "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookExecutionJob` supports = and !=. `notebookExecutionJob` represents the NotebookExecutionJob ID. * `displayName` supports = and != and regex. * `schedule` supports = and != and regex. Some examples: * `notebookExecutionJob=\"123\"` * `notebookExecutionJob=\"my-execution-job\"` * `displayName=\"myDisplayName\"` and `displayName=~\"myDisplayNameRegex\"`", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.", - "location": "query", - "type": "string" - }, "pageSize": { "description": "Optional. The standard list page size.", "format": "int32", @@ -17064,64 +25356,83 @@ "type": "integer" }, "pageToken": { - "description": "Optional. The standard list page token. Typically obtained via ListNotebookExecutionJobsResponse.next_page_token of the previous NotebookService.ListNotebookExecutionJobs call.", + "description": "Optional. The standard list page token. Typically obtained via ListPersistentResourcesResponse.next_page_token of the previous PersistentResourceService.ListPersistentResource call.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the Location from which to list the NotebookExecutionJobs. Format: `projects/{project}/locations/{location}`", + "description": "Required. The resource name of the Location to list the PersistentResources from. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" + } + }, + "path": "v1beta1/{+parent}/persistentResources", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListPersistentResourcesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a PersistentResource.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.persistentResources.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. Resource name of a PersistentResource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$", + "required": true, + "type": "string" }, - "view": { - "description": "Optional. The NotebookExecutionJob view. Defaults to BASIC.", - "enum": [ - "NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED", - "NOTEBOOK_EXECUTION_JOB_VIEW_BASIC", - "NOTEBOOK_EXECUTION_JOB_VIEW_FULL" - ], - "enumDescriptions": [ - "When unspecified, the API defaults to the BASIC view.", - "Includes all fields except for direct notebook inputs.", - "Includes all fields." - ], + "updateMask": { + "description": "Required. Specify the fields to be overwritten in the PersistentResource by the update method.", + "format": "google-fieldmask", "location": "query", "type": "string" } }, - "path": "v1beta1/{+parent}/notebookExecutionJobs", + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1PersistentResource" + }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListNotebookExecutionJobsResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "reportEvent": { - "description": "", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}:reportEvent", + "reboot": { + "description": "Reboots a PersistentResource.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}:reboot", "httpMethod": "POST", - "id": "aiplatform.projects.locations.notebookExecutionJobs.reportEvent", + "id": "aiplatform.projects.locations.persistentResources.reboot", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the NotebookExecutionJob resource. Format: `projects/{project}/locations/{location}/notebookExecutionJobs/{notebook_execution_jobs}`", + "description": "Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+name}:reportEvent", + "path": "v1beta1/{+name}:reboot", "request": { - "$ref": "GoogleCloudAiplatformV1beta1ReportExecutionEventRequest" + "$ref": "GoogleCloudAiplatformV1beta1RebootPersistentResourceRequest" }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1ReportExecutionEventResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -17133,9 +25444,9 @@ "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:cancel", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.notebookExecutionJobs.operations.cancel", + "id": "aiplatform.projects.locations.persistentResources.operations.cancel", "parameterOrder": [ "name" ], @@ -17143,7 +25454,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -17158,9 +25469,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.notebookExecutionJobs.operations.delete", + "id": "aiplatform.projects.locations.persistentResources.operations.delete", "parameterOrder": [ "name" ], @@ -17168,7 +25479,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -17183,9 +25494,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.notebookExecutionJobs.operations.get", + "id": "aiplatform.projects.locations.persistentResources.operations.get", "parameterOrder": [ "name" ], @@ -17193,7 +25504,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -17208,9 +25519,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.notebookExecutionJobs.operations.list", + "id": "aiplatform.projects.locations.persistentResources.operations.list", "parameterOrder": [ "name" ], @@ -17223,7 +25534,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$", "required": true, "type": "string" }, @@ -17254,9 +25565,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:wait", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.notebookExecutionJobs.operations.wait", + "id": "aiplatform.projects.locations.persistentResources.operations.wait", "parameterOrder": [ "name" ], @@ -17264,7 +25575,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -17287,33 +25598,28 @@ } } }, - "notebookRuntimeTemplates": { + "pipelineJobs": { "methods": { - "create": { - "description": "Creates a NotebookRuntimeTemplate.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates", + "batchCancel": { + "description": "Batch cancel PipelineJobs. Firstly the server will check if all the jobs are in non-terminal states, and skip the jobs that are already terminated. If the operation failed, none of the pipeline jobs are cancelled. The server will poll the states of all the pipeline jobs periodically to check the cancellation status. This operation will return an LRO.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchCancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.notebookRuntimeTemplates.create", + "id": "aiplatform.projects.locations.pipelineJobs.batchCancel", "parameterOrder": [ "parent" ], "parameters": { - "notebookRuntimeTemplateId": { - "description": "Optional. User specified ID for the notebook runtime template.", - "location": "query", - "type": "string" - }, "parent": { - "description": "Required. The resource name of the Location to create the NotebookRuntimeTemplate. Format: `projects/{project}/locations/{location}`", + "description": "Required. The name of the PipelineJobs' parent resource. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/notebookRuntimeTemplates", + "path": "v1beta1/{+parent}/pipelineJobs:batchCancel", "request": { - "$ref": "GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate" + "$ref": "GoogleCloudAiplatformV1beta1BatchCancelPipelineJobsRequest" }, "response": { "$ref": "GoogleLongrunningOperation" @@ -17322,24 +25628,27 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "delete": { - "description": "Deletes a NotebookRuntimeTemplate.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.notebookRuntimeTemplates.delete", + "batchDelete": { + "description": "Batch deletes PipelineJobs The Operation is atomic. If it fails, none of the PipelineJobs are deleted. If it succeeds, all of the PipelineJobs are deleted.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchDelete", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.pipelineJobs.batchDelete", "parameterOrder": [ - "name" + "parent" ], "parameters": { - "name": { - "description": "Required. The name of the NotebookRuntimeTemplate resource to be deleted. Format: `projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}`", + "parent": { + "description": "Required. The name of the PipelineJobs' parent resource. Format: `projects/{project}/locations/{location}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+name}", + "path": "v1beta1/{+parent}/pipelineJobs:batchDelete", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1BatchDeletePipelineJobsRequest" + }, "response": { "$ref": "GoogleLongrunningOperation" }, @@ -17347,202 +25656,164 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "get": { - "description": "Gets a NotebookRuntimeTemplate.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.notebookRuntimeTemplates.get", + "cancel": { + "description": "Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetPipelineJob or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it becomes a pipeline with a PipelineJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and PipelineJob.state is set to `CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.pipelineJobs.cancel", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the NotebookRuntimeTemplate resource. Format: `projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}`", + "description": "Required. The name of the PipelineJob to cancel. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:getIamPolicy", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.notebookRuntimeTemplates.getIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "options.requestedPolicyVersion": { - "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", - "format": "int32", - "location": "query", - "type": "integer" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$", - "required": true, - "type": "string" - } + "path": "v1beta1/{+name}:cancel", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1CancelPipelineJobRequest" }, - "path": "v1beta1/{+resource}:getIamPolicy", "response": { - "$ref": "GoogleIamV1Policy" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "list": { - "description": "Lists NotebookRuntimeTemplates in a Location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.notebookRuntimeTemplates.list", + "create": { + "description": "Creates a PipelineJob. A PipelineJob will run immediately when created.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.pipelineJobs.create", "parameterOrder": [ "parent" ], "parameters": { - "filter": { - "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntimeTemplate=notebookRuntimeTemplate123` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4`", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The standard list page token. Typically obtained via ListNotebookRuntimeTemplatesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimeTemplates call.", - "location": "query", - "type": "string" - }, "parent": { - "description": "Required. The resource name of the Location from which to list the NotebookRuntimeTemplates. Format: `projects/{project}/locations/{location}`", + "description": "Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, - "readMask": { - "description": "Optional. Mask specifying which fields to read.", - "format": "google-fieldmask", + "pipelineJobId": { + "description": "The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/a-z-/`.", "location": "query", "type": "string" } }, - "path": "v1beta1/{+parent}/notebookRuntimeTemplates", + "path": "v1beta1/{+parent}/pipelineJobs", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1PipelineJob" + }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListNotebookRuntimeTemplatesResponse" + "$ref": "GoogleCloudAiplatformV1beta1PipelineJob" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "patch": { - "description": "Updates a NotebookRuntimeTemplate.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.notebookRuntimeTemplates.patch", + "delete": { + "description": "Deletes a PipelineJob.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.pipelineJobs.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "The resource name of the NotebookRuntimeTemplate.", + "description": "Required. The name of the PipelineJob resource to be deleted. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$", "required": true, "type": "string" - }, - "updateMask": { - "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Input format: `{paths: \"${updated_filed}\"}` Updatable fields: * `encryption_spec.kms_key_name`", - "format": "google-fieldmask", - "location": "query", - "type": "string" } }, "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate" - }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:setIamPolicy", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.notebookRuntimeTemplates.setIamPolicy", + "get": { + "description": "Gets a PipelineJob.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.pipelineJobs.get", "parameterOrder": [ - "resource" + "name" ], "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "name": { + "description": "Required. The name of the PipelineJob resource. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+resource}:setIamPolicy", - "request": { - "$ref": "GoogleIamV1SetIamPolicyRequest" - }, + "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleIamV1Policy" + "$ref": "GoogleCloudAiplatformV1beta1PipelineJob" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:testIamPermissions", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.notebookRuntimeTemplates.testIamPermissions", + }, + "list": { + "description": "Lists PipelineJobs in a Location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.pipelineJobs.list", "parameterOrder": [ - "resource" + "parent" ], "parameters": { - "permissions": { - "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", + "filter": { + "description": "Lists the PipelineJobs that match the filter expression. The following fields are supported: * `pipeline_name`: Supports `=` and `!=` comparisons. * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `pipeline_job_user_id`: Supports `=`, `!=` comparisons, and `:` wildcard. for example, can check if pipeline's display_name contains *step* by doing display_name:\\\"*step*\\\" * `state`: Supports `=` and `!=` comparisons. * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. * `template_uri`: Supports `=`, `!=` comparisons, and `:` wildcard. * `template_metadata.version`: Supports `=`, `!=` comparisons, and `:` wildcard. Filter expressions can be combined together using logical operators (`AND` & `OR`). For example: `pipeline_name=\"test\" AND create_time>\"2020-05-18T13:30:00Z\"`. The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `create_time>\"2021-05-18T00:00:00Z\" OR update_time>\"2020-05-18T00:00:00Z\"` PipelineJobs created or updated after 2020-05-18 00:00:00 UTC. * `labels.env = \"prod\"` PipelineJobs with label \"env\" set to \"prod\".", "location": "query", - "repeated": true, "type": "string" }, - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "orderBy": { + "description": "A comma-separated list of fields to order by. The default sort order is in ascending order. Use \"desc\" after a field name for descending. You can have multiple order_by fields provided e.g. \"create_time desc, end_time\", \"end_time, start_time, update_time\" For example, using \"create_time desc, end_time\" will order results by create time in descending order, and if there are multiple jobs having the same create time, order them by the end time in ascending order. if order_by is not specified, it will order by default order is create time in descending order. Supported fields: * `create_time` * `update_time` * `end_time` * `start_time`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token. Typically obtained via ListPipelineJobsResponse.next_page_token of the previous PipelineService.ListPipelineJobs call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list the PipelineJobs from. Format: `projects/{project}/locations/{location}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, - "path": "v1beta1/{+resource}:testIamPermissions", + "path": "v1beta1/{+parent}/pipelineJobs", "response": { - "$ref": "GoogleIamV1TestIamPermissionsResponse" + "$ref": "GoogleCloudAiplatformV1beta1ListPipelineJobsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -17554,9 +25825,9 @@ "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:cancel", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.cancel", + "id": "aiplatform.projects.locations.pipelineJobs.operations.cancel", "parameterOrder": [ "name" ], @@ -17564,7 +25835,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -17579,9 +25850,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.delete", + "id": "aiplatform.projects.locations.pipelineJobs.operations.delete", "parameterOrder": [ "name" ], @@ -17589,7 +25860,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -17604,9 +25875,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.get", + "id": "aiplatform.projects.locations.pipelineJobs.operations.get", "parameterOrder": [ "name" ], @@ -17614,7 +25885,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -17629,9 +25900,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.list", + "id": "aiplatform.projects.locations.pipelineJobs.operations.list", "parameterOrder": [ "name" ], @@ -17644,7 +25915,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$", "required": true, "type": "string" }, @@ -17675,9 +25946,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:wait", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.wait", + "id": "aiplatform.projects.locations.pipelineJobs.operations.wait", "parameterOrder": [ "name" ], @@ -17685,7 +25956,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -17696,40 +25967,486 @@ "type": "string" } }, - "path": "v1beta1/{+name}:wait", + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "publishers": { + "resources": { + "models": { + "methods": { + "computeTokens": { + "description": "Return a list of tokens based on the input text.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:computeTokens", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.publishers.models.computeTokens", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}:computeTokens", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1ComputeTokensRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ComputeTokensResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "countTokens": { + "description": "Perform a token counting.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:countTokens", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.publishers.models.countTokens", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}:countTokens", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1CountTokensRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1CountTokensResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "embedContent": { + "description": "Embed content with multimodal inputs.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:embedContent", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.publishers.models.embedContent", + "parameterOrder": [ + "model" + ], + "parameters": { + "model": { + "description": "Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+model}:embedContent", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1EmbedContentRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1EmbedContentResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "export": { + "description": "Exports a publisher model to a user provided Google Cloud Storage bucket.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:export", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.publishers.models.export", + "parameterOrder": [ + "parent", + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}@{version_id}`, or `publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001`", + "location": "path", + "pattern": "^publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + }, + "parent": { + "description": "Required. The Location to export the model weights from Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/{+name}:export", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1ExportPublisherModelRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "fetchPredictOperation": { + "description": "Fetch an asynchronous online prediction operation.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:fetchPredictOperation", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.publishers.models.fetchPredictOperation", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}:fetchPredictOperation", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1FetchPredictOperationRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "fetchPublisherModelConfig": { + "description": "Fetches the configs of publisher models.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:fetchPublisherModelConfig", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.publishers.models.fetchPublisherModelConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the publisher model, in the format of `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:fetchPublisherModelConfig", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1PublisherModelConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "generateContent": { + "description": "Generate content with multimodal inputs.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:generateContent", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.publishers.models.generateContent", + "parameterOrder": [ + "model" + ], + "parameters": { + "model": { + "description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+model}:generateContent", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:getIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.publishers.models.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:getIamPolicy", + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "predict": { + "description": "Perform an online prediction.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:predict", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.publishers.models.predict", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}:predict", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1PredictRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1PredictResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "predictLongRunning": { + "description": "", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:predictLongRunning", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.publishers.models.predictLongRunning", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}:predictLongRunning", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1PredictLongRunningRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "rawPredict": { + "description": "Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's DeployedModel that served this prediction.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:rawPredict", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.publishers.models.rawPredict", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}:rawPredict", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1RawPredictRequest" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "serverStreamingPredict": { + "description": "Perform a server-side streaming online prediction request for Vertex LLM streaming.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:serverStreamingPredict", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.publishers.models.serverStreamingPredict", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}:serverStreamingPredict", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1StreamingPredictRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1StreamingPredictResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "setPublisherModelConfig": { + "description": "Sets (creates or updates) configs of publisher models. For example, sets the request/response logging config.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:setPublisherModelConfig", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.publishers.models.setPublisherModelConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the publisher model, in the format of `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:setPublisherModelConfig", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1SetPublisherModelConfigRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "streamGenerateContent": { + "description": "Generate content with multimodal inputs with streaming support.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamGenerateContent", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.publishers.models.streamGenerateContent", + "parameterOrder": [ + "model" + ], + "parameters": { + "model": { + "description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+model}:streamGenerateContent", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "streamRawPredict": { + "description": "Perform a streaming online prediction with an arbitrary HTTP payload.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamRawPredict", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.publishers.models.streamRawPredict", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}:streamRawPredict", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1StreamRawPredictRequest" + }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleApiHttpBody" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" ] } } } } }, - "notebookRuntimes": { + "ragCorpora": { "methods": { - "assign": { - "description": "Assigns a NotebookRuntime to a user for a particular Notebook file. This method will either returns an existing assignment or generates a new one.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes:assign", + "create": { + "description": "Creates a RagCorpus.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora", "httpMethod": "POST", - "id": "aiplatform.projects.locations.notebookRuntimes.assign", + "id": "aiplatform.projects.locations.ragCorpora.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { - "description": "Required. The resource name of the Location to get the NotebookRuntime assignment. Format: `projects/{project}/locations/{location}`", + "description": "Required. The resource name of the Location to create the RagCorpus in. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/notebookRuntimes:assign", + "path": "v1beta1/{+parent}/ragCorpora", "request": { - "$ref": "GoogleCloudAiplatformV1beta1AssignNotebookRuntimeRequest" + "$ref": "GoogleCloudAiplatformV1beta1RagCorpus" }, "response": { "$ref": "GoogleLongrunningOperation" @@ -17739,18 +26456,23 @@ ] }, "delete": { - "description": "Deletes a NotebookRuntime.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}", + "description": "Deletes a RagCorpus.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.notebookRuntimes.delete", + "id": "aiplatform.projects.locations.ragCorpora.delete", "parameterOrder": [ "name" ], "parameters": { + "force": { + "description": "Optional. If set to true, any RagFiles in this RagCorpus will also be deleted. Otherwise, the request will only work if the RagCorpus has no RagFiles.", + "location": "query", + "type": "boolean" + }, "name": { - "description": "Required. The name of the NotebookRuntime resource to be deleted. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.", + "description": "Required. The name of the RagCorpus resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", "required": true, "type": "string" } @@ -17763,78 +26485,40 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "generateAccessToken": { - "description": "Internal only: Called from Compute Engine instance to obtain EUC for owner Anonymous access: authenticates caller using VM identity JWT. Design doc: go/colab-on-vertex-euc-dd", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:generateAccessToken", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.notebookRuntimes.generateAccessToken", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the resource requesting the OAuth2 token. Format: `projects/{project}/locations/{location}/notebookRuntimes/{notebook_runtime}` `projects/{project}/locations/{location}/notebookExecutionJobs/{notebook_execution_job}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:generateAccessToken", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1GenerateAccessTokenRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1GenerateAccessTokenResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "get": { - "description": "Gets a NotebookRuntime.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}", + "description": "Gets a RagCorpus.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.notebookRuntimes.get", + "id": "aiplatform.projects.locations.ragCorpora.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the NotebookRuntime resource. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.", + "description": "Required. The name of the RagCorpus resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1NotebookRuntime" + "$ref": "GoogleCloudAiplatformV1beta1RagCorpus" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists NotebookRuntimes in a Location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes", + "description": "Lists RagCorpora in a Location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora", "httpMethod": "GET", - "id": "aiplatform.projects.locations.notebookRuntimes.list", + "id": "aiplatform.projects.locations.ragCorpora.list", "parameterOrder": [ "parent" ], "parameters": { - "filter": { - "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED, ERROR, INVALID]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntime=\"notebookRuntime123\"` * `displayName=\"myDisplayName\"` and `displayName=~\"myDisplayNameRegex\"` * `notebookRuntimeTemplate=\"notebookRuntimeTemplate321\"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser=\"test@google.com\"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4`", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.", - "location": "query", - "type": "string" - }, "pageSize": { "description": "Optional. The standard list page size.", "format": "int32", @@ -17842,136 +26526,46 @@ "type": "integer" }, "pageToken": { - "description": "Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimes call.", + "description": "Optional. The standard list page token. Typically obtained via ListRagCorporaResponse.next_page_token of the previous VertexRagDataService.ListRagCorpora call.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the Location from which to list the NotebookRuntimes. Format: `projects/{project}/locations/{location}`", + "description": "Required. The resource name of the Location from which to list the RagCorpora. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" - }, - "readMask": { - "description": "Optional. Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+parent}/notebookRuntimes", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListNotebookRuntimesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "reportEvent": { - "description": "", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:reportEvent", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.notebookRuntimes.reportEvent", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the NotebookRuntime resource. Format: `projects/{project}/locations/{location}/notebookRuntimes/{notebook_runtime}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:reportEvent", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1ReportRuntimeEventRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ReportRuntimeEventResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "start": { - "description": "Starts a NotebookRuntime.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:start", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.notebookRuntimes.start", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the NotebookRuntime resource to be started. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:start", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1StartNotebookRuntimeRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "stop": { - "description": "Stops a NotebookRuntime.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:stop", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.notebookRuntimes.stop", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the NotebookRuntime resource to be stopped. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", - "required": true, - "type": "string" } }, - "path": "v1beta1/{+name}:stop", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1StopNotebookRuntimeRequest" - }, + "path": "v1beta1/{+parent}/ragCorpora", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1beta1ListRagCorporaResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "upgrade": { - "description": "Upgrades a NotebookRuntime.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:upgrade", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.notebookRuntimes.upgrade", + "patch": { + "description": "Updates a RagCorpus.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.ragCorpora.patch", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the NotebookRuntime resource to be upgrade. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.", + "description": "Output only. The resource name of the RagCorpus.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+name}:upgrade", + "path": "v1beta1/{+name}", "request": { - "$ref": "GoogleCloudAiplatformV1beta1UpgradeNotebookRuntimeRequest" + "$ref": "GoogleCloudAiplatformV1beta1RagCorpus" }, "response": { "$ref": "GoogleLongrunningOperation" @@ -17986,9 +26580,9 @@ "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:cancel", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.notebookRuntimes.operations.cancel", + "id": "aiplatform.projects.locations.ragCorpora.operations.cancel", "parameterOrder": [ "name" ], @@ -17996,7 +26590,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -18011,9 +26605,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.notebookRuntimes.operations.delete", + "id": "aiplatform.projects.locations.ragCorpora.operations.delete", "parameterOrder": [ "name" ], @@ -18021,7 +26615,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -18036,9 +26630,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.notebookRuntimes.operations.get", + "id": "aiplatform.projects.locations.ragCorpora.operations.get", "parameterOrder": [ "name" ], @@ -18046,7 +26640,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -18061,9 +26655,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.notebookRuntimes.operations.list", + "id": "aiplatform.projects.locations.ragCorpora.operations.list", "parameterOrder": [ "name" ], @@ -18076,7 +26670,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", "required": true, "type": "string" }, @@ -18107,9 +26701,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:wait", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.notebookRuntimes.operations.wait", + "id": "aiplatform.projects.locations.ragCorpora.operations.wait", "parameterOrder": [ "name" ], @@ -18117,7 +26711,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -18136,358 +26730,300 @@ "https://www.googleapis.com/auth/cloud-platform" ] } - } - } - } - }, - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, - "persistentResources": { - "methods": { - "create": { - "description": "Creates a PersistentResource.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.persistentResources.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the PersistentResource in. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - }, - "persistentResourceId": { - "description": "Required. The ID to use for the PersistentResource, which become the final component of the PersistentResource's resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+parent}/persistentResources", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1PersistentResource" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a PersistentResource.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.persistentResources.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the PersistentResource to be deleted. Format: `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets a PersistentResource.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.persistentResources.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1PersistentResource" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists PersistentResources in a Location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.persistentResources.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "Optional. The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The standard list page token. Typically obtained via ListPersistentResourcesResponse.next_page_token of the previous PersistentResourceService.ListPersistentResource call.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Location to list the PersistentResources from. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/persistentResources", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListPersistentResourcesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + } }, - "patch": { - "description": "Updates a PersistentResource.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.persistentResources.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Immutable. Resource name of a PersistentResource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$", - "required": true, - "type": "string" + "ragFiles": { + "methods": { + "delete": { + "description": "Deletes a RagFile.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.ragCorpora.ragFiles.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "forceDelete": { + "description": "Optional. If set to true, any errors generated by external vector database during the deletion will be ignored. The default value is false.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the RagFile resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "updateMask": { - "description": "Required. Specify the fields to be overwritten in the PersistentResource by the update method.", - "format": "google-fieldmask", - "location": "query", - "type": "string" + "get": { + "description": "Gets a RagFile.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.ragCorpora.ragFiles.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the RagFile resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1RagFile" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "import": { + "description": "Import files from Google Cloud Storage or Google Drive into a RagCorpus.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles:import", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.ragCorpora.ragFiles.import", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the RagCorpus resource into which to import files. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/ragFiles:import", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1ImportRagFilesRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists RagFiles in a RagCorpus.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.ragCorpora.ragFiles.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token. Typically obtained via ListRagFilesResponse.next_page_token of the previous VertexRagDataService.ListRagFiles call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the RagCorpus from which to list the RagFiles. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/ragFiles", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListRagFilesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1PersistentResource" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "reboot": { - "description": "Reboots a PersistentResource.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}:reboot", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.persistentResources.reboot", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$", - "required": true, - "type": "string" + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } - }, - "path": "v1beta1/{+name}:reboot", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1RebootPersistentResourceRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + } } - }, + } + }, + "ragEngineConfig": { "resources": { "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:cancel", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.persistentResources.operations.cancel", + "id": "aiplatform.projects.locations.ragEngineConfig.operations.cancel", "parameterOrder": [ "name" ], @@ -18495,7 +27031,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$", "required": true, "type": "string" } @@ -18510,9 +27046,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.persistentResources.operations.delete", + "id": "aiplatform.projects.locations.ragEngineConfig.operations.delete", "parameterOrder": [ "name" ], @@ -18520,7 +27056,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$", "required": true, "type": "string" } @@ -18535,9 +27071,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.persistentResources.operations.get", + "id": "aiplatform.projects.locations.ragEngineConfig.operations.get", "parameterOrder": [ "name" ], @@ -18545,7 +27081,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$", "required": true, "type": "string" } @@ -18560,9 +27096,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.persistentResources.operations.list", + "id": "aiplatform.projects.locations.ragEngineConfig.operations.list", "parameterOrder": [ "name" ], @@ -18575,7 +27111,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig$", "required": true, "type": "string" }, @@ -18606,9 +27142,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:wait", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.persistentResources.operations.wait", + "id": "aiplatform.projects.locations.ragEngineConfig.operations.wait", "parameterOrder": [ "name" ], @@ -18616,7 +27152,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$", "required": true, "type": "string" }, @@ -18639,28 +27175,28 @@ } } }, - "pipelineJobs": { + "reasoningEngines": { "methods": { - "batchCancel": { - "description": "Batch cancel PipelineJobs. Firstly the server will check if all the jobs are in non-terminal states, and skip the jobs that are already terminated. If the operation failed, none of the pipeline jobs are cancelled. The server will poll the states of all the pipeline jobs periodically to check the cancellation status. This operation will return an LRO.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchCancel", + "create": { + "description": "Creates a reasoning engine.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines", "httpMethod": "POST", - "id": "aiplatform.projects.locations.pipelineJobs.batchCancel", + "id": "aiplatform.projects.locations.reasoningEngines.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { - "description": "Required. The name of the PipelineJobs' parent resource. Format: `projects/{project}/locations/{location}`", + "description": "Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/pipelineJobs:batchCancel", + "path": "v1beta1/{+parent}/reasoningEngines", "request": { - "$ref": "GoogleCloudAiplatformV1beta1BatchCancelPipelineJobsRequest" + "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngine" }, "response": { "$ref": "GoogleLongrunningOperation" @@ -18669,27 +27205,29 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "batchDelete": { - "description": "Batch deletes PipelineJobs The Operation is atomic. If it fails, none of the PipelineJobs are deleted. If it succeeds, all of the PipelineJobs are deleted.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchDelete", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.pipelineJobs.batchDelete", + "delete": { + "description": "Deletes a reasoning engine.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.reasoningEngines.delete", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "parent": { - "description": "Required. The name of the PipelineJobs' parent resource. Format: `projects/{project}/locations/{location}`", + "force": { + "description": "Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/pipelineJobs:batchDelete", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1BatchDeletePipelineJobsRequest" - }, + "path": "v1beta1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, @@ -18697,418 +27235,867 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "cancel": { - "description": "Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetPipelineJob or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it becomes a pipeline with a PipelineJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and PipelineJob.state is set to `CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.pipelineJobs.cancel", + "get": { + "description": "Gets a reasoning engine.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the PipelineJob to cancel. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`", + "description": "Required. The name of the ReasoningEngine resource. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+name}:cancel", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1CancelPipelineJobRequest" - }, + "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngine" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "create": { - "description": "Creates a PipelineJob. A PipelineJob will run immediately when created.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.pipelineJobs.create", + "list": { + "description": "Lists reasoning engines in a location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.list", "parameterOrder": [ "parent" ], "parameters": { + "filter": { + "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token.", + "location": "query", + "type": "string" + }, "parent": { - "description": "Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project}/locations/{location}`", + "description": "Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" + } + }, + "path": "v1beta1/{+parent}/reasoningEngines", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListReasoningEnginesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a reasoning engine.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.reasoningEngines.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" }, - "pipelineJobId": { - "description": "The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/a-z-/`.", + "updateMask": { + "description": "Optional. Mask specifying which fields to update.", + "format": "google-fieldmask", "location": "query", "type": "string" } }, - "path": "v1beta1/{+parent}/pipelineJobs", + "path": "v1beta1/{+name}", "request": { - "$ref": "GoogleCloudAiplatformV1beta1PipelineJob" + "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngine" }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1PipelineJob" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a PipelineJob.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.pipelineJobs.delete", + ] + }, + "query": { + "description": "Queries using a reasoning engine.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:query", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.query", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the PipelineJob resource to be deleted. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`", + "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+name}", + "path": "v1beta1/{+name}:query", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1QueryReasoningEngineRequest" + }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1beta1QueryReasoningEngineResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "get": { - "description": "Gets a PipelineJob.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.pipelineJobs.get", + "streamQuery": { + "description": "Streams queries using a reasoning engine.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:streamQuery", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.streamQuery", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the PipelineJob resource. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`", + "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+name}", + "path": "v1beta1/{+name}:streamQuery", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1StreamQueryReasoningEngineRequest" + }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1PipelineJob" + "$ref": "GoogleApiHttpBody" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + } + }, + "resources": { + "a2a": { + "resources": { + "v1": { + "methods": { + "card": { + "description": "Get request for reasoning engine instance via the A2A get protocol apis.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/card", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.card", + "parameterOrder": [ + "name", + "a2aEndpoint" + ], + "parameters": { + "a2aEndpoint": { + "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", + "location": "path", + "pattern": "^v1/card$", + "required": true, + "type": "string" + }, + "historyLength": { + "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", + "response": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "message": { + "methods": { + "send": { + "description": "Send post request for reasoning engine instance via the A2A post protocol apis.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/message:send", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.message.send", + "parameterOrder": [ + "name", + "a2aEndpoint" + ], + "parameters": { + "a2aEndpoint": { + "description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send", + "location": "path", + "pattern": "^v1/message$", + "required": true, + "type": "string" + }, + "name": { + "description": "Required. The full resource path of the reasoning engine, captured from the URL.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:send", + "request": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "stream": { + "description": "Streams queries using a reasoning engine instance via the A2A streaming protocol apis.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/message:stream", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.message.stream", + "parameterOrder": [ + "name", + "a2aEndpoint" + ], + "parameters": { + "a2aEndpoint": { + "description": "Required. The http endpoint extracted from the URL path. e.g., v1/message:stream.", + "location": "path", + "pattern": "^v1/message$", + "required": true, + "type": "string" + }, + "name": { + "description": "Required. The full resource path of the reasoning engine, captured from the URL.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:stream", + "request": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "tasks": { + "methods": { + "a2aGetReasoningEngine": { + "description": "Get request for reasoning engine instance via the A2A get protocol apis.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.tasks.a2aGetReasoningEngine", + "parameterOrder": [ + "name", + "a2aEndpoint" + ], + "parameters": { + "a2aEndpoint": { + "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", + "location": "path", + "pattern": "^v1/tasks/[^/]+$", + "required": true, + "type": "string" + }, + "historyLength": { + "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", + "response": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "cancel": { + "description": "Send post request for reasoning engine instance via the A2A post protocol apis.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.tasks.cancel", + "parameterOrder": [ + "name", + "a2aEndpoint" + ], + "parameters": { + "a2aEndpoint": { + "description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send", + "location": "path", + "pattern": "^v1/tasks/[^/]+$", + "required": true, + "type": "string" + }, + "name": { + "description": "Required. The full resource path of the reasoning engine, captured from the URL.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:cancel", + "request": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "pushNotificationConfigs": { + "description": "Get request for reasoning engine instance via the A2A get protocol apis.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs", + "parameterOrder": [ + "name", + "a2aEndpoint" + ], + "parameters": { + "a2aEndpoint": { + "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", + "location": "path", + "pattern": "^v1/tasks/[^/]+/pushNotificationConfigs$", + "required": true, + "type": "string" + }, + "historyLength": { + "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", + "response": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "subscribe": { + "description": "Stream get request for reasoning engine instance via the A2A stream get protocol apis.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}:subscribe", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.tasks.subscribe", + "parameterOrder": [ + "name", + "a2aEndpoint" + ], + "parameters": { + "a2aEndpoint": { + "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123:subscribe`.", + "location": "path", + "pattern": "^v1/tasks/[^/]+$", + "required": true, + "type": "string" + }, + "name": { + "description": "Required. The full resource path of the reasoning engine, captured from the URL.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:subscribe", + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "pushNotificationConfigs": { + "methods": { + "a2aGetReasoningEngine": { + "description": "Get request for reasoning engine instance via the A2A get protocol apis.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs.a2aGetReasoningEngine", + "parameterOrder": [ + "name", + "a2aEndpoint" + ], + "parameters": { + "a2aEndpoint": { + "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", + "location": "path", + "pattern": "^v1/tasks/[^/]+/pushNotificationConfigs/[^/]+$", + "required": true, + "type": "string" + }, + "historyLength": { + "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", + "response": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + } }, - "list": { - "description": "Lists PipelineJobs in a Location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.pipelineJobs.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Lists the PipelineJobs that match the filter expression. The following fields are supported: * `pipeline_name`: Supports `=` and `!=` comparisons. * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `pipeline_job_user_id`: Supports `=`, `!=` comparisons, and `:` wildcard. for example, can check if pipeline's display_name contains *step* by doing display_name:\\\"*step*\\\" * `state`: Supports `=` and `!=` comparisons. * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. * `template_uri`: Supports `=`, `!=` comparisons, and `:` wildcard. * `template_metadata.version`: Supports `=`, `!=` comparisons, and `:` wildcard. Filter expressions can be combined together using logical operators (`AND` & `OR`). For example: `pipeline_name=\"test\" AND create_time>\"2020-05-18T13:30:00Z\"`. The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `create_time>\"2021-05-18T00:00:00Z\" OR update_time>\"2020-05-18T00:00:00Z\"` PipelineJobs created or updated after 2020-05-18 00:00:00 UTC. * `labels.env = \"prod\"` PipelineJobs with label \"env\" set to \"prod\".", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "A comma-separated list of fields to order by. The default sort order is in ascending order. Use \"desc\" after a field name for descending. You can have multiple order_by fields provided e.g. \"create_time desc, end_time\", \"end_time, start_time, update_time\" For example, using \"create_time desc, end_time\" will order results by create time in descending order, and if there are multiple jobs having the same create time, order them by the end time in ascending order. if order_by is not specified, it will order by default order is create time in descending order. Supported fields: * `create_time` * `update_time` * `end_time` * `start_time`", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token. Typically obtained via ListPipelineJobsResponse.next_page_token of the previous PipelineService.ListPipelineJobs call.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Location to list the PipelineJobs from. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" + "examples": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.examples.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.reasoningEngines.examples.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.examples.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.examples.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } - }, - "path": "v1beta1/{+parent}/pipelineJobs", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListPipelineJobsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "operations": { + } + }, + "memories": { "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:cancel", + "create": { + "description": "Create a Memory.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories", "httpMethod": "POST", - "id": "aiplatform.projects.locations.pipelineJobs.operations.cancel", + "id": "aiplatform.projects.locations.reasoningEngines.memories.create", "parameterOrder": [ - "name" + "parent" ], "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", + "parent": { + "description": "Required. The resource name of the ReasoningEngine to create the Memory under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+name}:cancel", + "path": "v1beta1/{+parent}/memories", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Memory" + }, "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}", + "description": "Delete a Memory.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.pipelineJobs.operations.delete", + "id": "aiplatform.projects.locations.reasoningEngines.memories.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", + "description": "Required. The resource name of the Memory to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "generate": { + "description": "Generate memories.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories:generate", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.memories.generate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the ReasoningEngine to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/memories:generate", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1GenerateMemoriesRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}", + "description": "Get a Memory.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.pipelineJobs.operations.get", + "id": "aiplatform.projects.locations.reasoningEngines.memories.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "The name of the operation resource.", + "description": "Required. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1beta1Memory" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations", + "description": "List Memories.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories", "httpMethod": "GET", - "id": "aiplatform.projects.locations.pipelineJobs.operations.list", + "id": "aiplatform.projects.locations.reasoningEngines.memories.list", "parameterOrder": [ - "name" + "parent" ], "parameters": { "filter": { - "description": "The standard list filter.", + "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `scope` (as a JSON string)", "location": "query", "type": "string" }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$", - "required": true, + "orderBy": { + "description": "Optional. The standard list order by string. If not specified, the default order is `create_time desc`. If specified, the default sorting order of provided fields is ascending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time`", + "location": "query", "type": "string" }, "pageSize": { - "description": "The standard list page size.", + "description": "Optional. The standard list page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "The standard list page token.", + "description": "Optional. The standard list page token.", "location": "query", "type": "string" }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" + "parent": { + "description": "Required. The resource name of the ReasoningEngine to list the Memories under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" } }, - "path": "v1beta1/{+name}/operations", + "path": "v1beta1/{+parent}/memories", "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleCloudAiplatformV1beta1ListMemoriesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.pipelineJobs.operations.wait", + "patch": { + "description": "Update a Memory.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.reasoningEngines.memories.patch", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "The name of the operation resource to wait on.", + "description": "Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+$", "required": true, "type": "string" }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", + "updateMask": { + "description": "Optional. Mask specifying which fields to update. Supported fields: * `display_name` * `description` * `fact`", + "format": "google-fieldmask", "location": "query", "type": "string" } }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - }, - "publishers": { - "resources": { - "models": { - "methods": { - "computeTokens": { - "description": "Return a list of tokens based on the input text.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:computeTokens", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.publishers.models.computeTokens", - "parameterOrder": [ - "endpoint" - ], - "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+endpoint}:computeTokens", + "path": "v1beta1/{+name}", "request": { - "$ref": "GoogleCloudAiplatformV1beta1ComputeTokensRequest" + "$ref": "GoogleCloudAiplatformV1beta1Memory" }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1ComputeTokensResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "countTokens": { - "description": "Perform a token counting.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:countTokens", + "retrieve": { + "description": "Retrieve memories.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories:retrieve", "httpMethod": "POST", - "id": "aiplatform.projects.locations.publishers.models.countTokens", + "id": "aiplatform.projects.locations.reasoningEngines.memories.retrieve", "parameterOrder": [ - "endpoint" + "parent" ], "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "parent": { + "description": "Required. The resource name of the ReasoningEngine to retrieve memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+endpoint}:countTokens", + "path": "v1beta1/{+parent}/memories:retrieve", "request": { - "$ref": "GoogleCloudAiplatformV1beta1CountTokensRequest" + "$ref": "GoogleCloudAiplatformV1beta1RetrieveMemoriesRequest" }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1CountTokensResponse" + "$ref": "GoogleCloudAiplatformV1beta1RetrieveMemoriesResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" + "https://www.googleapis.com/auth/cloud-platform" ] }, - "export": { - "description": "Exports a publisher model to a user provided Google Cloud Storage bucket.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:export", + "rollback": { + "description": "Rollback Memory to a specific revision.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}:rollback", "httpMethod": "POST", - "id": "aiplatform.projects.locations.publishers.models.export", + "id": "aiplatform.projects.locations.reasoningEngines.memories.rollback", "parameterOrder": [ - "parent", "name" ], "parameters": { "name": { - "description": "Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}@{version_id}`, or `publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001`", - "location": "path", - "pattern": "^publishers/[^/]+/models/[^/]+$", - "required": true, - "type": "string" - }, - "parent": { - "description": "Required. The Location to export the model weights from Format: `projects/{project}/locations/{location}`", + "description": "Required. The resource name of the Memory to rollback. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/{+name}:export", + "path": "v1beta1/{+name}:rollback", "request": { - "$ref": "GoogleCloudAiplatformV1beta1ExportPublisherModelRequest" + "$ref": "GoogleCloudAiplatformV1beta1RollbackMemoryRequest" }, "response": { "$ref": "GoogleLongrunningOperation" @@ -19116,543 +28103,773 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "fetchPredictOperation": { - "description": "Fetch an asynchronous online prediction operation.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:fetchPredictOperation", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.publishers.models.fetchPredictOperation", - "parameterOrder": [ - "endpoint" - ], - "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", - "required": true, - "type": "string" + } + }, + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.memories.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.reasoningEngines.memories.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.memories.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.memories.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.memories.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } - }, - "path": "v1beta1/{+endpoint}:fetchPredictOperation", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1FetchPredictOperationRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] + } }, - "fetchPublisherModelConfig": { - "description": "Fetches the configs of publisher models.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:fetchPublisherModelConfig", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.publishers.models.fetchPublisherModelConfig", + "revisions": { + "methods": { + "get": { + "description": "Get a Memory Revision.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/revisions/{revisionsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.memories.revisions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Memory Revision to retrieve. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{revision}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+/revisions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1MemoryRevision" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List Memory Revisions for a Memory.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/revisions", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.memories.revisions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `labels`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Memory to list revisions for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/revisions", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListMemoryRevisionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.operations.cancel", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the publisher model, in the format of `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`.", + "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+name}:fetchPublisherModelConfig", + "path": "v1beta1/{+name}:cancel", "response": { - "$ref": "GoogleCloudAiplatformV1beta1PublisherModelConfig" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "generateContent": { - "description": "Generate content with multimodal inputs.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:generateContent", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.publishers.models.generateContent", + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.reasoningEngines.operations.delete", "parameterOrder": [ - "model" + "name" ], "parameters": { - "model": { - "description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "name": { + "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+model}:generateContent", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest" - }, + "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse" + "$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" ] }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:getIamPolicy", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.publishers.models.getIamPolicy", + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.operations.get", "parameterOrder": [ - "resource" + "name" ], "parameters": { - "options.requestedPolicyVersion": { - "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", - "format": "int32", - "location": "query", - "type": "integer" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "name": { + "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+resource}:getIamPolicy", + "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleIamV1Policy" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "predict": { - "description": "Perform an online prediction.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:predict", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.publishers.models.predict", + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.operations.list", "parameterOrder": [ - "endpoint" + "name" ], "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, - "path": "v1beta1/{+endpoint}:predict", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1PredictRequest" - }, + "path": "v1beta1/{+name}/operations", "response": { - "$ref": "GoogleCloudAiplatformV1beta1PredictResponse" + "$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" ] }, - "predictLongRunning": { - "description": "", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:predictLongRunning", + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.publishers.models.predictLongRunning", + "id": "aiplatform.projects.locations.reasoningEngines.operations.wait", "parameterOrder": [ - "endpoint" + "name" ], "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`", + "name": { + "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$", "required": true, "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" } }, - "path": "v1beta1/{+endpoint}:predictLongRunning", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1PredictLongRunningRequest" - }, + "path": "v1beta1/{+name}:wait", "response": { "$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" ] - }, - "rawPredict": { - "description": "Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's DeployedModel that served this prediction.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:rawPredict", + } + } + }, + "sandboxEnvironments": { + "methods": { + "create": { + "description": "Creates a SandboxEnvironment in a given reasoning engine.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments", "httpMethod": "POST", - "id": "aiplatform.projects.locations.publishers.models.rawPredict", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.create", "parameterOrder": [ - "endpoint" + "parent" ], "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "parent": { + "description": "Required. The resource name of the reasoning engine to create the SandboxEnvironment in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+endpoint}:rawPredict", + "path": "v1beta1/{+parent}/sandboxEnvironments", "request": { - "$ref": "GoogleCloudAiplatformV1beta1RawPredictRequest" + "$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironment" }, "response": { - "$ref": "GoogleApiHttpBody" + "$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" ] }, - "serverStreamingPredict": { - "description": "Perform a server-side streaming online prediction request for Vertex LLM streaming.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:serverStreamingPredict", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.publishers.models.serverStreamingPredict", + "delete": { + "description": "Deletes the specific SandboxEnvironment.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.delete", "parameterOrder": [ - "endpoint" + "name" ], "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "name": { + "description": "Required. The resource name of the SandboxEnvironment to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+endpoint}:serverStreamingPredict", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1StreamingPredictRequest" - }, + "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1StreamingPredictResponse" + "$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" ] }, - "setPublisherModelConfig": { - "description": "Sets (creates or updates) configs of publisher models. For example, sets the request/response logging config.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:setPublisherModelConfig", + "execute": { + "description": "Executes using a sandbox environment.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:execute", "httpMethod": "POST", - "id": "aiplatform.projects.locations.publishers.models.setPublisherModelConfig", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.execute", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the publisher model, in the format of `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`.", + "description": "Required. The resource name of the sandbox environment to execute. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+name}:setPublisherModelConfig", + "path": "v1beta1/{+name}:execute", "request": { - "$ref": "GoogleCloudAiplatformV1beta1SetPublisherModelConfigRequest" + "$ref": "GoogleCloudAiplatformV1beta1ExecuteSandboxEnvironmentRequest" }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1beta1ExecuteSandboxEnvironmentResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "streamGenerateContent": { - "description": "Generate content with multimodal inputs with streaming support.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamGenerateContent", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.publishers.models.streamGenerateContent", + "get": { + "description": "Gets details of the specific SandboxEnvironment.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.get", "parameterOrder": [ - "model" + "name" ], "parameters": { - "model": { - "description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "name": { + "description": "Required. The resource name of the sandbox environment. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+model}:streamGenerateContent", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest" - }, + "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse" + "$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironment" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" + "https://www.googleapis.com/auth/cloud-platform" ] }, - "streamRawPredict": { - "description": "Perform a streaming online prediction with an arbitrary HTTP payload.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamRawPredict", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.publishers.models.streamRawPredict", + "list": { + "description": "Lists SandboxEnvironments in a given reasoning engine.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.list", "parameterOrder": [ - "endpoint" + "parent" ], "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "filter": { + "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of SandboxEnvironments to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironments will be returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token, received from a previous `ListSandboxEnvironments` call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+endpoint}:streamRawPredict", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1StreamRawPredictRequest" - }, + "path": "v1beta1/{+parent}/sandboxEnvironments", "response": { - "$ref": "GoogleApiHttpBody" + "$ref": "GoogleCloudAiplatformV1beta1ListSandboxEnvironmentsResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" + "https://www.googleapis.com/auth/cloud-platform" ] } - } - } - } - }, - "ragCorpora": { - "methods": { - "create": { - "description": "Creates a RagCorpus.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.ragCorpora.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the RagCorpus in. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/ragCorpora", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1RagCorpus" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a RagCorpus.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.ragCorpora.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "force": { - "description": "Optional. If set to true, any RagFiles in this RagCorpus will also be deleted. Otherwise, the request will only work if the RagCorpus has no RagFiles.", - "location": "query", - "type": "boolean" - }, - "name": { - "description": "Required. The name of the RagCorpus resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets a RagCorpus.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.ragCorpora.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the RagCorpus resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1RagCorpus" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists RagCorpora in a Location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.ragCorpora.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "Optional. The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The standard list page token. Typically obtained via ListRagCorporaResponse.next_page_token of the previous VertexRagDataService.ListRagCorpora call.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Location from which to list the RagCorpora. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } - }, - "path": "v1beta1/{+parent}/ragCorpora", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListRagCorporaResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + } }, - "patch": { - "description": "Updates a RagCorpus.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.ragCorpora.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Output only. The resource name of the RagCorpus.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1RagCorpus" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "operations": { + "sessions": { "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}:cancel", + "appendEvent": { + "description": "Appends an event to a given session.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}:appendEvent", "httpMethod": "POST", - "id": "aiplatform.projects.locations.ragCorpora.operations.cancel", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.appendEvent", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "The name of the operation resource to be cancelled.", + "description": "Required. The resource name of the session to append event to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+name}:cancel", + "path": "v1beta1/{+name}:appendEvent", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1SessionEvent" + }, "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleCloudAiplatformV1beta1AppendEventResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.ragCorpora.operations.delete", + "create": { + "description": "Creates a new Session.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.create", "parameterOrder": [ - "name" + "parent" ], "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", + "parent": { + "description": "Required. The resource name of the location to create the session in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+name}", + "path": "v1beta1/{+parent}/sessions", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Session" + }, "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.ragCorpora.operations.get", + "delete": { + "description": "Deletes details of the specific Session.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "The name of the operation resource.", + "description": "Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", "required": true, "type": "string" } @@ -19665,201 +28882,106 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations", + "get": { + "description": "Gets details of the specific Session.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.ragCorpora.operations.list", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.get", "parameterOrder": [ "name" ], "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, "name": { - "description": "The name of the operation's parent resource.", + "description": "Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", "required": true, "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" } }, - "path": "v1beta1/{+name}/operations", + "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleCloudAiplatformV1beta1Session" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.ragCorpora.operations.wait", + "list": { + "description": "Lists Sessions in a given reasoning engine.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.list", "parameterOrder": [ - "name" + "parent" ], "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$", - "required": true, + "filter": { + "description": "Optional. The standard list filter. Supported fields: * `display_name` * `user_id` Example: `display_name=\"abc\"`, `user_id=\"123\"`.", + "location": "query", "type": "string" }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`.", "location": "query", "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, - "ragFiles": { - "methods": { - "delete": { - "description": "Deletes a RagFile.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.ragCorpora.ragFiles.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "forceDelete": { - "description": "Optional. If set to true, any errors generated by external vector database during the deletion will be ignored. The default value is false.", + }, + "pageSize": { + "description": "Optional. The maximum number of sessions to return. The service may return fewer than this value. If unspecified, at most 100 sessions will be returned.", + "format": "int32", "location": "query", - "type": "boolean" + "type": "integer" }, - "name": { - "description": "Required. The name of the RagFile resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`", + "pageToken": { + "description": "Optional. The next_page_token value returned from a previous list SessionService.ListSessions call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the location to list sessions from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+name}", + "path": "v1beta1/{+parent}/sessions", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1beta1ListSessionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "get": { - "description": "Gets a RagFile.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.ragCorpora.ragFiles.get", + "patch": { + "description": "Updates the specific Session.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.patch", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the RagFile resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1RagFile" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "import": { - "description": "Import files from Google Cloud Storage or Google Drive into a RagCorpus.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles:import", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.ragCorpora.ragFiles.import", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The name of the RagCorpus resource into which to import files. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", + "description": "Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", "required": true, "type": "string" - } - }, - "path": "v1beta1/{+parent}/ragFiles:import", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1ImportRagFilesRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists RagFiles in a RagCorpus.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.ragCorpora.ragFiles.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "Optional. The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" }, - "pageToken": { - "description": "Optional. The standard list page token. Typically obtained via ListRagFilesResponse.next_page_token of the previous VertexRagDataService.ListRagFiles call.", + "updateMask": { + "description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.", + "format": "google-fieldmask", "location": "query", "type": "string" - }, - "parent": { - "description": "Required. The resource name of the RagCorpus from which to list the RagFiles. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", - "required": true, - "type": "string" } }, - "path": "v1beta1/{+parent}/ragFiles", + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Session" + }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListRagFilesResponse" + "$ref": "GoogleCloudAiplatformV1beta1Session" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -19867,13 +28989,58 @@ } }, "resources": { + "events": { + "methods": { + "list": { + "description": "Lists Events in a given session.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/events", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.events.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The standard list filter. Supported fields: * `timestamp` range (i.e. `timestamp>=\"2025-01-31T11:30:00-04:00\"` where the timestamp is in RFC 3339 format) More detail in [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of events to return. The service may return fewer than this value. If unspecified, at most 100 events will be returned. These events are ordered by timestamp in ascending order.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The next_page_token value returned from a previous list SessionService.ListEvents call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the session to list events from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/events", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListEventsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:cancel", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.cancel", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.cancel", "parameterOrder": [ "name" ], @@ -19881,7 +29048,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -19896,9 +29063,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.delete", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.delete", "parameterOrder": [ "name" ], @@ -19906,7 +29073,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -19921,9 +29088,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.get", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.get", "parameterOrder": [ "name" ], @@ -19931,7 +29098,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -19946,9 +29113,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.list", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.list", "parameterOrder": [ "name" ], @@ -19961,7 +29128,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", "required": true, "type": "string" }, @@ -19992,9 +29159,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:wait", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.wait", + "id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.wait", "parameterOrder": [ "name" ], @@ -20002,7 +29169,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -20023,19 +29190,235 @@ } } } - } + } + } + } + }, + "schedules": { + "methods": { + "create": { + "description": "Creates a Schedule.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.schedules.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the Schedule in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/schedules", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Schedule" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1Schedule" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a Schedule.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.schedules.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Schedule resource to be deleted. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a Schedule.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.schedules.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Schedule resource. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1Schedule" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Schedules in a Location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.schedules.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Lists the Schedules that match the filter expression. The following fields are supported: * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `state`: Supports `=` and `!=` comparisons. * `request`: Supports existence of the check. (e.g. `create_pipeline_job_request:*` --> Schedule has create_pipeline_job_request). * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `start_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, `>=` comparisons and `:*` existence check. Values must be in RFC 3339 format. * `next_run_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. Filter expressions can be combined together using logical operators (`NOT`, `AND` & `OR`). The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `state=\"ACTIVE\" AND display_name:\"my_schedule_*\"` * `NOT display_name=\"my_schedule\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `end_time>\"2021-05-18T00:00:00Z\" OR NOT end_time:*` * `create_pipeline_job_request:*`", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "A comma-separated list of fields to order by. The default sort order is in ascending order. Use \"desc\" after a field name for descending. You can have multiple order_by fields provided. For example, using \"create_time desc, end_time\" will order results by create time in descending order, and if there are multiple schedules having the same create time, order them by the end time in ascending order. If order_by is not specified, it will order by default with create_time in descending order. Supported fields: * `create_time` * `start_time` * `end_time` * `next_run_time`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size. Default to 100 if not specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token. Typically obtained via ListSchedulesResponse.next_page_token of the previous ScheduleService.ListSchedules call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list the Schedules from. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/schedules", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListSchedulesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an active or paused Schedule. When the Schedule is updated, new runs will be scheduled starting from the updated next execution time after the update time based on the time_specification in the updated Schedule. All unstarted runs before the update time will be skipped while already created runs will NOT be paused or canceled.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.schedules.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. The resource name of the Schedule.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Schedule" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1Schedule" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "pause": { + "description": "Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:pause", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.schedules.pause", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Schedule resource to be paused. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:pause", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1PauseScheduleRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "resume": { + "description": "Resumes a paused Schedule to start scheduling new runs. Will mark Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed. When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If Schedule.catch_up is set up true, all missed runs will be scheduled for backfill first.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:resume", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.schedules.resume", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Schedule resource to be resumed. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:resume", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1ResumeScheduleRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } - } - }, - "ragEngineConfig": { + }, "resources": { "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}:cancel", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.ragEngineConfig.operations.cancel", + "id": "aiplatform.projects.locations.schedules.operations.cancel", "parameterOrder": [ "name" ], @@ -20043,7 +29426,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -20058,9 +29441,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.ragEngineConfig.operations.delete", + "id": "aiplatform.projects.locations.schedules.operations.delete", "parameterOrder": [ "name" ], @@ -20068,7 +29451,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -20083,9 +29466,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.ragEngineConfig.operations.get", + "id": "aiplatform.projects.locations.schedules.operations.get", "parameterOrder": [ "name" ], @@ -20093,7 +29476,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -20108,9 +29491,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.ragEngineConfig.operations.list", + "id": "aiplatform.projects.locations.schedules.operations.list", "parameterOrder": [ "name" ], @@ -20123,7 +29506,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig$", + "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", "required": true, "type": "string" }, @@ -20154,9 +29537,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}:wait", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.ragEngineConfig.operations.wait", + "id": "aiplatform.projects.locations.schedules.operations.wait", "parameterOrder": [ "name" ], @@ -20164,7 +29547,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -20187,28 +29570,132 @@ } } }, - "reasoningEngines": { + "solvers": { + "resources": { + "operations": { + "methods": { + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/solvers/{solversId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.solvers.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/solvers/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/solvers/{solversId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.solvers.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/solvers/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/solvers/{solversId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.solvers.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/solvers/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "specialistPools": { "methods": { "create": { - "description": "Creates a reasoning engine.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines", + "description": "Creates a SpecialistPool.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools", "httpMethod": "POST", - "id": "aiplatform.projects.locations.reasoningEngines.create", + "id": "aiplatform.projects.locations.specialistPools.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { - "description": "Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project}/locations/{location}`", + "description": "Required. The parent Project name for the new SpecialistPool. The form is `projects/{project}/locations/{location}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/reasoningEngines", + "path": "v1beta1/{+parent}/specialistPools", "request": { - "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngine" + "$ref": "GoogleCloudAiplatformV1beta1SpecialistPool" }, "response": { "$ref": "GoogleLongrunningOperation" @@ -20218,23 +29705,23 @@ ] }, "delete": { - "description": "Deletes a reasoning engine.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}", + "description": "Deletes a SpecialistPool as well as all Specialists in the pool.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.reasoningEngines.delete", + "id": "aiplatform.projects.locations.specialistPools.delete", "parameterOrder": [ "name" ], "parameters": { "force": { - "description": "Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources.", + "description": "If set to true, any specialist managers in this SpecialistPool will also be deleted. (Otherwise, the request will only work if the SpecialistPool has no specialist managers.)", "location": "query", "type": "boolean" }, "name": { - "description": "Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "description": "Required. The resource name of the SpecialistPool to delete. Format: `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", "required": true, "type": "string" } @@ -20248,89 +29735,90 @@ ] }, "get": { - "description": "Gets a reasoning engine.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}", + "description": "Gets a SpecialistPool.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.reasoningEngines.get", + "id": "aiplatform.projects.locations.specialistPools.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the ReasoningEngine resource. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "description": "Required. The name of the SpecialistPool resource. The form is `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngine" + "$ref": "GoogleCloudAiplatformV1beta1SpecialistPool" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists reasoning engines in a location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines", + "description": "Lists SpecialistPools in a Location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools", "httpMethod": "GET", - "id": "aiplatform.projects.locations.reasoningEngines.list", + "id": "aiplatform.projects.locations.specialistPools.list", "parameterOrder": [ "parent" ], "parameters": { - "filter": { - "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", - "location": "query", - "type": "string" - }, "pageSize": { - "description": "Optional. The standard list page size.", + "description": "The standard list page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. The standard list page token.", + "description": "The standard list page token. Typically obtained by ListSpecialistPoolsResponse.next_page_token of the previous SpecialistPoolService.ListSpecialistPools call. Return first page if empty.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project}/locations/{location}`", + "description": "Required. The name of the SpecialistPool's parent resource. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read. FieldMask represents a set of", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, - "path": "v1beta1/{+parent}/reasoningEngines", + "path": "v1beta1/{+parent}/specialistPools", "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListReasoningEnginesResponse" + "$ref": "GoogleCloudAiplatformV1beta1ListSpecialistPoolsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { - "description": "Updates a reasoning engine.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}", + "description": "Updates a SpecialistPool.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}", "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.reasoningEngines.patch", + "id": "aiplatform.projects.locations.specialistPools.patch", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "description": "Required. The resource name of the SpecialistPool.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", "required": true, "type": "string" }, "updateMask": { - "description": "Optional. Mask specifying which fields to update.", + "description": "Required. The update mask applies to the resource.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -20338,7 +29826,7 @@ }, "path": "v1beta1/{+name}", "request": { - "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngine" + "$ref": "GoogleCloudAiplatformV1beta1SpecialistPool" }, "response": { "$ref": "GoogleLongrunningOperation" @@ -20346,948 +29834,596 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "query": { - "description": "Queries using a reasoning engine.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:query", + } + }, + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.specialistPools.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.specialistPools.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.specialistPools.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.specialistPools.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.specialistPools.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "studies": { + "methods": { + "create": { + "description": "Creates a Study. A resource name will be generated after creation of the Study.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies", "httpMethod": "POST", - "id": "aiplatform.projects.locations.reasoningEngines.query", + "id": "aiplatform.projects.locations.studies.create", "parameterOrder": [ - "name" + "parent" ], "parameters": { - "name": { - "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "parent": { + "description": "Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project}/locations/{location}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+name}:query", + "path": "v1beta1/{+parent}/studies", "request": { - "$ref": "GoogleCloudAiplatformV1beta1QueryReasoningEngineRequest" + "$ref": "GoogleCloudAiplatformV1beta1Study" }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1QueryReasoningEngineResponse" + "$ref": "GoogleCloudAiplatformV1beta1Study" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "streamQuery": { - "description": "Streams queries using a reasoning engine.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:streamQuery", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.reasoningEngines.streamQuery", + "delete": { + "description": "Deletes a Study.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.studies.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:streamQuery", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1StreamQueryReasoningEngineRequest" - }, - "response": { - "$ref": "GoogleApiHttpBody" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "a2a": { - "resources": { - "v1": { - "methods": { - "card": { - "description": "Get request for reasoning engine instance via the A2A get protocol apis.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/card", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.card", - "parameterOrder": [ - "name", - "a2aEndpoint" - ], - "parameters": { - "a2aEndpoint": { - "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", - "location": "path", - "pattern": "^v1/card$", - "required": true, - "type": "string" - }, - "historyLength": { - "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", - "location": "query", - "type": "string" - }, - "name": { - "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", - "response": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "type": "object" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "message": { - "methods": { - "send": { - "description": "Send post request for reasoning engine instance via the A2A post protocol apis.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/message:send", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.message.send", - "parameterOrder": [ - "name", - "a2aEndpoint" - ], - "parameters": { - "a2aEndpoint": { - "description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send", - "location": "path", - "pattern": "^v1/message$", - "required": true, - "type": "string" - }, - "name": { - "description": "Required. The full resource path of the reasoning engine, captured from the URL.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:send", - "request": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "type": "object" - }, - "response": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "type": "object" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "stream": { - "description": "Streams queries using a reasoning engine instance via the A2A streaming protocol apis.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/message:stream", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.message.stream", - "parameterOrder": [ - "name", - "a2aEndpoint" - ], - "parameters": { - "a2aEndpoint": { - "description": "Required. The http endpoint extracted from the URL path. e.g., v1/message:stream.", - "location": "path", - "pattern": "^v1/message$", - "required": true, - "type": "string" - }, - "name": { - "description": "Required. The full resource path of the reasoning engine, captured from the URL.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:stream", - "request": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "type": "object" - }, - "response": { - "$ref": "GoogleApiHttpBody" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, - "tasks": { - "methods": { - "a2aGetReasoningEngine": { - "description": "Get request for reasoning engine instance via the A2A get protocol apis.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.tasks.a2aGetReasoningEngine", - "parameterOrder": [ - "name", - "a2aEndpoint" - ], - "parameters": { - "a2aEndpoint": { - "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", - "location": "path", - "pattern": "^v1/tasks/[^/]+$", - "required": true, - "type": "string" - }, - "historyLength": { - "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", - "location": "query", - "type": "string" - }, - "name": { - "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", - "response": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "type": "object" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "cancel": { - "description": "Send post request for reasoning engine instance via the A2A post protocol apis.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.tasks.cancel", - "parameterOrder": [ - "name", - "a2aEndpoint" - ], - "parameters": { - "a2aEndpoint": { - "description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send", - "location": "path", - "pattern": "^v1/tasks/[^/]+$", - "required": true, - "type": "string" - }, - "name": { - "description": "Required. The full resource path of the reasoning engine, captured from the URL.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:cancel", - "request": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "type": "object" - }, - "response": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "type": "object" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "pushNotificationConfigs": { - "description": "Get request for reasoning engine instance via the A2A get protocol apis.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs", - "parameterOrder": [ - "name", - "a2aEndpoint" - ], - "parameters": { - "a2aEndpoint": { - "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", - "location": "path", - "pattern": "^v1/tasks/[^/]+/pushNotificationConfigs$", - "required": true, - "type": "string" - }, - "historyLength": { - "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", - "location": "query", - "type": "string" - }, - "name": { - "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", - "response": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "type": "object" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "subscribe": { - "description": "Stream get request for reasoning engine instance via the A2A stream get protocol apis.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}:subscribe", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.tasks.subscribe", - "parameterOrder": [ - "name", - "a2aEndpoint" - ], - "parameters": { - "a2aEndpoint": { - "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123:subscribe`.", - "location": "path", - "pattern": "^v1/tasks/[^/]+$", - "required": true, - "type": "string" - }, - "name": { - "description": "Required. The full resource path of the reasoning engine, captured from the URL.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:subscribe", - "response": { - "$ref": "GoogleApiHttpBody" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "pushNotificationConfigs": { - "methods": { - "a2aGetReasoningEngine": { - "description": "Get request for reasoning engine instance via the A2A get protocol apis.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs.a2aGetReasoningEngine", - "parameterOrder": [ - "name", - "a2aEndpoint" - ], - "parameters": { - "a2aEndpoint": { - "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", - "location": "path", - "pattern": "^v1/tasks/[^/]+/pushNotificationConfigs/[^/]+$", - "required": true, - "type": "string" - }, - "historyLength": { - "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", - "location": "query", - "type": "string" - }, - "name": { - "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", - "response": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "type": "object" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - } - } - } - } - }, - "examples": { - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.reasoningEngines.examples.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.reasoningEngines.examples.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.reasoningEngines.examples.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.reasoningEngines.examples.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } + "description": "Required. The name of the Study resource to be deleted. Format: `projects/{project}/locations/{location}/studies/{study}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", + "required": true, + "type": "string" } - } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "memories": { + "get": { + "description": "Gets a Study by name.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.studies.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Study resource. Format: `projects/{project}/locations/{location}/studies/{study}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1Study" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all the studies in a region for an associated project.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.studies.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of studies to return per \"page\" of results. If unspecified, service will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list the Study from. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/studies", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListStudiesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "lookup": { + "description": "Looks a study up using the user-defined display_name field instead of the fully qualified resource name.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies:lookup", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.studies.lookup", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to get the Study from. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/studies:lookup", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1LookupStudyRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1Study" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { "methods": { - "create": { - "description": "Create a Memory.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories", + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.reasoningEngines.memories.create", + "id": "aiplatform.projects.locations.studies.operations.cancel", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "parent": { - "description": "Required. The resource name of the ReasoningEngine to create the Memory under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "name": { + "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/memories", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1Memory" - }, + "path": "v1beta1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { - "description": "Delete a Memory.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}", + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.reasoningEngines.memories.delete", + "id": "aiplatform.projects.locations.studies.operations.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The resource name of the Memory to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", + "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "generate": { - "description": "Generate memories.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories:generate", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.reasoningEngines.memories.generate", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the ReasoningEngine to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/memories:generate", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1GenerateMemoriesRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { - "description": "Get a Memory.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}", + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.reasoningEngines.memories.get", + "id": "aiplatform.projects.locations.studies.operations.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", + "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1Memory" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "List Memories.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.reasoningEngines.memories.list", + "id": "aiplatform.projects.locations.studies.operations.list", "parameterOrder": [ - "parent" + "name" ], "parameters": { "filter": { - "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `scope` (as a JSON string)", + "description": "The standard list filter.", "location": "query", "type": "string" }, - "orderBy": { - "description": "Optional. The standard list order by string. If not specified, the default order is `create_time desc`. If specified, the default sorting order of provided fields is ascending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time`", - "location": "query", + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", + "required": true, "type": "string" }, "pageSize": { - "description": "Optional. The standard list page size.", + "description": "The standard list page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. The standard list page token.", + "description": "The standard list page token.", "location": "query", "type": "string" }, - "parent": { - "description": "Required. The resource name of the ReasoningEngine to list the Memories under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", - "required": true, - "type": "string" + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, - "path": "v1beta1/{+parent}/memories", + "path": "v1beta1/{+name}/operations", "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListMemoriesResponse" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "patch": { - "description": "Update a Memory.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.reasoningEngines.memories.patch", + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.studies.operations.wait", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", + "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, - "updateMask": { - "description": "Optional. Mask specifying which fields to update. Supported fields: * `display_name` * `description` * `fact`", - "format": "google-fieldmask", + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", "location": "query", "type": "string" } }, - "path": "v1beta1/{+name}", + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "trials": { + "methods": { + "addTrialMeasurement": { + "description": "Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:addTrialMeasurement", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.studies.trials.addTrialMeasurement", + "parameterOrder": [ + "trialName" + ], + "parameters": { + "trialName": { + "description": "Required. The name of the trial to add measurement. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+trialName}:addTrialMeasurement", "request": { - "$ref": "GoogleCloudAiplatformV1beta1Memory" + "$ref": "GoogleCloudAiplatformV1beta1AddTrialMeasurementRequest" }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1beta1Trial" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "retrieve": { - "description": "Retrieve memories.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories:retrieve", + "checkTrialEarlyStoppingState": { + "description": "Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:checkTrialEarlyStoppingState", "httpMethod": "POST", - "id": "aiplatform.projects.locations.reasoningEngines.memories.retrieve", + "id": "aiplatform.projects.locations.studies.trials.checkTrialEarlyStoppingState", "parameterOrder": [ - "parent" + "trialName" ], "parameters": { - "parent": { - "description": "Required. The resource name of the ReasoningEngine to retrieve memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "trialName": { + "description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/memories:retrieve", + "path": "v1beta1/{+trialName}:checkTrialEarlyStoppingState", "request": { - "$ref": "GoogleCloudAiplatformV1beta1RetrieveMemoriesRequest" + "$ref": "GoogleCloudAiplatformV1beta1CheckTrialEarlyStoppingStateRequest" }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1RetrieveMemoriesResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - } - }, - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.reasoningEngines.memories.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.reasoningEngines.memories.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.reasoningEngines.memories.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.reasoningEngines.memories.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.reasoningEngines.memories.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - }, - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:cancel", + }, + "complete": { + "description": "Marks a Trial as complete.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:complete", "httpMethod": "POST", - "id": "aiplatform.projects.locations.reasoningEngines.operations.cancel", + "id": "aiplatform.projects.locations.studies.trials.complete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "The name of the operation resource to be cancelled.", + "description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+name}:cancel", + "path": "v1beta1/{+name}:complete", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1CompleteTrialRequest" + }, "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleCloudAiplatformV1beta1Trial" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Adds a user provided Trial to a Study.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.studies.trials.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Study to create the Trial in. Format: `projects/{project}/locations/{location}/studies/{study}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/trials", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Trial" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1Trial" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}", + "description": "Deletes a Trial.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.reasoningEngines.operations.delete", + "id": "aiplatform.projects.locations.studies.trials.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", + "description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", "required": true, "type": "string" } @@ -21301,253 +30437,145 @@ ] }, "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}", + "description": "Gets a Trial.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.reasoningEngines.operations.get", + "id": "aiplatform.projects.locations.studies.trials.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "The name of the operation resource.", + "description": "Required. The name of the Trial resource. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1beta1Trial" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations", + "description": "Lists the Trials associated with a Study.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials", "httpMethod": "GET", - "id": "aiplatform.projects.locations.reasoningEngines.operations.list", + "id": "aiplatform.projects.locations.studies.trials.list", "parameterOrder": [ - "name" + "parent" ], "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", - "required": true, - "type": "string" - }, "pageSize": { - "description": "The standard list page size.", + "description": "Optional. The number of Trials to retrieve per \"page\" of results. If unspecified, the service will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "The standard list page token.", + "description": "Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.", "location": "query", "type": "string" }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.reasoningEngines.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", + "parent": { + "description": "Required. The resource name of the Study to list the Trial from. Format: `projects/{project}/locations/{location}/studies/{study}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", "required": true, "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" } }, - "path": "v1beta1/{+name}:wait", + "path": "v1beta1/{+parent}/trials", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1beta1ListTrialsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - } - } - }, - "sandboxEnvironments": { - "methods": { - "create": { - "description": "Creates a SandboxEnvironment in a given reasoning engine.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments", + }, + "listOptimalTrials": { + "description": "Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:listOptimalTrials", "httpMethod": "POST", - "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.create", + "id": "aiplatform.projects.locations.studies.trials.listOptimalTrials", "parameterOrder": [ "parent" ], "parameters": { "parent": { - "description": "Required. The resource name of the reasoning engine to create the SandboxEnvironment in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`.", + "description": "Required. The name of the Study that the optimal Trial belongs to.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/sandboxEnvironments", + "path": "v1beta1/{+parent}/trials:listOptimalTrials", "request": { - "$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironment" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes the specific SandboxEnvironment.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The resource name of the SandboxEnvironment to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", - "required": true, - "type": "string" - } + "$ref": "GoogleCloudAiplatformV1beta1ListOptimalTrialsRequest" }, - "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1beta1ListOptimalTrialsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "execute": { - "description": "Executes using a sandbox environment.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:execute", + "stop": { + "description": "Stops a Trial.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:stop", "httpMethod": "POST", - "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.execute", + "id": "aiplatform.projects.locations.studies.trials.stop", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The resource name of the sandbox environment to execute. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", + "description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+name}:execute", + "path": "v1beta1/{+name}:stop", "request": { - "$ref": "GoogleCloudAiplatformV1beta1ExecuteSandboxEnvironmentRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ExecuteSandboxEnvironmentResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets details of the specific SandboxEnvironment.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The resource name of the sandbox environment. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", - "required": true, - "type": "string" - } + "$ref": "GoogleCloudAiplatformV1beta1StopTrialRequest" }, - "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironment" + "$ref": "GoogleCloudAiplatformV1beta1Trial" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "list": { - "description": "Lists SandboxEnvironments in a given reasoning engine.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.list", + "suggest": { + "description": "Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier. Returns a long-running operation associated with the generation of Trial suggestions. When this long-running operation succeeds, it will contain a SuggestTrialsResponse.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:suggest", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.studies.trials.suggest", "parameterOrder": [ "parent" ], "parameters": { - "filter": { - "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. The maximum number of SandboxEnvironments to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironments will be returned.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The standard list page token, received from a previous `ListSandboxEnvironments` call. Provide this to retrieve the subsequent page.", - "location": "query", - "type": "string" - }, "parent": { - "description": "Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "description": "Required. The project and location that the Study belongs to. Format: `projects/{project}/locations/{location}/studies/{study}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/sandboxEnvironments", + "path": "v1beta1/{+parent}/trials:suggest", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1SuggestTrialsRequest" + }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListSandboxEnvironmentsResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -21559,9 +30587,9 @@ "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}:cancel", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.cancel", + "id": "aiplatform.projects.locations.studies.trials.operations.cancel", "parameterOrder": [ "name" ], @@ -21569,7 +30597,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -21584,9 +30612,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.delete", + "id": "aiplatform.projects.locations.studies.trials.operations.delete", "parameterOrder": [ "name" ], @@ -21594,7 +30622,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -21609,9 +30637,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.get", + "id": "aiplatform.projects.locations.studies.trials.operations.get", "parameterOrder": [ "name" ], @@ -21619,7 +30647,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -21634,9 +30662,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.list", + "id": "aiplatform.projects.locations.studies.trials.operations.list", "parameterOrder": [ "name" ], @@ -21649,7 +30677,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", "required": true, "type": "string" }, @@ -21680,9 +30708,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}:wait", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.wait", + "id": "aiplatform.projects.locations.studies.trials.operations.wait", "parameterOrder": [ "name" ], @@ -21690,7 +30718,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -21712,78 +30740,334 @@ } } } + } + } + }, + "tensorboards": { + "methods": { + "batchRead": { + "description": "Reads multiple TensorboardTimeSeries' data. The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:batchRead", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.batchRead", + "parameterOrder": [ + "tensorboard" + ], + "parameters": { + "tensorboard": { + "description": "Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`. The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", + "required": true, + "type": "string" + }, + "timeSeries": { + "description": "Required. The resource names of the TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", + "location": "query", + "repeated": true, + "type": "string" + } + }, + "path": "v1beta1/{+tensorboard}:batchRead", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1BatchReadTensorboardTimeSeriesDataResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "sessions": { + "create": { + "description": "Creates a Tensorboard.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tensorboards.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the Tensorboard in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/tensorboards", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Tensorboard" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a Tensorboard.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.tensorboards.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Tensorboard to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a Tensorboard.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1Tensorboard" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Tensorboards in a Location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Lists the Tensorboards that match the filter expression.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field to use to sort the list.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of Tensorboards to return. The service may return fewer than this value. If unspecified, at most 100 Tensorboards are returned. The maximum value is 100; values above 100 are coerced to 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous TensorboardService.ListTensorboards call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboards must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list Tensorboards. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/tensorboards", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListTensorboardsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a Tensorboard.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.tensorboards.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Name of the Tensorboard. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. Field mask is used to specify the fields to be overwritten in the Tensorboard resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Tensorboard" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "readSize": { + "description": "Returns the storage size for a given TensorBoard instance.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readSize", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.readSize", + "parameterOrder": [ + "tensorboard" + ], + "parameters": { + "tensorboard": { + "description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+tensorboard}:readSize", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ReadTensorboardSizeResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "readUsage": { + "description": "Returns a list of monthly active users for a given TensorBoard instance.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readUsage", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.readUsage", + "parameterOrder": [ + "tensorboard" + ], + "parameters": { + "tensorboard": { + "description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+tensorboard}:readUsage", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ReadTensorboardUsageResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "experiments": { "methods": { - "appendEvent": { - "description": "Appends an event to a given session.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}:appendEvent", + "batchCreate": { + "description": "Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:batchCreate", "httpMethod": "POST", - "id": "aiplatform.projects.locations.reasoningEngines.sessions.appendEvent", + "id": "aiplatform.projects.locations.tensorboards.experiments.batchCreate", "parameterOrder": [ - "name" + "parent" ], "parameters": { - "name": { - "description": "Required. The resource name of the session to append event to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", + "parent": { + "description": "Required. The resource name of the TensorboardExperiment to create the TensorboardTimeSeries in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` The TensorboardRuns referenced by the parent fields in the CreateTensorboardTimeSeriesRequest messages must be sub resources of this TensorboardExperiment.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+name}:appendEvent", + "path": "v1beta1/{+parent}:batchCreate", "request": { - "$ref": "GoogleCloudAiplatformV1beta1SessionEvent" + "$ref": "GoogleCloudAiplatformV1beta1BatchCreateTensorboardTimeSeriesRequest" }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1AppendEventResponse" + "$ref": "GoogleCloudAiplatformV1beta1BatchCreateTensorboardTimeSeriesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { - "description": "Creates a new Session.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions", + "description": "Creates a TensorboardExperiment.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments", "httpMethod": "POST", - "id": "aiplatform.projects.locations.reasoningEngines.sessions.create", + "id": "aiplatform.projects.locations.tensorboards.experiments.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { - "description": "Required. The resource name of the location to create the session in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "description": "Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", "required": true, "type": "string" + }, + "tensorboardExperimentId": { + "description": "Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`.", + "location": "query", + "type": "string" } }, - "path": "v1beta1/{+parent}/sessions", + "path": "v1beta1/{+parent}/experiments", "request": { - "$ref": "GoogleCloudAiplatformV1beta1Session" + "$ref": "GoogleCloudAiplatformV1beta1TensorboardExperiment" }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1beta1TensorboardExperiment" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { - "description": "Deletes details of the specific Session.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", + "description": "Deletes a TensorboardExperiment.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.reasoningEngines.sessions.delete", + "id": "aiplatform.projects.locations.tensorboards.experiments.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", + "description": "Required. The name of the TensorboardExperiment to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", "required": true, "type": "string" } @@ -21797,94 +31081,100 @@ ] }, "get": { - "description": "Gets details of the specific Session.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", + "description": "Gets a TensorboardExperiment.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.reasoningEngines.sessions.get", + "id": "aiplatform.projects.locations.tensorboards.experiments.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", + "description": "Required. The name of the TensorboardExperiment resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1Session" + "$ref": "GoogleCloudAiplatformV1beta1TensorboardExperiment" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists Sessions in a given reasoning engine.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions", + "description": "Lists TensorboardExperiments in a Location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments", "httpMethod": "GET", - "id": "aiplatform.projects.locations.reasoningEngines.sessions.list", + "id": "aiplatform.projects.locations.tensorboards.experiments.list", "parameterOrder": [ "parent" ], "parameters": { "filter": { - "description": "Optional. The standard list filter. Supported fields: * `display_name` Example: `display_name=abc`.", + "description": "Lists the TensorboardExperiments that match the filter expression.", "location": "query", "type": "string" }, "orderBy": { - "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`.", + "description": "Field to use to sort the list.", "location": "query", "type": "string" }, "pageSize": { - "description": "Optional. The maximum number of sessions to return. The service may return fewer than this value. If unspecified, at most 100 sessions will be returned.", + "description": "The maximum number of TensorboardExperiments to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardExperiments are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. The next_page_token value returned from a previous list SessionService.ListSessions call.", + "description": "A page token, received from a previous TensorboardService.ListTensorboardExperiments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardExperiments must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the location to list sessions from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "description": "Required. The resource name of the Tensorboard to list TensorboardExperiments. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", "required": true, "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, - "path": "v1beta1/{+parent}/sessions", + "path": "v1beta1/{+parent}/experiments", "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListSessionsResponse" + "$ref": "GoogleCloudAiplatformV1beta1ListTensorboardExperimentsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { - "description": "Updates the specific Session.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", + "description": "Updates a TensorboardExperiment.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}", "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.reasoningEngines.sessions.patch", + "id": "aiplatform.projects.locations.tensorboards.experiments.patch", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.", + "description": "Output only. Name of the TensorboardExperiment. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", "required": true, "type": "string" }, "updateMask": { - "description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.", + "description": "Required. Field mask is used to specify the fields to be overwritten in the TensorboardExperiment resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -21892,10 +31182,38 @@ }, "path": "v1beta1/{+name}", "request": { - "$ref": "GoogleCloudAiplatformV1beta1Session" + "$ref": "GoogleCloudAiplatformV1beta1TensorboardExperiment" }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1Session" + "$ref": "GoogleCloudAiplatformV1beta1TensorboardExperiment" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "write": { + "description": "Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. If any data fail to be ingested, an error is returned.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:write", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tensorboards.experiments.write", + "parameterOrder": [ + "tensorboardExperiment" + ], + "parameters": { + "tensorboardExperiment": { + "description": "Required. The resource name of the TensorboardExperiment to write data to. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+tensorboardExperiment}:write", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1WriteTensorboardExperimentDataRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1WriteTensorboardExperimentDataResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -21903,58 +31221,13 @@ } }, "resources": { - "events": { - "methods": { - "list": { - "description": "Lists Events in a given session.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/events", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.reasoningEngines.sessions.events.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Optional. The standard list filter. Supported fields: * `timestamp` range (i.e. `timestamp>=\"2025-01-31T11:30:00-04:00\"` where the timestamp is in RFC 3339 format) More detail in [AIP-160](https://google.aip.dev/160).", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. The maximum number of events to return. The service may return fewer than this value. If unspecified, at most 100 events will be returned. These events are ordered by timestamp in ascending order.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The next_page_token value returned from a previous list SessionService.ListEvents call.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the session to list events from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/events", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListEventsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}:cancel", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.cancel", + "id": "aiplatform.projects.locations.tensorboards.experiments.operations.cancel", "parameterOrder": [ "name" ], @@ -21962,7 +31235,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -21977,9 +31250,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.delete", + "id": "aiplatform.projects.locations.tensorboards.experiments.operations.delete", "parameterOrder": [ "name" ], @@ -21987,7 +31260,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -22002,9 +31275,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.get", + "id": "aiplatform.projects.locations.tensorboards.experiments.operations.get", "parameterOrder": [ "name" ], @@ -22012,7 +31285,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -22027,9 +31300,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.list", + "id": "aiplatform.projects.locations.tensorboards.experiments.operations.list", "parameterOrder": [ "name" ], @@ -22042,7 +31315,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", "required": true, "type": "string" }, @@ -22073,9 +31346,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}:wait", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.wait", + "id": "aiplatform.projects.locations.tensorboards.experiments.operations.wait", "parameterOrder": [ "name" ], @@ -22083,7 +31356,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -22103,661 +31376,829 @@ ] } } - } - } - } - } - }, - "schedules": { - "methods": { - "create": { - "description": "Creates a Schedule.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.schedules.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the Schedule in. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/schedules", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1Schedule" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1Schedule" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a Schedule.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.schedules.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the Schedule resource to be deleted. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets a Schedule.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.schedules.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the Schedule resource. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1Schedule" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists Schedules in a Location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.schedules.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Lists the Schedules that match the filter expression. The following fields are supported: * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `state`: Supports `=` and `!=` comparisons. * `request`: Supports existence of the check. (e.g. `create_pipeline_job_request:*` --> Schedule has create_pipeline_job_request). * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `start_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, `>=` comparisons and `:*` existence check. Values must be in RFC 3339 format. * `next_run_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. Filter expressions can be combined together using logical operators (`NOT`, `AND` & `OR`). The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `state=\"ACTIVE\" AND display_name:\"my_schedule_*\"` * `NOT display_name=\"my_schedule\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `end_time>\"2021-05-18T00:00:00Z\" OR NOT end_time:*` * `create_pipeline_job_request:*`", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "A comma-separated list of fields to order by. The default sort order is in ascending order. Use \"desc\" after a field name for descending. You can have multiple order_by fields provided. For example, using \"create_time desc, end_time\" will order results by create time in descending order, and if there are multiple schedules having the same create time, order them by the end time in ascending order. If order_by is not specified, it will order by default with create_time in descending order. Supported fields: * `create_time` * `start_time` * `end_time` * `next_run_time`", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size. Default to 100 if not specified.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token. Typically obtained via ListSchedulesResponse.next_page_token of the previous ScheduleService.ListSchedules call.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Location to list the Schedules from. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/schedules", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListSchedulesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "patch": { - "description": "Updates an active or paused Schedule. When the Schedule is updated, new runs will be scheduled starting from the updated next execution time after the update time based on the time_specification in the updated Schedule. All unstarted runs before the update time will be skipped while already created runs will NOT be paused or canceled.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.schedules.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Immutable. The resource name of the Schedule.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1Schedule" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1Schedule" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "pause": { - "description": "Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:pause", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.schedules.pause", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the Schedule resource to be paused. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:pause", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1PauseScheduleRequest" - }, - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "resume": { - "description": "Resumes a paused Schedule to start scheduling new runs. Will mark Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed. When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If Schedule.catch_up is set up true, all missed runs will be scheduled for backfill first.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:resume", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.schedules.resume", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the Schedule resource to be resumed. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:resume", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1ResumeScheduleRequest" - }, - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.schedules.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.schedules.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.schedules.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.schedules.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" + "runs": { + "methods": { + "batchCreate": { + "description": "Batch create TensorboardRuns.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs:batchCreate", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.batchCreate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the TensorboardExperiment to create the TensorboardRuns in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` The parent field in the CreateTensorboardRunRequest messages must match this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/runs:batchCreate", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1BatchCreateTensorboardRunsRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1BatchCreateTensorboardRunsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", - "required": true, - "type": "string" + "create": { + "description": "Creates a TensorboardRun.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", + "required": true, + "type": "string" + }, + "tensorboardRunId": { + "description": "Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/runs", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1TensorboardRun" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1TensorboardRun" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" + "delete": { + "description": "Deletes a TensorboardRun.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the TensorboardRun to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" + "get": { + "description": "Gets a TensorboardRun.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the TensorboardRun resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1TensorboardRun" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.schedules.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" + "list": { + "description": "Lists TensorboardRuns in a Location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Lists the TensorboardRuns that match the filter expression.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field to use to sort the list.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of TensorboardRuns to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardRuns are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous TensorboardService.ListTensorboardRuns call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardRuns must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/runs", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListTensorboardRunsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - }, - "solvers": { - "resources": { - "operations": { - "methods": { - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/solvers/{solversId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.solvers.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/solvers/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/solvers/{solversId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.solvers.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/solvers/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" + "patch": { + "description": "Updates a TensorboardRun.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Name of the TensorboardRun. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. Field mask is used to specify the fields to be overwritten in the TensorboardRun resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1TensorboardRun" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1TensorboardRun" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "write": { + "description": "Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}:write", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.write", + "parameterOrder": [ + "tensorboardRun" + ], + "parameters": { + "tensorboardRun": { + "description": "Required. The resource name of the TensorboardRun to write data to. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+tensorboardRun}:write", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1WriteTensorboardRunDataRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1WriteTensorboardRunDataResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/solvers/{solversId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.solvers.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/solvers/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - }, - "specialistPools": { - "methods": { - "create": { - "description": "Creates a SpecialistPool.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.specialistPools.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The parent Project name for the new SpecialistPool. The form is `projects/{project}/locations/{location}`.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/specialistPools", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1SpecialistPool" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a SpecialistPool as well as all Specialists in the pool.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.specialistPools.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "force": { - "description": "If set to true, any specialist managers in this SpecialistPool will also be deleted. (Otherwise, the request will only work if the SpecialistPool has no specialist managers.)", - "location": "query", - "type": "boolean" - }, - "name": { - "description": "Required. The resource name of the SpecialistPool to delete. Format: `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets a SpecialistPool.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.specialistPools.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the SpecialistPool resource. The form is `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1SpecialistPool" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists SpecialistPools in a Location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.specialistPools.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token. Typically obtained by ListSpecialistPoolsResponse.next_page_token of the previous SpecialistPoolService.ListSpecialistPools call. Return first page if empty.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The name of the SpecialistPool's parent resource. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read. FieldMask represents a set of", - "format": "google-fieldmask", - "location": "query", - "type": "string" + "timeSeries": { + "methods": { + "create": { + "description": "Creates a TensorboardTimeSeries.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the TensorboardRun to create the TensorboardTimeSeries in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", + "required": true, + "type": "string" + }, + "tensorboardTimeSeriesId": { + "description": "Optional. The user specified unique ID to use for the TensorboardTimeSeries, which becomes the final component of the TensorboardTimeSeries's resource name. This value should match \"a-z0-9{0, 127}\"", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/timeSeries", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1TensorboardTimeSeries" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1TensorboardTimeSeries" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a TensorboardTimeSeries.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the TensorboardTimeSeries to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "exportTensorboardTimeSeries": { + "description": "Exports a TensorboardTimeSeries' data. Data is returned in paginated responses.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:exportTensorboardTimeSeries", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.exportTensorboardTimeSeries", + "parameterOrder": [ + "tensorboardTimeSeries" + ], + "parameters": { + "tensorboardTimeSeries": { + "description": "Required. The resource name of the TensorboardTimeSeries to export data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+tensorboardTimeSeries}:exportTensorboardTimeSeries", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1ExportTensorboardTimeSeriesDataRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ExportTensorboardTimeSeriesDataResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a TensorboardTimeSeries.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the TensorboardTimeSeries resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1TensorboardTimeSeries" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists TensorboardTimeSeries in a Location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Lists the TensorboardTimeSeries that match the filter expression.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field to use to sort the list.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of TensorboardTimeSeries to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardTimeSeries are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous TensorboardService.ListTensorboardTimeSeries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardTimeSeries must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/timeSeries", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListTensorboardTimeSeriesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a TensorboardTimeSeries.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Name of the TensorboardTimeSeries.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. Field mask is used to specify the fields to be overwritten in the TensorboardTimeSeries resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1TensorboardTimeSeries" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1TensorboardTimeSeries" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "read": { + "description": "Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:read", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.read", + "parameterOrder": [ + "tensorboardTimeSeries" + ], + "parameters": { + "filter": { + "description": "Reads the TensorboardTimeSeries' data that match the filter expression.", + "location": "query", + "type": "string" + }, + "maxDataPoints": { + "description": "The maximum number of TensorboardTimeSeries' data to return. This value should be a positive integer. This value can be set to -1 to return all data.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "tensorboardTimeSeries": { + "description": "Required. The resource name of the TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+tensorboardTimeSeries}:read", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ReadTensorboardTimeSeriesDataResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "readBlobData": { + "description": "Gets bytes of TensorboardBlobs. This is to allow reading blob data stored in consumer project's Cloud Storage bucket without users having to obtain Cloud Storage access permission.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:readBlobData", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.readBlobData", + "parameterOrder": [ + "timeSeries" + ], + "parameters": { + "blobIds": { + "description": "IDs of the blobs to read.", + "location": "query", + "repeated": true, + "type": "string" + }, + "timeSeries": { + "description": "Required. The resource name of the TensorboardTimeSeries to list Blobs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+timeSeries}:readBlobData", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ReadTensorboardBlobDataResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } } - }, - "path": "v1beta1/{+parent}/specialistPools", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListSpecialistPoolsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + } }, - "patch": { - "description": "Updates a SpecialistPool.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.specialistPools.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The resource name of the SpecialistPool.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Required. The update mask applies to the resource.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1SpecialistPool" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:cancel", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.specialistPools.operations.cancel", + "id": "aiplatform.projects.locations.tensorboards.operations.cancel", "parameterOrder": [ "name" ], @@ -22765,7 +32206,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -22780,9 +32221,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.specialistPools.operations.delete", + "id": "aiplatform.projects.locations.tensorboards.operations.delete", "parameterOrder": [ "name" ], @@ -22790,7 +32231,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -22805,9 +32246,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.specialistPools.operations.get", + "id": "aiplatform.projects.locations.tensorboards.operations.get", "parameterOrder": [ "name" ], @@ -22815,7 +32256,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -22830,9 +32271,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.specialistPools.operations.list", + "id": "aiplatform.projects.locations.tensorboards.operations.list", "parameterOrder": [ "name" ], @@ -22845,7 +32286,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", "required": true, "type": "string" }, @@ -22876,9 +32317,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:wait", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.specialistPools.operations.wait", + "id": "aiplatform.projects.locations.tensorboards.operations.wait", "parameterOrder": [ "name" ], @@ -22886,7 +32327,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -22909,145 +32350,156 @@ } } }, - "studies": { + "trainingPipelines": { "methods": { + "cancel": { + "description": "Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetTrainingPipeline or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead it becomes a pipeline with a TrainingPipeline.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TrainingPipeline.state is set to `CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.trainingPipelines.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the TrainingPipeline to cancel. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1CancelTrainingPipelineRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "create": { - "description": "Creates a Study. A resource name will be generated after creation of the Study.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies", + "description": "Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines", "httpMethod": "POST", - "id": "aiplatform.projects.locations.studies.create", + "id": "aiplatform.projects.locations.trainingPipelines.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { - "description": "Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project}/locations/{location}`", + "description": "Required. The resource name of the Location to create the TrainingPipeline in. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/studies", + "path": "v1beta1/{+parent}/trainingPipelines", "request": { - "$ref": "GoogleCloudAiplatformV1beta1Study" + "$ref": "GoogleCloudAiplatformV1beta1TrainingPipeline" }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1Study" + "$ref": "GoogleCloudAiplatformV1beta1TrainingPipeline" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { - "description": "Deletes a Study.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}", + "description": "Deletes a TrainingPipeline.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.studies.delete", + "id": "aiplatform.projects.locations.trainingPipelines.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the Study resource to be deleted. Format: `projects/{project}/locations/{location}/studies/{study}`", + "description": "Required. The name of the TrainingPipeline resource to be deleted. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { - "description": "Gets a Study by name.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}", + "description": "Gets a TrainingPipeline.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.studies.get", + "id": "aiplatform.projects.locations.trainingPipelines.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the Study resource. Format: `projects/{project}/locations/{location}/studies/{study}`", + "description": "Required. The name of the TrainingPipeline resource. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1Study" + "$ref": "GoogleCloudAiplatformV1beta1TrainingPipeline" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists all the studies in a region for an associated project.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies", + "description": "Lists TrainingPipelines in a Location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines", "httpMethod": "GET", - "id": "aiplatform.projects.locations.studies.list", + "id": "aiplatform.projects.locations.trainingPipelines.list", "parameterOrder": [ "parent" ], "parameters": { + "filter": { + "description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `training_task_definition` `=`, `!=` comparisons, and `:` wildcard. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"PIPELINE_STATE_SUCCEEDED\" AND display_name:\"my_pipeline_*\"` * `state!=\"PIPELINE_STATE_FAILED\" OR display_name=\"my_pipeline\"` * `NOT display_name=\"my_pipeline\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `training_task_definition:\"*automl_text_classification*\"`", + "location": "query", + "type": "string" + }, "pageSize": { - "description": "Optional. The maximum number of studies to return per \"page\" of results. If unspecified, service will pick an appropriate default.", + "description": "The standard list page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.", + "description": "The standard list page token. Typically obtained via ListTrainingPipelinesResponse.next_page_token of the previous PipelineService.ListTrainingPipelines call.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the Location to list the Study from. Format: `projects/{project}/locations/{location}`", + "description": "Required. The resource name of the Location to list the TrainingPipelines from. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" - } - }, - "path": "v1beta1/{+parent}/studies", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListStudiesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "lookup": { - "description": "Looks a study up using the user-defined display_name field instead of the fully qualified resource name.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies:lookup", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.studies.lookup", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to get the Study from. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", "type": "string" } }, - "path": "v1beta1/{+parent}/studies:lookup", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1LookupStudyRequest" - }, + "path": "v1beta1/{+parent}/trainingPipelines", "response": { - "$ref": "GoogleCloudAiplatformV1beta1Study" + "$ref": "GoogleCloudAiplatformV1beta1ListTrainingPipelinesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -23059,9 +32511,9 @@ "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:cancel", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.studies.operations.cancel", + "id": "aiplatform.projects.locations.trainingPipelines.operations.cancel", "parameterOrder": [ "name" ], @@ -23069,7 +32521,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -23084,9 +32536,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.studies.operations.delete", + "id": "aiplatform.projects.locations.trainingPipelines.operations.delete", "parameterOrder": [ "name" ], @@ -23094,7 +32546,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -23109,9 +32561,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.studies.operations.get", + "id": "aiplatform.projects.locations.trainingPipelines.operations.get", "parameterOrder": [ "name" ], @@ -23119,7 +32571,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -23134,9 +32586,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.studies.operations.list", + "id": "aiplatform.projects.locations.trainingPipelines.operations.list", "parameterOrder": [ "name" ], @@ -23149,7 +32601,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", "required": true, "type": "string" }, @@ -23180,9 +32632,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:wait", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.studies.operations.wait", + "id": "aiplatform.projects.locations.trainingPipelines.operations.wait", "parameterOrder": [ "name" ], @@ -23190,7 +32642,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -23210,134 +32662,206 @@ ] } } + } + } + }, + "tuningJobs": { + "methods": { + "cancel": { + "description": "Cancels a TuningJob. Starts asynchronous cancellation on the TuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use GenAiTuningService.GetTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the TuningJob is not deleted; instead it becomes a job with a TuningJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TuningJob.state is set to `CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tuningJobs.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the TuningJob to cancel. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1CancelTuningJobRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "trials": { - "methods": { - "addTrialMeasurement": { - "description": "Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:addTrialMeasurement", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.studies.trials.addTrialMeasurement", - "parameterOrder": [ - "trialName" - ], - "parameters": { - "trialName": { - "description": "Required. The name of the trial to add measurement. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+trialName}:addTrialMeasurement", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1AddTrialMeasurementRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1Trial" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "checkTrialEarlyStoppingState": { - "description": "Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:checkTrialEarlyStoppingState", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.studies.trials.checkTrialEarlyStoppingState", - "parameterOrder": [ - "trialName" - ], - "parameters": { - "trialName": { - "description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+trialName}:checkTrialEarlyStoppingState", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1CheckTrialEarlyStoppingStateRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "create": { + "description": "Creates a TuningJob. A created TuningJob right away will be attempted to be run.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tuningJobs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the TuningJob in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/tuningJobs", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1TuningJob" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1TuningJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a TuningJob.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tuningJobs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the TuningJob resource. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1TuningJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists TuningJobs in a Location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tuningJobs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The standard list filter.", + "location": "query", + "type": "string" }, - "complete": { - "description": "Marks a Trial as complete.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:complete", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.studies.trials.complete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:complete", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1CompleteTrialRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1Trial" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" }, - "create": { - "description": "Adds a user provided Trial to a Study.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.studies.trials.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the Study to create the Trial in. Format: `projects/{project}/locations/{location}/studies/{study}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/trials", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1Trial" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1Trial" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageToken": { + "description": "Optional. The standard list page token. Typically obtained via ListTuningJobsResponse.next_page_token of the previous GenAiTuningService.ListTuningJob][] call.", + "location": "query", + "type": "string" }, + "parent": { + "description": "Required. The resource name of the Location to list the TuningJobs from. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/tuningJobs", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListTuningJobsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "optimizePrompt": { + "description": "Optimizes a prompt.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs:optimizePrompt", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tuningJobs.optimizePrompt", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to optimize the prompt in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/tuningJobs:optimizePrompt", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1OptimizePromptRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1OptimizePromptResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "rebaseTunedModel": { + "description": "Rebase a TunedModel.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs:rebaseTunedModel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tuningJobs.rebaseTunedModel", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location into which to rebase the Model. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/tuningJobs:rebaseTunedModel", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1RebaseTunedModelRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { "delete": { - "description": "Deletes a Trial.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}", + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.studies.trials.delete", + "id": "aiplatform.projects.locations.tuningJobs.operations.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", + "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -23349,556 +32873,1195 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + } + } + } + } + } + } + }, + "modelGardenEula": { + "methods": { + "accept": { + "description": "Accepts the EULA acceptance status of a publisher model.", + "flatPath": "v1beta1/projects/{projectsId}/modelGardenEula:accept", + "httpMethod": "POST", + "id": "aiplatform.projects.modelGardenEula.accept", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The project requesting access for named model. The format is `projects/{project}`.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/modelGardenEula:accept", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1AcceptPublisherModelEulaRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1PublisherModelEulaAcceptance" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "check": { + "description": "Checks the EULA acceptance status of a publisher model.", + "flatPath": "v1beta1/projects/{projectsId}/modelGardenEula:check", + "httpMethod": "POST", + "id": "aiplatform.projects.modelGardenEula.check", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The project requesting access for named model. The format is `projects/{project}`.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/modelGardenEula:check", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1CheckPublisherModelEulaAcceptanceRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1PublisherModelEulaAcceptance" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "publishers": { + "resources": { + "models": { + "methods": { + "enableModel": { + "description": "Enables model for the project if prerequisites are met (e.g. completed questionnaire and consents, or an active Private Offer).", + "flatPath": "v1beta1/projects/{projectsId}/publishers/{publishersId}/models/{modelsId}:enableModel", + "httpMethod": "POST", + "id": "aiplatform.projects.publishers.models.enableModel", + "parameterOrder": [ + "parent", + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}`", + "location": "path", + "pattern": "^publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" }, - "get": { - "description": "Gets a Trial.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.studies.trials.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the Trial resource. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1Trial" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists the Trials associated with a Study.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.studies.trials.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "Optional. The number of Trials to retrieve per \"page\" of results. If unspecified, the service will pick an appropriate default.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Study to list the Trial from. Format: `projects/{project}/locations/{location}/studies/{study}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/trials", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListTrialsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "listOptimalTrials": { - "description": "Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:listOptimalTrials", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.studies.trials.listOptimalTrials", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The name of the Study that the optimal Trial belongs to.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/trials:listOptimalTrials", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1ListOptimalTrialsRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListOptimalTrialsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "stop": { - "description": "Stops a Trial.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:stop", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.studies.trials.stop", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:stop", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1StopTrialRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1Trial" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "suggest": { - "description": "Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier. Returns a long-running operation associated with the generation of Trial suggestions. When this long-running operation succeeds, it will contain a SuggestTrialsResponse.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:suggest", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.studies.trials.suggest", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The project and location that the Study belongs to. Format: `projects/{project}/locations/{location}/studies/{study}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/trials:suggest", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1SuggestTrialsRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "parent": { + "description": "Required. The project requesting access for named model. Format: `projects/{project}`", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" } }, - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.studies.trials.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.studies.trials.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.studies.trials.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.studies.trials.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.studies.trials.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } + "path": "v1beta1/{+parent}/{+name}:enableModel", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1EnableModelRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1EnableModelResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + }, + "publishers": { + "resources": { + "models": { + "methods": { + "computeTokens": { + "description": "Return a list of tokens based on the input text.", + "flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:computeTokens", + "httpMethod": "POST", + "id": "aiplatform.publishers.models.computeTokens", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.", + "location": "path", + "pattern": "^publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}:computeTokens", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1ComputeTokensRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ComputeTokensResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "countTokens": { + "description": "Perform a token counting.", + "flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:countTokens", + "httpMethod": "POST", + "id": "aiplatform.publishers.models.countTokens", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" } - } + }, + "path": "v1beta1/{+endpoint}:countTokens", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1CountTokensRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1CountTokensResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] }, - "tensorboards": { - "methods": { - "batchRead": { - "description": "Reads multiple TensorboardTimeSeries' data. The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:batchRead", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.batchRead", - "parameterOrder": [ - "tensorboard" + "fetchPredictOperation": { + "description": "Fetch an asynchronous online prediction operation.", + "flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:fetchPredictOperation", + "httpMethod": "POST", + "id": "aiplatform.publishers.models.fetchPredictOperation", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`", + "location": "path", + "pattern": "^publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}:fetchPredictOperation", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1FetchPredictOperationRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "generateContent": { + "description": "Generate content with multimodal inputs.", + "flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:generateContent", + "httpMethod": "POST", + "id": "aiplatform.publishers.models.generateContent", + "parameterOrder": [ + "model" + ], + "parameters": { + "model": { + "description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+model}:generateContent", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "get": { + "description": "Gets a Model Garden publisher model.", + "flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}", + "httpMethod": "GET", + "id": "aiplatform.publishers.models.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "huggingFaceToken": { + "description": "Optional. Token used to access Hugging Face gated models.", + "location": "query", + "type": "string" + }, + "includeEquivalentModelGardenModelDeploymentConfigs": { + "description": "Optional. Whether to cnclude the deployment configs from the equivalent Model Garden model if the requested model is a Hugging Face model.", + "location": "query", + "type": "boolean" + }, + "isHuggingFaceModel": { + "description": "Optional. Boolean indicates whether the requested model is a Hugging Face model.", + "location": "query", + "type": "boolean" + }, + "languageCode": { + "description": "Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}`", + "location": "path", + "pattern": "^publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "Optional. PublisherModel view specifying which fields to read.", + "enum": [ + "PUBLISHER_MODEL_VIEW_UNSPECIFIED", + "PUBLISHER_MODEL_VIEW_BASIC", + "PUBLISHER_MODEL_VIEW_FULL", + "PUBLISHER_MODEL_VERSION_VIEW_BASIC" ], - "parameters": { - "tensorboard": { - "description": "Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`. The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", - "required": true, - "type": "string" - }, - "timeSeries": { - "description": "Required. The resource names of the TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", - "location": "query", - "repeated": true, - "type": "string" - } - }, - "path": "v1beta1/{+tensorboard}:batchRead", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1BatchReadTensorboardTimeSeriesDataResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "enumDescriptions": [ + "The default / unset value. The API will default to the BASIC view.", + "Include basic metadata about the publisher model, but not the full contents.", + "Include everything.", + "Include: VersionId, ModelVersionExternalName, and SupportedActions." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1PublisherModel" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists publisher models in Model Garden.", + "flatPath": "v1beta1/publishers/{publishersId}/models", + "httpMethod": "GET", + "id": "aiplatform.publishers.models.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The standard list filter.", + "location": "query", + "type": "string" }, - "create": { - "description": "Creates a Tensorboard.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards", + "languageCode": { + "description": "Optional. The IETF BCP-47 language code representing the language in which the publisher models' text information should be written in. If not set, by default English (en).", + "location": "query", + "type": "string" + }, + "listAllVersions": { + "description": "Optional. List all publisher model versions if the flag is set to true.", + "location": "query", + "type": "boolean" + }, + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token. Typically obtained via ListPublisherModelsResponse.next_page_token of the previous ModelGardenService.ListPublisherModels call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the Publisher from which to list the PublisherModels. Format: `publishers/{publisher}`", + "location": "path", + "pattern": "^publishers/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "Optional. PublisherModel view specifying which fields to read.", + "enum": [ + "PUBLISHER_MODEL_VIEW_UNSPECIFIED", + "PUBLISHER_MODEL_VIEW_BASIC", + "PUBLISHER_MODEL_VIEW_FULL", + "PUBLISHER_MODEL_VERSION_VIEW_BASIC" + ], + "enumDescriptions": [ + "The default / unset value. The API will default to the BASIC view.", + "Include basic metadata about the publisher model, but not the full contents.", + "Include everything.", + "Include: VersionId, ModelVersionExternalName, and SupportedActions." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/models", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListPublisherModelsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "predict": { + "description": "Perform an online prediction.", + "flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:predict", + "httpMethod": "POST", + "id": "aiplatform.publishers.models.predict", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}:predict", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1PredictRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1PredictResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "predictLongRunning": { + "description": "", + "flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:predictLongRunning", + "httpMethod": "POST", + "id": "aiplatform.publishers.models.predictLongRunning", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`", + "location": "path", + "pattern": "^publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}:predictLongRunning", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1PredictLongRunningRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "streamGenerateContent": { + "description": "Generate content with multimodal inputs with streaming support.", + "flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:streamGenerateContent", + "httpMethod": "POST", + "id": "aiplatform.publishers.models.streamGenerateContent", + "parameterOrder": [ + "model" + ], + "parameters": { + "model": { + "description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^publishers/[^/]+/models/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+model}:streamGenerateContent", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + } + } + }, + "ragCorpora": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/ragCorpora/{ragCorporaId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.ragCorpora.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^ragCorpora/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/ragCorpora/{ragCorporaId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.ragCorpora.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^ragCorpora/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/ragCorpora/{ragCorporaId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.ragCorpora.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^ragCorpora/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/ragCorpora/{ragCorporaId}/operations", + "httpMethod": "GET", + "id": "aiplatform.ragCorpora.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^ragCorpora/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/ragCorpora/{ragCorporaId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.ragCorpora.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^ragCorpora/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "ragFiles": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.tensorboards.create", + "id": "aiplatform.ragCorpora.ragFiles.operations.cancel", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the Tensorboard in. Format: `projects/{project}/locations/{location}`", + "name": { + "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/tensorboards", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1Tensorboard" - }, + "path": "v1beta1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { - "description": "Deletes a Tensorboard.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}", + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.tensorboards.delete", + "id": "aiplatform.ragCorpora.ragFiles.operations.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the Tensorboard to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", + "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", + "pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { - "description": "Gets a Tensorboard.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}", + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.get", + "id": "aiplatform.ragCorpora.ragFiles.operations.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", + "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", + "pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1Tensorboard" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists Tensorboards in a Location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.list", + "id": "aiplatform.ragCorpora.ragFiles.operations.list", "parameterOrder": [ - "parent" + "name" ], "parameters": { "filter": { - "description": "Lists the Tensorboards that match the filter expression.", + "description": "The standard list filter.", "location": "query", "type": "string" }, - "orderBy": { - "description": "Field to use to sort the list.", - "location": "query", + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+$", + "required": true, "type": "string" }, "pageSize": { - "description": "The maximum number of Tensorboards to return. The service may return fewer than this value. If unspecified, at most 100 Tensorboards are returned. The maximum value is 100; values above 100 are coerced to 100.", + "description": "The standard list page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A page token, received from a previous TensorboardService.ListTensorboards call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboards must match the call that provided the page token.", + "description": "The standard list page token.", "location": "query", "type": "string" }, - "parent": { - "description": "Required. The resource name of the Location to list Tensorboards. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", - "type": "string" + "type": "boolean" } }, - "path": "v1beta1/{+parent}/tensorboards", + "path": "v1beta1/{+name}/operations", "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListTensorboardsResponse" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "patch": { - "description": "Updates a Tensorboard.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.tensorboards.patch", + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.ragCorpora.ragFiles.operations.wait", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Output only. Name of the Tensorboard. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", + "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", + "pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, - "updateMask": { - "description": "Required. Field mask is used to specify the fields to be overwritten in the Tensorboard resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.", - "format": "google-fieldmask", + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", "location": "query", "type": "string" } }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1Tensorboard" - }, + "path": "v1beta1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + } + } + } + } + } + } + }, + "ragEngineConfig": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/ragEngineConfig/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.ragEngineConfig.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^ragEngineConfig/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/ragEngineConfig/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.ragEngineConfig.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^ragEngineConfig/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/ragEngineConfig/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.ragEngineConfig.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^ragEngineConfig/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/ragEngineConfig/operations", + "httpMethod": "GET", + "id": "aiplatform.ragEngineConfig.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" }, - "readSize": { - "description": "Returns the storage size for a given TensorBoard instance.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readSize", + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^ragEngineConfig$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/ragEngineConfig/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.ragEngineConfig.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^ragEngineConfig/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "reasoningEngines": { + "methods": { + "create": { + "description": "Creates a reasoning engine.", + "flatPath": "v1beta1/reasoningEngines", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.create", + "parameterOrder": [], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project}/locations/{location}`", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/reasoningEngines", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngine" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a reasoning engine.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}", + "httpMethod": "DELETE", + "id": "aiplatform.reasoningEngines.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a reasoning engine.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the ReasoningEngine resource. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngine" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists reasoning engines in a location.", + "flatPath": "v1beta1/reasoningEngines", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.list", + "parameterOrder": [], + "parameters": { + "filter": { + "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project}/locations/{location}`", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/reasoningEngines", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListReasoningEnginesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a reasoning engine.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}", + "httpMethod": "PATCH", + "id": "aiplatform.reasoningEngines.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Mask specifying which fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngine" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "query": { + "description": "Queries using a reasoning engine.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}:query", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.query", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:query", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1QueryReasoningEngineRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1QueryReasoningEngineResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "streamQuery": { + "description": "Streams queries using a reasoning engine.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}:streamQuery", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.streamQuery", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:streamQuery", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1StreamQueryReasoningEngineRequest" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "a2a": { + "resources": { + "v1": { + "methods": { + "card": { + "description": "Get request for reasoning engine instance via the A2A get protocol apis.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/card", "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.readSize", + "id": "aiplatform.reasoningEngines.a2a.v1.card", "parameterOrder": [ - "tensorboard" + "name", + "a2aEndpoint" ], "parameters": { - "tensorboard": { - "description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", + "a2aEndpoint": { + "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", + "pattern": "^v1/card$", "required": true, "type": "string" - } - }, - "path": "v1beta1/{+tensorboard}:readSize", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ReadTensorboardSizeResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "readUsage": { - "description": "Returns a list of monthly active users for a given TensorBoard instance.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readUsage", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.readUsage", - "parameterOrder": [ - "tensorboard" - ], - "parameters": { - "tensorboard": { - "description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", + }, + "historyLength": { + "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", + "pattern": "^reasoningEngines/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+tensorboard}:readUsage", + "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1ReadTensorboardUsageResponse" + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -23906,1387 +34069,1077 @@ } }, "resources": { - "experiments": { + "message": { "methods": { - "batchCreate": { - "description": "Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:batchCreate", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.tensorboards.experiments.batchCreate", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the TensorboardExperiment to create the TensorboardTimeSeries in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` The TensorboardRuns referenced by the parent fields in the CreateTensorboardTimeSeriesRequest messages must be sub resources of this TensorboardExperiment.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}:batchCreate", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1BatchCreateTensorboardTimeSeriesRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1BatchCreateTensorboardTimeSeriesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "create": { - "description": "Creates a TensorboardExperiment.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.tensorboards.experiments.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", - "required": true, - "type": "string" - }, - "tensorboardExperimentId": { - "description": "Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`.", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+parent}/experiments", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1TensorboardExperiment" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1TensorboardExperiment" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a TensorboardExperiment.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.tensorboards.experiments.delete", + "send": { + "description": "Send post request for reasoning engine instance via the A2A post protocol apis.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/message:send", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.a2a.v1.message.send", "parameterOrder": [ - "name" + "name", + "a2aEndpoint" ], "parameters": { + "a2aEndpoint": { + "description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send", + "location": "path", + "pattern": "^v1/message$", + "required": true, + "type": "string" + }, "name": { - "description": "Required. The name of the TensorboardExperiment to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", + "description": "Required. The full resource path of the reasoning engine, captured from the URL.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", + "pattern": "^reasoningEngines/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+name}", + "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:send", + "request": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, "response": { - "$ref": "GoogleLongrunningOperation" + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "get": { - "description": "Gets a TensorboardExperiment.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.experiments.get", + "stream": { + "description": "Streams queries using a reasoning engine instance via the A2A streaming protocol apis.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/message:stream", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.a2a.v1.message.stream", "parameterOrder": [ - "name" + "name", + "a2aEndpoint" ], "parameters": { + "a2aEndpoint": { + "description": "Required. The http endpoint extracted from the URL path. e.g., v1/message:stream.", + "location": "path", + "pattern": "^v1/message$", + "required": true, + "type": "string" + }, "name": { - "description": "Required. The name of the TensorboardExperiment resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", + "description": "Required. The full resource path of the reasoning engine, captured from the URL.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", + "pattern": "^reasoningEngines/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+name}", + "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:stream", + "request": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1TensorboardExperiment" + "$ref": "GoogleApiHttpBody" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "list": { - "description": "Lists TensorboardExperiments in a Location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments", + } + } + }, + "tasks": { + "methods": { + "a2aGetReasoningEngine": { + "description": "Get request for reasoning engine instance via the A2A get protocol apis.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.experiments.list", + "id": "aiplatform.reasoningEngines.a2a.v1.tasks.a2aGetReasoningEngine", "parameterOrder": [ - "parent" + "name", + "a2aEndpoint" ], "parameters": { - "filter": { - "description": "Lists the TensorboardExperiments that match the filter expression.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "Field to use to sort the list.", - "location": "query", + "a2aEndpoint": { + "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", + "location": "path", + "pattern": "^v1/tasks/[^/]+$", + "required": true, "type": "string" }, - "pageSize": { - "description": "The maximum number of TensorboardExperiments to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardExperiments are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous TensorboardService.ListTensorboardExperiments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardExperiments must match the call that provided the page token.", + "historyLength": { + "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "location": "query", "type": "string" }, - "parent": { - "description": "Required. The resource name of the Tensorboard to list TensorboardExperiments. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", + "name": { + "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", + "pattern": "^reasoningEngines/[^/]+$", "required": true, "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" } }, - "path": "v1beta1/{+parent}/experiments", + "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListTensorboardExperimentsResponse" + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "patch": { - "description": "Updates a TensorboardExperiment.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.tensorboards.experiments.patch", + "cancel": { + "description": "Send post request for reasoning engine instance via the A2A post protocol apis.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.a2a.v1.tasks.cancel", "parameterOrder": [ - "name" + "name", + "a2aEndpoint" ], "parameters": { - "name": { - "description": "Output only. Name of the TensorboardExperiment. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", + "a2aEndpoint": { + "description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", + "pattern": "^v1/tasks/[^/]+$", "required": true, "type": "string" }, - "updateMask": { - "description": "Required. Field mask is used to specify the fields to be overwritten in the TensorboardExperiment resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1TensorboardExperiment" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1TensorboardExperiment" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "write": { - "description": "Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. If any data fail to be ingested, an error is returned.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:write", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.tensorboards.experiments.write", - "parameterOrder": [ - "tensorboardExperiment" - ], - "parameters": { - "tensorboardExperiment": { - "description": "Required. The resource name of the TensorboardExperiment to write data to. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", + "name": { + "description": "Required. The full resource path of the reasoning engine, captured from the URL.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", + "pattern": "^reasoningEngines/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+tensorboardExperiment}:write", + "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:cancel", "request": { - "$ref": "GoogleCloudAiplatformV1beta1WriteTensorboardExperimentDataRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1WriteTensorboardExperimentDataResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.tensorboards.experiments.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.tensorboards.experiments.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.experiments.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.experiments.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.tensorboards.experiments.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, - "runs": { - "methods": { - "batchCreate": { - "description": "Batch create TensorboardRuns.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs:batchCreate", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.batchCreate", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the TensorboardExperiment to create the TensorboardRuns in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` The parent field in the CreateTensorboardRunRequest messages must match this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/runs:batchCreate", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1BatchCreateTensorboardRunsRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1BatchCreateTensorboardRunsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "create": { - "description": "Creates a TensorboardRun.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", - "required": true, - "type": "string" - }, - "tensorboardRunId": { - "description": "Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`.", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+parent}/runs", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1TensorboardRun" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1TensorboardRun" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a TensorboardRun.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the TensorboardRun to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets a TensorboardRun.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the TensorboardRun resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1TensorboardRun" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists TensorboardRuns in a Location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Lists the TensorboardRuns that match the filter expression.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "Field to use to sort the list.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of TensorboardRuns to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardRuns are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous TensorboardService.ListTensorboardRuns call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardRuns must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+parent}/runs", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListTensorboardRunsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" }, - "patch": { - "description": "Updates a TensorboardRun.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Output only. Name of the TensorboardRun. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Required. Field mask is used to specify the fields to be overwritten in the TensorboardRun resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1TensorboardRun" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1TensorboardRun" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "type": "object" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" }, - "write": { - "description": "Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}:write", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.write", - "parameterOrder": [ - "tensorboardRun" - ], - "parameters": { - "tensorboardRun": { - "description": "Required. The resource name of the TensorboardRun to write data to. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+tensorboardRun}:write", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1WriteTensorboardRunDataRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1WriteTensorboardRunDataResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "type": "object" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "pushNotificationConfigs": { + "description": "Get request for reasoning engine instance via the A2A get protocol apis.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs", + "parameterOrder": [ + "name", + "a2aEndpoint" + ], + "parameters": { + "a2aEndpoint": { + "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", + "location": "path", + "pattern": "^v1/tasks/[^/]+/pushNotificationConfigs$", + "required": true, + "type": "string" + }, + "historyLength": { + "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" } }, - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } + "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", + "response": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" }, - "timeSeries": { - "methods": { - "create": { - "description": "Creates a TensorboardTimeSeries.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the TensorboardRun to create the TensorboardTimeSeries in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", - "required": true, - "type": "string" - }, - "tensorboardTimeSeriesId": { - "description": "Optional. The user specified unique ID to use for the TensorboardTimeSeries, which becomes the final component of the TensorboardTimeSeries's resource name. This value should match \"a-z0-9{0, 127}\"", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+parent}/timeSeries", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1TensorboardTimeSeries" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1TensorboardTimeSeries" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a TensorboardTimeSeries.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the TensorboardTimeSeries to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "exportTensorboardTimeSeries": { - "description": "Exports a TensorboardTimeSeries' data. Data is returned in paginated responses.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:exportTensorboardTimeSeries", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.exportTensorboardTimeSeries", - "parameterOrder": [ - "tensorboardTimeSeries" - ], - "parameters": { - "tensorboardTimeSeries": { - "description": "Required. The resource name of the TensorboardTimeSeries to export data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+tensorboardTimeSeries}:exportTensorboardTimeSeries", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1ExportTensorboardTimeSeriesDataRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ExportTensorboardTimeSeriesDataResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets a TensorboardTimeSeries.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the TensorboardTimeSeries resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1TensorboardTimeSeries" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists TensorboardTimeSeries in a Location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Lists the TensorboardTimeSeries that match the filter expression.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "Field to use to sort the list.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of TensorboardTimeSeries to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardTimeSeries are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous TensorboardService.ListTensorboardTimeSeries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardTimeSeries must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+parent}/timeSeries", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListTensorboardTimeSeriesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "patch": { - "description": "Updates a TensorboardTimeSeries.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Output only. Name of the TensorboardTimeSeries.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Required. Field mask is used to specify the fields to be overwritten in the TensorboardTimeSeries resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1TensorboardTimeSeries" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1TensorboardTimeSeries" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "type": "object" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "subscribe": { + "description": "Stream get request for reasoning engine instance via the A2A stream get protocol apis.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}:subscribe", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.a2a.v1.tasks.subscribe", + "parameterOrder": [ + "name", + "a2aEndpoint" + ], + "parameters": { + "a2aEndpoint": { + "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123:subscribe`.", + "location": "path", + "pattern": "^v1/tasks/[^/]+$", + "required": true, + "type": "string" + }, + "name": { + "description": "Required. The full resource path of the reasoning engine, captured from the URL.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:subscribe", + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "pushNotificationConfigs": { + "methods": { + "a2aGetReasoningEngine": { + "description": "Get request for reasoning engine instance via the A2A get protocol apis.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs.a2aGetReasoningEngine", + "parameterOrder": [ + "name", + "a2aEndpoint" + ], + "parameters": { + "a2aEndpoint": { + "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", + "location": "path", + "pattern": "^v1/tasks/[^/]+/pushNotificationConfigs/[^/]+$", + "required": true, + "type": "string" }, - "read": { - "description": "Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:read", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.read", - "parameterOrder": [ - "tensorboardTimeSeries" - ], - "parameters": { - "filter": { - "description": "Reads the TensorboardTimeSeries' data that match the filter expression.", - "location": "query", - "type": "string" - }, - "maxDataPoints": { - "description": "The maximum number of TensorboardTimeSeries' data to return. This value should be a positive integer. This value can be set to -1 to return all data.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "tensorboardTimeSeries": { - "description": "Required. The resource name of the TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+tensorboardTimeSeries}:read", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ReadTensorboardTimeSeriesDataResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "historyLength": { + "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", + "location": "query", + "type": "string" }, - "readBlobData": { - "description": "Gets bytes of TensorboardBlobs. This is to allow reading blob data stored in consumer project's Cloud Storage bucket without users having to obtain Cloud Storage access permission.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:readBlobData", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.readBlobData", - "parameterOrder": [ - "timeSeries" - ], - "parameters": { - "blobIds": { - "description": "IDs of the blobs to read.", - "location": "query", - "repeated": true, - "type": "string" - }, - "timeSeries": { - "description": "Required. The resource name of the TensorboardTimeSeries to list Blobs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+timeSeries}:readBlobData", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ReadTensorboardBlobDataResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "name": { + "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" } }, - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } + "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", + "response": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } } - } + } + } + } + } + } + }, + "examples": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.examples.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.reasoningEngines.examples.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.examples.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.examples.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "memories": { + "methods": { + "create": { + "description": "Create a Memory.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.memories.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the ReasoningEngine to create the Memory under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/memories", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Memory" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Delete a Memory.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}", + "httpMethod": "DELETE", + "id": "aiplatform.reasoningEngines.memories.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Memory to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/memories/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "generate": { + "description": "Generate memories.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories:generate", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.memories.generate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the ReasoningEngine to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/memories:generate", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1GenerateMemoriesRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get a Memory.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.memories.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/memories/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1Memory" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List Memories.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.memories.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `scope` (as a JSON string)", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. The standard list order by string. If not specified, the default order is `create_time desc`. If specified, the default sorting order of provided fields is ascending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the ReasoningEngine to list the Memories under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/memories", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListMemoriesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Update a Memory.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}", + "httpMethod": "PATCH", + "id": "aiplatform.reasoningEngines.memories.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/memories/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Mask specifying which fields to update. Supported fields: * `display_name` * `description` * `fact`", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Memory" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "retrieve": { + "description": "Retrieve memories.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories:retrieve", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.memories.retrieve", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the ReasoningEngine to retrieve memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/memories:retrieve", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1RetrieveMemoriesRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1RetrieveMemoriesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "rollback": { + "description": "Rollback Memory to a specific revision.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}:rollback", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.memories.rollback", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Memory to rollback. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/memories/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:rollback", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1RollbackMemoryRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.memories.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.tensorboards.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.reasoningEngines.memories.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.memories.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.memories.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.tensorboards.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/memories/[^/]+$", + "required": true, + "type": "string" }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.tensorboards.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.tensorboards.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } - } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.memories.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "revisions": { + "methods": { + "get": { + "description": "Get a Memory Revision.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/revisions/{revisionsId}", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.memories.revisions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Memory Revision to retrieve. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{revision}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/memories/[^/]+/revisions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1MemoryRevision" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List Memory Revisions for a Memory.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/revisions", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.memories.revisions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `labels`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Memory to list revisions for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/memories/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/revisions", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListMemoryRevisionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.reasoningEngines.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } - } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "trainingPipelines": { + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "sandboxEnvironments": { + "resources": { + "operations": { "methods": { "cancel": { - "description": "Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetTrainingPipeline or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead it becomes a pipeline with a TrainingPipeline.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TrainingPipeline.state is set to `CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}:cancel", + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.trainingPipelines.cancel", + "id": "aiplatform.reasoningEngines.sandboxEnvironments.operations.cancel", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the TrainingPipeline to cancel. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`", + "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", + "pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}:cancel", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1CancelTrainingPipelineRequest" - }, "response": { "$ref": "GoogleProtobufEmpty" }, @@ -25294,98 +35147,77 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "create": { - "description": "Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.trainingPipelines.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the TrainingPipeline in. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/trainingPipelines", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1TrainingPipeline" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1TrainingPipeline" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "delete": { - "description": "Deletes a TrainingPipeline.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}", + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.trainingPipelines.delete", + "id": "aiplatform.reasoningEngines.sandboxEnvironments.operations.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the TrainingPipeline resource to be deleted. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`", + "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", + "pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { - "description": "Gets a TrainingPipeline.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}", + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.trainingPipelines.get", + "id": "aiplatform.reasoningEngines.sandboxEnvironments.operations.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the TrainingPipeline resource. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`", + "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", + "pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1TrainingPipeline" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists TrainingPipelines in a Location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.trainingPipelines.list", + "id": "aiplatform.reasoningEngines.sandboxEnvironments.operations.list", "parameterOrder": [ - "parent" + "name" ], "parameters": { "filter": { - "description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `training_task_definition` `=`, `!=` comparisons, and `:` wildcard. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"PIPELINE_STATE_SUCCEEDED\" AND display_name:\"my_pipeline_*\"` * `state!=\"PIPELINE_STATE_FAILED\" OR display_name=\"my_pipeline\"` * `NOT display_name=\"my_pipeline\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `training_task_definition:\"*automl_text_classification*\"`", + "description": "The standard list filter.", "location": "query", "type": "string" }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", + "required": true, + "type": "string" + }, "pageSize": { "description": "The standard list page size.", "format": "int32", @@ -25393,215 +35225,314 @@ "type": "integer" }, "pageToken": { - "description": "The standard list page token. Typically obtained via ListTrainingPipelinesResponse.next_page_token of the previous PipelineService.ListTrainingPipelines call.", + "description": "The standard list page token.", "location": "query", "type": "string" }, - "parent": { - "description": "Required. The resource name of the Location to list the TrainingPipelines from. Format: `projects/{project}/locations/{location}`", + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.sandboxEnvironments.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", "location": "query", "type": "string" } }, - "path": "v1beta1/{+parent}/trainingPipelines", + "path": "v1beta1/{+name}:wait", "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListTrainingPipelinesResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } + } + } + } + }, + "sessions": { + "methods": { + "appendEvent": { + "description": "Appends an event to a given session.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}:appendEvent", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.sessions.appendEvent", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the session to append event to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + } }, - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.trainingPipelines.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.trainingPipelines.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.trainingPipelines.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "path": "v1beta1/{+name}:appendEvent", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1SessionEvent" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1AppendEventResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a new Session.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.sessions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the location to create the session in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/sessions", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Session" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes details of the specific Session.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", + "httpMethod": "DELETE", + "id": "aiplatform.reasoningEngines.sessions.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of the specific Session.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.sessions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1Session" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Sessions in a given reasoning engine.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.sessions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The standard list filter. Supported fields: * `display_name` * `user_id` Example: `display_name=\"abc\"`, `user_id=\"123\"`.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of sessions to return. The service may return fewer than this value. If unspecified, at most 100 sessions will be returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The next_page_token value returned from a previous list SessionService.ListSessions call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the location to list sessions from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/sessions", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListSessionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the specific Session.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", + "httpMethod": "PATCH", + "id": "aiplatform.reasoningEngines.sessions.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask is used 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": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Session" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1Session" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "events": { + "methods": { + "list": { + "description": "Lists Events in a given session.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/events", + "httpMethod": "GET", + "id": "aiplatform.reasoningEngines.sessions.events.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The standard list filter. Supported fields: * `timestamp` range (i.e. `timestamp>=\"2025-01-31T11:30:00-04:00\"` where the timestamp is in RFC 3339 format) More detail in [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.trainingPipelines.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageSize": { + "description": "Optional. The maximum number of events to return. The service may return fewer than this value. If unspecified, at most 100 events will be returned. These events are ordered by timestamp in ascending order.", + "format": "int32", + "location": "query", + "type": "integer" }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.trainingPipelines.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageToken": { + "description": "Optional. The next_page_token value returned from a previous list SessionService.ListEvents call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the session to list events from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" } - } + }, + "path": "v1beta1/{+parent}/events", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListEventsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } }, - "tuningJobs": { + "operations": { "methods": { "cancel": { - "description": "Cancels a TuningJob. Starts asynchronous cancellation on the TuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use GenAiTuningService.GetTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the TuningJob is not deleted; instead it becomes a job with a TuningJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TuningJob.state is set to `CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}:cancel", + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.tuningJobs.cancel", + "id": "aiplatform.reasoningEngines.sessions.operations.cancel", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the TuningJob to cancel. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`", + "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$", + "pattern": "^reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}:cancel", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1CancelTuningJobRequest" - }, "response": { "$ref": "GoogleProtobufEmpty" }, @@ -25609,149 +35540,126 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "create": { - "description": "Creates a TuningJob. A created TuningJob right away will be attempted to be run.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.tuningJobs.create", + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.reasoningEngines.sessions.operations.delete", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the TuningJob in. Format: `projects/{project}/locations/{location}`", + "name": { + "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/tuningJobs", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1TuningJob" - }, + "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1TuningJob" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { - "description": "Gets a TuningJob.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}", + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.tuningJobs.get", + "id": "aiplatform.reasoningEngines.sessions.operations.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the TuningJob resource. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`", + "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$", + "pattern": "^reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1TuningJob" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists TuningJobs in a Location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.tuningJobs.list", + "id": "aiplatform.reasoningEngines.sessions.operations.list", "parameterOrder": [ - "parent" + "name" ], "parameters": { "filter": { - "description": "Optional. The standard list filter.", + "description": "The standard list filter.", "location": "query", "type": "string" }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + }, "pageSize": { - "description": "Optional. The standard list page size.", + "description": "The standard list page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. The standard list page token. Typically obtained via ListTuningJobsResponse.next_page_token of the previous GenAiTuningService.ListTuningJob][] call.", + "description": "The standard list page token.", "location": "query", "type": "string" }, - "parent": { - "description": "Required. The resource name of the Location to list the TuningJobs from. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, - "path": "v1beta1/{+parent}/tuningJobs", + "path": "v1beta1/{+name}/operations", "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListTuningJobsResponse" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "optimizePrompt": { - "description": "Optimizes a prompt.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs:optimizePrompt", + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.tuningJobs.optimizePrompt", + "id": "aiplatform.reasoningEngines.sessions.operations.wait", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "parent": { - "description": "Required. The resource name of the Location to optimize the prompt in. Format: `projects/{project}/locations/{location}`", + "name": { + "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", "required": true, "type": "string" - } - }, - "path": "v1beta1/{+parent}/tuningJobs:optimizePrompt", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1OptimizePromptRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1OptimizePromptResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "rebaseTunedModel": { - "description": "Rebase a TunedModel.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs:rebaseTunedModel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.tuningJobs.rebaseTunedModel", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the Location into which to rebase the Model. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", "type": "string" } }, - "path": "v1beta1/{+parent}/tuningJobs:rebaseTunedModel", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1RebaseTunedModelRequest" - }, + "path": "v1beta1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, @@ -25759,1042 +35667,1225 @@ "https://www.googleapis.com/auth/cloud-platform" ] } - }, - "resources": { - "operations": { - "methods": { - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.tuningJobs.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } } } } - }, - "modelGardenEula": { + } + } + }, + "schedules": { + "resources": { + "operations": { "methods": { - "accept": { - "description": "Accepts the EULA acceptance status of a publisher model.", - "flatPath": "v1beta1/projects/{projectsId}/modelGardenEula:accept", + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/schedules/{schedulesId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.modelGardenEula.accept", + "id": "aiplatform.schedules.operations.cancel", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "parent": { - "description": "Required. The project requesting access for named model. The format is `projects/{project}`.", + "name": { + "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+$", + "pattern": "^schedules/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/modelGardenEula:accept", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1AcceptPublisherModelEulaRequest" + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/schedules/{schedulesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.schedules.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^schedules/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } }, + "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1PublisherModelEulaAcceptance" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "check": { - "description": "Checks the EULA acceptance status of a publisher model.", - "flatPath": "v1beta1/projects/{projectsId}/modelGardenEula:check", - "httpMethod": "POST", - "id": "aiplatform.projects.modelGardenEula.check", + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/schedules/{schedulesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.schedules.operations.get", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "parent": { - "description": "Required. The project requesting access for named model. The format is `projects/{project}`.", + "name": { + "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+$", + "pattern": "^schedules/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/modelGardenEula:check", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1CheckPublisherModelEulaAcceptanceRequest" + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/schedules/{schedulesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.schedules.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^schedules/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } }, + "path": "v1beta1/{+name}/operations", "response": { - "$ref": "GoogleCloudAiplatformV1beta1PublisherModelEulaAcceptance" + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/schedules/{schedulesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.schedules.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^schedules/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } - }, - "publishers": { - "resources": { - "models": { - "methods": { - "enableModel": { - "description": "Enables model for the project if prerequisites are met (e.g. completed questionnaire and consents, or an active Private Offer).", - "flatPath": "v1beta1/projects/{projectsId}/publishers/{publishersId}/models/{modelsId}:enableModel", - "httpMethod": "POST", - "id": "aiplatform.projects.publishers.models.enableModel", - "parameterOrder": [ - "parent", - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}`", - "location": "path", - "pattern": "^publishers/[^/]+/models/[^/]+$", - "required": true, - "type": "string" - }, - "parent": { - "description": "Required. The project requesting access for named model. Format: `projects/{project}`", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/{+name}:enableModel", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1EnableModelRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1EnableModelResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + } + } + }, + "solvers": { + "resources": { + "operations": { + "methods": { + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/solvers/{solversId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.solvers.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^solvers/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" } - } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/solvers/{solversId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.solvers.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^solvers/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/solvers/{solversId}/operations", + "httpMethod": "GET", + "id": "aiplatform.solvers.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^solvers/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } } } }, - "publishers": { + "specialistPools": { "resources": { - "models": { + "operations": { "methods": { - "computeTokens": { - "description": "Return a list of tokens based on the input text.", - "flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:computeTokens", + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/specialistPools/{specialistPoolsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.publishers.models.computeTokens", + "id": "aiplatform.specialistPools.operations.cancel", "parameterOrder": [ - "endpoint" + "name" ], "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.", + "name": { + "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^publishers/[^/]+/models/[^/]+$", + "pattern": "^specialistPools/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+endpoint}:computeTokens", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1ComputeTokensRequest" + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/specialistPools/{specialistPoolsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.specialistPools.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^specialistPools/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } }, + "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1ComputeTokensResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "countTokens": { - "description": "Perform a token counting.", - "flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:countTokens", - "httpMethod": "POST", - "id": "aiplatform.publishers.models.countTokens", + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/specialistPools/{specialistPoolsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.specialistPools.operations.get", "parameterOrder": [ - "endpoint" + "name" ], "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "name": { + "description": "The name of the operation resource.", "location": "path", - "pattern": "^publishers/[^/]+/models/[^/]+$", + "pattern": "^specialistPools/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+endpoint}:countTokens", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1CountTokensRequest" + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/specialistPools/{specialistPoolsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.specialistPools.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^specialistPools/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } }, + "path": "v1beta1/{+name}/operations", "response": { - "$ref": "GoogleCloudAiplatformV1beta1CountTokensResponse" + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/specialistPools/{specialistPoolsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.specialistPools.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^specialistPools/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$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" ] - }, - "fetchPredictOperation": { - "description": "Fetch an asynchronous online prediction operation.", - "flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:fetchPredictOperation", + } + } + } + } + }, + "studies": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/studies/{studiesId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.publishers.models.fetchPredictOperation", + "id": "aiplatform.studies.operations.cancel", "parameterOrder": [ - "endpoint" + "name" ], "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`", + "name": { + "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^publishers/[^/]+/models/[^/]+$", + "pattern": "^studies/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+endpoint}:fetchPredictOperation", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1FetchPredictOperationRequest" - }, + "path": "v1beta1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningOperation" + "$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" ] }, - "generateContent": { - "description": "Generate content with multimodal inputs.", - "flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:generateContent", - "httpMethod": "POST", - "id": "aiplatform.publishers.models.generateContent", + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/studies/{studiesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.studies.operations.delete", "parameterOrder": [ - "model" + "name" ], "parameters": { - "model": { - "description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "name": { + "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^publishers/[^/]+/models/[^/]+$", + "pattern": "^studies/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+model}:generateContent", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest" - }, + "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse" + "$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": { - "description": "Gets a Model Garden publisher model.", - "flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}", + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/studies/{studiesId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.publishers.models.get", + "id": "aiplatform.studies.operations.get", "parameterOrder": [ "name" ], "parameters": { - "huggingFaceToken": { - "description": "Optional. Token used to access Hugging Face gated models.", - "location": "query", - "type": "string" - }, - "includeEquivalentModelGardenModelDeploymentConfigs": { - "description": "Optional. Whether to cnclude the deployment configs from the equivalent Model Garden model if the requested model is a Hugging Face model.", - "location": "query", - "type": "boolean" - }, - "isHuggingFaceModel": { - "description": "Optional. Boolean indicates whether the requested model is a Hugging Face model.", - "location": "query", - "type": "boolean" - }, - "languageCode": { - "description": "Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in.", - "location": "query", - "type": "string" - }, "name": { - "description": "Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}`", + "description": "The name of the operation resource.", "location": "path", - "pattern": "^publishers/[^/]+/models/[^/]+$", + "pattern": "^studies/[^/]+/operations/[^/]+$", "required": true, "type": "string" - }, - "view": { - "description": "Optional. PublisherModel view specifying which fields to read.", - "enum": [ - "PUBLISHER_MODEL_VIEW_UNSPECIFIED", - "PUBLISHER_MODEL_VIEW_BASIC", - "PUBLISHER_MODEL_VIEW_FULL", - "PUBLISHER_MODEL_VERSION_VIEW_BASIC" - ], - "enumDescriptions": [ - "The default / unset value. The API will default to the BASIC view.", - "Include basic metadata about the publisher model, but not the full contents.", - "Include everything.", - "Include: VersionId, ModelVersionExternalName, and SupportedActions." - ], - "location": "query", - "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1PublisherModel" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists publisher models in Model Garden.", - "flatPath": "v1beta1/publishers/{publishersId}/models", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/studies/{studiesId}/operations", "httpMethod": "GET", - "id": "aiplatform.publishers.models.list", + "id": "aiplatform.studies.operations.list", "parameterOrder": [ - "parent" + "name" ], "parameters": { "filter": { - "description": "Optional. The standard list filter.", - "location": "query", - "type": "string" - }, - "languageCode": { - "description": "Optional. The IETF BCP-47 language code representing the language in which the publisher models' text information should be written in. If not set, by default English (en).", + "description": "The standard list filter.", "location": "query", "type": "string" }, - "listAllVersions": { - "description": "Optional. List all publisher model versions if the flag is set to true.", - "location": "query", - "type": "boolean" - }, - "orderBy": { - "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", - "location": "query", + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^studies/[^/]+$", + "required": true, "type": "string" }, "pageSize": { - "description": "Optional. The standard list page size.", + "description": "The standard list page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. The standard list page token. Typically obtained via ListPublisherModelsResponse.next_page_token of the previous ModelGardenService.ListPublisherModels call.", + "description": "The standard list page token.", "location": "query", "type": "string" }, - "parent": { - "description": "Required. The name of the Publisher from which to list the PublisherModels. Format: `publishers/{publisher}`", - "location": "path", - "pattern": "^publishers/[^/]+$", - "required": true, - "type": "string" - }, - "view": { - "description": "Optional. PublisherModel view specifying which fields to read.", - "enum": [ - "PUBLISHER_MODEL_VIEW_UNSPECIFIED", - "PUBLISHER_MODEL_VIEW_BASIC", - "PUBLISHER_MODEL_VIEW_FULL", - "PUBLISHER_MODEL_VERSION_VIEW_BASIC" - ], - "enumDescriptions": [ - "The default / unset value. The API will default to the BASIC view.", - "Include basic metadata about the publisher model, but not the full contents.", - "Include everything.", - "Include: VersionId, ModelVersionExternalName, and SupportedActions." - ], + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", - "type": "string" + "type": "boolean" } }, - "path": "v1beta1/{+parent}/models", + "path": "v1beta1/{+name}/operations", "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListPublisherModelsResponse" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "predict": { - "description": "Perform an online prediction.", - "flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:predict", + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/studies/{studiesId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.publishers.models.predict", + "id": "aiplatform.studies.operations.wait", "parameterOrder": [ - "endpoint" + "name" ], "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "name": { + "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^publishers/[^/]+/models/[^/]+$", + "pattern": "^studies/[^/]+/operations/[^/]+$", "required": true, "type": "string" - } - }, - "path": "v1beta1/{+endpoint}:predict", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1PredictRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1PredictResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "predictLongRunning": { - "description": "", - "flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:predictLongRunning", - "httpMethod": "POST", - "id": "aiplatform.publishers.models.predictLongRunning", - "parameterOrder": [ - "endpoint" - ], - "parameters": { - "endpoint": { - "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`", - "location": "path", - "pattern": "^publishers/[^/]+/models/[^/]+$", - "required": true, + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", "type": "string" } }, - "path": "v1beta1/{+endpoint}:predictLongRunning", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1PredictLongRunningRequest" - }, + "path": "v1beta1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "streamGenerateContent": { - "description": "Generate content with multimodal inputs with streaming support.", - "flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:streamGenerateContent", - "httpMethod": "POST", - "id": "aiplatform.publishers.models.streamGenerateContent", - "parameterOrder": [ - "model" - ], - "parameters": { - "model": { - "description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", - "location": "path", - "pattern": "^publishers/[^/]+/models/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+model}:streamGenerateContent", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" + "https://www.googleapis.com/auth/cloud-platform" ] } } - } - } - }, - "reasoningEngines": { - "methods": { - "create": { - "description": "Creates a reasoning engine.", - "flatPath": "v1beta1/reasoningEngines", - "httpMethod": "POST", - "id": "aiplatform.reasoningEngines.create", - "parameterOrder": [], - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project}/locations/{location}`", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/reasoningEngines", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngine" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a reasoning engine.", - "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}", - "httpMethod": "DELETE", - "id": "aiplatform.reasoningEngines.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "force": { - "description": "Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources.", - "location": "query", - "type": "boolean" - }, - "name": { - "description": "Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", - "location": "path", - "pattern": "^reasoningEngines/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets a reasoning engine.", - "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}", - "httpMethod": "GET", - "id": "aiplatform.reasoningEngines.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the ReasoningEngine resource. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", - "location": "path", - "pattern": "^reasoningEngines/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngine" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists reasoning engines in a location.", - "flatPath": "v1beta1/reasoningEngines", - "httpMethod": "GET", - "id": "aiplatform.reasoningEngines.list", - "parameterOrder": [], - "parameters": { - "filter": { - "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The standard list page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project}/locations/{location}`", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/reasoningEngines", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListReasoningEnginesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "patch": { - "description": "Updates a reasoning engine.", - "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}", - "httpMethod": "PATCH", - "id": "aiplatform.reasoningEngines.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", - "location": "path", - "pattern": "^reasoningEngines/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Optional. Mask specifying which fields to update.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngine" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "query": { - "description": "Queries using a reasoning engine.", - "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}:query", - "httpMethod": "POST", - "id": "aiplatform.reasoningEngines.query", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", - "location": "path", - "pattern": "^reasoningEngines/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:query", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1QueryReasoningEngineRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1QueryReasoningEngineResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] }, - "streamQuery": { - "description": "Streams queries using a reasoning engine.", - "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}:streamQuery", - "httpMethod": "POST", - "id": "aiplatform.reasoningEngines.streamQuery", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", - "location": "path", - "pattern": "^reasoningEngines/[^/]+$", - "required": true, - "type": "string" + "trials": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.studies.trials.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^studies/[^/]+/trials/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.studies.trials.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^studies/[^/]+/trials/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.studies.trials.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^studies/[^/]+/trials/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/studies/{studiesId}/trials/{trialsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.studies.trials.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^studies/[^/]+/trials/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.studies.trials.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^studies/[^/]+/trials/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } - }, - "path": "v1beta1/{+name}:streamQuery", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1StreamQueryReasoningEngineRequest" - }, - "response": { - "$ref": "GoogleApiHttpBody" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + } } - }, + } + }, + "tensorboards": { "resources": { - "a2a": { + "experiments": { "resources": { - "v1": { + "operations": { "methods": { - "card": { - "description": "Get request for reasoning engine instance via the A2A get protocol apis.", - "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/card", + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.tensorboards.experiments.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.tensorboards.experiments.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.reasoningEngines.a2a.v1.card", + "id": "aiplatform.tensorboards.experiments.operations.get", "parameterOrder": [ - "name", - "a2aEndpoint" + "name" ], "parameters": { - "a2aEndpoint": { - "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", + "name": { + "description": "The name of the operation resource.", "location": "path", - "pattern": "^v1/card$", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", "required": true, "type": "string" - }, - "historyLength": { - "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.tensorboards.experiments.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", "location": "query", "type": "string" }, "name": { - "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^reasoningEngines/[^/]+$", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+$", "required": true, "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, - "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", + "path": "v1beta1/{+name}/operations", "response": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.tensorboards.experiments.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" }, - "type": "object" + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } - }, + } + }, + "runs": { "resources": { - "message": { + "operations": { "methods": { - "send": { - "description": "Send post request for reasoning engine instance via the A2A post protocol apis.", - "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/message:send", + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.reasoningEngines.a2a.v1.message.send", + "id": "aiplatform.tensorboards.experiments.runs.operations.cancel", "parameterOrder": [ - "name", - "a2aEndpoint" + "name" ], "parameters": { - "a2aEndpoint": { - "description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send", - "location": "path", - "pattern": "^v1/message$", - "required": true, - "type": "string" - }, "name": { - "description": "Required. The full resource path of the reasoning engine, captured from the URL.", + "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^reasoningEngines/[^/]+$", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:send", - "request": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "type": "object" - }, + "path": "v1beta1/{+name}:cancel", "response": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "type": "object" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "stream": { - "description": "Streams queries using a reasoning engine instance via the A2A streaming protocol apis.", - "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/message:stream", - "httpMethod": "POST", - "id": "aiplatform.reasoningEngines.a2a.v1.message.stream", + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.tensorboards.experiments.runs.operations.delete", "parameterOrder": [ - "name", - "a2aEndpoint" + "name" ], "parameters": { - "a2aEndpoint": { - "description": "Required. The http endpoint extracted from the URL path. e.g., v1/message:stream.", - "location": "path", - "pattern": "^v1/message$", - "required": true, - "type": "string" - }, "name": { - "description": "Required. The full resource path of the reasoning engine, captured from the URL.", + "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^reasoningEngines/[^/]+$", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:stream", - "request": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "type": "object" - }, + "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleApiHttpBody" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - } - } - }, - "tasks": { - "methods": { - "a2aGetReasoningEngine": { - "description": "Get request for reasoning engine instance via the A2A get protocol apis.", - "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}", + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.reasoningEngines.a2a.v1.tasks.a2aGetReasoningEngine", + "id": "aiplatform.tensorboards.experiments.runs.operations.get", "parameterOrder": [ - "name", - "a2aEndpoint" + "name" ], "parameters": { - "a2aEndpoint": { - "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", - "location": "path", - "pattern": "^v1/tasks/[^/]+$", - "required": true, - "type": "string" - }, - "historyLength": { - "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", - "location": "query", - "type": "string" - }, "name": { - "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "description": "The name of the operation resource.", "location": "path", - "pattern": "^reasoningEngines/[^/]+$", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", + "path": "v1beta1/{+name}", "response": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "type": "object" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "cancel": { - "description": "Send post request for reasoning engine instance via the A2A post protocol apis.", - "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.reasoningEngines.a2a.v1.tasks.cancel", + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.tensorboards.experiments.runs.operations.list", "parameterOrder": [ - "name", - "a2aEndpoint" + "name" ], "parameters": { - "a2aEndpoint": { - "description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send", - "location": "path", - "pattern": "^v1/tasks/[^/]+$", - "required": true, + "filter": { + "description": "The standard list filter.", + "location": "query", "type": "string" }, "name": { - "description": "Required. The full resource path of the reasoning engine, captured from the URL.", + "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^reasoningEngines/[^/]+$", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", "required": true, "type": "string" - } - }, - "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:cancel", - "request": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "type": "object" - }, - "response": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" }, - "type": "object" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "pushNotificationConfigs": { - "description": "Get request for reasoning engine instance via the A2A get protocol apis.", - "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs", - "httpMethod": "GET", - "id": "aiplatform.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs", - "parameterOrder": [ - "name", - "a2aEndpoint" - ], - "parameters": { - "a2aEndpoint": { - "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", - "location": "path", - "pattern": "^v1/tasks/[^/]+/pushNotificationConfigs$", - "required": true, - "type": "string" + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" }, - "historyLength": { - "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", + "pageToken": { + "description": "The standard list page token.", "location": "query", "type": "string" }, - "name": { - "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", - "location": "path", - "pattern": "^reasoningEngines/[^/]+$", - "required": true, - "type": "string" + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, - "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", + "path": "v1beta1/{+name}/operations", "response": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "type": "object" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "subscribe": { - "description": "Stream get request for reasoning engine instance via the A2A stream get protocol apis.", - "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}:subscribe", - "httpMethod": "GET", - "id": "aiplatform.reasoningEngines.a2a.v1.tasks.subscribe", + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.tensorboards.experiments.runs.operations.wait", "parameterOrder": [ - "name", - "a2aEndpoint" + "name" ], "parameters": { - "a2aEndpoint": { - "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123:subscribe`.", + "name": { + "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^v1/tasks/[^/]+$", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, - "name": { - "description": "Required. The full resource path of the reasoning engine, captured from the URL.", - "location": "path", - "pattern": "^reasoningEngines/[^/]+$", - "required": true, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", "type": "string" } }, - "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:subscribe", + "path": "v1beta1/{+name}:wait", "response": { - "$ref": "GoogleApiHttpBody" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } - }, + } + }, + "timeSeries": { "resources": { - "pushNotificationConfigs": { + "operations": { "methods": { - "a2aGetReasoningEngine": { - "description": "Get request for reasoning engine instance via the A2A get protocol apis.", - "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}", + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.tensorboards.experiments.runs.timeSeries.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.tensorboards.experiments.runs.timeSeries.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs.a2aGetReasoningEngine", + "id": "aiplatform.tensorboards.experiments.runs.timeSeries.operations.get", "parameterOrder": [ - "name", - "a2aEndpoint" + "name" ], "parameters": { - "a2aEndpoint": { - "description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", + "name": { + "description": "The name of the operation resource.", "location": "path", - "pattern": "^v1/tasks/[^/]+/pushNotificationConfigs/[^/]+$", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.tensorboards.experiments.runs.timeSeries.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", "required": true, "type": "string" }, - "historyLength": { - "description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", "location": "query", "type": "string" }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.tensorboards.experiments.runs.timeSeries.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { "name": { - "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^reasoningEngines/[^/]+$", + "pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", "required": true, "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" } }, - "path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", + "path": "v1beta1/{+name}:wait", "response": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "type": "object" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -26808,465 +36899,359 @@ } } }, - "memories": { + "operations": { "methods": { - "create": { - "description": "Create a Memory.", - "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories", + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/tensorboards/{tensorboardsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.reasoningEngines.memories.create", + "id": "aiplatform.tensorboards.operations.cancel", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "parent": { - "description": "Required. The resource name of the ReasoningEngine to create the Memory under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "name": { + "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^reasoningEngines/[^/]+$", + "pattern": "^tensorboards/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/memories", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1Memory" - }, + "path": "v1beta1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { - "description": "Delete a Memory.", - "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}", + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/tensorboards/{tensorboardsId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.reasoningEngines.memories.delete", + "id": "aiplatform.tensorboards.operations.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The resource name of the Memory to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", + "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^reasoningEngines/[^/]+/memories/[^/]+$", + "pattern": "^tensorboards/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "generate": { - "description": "Generate memories.", - "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories:generate", - "httpMethod": "POST", - "id": "aiplatform.reasoningEngines.memories.generate", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the ReasoningEngine to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", - "location": "path", - "pattern": "^reasoningEngines/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/memories:generate", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1GenerateMemoriesRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { - "description": "Get a Memory.", - "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}", + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/tensorboards/{tensorboardsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.reasoningEngines.memories.get", + "id": "aiplatform.tensorboards.operations.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", + "description": "The name of the operation resource.", "location": "path", - "pattern": "^reasoningEngines/[^/]+/memories/[^/]+$", + "pattern": "^tensorboards/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1Memory" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "List Memories.", - "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/tensorboards/{tensorboardsId}/operations", "httpMethod": "GET", - "id": "aiplatform.reasoningEngines.memories.list", + "id": "aiplatform.tensorboards.operations.list", "parameterOrder": [ - "parent" + "name" ], "parameters": { "filter": { - "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `scope` (as a JSON string)", + "description": "The standard list filter.", "location": "query", "type": "string" }, - "orderBy": { - "description": "Optional. The standard list order by string. If not specified, the default order is `create_time desc`. If specified, the default sorting order of provided fields is ascending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time`", - "location": "query", + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^tensorboards/[^/]+$", + "required": true, "type": "string" }, "pageSize": { - "description": "Optional. The standard list page size.", + "description": "The standard list page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. The standard list page token.", + "description": "The standard list page token.", "location": "query", "type": "string" }, - "parent": { - "description": "Required. The resource name of the ReasoningEngine to list the Memories under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", - "location": "path", - "pattern": "^reasoningEngines/[^/]+$", - "required": true, - "type": "string" + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, - "path": "v1beta1/{+parent}/memories", + "path": "v1beta1/{+name}/operations", "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListMemoriesResponse" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "patch": { - "description": "Update a Memory.", - "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}", - "httpMethod": "PATCH", - "id": "aiplatform.reasoningEngines.memories.patch", + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/tensorboards/{tensorboardsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.tensorboards.operations.wait", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", + "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^reasoningEngines/[^/]+/memories/[^/]+$", + "pattern": "^tensorboards/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, - "updateMask": { - "description": "Optional. Mask specifying which fields to update. Supported fields: * `display_name` * `description` * `fact`", - "format": "google-fieldmask", + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", "location": "query", "type": "string" } }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1Memory" - }, + "path": "v1beta1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "retrieve": { - "description": "Retrieve memories.", - "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories:retrieve", - "httpMethod": "POST", - "id": "aiplatform.reasoningEngines.memories.retrieve", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the ReasoningEngine to retrieve memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", - "location": "path", - "pattern": "^reasoningEngines/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/memories:retrieve", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1RetrieveMemoriesRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1RetrieveMemoriesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] } } - }, - "sessions": { + } + } + }, + "trainingPipelines": { + "resources": { + "operations": { "methods": { - "appendEvent": { - "description": "Appends an event to a given session.", - "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}:appendEvent", + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.reasoningEngines.sessions.appendEvent", + "id": "aiplatform.trainingPipelines.operations.cancel", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The resource name of the session to append event to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", - "location": "path", - "pattern": "^reasoningEngines/[^/]+/sessions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:appendEvent", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1SessionEvent" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1AppendEventResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "create": { - "description": "Creates a new Session.", - "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions", - "httpMethod": "POST", - "id": "aiplatform.reasoningEngines.sessions.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the location to create the session in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^reasoningEngines/[^/]+$", + "pattern": "^trainingPipelines/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/sessions", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1Session" - }, + "path": "v1beta1/{+name}:cancel", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { - "description": "Deletes details of the specific Session.", - "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.reasoningEngines.sessions.delete", + "id": "aiplatform.trainingPipelines.operations.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", + "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^reasoningEngines/[^/]+/sessions/[^/]+$", + "pattern": "^trainingPipelines/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { - "description": "Gets details of the specific Session.", - "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.reasoningEngines.sessions.get", + "id": "aiplatform.trainingPipelines.operations.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", + "description": "The name of the operation resource.", "location": "path", - "pattern": "^reasoningEngines/[^/]+/sessions/[^/]+$", + "pattern": "^trainingPipelines/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1Session" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists Sessions in a given reasoning engine.", - "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/trainingPipelines/{trainingPipelinesId}/operations", "httpMethod": "GET", - "id": "aiplatform.reasoningEngines.sessions.list", + "id": "aiplatform.trainingPipelines.operations.list", "parameterOrder": [ - "parent" + "name" ], "parameters": { "filter": { - "description": "Optional. The standard list filter. Supported fields: * `display_name` Example: `display_name=abc`.", + "description": "The standard list filter.", "location": "query", "type": "string" }, - "orderBy": { - "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`.", - "location": "query", + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^trainingPipelines/[^/]+$", + "required": true, "type": "string" }, "pageSize": { - "description": "Optional. The maximum number of sessions to return. The service may return fewer than this value. If unspecified, at most 100 sessions will be returned.", + "description": "The standard list page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. The next_page_token value returned from a previous list SessionService.ListSessions call.", + "description": "The standard list page token.", "location": "query", "type": "string" }, - "parent": { - "description": "Required. The resource name of the location to list sessions from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", - "location": "path", - "pattern": "^reasoningEngines/[^/]+$", - "required": true, - "type": "string" + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, - "path": "v1beta1/{+parent}/sessions", + "path": "v1beta1/{+name}/operations", "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListSessionsResponse" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "patch": { - "description": "Updates the specific Session.", - "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", - "httpMethod": "PATCH", - "id": "aiplatform.reasoningEngines.sessions.patch", + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.trainingPipelines.operations.wait", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.", + "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^reasoningEngines/[^/]+/sessions/[^/]+$", + "pattern": "^trainingPipelines/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, - "updateMask": { - "description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.", - "format": "google-fieldmask", + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", "location": "query", "type": "string" } }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1Session" - }, + "path": "v1beta1/{+name}:wait", "response": { - "$ref": "GoogleCloudAiplatformV1beta1Session" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } - }, - "resources": { - "events": { - "methods": { - "list": { - "description": "Lists Events in a given session.", - "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/events", - "httpMethod": "GET", - "id": "aiplatform.reasoningEngines.sessions.events.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Optional. The standard list filter. Supported fields: * `timestamp` range (i.e. `timestamp>=\"2025-01-31T11:30:00-04:00\"` where the timestamp is in RFC 3339 format) More detail in [AIP-160](https://google.aip.dev/160).", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. The maximum number of events to return. The service may return fewer than this value. If unspecified, at most 100 events will be returned. These events are ordered by timestamp in ascending order.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The next_page_token value returned from a previous list SessionService.ListEvents call.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the session to list events from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", - "location": "path", - "pattern": "^reasoningEngines/[^/]+/sessions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/events", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListEventsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + } + } + } + }, + "tuningJobs": { + "resources": { + "operations": { + "methods": { + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/tuningJobs/{tuningJobsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.tuningJobs.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^tuningJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" } - } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } } } } }, - "revision": "20251003", + "revision": "20251027", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -29728,6 +39713,13 @@ "description": "Required. The name of the candidate that produced the response.", "type": "string" }, + "events": { + "description": "Optional. Intermediate events (such as tool calls and responses) that led to the final response.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1Content" + }, + "type": "array" + }, "text": { "description": "Text response.", "type": "string" @@ -30673,7 +40665,9 @@ "GETTING_CONTAINER_IMAGE", "STARTING_MODEL_SERVER", "FINISHING_UP", - "DEPLOYMENT_TERMINATED" + "DEPLOYMENT_TERMINATED", + "SUCCESSFULLY_DEPLOYED", + "FAILED_TO_DEPLOY" ], "enumDescriptions": [ "Default value. This value is unused.", @@ -30684,7 +40678,9 @@ "The deployment is getting the container image for the model server.", "The deployment is starting the model server.", "The deployment is performing finalization steps.", - "The deployment has terminated." + "The deployment has terminated.", + "The deployment has succeeded.", + "The deployment has failed." ], "readOnly": true, "type": "string" @@ -31805,7 +41801,7 @@ "id": "GoogleCloudAiplatformV1beta1DedicatedResourcesScaleToZeroSpec", "properties": { "idleScaledownPeriod": { - "description": "Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours)", + "description": "Optional. Duration of no traffic before scaling to zero. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours)", "format": "google-duration", "type": "string" }, @@ -32001,7 +41997,9 @@ "GETTING_CONTAINER_IMAGE", "STARTING_MODEL_SERVER", "FINISHING_UP", - "DEPLOYMENT_TERMINATED" + "DEPLOYMENT_TERMINATED", + "SUCCESSFULLY_DEPLOYED", + "FAILED_TO_DEPLOY" ], "enumDescriptions": [ "Default value. This value is unused.", @@ -32012,7 +42010,9 @@ "The deployment is getting the container image for the model server.", "The deployment is starting the model server.", "The deployment is performing finalization steps.", - "The deployment has terminated." + "The deployment has terminated.", + "The deployment has succeeded.", + "The deployment has failed." ], "readOnly": true, "type": "string" @@ -32806,11 +42806,96 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1EmbedContentRequest": { + "description": "Request message for PredictionService.EmbedContent.", + "id": "GoogleCloudAiplatformV1beta1EmbedContentRequest", + "properties": { + "autoTruncate": { + "description": "Optional. Whether to silently truncate the input content if it's longer than the maximum sequence length.", + "type": "boolean" + }, + "content": { + "$ref": "GoogleCloudAiplatformV1beta1Content", + "description": "Required. Input content to be embedded. Required." + }, + "outputDimensionality": { + "description": "Optional. Optional reduced dimension for the output embedding. If set, excessive values in the output embedding are truncated from the end.", + "format": "int32", + "type": "integer" + }, + "taskType": { + "description": "Optional. The task type of the embedding.", + "enum": [ + "UNSPECIFIED", + "RETRIEVAL_QUERY", + "RETRIEVAL_DOCUMENT", + "SEMANTIC_SIMILARITY", + "CLASSIFICATION", + "CLUSTERING", + "QUESTION_ANSWERING", + "FACT_VERIFICATION", + "CODE_RETRIEVAL_QUERY" + ], + "enumDescriptions": [ + "Unset value, which will default to one of the other enum values.", + "Specifies the given text is a query in a search/retrieval setting.", + "Specifies the given text is a document from the corpus being searched.", + "Specifies the given text will be used for STS.", + "Specifies that the given text will be classified.", + "Specifies that the embeddings will be used for clustering.", + "Specifies that the embeddings will be used for question answering.", + "Specifies that the embeddings will be used for fact verification.", + "Specifies that the embeddings will be used for code retrieval." + ], + "type": "string" + }, + "title": { + "description": "Optional. An optional title for the text.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1EmbedContentResponse": { + "description": "Response message for PredictionService.EmbedContent.", + "id": "GoogleCloudAiplatformV1beta1EmbedContentResponse", + "properties": { + "embedding": { + "$ref": "GoogleCloudAiplatformV1beta1EmbedContentResponseEmbedding", + "description": "The embedding generated from the input content." + }, + "truncated": { + "description": "Whether the input content was truncated before generating the embedding.", + "type": "boolean" + }, + "usageMetadata": { + "$ref": "GoogleCloudAiplatformV1beta1UsageMetadata", + "description": "Metadata about the response(s)." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1EmbedContentResponseEmbedding": { + "description": "A list of floats representing an embedding.", + "id": "GoogleCloudAiplatformV1beta1EmbedContentResponseEmbedding", + "properties": { + "values": { + "description": "Embedding vector values.", + "items": { + "format": "float", + "type": "number" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1EnableModelRequest": { "description": "Request message for ModelGardenService.EnableModel.", "id": "GoogleCloudAiplatformV1beta1EnableModelRequest", "properties": { "service": { + "deprecated": true, "description": "Optional. The ID links the Marketplace listing to the underlying Vertex AI model endpoint. Format: `services/{service_id}` Format: `services/{service_id}`", "type": "string" } @@ -33632,6 +43717,10 @@ "description": "A single instance to be evaluated. Instances are used to specify the input data for evaluation, from simple string comparisons to complex, multi-turn model evaluations", "id": "GoogleCloudAiplatformV1beta1EvaluationInstance", "properties": { + "agentData": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentData", + "description": "Optional. Data used for agent evaluation." + }, "otherData": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceMapInstance", "description": "Optional. Other data used to populate placeholders based on their key." @@ -33658,6 +43747,102 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentConfig": { + "description": "Configuration for an Agent.", + "id": "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentConfig", + "properties": { + "developerInstruction": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceInstanceData", + "description": "Optional. A field containing instructions from the developer for the agent." + }, + "tools": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentConfigTools", + "description": "List of tools." + }, + "toolsText": { + "description": "A JSON string containing a list of tools available to an agent with info such as name, description, parameters and required parameters.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentConfigTools": { + "description": "Represents a list of tools for an agent.", + "id": "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentConfigTools", + "properties": { + "tool": { + "description": "Optional. List of tools: each tool can have multiple function declarations.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1Tool" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentData": { + "description": "Contains data specific to agent evaluations.", + "id": "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentData", + "properties": { + "agentConfig": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentConfig", + "description": "Optional. Agent configuration." + }, + "developerInstruction": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceInstanceData", + "deprecated": true, + "description": "Optional. A field containing instructions from the developer for the agent." + }, + "events": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentDataEvents", + "description": "A list of events." + }, + "eventsText": { + "description": "A JSON string containing a sequence of events.", + "type": "string" + }, + "tools": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentDataTools", + "deprecated": true, + "description": "List of tools." + }, + "toolsText": { + "deprecated": true, + "description": "A JSON string containing a list of tools available to an agent with info such as name, description, parameters and required parameters. Example: [ { \"name\": \"search_actors\", \"description\": \"Search for actors in a movie. Returns a list of actors, their roles, their birthdate, and their place of birth.\", \"parameters\": [ { \"name\": \"movie_name\", \"description\": \"The name of the movie.\" }, { \"name\": \"character_name\", \"description\": \"The name of the character.\" } ], \"required\": [\"movie_name\", \"character_name\"] } ]", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentDataEvents": { + "description": "Represents a list of events for an agent.", + "id": "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentDataEvents", + "properties": { + "event": { + "description": "Optional. A list of events.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1Content" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentDataTools": { + "description": "Represents a list of tools for an agent.", + "id": "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentDataTools", + "properties": { + "tool": { + "deprecated": true, + "description": "Optional. List of tools: each tool can have multiple function declarations.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1Tool" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1EvaluationInstanceInstanceData": { "description": "Instance data used to populate placeholders in a metric prompt template.", "id": "GoogleCloudAiplatformV1beta1EvaluationInstanceInstanceData", @@ -34090,6 +44275,10 @@ "description": "An inference config used for model inference during the evaluation run.", "id": "GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfig", "properties": { + "agentConfig": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfigAgentConfig", + "description": "Optional. Agent config used to generate responses." + }, "generationConfig": { "$ref": "GoogleCloudAiplatformV1beta1GenerationConfig", "description": "Optional. Generation config." @@ -34101,6 +44290,24 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfigAgentConfig": { + "description": "Configuration that describes an agent.", + "id": "GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfigAgentConfig", + "properties": { + "developerInstruction": { + "$ref": "GoogleCloudAiplatformV1beta1Content", + "description": "Optional. The developer instruction for the agent." + }, + "tools": { + "description": "Optional. The tools available to the agent.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1Tool" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1EvaluationRunMetric": { "description": "The metric used for evaluation runs.", "id": "GoogleCloudAiplatformV1beta1EvaluationRunMetric", @@ -34113,6 +44320,10 @@ "description": "Required. The name of the metric.", "type": "string" }, + "metricConfig": { + "$ref": "GoogleCloudAiplatformV1beta1Metric", + "description": "The metric config." + }, "predefinedMetricSpec": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunMetricPredefinedMetricSpec", "description": "Spec for a pre-defined metric." @@ -34381,11 +44592,6 @@ "transferAgent": { "description": "Optional. If set, the event transfers to the specified agent.", "type": "string" - }, - "transferToAgent": { - "deprecated": true, - "description": "Deprecated. If set, the event transfers to the specified agent.", - "type": "boolean" } }, "type": "object" @@ -38062,6 +48268,13 @@ "description": "Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].", "type": "string" }, + "parts": { + "description": "Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1FunctionResponsePart" + }, + "type": "array" + }, "response": { "additionalProperties": { "description": "Properties of the object.", @@ -38073,6 +48286,60 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1FunctionResponseBlob": { + "description": "Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field.", + "id": "GoogleCloudAiplatformV1beta1FunctionResponseBlob", + "properties": { + "data": { + "description": "Required. Raw bytes.", + "format": "byte", + "type": "string" + }, + "displayName": { + "description": "Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.", + "type": "string" + }, + "mimeType": { + "description": "Required. The IANA standard MIME type of the source data.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1FunctionResponseFileData": { + "description": "URI based data for function response.", + "id": "GoogleCloudAiplatformV1beta1FunctionResponseFileData", + "properties": { + "displayName": { + "description": "Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.", + "type": "string" + }, + "fileUri": { + "description": "Required. URI.", + "type": "string" + }, + "mimeType": { + "description": "Required. The IANA standard MIME type of the source data.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1FunctionResponsePart": { + "description": "A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.", + "id": "GoogleCloudAiplatformV1beta1FunctionResponsePart", + "properties": { + "fileData": { + "$ref": "GoogleCloudAiplatformV1beta1FunctionResponseFileData", + "description": "URI based data." + }, + "inlineData": { + "$ref": "GoogleCloudAiplatformV1beta1FunctionResponseBlob", + "description": "Inline media bytes." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1GcsDestination": { "description": "The Google Cloud Storage location where the output is to be written to.", "id": "GoogleCloudAiplatformV1beta1GcsDestination", @@ -38544,6 +48811,10 @@ "description": "Request message for EvaluationService.GenerateInstanceRubrics.", "id": "GoogleCloudAiplatformV1beta1GenerateInstanceRubricsRequest", "properties": { + "agentConfig": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentConfig", + "description": "Optional. Agent configuration, required for agent-based rubric generation." + }, "contents": { "description": "Required. The prompt to generate rubrics from. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.", "items": { @@ -38593,6 +48864,27 @@ "description": "Optional. If true, generated memories will not be consolidated with existing memories; all generated memories will be added as new memories regardless of whether they are duplicates of or contradictory to existing memories. By default, memory consolidation is enabled.", "type": "boolean" }, + "disableMemoryRevisions": { + "description": "Optional. If true, no revisions will be created for this request.", + "type": "boolean" + }, + "revisionExpireTime": { + "description": "Optional. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.", + "format": "google-datetime", + "type": "string" + }, + "revisionLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels to be applied to the generated memory revisions. For example, you can use this to label a revision with its data source.", + "type": "object" + }, + "revisionTtl": { + "description": "Optional. The TTL for the revision. The expiration time is computed: now + TTL.", + "format": "google-duration", + "type": "string" + }, "scope": { "additionalProperties": { "type": "string" @@ -38653,6 +48945,13 @@ "fact": { "description": "Required. The fact to consolidate with existing memories.", "type": "string" + }, + "topics": { + "description": "Optional. The topics that the consolidated memories should be associated with.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1MemoryTopicId" + }, + "type": "array" } }, "type": "object" @@ -39543,6 +49842,42 @@ "aspectRatio": { "description": "Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: \"1:1\" \"2:3\", \"3:2\" \"3:4\", \"4:3\" \"4:5\", \"5:4\" \"9:16\", \"16:9\" \"21:9\"", "type": "string" + }, + "imageOutputOptions": { + "$ref": "GoogleCloudAiplatformV1beta1ImageConfigImageOutputOptions", + "description": "Optional. The image output format for generated images." + }, + "personGeneration": { + "description": "Optional. Controls whether the model can generate people.", + "enum": [ + "PERSON_GENERATION_UNSPECIFIED", + "ALLOW_ALL", + "ALLOW_ADULT", + "ALLOW_NONE" + ], + "enumDescriptions": [ + "Generation images of people unspecified.", + "Generate images that include adults and children.", + "Generate images of adults, but not children.", + "Block generation of images of people." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ImageConfigImageOutputOptions": { + "description": "The image output format for generated images.", + "id": "GoogleCloudAiplatformV1beta1ImageConfigImageOutputOptions", + "properties": { + "compressionQuality": { + "description": "Optional. The compression quality of the output image.", + "format": "int32", + "type": "integer" + }, + "mimeType": { + "description": "Optional. The image format that the output should be saved as.", + "type": "string" } }, "type": "object" @@ -40461,6 +50796,18 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1IntermediateExtractedMemory": { + "description": "An extracted memory that is the intermediate result before consolidation.", + "id": "GoogleCloudAiplatformV1beta1IntermediateExtractedMemory", + "properties": { + "fact": { + "description": "Output only. The fact of the extracted memory.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1InternalOsServiceStateInstance": { "description": "Request message for [InternalOsServiceStateInstance].", "id": "GoogleCloudAiplatformV1beta1InternalOsServiceStateInstance", @@ -41230,6 +51577,24 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ListMemoryRevisionsResponse": { + "description": "Response message for MemoryBankService.ListMemoryRevisions.", + "id": "GoogleCloudAiplatformV1beta1ListMemoryRevisionsResponse", + "properties": { + "memoryRevisions": { + "description": "The list of Memory Revisions in the request page.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1MemoryRevision" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ListMetadataSchemasResponse": { "description": "Response message for MetadataService.ListMetadataSchemas.", "id": "GoogleCloudAiplatformV1beta1ListMetadataSchemasResponse", @@ -42122,6 +52487,10 @@ "description": "Optional. Description of the Memory.", "type": "string" }, + "disableMemoryRevisions": { + "description": "Optional. Input only. If true, no revision will be created for this request.", + "type": "boolean" + }, "displayName": { "description": "Optional. Display name of the Memory.", "type": "string" @@ -42139,6 +52508,16 @@ "description": "Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "type": "string" }, + "revisionExpireTime": { + "description": "Optional. Input only. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.", + "format": "google-datetime", + "type": "string" + }, + "revisionTtl": { + "description": "Optional. Input only. The TTL for the revision. The expiration time is computed: now + TTL.", + "format": "google-duration", + "type": "string" + }, "scope": { "additionalProperties": { "type": "string" @@ -42146,6 +52525,13 @@ "description": "Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.", "type": "object" }, + "topics": { + "description": "Optional. The Topics of the Memory.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1MemoryTopicId" + }, + "type": "array" + }, "ttl": { "description": "Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL.", "format": "google-duration", @@ -42304,6 +52690,50 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1MemoryRevision": { + "description": "A revision of a Memory.", + "id": "GoogleCloudAiplatformV1beta1MemoryRevision", + "properties": { + "createTime": { + "description": "Output only. Timestamp when this Memory Revision was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "expireTime": { + "description": "Output only. Timestamp of when this resource is considered expired.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "extractedMemories": { + "description": "Output only. The extracted memories from the source content before consolidation when the memory was updated via GenerateMemories. This information was used to modify an existing Memory via Consolidation.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1IntermediateExtractedMemory" + }, + "readOnly": true, + "type": "array" + }, + "fact": { + "description": "Output only. The fact of the Memory Revision. This corresponds to the `fact` field of the parent Memory at the time of revision creation.", + "readOnly": true, + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Output only. The labels of the Memory Revision. These labels are applied to the MemoryRevision when it is created based on `GenerateMemoriesRequest.revision_labels`.", + "readOnly": true, + "type": "object" + }, + "name": { + "description": "Identifier. The resource name of the Memory Revision. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{memory_revision}`", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1MemoryTopicId": { "description": "A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval.", "id": "GoogleCloudAiplatformV1beta1MemoryTopicId", @@ -44952,7 +55382,7 @@ "properties": { "deployedModel": { "$ref": "GoogleCloudAiplatformV1beta1DeployedModel", - "description": "Required. The DeployedModel to be mutated within the Endpoint. Only the following fields can be mutated: * `min_replica_count` in either DedicatedResources or AutomaticResources * `max_replica_count` in either DedicatedResources or AutomaticResources * `required_replica_count` in DedicatedResources * autoscaling_metric_specs * `disable_container_logging` (v1 only) * `enable_container_logging` (v1beta1 only)" + "description": "Required. The DeployedModel to be mutated within the Endpoint. Only the following fields can be mutated: * `min_replica_count` in either DedicatedResources or AutomaticResources * `max_replica_count` in either DedicatedResources or AutomaticResources * `required_replica_count` in DedicatedResources * autoscaling_metric_specs * `disable_container_logging` (v1 only) * `enable_container_logging` (v1beta1 only) * `scale_to_zero_spec` in DedicatedResources (v1beta1 only) * `initial_replica_count` in DedicatedResources (v1beta1 only)" }, "updateMask": { "description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask.", @@ -46283,6 +56713,20 @@ "content": { "$ref": "GoogleCloudAiplatformV1beta1Content", "description": "Required. The content to optimize." + }, + "optimizationTarget": { + "description": "Optional. The target model to optimize the prompt for.", + "enum": [ + "OPTIMIZATION_TARGET_UNSPECIFIED", + "OPTIMIZATION_TARGET_GENERAL", + "OPTIMIZATION_TARGET_GEMINI_NANO" + ], + "enumDescriptions": [ + "Unspecified optimization target. Default to OPTIMIZATION_TARGET_GENERAL.", + "Optimize the prompt for quality.", + "Optimize the prompt for Gemini Nano." + ], + "type": "string" } }, "type": "object" @@ -47718,6 +58162,13 @@ }, "type": "array" }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The user labels for Imagen billing usage only. Only Imagen supports labels. For other use cases, it will be ignored.", + "type": "object" + }, "parameters": { "description": "The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' Model's PredictSchemata's parameters_schema_uri.", "type": "any" @@ -47929,10 +58380,6 @@ "description": "Tuning Spec for Preference Optimization.", "id": "GoogleCloudAiplatformV1beta1PreferenceOptimizationSpec", "properties": { - "evaluationConfig": { - "$ref": "GoogleCloudAiplatformV1beta1EvaluationConfig", - "description": "Optional. Evaluation Config for Preference Optimization Job." - }, "exportLastCheckpointOnly": { "description": "Optional. If set to true, disable intermediate checkpoints for Preference Optimization and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for Preference Optimization. Default is false.", "type": "boolean" @@ -49778,11 +60225,11 @@ "enterprise": { "$ref": "GoogleCloudAiplatformV1beta1RagManagedDbConfigEnterprise", "deprecated": true, - "description": "Sets the RagManagedDb to the Enterprise tier. This is the default tier if not explicitly chosen." + "description": "Sets the RagManagedDb to the Enterprise tier." }, "scaled": { "$ref": "GoogleCloudAiplatformV1beta1RagManagedDbConfigScaled", - "description": "Sets the RagManagedDb to the Scaled tier." + "description": "Sets the RagManagedDb to the Scaled tier. This is the default tier if not explicitly chosen." }, "unprovisioned": { "$ref": "GoogleCloudAiplatformV1beta1RagManagedDbConfigUnprovisioned", @@ -50439,6 +60886,10 @@ }, "type": "array" }, + "disableMemoryRevisions": { + "description": "If true, no memory revisions will be created for any requests to the Memory Bank.", + "type": "boolean" + }, "generationConfig": { "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineContextSpecMemoryBankConfigGenerationConfig", "description": "Optional. Configuration for how to generate memories for the Memory Bank." @@ -50488,6 +60939,11 @@ "granularTtlConfig": { "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineContextSpecMemoryBankConfigTtlConfigGranularTtlConfig", "description": "Optional. The granular TTL configuration of the memories in the Memory Bank." + }, + "memoryRevisionDefaultTtl": { + "description": "Optional. The default TTL duration of the memory revisions in the Memory Bank. This applies to all operations that create a memory revision. If not set, a default TTL of 365 days will be used.", + "format": "google-duration", + "type": "string" } }, "type": "object" @@ -50544,6 +61000,10 @@ "serviceAccount": { "description": "Optional. The service account that the Reasoning Engine artifact runs as. It should have \"roles/storage.objectViewer\" for reading the user project's Cloud Storage and \"roles/aiplatform.user\" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used.", "type": "string" + }, + "sourceCodeSpec": { + "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpec", + "description": "Deploy from source code files with a defined entrypoint." } }, "type": "object" @@ -50632,6 +61092,56 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpec": { + "description": "Specification for deploying from source code.", + "id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpec", + "properties": { + "inlineSource": { + "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpecInlineSource", + "description": "Source code is provided directly in the request." + }, + "pythonSpec": { + "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpecPythonSpec", + "description": "Configuration for a Python application." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpecInlineSource": { + "description": "Specifies source code provided as a byte stream.", + "id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpecInlineSource", + "properties": { + "sourceArchive": { + "description": "Required. Input only. The application source code archive, provided as a compressed tarball (.tar.gz) file.", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpecPythonSpec": { + "description": "Specification for running a Python application from source.", + "id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpecPythonSpec", + "properties": { + "entrypointModule": { + "description": "Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to \"agent\". The project root will be added to Python sys.path, allowing imports to be specified relative to the root.", + "type": "string" + }, + "entrypointObject": { + "description": "Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to \"root_agent\".", + "type": "string" + }, + "requirementsFile": { + "description": "Optional. The path to the requirements file, relative to the source root. If not specified, defaults to \"requirements.txt\".", + "type": "string" + }, + "version": { + "description": "Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, default value is 3.10.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1RebaseTunedModelRequest": { "description": "Request message for GenAiTuningService.RebaseTunedModel.", "id": "GoogleCloudAiplatformV1beta1RebaseTunedModelRequest", @@ -51227,6 +61737,10 @@ "description": "Request message for MemoryBankService.RetrieveMemories.", "id": "GoogleCloudAiplatformV1beta1RetrieveMemoriesRequest", "properties": { + "filter": { + "description": "Optional. The standard list filter that will be applied to the retrieved memories. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `fact` * `create_time` * `update_time`", + "type": "string" + }, "scope": { "additionalProperties": { "type": "string" @@ -51311,6 +61825,18 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1RollbackMemoryRequest": { + "description": "Request message for MemoryBankService.RollbackMemory.", + "id": "GoogleCloudAiplatformV1beta1RollbackMemoryRequest", + "properties": { + "targetRevisionId": { + "description": "Required. The ID of the revision to rollback to.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1RolloutOptions": { "description": "Configuration for rolling deployments.", "id": "GoogleCloudAiplatformV1beta1RolloutOptions", @@ -59664,6 +70190,10 @@ "$ref": "GoogleCloudAiplatformV1beta1ToolCodeExecution", "description": "Optional. CodeExecution tool type. Enables the model to execute code as part of generation." }, + "computerUse": { + "$ref": "GoogleCloudAiplatformV1beta1ToolComputerUse", + "description": "Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations." + }, "enterpriseWebSearch": { "$ref": "GoogleCloudAiplatformV1beta1EnterpriseWebSearch", "description": "Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance." @@ -59787,6 +70317,32 @@ "properties": {}, "type": "object" }, + "GoogleCloudAiplatformV1beta1ToolComputerUse": { + "description": "Tool to support computer use.", + "id": "GoogleCloudAiplatformV1beta1ToolComputerUse", + "properties": { + "environment": { + "description": "Required. The environment being operated.", + "enum": [ + "ENVIRONMENT_UNSPECIFIED", + "ENVIRONMENT_BROWSER" + ], + "enumDescriptions": [ + "Defaults to browser.", + "Operates in a web browser." + ], + "type": "string" + }, + "excludedPredefinedFunctions": { + "description": "Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ToolConfig": { "description": "Tool config. This config is shared for all tools provided in the request.", "id": "GoogleCloudAiplatformV1beta1ToolConfig", @@ -61579,6 +72135,93 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1UsageMetadata": { + "description": "Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics.", + "id": "GoogleCloudAiplatformV1beta1UsageMetadata", + "properties": { + "cacheTokensDetails": { + "description": "Output only. A detailed breakdown of the token count for each modality in the cached content.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1ModalityTokenCount" + }, + "readOnly": true, + "type": "array" + }, + "cachedContentTokenCount": { + "description": "Output only. The number of tokens in the cached content that was used for this request.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "candidatesTokenCount": { + "description": "The total number of tokens in the generated candidates.", + "format": "int32", + "type": "integer" + }, + "candidatesTokensDetails": { + "description": "Output only. A detailed breakdown of the token count for each modality in the generated candidates.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1ModalityTokenCount" + }, + "readOnly": true, + "type": "array" + }, + "promptTokenCount": { + "description": "The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content.", + "format": "int32", + "type": "integer" + }, + "promptTokensDetails": { + "description": "Output only. A detailed breakdown of the token count for each modality in the prompt.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1ModalityTokenCount" + }, + "readOnly": true, + "type": "array" + }, + "thoughtsTokenCount": { + "description": "Output only. The number of tokens that were part of the model's generated \"thoughts\" output, if applicable.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "toolUsePromptTokenCount": { + "description": "Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "toolUsePromptTokensDetails": { + "description": "Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1ModalityTokenCount" + }, + "readOnly": true, + "type": "array" + }, + "totalTokenCount": { + "description": "The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`.", + "format": "int32", + "type": "integer" + }, + "trafficType": { + "description": "Output only. The traffic type for this request.", + "enum": [ + "TRAFFIC_TYPE_UNSPECIFIED", + "ON_DEMAND", + "PROVISIONED_THROUGHPUT" + ], + "enumDescriptions": [ + "Unspecified request traffic type.", + "Type for Pay-As-You-Go traffic.", + "Type for Provisioned Throughput traffic." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1UserActionReference": { "description": "References an API call. It contains more information about long running operation and Jobs that are triggered by the API call.", "id": "GoogleCloudAiplatformV1beta1UserActionReference", diff --git a/discovery/alloydb-v1.json b/discovery/alloydb-v1.json index d8573454c3..126a00c932 100644 --- a/discovery/alloydb-v1.json +++ b/discovery/alloydb-v1.json @@ -1627,7 +1627,7 @@ } } }, - "revision": "20251009", + "revision": "20251016", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -2141,6 +2141,10 @@ ], "type": "string" }, + "dataplexConfig": { + "$ref": "DataplexConfig", + "description": "Optional. Configuration for Dataplex integration." + }, "deleteTime": { "description": "Output only. Delete time stamp", "format": "google-datetime", @@ -2581,6 +2585,17 @@ }, "type": "object" }, + "DataplexConfig": { + "description": "Configuration for Dataplex integration.", + "id": "DataplexConfig", + "properties": { + "enabled": { + "description": "Dataplex is enabled by default for resources such as clusters and instances. This flag controls the integration of AlloyDB PG resources (like databases, schemas, and tables) with Dataplex.\"", + "type": "boolean" + } + }, + "type": "object" + }, "DenyMaintenancePeriod": { "description": "DenyMaintenancePeriod definition. Excepting emergencies, maintenance will not be scheduled to start within this deny period. The start_date must be less than the end_date.", "id": "DenyMaintenancePeriod", diff --git a/discovery/alloydb-v1alpha.json b/discovery/alloydb-v1alpha.json index bfebb2f876..ebd9fb43f6 100644 --- a/discovery/alloydb-v1alpha.json +++ b/discovery/alloydb-v1alpha.json @@ -1627,7 +1627,7 @@ } } }, - "revision": "20251009", + "revision": "20251016", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -2164,6 +2164,10 @@ ], "type": "string" }, + "dataplexConfig": { + "$ref": "DataplexConfig", + "description": "Optional. Configuration for Dataplex integration." + }, "deleteTime": { "description": "Output only. Delete time stamp", "format": "google-datetime", @@ -2725,6 +2729,17 @@ }, "type": "object" }, + "DataplexConfig": { + "description": "Configuration for Dataplex integration.", + "id": "DataplexConfig", + "properties": { + "enabled": { + "description": "Dataplex is enabled by default for resources such as clusters and instances. This flag controls the integration of AlloyDB PG resources (like databases, schemas, and tables) with Dataplex.\"", + "type": "boolean" + } + }, + "type": "object" + }, "DenyMaintenancePeriod": { "description": "DenyMaintenancePeriod definition. Excepting emergencies, maintenance will not be scheduled to start within this deny period. The start_date must be less than the end_date.", "id": "DenyMaintenancePeriod", diff --git a/discovery/alloydb-v1beta.json b/discovery/alloydb-v1beta.json index 6f28efd5b4..330d5bc355 100644 --- a/discovery/alloydb-v1beta.json +++ b/discovery/alloydb-v1beta.json @@ -1624,7 +1624,7 @@ } } }, - "revision": "20251009", + "revision": "20251016", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -2150,6 +2150,10 @@ ], "type": "string" }, + "dataplexConfig": { + "$ref": "DataplexConfig", + "description": "Optional. Configuration for Dataplex integration." + }, "deleteTime": { "description": "Output only. Delete time stamp", "format": "google-datetime", @@ -2706,6 +2710,17 @@ }, "type": "object" }, + "DataplexConfig": { + "description": "Configuration for Dataplex integration.", + "id": "DataplexConfig", + "properties": { + "enabled": { + "description": "Dataplex is enabled by default for resources such as clusters and instances. This flag controls the integration of AlloyDB PG resources (like databases, schemas, and tables) with Dataplex.\"", + "type": "boolean" + } + }, + "type": "object" + }, "DenyMaintenancePeriod": { "description": "DenyMaintenancePeriod definition. Excepting emergencies, maintenance will not be scheduled to start within this deny period. The start_date must be less than the end_date.", "id": "DenyMaintenancePeriod", diff --git a/discovery/analyticshub-v1.json b/discovery/analyticshub-v1.json index 01aaf110ec..9ce496befb 100644 --- a/discovery/analyticshub-v1.json +++ b/discovery/analyticshub-v1.json @@ -1247,7 +1247,7 @@ } } }, - "revision": "20250901", + "revision": "20251020", "rootUrl": "https://analyticshub.googleapis.com/", "schemas": { "ApproveQueryTemplateRequest": { @@ -1837,6 +1837,13 @@ "retryPolicy": { "$ref": "RetryPolicy", "description": "Optional. A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message." + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"", + "type": "object" } }, "type": "object" @@ -2147,6 +2154,10 @@ ], "readOnly": true, "type": "string" + }, + "storedProcedureConfig": { + "$ref": "StoredProcedureConfig", + "description": "Optional. If set, stored procedure configuration will be propagated and enforced on the linked dataset." } }, "type": "object" @@ -2669,6 +2680,33 @@ }, "type": "object" }, + "StoredProcedureConfig": { + "description": "Stored procedure configuration, used to configure stored procedure sharing on linked dataset.", + "id": "StoredProcedureConfig", + "properties": { + "allowedStoredProcedureTypes": { + "description": "Output only. Types of stored procedure supported to share.", + "items": { + "enum": [ + "STORED_PROCEDURE_TYPE_UNSPECIFIED", + "SQL_PROCEDURE" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "SQL stored procedure." + ], + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "enabled": { + "description": "Optional. If true, enable sharing of stored procedure.", + "type": "boolean" + } + }, + "type": "object" + }, "SubmitQueryTemplateRequest": { "description": "Message for submitting a QueryTemplate.", "id": "SubmitQueryTemplateRequest", diff --git a/discovery/androidmanagement-v1.json b/discovery/androidmanagement-v1.json index 641be0d75a..a451535202 100644 --- a/discovery/androidmanagement-v1.json +++ b/discovery/androidmanagement-v1.json @@ -1265,7 +1265,7 @@ } } }, - "revision": "20251015", + "revision": "20251022", "rootUrl": "https://androidmanagement.googleapis.com/", "schemas": { "AdbShellCommandEvent": { @@ -2747,7 +2747,7 @@ ], "enumDescriptions": [ "This value is disallowed.", - "Lock the device, as if the lock screen timeout had expired.", + "Lock the device, as if the lock screen timeout had expired. For a work profile, if there is a separate work profile lock, this only locks the work profile, with one exception: on work profiles on an organization-owned device running Android 8, 9, or 10, this locks the entire device.", "Reset the user's password.", "Reboot the device. Only supported on fully managed devices running Android 7.0 (API level 24) or higher.", "Removes the work profile and all policies from a company-owned Android 8.0+ device, relinquishing the device for personal use. Apps and data associated with the personal profile(s) are preserved. The device will be deleted from the server after it acknowledges the command.", diff --git a/discovery/androidpublisher-v3.json b/discovery/androidpublisher-v3.json index 935b8b2a41..a26d2f4f8e 100644 --- a/discovery/androidpublisher-v3.json +++ b/discovery/androidpublisher-v3.json @@ -5555,7 +5555,7 @@ } } }, - "revision": "20250904", + "revision": "20251028", "rootUrl": "https://androidpublisher.googleapis.com/", "schemas": { "Abi": { @@ -9456,13 +9456,15 @@ "AVAILABILITY_UNSPECIFIED", "AVAILABLE", "NO_LONGER_AVAILABLE", - "AVAILABLE_IF_RELEASED" + "AVAILABLE_IF_RELEASED", + "AVAILABLE_FOR_OFFERS_ONLY" ], "enumDescriptions": [ "Unspecified availability. Must not be used.", "The purchase option is available to users.", "The purchase option is no longer available to users. This value can only be used if the availability was previously set as AVAILABLE.", - "The purchase option is initially unavailable, but made available via a released pre-order offer." + "The purchase option is initially unavailable, but made available via a released pre-order offer.", + "The purchase option is unavailable but offers linked to it (i.e. Play Points offer) are available." ], "type": "string" }, @@ -9518,6 +9520,10 @@ "description": "The offer ID of the one-time purchase offer.", "type": "string" }, + "preorderDetails": { + "$ref": "PreorderDetails", + "description": "The details of a pre-order purchase. Only set if it is a pre-order purchase. Note that this field will be set even after pre-order is fulfilled." + }, "purchaseOptionId": { "description": "ID of the purchase option. This field is set for both purchase options and variant offers. For purchase options, this ID identifies the purchase option itself. For variant offers, this ID refers to the associated purchase option, and in conjunction with offer_id it identifies the variant offer.", "type": "string" @@ -9855,6 +9861,24 @@ }, "type": "object" }, + "PreorderDetails": { + "description": "Details of a pre-order purchase.", + "id": "PreorderDetails", + "properties": {}, + "type": "object" + }, + "PreorderOfferDetails": { + "description": "Offer details information related to a preorder line item.", + "id": "PreorderOfferDetails", + "properties": { + "preorderReleaseTime": { + "description": "The time when a preordered item is released for a preorder purchase.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "PrepaidBasePlanType": { "description": "Represents a base plan that does not automatically renew at the end of the base plan, and must be manually renewed by the user.", "id": "PrepaidBasePlanType", @@ -10001,6 +10025,10 @@ "description": "The per-transaction offer token used to make this purchase line item.", "type": "string" }, + "preorderOfferDetails": { + "$ref": "PreorderOfferDetails", + "description": "Offer details for a preorder offer. This will only be set for preorders." + }, "purchaseOptionId": { "description": "The purchase option ID.", "type": "string" diff --git a/discovery/apigee-v1.json b/discovery/apigee-v1.json index 0a6c720911..59bafae980 100644 --- a/discovery/apigee-v1.json +++ b/discovery/apigee-v1.json @@ -1592,6 +1592,59 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "get": { + "description": "Get the key value map scoped to an organization, environment, or API proxy.", + "flatPath": "v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps/{keyvaluemapsId}", + "httpMethod": "GET", + "id": "apigee.organizations.apis.keyvaluemaps.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Scope as indicated by the URI in which to fetch the key value map. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", + "location": "path", + "pattern": "^organizations/[^/]+/apis/[^/]+/keyvaluemaps/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApigeeV1KeyValueMap" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "update": { + "description": "Update the key value map scoped to an organization, environment, or API proxy.", + "flatPath": "v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps/{keyvaluemapsId}", + "httpMethod": "PUT", + "id": "apigee.organizations.apis.keyvaluemaps.update", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Scope as indicated by the URI in which to fetch the key value map. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", + "location": "path", + "pattern": "^organizations/[^/]+/apis/[^/]+/keyvaluemaps/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudApigeeV1KeyValueMap" + }, + "response": { + "$ref": "GoogleCloudApigeeV1KeyValueMap" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -6276,6 +6329,59 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "get": { + "description": "Get the key value map scoped to an organization, environment, or API proxy.", + "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps/{keyvaluemapsId}", + "httpMethod": "GET", + "id": "apigee.organizations.environments.keyvaluemaps.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Scope as indicated by the URI in which to fetch the key value map. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", + "location": "path", + "pattern": "^organizations/[^/]+/environments/[^/]+/keyvaluemaps/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApigeeV1KeyValueMap" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "update": { + "description": "Update the key value map scoped to an organization, environment, or API proxy.", + "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps/{keyvaluemapsId}", + "httpMethod": "PUT", + "id": "apigee.organizations.environments.keyvaluemaps.update", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Scope as indicated by the URI in which to fetch the key value map. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", + "location": "path", + "pattern": "^organizations/[^/]+/environments/[^/]+/keyvaluemaps/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudApigeeV1KeyValueMap" + }, + "response": { + "$ref": "GoogleCloudApigeeV1KeyValueMap" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -9100,6 +9206,59 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "get": { + "description": "Get the key value map scoped to an organization, environment, or API proxy.", + "flatPath": "v1/organizations/{organizationsId}/keyvaluemaps/{keyvaluemapsId}", + "httpMethod": "GET", + "id": "apigee.organizations.keyvaluemaps.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Scope as indicated by the URI in which to fetch the key value map. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", + "location": "path", + "pattern": "^organizations/[^/]+/keyvaluemaps/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApigeeV1KeyValueMap" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "update": { + "description": "Update the key value map scoped to an organization, environment, or API proxy.", + "flatPath": "v1/organizations/{organizationsId}/keyvaluemaps/{keyvaluemapsId}", + "httpMethod": "PUT", + "id": "apigee.organizations.keyvaluemaps.update", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Scope as indicated by the URI in which to fetch the key value map. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", + "location": "path", + "pattern": "^organizations/[^/]+/keyvaluemaps/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudApigeeV1KeyValueMap" + }, + "response": { + "$ref": "GoogleCloudApigeeV1KeyValueMap" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -11289,7 +11448,7 @@ } } }, - "revision": "20250929", + "revision": "20251016", "rootUrl": "https://apigee.googleapis.com/", "schemas": { "EdgeConfigstoreBundleBadBundle": { @@ -18771,14 +18930,12 @@ "enum": [ "ATTRIBUTE_UNSPECIFIED", "ATTRIBUTE_ENVIRONMENTS", - "ATTRIBUTE_IP_ADDRESS_RANGES", - "ATTRIBUTE_API_KEYS" + "ATTRIBUTE_IP_ADDRESS_RANGES" ], "enumDescriptions": [ "Unspecified attribute.", "Values will be a list of environments.", - "Values will be a list of IP addresses. This could be either IPv4 or IPv6.", - "Values will be a list of API keys." + "Values will be a list of IP addresses. This could be either IPv4 or IPv6." ], "type": "string" }, diff --git a/discovery/apihub-v1.json b/discovery/apihub-v1.json index 89bf9c1f95..343ae7ab09 100644 --- a/discovery/apihub-v1.json +++ b/discovery/apihub-v1.json @@ -172,7 +172,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -508,7 +508,7 @@ ] }, "patch": { - "description": "Update an API resource in the API hub. The following fields in the API can be updated: * display_name * description * owner * documentation * target_user * team * business_unit * maturity_level * api_style * attributes The update_mask should be used to specify the fields being updated. Updating the owner field requires complete owner message and updates both owner and email fields.", + "description": "Update an API resource in the API hub. The following fields in the API can be updated: * display_name * description * owner * documentation * target_user * team * business_unit * maturity_level * api_style * attributes * fingerprint The update_mask should be used to specify the fields being updated. Updating the owner field requires complete owner message and updates both owner and email fields.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}", "httpMethod": "PATCH", "id": "apihub.projects.locations.apis.patch", @@ -866,7 +866,7 @@ ] }, "patch": { - "description": "Update an operation in an API version. The following fields in the ApiOperation resource can be updated: * details.description * details.documentation * details.http_operation.path * details.http_operation.method * details.deprecated * attributes The update_mask should be used to specify the fields being updated. An operation can be updated only if the operation was created via CreateApiOperation API. If the operation was created by parsing the spec, then it can be edited by updating the spec.", + "description": "Update an operation in an API version. The following fields in the ApiOperation resource can be updated: * details.description * details.documentation * details.http_operation.path * details.http_operation.method * details.deprecated * attributes * details.mcp_tool.title * details.mcp_tool.description * details.input_schema * details.output_schema * details.mcp_tool.annotations.title * details.mcp_tool.annotations.read_only_hint * details.mcp_tool.annotations.destructive_hint * details.mcp_tool.annotations.idempotent_hint * details.mcp_tool.annotations.open_world_hint * details.mcp_tool.annotations.additional_hints The update_mask should be used to specify the fields being updated. An operation can be updated only if the operation was created via CreateApiOperation API. If the operation was created by parsing the spec, then it can be edited by updating the spec.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/operations/{operationsId}", "httpMethod": "PATCH", "id": "apihub.projects.locations.apis.versions.operations.patch", @@ -2276,6 +2276,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}/operations", @@ -2974,7 +2979,7 @@ } } }, - "revision": "20250912", + "revision": "20251025", "rootUrl": "https://apihub.googleapis.com/", "schemas": { "Empty": { @@ -3099,7 +3104,7 @@ "description": "Optional. The documentation for the API resource." }, "fingerprint": { - "description": "Optional. Fingerprint of the API resource.", + "description": "Optional. Fingerprint of the API resource. This must be unique for each API resource. It can neither be unset nor be updated to an existing fingerprint of another API resource.", "type": "string" }, "maturityLevel": { @@ -6515,6 +6520,13 @@ "$ref": "GoogleLongrunningOperation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/discovery/apim-v1alpha.json b/discovery/apim-v1alpha.json index 9d4cd7afa1..896c3c67d3 100644 --- a/discovery/apim-v1alpha.json +++ b/discovery/apim-v1alpha.json @@ -169,7 +169,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -851,7 +851,7 @@ } } }, - "revision": "20250924", + "revision": "20251022", "rootUrl": "https://apim.googleapis.com/", "schemas": { "ApiObservation": { diff --git a/discovery/artifactregistry-v1.json b/discovery/artifactregistry-v1.json index 9c51a94ed8..9762e80f8d 100644 --- a/discovery/artifactregistry-v1.json +++ b/discovery/artifactregistry-v1.json @@ -2465,7 +2465,7 @@ } } }, - "revision": "20250925", + "revision": "20251007", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { @@ -4115,7 +4115,8 @@ "PYTHON", "KFP", "GO", - "GENERIC" + "GENERIC", + "RUBY" ], "enumDescriptions": [ "Unspecified package format.", @@ -4128,7 +4129,8 @@ "Python package format.", "Kubeflow Pipelines package format.", "Go package format.", - "Generic package format." + "Generic package format.", + "Ruby package format." ], "type": "string" }, @@ -4666,7 +4668,7 @@ "DISABLED" ], "enumDescriptions": [ - "Not set. This will be treated as INHERITED.", + "Not set. This will be treated as INHERITED for Docker repositories and DISABLED for non-Docker repositories.", "Scanning is Enabled, but dependent on API enablement.", "No automatic vulnerability scanning will be performed for this repository." ], diff --git a/discovery/authorizedbuyersmarketplace-v1.json b/discovery/authorizedbuyersmarketplace-v1.json index dcc1c264ea..c7d764a2f7 100644 --- a/discovery/authorizedbuyersmarketplace-v1.json +++ b/discovery/authorizedbuyersmarketplace-v1.json @@ -204,6 +204,34 @@ "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ] + }, + "setReadyToServe": { + "description": "Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. In addition, bidders can use the URL path \"/v1/bidders/{accountId}/finalizedDeals/{dealId}\" to set ready to serve for the finalized deals belong to itself, its child seats and all their clients. This method only applies to programmatic guaranteed deals.", + "flatPath": "v1/bidders/{biddersId}/finalizedDeals/{finalizedDealsId}:setReadyToServe", + "httpMethod": "POST", + "id": "authorizedbuyersmarketplace.bidders.finalizedDeals.setReadyToServe", + "parameterOrder": [ + "deal" + ], + "parameters": { + "deal": { + "description": "Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}` or `bidders/{accountId}/finalizedDeals/{dealId}`", + "location": "path", + "pattern": "^bidders/[^/]+/finalizedDeals/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+deal}:setReadyToServe", + "request": { + "$ref": "SetReadyToServeRequest" + }, + "response": { + "$ref": "FinalizedDeal" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] } } } @@ -920,7 +948,7 @@ ] }, "setReadyToServe": { - "description": "Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. This method only applies to programmatic guaranteed deals.", + "description": "Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. In addition, bidders can use the URL path \"/v1/bidders/{accountId}/finalizedDeals/{dealId}\" to set ready to serve for the finalized deals belong to itself, its child seats and all their clients. This method only applies to programmatic guaranteed deals.", "flatPath": "v1/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}:setReadyToServe", "httpMethod": "POST", "id": "authorizedbuyersmarketplace.buyers.finalizedDeals.setReadyToServe", @@ -929,7 +957,7 @@ ], "parameters": { "deal": { - "description": "Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}`", + "description": "Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}` or `bidders/{accountId}/finalizedDeals/{dealId}`", "location": "path", "pattern": "^buyers/[^/]+/finalizedDeals/[^/]+$", "required": true, @@ -1367,7 +1395,7 @@ } } }, - "revision": "20250828", + "revision": "20251028", "rootUrl": "https://authorizedbuyersmarketplace.googleapis.com/", "schemas": { "AcceptProposalRequest": { diff --git a/discovery/authorizedbuyersmarketplace-v1alpha.json b/discovery/authorizedbuyersmarketplace-v1alpha.json index b1cc97cfc9..dd0ac6d490 100644 --- a/discovery/authorizedbuyersmarketplace-v1alpha.json +++ b/discovery/authorizedbuyersmarketplace-v1alpha.json @@ -204,6 +204,34 @@ "scopes": [ "https://www.googleapis.com/auth/authorized-buyers-marketplace" ] + }, + "setReadyToServe": { + "description": "Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. In addition, bidders can use the URL path \"/v1alpha/bidders/{accountId}/finalizedDeals/{dealId}\" to set ready to serve for the finalized deals belong to itself, its child seats and all their clients. This method only applies to programmatic guaranteed deals.", + "flatPath": "v1alpha/bidders/{biddersId}/finalizedDeals/{finalizedDealsId}:setReadyToServe", + "httpMethod": "POST", + "id": "authorizedbuyersmarketplace.bidders.finalizedDeals.setReadyToServe", + "parameterOrder": [ + "deal" + ], + "parameters": { + "deal": { + "description": "Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}` or `bidders/{accountId}/finalizedDeals/{dealId}`", + "location": "path", + "pattern": "^bidders/[^/]+/finalizedDeals/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+deal}:setReadyToServe", + "request": { + "$ref": "SetReadyToServeRequest" + }, + "response": { + "$ref": "FinalizedDeal" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] } } } @@ -1103,7 +1131,7 @@ ] }, "setReadyToServe": { - "description": "Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. This method only applies to programmatic guaranteed deals.", + "description": "Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. In addition, bidders can use the URL path \"/v1alpha/bidders/{accountId}/finalizedDeals/{dealId}\" to set ready to serve for the finalized deals belong to itself, its child seats and all their clients. This method only applies to programmatic guaranteed deals.", "flatPath": "v1alpha/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}:setReadyToServe", "httpMethod": "POST", "id": "authorizedbuyersmarketplace.buyers.finalizedDeals.setReadyToServe", @@ -1112,7 +1140,7 @@ ], "parameters": { "deal": { - "description": "Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}`", + "description": "Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}` or `bidders/{accountId}/finalizedDeals/{dealId}`", "location": "path", "pattern": "^buyers/[^/]+/finalizedDeals/[^/]+$", "required": true, @@ -1550,7 +1578,7 @@ } } }, - "revision": "20250910", + "revision": "20251028", "rootUrl": "https://authorizedbuyersmarketplace.googleapis.com/", "schemas": { "AcceptProposalRequest": { diff --git a/discovery/backupdr-v1.json b/discovery/backupdr-v1.json index 69e2ebb59b..4611606ac6 100644 --- a/discovery/backupdr-v1.json +++ b/discovery/backupdr-v1.json @@ -1363,6 +1363,72 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "fetchForResourceType": { + "description": "Fetch Backups for a given resource type.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups:fetchForResourceType", + "httpMethod": "GET", + "id": "backupdr.projects.locations.backupVaults.dataSources.backups.fetchForResourceType", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. A filter expression that filters the results fetched in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. Supported fields:", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of Backups to return. The service may return fewer than this value. If unspecified, at most 50 Backups will be returned. The maximum value is 100; values above 100 will be coerced to 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous call of `FetchBackupsForResourceType`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchBackupsForResourceType` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Datasources are the parent resource for the backups. Format: projects/{project}/locations/{location}/backupVaults/{backupVaultId}/dataSources/{datasourceId}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$", + "required": true, + "type": "string" + }, + "resourceType": { + "description": "Required. The type of the GCP resource. Ex: sqladmin.googleapis.com/Instance", + "location": "query", + "type": "string" + }, + "view": { + "description": "Optional. This parameter is used to specify the view of the backup. If not specified, the default view is BASIC.", + "enum": [ + "BACKUP_VIEW_UNSPECIFIED", + "BACKUP_VIEW_BASIC", + "BACKUP_VIEW_FULL" + ], + "enumDescriptions": [ + "If the value is not set, the default 'FULL' view is used.", + "Includes basic data about the Backup, but not the full contents.", + "Includes all data about the Backup. This is the default value (for both ListBackups and GetBackup)." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/backups:fetchForResourceType", + "response": { + "$ref": "FetchBackupsForResourceTypeResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "Gets details of a Backup.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups/{backupsId}", @@ -1614,6 +1680,52 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "list": { + "description": "Lists DataSourceReferences for a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSourceReferences", + "httpMethod": "GET", + "id": "backupdr.projects.locations.dataSourceReferences.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. A filter expression that filters the results listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The following field and operator combinations are supported: * data_source_gcp_resource_info.gcp_resourcename with `=`, `!=` * data_source_gcp_resource_info.type with `=`, `!=`", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * data_source * data_source_gcp_resource_info.gcp_resourcename", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of DataSourceReferences to return. The service may return fewer than this value. If unspecified, at most 50 DataSourceReferences will be returned. The maximum value is 100; values above 100 will be coerced to 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListDataSourceReferences` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDataSourceReferences` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource name. Format: projects/{project}/locations/{location}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/dataSourceReferences", + "response": { + "$ref": "ListDataSourceReferencesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } }, @@ -2122,7 +2234,7 @@ } } }, - "revision": "20251001", + "revision": "20251015", "rootUrl": "https://backupdr.googleapis.com/", "schemas": { "AbandonBackupRequest": { @@ -2602,6 +2714,11 @@ "description": "Output only. Configuration for a Google Cloud resource.", "readOnly": true }, + "gcpResource": { + "$ref": "BackupGcpResource", + "description": "Output only. Unique identifier of the GCP resource that is being backed up.", + "readOnly": true + }, "labels": { "additionalProperties": { "type": "string" @@ -2950,6 +3067,25 @@ }, "type": "object" }, + "BackupGcpResource": { + "description": "Minimum details to identify a Google Cloud resource for a backup.", + "id": "BackupGcpResource", + "properties": { + "gcpResourcename": { + "description": "Name of the Google Cloud resource.", + "type": "string" + }, + "location": { + "description": "Location of the resource: //\"global\"/\"unspecified\".", + "type": "string" + }, + "type": { + "description": "Type of the resource. Use the Unified Resource Type, eg. compute.googleapis.com/Instance.", + "type": "string" + } + }, + "type": "object" + }, "BackupLocation": { "description": "BackupLocation represents a cloud location where a backup can be stored.", "id": "BackupLocation", @@ -3448,6 +3584,18 @@ "readOnly": true, "type": "boolean" }, + "instanceCreateTime": { + "description": "Output only. The instance creation timestamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "instanceDeleteTime": { + "description": "Output only. The instance delete timestamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "instanceTier": { "description": "Output only. The tier (or machine type) for this instance. Example: `db-custom-1-3840`", "readOnly": true, @@ -4132,6 +4280,12 @@ "name": { "description": "Identifier. The resource name of the DataSourceReference. Format: projects/{project}/locations/{location}/dataSourceReferences/{data_source_reference}", "type": "string" + }, + "totalStoredBytes": { + "description": "Output only. Total size of the storage used by all backup resources for the referenced datasource.", + "format": "int64", + "readOnly": true, + "type": "string" } }, "type": "object" @@ -4501,6 +4655,24 @@ }, "type": "object" }, + "FetchBackupsForResourceTypeResponse": { + "description": "Response for the FetchBackupsForResourceType method.", + "id": "FetchBackupsForResourceTypeResponse", + "properties": { + "backups": { + "description": "The Backups from the specified parent.", + "items": { + "$ref": "Backup" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, "FetchDataSourceReferencesForResourceTypeResponse": { "description": "Response for the FetchDataSourceReferencesForResourceType method.", "id": "FetchDataSourceReferencesForResourceTypeResponse", @@ -4938,6 +5110,24 @@ }, "type": "object" }, + "ListDataSourceReferencesResponse": { + "description": "Response for the ListDataSourceReferences method.", + "id": "ListDataSourceReferencesResponse", + "properties": { + "dataSourceReferences": { + "description": "The DataSourceReferences from the specified parent.", + "items": { + "$ref": "DataSourceReference" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, "ListDataSourcesResponse": { "description": "Response message for listing DataSources.", "id": "ListDataSourcesResponse", diff --git a/discovery/bigquery-v2.json b/discovery/bigquery-v2.json index d97733e269..809ac78058 100644 --- a/discovery/bigquery-v2.json +++ b/discovery/bigquery-v2.json @@ -2375,7 +2375,7 @@ } } }, - "revision": "20250928", + "revision": "20251012", "rootUrl": "https://bigquery.googleapis.com/", "schemas": { "AggregateClassificationMetrics": { @@ -5185,6 +5185,10 @@ "$ref": "TableReference", "description": "The base table reference." }, + "indexId": { + "description": "The index id.", + "type": "string" + }, "postIndexPruningParallelInputCount": { "description": "The number of parallel inputs after index pruning.", "format": "int64", diff --git a/discovery/bigquerydatatransfer-v1.json b/discovery/bigquerydatatransfer-v1.json index 585a6c4e8f..eff0ad0ac6 100644 --- a/discovery/bigquerydatatransfer-v1.json +++ b/discovery/bigquerydatatransfer-v1.json @@ -1488,7 +1488,7 @@ } } }, - "revision": "20250906", + "revision": "20251020", "rootUrl": "https://bigquerydatatransfer.googleapis.com/", "schemas": { "CheckValidCredsRequest": { @@ -2134,6 +2134,20 @@ "description": "Output only. Error code with detailed information about reason of the latest config failure.", "readOnly": true }, + "managedTableType": { + "description": "The classification of the destination table.", + "enum": [ + "MANAGED_TABLE_TYPE_UNSPECIFIED", + "NATIVE", + "BIGLAKE" + ], + "enumDescriptions": [ + "Type unspecified. This defaults to `NATIVE` table.", + "The managed table is a native BigQuery table. This is the default value.", + "The managed table is a BigQuery table for Apache Iceberg (formerly BigLake managed tables), with a BigLake configuration." + ], + "type": "string" + }, "name": { "description": "Identifier. The resource name of the transfer config. Transfer config names have the form either `projects/{project_id}/locations/{region}/transferConfigs/{config_id}` or `projects/{project_id}/transferConfigs/{config_id}`, where `config_id` is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config.", "type": "string" diff --git a/discovery/bigqueryreservation-v1.json b/discovery/bigqueryreservation-v1.json index b611abee2c..99d5d7a478 100644 --- a/discovery/bigqueryreservation-v1.json +++ b/discovery/bigqueryreservation-v1.json @@ -1267,7 +1267,7 @@ } } }, - "revision": "20250907", + "revision": "20251009", "rootUrl": "https://bigqueryreservation.googleapis.com/", "schemas": { "Assignment": { @@ -1313,6 +1313,10 @@ "readOnly": true, "type": "string" }, + "schedulingPolicy": { + "$ref": "SchedulingPolicy", + "description": "Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available." + }, "state": { "description": "Output only. State of the assignment.", "enum": [ @@ -1916,6 +1920,10 @@ ], "type": "string" }, + "schedulingPolicy": { + "$ref": "SchedulingPolicy", + "description": "Optional. The scheduling policy to use for jobs and queries running under this reservation. The scheduling policy controls how the reservation's resources are distributed. This feature is not yet generally available." + }, "secondaryLocation": { "description": "Optional. The current location of the reservation's secondary replica. This field is only set for reservations using the managed disaster recovery feature. Users can set this in create reservation calls to create a failover reservation or in update reservation calls to convert a non-failover reservation to a failover reservation(or vice versa).", "type": "string" @@ -1945,6 +1953,23 @@ }, "type": "object" }, + "SchedulingPolicy": { + "description": "The scheduling policy controls how a reservation's resources are distributed.", + "id": "SchedulingPolicy", + "properties": { + "concurrency": { + "description": "Optional. If present and > 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available.", + "format": "int64", + "type": "string" + }, + "maxSlots": { + "description": "Optional. If present and > 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "SearchAllAssignmentsResponse": { "description": "The response for ReservationService.SearchAllAssignments.", "id": "SearchAllAssignmentsResponse", diff --git a/discovery/bigtableadmin-v2.json b/discovery/bigtableadmin-v2.json index 5e8264d496..85546a19c3 100644 --- a/discovery/bigtableadmin-v2.json +++ b/discovery/bigtableadmin-v2.json @@ -3070,7 +3070,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -3118,7 +3118,7 @@ } } }, - "revision": "20251012", + "revision": "20251026", "rootUrl": "https://bigtableadmin.googleapis.com/", "schemas": { "AppProfile": { @@ -3627,7 +3627,7 @@ }, "valueType": { "$ref": "Type", - "description": "The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations" + "description": "The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. This field is mutually exclusive with `sql_type`. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations" } }, "type": "object" diff --git a/discovery/businessprofileperformance-v1.json b/discovery/businessprofileperformance-v1.json index 0e66bace4c..a3cad61acb 100644 --- a/discovery/businessprofileperformance-v1.json +++ b/discovery/businessprofileperformance-v1.json @@ -123,6 +123,20 @@ "BUSINESS_FOOD_ORDERS", "BUSINESS_FOOD_MENU_CLICKS" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + true, + false + ], "enumDescriptions": [ "Represents the default unknown value.", "Business impressions on Google Maps on Desktop devices. Multiple impressions by a unique user within a single day are counted as a single impression.", @@ -215,6 +229,20 @@ "BUSINESS_FOOD_ORDERS", "BUSINESS_FOOD_MENU_CLICKS" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + true, + false + ], "enumDescriptions": [ "Represents the default unknown value.", "Business impressions on Google Maps on Desktop devices. Multiple impressions by a unique user within a single day are counted as a single impression.", @@ -417,7 +445,7 @@ } } }, - "revision": "20241002", + "revision": "20251026", "rootUrl": "https://businessprofileperformance.googleapis.com/", "schemas": { "DailyMetricTimeSeries": { @@ -440,6 +468,20 @@ "BUSINESS_FOOD_ORDERS", "BUSINESS_FOOD_MENU_CLICKS" ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + true, + false + ], "enumDescriptions": [ "Represents the default unknown value.", "Business impressions on Google Maps on Desktop devices. Multiple impressions by a unique user within a single day are counted as a single impression.", diff --git a/discovery/chat-v1.json b/discovery/chat-v1.json index d47acfd56c..3182b6f2c9 100644 --- a/discovery/chat-v1.json +++ b/discovery/chat-v1.json @@ -1535,7 +1535,7 @@ } } }, - "revision": "20251014", + "revision": "20251029", "rootUrl": "https://chat.googleapis.com/", "schemas": { "AccessSettings": { @@ -2243,7 +2243,7 @@ "enumDescriptions": [ "This value is unused.", "User deleted their own message.", - "A space manager deleted the message.", + "An owner or manager deleted the message.", "A Google Workspace administrator deleted the message. Administrators can delete any message in the space, including messages sent by any space member or Chat app.", "A Chat app deleted its own message when it expired.", "A Chat app deleted the message on behalf of the creator (using user authentication).", @@ -3041,7 +3041,7 @@ "type": "string" }, "valueMsEpoch": { - "description": "Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`).", + "description": "The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`).", "format": "int64", "type": "string" } @@ -4494,12 +4494,14 @@ "enum": [ "MEMBERSHIP_ROLE_UNSPECIFIED", "ROLE_MEMBER", - "ROLE_MANAGER" + "ROLE_MANAGER", + "ROLE_ASSISTANT_MANAGER" ], "enumDescriptions": [ "Default value. For users: they aren't a member of the space, but can be invited. For Google Groups: they're always assigned this role (other enum values might be used in the future).", "A member of the space. In the Chat UI, this role is called Member. The user has basic permissions, like sending messages to the space. Managers and owners can grant members additional permissions in a space, including: - Add or remove members. - Modify space details. - Turn history on or off. - Mention everyone in the space with `@all`. - Manage Chat apps and webhooks installed in the space. In direct messages and unnamed group conversations, everyone has this role.", - "A space owner. In the Chat UI, this role is called Owner. The user has the complete set of space permissions to manage the space, including: - Change the role of other members in the space to member, manager, or owner. - Delete the space. Only supported in SpaceType.SPACE (named spaces). To learn more, see [Learn more about your role as a space owner or manager](https://support.google.com/chat/answer/11833441)." + "A space owner. In the Chat UI, this role is called Owner. The user has the complete set of space permissions to manage the space, including: - Change the role of other members in the space to member, manager, or owner. - Delete the space. Only supported in SpaceType.SPACE (named spaces). To learn more, see [Learn more about your role as a space owner or manager](https://support.google.com/chat/answer/11833441).", + "A space manager. In the Chat UI, this role is called Manager. The user has all basic permissions of `ROLE_MEMBER`, and can be granted a subset of administrative permissions by an owner. By default, managers have all the permissions of an owner except for the ability to: - Delete the space. - Make another space member an owner. - Change an owner's role. By default, managers permissions include but aren't limited to: - Make another member a manager. - Delete messages in the space. - Manage space permissions. - Receive notifications for requests to join the space if the manager has the \"manage members\" permission in the space settings. - Make a space discoverable. Only supported in SpaceType.SPACE (named spaces). To learn more, see [Manage space settings](https://support.google.com/chat/answer/13340792)." ], "type": "string" }, @@ -4871,6 +4873,10 @@ "description": "Represents a space permission setting.", "id": "PermissionSetting", "properties": { + "assistantManagersAllowed": { + "description": "Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission.", + "type": "boolean" + }, "managersAllowed": { "description": "Optional. Whether space owners (`ROLE_MANAGER`) have this permission.", "type": "boolean" @@ -5199,7 +5205,7 @@ "type": "string" }, "customer": { - "description": "Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated.", + "description": "Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users.", "type": "string" }, "displayName": { diff --git a/discovery/chromewebstore-v2.json b/discovery/chromewebstore-v2.json new file mode 100644 index 0000000000..e17435629e --- /dev/null +++ b/discovery/chromewebstore-v2.json @@ -0,0 +1,550 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/chromewebstore": { + "description": "See, edit, update, or publish your Chrome Web Store extensions, themes, apps, and licences you have access to" + }, + "https://www.googleapis.com/auth/chromewebstore.readonly": { + "description": "See and download your Chrome Web Store extensions and apps, and see licenses you have access to" + } + } + } + }, + "basePath": "", + "baseUrl": "https://chromewebstore.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Chromewebstore", + "description": "The Chrome Web Store API provides access to data about apps and extensions, as well as developer tools for managing them.", + "discoveryVersion": "v1", + "documentationLink": "https://developer.chrome.com/docs/webstore/api", + "fullyEncodeReservedExpansion": true, + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "chromewebstore:v2", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://chromewebstore.mtls.googleapis.com/", + "name": "chromewebstore", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "description": "Data format for response.", + "enum": [ + "json", + "media", + "proto" + ], + "enumDescriptions": [ + "Responses with Content-Type of application/json", + "Media download with context-dependent Content-Type", + "Responses with Content-Type of application/x-protobuf" + ], + "location": "query", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", + "location": "query", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "media": { + "methods": { + "upload": { + "description": "Upload a new package to an existing item.", + "flatPath": "v2/publishers/{publishersId}/items/{itemsId}:upload", + "httpMethod": "POST", + "id": "chromewebstore.media.upload", + "mediaUpload": { + "accept": [ + "*/*" + ], + "maxSize": "2147483648", + "protocols": { + "simple": { + "multipart": true, + "path": "/upload/v2/{+name}:upload" + } + } + }, + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the item to upload the new package to in the form `publishers/{publisherId}/items/{itemId}`", + "location": "path", + "pattern": "^publishers/[^/]+/items/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}:upload", + "request": { + "$ref": "UploadItemPackageRequest" + }, + "response": { + "$ref": "UploadItemPackageResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/chromewebstore" + ], + "supportsMediaUpload": true + } + } + }, + "publishers": { + "resources": { + "items": { + "methods": { + "cancelSubmission": { + "description": "Cancel the current active submission of an item if present. This can be used to cancel the review of a pending submission.", + "flatPath": "v2/publishers/{publishersId}/items/{itemsId}:cancelSubmission", + "httpMethod": "POST", + "id": "chromewebstore.publishers.items.cancelSubmission", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the item to cancel the submission of in the form `publishers/{publisherId}/items/{itemId}`", + "location": "path", + "pattern": "^publishers/[^/]+/items/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}:cancelSubmission", + "request": { + "$ref": "CancelSubmissionRequest" + }, + "response": { + "$ref": "CancelSubmissionResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/chromewebstore" + ] + }, + "fetchStatus": { + "description": "Fetch the status of an item.", + "flatPath": "v2/publishers/{publishersId}/items/{itemsId}:fetchStatus", + "httpMethod": "GET", + "id": "chromewebstore.publishers.items.fetchStatus", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the item to retrieve the status of in the form `publishers/{publisherId}/items/{itemId}`", + "location": "path", + "pattern": "^publishers/[^/]+/items/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}:fetchStatus", + "response": { + "$ref": "FetchItemStatusResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/chromewebstore", + "https://www.googleapis.com/auth/chromewebstore.readonly" + ] + }, + "publish": { + "description": "Submit the item to be published in the store. The item will be submitted for review unless `skip_review` is set to true, or the item is staged from a previous submission with `publish_type` set to `STAGED_PUBLISH`.", + "flatPath": "v2/publishers/{publishersId}/items/{itemsId}:publish", + "httpMethod": "POST", + "id": "chromewebstore.publishers.items.publish", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the item in the form `publishers/{publisherId}/items/{itemId}`", + "location": "path", + "pattern": "^publishers/[^/]+/items/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}:publish", + "request": { + "$ref": "PublishItemRequest" + }, + "response": { + "$ref": "PublishItemResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/chromewebstore" + ] + }, + "setPublishedDeployPercentage": { + "description": "Set a higher target deploy percentage for the item's published revision. This will be updated without the item being submitted for review. This is only available to items with over 10,000 seven-day active users.", + "flatPath": "v2/publishers/{publishersId}/items/{itemsId}:setPublishedDeployPercentage", + "httpMethod": "POST", + "id": "chromewebstore.publishers.items.setPublishedDeployPercentage", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the item to update the published revision of in the form `publishers/{publisherId}/items/{itemId}`", + "location": "path", + "pattern": "^publishers/[^/]+/items/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}:setPublishedDeployPercentage", + "request": { + "$ref": "SetPublishedDeployPercentageRequest" + }, + "response": { + "$ref": "SetPublishedDeployPercentageResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/chromewebstore" + ] + } + } + } + } + } + }, + "revision": "20251026", + "rootUrl": "https://chromewebstore.googleapis.com/", + "schemas": { + "CancelSubmissionRequest": { + "description": "Request message for CancelSubmission.", + "id": "CancelSubmissionRequest", + "properties": {}, + "type": "object" + }, + "CancelSubmissionResponse": { + "description": "Response message for `CancelSubmission`.", + "id": "CancelSubmissionResponse", + "properties": {}, + "type": "object" + }, + "DeployInfo": { + "description": "Deployment information for a specific release channel. Used in requests to update deployment parameters.", + "id": "DeployInfo", + "properties": { + "deployPercentage": { + "description": "Required. The current deploy percentage for the release channel (nonnegative number between 0 and 100).", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "DistributionChannel": { + "description": "Deployment information for a specific release channel", + "id": "DistributionChannel", + "properties": { + "crxVersion": { + "description": "The extension version provided in the manifest of the uploaded package.", + "type": "string" + }, + "deployPercentage": { + "description": "The current deploy percentage for the release channel (nonnegative number between 0 and 100).", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "FetchItemStatusResponse": { + "description": "Response message for `FetchItemStatus`.", + "id": "FetchItemStatusResponse", + "properties": { + "itemId": { + "description": "Output only. The ID of the item.", + "readOnly": true, + "type": "string" + }, + "lastAsyncUploadState": { + "description": "Output only. The state of the last async upload for an item. Only set when there has been an async upload for the item in the past 24 hours.", + "enum": [ + "UPLOAD_STATE_UNSPECIFIED", + "SUCCEEDED", + "IN_PROGRESS", + "FAILED", + "NOT_FOUND" + ], + "enumDescriptions": [ + "The default value.", + "The upload succeeded.", + "The upload is currently being processed.", + "The upload failed.", + "Used as the value of `lastAsyncUploadState` in a `fetchStatus` response indicating that an upload attempt was not found." + ], + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the requested item.", + "type": "string" + }, + "publicKey": { + "description": "The public key of the item, which may be generated by the store.", + "type": "string" + }, + "publishedItemRevisionStatus": { + "$ref": "ItemRevisionStatus", + "description": "Output only. Status of the current published revision of the item. Will be unset if the item is not published.", + "readOnly": true + }, + "submittedItemRevisionStatus": { + "$ref": "ItemRevisionStatus", + "description": "Status of the item revision submitted to be published. Will be unset if the item has not been submitted for publishing since the last successful publish." + }, + "takenDown": { + "description": "If true, the item has been taken down for a policy violation. Check the developer dashboard for details.", + "type": "boolean" + }, + "warned": { + "description": "If true, the item has been warned for a policy violation and will be taken down if not resolved. Check the developer dashboard for details.", + "type": "boolean" + } + }, + "type": "object" + }, + "ItemRevisionStatus": { + "description": "Details on the status of an item revision.", + "id": "ItemRevisionStatus", + "properties": { + "distributionChannels": { + "description": "Details on the package of the item", + "items": { + "$ref": "DistributionChannel" + }, + "type": "array" + }, + "state": { + "description": "Output only. Current state of the item", + "enum": [ + "ITEM_STATE_UNSPECIFIED", + "PENDING_REVIEW", + "STAGED", + "PUBLISHED", + "PUBLISHED_TO_TESTERS", + "REJECTED", + "CANCELLED" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "The item is pending review.", + "The item has been approved and is ready to be published.", + "The item is published publicly.", + "The item is published to trusted testers.", + "The item has been rejected for publishing.", + "The item submission has been cancelled." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "PublishItemRequest": { + "description": "Request message for PublishItem.", + "id": "PublishItemRequest", + "properties": { + "deployInfos": { + "description": "Optional. Additional deploy information including the desired initial percentage rollout. Defaults to the current value saved in the developer dashboard if unset.", + "items": { + "$ref": "DeployInfo" + }, + "type": "array" + }, + "publishType": { + "description": "Optional. Use this to control if the item is published immediately on approval or staged for publishing in the future. Defaults to `DEFAULT_PUBLISH` if unset.", + "enum": [ + "PUBLISH_TYPE_UNSPECIFIED", + "DEFAULT_PUBLISH", + "STAGED_PUBLISH" + ], + "enumDescriptions": [ + "Default value. This is the same as DEFAULT_PUBLISH.", + "The submission will be published immediately after being approved.", + "After approval the submission will be staged and can then be published by the developer." + ], + "type": "string" + }, + "skipReview": { + "description": "Optional. Whether to attempt to skip item review. The API will validate if the item qualifies and return a validation error if the item requires review. Defaults to `false` if unset.", + "type": "boolean" + } + }, + "type": "object" + }, + "PublishItemResponse": { + "description": "Response message for `PublishItem`.", + "id": "PublishItemResponse", + "properties": { + "itemId": { + "description": "Output only. The ID of the item.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the item that was submitted", + "type": "string" + }, + "state": { + "description": "Output only. The current state of the submission.", + "enum": [ + "ITEM_STATE_UNSPECIFIED", + "PENDING_REVIEW", + "STAGED", + "PUBLISHED", + "PUBLISHED_TO_TESTERS", + "REJECTED", + "CANCELLED" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "The item is pending review.", + "The item has been approved and is ready to be published.", + "The item is published publicly.", + "The item is published to trusted testers.", + "The item has been rejected for publishing.", + "The item submission has been cancelled." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "SetPublishedDeployPercentageRequest": { + "description": "Request message for SetPublishedDeployPercentage.", + "id": "SetPublishedDeployPercentageRequest", + "properties": { + "deployPercentage": { + "description": "Required. Unscaled percentage value for the publised revision (nonnegative number between 0 and 100). It must be larger than the existing target percentage.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "SetPublishedDeployPercentageResponse": { + "description": "Response message for `SetPublishedDeployPercentage`.", + "id": "SetPublishedDeployPercentageResponse", + "properties": {}, + "type": "object" + }, + "UploadItemPackageRequest": { + "description": "Request message for UploadItemPackage.", + "id": "UploadItemPackageRequest", + "properties": {}, + "type": "object" + }, + "UploadItemPackageResponse": { + "description": "Response message for `UploadItemPackage`.", + "id": "UploadItemPackageResponse", + "properties": { + "crxVersion": { + "description": "The extension version provided in the manifest of the uploaded package. This will not be set if the upload is still in progress (`upload_state` is `UPLOAD_IN_PROGRESS`).", + "type": "string" + }, + "itemId": { + "description": "Output only. The ID of the item the package was uploaded to.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the item the package was uploaded to.", + "type": "string" + }, + "uploadState": { + "description": "Output only. The state of the upload. If `upload_state` is `UPLOAD_IN_PROGRESS`, you can poll for updates using the fetchStatus method.", + "enum": [ + "UPLOAD_STATE_UNSPECIFIED", + "SUCCEEDED", + "IN_PROGRESS", + "FAILED", + "NOT_FOUND" + ], + "enumDescriptions": [ + "The default value.", + "The upload succeeded.", + "The upload is currently being processed.", + "The upload failed.", + "Used as the value of `lastAsyncUploadState` in a `fetchStatus` response indicating that an upload attempt was not found." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Chrome Web Store API", + "version": "v2", + "version_module": true +} \ No newline at end of file diff --git a/discovery/cloudbuild-v2.json b/discovery/cloudbuild-v2.json index fe992b9660..6c3d998895 100644 --- a/discovery/cloudbuild-v2.json +++ b/discovery/cloudbuild-v2.json @@ -371,7 +371,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1087,7 +1087,7 @@ } } }, - "revision": "20250903", + "revision": "20251021", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/discovery/cloudfunctions-v1.json b/discovery/cloudfunctions-v1.json index 4c947b5746..7a11bddd42 100644 --- a/discovery/cloudfunctions-v1.json +++ b/discovery/cloudfunctions-v1.json @@ -190,7 +190,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -563,7 +563,7 @@ } } }, - "revision": "20250929", + "revision": "20251023", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/discovery/cloudfunctions-v2.json b/discovery/cloudfunctions-v2.json index f7176e5cc5..d7ca355375 100644 --- a/discovery/cloudfunctions-v2.json +++ b/discovery/cloudfunctions-v2.json @@ -119,7 +119,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -755,7 +755,7 @@ } } }, - "revision": "20250929", + "revision": "20251023", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AbortFunctionUpgradeRequest": { diff --git a/discovery/cloudfunctions-v2alpha.json b/discovery/cloudfunctions-v2alpha.json index 04e26fb91a..7d2c3a2399 100644 --- a/discovery/cloudfunctions-v2alpha.json +++ b/discovery/cloudfunctions-v2alpha.json @@ -119,7 +119,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -755,7 +755,7 @@ } } }, - "revision": "20250929", + "revision": "20251023", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AbortFunctionUpgradeRequest": { @@ -947,6 +947,28 @@ "properties": {}, "type": "object" }, + "DirectVpcNetworkInterface": { + "description": "The Direct VPC network interface. This is mutually exclusive with VPC Connector.", + "id": "DirectVpcNetworkInterface", + "properties": { + "network": { + "description": "Optional. The name of the VPC network to which the function will be connected. Specify either a VPC network or a subnet, or both. If you specify only a network, the subnet uses the same name as the network.", + "type": "string" + }, + "subnetwork": { + "description": "Optional. The name of the VPC subnetwork that the Cloud Function resource will get IPs from. Specify either a VPC network or a subnet, or both. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used.", + "type": "string" + }, + "tags": { + "description": "Optional. Network tags applied to this Cloud Function resource.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "EventFilter": { "description": "Filters events based on exact matches on the CloudEvents attributes.", "id": "EventFilter", @@ -1876,6 +1898,27 @@ "description": "Optional. The binary authorization policy to be checked when deploying the Cloud Run service.", "type": "string" }, + "directVpcEgress": { + "description": "Optional. Egress settings for direct VPC. If not provided, it defaults to VPC_EGRESS_PRIVATE_RANGES_ONLY.", + "enum": [ + "DIRECT_VPC_EGRESS_UNSPECIFIED", + "VPC_EGRESS_PRIVATE_RANGES_ONLY", + "VPC_EGRESS_ALL_TRAFFIC" + ], + "enumDescriptions": [ + "Unspecified.", + "Sends only traffic to internal addresses through the VPC network.", + "Sends all outbound traffic through the VPC network." + ], + "type": "string" + }, + "directVpcNetworkInterface": { + "description": "Optional. The Direct VPC network interface for the Cloud Function. Currently only a single Direct VPC is supported.", + "items": { + "$ref": "DirectVpcNetworkInterface" + }, + "type": "array" + }, "environmentVariables": { "additionalProperties": { "type": "string" diff --git a/discovery/cloudfunctions-v2beta.json b/discovery/cloudfunctions-v2beta.json index 0dedf52b65..60aebd8f92 100644 --- a/discovery/cloudfunctions-v2beta.json +++ b/discovery/cloudfunctions-v2beta.json @@ -119,7 +119,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -755,7 +755,7 @@ } } }, - "revision": "20250929", + "revision": "20251023", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AbortFunctionUpgradeRequest": { @@ -947,6 +947,28 @@ "properties": {}, "type": "object" }, + "DirectVpcNetworkInterface": { + "description": "The Direct VPC network interface. This is mutually exclusive with VPC Connector.", + "id": "DirectVpcNetworkInterface", + "properties": { + "network": { + "description": "Optional. The name of the VPC network to which the function will be connected. Specify either a VPC network or a subnet, or both. If you specify only a network, the subnet uses the same name as the network.", + "type": "string" + }, + "subnetwork": { + "description": "Optional. The name of the VPC subnetwork that the Cloud Function resource will get IPs from. Specify either a VPC network or a subnet, or both. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used.", + "type": "string" + }, + "tags": { + "description": "Optional. Network tags applied to this Cloud Function resource.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "EventFilter": { "description": "Filters events based on exact matches on the CloudEvents attributes.", "id": "EventFilter", @@ -1876,6 +1898,27 @@ "description": "Optional. The binary authorization policy to be checked when deploying the Cloud Run service.", "type": "string" }, + "directVpcEgress": { + "description": "Optional. Egress settings for direct VPC. If not provided, it defaults to VPC_EGRESS_PRIVATE_RANGES_ONLY.", + "enum": [ + "DIRECT_VPC_EGRESS_UNSPECIFIED", + "VPC_EGRESS_PRIVATE_RANGES_ONLY", + "VPC_EGRESS_ALL_TRAFFIC" + ], + "enumDescriptions": [ + "Unspecified.", + "Sends only traffic to internal addresses through the VPC network.", + "Sends all outbound traffic through the VPC network." + ], + "type": "string" + }, + "directVpcNetworkInterface": { + "description": "Optional. The Direct VPC network interface for the Cloud Function. Currently only a single Direct VPC is supported.", + "items": { + "$ref": "DirectVpcNetworkInterface" + }, + "type": "array" + }, "environmentVariables": { "additionalProperties": { "type": "string" diff --git a/discovery/cloudidentity-v1.json b/discovery/cloudidentity-v1.json index e96a0e309c..1e1cdd2199 100644 --- a/discovery/cloudidentity-v1.json +++ b/discovery/cloudidentity-v1.json @@ -2179,7 +2179,7 @@ "policies": { "methods": { "get": { - "description": "Get a Policy", + "description": "Get a policy.", "flatPath": "v1/policies/{policiesId}", "httpMethod": "GET", "id": "cloudidentity.policies.get", @@ -2205,7 +2205,7 @@ ] }, "list": { - "description": "List Policies", + "description": "List policies.", "flatPath": "v1/policies", "httpMethod": "GET", "id": "cloudidentity.policies.list", @@ -2240,7 +2240,7 @@ } } }, - "revision": "20250923", + "revision": "20251021", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { "AddIdpCredentialOperationMetadata": { diff --git a/discovery/cloudidentity-v1beta1.json b/discovery/cloudidentity-v1beta1.json index f5573db787..d2f4a03f8a 100644 --- a/discovery/cloudidentity-v1beta1.json +++ b/discovery/cloudidentity-v1beta1.json @@ -2216,8 +2216,51 @@ }, "policies": { "methods": { + "create": { + "description": "Create a policy.", + "flatPath": "v1beta1/policies", + "httpMethod": "POST", + "id": "cloudidentity.policies.create", + "parameterOrder": [], + "parameters": {}, + "path": "v1beta1/policies", + "request": { + "$ref": "Policy" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-identity.policies" + ] + }, + "delete": { + "description": "Delete a policy.", + "flatPath": "v1beta1/policies/{policiesId}", + "httpMethod": "DELETE", + "id": "cloudidentity.policies.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the policy to retrieve. Format: \"policies/{policy}\".", + "location": "path", + "pattern": "^policies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-identity.policies" + ] + }, "get": { - "description": "Get a Policy", + "description": "Get a policy.", "flatPath": "v1beta1/policies/{policiesId}", "httpMethod": "GET", "id": "cloudidentity.policies.get", @@ -2243,7 +2286,7 @@ ] }, "list": { - "description": "List Policies", + "description": "List policies.", "flatPath": "v1beta1/policies", "httpMethod": "GET", "id": "cloudidentity.policies.list", @@ -2274,11 +2317,39 @@ "https://www.googleapis.com/auth/cloud-identity.policies", "https://www.googleapis.com/auth/cloud-identity.policies.readonly" ] + }, + "patch": { + "description": "Update a policy.", + "flatPath": "v1beta1/policies/{policiesId}", + "httpMethod": "PATCH", + "id": "cloudidentity.policies.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Identifier. The [resource name](https://cloud.google.com/apis/design/resource_names) of the Policy. Format: policies/{policy}.", + "location": "path", + "pattern": "^policies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "Policy" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-identity.policies" + ] } } } }, - "revision": "20250916", + "revision": "20251027", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { "AddIdpCredentialOperationMetadata": { diff --git a/discovery/cloudkms-v1.json b/discovery/cloudkms-v1.json index 0bad1eecf8..bb842b2e6d 100644 --- a/discovery/cloudkms-v1.json +++ b/discovery/cloudkms-v1.json @@ -2496,7 +2496,7 @@ } } }, - "revision": "20250926", + "revision": "20251016", "rootUrl": "https://cloudkms.googleapis.com/", "schemas": { "AsymmetricDecryptRequest": { @@ -2965,7 +2965,9 @@ "ML_KEM_768", "ML_KEM_1024", "KEM_XWING", + "PQ_SIGN_ML_DSA_44", "PQ_SIGN_ML_DSA_65", + "PQ_SIGN_ML_DSA_87", "PQ_SIGN_SLH_DSA_SHA2_128S", "PQ_SIGN_HASH_SLH_DSA_SHA2_128S_SHA256" ], @@ -3009,7 +3011,9 @@ "ML-KEM-768 (FIPS 203)", "ML-KEM-1024 (FIPS 203)", "X-Wing hybrid KEM combining ML-KEM-768 with X25519 following datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem/.", + "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 1. Randomized version.", "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 3. Randomized version.", + "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 5. Randomized version.", "The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized version.", "The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized pre-hash version supporting SHA256 digests." ], @@ -3183,7 +3187,9 @@ "ML_KEM_768", "ML_KEM_1024", "KEM_XWING", + "PQ_SIGN_ML_DSA_44", "PQ_SIGN_ML_DSA_65", + "PQ_SIGN_ML_DSA_87", "PQ_SIGN_SLH_DSA_SHA2_128S", "PQ_SIGN_HASH_SLH_DSA_SHA2_128S_SHA256" ], @@ -3227,7 +3233,9 @@ "ML-KEM-768 (FIPS 203)", "ML-KEM-1024 (FIPS 203)", "X-Wing hybrid KEM combining ML-KEM-768 with X25519 following datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem/.", + "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 1. Randomized version.", "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 3. Randomized version.", + "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 5. Randomized version.", "The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized version.", "The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized pre-hash version supporting SHA256 digests." ], @@ -3676,7 +3684,9 @@ "ML_KEM_768", "ML_KEM_1024", "KEM_XWING", + "PQ_SIGN_ML_DSA_44", "PQ_SIGN_ML_DSA_65", + "PQ_SIGN_ML_DSA_87", "PQ_SIGN_SLH_DSA_SHA2_128S", "PQ_SIGN_HASH_SLH_DSA_SHA2_128S_SHA256" ], @@ -3720,7 +3730,9 @@ "ML-KEM-768 (FIPS 203)", "ML-KEM-1024 (FIPS 203)", "X-Wing hybrid KEM combining ML-KEM-768 with X25519 following datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem/.", + "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 1. Randomized version.", "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 3. Randomized version.", + "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 5. Randomized version.", "The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized version.", "The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized pre-hash version supporting SHA256 digests." ], @@ -4437,7 +4449,9 @@ "ML_KEM_768", "ML_KEM_1024", "KEM_XWING", + "PQ_SIGN_ML_DSA_44", "PQ_SIGN_ML_DSA_65", + "PQ_SIGN_ML_DSA_87", "PQ_SIGN_SLH_DSA_SHA2_128S", "PQ_SIGN_HASH_SLH_DSA_SHA2_128S_SHA256" ], @@ -4481,7 +4495,9 @@ "ML-KEM-768 (FIPS 203)", "ML-KEM-1024 (FIPS 203)", "X-Wing hybrid KEM combining ML-KEM-768 with X25519 following datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem/.", + "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 1. Randomized version.", "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 3. Randomized version.", + "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 5. Randomized version.", "The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized version.", "The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized pre-hash version supporting SHA256 digests." ], diff --git a/discovery/cloudlocationfinder-v1.json b/discovery/cloudlocationfinder-v1.json index 938fb22aed..fd203d0a1f 100644 --- a/discovery/cloudlocationfinder-v1.json +++ b/discovery/cloudlocationfinder-v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -304,7 +304,7 @@ } } }, - "revision": "20250905", + "revision": "20251022", "rootUrl": "https://cloudlocationfinder.googleapis.com/", "schemas": { "CloudLocation": { diff --git a/discovery/cloudlocationfinder-v1alpha.json b/discovery/cloudlocationfinder-v1alpha.json index a7f98614cf..42ce91be56 100644 --- a/discovery/cloudlocationfinder-v1alpha.json +++ b/discovery/cloudlocationfinder-v1alpha.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -304,7 +304,7 @@ } } }, - "revision": "20250905", + "revision": "20251022", "rootUrl": "https://cloudlocationfinder.googleapis.com/", "schemas": { "CloudLocation": { diff --git a/discovery/cloudscheduler-v1.json b/discovery/cloudscheduler-v1.json index 6d2bfb7c10..bb0a79a8a7 100644 --- a/discovery/cloudscheduler-v1.json +++ b/discovery/cloudscheduler-v1.json @@ -134,6 +134,31 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "getCmekConfig": { + "description": "Gets the Scheduler config in the project/region.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cmekConfig", + "httpMethod": "GET", + "id": "cloudscheduler.projects.locations.getCmekConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The config name. For example: projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/cmekConfig$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "CmekConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Lists information about the supported locations for this service.", "flatPath": "v1/projects/{projectsId}/locations", @@ -144,7 +169,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -180,6 +205,40 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "updateCmekConfig": { + "description": "Initializes or Updates the a scheduler config.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cmekConfig", + "httpMethod": "PATCH", + "id": "cloudscheduler.projects.locations.updateCmekConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/cmekConfig$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. List of fields to be updated in this request.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "CmekConfig" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -309,7 +368,7 @@ ], "parameters": { "name": { - "description": "Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.", + "description": "Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling [locations.list](/scheduler/docs/reference/rest/v1/projects.locations/list). For more information, see [Cloud Scheduler locations](/scheduler/docs/locations). * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$", "required": true, @@ -552,7 +611,7 @@ } } }, - "revision": "20250925", + "revision": "20251022", "rootUrl": "https://cloudscheduler.googleapis.com/", "schemas": { "AppEngineHttpTarget": { @@ -635,6 +694,21 @@ "properties": {}, "type": "object" }, + "CmekConfig": { + "description": "Describes the project/location configuration of Cloud Scheduler Resources.", + "id": "CmekConfig", + "properties": { + "kmsKeyName": { + "description": "Optional. Resource name of the Cloud KMS key, of the form `projects/PROJECT_ID/locations/LOCATION_ID/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID`, that will be used to encrypt Jobs in the region. Setting this as blank will turn off CMEK encryption.", + "type": "string" + }, + "name": { + "description": "Identifier. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig`", + "type": "string" + } + }, + "type": "object" + }, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "Empty", @@ -724,7 +798,7 @@ "type": "string" }, "name": { - "description": "Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.", + "description": "Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling [locations.list](/scheduler/docs/reference/rest/v1/projects.locations/list). For more information, see [Cloud Scheduler locations](/scheduler/docs/locations). * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.", "type": "string" }, "pubsubTarget": { @@ -741,7 +815,7 @@ "type": "boolean" }, "schedule": { - "description": "Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.", + "description": "Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.", "type": "string" }, "scheduleTime": { @@ -1059,7 +1133,7 @@ "type": "object" }, "RetryConfig": { - "description": "Settings that determine the retry behavior. For more information, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig.", + "description": "Settings that determine the retry behavior. For more information, see [Retry jobs](/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig.", "id": "RetryConfig", "properties": { "maxBackoffDuration": { @@ -1068,7 +1142,7 @@ "type": "string" }, "maxDoublings": { - "description": "The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.", + "description": "The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.", "format": "int32", "type": "integer" }, diff --git a/discovery/cloudscheduler-v1beta1.json b/discovery/cloudscheduler-v1beta1.json index 3d6dacb4f2..e5f126d632 100644 --- a/discovery/cloudscheduler-v1beta1.json +++ b/discovery/cloudscheduler-v1beta1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -324,7 +324,7 @@ ], "parameters": { "name": { - "description": "Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.", + "description": "Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling [locations.list](/scheduler/docs/reference/rest/v1beta1/projects.locations/list). For more information, see [Cloud Scheduler locations](/scheduler/docs/locations). * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$", "required": true, @@ -433,13 +433,141 @@ ] } } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "cloudscheduler.projects.locations.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "request": { + "$ref": "CancelOperationRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "cloudscheduler.projects.locations.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "cloudscheduler.projects.locations.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations", + "httpMethod": "GET", + "id": "cloudscheduler.projects.locations.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "ListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } } } } } }, - "revision": "20250917", + "revision": "20251022", "rootUrl": "https://cloudscheduler.googleapis.com/", "schemas": { "AppEngineHttpTarget": { @@ -516,6 +644,12 @@ }, "type": "object" }, + "CancelOperationRequest": { + "description": "The request message for Operations.CancelOperation.", + "id": "CancelOperationRequest", + "properties": {}, + "type": "object" + }, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "Empty", @@ -609,7 +743,7 @@ "type": "boolean" }, "name": { - "description": "Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.", + "description": "Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling [locations.list](/scheduler/docs/reference/rest/v1beta1/projects.locations/list). For more information, see [Cloud Scheduler locations](/scheduler/docs/locations). * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.", "type": "string" }, "pubsubTarget": { @@ -626,7 +760,7 @@ "type": "boolean" }, "schedule": { - "description": "Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.", + "description": "Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.", "type": "string" }, "scheduleTime": { @@ -708,6 +842,31 @@ }, "type": "object" }, + "ListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "id": "ListOperationsResponse", + "properties": { + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + }, + "operations": { + "description": "A list of operations that matches the specified filter in the request.", + "items": { + "$ref": "Operation" + }, + "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "Location": { "description": "A resource that represents a Google Cloud location.", "id": "Location", @@ -772,6 +931,41 @@ }, "type": "object" }, + "Operation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "Operation", + "properties": { + "done": { + "description": "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.", + "type": "boolean" + }, + "error": { + "$ref": "Status", + "description": "The error result of the operation in case of failure or cancellation." + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "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.", + "type": "object" + }, + "name": { + "description": "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}`.", + "type": "string" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "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`.", + "type": "object" + } + }, + "type": "object" + }, "OperationMetadata": { "description": "Represents the metadata of the long-running operation.", "id": "OperationMetadata", @@ -884,7 +1078,7 @@ "type": "object" }, "RetryConfig": { - "description": "Settings that determine the retry behavior. For more information, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig.", + "description": "Settings that determine the retry behavior. For more information, see [Retry jobs](/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig.", "id": "RetryConfig", "properties": { "maxBackoffDuration": { @@ -893,7 +1087,7 @@ "type": "string" }, "maxDoublings": { - "description": "The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.", + "description": "The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.", "format": "int32", "type": "integer" }, diff --git a/discovery/cloudtasks-v2.json b/discovery/cloudtasks-v2.json index 93d1ea8f73..26ce9c83ec 100644 --- a/discovery/cloudtasks-v2.json +++ b/discovery/cloudtasks-v2.json @@ -169,7 +169,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -785,7 +785,7 @@ } } }, - "revision": "20250914", + "revision": "20251021", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AppEngineHttpRequest": { diff --git a/discovery/cloudtasks-v2beta2.json b/discovery/cloudtasks-v2beta2.json index 1527172a87..0a8680d289 100644 --- a/discovery/cloudtasks-v2beta2.json +++ b/discovery/cloudtasks-v2beta2.json @@ -201,7 +201,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -941,7 +941,7 @@ } } }, - "revision": "20250914", + "revision": "20251021", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AcknowledgeTaskRequest": { diff --git a/discovery/cloudtasks-v2beta3.json b/discovery/cloudtasks-v2beta3.json index f08d537fa3..e5e17a4e60 100644 --- a/discovery/cloudtasks-v2beta3.json +++ b/discovery/cloudtasks-v2beta3.json @@ -169,7 +169,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -797,7 +797,7 @@ } } }, - "revision": "20250914", + "revision": "20251021", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AppEngineHttpQueue": { diff --git a/discovery/compute-alpha.json b/discovery/compute-alpha.json index fa5fe83b58..f5fb64883b 100644 --- a/discovery/compute-alpha.json +++ b/discovery/compute-alpha.json @@ -126,7 +126,7 @@ "acceleratorTypes": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of accelerator types.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", + "description": "Retrieves an aggregated list of accelerator types.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/acceleratorTypes", "httpMethod": "GET", "id": "compute.acceleratorTypes.aggregatedList", @@ -302,7 +302,7 @@ "addresses": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of addresses.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", + "description": "Retrieves an aggregated list of addresses.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/addresses", "httpMethod": "GET", "id": "compute.addresses.aggregatedList", @@ -791,7 +791,7 @@ "autoscalers": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of autoscalers.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", + "description": "Retrieves an aggregated list of autoscalers.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/autoscalers", "httpMethod": "GET", "id": "compute.autoscalers.aggregatedList", @@ -1854,7 +1854,7 @@ ] }, "aggregatedList": { - "description": "Retrieves the list of all BackendService resources, regional and global,\navailable to the specified project.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", + "description": "Retrieves the list of all BackendService resources, regional and global,\navailable to the specified project.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/backendServices", "httpMethod": "GET", "id": "compute.backendServices.aggregatedList", @@ -2853,7 +2853,7 @@ "diskTypes": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of disk types.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", + "description": "Retrieves an aggregated list of disk types.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/diskTypes", "httpMethod": "GET", "id": "compute.diskTypes.aggregatedList", @@ -3079,7 +3079,7 @@ ] }, "aggregatedList": { - "description": "Retrieves an aggregated list of persistent disks.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", + "description": "Retrieves an aggregated list of persistent disks.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/disks", "httpMethod": "GET", "id": "compute.disks.aggregatedList", @@ -5439,7 +5439,7 @@ "forwardingRules": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of forwarding rules.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", + "description": "Retrieves an aggregated list of forwarding rules.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/forwardingRules", "httpMethod": "GET", "id": "compute.forwardingRules.aggregatedList", @@ -5900,7 +5900,7 @@ "futureReservations": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of future reservations.\n\nTo prevent failure, recommendation is that you set the\n`returnPartialSuccess` parameter to `true`.", + "description": "Retrieves an aggregated list of future reservations.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/futureReservations", "httpMethod": "GET", "id": "compute.futureReservations.aggregatedList", @@ -7924,8 +7924,8 @@ }, "delete": { "description": "Purge scoped resources (zonal policies) from a global VM extension\npolicy, and then delete the global VM extension policy. Purge of the scoped\nresources is a pre-condition of the global VM extension policy deletion.\nThe deletion of the global VM extension policy happens after the purge\nrollout is done, so it's not a part of the LRO. It's an automatic process\nthat triggers in the backend.", - "flatPath": "projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}", - "httpMethod": "PATCH", + "flatPath": "projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}/delete", + "httpMethod": "POST", "id": "compute.globalVmExtensionPolicies.delete", "parameterOrder": [ "project", @@ -7949,39 +7949,12 @@ "description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" - }, - "rolloutInput.conflictBehavior": { - "description": "Optional. [Optional] Specifies the behavior of the Rollout if a conflict is\ndetected in a project during a Rollout. It can be one of the following\nvalues:\n1) empty : don't overwrite the local value if conflict happens. This is\nthe default behavior.\n2) \"overwrite\" : Overwrite the local value with the rollout value.\nThe concept of \"conflict\" applies to:\n1) Insert action. If the zonal policy already exists when Insert\nhappens, it's a conflict.\n2) Update action. If the zonal policy was updated out of band by a\nzonal API, it's a conflict.", - "location": "query", - "type": "string" - }, - "rolloutInput.name": { - "description": "Optional. The name of the rollout plan.\nEx.\nprojects//locations/global/rolloutPlans/.", - "location": "query", - "type": "string" - }, - "rolloutInput.predefinedRolloutPlan": { - "description": "Optional. Predefined rollout plan.", - "enum": [ - "FAST_ROLLOUT", - "ROLLOUT_PLAN_UNSPECIFIED", - "SLOW_ROLLOUT" - ], - "enumDescriptions": [ - "", - "", - "" - ], - "location": "query", - "type": "string" - }, - "rolloutInput.retryUuid": { - "description": "Optional. The UUID of the retry action. Only set it if this is a retry\nfor an existing resource. This is for the user re-populate the resource\nwithout changes. An error will be returned if the retry_uuid is set but\nthe resource get modified.", - "location": "query", - "type": "string" } }, - "path": "projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}", + "path": "projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}/delete", + "request": { + "$ref": "GlobalVmExtensionPolicyRolloutOperationRolloutInput" + }, "response": { "$ref": "Operation" }, @@ -8159,6 +8132,72 @@ }, "haControllers": { "methods": { + "aggregatedList": { + "description": "Retrieves an aggregated list of all of the HaControllers in the specified\nproject across all regions.", + "flatPath": "projects/{project}/aggregated/haControllers", + "httpMethod": "GET", + "id": "compute.haControllers.aggregatedList", + "parameterOrder": [ + "project" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.", + "location": "query", + "type": "string" + }, + "includeAllScopes": { + "description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.", + "location": "query", + "type": "boolean" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", + "location": "query", + "type": "boolean" + }, + "serviceProjectNumber": { + "description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/aggregated/haControllers", + "response": { + "$ref": "HaControllersAggregatedList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, "delete": { "description": "Deletes an HaController in the specified project.", "flatPath": "projects/{project}/regions/{region}/haControllers/{haController}", @@ -20634,7 +20673,7 @@ ] }, "aggregatedList": { - "description": "Retrieves an aggregated list of network firewall policies, listing network\nfirewall policies from all applicable scopes (global and regional) and\ngrouping the results per scope.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", + "description": "Retrieves an aggregated list of network firewall policies, listing network\nfirewall policies from all applicable scopes (global and regional) and\ngrouping the results per scope.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/firewallPolicies", "httpMethod": "GET", "id": "compute.networkFirewallPolicies.aggregatedList", @@ -25071,7 +25110,7 @@ }, "moveDisk": { "deprecated": true, - "description": "Starting September 29, 2025, you can't use the moveDisk API on new\nprojects. To move a disk to a different region or zone, follow the steps in\n[Change the location of a\ndisk](https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd).\n\nProjects that already use the moveDisk API can continue usage until\nSeptember 29, 2026.\n\nStarting November 1, 2025, API responses will include a warning message in\nthe response body about the upcoming deprecation. You can skip the message\nto continue using the service without interruption.", + "description": "Moves a persistent disk from one zone to another.\n*Note*: The moveDisk API will be deprecated on September 29, 2026.\n\nStarting September 29, 2025, you can't use the moveDisk API on new\nprojects. To move a disk to a different region or zone, follow the steps in\n[Change the location of a\ndisk](https://cloud.google.com/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd).\n\nProjects that already use the moveDisk API can continue usage until\nSeptember 29, 2026.\n\nStarting November 1, 2025, API responses will include a warning message in\nthe response body about the upcoming deprecation. You can skip the message\nto continue using the service without interruption.", "flatPath": "projects/{project}/moveDisk", "httpMethod": "POST", "id": "compute.projects.moveDisk", @@ -27793,7 +27832,7 @@ "regionCommitments": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of commitments by region.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", + "description": "Retrieves an aggregated list of commitments by region.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/commitments", "httpMethod": "GET", "id": "compute.regionCommitments.aggregatedList", @@ -28262,7 +28301,7 @@ "regionCompositeHealthChecks": { "methods": { "aggregatedList": { - "description": "Retrieves the list of all CompositeHealthCheck resources (all\nregional) available to the specified project.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", + "description": "Retrieves the list of all CompositeHealthCheck resources (all\nregional) available to the specified project.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/compositeHealthChecks", "httpMethod": "GET", "id": "compute.regionCompositeHealthChecks.aggregatedList", @@ -29797,7 +29836,7 @@ "regionHealthAggregationPolicies": { "methods": { "aggregatedList": { - "description": "Retrieves the list of all HealthAggregationPolicy resources,\nregional and global, available to the specified project.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", + "description": "Retrieves the list of all HealthAggregationPolicy resources,\nregional and global, available to the specified project.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/healthAggregationPolicies", "httpMethod": "GET", "id": "compute.regionHealthAggregationPolicies.aggregatedList", @@ -30157,7 +30196,7 @@ "regionHealthCheckServices": { "methods": { "aggregatedList": { - "description": "Retrieves the list of all HealthCheckService resources,\nregional and global, available to the specified project.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", + "description": "Retrieves the list of all HealthCheckService resources,\nregional and global, available to the specified project.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/healthCheckServices", "httpMethod": "GET", "id": "compute.regionHealthCheckServices.aggregatedList", @@ -40603,7 +40642,7 @@ "reservations": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of reservations.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", + "description": "Retrieves an aggregated list of reservations.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/reservations", "httpMethod": "GET", "id": "compute.reservations.aggregatedList", @@ -41630,13 +41669,121 @@ } } }, - "routers": { + "rolloutPlans": { "methods": { - "aggregatedList": { - "description": "Retrieves an aggregated list of routers.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", - "flatPath": "projects/{project}/aggregated/routers", + "delete": { + "description": "Deletes a RolloutPlan.", + "flatPath": "projects/{project}/global/rolloutPlans/{rolloutPlan}", + "httpMethod": "DELETE", + "id": "compute.rolloutPlans.delete", + "parameterOrder": [ + "project", + "rolloutPlan" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "rolloutPlan": { + "description": "Name of the RolloutPlan resource to delete.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/global/rolloutPlans/{rolloutPlan}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "get": { + "description": "Gets details of a single project-scoped RolloutPlan.", + "flatPath": "projects/{project}/global/rolloutPlans/{rolloutPlan}", "httpMethod": "GET", - "id": "compute.routers.aggregatedList", + "id": "compute.rolloutPlans.get", + "parameterOrder": [ + "project", + "rolloutPlan" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "rolloutPlan": { + "description": "Name of the persistent rollout plan to return.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/global/rolloutPlans/{rolloutPlan}", + "response": { + "$ref": "RolloutPlan" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "insert": { + "description": "Creates a new RolloutPlan in a given project and location.", + "flatPath": "projects/{project}/global/rolloutPlans", + "httpMethod": "POST", + "id": "compute.rolloutPlans.insert", + "parameterOrder": [ + "project" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/global/rolloutPlans", + "request": { + "$ref": "RolloutPlan" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "list": { + "description": "Lists RolloutPlans in a given project and location.", + "flatPath": "projects/{project}/global/rolloutPlans", + "httpMethod": "GET", + "id": "compute.rolloutPlans.list", "parameterOrder": [ "project" ], @@ -41646,8 +41793,244 @@ "location": "query", "type": "string" }, - "includeAllScopes": { - "description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.", + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", + "location": "query", + "type": "boolean" + } + }, + "path": "projects/{project}/global/rolloutPlans", + "response": { + "$ref": "RolloutPlansListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + } + } + }, + "rollouts": { + "methods": { + "cancel": { + "description": "Cancels a Rollout.", + "flatPath": "projects/{project}/global/rollouts/{rollout}", + "httpMethod": "PATCH", + "id": "compute.rollouts.cancel", + "parameterOrder": [ + "project", + "rollout" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "rollback": { + "description": "Optional. If true, then the ongoing rollout must be rolled back. Else, just cancel\nthe rollout without taking any further actions. Note that products must\nsupport at least one of these options, however, it does not need to support\nboth.", + "location": "query", + "type": "boolean" + }, + "rollout": { + "description": "Name of the Rollout resource to cancel.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/global/rollouts/{rollout}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "delete": { + "description": "Deletes a Rollout.", + "flatPath": "projects/{project}/global/rollouts/{rollout}", + "httpMethod": "DELETE", + "id": "compute.rollouts.delete", + "parameterOrder": [ + "project", + "rollout" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "rollout": { + "description": "Name of the Rollout resource to delete.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/global/rollouts/{rollout}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "get": { + "description": "Gets details of a single project-scoped Rollout.", + "flatPath": "projects/{project}/global/rollouts/{rollout}", + "httpMethod": "GET", + "id": "compute.rollouts.get", + "parameterOrder": [ + "project", + "rollout" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "rollout": { + "description": "Name of the persistent rollout to return.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/global/rollouts/{rollout}", + "response": { + "$ref": "Rollout" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "list": { + "description": "Lists Rollouts in a given project and location.", + "flatPath": "projects/{project}/global/rollouts", + "httpMethod": "GET", + "id": "compute.rollouts.list", + "parameterOrder": [ + "project" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", + "location": "query", + "type": "boolean" + } + }, + "path": "projects/{project}/global/rollouts", + "response": { + "$ref": "RolloutsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + } + } + }, + "routers": { + "methods": { + "aggregatedList": { + "description": "Retrieves an aggregated list of routers.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", + "flatPath": "projects/{project}/aggregated/routers", + "httpMethod": "GET", + "id": "compute.routers.aggregatedList", + "parameterOrder": [ + "project" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.", + "location": "query", + "type": "string" + }, + "includeAllScopes": { + "description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.", "location": "query", "type": "boolean" }, @@ -46402,6 +46785,20 @@ "format": "int64", "location": "query", "type": "string" + }, + "views": { + "description": "Defines the extra views returned back in the subnetwork resource.\nSupported values:\n \n - WITH_UTILIZATION: Utilization data is included in the\n response.", + "enum": [ + "DEFAULT", + "WITH_UTILIZATION" + ], + "enumDescriptions": [ + "", + "Utilization data is included in the response." + ], + "location": "query", + "repeated": true, + "type": "string" } }, "path": "projects/{project}/aggregated/subnetworks", @@ -52783,7 +53180,7 @@ } } }, - "revision": "20250930", + "revision": "20251019", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -56234,7 +56631,7 @@ "id": "BackendBucketCdnPolicyNegativeCachingPolicy", "properties": { "code": { - "description": "The HTTP status code to define a TTL against. Only HTTP status codes\n300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be\nspecified as values, and you cannot specify a status code more than\nonce.", + "description": "The HTTP status code to define a TTL against. Only HTTP status codes\n300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be\nspecified as values, and you cannot specify a status code more than\nonce.", "format": "int32", "type": "integer" }, @@ -56730,7 +57127,7 @@ "type": "number" }, "name": { - "description": "Name of a custom utilization signal. The name must be 1-64 characters\nlong and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, period, underscore, lowercase letter, or\ndigit, except the last character, which cannot be a dash, period, or\nunderscore. For usage guidelines, see Custom Metrics balancing mode. This\nfield can only be used for a global or regional backend service with the\nloadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.", + "description": "Name of a custom utilization signal. The name must be 1-64 characters\nlong and match the regular expression\n`[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, period, underscore, lowercase letter, or\ndigit, except the last character, which cannot be a dash, period, or\nunderscore. For usage guidelines, see Custom Metrics balancing mode. This\nfield can only be used for a global or regional backend service with the\nloadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.", "type": "string" } }, @@ -57384,7 +57781,7 @@ "id": "BackendServiceCdnPolicyNegativeCachingPolicy", "properties": { "code": { - "description": "The HTTP status code to define a TTL against. Only HTTP status codes\n300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be\nspecified as values, and you cannot specify a status code more than\nonce.", + "description": "The HTTP status code to define a TTL against. Only HTTP status codes\n300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be\nspecified as values, and you cannot specify a status code more than\nonce.", "format": "int32", "type": "integer" }, @@ -57449,7 +57846,7 @@ "type": "boolean" }, "name": { - "description": "Name of a custom utilization signal. The name must be 1-64 characters\nlong and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, period, underscore, lowercase letter, or\ndigit, except the last character, which cannot be a dash, period, or\nunderscore. For usage guidelines, see Custom Metrics balancing mode. This\nfield can only be used for a global or regional backend service with the\nloadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.", + "description": "Name of a custom utilization signal. The name must be 1-64 characters\nlong and match the regular expression\n`[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, period, underscore, lowercase letter, or\ndigit, except the last character, which cannot be a dash, period, or\nunderscore. For usage guidelines, see Custom Metrics balancing mode. This\nfield can only be used for a global or regional backend service with the\nloadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.", "type": "string" } }, @@ -58127,7 +58524,7 @@ "type": "string" }, "identity": { - "description": "Assigns the Managed Identity for the RegionBackendService Workload.\n\n\nUse this property to configure the load balancer back-end to use\ncertificates and roots of trust provisioned by the Managed Workload\nIdentity system. \n\n The `managedIdentity` property is the\nfully-specified SPIFFE ID to use in the SVID presented by the Load\nBalancer Workload. \n\n The SPIFFE ID must be a resource starting with the\n\"spiffe\" scheme identifier, followed by the \"trustDomain\" property value,\nfollowed by the path to the Managed Workload Identity. \n\n Supported\nSPIFFE ID format: \n \n - spiffe:///ns//sa/\n\n\nThe Trust Domain within the Managed Identity must refer to a valid\nWorkload Identity Pool. The TrustConfig and CertificateIssuanceConfig\nwill be inherited from the Workload Identity Pool. \n\n Restrictions: \n \n - If you set the `managedIdentity` property, you cannot manually set\n the following fields: \n - tlsSettings.sni\n - tlsSettings.subjectAltNames\n - tlsSettings.authenticationConfig\n \n\nWhen defining a `managedIdentity` for a RegionBackendServices, the\ncorresponding Workload Identity Pool must have a ca_pool\nconfigured in the same region. \n\n The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.", + "description": "Assigns the Managed Identity for the BackendService Workload.\n\n\nUse this property to configure the load balancer back-end to use\ncertificates and roots of trust provisioned by the Managed Workload\nIdentity system. \n\n The `identity` property is the\nfully-specified SPIFFE ID to use in the SVID presented by the Load\nBalancer Workload. \n\n The SPIFFE ID must be a resource starting with the\n`trustDomain` property value, followed by the path to the Managed\nWorkload Identity. \n\n Supported SPIFFE ID format: \n \n - ///ns//sa/\n\n\nThe Trust Domain within the Managed Identity must refer to a valid\nWorkload Identity Pool. The TrustConfig and CertificateIssuanceConfig\nwill be inherited from the Workload Identity Pool. \n\n Restrictions: \n \n - If you set the `identity` property, you cannot manually set\n the following fields: \n - tlsSettings.sni\n - tlsSettings.subjectAltNames\n - tlsSettings.authenticationConfig\n \n\nWhen defining a `identity` for a RegionBackendServices, the\ncorresponding Workload Identity Pool must have a ca_pool\nconfigured in the same region. \n\n The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.", "type": "string" }, "sni": { @@ -59160,7 +59557,7 @@ "type": "number" }, "uptimeScore": { - "description": "The uptime score indicates the availability of your Spot VMs. For more\ninformation about the preemption process, see Preemption\nof Spot VMs.\nThe score range is 0.0 through 1.0. Higher is better.", + "description": "The uptime score indicates the likelihood that your Spot VMs will\ncontinue to run without preemption within the next few hours. For more\ninformation about the preemption process, see Preemption\nof Spot VMs.\nThe score range is 0.0 through 1.0. Higher is better.", "format": "double", "type": "number" } @@ -59377,12 +59774,14 @@ "INVALID", "SIXTY_MONTH", "THIRTY_SIX_MONTH", - "TWELVE_MONTH" + "TWELVE_MONTH", + "TWENTY_FOUR_MONTH" ], "enumDescriptions": [ "", "", "", + "", "" ], "type": "string" @@ -63866,11 +64265,13 @@ "policyType": { "description": "The type of the firewall policy. This field can be eitherVPC_POLICY or RDMA_ROCE_POLICY.\n\nNote: if not specified then VPC_POLICY will be used.", "enum": [ + "RDMA_FALCON_POLICY", "RDMA_ROCE_POLICY", "ULL_POLICY", "VPC_POLICY" ], "enumDescriptions": [ + "", "", "", "" @@ -65434,12 +65835,14 @@ "INVALID", "SIXTY_MONTH", "THIRTY_SIX_MONTH", - "TWELVE_MONTH" + "TWELVE_MONTH", + "TWENTY_FOUR_MONTH" ], "enumDescriptions": [ "", "", "", + "", "" ], "type": "string" @@ -67783,51 +68186,46 @@ }, "type": "object" }, - "HaControllersFailoverRequest": { - "id": "HaControllersFailoverRequest", - "properties": { - "primaryZone": { - "description": "Name of the destination zone for the failover.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string" - } - }, - "type": "object" - }, - "HaControllersList": { - "id": "HaControllersList", + "HaControllersAggregatedList": { + "id": "HaControllersAggregatedList", "properties": { "etag": { "type": "string" }, "id": { - "description": "Unique identifier for the resource; defined by the server.", + "description": "[Output Only] Unique identifier for the resource; defined by the server.", "type": "string" }, "items": { - "description": "A list of HaControllers in the specified project and region.", - "items": { - "$ref": "HaController" + "additionalProperties": { + "$ref": "HaControllersScopedList", + "description": "Name of the scope containing this set of ha controllers." }, - "type": "array" + "description": "A list of HaControllersScopedList resources.", + "type": "object" + }, + "kind": { + "default": "compute#haControllersAggregatedList", + "description": "[Output Only] Type of resource. Alwayscompute#haControllersAggregatedList for lists of\nHaControllers.", + "type": "string" }, "nextPageToken": { - "description": "This token allows you to get the next page of results formaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", + "description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", "type": "string" }, "selfLink": { - "description": "[Output only] Server-defined URL for this resource.", + "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, "unreachables": { - "description": "[Output only] Unreachable resources.", + "description": "[Output Only] Unreachable resources.", "items": { "type": "string" }, "type": "array" }, "warning": { - "description": "Informational warning message.", + "description": "[Output Only] Informational warning message.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", @@ -67953,18 +68351,57 @@ }, "type": "object" }, - "HealthAggregationPoliciesScopedList": { - "id": "HealthAggregationPoliciesScopedList", + "HaControllersFailoverRequest": { + "id": "HaControllersFailoverRequest", "properties": { - "healthAggregationPolicies": { - "description": "A list of HealthAggregationPolicys contained in this scope.", + "failoverToZone": { + "description": "Name of the destination zone for the failover.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, + "primaryZone": { + "deprecated": true, + "description": "Name of the destination zone for the failover.\nDeprecated: use failover_to_zone instead.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + } + }, + "type": "object" + }, + "HaControllersList": { + "id": "HaControllersList", + "properties": { + "etag": { + "type": "string" + }, + "id": { + "description": "Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "A list of HaControllers in the specified project and region.", "items": { - "$ref": "HealthAggregationPolicy" + "$ref": "HaController" + }, + "type": "array" + }, + "nextPageToken": { + "description": "This token allows you to get the next page of results formaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output only] Server-defined URL for this resource.", + "type": "string" + }, + "unreachables": { + "description": "[Output only] Unreachable resources.", + "items": { + "type": "string" }, "type": "array" }, "warning": { - "description": "Informational warning which replaces the list of health aggregation\npolicies when the list is empty.", + "description": "Informational warning message.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", @@ -68090,113 +68527,387 @@ }, "type": "object" }, - "HealthAggregationPolicy": { - "description": "Represents a health aggregation policy.\n\nA health aggregation policy resource defines a policy to aggregate health.\n\nFor more information, see\nHealth checks overview.", - "id": "HealthAggregationPolicy", + "HaControllersScopedList": { + "id": "HaControllersScopedList", "properties": { - "creationTimestamp": { - "description": "[Output Only] Creation timestamp inRFC3339\ntext format.", - "type": "string" - }, - "description": { - "description": "An optional description of this resource. Provide this property when you\ncreate the resource.", - "type": "string" - }, - "fingerprint": { - "description": "Fingerprint of this resource. A hash of the contents stored in this object.\nThis field is used in optimistic locking. This field will be ignored when\ninserting a HealthAggregationPolicy. An up-to-date fingerprint\nmust be provided in order to patch the HealthAggregationPolicy; Otherwise,\nthe request will fail with error 412 conditionNotMet. To see\nthe latest fingerprint, make a get() request to retrieve the\nHealthAggregationPolicy.", - "format": "byte", - "type": "string" - }, - "healthyPercentThreshold": { - "description": "Can only be set if the policyType field isBACKEND_SERVICE_POLICY. Specifies the threshold (as a\npercentage) of healthy endpoints required in order to consider the\naggregated health result HEALTHY. Defaults to 60. Must be in\nrange [0, 100]. Not applicable if the policyType field isDNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional,\nand will be set to the default if unspecified. Note that both this\nthreshold and minHealthyThreshold must be satisfied in order\nfor HEALTHY to be the aggregated result. \"Endpoints\" refers to network\nendpoints within a Network Endpoint Group or instances within an Instance\nGroup.", - "format": "uint32", - "type": "integer" - }, - "id": { - "description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.", - "format": "uint64", - "type": "string" - }, - "kind": { - "default": "compute#healthAggregationPolicy", - "description": "[Output Only] Type of the resource. Alwayscompute#healthAggregationPolicy for health aggregation\npolicies.", - "type": "string" - }, - "minHealthyThreshold": { - "description": "Can only be set if the policyType field isBACKEND_SERVICE_POLICY. Specifies the minimum number of\nhealthy endpoints required in order to consider the aggregated health\nresult HEALTHY. Defaults to 1. Must be positive. Not\napplicable if the policyType field isDNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional,\nand will be set to the default if unspecified. Note that both this\nthreshold and healthyPercentThreshold must be satisfied in\norder for HEALTHY to be the aggregated result. \"Endpoints\" refers to\nnetwork endpoints within a Network Endpoint Group or instances within an\nInstance Group.", - "format": "uint32", - "type": "integer" - }, - "name": { - "description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string" - }, - "policyType": { - "description": "Specifies the type of the healthAggregationPolicy. The only allowed value\nfor global resources is DNS_PUBLIC_IP_POLICY. The only allowed\nvalue for regional resources is BACKEND_SERVICE_POLICY. Must\nbe specified when the healthAggregationPolicy is created, and cannot be\nmutated.", - "enum": [ - "BACKEND_SERVICE_POLICY", - "DNS_PUBLIC_IP_POLICY" - ], - "enumDescriptions": [ - "", - "" - ], - "type": "string" - }, - "region": { - "description": "[Output Only] URL of the region where the health aggregation policy\nresides. This field applies only to the regional resource. You must specify\nthis field as part of the HTTP request URL. It is not settable as a field\nin the request body.", - "type": "string" - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for the resource.", - "type": "string" - }, - "selfLinkWithId": { - "description": "[Output Only] Server-defined URL with id for the resource.", - "type": "string" - } - }, - "type": "object" - }, - "HealthAggregationPolicyAggregatedList": { - "description": "Contains a list of HealthAggregationPoliciesScopedList.", - "id": "HealthAggregationPolicyAggregatedList", - "properties": { - "id": { - "description": "[Output Only] Unique identifier for the resource; defined by the server.", - "type": "string" - }, - "items": { - "additionalProperties": { - "$ref": "HealthAggregationPoliciesScopedList", - "description": "Name of the scope containing this set of HealthAggregationPolicies." - }, - "description": "A list of HealthAggregationPoliciesScopedList resources.", - "type": "object" - }, - "kind": { - "default": "compute#healthAggregationPolicyAggregatedList", - "description": "Type of resource.", - "type": "string" - }, - "nextPageToken": { - "description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", - "type": "string" - }, - "selfLink": { - "description": "[Output Only] Server-defined URL for this resource.", - "type": "string" - }, - "unreachables": { - "description": "[Output Only] Unreachable resources.", + "haControllers": { + "description": "List of HaControllers contained in this scope.", "items": { - "type": "string" + "$ref": "HaController" }, "type": "array" }, "warning": { - "description": "[Output Only] Informational warning message.", + "description": "Informational warning which replaces the list of\nbackend services when the list is empty.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed\noperation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as\ndeprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as\nexperimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden.\nDeprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the\nnetwork.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite\nthe mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "Quota information is not available to client requests (e.g:\nregions.list).", + "The user attempted to use a resource that requires a TOS they have not\naccepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "HealthAggregationPoliciesScopedList": { + "id": "HealthAggregationPoliciesScopedList", + "properties": { + "healthAggregationPolicies": { + "description": "A list of HealthAggregationPolicys contained in this scope.", + "items": { + "$ref": "HealthAggregationPolicy" + }, + "type": "array" + }, + "warning": { + "description": "Informational warning which replaces the list of health aggregation\npolicies when the list is empty.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed\noperation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as\ndeprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as\nexperimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden.\nDeprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the\nnetwork.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite\nthe mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "Quota information is not available to client requests (e.g:\nregions.list).", + "The user attempted to use a resource that requires a TOS they have not\naccepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "HealthAggregationPolicy": { + "description": "Represents a health aggregation policy.\n\nA health aggregation policy resource defines a policy to aggregate health.\n\nFor more information, see\nHealth checks overview.", + "id": "HealthAggregationPolicy", + "properties": { + "creationTimestamp": { + "description": "[Output Only] Creation timestamp inRFC3339\ntext format.", + "type": "string" + }, + "description": { + "description": "An optional description of this resource. Provide this property when you\ncreate the resource.", + "type": "string" + }, + "fingerprint": { + "description": "Fingerprint of this resource. A hash of the contents stored in this object.\nThis field is used in optimistic locking. This field will be ignored when\ninserting a HealthAggregationPolicy. An up-to-date fingerprint\nmust be provided in order to patch the HealthAggregationPolicy; Otherwise,\nthe request will fail with error 412 conditionNotMet. To see\nthe latest fingerprint, make a get() request to retrieve the\nHealthAggregationPolicy.", + "format": "byte", + "type": "string" + }, + "healthyPercentThreshold": { + "description": "Can only be set if the policyType field isBACKEND_SERVICE_POLICY. Specifies the threshold (as a\npercentage) of healthy endpoints required in order to consider the\naggregated health result HEALTHY. Defaults to 60. Must be in\nrange [0, 100]. Not applicable if the policyType field isDNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional,\nand will be set to the default if unspecified. Note that both this\nthreshold and minHealthyThreshold must be satisfied in order\nfor HEALTHY to be the aggregated result. \"Endpoints\" refers to network\nendpoints within a Network Endpoint Group or instances within an Instance\nGroup.", + "format": "uint32", + "type": "integer" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.", + "format": "uint64", + "type": "string" + }, + "kind": { + "default": "compute#healthAggregationPolicy", + "description": "[Output Only] Type of the resource. Alwayscompute#healthAggregationPolicy for health aggregation\npolicies.", + "type": "string" + }, + "minHealthyThreshold": { + "description": "Can only be set if the policyType field isBACKEND_SERVICE_POLICY. Specifies the minimum number of\nhealthy endpoints required in order to consider the aggregated health\nresult HEALTHY. Defaults to 1. Must be positive. Not\napplicable if the policyType field isDNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional,\nand will be set to the default if unspecified. Note that both this\nthreshold and healthyPercentThreshold must be satisfied in\norder for HEALTHY to be the aggregated result. \"Endpoints\" refers to\nnetwork endpoints within a Network Endpoint Group or instances within an\nInstance Group.", + "format": "uint32", + "type": "integer" + }, + "name": { + "description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, + "policyType": { + "description": "Specifies the type of the healthAggregationPolicy. The only allowed value\nfor global resources is DNS_PUBLIC_IP_POLICY. The only allowed\nvalue for regional resources is BACKEND_SERVICE_POLICY. Must\nbe specified when the healthAggregationPolicy is created, and cannot be\nmutated.", + "enum": [ + "BACKEND_SERVICE_POLICY", + "DNS_PUBLIC_IP_POLICY" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "region": { + "description": "[Output Only] URL of the region where the health aggregation policy\nresides. This field applies only to the regional resource. You must specify\nthis field as part of the HTTP request URL. It is not settable as a field\nin the request body.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for the resource.", + "type": "string" + }, + "selfLinkWithId": { + "description": "[Output Only] Server-defined URL with id for the resource.", + "type": "string" + } + }, + "type": "object" + }, + "HealthAggregationPolicyAggregatedList": { + "description": "Contains a list of HealthAggregationPoliciesScopedList.", + "id": "HealthAggregationPolicyAggregatedList", + "properties": { + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "additionalProperties": { + "$ref": "HealthAggregationPoliciesScopedList", + "description": "Name of the scope containing this set of HealthAggregationPolicies." + }, + "description": "A list of HealthAggregationPoliciesScopedList resources.", + "type": "object" + }, + "kind": { + "default": "compute#healthAggregationPolicyAggregatedList", + "description": "Type of resource.", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "unreachables": { + "description": "[Output Only] Unreachable resources.", + "items": { + "type": "string" + }, + "type": "array" + }, + "warning": { + "description": "[Output Only] Informational warning message.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", @@ -71710,9 +72421,11 @@ "type": "string" }, "identity": { + "deprecated": true, "type": "string" }, "identityCertificate": { + "deprecated": true, "type": "boolean" }, "instanceEncryptionKey": { @@ -71964,6 +72677,9 @@ "$ref": "UpcomingMaintenance", "description": "[Output Only] DEPRECATED: Please useresource_status.upcoming_maintenance instead. Specifies\nupcoming maintenance for the instance." }, + "workloadIdentityConfig": { + "$ref": "WorkloadIdentityConfig" + }, "zone": { "description": "[Output Only] URL of the zone where the instance resides.\nYou must specify this field as part of the HTTP request URL. It is\nnot settable as a field in the request body.", "type": "string" @@ -73145,6 +73861,13 @@ "InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection": { "id": "InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection", "properties": { + "disks": { + "description": "List of disks to be attached to the instances created from this\nselection.", + "items": { + "$ref": "AttachedDisk" + }, + "type": "array" + }, "machineTypes": { "description": "Full machine-type names, e.g. \"n1-standard-16\".", "items": { @@ -73152,6 +73875,10 @@ }, "type": "array" }, + "minCpuPlatform": { + "description": "Name of the minimum CPU platform to be used by this instance selection.\ne.g. 'Intel Ice Lake'.", + "type": "string" + }, "rank": { "description": "Preference of this instance selection. Lower number means higher\npreference. MIG will first try to create a VM based on the machine-type\nwith lowest rank and fallback to next rank based on availability.\nMachine types and instance selections with the same rank have the same\npreference.", "format": "int32", @@ -73248,7 +73975,7 @@ "id": "InstanceGroupManagerInstanceLifecyclePolicyOnRepair", "properties": { "allowChangingZone": { - "description": "Specifies whether the MIG can change a VM's zone during a repair.", + "description": "Specifies whether the MIG can change a VM's zone during a repair.\nValid values are:\n \n - NO (default): MIG cannot change a VM's zone during a\n repair.\n - YES: MIG can select a different zone for the VM during\n a repair.", "enum": [ "NO", "YES" @@ -75590,9 +76317,11 @@ "type": "array" }, "identity": { + "deprecated": true, "type": "string" }, "identityCertificate": { + "deprecated": true, "type": "boolean" }, "keyRevocationActionType": { @@ -75733,6 +76462,9 @@ "tags": { "$ref": "Tags", "description": "A list of tags to apply to the instances that are created from these\nproperties. The tags identify valid sources or targets for network\nfirewalls. The setTags method can modify this list of tags. Each tag within\nthe list must comply with RFC1035." + }, + "workloadIdentityConfig": { + "$ref": "WorkloadIdentityConfig" } }, "type": "object" @@ -78193,7 +78925,7 @@ "type": "integer" }, "type": { - "description": "The type of interconnect attachment this is, which can take one of the\nfollowing values:\n \n - DEDICATED: an attachment to a Dedicated Interconnect.\n - PARTNER: an attachment to a Partner Interconnect, created by the\n customer.\n - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by\n the partner.", + "description": "The type of interconnect attachment this is, which can take one of the\nfollowing values:\n \n - DEDICATED: an attachment to a Dedicated Interconnect.\n - PARTNER: an attachment to a Partner Interconnect, created by the\n customer.\n - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by\n the partner.\n\n- L2_DEDICATED: a L2 attachment to a Dedicated Interconnect.", "enum": [ "DEDICATED", "L2_DEDICATED", @@ -78202,7 +78934,7 @@ ], "enumDescriptions": [ "Attachment to a dedicated interconnect.", - "Attachment to a L2 interconnect, created by the customer.", + "Attachment to a dedicated interconnect, forwarding L2 packets.", "Attachment to a partner interconnect, created by the customer.", "Attachment to a partner interconnect, created by the partner." ], @@ -78912,7 +79644,7 @@ ], "enumDescriptions": [ "Attachment to a dedicated interconnect.", - "Attachment to a L2 interconnect, created by the customer.", + "Attachment to a dedicated interconnect, forwarding L2 packets.", "Attachment to a partner interconnect, created by the customer.", "Attachment to a partner interconnect, created by the partner." ], @@ -79852,7 +80584,7 @@ "type": "string" }, "etag": { - "description": "Opaque system-generated token that uniquely identifies the configuration.\nIf provided when patching a configuration in update mode, the provided\ntoken must match the current token or the update is rejected. This provides\na reliable means of doing read-modify-write (optimistic locking) as\ndescribed byAPI 154.", + "description": "Opaque system-generated token that uniquely identifies the configuration.\nIf provided when patching a configuration in update mode, the provided\ntoken must match the current token or the update is rejected. This provides\na reliable means of doing read-modify-write (optimistic locking) as\ndescribed by AIP 154.", "type": "string" }, "id": { @@ -83900,10 +84632,21 @@ "ManagedInstanceInstanceFlexibilityOverride": { "id": "ManagedInstanceInstanceFlexibilityOverride", "properties": { + "disks": { + "description": "List of disks to be attached to the instance.", + "items": { + "$ref": "AttachedDisk" + }, + "type": "array" + }, "machineType": { "description": "The machine type to be used for this instance.", "type": "string" }, + "minCpuPlatform": { + "description": "Name of the minimum CPU platform to be used by this instance.\ne.g. 'Intel Ice Lake'.", + "type": "string" + }, "provisioningModel": { "description": "The provisioning model to be used for this instance.", "enum": [ @@ -88493,6 +89236,18 @@ }, "type": "array" }, + "allowAddressCreation": { + "description": "Specifies whether address creation is allowed.", + "enum": [ + "ADDRESS_CREATION_ALLOWED", + "ADDRESS_CREATION_BLOCKED" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, "allowAliasIpRanges": { "description": "Specifies whether alias IP ranges (and secondary address ranges) are\nallowed.", "enum": [ @@ -88637,6 +89392,30 @@ ], "type": "string" }, + "allowMultiNicInSameSubnetwork": { + "description": "Specifies whether multi-nic in the same subnetwork is allowed.", + "enum": [ + "MULTI_NIC_IN_SAME_SUBNETWORK_ALLOWED", + "MULTI_NIC_IN_SAME_SUBNETWORK_BLOCKED" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "allowMulticast": { + "description": "Specifies whether multicast is allowed.", + "enum": [ + "MULTICAST_ALLOWED", + "MULTICAST_BLOCKED" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, "allowNcc": { "description": "Specifies whether NCC is allowed.", "enum": [ @@ -88733,6 +89512,18 @@ ], "type": "string" }, + "allowSubnetworkCreation": { + "description": "Specifies whether subnetwork creation is allowed.", + "enum": [ + "SUBNETWORK_CREATION_ALLOWED", + "SUBNETWORK_CREATION_BLOCKED" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, "allowVpcFirewallRules": { "description": "Specifies whether VPC firewall rules can be created under the network.", "enum": [ @@ -88772,11 +89563,13 @@ "firewallPolicyTypes": { "items": { "enum": [ + "RDMA_FALCON_POLICY", "RDMA_ROCE_POLICY", "ULL_POLICY", "VPC_POLICY" ], "enumDescriptions": [ + "", "", "", "" @@ -88808,6 +89601,29 @@ }, "type": "array" }, + "multicast": { + "description": "Specifies which type of multicast is supported.", + "enum": [ + "MULTICAST_SDN", + "MULTICAST_ULL" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "predefinedNetworkInternalIpv6Range": { + "description": "Specifies a predefined internal IPv6 range for the network.", + "type": "string" + }, + "predefinedSubnetworkRanges": { + "description": "Predefined subnetwork ranges for the network.", + "items": { + "$ref": "NetworkProfileNetworkFeaturesPredefinedSubnetworkRange" + }, + "type": "array" + }, "subnetPurposes": { "description": "Specifies which subnetwork purposes are supported.", "items": { @@ -88905,6 +89721,20 @@ }, "type": "object" }, + "NetworkProfileNetworkFeaturesPredefinedSubnetworkRange": { + "id": "NetworkProfileNetworkFeaturesPredefinedSubnetworkRange", + "properties": { + "ipv6Range": { + "description": "The IPv6 range of the predefined subnetwork.", + "type": "string" + }, + "namePrefix": { + "description": "The naming prefix of the predefined subnetwork.", + "type": "string" + } + }, + "type": "object" + }, "NetworkProfileProfileType": { "id": "NetworkProfileProfileType", "properties": { @@ -100904,12 +101734,14 @@ "FAULT_BEHAVIOR_UNSPECIFIED", "GPU_ERROR", "PERFORMANCE", + "SILENT_DATA_CORRUPTION", "SWITCH_FAILURE" ], "enumDescriptions": [ "", "The subBlock experienced a GPU error.", "The subBlock experienced performance issues.", + "The subBlock experienced silent data corruption.", "The subBlock experienced a switch failure." ], "type": "string" @@ -101581,6 +102413,18 @@ "description": "A GroupPlacementPolicy specifies resource placement configuration.\nIt specifies the failure bucket separation", "id": "ResourcePolicyGroupPlacementPolicy", "properties": { + "acceleratorTopologyMode": { + "description": "Specifies the connection mode for the accelerator topology. If not\nspecified, the default is AUTO_CONNECT.", + "enum": [ + "AUTO_CONNECT", + "PROVISION_ONLY" + ], + "enumDescriptions": [ + "The interconnected chips are pre-configured at the time of VM creation.", + "The interconnected chips are connected on demand. At the time of VM\ncreation, the chips are not connected." + ], + "type": "string" + }, "availabilityDomainCount": { "description": "The number of availability domains to spread instances across. If two\ninstances are in different availability domain, they are not in the same\nlow latency network.", "format": "int32", @@ -102556,6 +103400,530 @@ }, "type": "object" }, + "Rollout": { + "description": "Represent a Rollout resource.", + "id": "Rollout", + "properties": { + "cancellationTime": { + "description": "Output only. The timestamp at which the Rollout was cancelled.", + "readOnly": true, + "type": "string" + }, + "completionTime": { + "description": "Output only. The timestamp at which the Rollout was completed.", + "readOnly": true, + "type": "string" + }, + "creationTimestamp": { + "description": "[Output Only] Creation timestamp inRFC3339\ntext format.", + "type": "string" + }, + "currentWaveNumber": { + "description": "Output only. The number of the currently running wave.\nEx. 1", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "An optional description of this resource. Provide this property when you\ncreate the resource.", + "type": "string" + }, + "etag": { + "description": "Output only. etag of the Rollout\nEx. abc1234", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.", + "format": "uint64", + "type": "string" + }, + "kind": { + "default": "compute#rollout", + "description": "[Output Only] Type of the resource. Always compute#rollout\nfor rollouts.", + "type": "string" + }, + "name": { + "description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?`\nwhich means the first character must be a lowercase letter, and all\nfollowing characters must be a dash, lowercase letter, or digit, except\nthe last character, which cannot be a dash.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, + "rolloutEntity": { + "$ref": "RolloutRolloutEntity", + "description": "Required. The resource being rolled out." + }, + "rolloutPlan": { + "description": "Required. Rollout Plan used to model the Rollout.\nEx. progressiverollout.googleapis.com/v1/organizations/1/rolloutPlans\nEx. progressiverollout.googleapis.com/v1/folders/1/rolloutPlans", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined fully-qualified URL for this resource.", + "type": "string" + }, + "selfLinkWithId": { + "description": "[Output Only] Server-defined URL for this resource's resource id.", + "type": "string" + }, + "state": { + "description": "Output only. The current state of the Rollout.", + "enum": [ + "CANCELLED", + "CANCELLING", + "CANCEL_FAILED", + "COMPLETED", + "COMPLETE_FAILED", + "COMPLETING", + "FAILED", + "PAUSED", + "PAUSE_FAILED", + "PAUSING", + "PROCESSING", + "READY", + "RESUMING", + "ROLLBACK_WAVE_FAILED", + "ROLLING_BACK", + "STATE_UNSPECIFIED", + "UNINITIALIZED", + "WAVE_FAILED" + ], + "enumDescriptions": [ + "The rollout is in a failure terminal state.", + "The rollout is being cancelled.", + "An attempted cancel operation was unsuccessful.", + "The rollout is in a successful terminal state.", + "An attempted complete operation was unsuccessful.", + "The rollout is being marked as completed.", + "The rollout completed with failures.", + "The rollout is paused.", + "An attempted pause operation was unsuccessful.", + "The rollout is being paused.", + "A wave is being processed by the product.", + "The rollout has been successfully initialized and is ready to start.", + "The rollout is being resumed after being paused.", + "An attempted rollback operation failed to complete successfully.", + "A wave rollback is in progress for this rollout.", + "Undefined default state. Should never be exposed to users.", + "The rollout has been created but is not yet ready to be started.", + "The product failed to process the wave." + ], + "readOnly": true, + "type": "string" + }, + "waveDetails": { + "description": "Output only. Details about each wave of the rollout.", + "items": { + "$ref": "RolloutWaveDetails" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "RolloutPlan": { + "description": "Message describing RolloutPlan object", + "id": "RolloutPlan", + "properties": { + "creationTimestamp": { + "description": "[Output Only] Creation timestamp inRFC3339\ntext format.", + "type": "string" + }, + "description": { + "description": "An optional description of this resource. Provide this property when you\ncreate the resource.", + "type": "string" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.", + "format": "uint64", + "type": "string" + }, + "kind": { + "default": "compute#rolloutPlan", + "description": "[Output Only] Type of the resource. Always compute#rolloutPlan\nfor rolloutPlans.", + "type": "string" + }, + "locationScope": { + "description": "The location scope of the rollout plan. If not specified, the location\nscope is considered as ZONAL.", + "enum": [ + "LOCATION_SCOPE_UNSPECIFIED", + "REGIONAL", + "ZONAL" + ], + "enumDescriptions": [ + "Unspecified value. Considered as ZONAL.", + "Regional scope.", + "Zonal scope." + ], + "type": "string" + }, + "name": { + "annotations": { + "required": [ + "compute.rolloutPlans.insert" + ] + }, + "description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?`\nwhich means the first character must be a lowercase letter, and all\nfollowing characters must be a dash, lowercase letter, or digit, except\nthe last character, which cannot be a dash.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined fully-qualified URL for this resource.", + "type": "string" + }, + "selfLinkWithId": { + "description": "[Output Only] Server-defined URL for this resource's resource id.", + "type": "string" + }, + "waves": { + "description": "Required. The waves included in this rollout plan.", + "items": { + "$ref": "RolloutPlanWave" + }, + "type": "array" + } + }, + "type": "object" + }, + "RolloutPlanWave": { + "description": "A single wave in a rollout plan.", + "id": "RolloutPlanWave", + "properties": { + "displayName": { + "description": "Optional. The display name of this wave of the rollout plan.", + "type": "string" + }, + "number": { + "description": "Output only. The wave number.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "orchestrationOptions": { + "$ref": "RolloutPlanWaveOrchestrationOptions", + "description": "Optional. The orchestration options for this wave." + }, + "selectors": { + "description": "Required. The selectors for this wave. There is a logical AND between each selector\ndefined in a wave, so a resource must satisfy the criteria of *all* the\nspecified selectors to be in scope for the wave.", + "items": { + "$ref": "RolloutPlanWaveSelector" + }, + "type": "array" + }, + "validation": { + "$ref": "RolloutPlanWaveValidation", + "description": "Required. The validation to be performed at the end of this wave." + } + }, + "type": "object" + }, + "RolloutPlanWaveOrchestrationOptions": { + "description": "Options to control the pace of orchestration of a wave. These options are\nrequired only if the resource being rolled out follows the Orchestrated\npattern.", + "id": "RolloutPlanWaveOrchestrationOptions", + "properties": { + "delays": { + "description": "Optional. Delays, if any, to be added between batches of projects. We allow\nmultiple Delays to be specified, letting users set separate delays\nbetween batches of projects corresponding to different locations and\nbatches of projects corresponding to the same location.", + "items": { + "$ref": "RolloutPlanWaveOrchestrationOptionsDelay" + }, + "type": "array" + }, + "maxConcurrentLocations": { + "description": "Optional. Maximum number of locations to be orchestrated in parallel.", + "format": "int64", + "type": "string" + }, + "maxConcurrentResourcesPerLocation": { + "description": "Optional. Maximum number of resources to be orchestrated per location in\nparallel.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "RolloutPlanWaveOrchestrationOptionsDelay": { + "description": "Options to control the delay, if any, between batches of projects.", + "id": "RolloutPlanWaveOrchestrationOptionsDelay", + "properties": { + "delimiter": { + "description": "Optional. Controls whether the delay should only be added between batches of\nprojects corresponding to different locations, or also between\nbatches of projects corresponding to the same location.\n\nMust be set to DELIMITER_UNSPECIFIED if no delay is to be added.", + "enum": [ + "DELIMITER_BATCH", + "DELIMITER_LOCATION", + "DELIMITER_UNSPECIFIED" + ], + "enumDescriptions": [ + "The delay will also be added between batches of projects\ncorresponding to the same location.", + "The delay will only be added between batches of projects\ncorresponding to different locations.", + "No delay will be added between batches of projects. Processing will\ncontinue with the next batch as soon as the previous batch of LROs\nis done." + ], + "type": "string" + }, + "duration": { + "description": "Optional. The duration of the delay, if any, to be added between batches of\nprojects. A zero duration corresponds to no delay.", + "format": "google-duration", + "type": "string" + }, + "type": { + "description": "Optional. Controls whether the specified duration is to be added at the end of\neach batch, or if the total processing time for each batch will be\npadded if needed to meet the specified duration.\n\nMust be set to TYPE_UNSPECIFIED if no delay is to be added.", + "enum": [ + "TYPE_MINIMUM", + "TYPE_OFFSET", + "TYPE_UNSPECIFIED" + ], + "enumDescriptions": [ + "The total processing time for each batch of projects will be padded\nif needed to meet the specified delay duration.", + "The specified delay will directly be added after each batch of\nprojects as specified by the delimiter.", + "No delay will be added between batches of projects. Processing will\ncontinue with the next batch as soon as the previous batch of LROs\nis done." + ], + "type": "string" + } + }, + "type": "object" + }, + "RolloutPlanWaveSelector": { + "description": "A selector which specifies what resource(s) are included in a given wave.", + "id": "RolloutPlanWaveSelector", + "properties": { + "locationSelector": { + "$ref": "RolloutPlanWaveSelectorLocationSelector", + "description": "Optional. Roll out to resources by Cloud locations." + }, + "resourceHierarchySelector": { + "$ref": "RolloutPlanWaveSelectorResourceHierarchySelector", + "description": "Optional. Roll out to resources by Cloud Resource Manager resource hierarchy." + } + }, + "type": "object" + }, + "RolloutPlanWaveSelectorLocationSelector": { + "description": "Roll out to resources by location.", + "id": "RolloutPlanWaveSelectorLocationSelector", + "properties": { + "includedLocations": { + "description": "Optional. Example: \"us-central1-a\"", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "RolloutPlanWaveSelectorResourceHierarchySelector": { + "description": "Roll out to resources by Cloud Resource Manager resource hierarchy\nnodes such as projects, folders, orgs.", + "id": "RolloutPlanWaveSelectorResourceHierarchySelector", + "properties": { + "includedFolders": { + "description": "Optional. Format: \"folders/{folder_id}\"", + "items": { + "type": "string" + }, + "type": "array" + }, + "includedOrganizations": { + "description": "Optional. Format: \"organizations/{organization_id}\"", + "items": { + "type": "string" + }, + "type": "array" + }, + "includedProjects": { + "description": "Optional. Format: \"projects/{project_id}\"", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "RolloutPlanWaveValidation": { + "description": "The validation to be performed before progressing to the next wave.", + "id": "RolloutPlanWaveValidation", + "properties": { + "timeBasedValidationMetadata": { + "$ref": "RolloutPlanWaveValidationTimeBasedValidationMetadata", + "description": "Optional. Metadata required if type = \"time\"." + }, + "type": { + "description": "Required. The type of the validation. If a type of validation is associated with\na metadata object, the appropriate metadata field mapping to the\nvalidation type must be provided in the validation message. Possible\nvalues are in quotes below alongside an explanation:\n \"manual\": The system waits for an end-user approval API before\n progressing to the next wave.\n \"time\": The system waits for a user specified duration before\n progressing to the next wave. TimeBasedValidation must be provided.", + "type": "string" + } + }, + "type": "object" + }, + "RolloutPlanWaveValidationTimeBasedValidationMetadata": { + "description": "Metadata required if type = \"time\".", + "id": "RolloutPlanWaveValidationTimeBasedValidationMetadata", + "properties": { + "waitDuration": { + "description": "Optional. The duration that the system waits in between waves. This wait starts\nafter all changes in the wave are rolled out.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "RolloutPlansListResponse": { + "description": "Contains a list of RolloutPlan resources.", + "id": "RolloutPlansListResponse", + "properties": { + "etag": { + "type": "string" + }, + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "A list of RolloutPlan resources.", + "items": { + "$ref": "RolloutPlan" + }, + "type": "array" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "unreachables": { + "description": "[Output Only] Unreachable resources.\nend_interface: MixerListResponseWithEtagBuilder", + "items": { + "type": "string" + }, + "type": "array" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed\noperation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as\ndeprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as\nexperimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden.\nDeprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the\nnetwork.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite\nthe mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "Quota information is not available to client requests (e.g:\nregions.list).", + "The user attempted to use a resource that requires a TOS they have not\naccepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, "RolloutPolicy": { "description": "A rollout policy configuration.", "id": "RolloutPolicy", @@ -102574,6 +103942,251 @@ }, "type": "object" }, + "RolloutRolloutEntity": { + "description": "Specifications of the resource to roll out.", + "id": "RolloutRolloutEntity", + "properties": { + "orchestratedEntity": { + "$ref": "RolloutRolloutEntityOrchestratedEntity", + "description": "Optional. Entity details for products using the Orchestrated Integration model." + } + }, + "type": "object" + }, + "RolloutRolloutEntityOrchestratedEntity": { + "description": "This message is used if the resource type follows the Orchestrated\nintegration model with ProgressiveRollout.", + "id": "RolloutRolloutEntityOrchestratedEntity", + "properties": { + "conflictBehavior": { + "description": "Required. Specifies the behavior of the Rollout if an out of band update is\ndetected in a project during a Rollout. It can be one of the following\nvalues:\n1) overwrite : Overwrite the local value with the rollout value.\n2) no_overwrite : Do not overwrite the local value with the rollout\nvalue.", + "type": "string" + }, + "orchestrationAction": { + "description": "Required. Orchestration action during the Rollout. It can be one of the following\nvalues:\n1) \"update\": Resources will be updated by the rollout.\n2) \"delete\": Resources will be deleted by the rollout.", + "type": "string" + }, + "orchestrationSource": { + "description": "Required. Fully qualified resource name of the resource which contains the source\nof truth of the configuration being rolled out across\nlocations/projects. For example, in the case of a global Rollout which\nis applied across regions, this contains the name of the global\nresource created by the user which contains a payload for a resource\nthat is orchestrated across regions. This follows the following format:\n//.googleapis.com/organizations//locations/global//\ne.g.\n//osconfig.googleapis.com/organizations/1/locations/global/policyOrchestrators/po1", + "type": "string" + } + }, + "type": "object" + }, + "RolloutWaveDetails": { + "description": "Additional metadata about the status of each wave provided by the server.", + "id": "RolloutWaveDetails", + "properties": { + "orchestratedWaveDetails": { + "$ref": "RolloutWaveDetailsOrchestratedWaveDetails", + "description": "Output only. Additional details of the wave for products using the Orchestrated\nIntegration model.", + "readOnly": true + }, + "waveDisplayName": { + "description": "Output only. Wave name.\nEx. wave1", + "readOnly": true, + "type": "string" + }, + "waveNumber": { + "description": "Output only. System generated number for the wave.", + "format": "int64", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "RolloutWaveDetailsOrchestratedWaveDetails": { + "description": "Details of the wave for products using the Orchestrated integration\nmodel.", + "id": "RolloutWaveDetailsOrchestratedWaveDetails", + "properties": { + "completedResourcesCount": { + "description": "Output only. Resource completed so far.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "estimatedTotalResourcesCount": { + "description": "Output only. Estimated total count of resources.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "failedLocations": { + "description": "Output only. Locations that failed during orchestration, and ProgressiveRollout\nstopped retrying. There may be some successful resources rolled out in\nthe wave as the location may have failed later in the Rollout.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "failedResourcesCount": { + "description": "Output only. Resources failed.", + "format": "int64", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "RolloutsListResponse": { + "id": "RolloutsListResponse", + "properties": { + "etag": { + "type": "string" + }, + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "A list of Rollout resources.", + "items": { + "$ref": "Rollout" + }, + "type": "array" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "unreachables": { + "description": "[Output Only] Unreachable resources.\nend_interface: MixerListResponseWithEtagBuilder", + "items": { + "type": "string" + }, + "type": "array" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed\noperation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as\ndeprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as\nexperimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden.\nDeprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the\nnetwork.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite\nthe mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "Quota information is not available to client requests (e.g:\nregions.list).", + "The user attempted to use a resource that requires a TOS they have not\naccepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, "Route": { "description": "Represents a Route resource.\n\nA route defines a path from VM instances in the VPC network to a specific\ndestination. This destination can be inside or outside the VPC network.\nFor more information, read theRoutes overview.", "id": "Route", @@ -102722,7 +104335,7 @@ "type": "integer" }, "routeStatus": { - "description": "[Output only] The status of the route.", + "description": "[Output only] The status of the route. This status only applies to\ndynamic routes learned by Cloud Routers. This status is not applicable\nto static routes.", "enum": [ "ACTIVE", "DROPPED", @@ -121619,6 +123232,18 @@ }, "type": "object" }, + "WorkloadIdentityConfig": { + "id": "WorkloadIdentityConfig", + "properties": { + "identity": { + "type": "string" + }, + "identityCertificateEnabled": { + "type": "boolean" + } + }, + "type": "object" + }, "XpnHostList": { "id": "XpnHostList", "properties": { diff --git a/discovery/compute-beta.json b/discovery/compute-beta.json index 395dcd0245..619f7911cf 100644 --- a/discovery/compute-beta.json +++ b/discovery/compute-beta.json @@ -126,7 +126,7 @@ "acceleratorTypes": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of accelerator types.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", + "description": "Retrieves an aggregated list of accelerator types.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/acceleratorTypes", "httpMethod": "GET", "id": "compute.acceleratorTypes.aggregatedList", @@ -302,7 +302,7 @@ "addresses": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of addresses.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", + "description": "Retrieves an aggregated list of addresses.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/addresses", "httpMethod": "GET", "id": "compute.addresses.aggregatedList", @@ -754,7 +754,7 @@ "autoscalers": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of autoscalers.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", + "description": "Retrieves an aggregated list of autoscalers.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/autoscalers", "httpMethod": "GET", "id": "compute.autoscalers.aggregatedList", @@ -1817,7 +1817,7 @@ ] }, "aggregatedList": { - "description": "Retrieves the list of all BackendService resources, regional and global,\navailable to the specified project.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", + "description": "Retrieves the list of all BackendService resources, regional and global,\navailable to the specified project.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/backendServices", "httpMethod": "GET", "id": "compute.backendServices.aggregatedList", @@ -2816,7 +2816,7 @@ "diskTypes": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of disk types.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", + "description": "Retrieves an aggregated list of disk types.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/diskTypes", "httpMethod": "GET", "id": "compute.diskTypes.aggregatedList", @@ -3042,7 +3042,7 @@ ] }, "aggregatedList": { - "description": "Retrieves an aggregated list of persistent disks.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", + "description": "Retrieves an aggregated list of persistent disks.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/disks", "httpMethod": "GET", "id": "compute.disks.aggregatedList", @@ -4605,6 +4605,11 @@ "httpMethod": "GET", "id": "compute.firewallPolicies.listAssociations", "parameters": { + "includeInheritedPolicies": { + "description": "If set to \"true\", the response will contain a list of all associations for\nthe containing folders and the containing organization of the target. The\nparameter has no effect if the target is an organization.", + "location": "query", + "type": "boolean" + }, "targetResource": { "description": "The target resource to list associations. It is an organization, or a\nfolder.", "location": "query", @@ -5234,7 +5239,7 @@ "forwardingRules": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of forwarding rules.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", + "description": "Retrieves an aggregated list of forwarding rules.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/forwardingRules", "httpMethod": "GET", "id": "compute.forwardingRules.aggregatedList", @@ -5695,7 +5700,7 @@ "futureReservations": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of future reservations.\n\nTo prevent failure, recommendation is that you set the\n`returnPartialSuccess` parameter to `true`.", + "description": "Retrieves an aggregated list of future reservations.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/futureReservations", "httpMethod": "GET", "id": "compute.futureReservations.aggregatedList", @@ -7518,13 +7523,13 @@ } } }, - "healthChecks": { + "globalVmExtensionPolicies": { "methods": { "aggregatedList": { - "description": "Retrieves the list of all HealthCheck resources, regional and global,\navailable to the specified project.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", - "flatPath": "projects/{project}/aggregated/healthChecks", + "description": "Retrieves the list of all VM Extension Policy resources\navailable to the specified project.\n\nTo prevent failure, it's recommended that you set the\n`returnPartialSuccess` parameter to `true`.", + "flatPath": "projects/{project}/aggregated/vmExtensionPolicies", "httpMethod": "GET", - "id": "compute.healthChecks.aggregatedList", + "id": "compute.globalVmExtensionPolicies.aggregatedList", "parameterOrder": [ "project" ], @@ -7576,9 +7581,9 @@ "type": "string" } }, - "path": "projects/{project}/aggregated/healthChecks", + "path": "projects/{project}/aggregated/vmExtensionPolicies", "response": { - "$ref": "HealthChecksAggregatedList" + "$ref": "VmExtensionPolicyAggregatedListResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -7586,57 +7591,18 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "delete": { - "description": "Deletes the specified HealthCheck resource.", - "flatPath": "projects/{project}/global/healthChecks/{healthCheck}", - "httpMethod": "DELETE", - "id": "compute.healthChecks.delete", - "parameterOrder": [ - "project", - "healthCheck" - ], - "parameters": { - "healthCheck": { - "description": "Name of the HealthCheck resource to delete.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" - }, - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" - }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" - } - }, - "path": "projects/{project}/global/healthChecks/{healthCheck}", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - }, "get": { - "description": "Returns the specified HealthCheck resource.", - "flatPath": "projects/{project}/global/healthChecks/{healthCheck}", + "description": "Gets details of a global VM extension policy.", + "flatPath": "projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}", "httpMethod": "GET", - "id": "compute.healthChecks.get", + "id": "compute.globalVmExtensionPolicies.get", "parameterOrder": [ "project", - "healthCheck" + "globalVmExtensionPolicy" ], "parameters": { - "healthCheck": { - "description": "Name of the HealthCheck resource to return.", + "globalVmExtensionPolicy": { + "description": "Name of the GlobalVmExtensionPolicy resource to return.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -7650,55 +7616,25 @@ "type": "string" } }, - "path": "projects/{project}/global/healthChecks/{healthCheck}", + "path": "projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}", "response": { - "$ref": "HealthCheck" + "$ref": "GlobalVmExtensionPolicy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ] - }, - "insert": { - "description": "Creates a HealthCheck resource in the specified project using the data\nincluded in the request.", - "flatPath": "projects/{project}/global/healthChecks", - "httpMethod": "POST", - "id": "compute.healthChecks.insert", - "parameterOrder": [ - "project" - ], - "parameters": { - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" - }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" - } - }, - "path": "projects/{project}/global/healthChecks", - "request": { - "$ref": "HealthCheck" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - }, - "list": { - "description": "Retrieves the list of HealthCheck resources available to the specified\nproject.", - "flatPath": "projects/{project}/global/healthChecks", + } + } + }, + "healthChecks": { + "methods": { + "aggregatedList": { + "description": "Retrieves the list of all HealthCheck resources, regional and global,\navailable to the specified project.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", + "flatPath": "projects/{project}/aggregated/healthChecks", "httpMethod": "GET", - "id": "compute.healthChecks.list", + "id": "compute.healthChecks.aggregatedList", "parameterOrder": [ "project" ], @@ -7708,6 +7644,11 @@ "location": "query", "type": "string" }, + "includeAllScopes": { + "description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.", + "location": "query", + "type": "boolean" + }, "maxResults": { "default": "500", "description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", @@ -7727,7 +7668,7 @@ "type": "string" }, "project": { - "description": "Project ID for this request.", + "description": "Name of the project scoping this request.", "location": "path", "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", "required": true, @@ -7737,91 +7678,17 @@ "description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", "location": "query", "type": "boolean" - } - }, - "path": "projects/{project}/global/healthChecks", - "response": { - "$ref": "HealthCheckList" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] - }, - "patch": { - "description": "Updates a HealthCheck resource in the specified project using the data\nincluded in the request. This method supportsPATCH\nsemantics and uses theJSON merge\npatch format and processing rules.", - "flatPath": "projects/{project}/global/healthChecks/{healthCheck}", - "httpMethod": "PATCH", - "id": "compute.healthChecks.patch", - "parameterOrder": [ - "project", - "healthCheck" - ], - "parameters": { - "healthCheck": { - "description": "Name of the HealthCheck resource to patch.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" }, - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" - }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", + "serviceProjectNumber": { + "description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.", + "format": "int64", "location": "query", "type": "string" } }, - "path": "projects/{project}/global/healthChecks/{healthCheck}", - "request": { - "$ref": "HealthCheck" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource.", - "flatPath": "projects/{project}/global/healthChecks/{resource}/testIamPermissions", - "httpMethod": "POST", - "id": "compute.healthChecks.testIamPermissions", - "parameterOrder": [ - "project", - "resource" - ], - "parameters": { - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" - }, - "resource": { - "description": "Name or id of the resource for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" - } - }, - "path": "projects/{project}/global/healthChecks/{resource}/testIamPermissions", - "request": { - "$ref": "TestPermissionsRequest" - }, + "path": "projects/{project}/aggregated/healthChecks", "response": { - "$ref": "TestPermissionsResponse" + "$ref": "HealthChecksAggregatedList" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -7829,18 +7696,18 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "update": { - "description": "Updates a HealthCheck resource in the specified project using the data\nincluded in the request.", + "delete": { + "description": "Deletes the specified HealthCheck resource.", "flatPath": "projects/{project}/global/healthChecks/{healthCheck}", - "httpMethod": "PUT", - "id": "compute.healthChecks.update", + "httpMethod": "DELETE", + "id": "compute.healthChecks.delete", "parameterOrder": [ "project", "healthCheck" ], "parameters": { "healthCheck": { - "description": "Name of the HealthCheck resource to update.", + "description": "Name of the HealthCheck resource to delete.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -7860,52 +7727,6 @@ } }, "path": "projects/{project}/global/healthChecks/{healthCheck}", - "request": { - "$ref": "HealthCheck" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - } - } - }, - "httpHealthChecks": { - "methods": { - "delete": { - "description": "Deletes the specified HttpHealthCheck resource.", - "flatPath": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}", - "httpMethod": "DELETE", - "id": "compute.httpHealthChecks.delete", - "parameterOrder": [ - "project", - "httpHealthCheck" - ], - "parameters": { - "httpHealthCheck": { - "description": "Name of the HttpHealthCheck resource to delete.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" - }, - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" - }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" - } - }, - "path": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}", "response": { "$ref": "Operation" }, @@ -7915,17 +7736,17 @@ ] }, "get": { - "description": "Returns the specified HttpHealthCheck resource.", - "flatPath": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}", + "description": "Returns the specified HealthCheck resource.", + "flatPath": "projects/{project}/global/healthChecks/{healthCheck}", "httpMethod": "GET", - "id": "compute.httpHealthChecks.get", + "id": "compute.healthChecks.get", "parameterOrder": [ "project", - "httpHealthCheck" + "healthCheck" ], "parameters": { - "httpHealthCheck": { - "description": "Name of the HttpHealthCheck resource to return.", + "healthCheck": { + "description": "Name of the HealthCheck resource to return.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -7939,9 +7760,9 @@ "type": "string" } }, - "path": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}", + "path": "projects/{project}/global/healthChecks/{healthCheck}", "response": { - "$ref": "HttpHealthCheck" + "$ref": "HealthCheck" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -7950,10 +7771,10 @@ ] }, "insert": { - "description": "Creates a HttpHealthCheck resource in the specified project using the data\nincluded in the request.", - "flatPath": "projects/{project}/global/httpHealthChecks", + "description": "Creates a HealthCheck resource in the specified project using the data\nincluded in the request.", + "flatPath": "projects/{project}/global/healthChecks", "httpMethod": "POST", - "id": "compute.httpHealthChecks.insert", + "id": "compute.healthChecks.insert", "parameterOrder": [ "project" ], @@ -7971,9 +7792,9 @@ "type": "string" } }, - "path": "projects/{project}/global/httpHealthChecks", + "path": "projects/{project}/global/healthChecks", "request": { - "$ref": "HttpHealthCheck" + "$ref": "HealthCheck" }, "response": { "$ref": "Operation" @@ -7984,10 +7805,299 @@ ] }, "list": { - "description": "Retrieves the list of HttpHealthCheck resources available to the specified\nproject.", - "flatPath": "projects/{project}/global/httpHealthChecks", + "description": "Retrieves the list of HealthCheck resources available to the specified\nproject.", + "flatPath": "projects/{project}/global/healthChecks", "httpMethod": "GET", - "id": "compute.httpHealthChecks.list", + "id": "compute.healthChecks.list", + "parameterOrder": [ + "project" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", + "location": "query", + "type": "boolean" + } + }, + "path": "projects/{project}/global/healthChecks", + "response": { + "$ref": "HealthCheckList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "patch": { + "description": "Updates a HealthCheck resource in the specified project using the data\nincluded in the request. This method supportsPATCH\nsemantics and uses theJSON merge\npatch format and processing rules.", + "flatPath": "projects/{project}/global/healthChecks/{healthCheck}", + "httpMethod": "PATCH", + "id": "compute.healthChecks.patch", + "parameterOrder": [ + "project", + "healthCheck" + ], + "parameters": { + "healthCheck": { + "description": "Name of the HealthCheck resource to patch.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/global/healthChecks/{healthCheck}", + "request": { + "$ref": "HealthCheck" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource.", + "flatPath": "projects/{project}/global/healthChecks/{resource}/testIamPermissions", + "httpMethod": "POST", + "id": "compute.healthChecks.testIamPermissions", + "parameterOrder": [ + "project", + "resource" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/global/healthChecks/{resource}/testIamPermissions", + "request": { + "$ref": "TestPermissionsRequest" + }, + "response": { + "$ref": "TestPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "update": { + "description": "Updates a HealthCheck resource in the specified project using the data\nincluded in the request.", + "flatPath": "projects/{project}/global/healthChecks/{healthCheck}", + "httpMethod": "PUT", + "id": "compute.healthChecks.update", + "parameterOrder": [ + "project", + "healthCheck" + ], + "parameters": { + "healthCheck": { + "description": "Name of the HealthCheck resource to update.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/global/healthChecks/{healthCheck}", + "request": { + "$ref": "HealthCheck" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + } + } + }, + "httpHealthChecks": { + "methods": { + "delete": { + "description": "Deletes the specified HttpHealthCheck resource.", + "flatPath": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}", + "httpMethod": "DELETE", + "id": "compute.httpHealthChecks.delete", + "parameterOrder": [ + "project", + "httpHealthCheck" + ], + "parameters": { + "httpHealthCheck": { + "description": "Name of the HttpHealthCheck resource to delete.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "get": { + "description": "Returns the specified HttpHealthCheck resource.", + "flatPath": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}", + "httpMethod": "GET", + "id": "compute.httpHealthChecks.get", + "parameterOrder": [ + "project", + "httpHealthCheck" + ], + "parameters": { + "httpHealthCheck": { + "description": "Name of the HttpHealthCheck resource to return.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}", + "response": { + "$ref": "HttpHealthCheck" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "insert": { + "description": "Creates a HttpHealthCheck resource in the specified project using the data\nincluded in the request.", + "flatPath": "projects/{project}/global/httpHealthChecks", + "httpMethod": "POST", + "id": "compute.httpHealthChecks.insert", + "parameterOrder": [ + "project" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/global/httpHealthChecks", + "request": { + "$ref": "HttpHealthCheck" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "list": { + "description": "Retrieves the list of HttpHealthCheck resources available to the specified\nproject.", + "flatPath": "projects/{project}/global/httpHealthChecks", + "httpMethod": "GET", + "id": "compute.httpHealthChecks.list", "parameterOrder": [ "project" ], @@ -9605,6 +9715,47 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, + "getAvailableAcceleratorTopologies": { + "description": "Returns information about available accelerator topologies for a given MIG.", + "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{resourceId}/getAvailableAcceleratorTopologies", + "httpMethod": "GET", + "id": "compute.instanceGroupManagers.getAvailableAcceleratorTopologies", + "parameterOrder": [ + "project", + "zone", + "resourceId" + ], + "parameters": { + "project": { + "description": "Required. Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "resourceId": { + "description": "Required. The name of the managed instance group.\nIt should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "zone": { + "description": "Required. The name of thezone where the managed\ninstance group is located.\nName should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{resourceId}/getAvailableAcceleratorTopologies", + "response": { + "$ref": "InstanceGroupManagersGetAvailableAcceleratorTopologiesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, "insert": { "description": "Creates a managed instance group using the information that you specify\nin the request. After the group is created, instances in the group are\ncreated using the specified instance template.\nThis operation is marked as DONE when the group is created\neven if the instances in the group have not yet been created. You\nmust separately verify the status of the individual instances with thelistmanagedinstances\nmethod.\n\nA managed instance group can have up to 1000 VM instances per group. Please\ncontact Cloud Support if you need an increase in\nthis limit.", "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers", @@ -19008,7 +19159,7 @@ ] }, "aggregatedList": { - "description": "Retrieves an aggregated list of network firewall policies, listing network\nfirewall policies from all applicable scopes (global and regional) and\ngrouping the results per scope.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", + "description": "Retrieves an aggregated list of network firewall policies, listing network\nfirewall policies from all applicable scopes (global and regional) and\ngrouping the results per scope.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/firewallPolicies", "httpMethod": "GET", "id": "compute.networkFirewallPolicies.aggregatedList", @@ -23203,7 +23354,7 @@ }, "moveDisk": { "deprecated": true, - "description": "Starting September 29, 2025, you can't use the moveDisk API on new\nprojects. To move a disk to a different region or zone, follow the steps in\n[Change the location of a\ndisk](https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd).\n\nProjects that already use the moveDisk API can continue usage until\nSeptember 29, 2026.\n\nStarting November 1, 2025, API responses will include a warning message in\nthe response body about the upcoming deprecation. You can skip the message\nto continue using the service without interruption.", + "description": "Moves a persistent disk from one zone to another.\n*Note*: The moveDisk API will be deprecated on September 29, 2026.\n\nStarting September 29, 2025, you can't use the moveDisk API on new\nprojects. To move a disk to a different region or zone, follow the steps in\n[Change the location of a\ndisk](https://cloud.google.com/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd).\n\nProjects that already use the moveDisk API can continue usage until\nSeptember 29, 2026.\n\nStarting November 1, 2025, API responses will include a warning message in\nthe response body about the upcoming deprecation. You can skip the message\nto continue using the service without interruption.", "flatPath": "projects/{project}/moveDisk", "httpMethod": "POST", "id": "compute.projects.moveDisk", @@ -25532,7 +25683,7 @@ "regionCommitments": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of commitments by region.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", + "description": "Retrieves an aggregated list of commitments by region.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/commitments", "httpMethod": "GET", "id": "compute.regionCommitments.aggregatedList", @@ -25907,7 +26058,7 @@ "regionCompositeHealthChecks": { "methods": { "aggregatedList": { - "description": "Retrieves the list of all CompositeHealthCheck resources (all\nregional) available to the specified project.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", + "description": "Retrieves the list of all CompositeHealthCheck resources (all\nregional) available to the specified project.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/compositeHealthChecks", "httpMethod": "GET", "id": "compute.regionCompositeHealthChecks.aggregatedList", @@ -27300,7 +27451,7 @@ "regionHealthAggregationPolicies": { "methods": { "aggregatedList": { - "description": "Retrieves the list of all HealthAggregationPolicy resources,\nregional and global, available to the specified project.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", + "description": "Retrieves the list of all HealthAggregationPolicy resources,\nregional and global, available to the specified project.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/healthAggregationPolicies", "httpMethod": "GET", "id": "compute.regionHealthAggregationPolicies.aggregatedList", @@ -37314,6 +37465,21 @@ "required": true, "type": "string" }, + "view": { + "description": "View of the subBlock.", + "enum": [ + "SUB_BLOCK_VIEW_BASIC", + "SUB_BLOCK_VIEW_FULL", + "SUB_BLOCK_VIEW_UNSPECIFIED" + ], + "enumDescriptions": [ + "This view includes basic information about the reservation sub block", + "Includes detailed topology view.", + "The default / unset value. The API will default to the BASIC view." + ], + "location": "query", + "type": "string" + }, "zone": { "description": "Name of the zone for this request. Zone name should conform to RFC1035.", "location": "path", @@ -37673,7 +37839,7 @@ "reservations": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of reservations.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", + "description": "Retrieves an aggregated list of reservations.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/reservations", "httpMethod": "GET", "id": "compute.reservations.aggregatedList", @@ -42820,6 +42986,20 @@ "format": "int64", "location": "query", "type": "string" + }, + "views": { + "description": "Defines the extra views returned back in the subnetwork resource.\nSupported values:\n \n - WITH_UTILIZATION: Utilization data is included in the\n response.", + "enum": [ + "DEFAULT", + "WITH_UTILIZATION" + ], + "enumDescriptions": [ + "", + "Utilization data is included in the response." + ], + "location": "query", + "repeated": true, + "type": "string" } }, "path": "projects/{project}/aggregated/subnetworks", @@ -48329,6 +48509,253 @@ } } }, + "zoneVmExtensionPolicies": { + "methods": { + "delete": { + "description": "Deletes a specified zone VM extension policy.", + "flatPath": "projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}", + "httpMethod": "DELETE", + "id": "compute.zoneVmExtensionPolicies.delete", + "parameterOrder": [ + "project", + "zone", + "vmExtensionPolicy" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "vmExtensionPolicy": { + "description": "Name of the zone VM extension policy to delete.", + "location": "path", + "required": true, + "type": "string" + }, + "zone": { + "description": "Name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "get": { + "description": "Retrieves details of a specific zone VM extension policy.", + "flatPath": "projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}", + "httpMethod": "GET", + "id": "compute.zoneVmExtensionPolicies.get", + "parameterOrder": [ + "project", + "zone", + "vmExtensionPolicy" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "vmExtensionPolicy": { + "description": "Name of the VM extension policy resource to return.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "zone": { + "description": "Name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}", + "response": { + "$ref": "VmExtensionPolicy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "insert": { + "description": "Creates a new zone-level VM extension policy within a project.", + "flatPath": "projects/{project}/zones/{zone}/vmExtensionPolicies", + "httpMethod": "POST", + "id": "compute.zoneVmExtensionPolicies.insert", + "parameterOrder": [ + "project", + "zone" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "zone": { + "description": "Name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/vmExtensionPolicies", + "request": { + "$ref": "VmExtensionPolicy" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "list": { + "description": "Lists all VM extension policies within a specific zone for a project.", + "flatPath": "projects/{project}/zones/{zone}/vmExtensionPolicies", + "httpMethod": "GET", + "id": "compute.zoneVmExtensionPolicies.list", + "parameterOrder": [ + "project", + "zone" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", + "location": "query", + "type": "boolean" + }, + "zone": { + "description": "Name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/vmExtensionPolicies", + "response": { + "$ref": "VmExtensionPolicyList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "update": { + "description": "Modifies an existing zone VM extension policy.", + "flatPath": "projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}", + "httpMethod": "PATCH", + "id": "compute.zoneVmExtensionPolicies.update", + "parameterOrder": [ + "project", + "zone", + "vmExtensionPolicy" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "vmExtensionPolicy": { + "description": "Name of the zone VM extension policy to update.", + "location": "path", + "required": true, + "type": "string" + }, + "zone": { + "description": "Name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}", + "request": { + "$ref": "VmExtensionPolicy" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + } + } + }, "zones": { "methods": { "get": { @@ -48424,7 +48851,7 @@ } } }, - "revision": "20251015", + "revision": "20251019", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -48466,6 +48893,66 @@ }, "type": "object" }, + "AcceleratorTopologiesInfo": { + "description": "Info for accelerator topologies within a densely packed reservation.", + "id": "AcceleratorTopologiesInfo", + "properties": { + "acceleratorTopologyInfos": { + "description": "Info for each accelerator topology.", + "items": { + "$ref": "AcceleratorTopologiesInfoAcceleratorTopologyInfo" + }, + "type": "array" + } + }, + "type": "object" + }, + "AcceleratorTopologiesInfoAcceleratorTopologyInfo": { + "description": "Info for a slice of a given topology.", + "id": "AcceleratorTopologiesInfoAcceleratorTopologyInfo", + "properties": { + "acceleratorTopology": { + "description": "The accelerator topology.", + "type": "string" + }, + "infoPerTopologyStates": { + "description": "Info for each topology state.", + "items": { + "$ref": "AcceleratorTopologiesInfoAcceleratorTopologyInfoInfoPerTopologyState" + }, + "type": "array" + } + }, + "type": "object" + }, + "AcceleratorTopologiesInfoAcceleratorTopologyInfoInfoPerTopologyState": { + "description": "Info for each topology state.", + "id": "AcceleratorTopologiesInfoAcceleratorTopologyInfoInfoPerTopologyState", + "properties": { + "count": { + "description": "The number of accelerator topologies in this state.", + "format": "int32", + "type": "integer" + }, + "state": { + "description": "The state of the accelerator topology.", + "enum": [ + "AVAILABLE", + "RUNNING", + "TOPOLOGY_STATE_UNSPECIFIED", + "UNHEALTHY" + ], + "enumDescriptions": [ + "The accelerator topology is available.", + "The accelerator topology is running.", + "The state of the topology is unspecified.", + "The accelerator topology is unhealthy." + ], + "type": "string" + } + }, + "type": "object" + }, "AcceleratorType": { "description": "Represents an Accelerator Type resource.\n\nGoogle Cloud Platform provides graphics processing units (accelerators) that\nyou can add to VM instances to improve or accelerate performance when working\nwith intensive workloads. For more information, readGPUs on Compute Engine.", "id": "AcceleratorType", @@ -51364,6 +51851,10 @@ "$ref": "BackendBucketParams", "description": "Input only. [Input Only] Additional params passed with the request, but not persisted\nas part of resource payload." }, + "region": { + "description": "[Output Only] URL of the region where the regional backend bucket\nresides. This field is not applicable to global backend buckets.\nYou must specify this field as part of the HTTP request URL. It is\nnot settable as a field in the request body.", + "type": "string" + }, "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" @@ -51651,7 +52142,7 @@ "id": "BackendBucketCdnPolicyNegativeCachingPolicy", "properties": { "code": { - "description": "The HTTP status code to define a TTL against. Only HTTP status codes\n300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be\nspecified as values, and you cannot specify a status code more than\nonce.", + "description": "The HTTP status code to define a TTL against. Only HTTP status codes\n300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be\nspecified as values, and you cannot specify a status code more than\nonce.", "format": "int32", "type": "integer" }, @@ -52147,7 +52638,7 @@ "type": "number" }, "name": { - "description": "Name of a custom utilization signal. The name must be 1-64 characters\nlong and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, period, underscore, lowercase letter, or\ndigit, except the last character, which cannot be a dash, period, or\nunderscore. For usage guidelines, see Custom Metrics balancing mode. This\nfield can only be used for a global or regional backend service with the\nloadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.", + "description": "Name of a custom utilization signal. The name must be 1-64 characters\nlong and match the regular expression\n`[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, period, underscore, lowercase letter, or\ndigit, except the last character, which cannot be a dash, period, or\nunderscore. For usage guidelines, see Custom Metrics balancing mode. This\nfield can only be used for a global or regional backend service with the\nloadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.", "type": "string" } }, @@ -52777,7 +53268,7 @@ "id": "BackendServiceCdnPolicyNegativeCachingPolicy", "properties": { "code": { - "description": "The HTTP status code to define a TTL against. Only HTTP status codes\n300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be\nspecified as values, and you cannot specify a status code more than\nonce.", + "description": "The HTTP status code to define a TTL against. Only HTTP status codes\n300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be\nspecified as values, and you cannot specify a status code more than\nonce.", "format": "int32", "type": "integer" }, @@ -52842,7 +53333,7 @@ "type": "boolean" }, "name": { - "description": "Name of a custom utilization signal. The name must be 1-64 characters\nlong and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, period, underscore, lowercase letter, or\ndigit, except the last character, which cannot be a dash, period, or\nunderscore. For usage guidelines, see Custom Metrics balancing mode. This\nfield can only be used for a global or regional backend service with the\nloadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.", + "description": "Name of a custom utilization signal. The name must be 1-64 characters\nlong and match the regular expression\n`[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, period, underscore, lowercase letter, or\ndigit, except the last character, which cannot be a dash, period, or\nunderscore. For usage guidelines, see Custom Metrics balancing mode. This\nfield can only be used for a global or regional backend service with the\nloadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.", "type": "string" } }, @@ -53478,6 +53969,10 @@ "description": "Reference to the BackendAuthenticationConfig resource from the\nnetworksecurity.googleapis.com namespace. Can be used in authenticating\nTLS connections to the backend, as specified by the authenticationMode\nfield. Can only be specified if authenticationMode is not NONE.", "type": "string" }, + "identity": { + "description": "Assigns the Managed Identity for the BackendService Workload.\n\n\nUse this property to configure the load balancer back-end to use\ncertificates and roots of trust provisioned by the Managed Workload\nIdentity system. \n\n The `identity` property is the\nfully-specified SPIFFE ID to use in the SVID presented by the Load\nBalancer Workload. \n\n The SPIFFE ID must be a resource starting with the\n`trustDomain` property value, followed by the path to the Managed\nWorkload Identity. \n\n Supported SPIFFE ID format: \n \n - ///ns//sa/\n\n\nThe Trust Domain within the Managed Identity must refer to a valid\nWorkload Identity Pool. The TrustConfig and CertificateIssuanceConfig\nwill be inherited from the Workload Identity Pool. \n\n Restrictions: \n \n - If you set the `identity` property, you cannot manually set\n the following fields: \n - tlsSettings.sni\n - tlsSettings.subjectAltNames\n - tlsSettings.authenticationConfig\n \n\nWhen defining a `identity` for a RegionBackendServices, the\ncorresponding Workload Identity Pool must have a ca_pool\nconfigured in the same region. \n\n The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.", + "type": "string" + }, "sni": { "description": "Server Name Indication - see RFC3546 section 3.1. If set, the load\nbalancer sends this string as the SNI hostname in the TLS connection to\nthe backend, and requires that this string match a Subject Alternative\nName (SAN) in the backend's server certificate. With a Regional Internet\nNEG backend, if the SNI is specified here, the load balancer uses it\nregardless of whether the Regional Internet NEG is specified with FQDN or\nIP address and port. When both sni and subjectAltNames[] are specified,\nthe load balancer matches the backend certificate's SAN only to\nsubjectAltNames[].", "type": "string" @@ -55086,6 +55581,13 @@ "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, + "unreachables": { + "description": "[Output Only] Unreachable resources.", + "items": { + "type": "string" + }, + "type": "array" + }, "warning": { "description": "[Output Only] Informational warning message.", "properties": { @@ -61325,6 +61827,223 @@ }, "type": "object" }, + "GlobalVmExtensionPolicy": { + "description": "Message describing GlobalVmExtensionPolicy object.", + "id": "GlobalVmExtensionPolicy", + "properties": { + "creationTimestamp": { + "description": "[Output Only] Creation timestamp inRFC3339\ntext format.", + "type": "string" + }, + "description": { + "description": "An optional description of this resource. Provide this property when you\ncreate the resource.", + "type": "string" + }, + "extensionPolicies": { + "additionalProperties": { + "$ref": "GlobalVmExtensionPolicyExtensionPolicy" + }, + "description": "Required. Map from extension (eg: \"cloudops\") to its policy configuration.\nThe key is the name of the extension.", + "type": "object" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.", + "format": "uint64", + "type": "string" + }, + "instanceSelectors": { + "description": "Optional. Selector to target VMs for a policy.\nThere is a logical \"AND\" between instance_selectors.", + "items": { + "$ref": "GlobalVmExtensionPolicyInstanceSelector" + }, + "type": "array" + }, + "kind": { + "default": "compute#globalVmExtensionPolicy", + "description": "[Output Only] Type of the resource. Alwayscompute#globalVmExtensionPolicy for globalVmExtensionPolicies.", + "type": "string" + }, + "name": { + "description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?`\nwhich means the first character must be a lowercase letter, and all\nfollowing characters must be a dash, lowercase letter, or digit, except\nthe last character, which cannot be a dash.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, + "priority": { + "description": "Optional. Used to resolve conflicts when multiple policies are active for the same\nextension. Defaults to 0.\n\nLarger the number, higher the priority. When the priority is the same,\nthe policy with the newer create time has higher priority.", + "format": "int32", + "type": "integer" + }, + "rolloutOperation": { + "$ref": "GlobalVmExtensionPolicyRolloutOperation", + "description": "Required. The rollout strategy and status." + }, + "scopedResourceStatus": { + "description": "[Output Only] The scoped resource status. It's only for tracking the\npurging status of the policy.", + "enum": [ + "SCOPED_RESOURCE_STATUS_DELETING", + "SCOPED_RESOURCE_STATUS_UNSPECIFIED" + ], + "enumDescriptions": [ + "The zonal policies are being deleted.", + "Default value. This value is unused." + ], + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined fully-qualified URL for this resource.", + "type": "string" + }, + "selfLinkWithId": { + "description": "[Output Only] Server-defined URL for this resource's resource id.", + "type": "string" + }, + "updateTimestamp": { + "description": "[Output Only] Update timestamp inRFC3339\ntext format.", + "type": "string" + } + }, + "type": "object" + }, + "GlobalVmExtensionPolicyExtensionPolicy": { + "description": "Policy for a single extension.", + "id": "GlobalVmExtensionPolicyExtensionPolicy", + "properties": { + "pinnedVersion": { + "description": "Optional. The version pinning for the extension.\nIf empty, the extension will be installed with the latest version\nreleased by the extension producer.", + "type": "string" + }, + "stringConfig": { + "description": "Optional. String configuration. Any string payload that the extension\nunderstands.", + "type": "string" + } + }, + "type": "object" + }, + "GlobalVmExtensionPolicyInstanceSelector": { + "description": "Selector to target VMs for a zone VM extension policy.", + "id": "GlobalVmExtensionPolicyInstanceSelector", + "properties": { + "labelSelector": { + "$ref": "GlobalVmExtensionPolicyLabelSelector", + "description": "Optional. Labels within the LabelSelector are OR'd." + } + }, + "type": "object" + }, + "GlobalVmExtensionPolicyLabelSelector": { + "description": "A LabelSelector is applicable for a VM only if it matches all labels in\nthe LabelSelector.", + "id": "GlobalVmExtensionPolicyLabelSelector", + "properties": { + "inclusionLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels as key value pairs.\nA VM should contain all the pairs specified in this map to be selected;\nLabels within the LabelSelector are OR'ed.", + "type": "object" + } + }, + "type": "object" + }, + "GlobalVmExtensionPolicyRolloutOperation": { + "description": "Represents the rollout operation", + "id": "GlobalVmExtensionPolicyRolloutOperation", + "properties": { + "rolloutInput": { + "$ref": "GlobalVmExtensionPolicyRolloutOperationRolloutInput", + "description": "Required. The rollout input which defines the rollout plan." + }, + "rolloutStatus": { + "$ref": "GlobalVmExtensionPolicyRolloutOperationRolloutStatus", + "description": "[Output Only] The rollout status of the policy." + } + }, + "type": "object" + }, + "GlobalVmExtensionPolicyRolloutOperationRolloutInput": { + "id": "GlobalVmExtensionPolicyRolloutOperationRolloutInput", + "properties": { + "conflictBehavior": { + "description": "Optional. [Optional] Specifies the behavior of the Rollout if a conflict is\ndetected in a project during a Rollout. It can be one of the following\nvalues:\n1) empty : don't overwrite the local value if conflict happens. This is\nthe default behavior.\n2) \"overwrite\" : Overwrite the local value with the rollout value.\nThe concept of \"conflict\" applies to:\n1) Insert action. If the zonal policy already exists when Insert\nhappens, it's a conflict.\n2) Update action. If the zonal policy was updated out of band by a\nzonal API, it's a conflict.", + "type": "string" + }, + "name": { + "description": "Optional. The name of the rollout plan.\nEx.\nprojects//locations/global/rolloutPlans/.", + "type": "string" + }, + "predefinedRolloutPlan": { + "description": "Optional. Predefined rollout plan.", + "enum": [ + "FAST_ROLLOUT", + "ROLLOUT_PLAN_UNSPECIFIED", + "SLOW_ROLLOUT" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "retryUuid": { + "description": "Optional. The UUID of the retry action. Only set it if this is a retry\nfor an existing resource. This is for the user re-populate the resource\nwithout changes. An error will be returned if the retry_uuid is set but\nthe resource get modified.", + "type": "string" + } + }, + "type": "object" + }, + "GlobalVmExtensionPolicyRolloutOperationRolloutStatus": { + "id": "GlobalVmExtensionPolicyRolloutOperationRolloutStatus", + "properties": { + "currentRollouts": { + "description": "[Output Only] The current rollouts for the latest version of the\nresource. There should be only one current rollout, but for\nscalability, we make it repeated.", + "items": { + "$ref": "GlobalVmExtensionPolicyRolloutOperationRolloutStatusRolloutMetadata" + }, + "type": "array" + }, + "previousRollout": { + "$ref": "GlobalVmExtensionPolicyRolloutOperationRolloutStatusRolloutMetadata", + "description": "[Output Only] The last completed rollout resource. This field will not\nbe populated until the first rollout is completed." + } + }, + "type": "object" + }, + "GlobalVmExtensionPolicyRolloutOperationRolloutStatusRolloutMetadata": { + "id": "GlobalVmExtensionPolicyRolloutOperationRolloutStatusRolloutMetadata", + "properties": { + "rollout": { + "description": "[Output Only] The name of the rollout.\nEx. projects//locations/global/rollouts/.", + "type": "string" + }, + "rolloutPlan": { + "description": "[Output Only] The name of the rollout plan.\nEx.\nprojects//locations/global/rolloutPlans/.", + "type": "string" + }, + "state": { + "description": "[Output Only] The overall state of the rollout.", + "enum": [ + "STATE_CANCELLED", + "STATE_COMPLETED", + "STATE_FAILED", + "STATE_PAUSED", + "STATE_PROCESSING", + "STATE_UNKNOWN", + "STATE_UNSPECIFIED" + ], + "enumDescriptions": [ + "Iteration was explicitly cancelled.", + "Iteration completed, with all actions being successful.", + "Iteration completed, with failures.", + "The rollout is paused.", + "Iteration is in progress.", + "Impossible to determine current state of the iteration.", + "Default value. This value is unused." + ], + "type": "string" + } + }, + "type": "object" + }, "GroupMaintenanceInfo": { "description": "Maintenance Info for ReservationBlocks.", "id": "GroupMaintenanceInfo", @@ -63110,6 +63829,13 @@ "description": "[Output Only] Server-defined URL for this resource.", "type": "string" }, + "unreachables": { + "description": "[Output Only] Unreachable resources.", + "items": { + "type": "string" + }, + "type": "array" + }, "warning": { "description": "[Output Only] Informational warning message.", "properties": { @@ -66458,7 +67184,7 @@ "id": "InstanceGroupManagerInstanceLifecyclePolicyOnRepair", "properties": { "allowChangingZone": { - "description": "Specifies whether the MIG can change a VM's zone during a repair.", + "description": "Specifies whether the MIG can change a VM's zone during a repair.\nValid values are:\n \n - NO (default): MIG cannot change a VM's zone during a\n repair.\n - YES: MIG can select a different zone for the VM during\n a repair.", "enum": [ "NO", "YES" @@ -67439,6 +68165,42 @@ }, "type": "object" }, + "InstanceGroupManagersGetAvailableAcceleratorTopologiesResponse": { + "id": "InstanceGroupManagersGetAvailableAcceleratorTopologiesResponse", + "properties": { + "acceleratorTopologiesInfo": { + "additionalProperties": { + "$ref": "InstanceGroupManagersGetAvailableAcceleratorTopologiesResponseAcceleratorTopologyInfo" + }, + "description": "The accelerator topology information returned per id of the topology\nlocation.", + "type": "object" + } + }, + "type": "object" + }, + "InstanceGroupManagersGetAvailableAcceleratorTopologiesResponseAcceleratorTopologyInfo": { + "id": "InstanceGroupManagersGetAvailableAcceleratorTopologiesResponseAcceleratorTopologyInfo", + "properties": { + "acceleratorTopology": { + "description": "Topology in the format of: \"16x16\", \"4x4x4\", etc.", + "type": "string" + }, + "acceleratorTopologyHealth": { + "enum": [ + "DEGRADED", + "HEALTHY", + "UNHEALTHY" + ], + "enumDescriptions": [ + "All VM are in RUNNING state, but there is an issue with\nthe inter-chip connectivity that makes this part\nof the infrastructure ready to use as a working\ninter-chip connected group only in a degraded mode.\nThis is allowed only for Instances configured with ICI\nresiliency", + "All VM are in RUNNING state, there are no issues with the\ninter-chip connectivity.", + "Some VMs may not be in RUNNING state, or there is an\nissue with the inter-chip connectivity that makes this\npart of the infrastructure unsuitable for forming a\nworking inter-chip connected group." + ], + "type": "string" + } + }, + "type": "object" + }, "InstanceGroupManagersListErrorsResponse": { "id": "InstanceGroupManagersListErrorsResponse", "properties": { @@ -70550,10 +71312,12 @@ "items": { "enum": [ "IF_CROSS_SITE_NETWORK", + "IF_L2_FORWARDING", "IF_MACSEC" ], "enumDescriptions": [ "Cross-Site Networking", + "L2 Interconnect Attachment Forwarding", "Media Access Control security (MACsec)" ], "type": "string" @@ -70718,10 +71482,12 @@ "items": { "enum": [ "IF_CROSS_SITE_NETWORK", + "IF_L2_FORWARDING", "IF_MACSEC" ], "enumDescriptions": [ "Cross-Site Networking", + "L2 Interconnect Attachment Forwarding", "Media Access Control security (MACsec)" ], "type": "string" @@ -71019,6 +71785,10 @@ "description": "[Output Only] Type of the resource. Alwayscompute#interconnectAttachment for interconnect attachments.", "type": "string" }, + "l2Forwarding": { + "$ref": "InterconnectAttachmentL2Forwarding", + "description": "L2 Interconnect Attachment related config. This field is required if the\ntype is L2_DEDICATED.\n\nThe configuration specifies how VLAN tags (like dot1q, qinq, or dot1ad)\nwithin L2 packets are mapped to the destination appliances IP addresses.\nThe packet is then encapsulated with the appliance IP address and sent to\nthe edge appliance." + }, "labelFingerprint": { "description": "A fingerprint for the labels being applied to this InterconnectAttachment,\nwhich is essentially a hash of the labels set used for optimistic locking.\nThe fingerprint is initially generated by Compute Engine and changes after\nevery request to modify or update labels. You must always provide an\nup-to-date fingerprint hash in order to update or change labels,\notherwise the request will fail with error412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to\nretrieve an InterconnectAttachment.", "format": "byte", @@ -71134,14 +71904,16 @@ "type": "integer" }, "type": { - "description": "The type of interconnect attachment this is, which can take one of the\nfollowing values:\n \n - DEDICATED: an attachment to a Dedicated Interconnect.\n - PARTNER: an attachment to a Partner Interconnect, created by the\n customer.\n - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by\n the partner.", + "description": "The type of interconnect attachment this is, which can take one of the\nfollowing values:\n \n - DEDICATED: an attachment to a Dedicated Interconnect.\n - PARTNER: an attachment to a Partner Interconnect, created by the\n customer.\n - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by\n the partner.\n\n- L2_DEDICATED: a L2 attachment to a Dedicated Interconnect.", "enum": [ "DEDICATED", + "L2_DEDICATED", "PARTNER", "PARTNER_PROVIDER" ], "enumDescriptions": [ "Attachment to a dedicated interconnect.", + "Attachment to a dedicated interconnect, forwarding L2 packets.", "Attachment to a partner interconnect, created by the customer.", "Attachment to a partner interconnect, created by the partner." ], @@ -71913,6 +72685,88 @@ }, "type": "object" }, + "InterconnectAttachmentL2Forwarding": { + "description": "L2 Interconnect Attachment related configuration.", + "id": "InterconnectAttachmentL2Forwarding", + "properties": { + "applianceMappings": { + "additionalProperties": { + "$ref": "InterconnectAttachmentL2ForwardingApplianceMapping" + }, + "description": "Optional. A map of VLAN tags to appliances and optional inner mapping\nrules. If VLANs are not explicitly mapped to any appliance, the\ndefaultApplianceIpAddress is used.\n\nEach VLAN tag can be a single number or a range of numbers in the range\nof 1 to 4094, e.g., \"1\" or \"4001-4094\". Non-empty and non-overlapping\nVLAN tag ranges are enforced, and violating operations will be rejected.\n\nThe VLAN tags in the Ethernet header must use an ethertype value of\n0x88A8 or 0x8100.", + "type": "object" + }, + "defaultApplianceIpAddress": { + "description": "Optional. A single IPv4 or IPv6 address used as the default destination\nIP when there is no VLAN mapping result found.\n\nUnset field (null-value) indicates the unmatched packet should be\ndropped.", + "type": "string" + }, + "geneveHeader": { + "$ref": "InterconnectAttachmentL2ForwardingGeneveHeader", + "description": "Optional. It represents the structure of a Geneve (Generic Network\nVirtualization Encapsulation) header, as defined in RFC8926. It encapsulates packets from various\nprotocols (e.g., Ethernet, IPv4, IPv6) for use in network virtualization\nenvironments." + }, + "network": { + "description": "Required. Resource URL of the network to which this attachment belongs.", + "type": "string" + }, + "tunnelEndpointIpAddress": { + "description": "Required. A single IPv4 or IPv6 address. This address will be used as the\nsource IP address for packets sent to the appliances, and must be used as\nthe destination IP address for packets that should be sent out through\nthis attachment.", + "type": "string" + } + }, + "type": "object" + }, + "InterconnectAttachmentL2ForwardingApplianceMapping": { + "description": "Two-level VLAN-to-Appliance mapping rule.", + "id": "InterconnectAttachmentL2ForwardingApplianceMapping", + "properties": { + "applianceIpAddress": { + "description": "Optional. A single IPv4 or IPv6 address used as the destination IP\naddress for ingress packets that match on a VLAN tag, but do not match\na more specific inner VLAN tag.\n\nUnset field (null-value) indicates both VLAN tags are required to be\nmapped. Otherwise, defaultApplianceIpAddress is used.", + "type": "string" + }, + "innerVlanToApplianceMappings": { + "description": "Optional. Used to match against the inner VLAN when the packet\ncontains two VLAN tags.\n\nA list of mapping rules from inner VLAN tags to IP addresses. If the\ninner VLAN is not explicitly mapped to an IP address range, the\napplianceIpAddress is used.", + "items": { + "$ref": "InterconnectAttachmentL2ForwardingApplianceMappingInnerVlanToApplianceMapping" + }, + "type": "array" + }, + "name": { + "description": "Optional. The name of this appliance mapping rule.", + "type": "string" + } + }, + "type": "object" + }, + "InterconnectAttachmentL2ForwardingApplianceMappingInnerVlanToApplianceMapping": { + "description": "The inner VLAN-to-Appliance mapping.", + "id": "InterconnectAttachmentL2ForwardingApplianceMappingInnerVlanToApplianceMapping", + "properties": { + "innerApplianceIpAddress": { + "description": "Required in this object. A single IPv4 or IPv6 address used as the\ndestination IP address for ingress packets that match on both VLAN\ntags.", + "type": "string" + }, + "innerVlanTags": { + "description": "Required in this object. Used to match the inner VLAN tag on the\npacket. Each entry can be a single number or a range of numbers in\nthe range of 1 to 4094, e.g., [\"1\", \"4001-4094\"] is valid. Non-empty\nand Non-overlapping VLAN tag ranges are enforced, and violating\noperations will be rejected.\n\nThe inner VLAN tags must have an ethertype value of 0x8100.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "InterconnectAttachmentL2ForwardingGeneveHeader": { + "description": "GeneveHeader related configurations.", + "id": "InterconnectAttachmentL2ForwardingGeneveHeader", + "properties": { + "vni": { + "description": "Optional. VNI is a 24-bit unique virtual network identifier, from 0 to\n16,777,215.", + "format": "uint32", + "type": "integer" + } + }, + "type": "object" + }, "InterconnectAttachmentList": { "description": "Response to the list request, and contains a list of interconnect\nattachments.", "id": "InterconnectAttachmentList", @@ -72467,7 +73321,7 @@ "type": "string" }, "etag": { - "description": "Opaque system-generated token that uniquely identifies the configuration.\nIf provided when patching a configuration in update mode, the provided\ntoken must match the current token or the update is rejected. This provides\na reliable means of doing read-modify-write (optimistic locking) as\ndescribed byAPI 154.", + "description": "Opaque system-generated token that uniquely identifies the configuration.\nIf provided when patching a configuration in update mode, the provided\ntoken must match the current token or the update is rejected. This provides\na reliable means of doing read-modify-write (optimistic locking) as\ndescribed by AIP 154.", "type": "string" }, "id": { @@ -72803,10 +73657,12 @@ "items": { "enum": [ "IF_CROSS_SITE_NETWORK", + "IF_L2_FORWARDING", "IF_MACSEC" ], "enumDescriptions": [ "Cross-Site Networking", + "L2 Interconnect Attachment Forwarding", "Media Access Control security (MACsec)" ], "type": "string" @@ -73252,10 +74108,12 @@ "items": { "enum": [ "IF_CROSS_SITE_NETWORK", + "IF_L2_FORWARDING", "IF_MACSEC" ], "enumDescriptions": [ "Cross-Site Networking", + "L2 Interconnect Attachment Forwarding", "Media Access Control security (MACsec)" ], "type": "string" @@ -73564,6 +74422,10 @@ "format": "int64", "type": "string" }, + "l2ForwardingEnabled": { + "description": "Identifies whether L2 Interconnect Attachments can be created in this\nregion for interconnects that are in this location.", + "type": "boolean" + }, "locationPresence": { "description": "Identifies the network presence of this location.", "enum": [ @@ -79861,6 +80723,18 @@ ], "type": "string" }, + "allowMulticast": { + "description": "Specifies whether multicast is allowed.", + "enum": [ + "MULTICAST_ALLOWED", + "MULTICAST_BLOCKED" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, "allowNcc": { "description": "Specifies whether NCC is allowed.", "enum": [ @@ -80018,6 +80892,18 @@ }, "type": "array" }, + "multicast": { + "description": "Specifies which type of multicast is supported.", + "enum": [ + "MULTICAST_SDN", + "MULTICAST_ULL" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, "subnetPurposes": { "description": "Specifies which subnetwork purposes are supported.", "items": { @@ -89469,6 +90355,10 @@ "description": "Represents a reservation subBlock resource.", "id": "ReservationSubBlock", "properties": { + "acceleratorTopologiesInfo": { + "$ref": "AcceleratorTopologiesInfo", + "description": "[Output Only] Slice info for the reservation subBlock." + }, "count": { "description": "[Output Only] The number of hosts that are allocated in this\nreservation subBlock.", "format": "int32", @@ -89817,12 +90707,14 @@ "FAULT_BEHAVIOR_UNSPECIFIED", "GPU_ERROR", "PERFORMANCE", + "SILENT_DATA_CORRUPTION", "SWITCH_FAILURE" ], "enumDescriptions": [ "", "The subBlock experienced a GPU error.", "The subBlock experienced performance issues.", + "The subBlock experienced silent data corruption.", "The subBlock experienced a switch failure." ], "type": "string" @@ -90486,6 +91378,18 @@ "description": "A GroupPlacementPolicy specifies resource placement configuration.\nIt specifies the failure bucket separation", "id": "ResourcePolicyGroupPlacementPolicy", "properties": { + "acceleratorTopologyMode": { + "description": "Specifies the connection mode for the accelerator topology. If not\nspecified, the default is AUTO_CONNECT.", + "enum": [ + "AUTO_CONNECT", + "PROVISION_ONLY" + ], + "enumDescriptions": [ + "The interconnected chips are pre-configured at the time of VM creation.", + "The interconnected chips are connected on demand. At the time of VM\ncreation, the chips are not connected." + ], + "type": "string" + }, "availabilityDomainCount": { "description": "The number of availability domains to spread instances across. If two\ninstances are in different availability domain, they are not in the same\nlow latency network.", "format": "int32", @@ -91274,7 +92178,7 @@ "type": "integer" }, "routeStatus": { - "description": "[Output only] The status of the route.", + "description": "[Output only] The status of the route. This status only applies to\ndynamic routes learned by Cloud Routers. This status is not applicable\nto static routes.", "enum": [ "ACTIVE", "DROPPED", @@ -96400,6 +97304,14 @@ "description": "A Shielded Instance Identity.", "id": "ShieldedInstanceIdentity", "properties": { + "eccP256EncryptionKey": { + "$ref": "ShieldedInstanceIdentityEntry", + "description": "An Endorsement Key (EK) made by the ECC P256 algorithm\nissued to the Shielded Instance's vTPM." + }, + "eccP256SigningKey": { + "$ref": "ShieldedInstanceIdentityEntry", + "description": "An Attestation Key (AK) made by the ECC P256 algorithm\nissued to the Shielded Instance's vTPM." + }, "encryptionKey": { "$ref": "ShieldedInstanceIdentityEntry", "description": "An Endorsement Key (EK) made by the RSA 2048 algorithm\nissued to the Shielded Instance's vTPM." @@ -105357,6 +106269,7 @@ "FAILURE_NETWORK", "FAILURE_NVLINK", "FAILURE_REDUNDANT_HARDWARE_FAULT", + "FAILURE_TPU", "INFRASTRUCTURE_RELOCATION", "MAINTENANCE_REASON_UNKNOWN", "PLANNED_NETWORK_UPDATE", @@ -105375,6 +106288,7 @@ "Maintenance due to network errors.", "Maintenance due to NVLink failure.", "Maintenance due to redundant hardware fault.", + "Maintenance due to TPU errors.", "Maintenance due to infrastructure relocation.", "Unknown maintenance reason. Do not use this value.", "Maintenance due to planned network update.", @@ -106654,6 +107568,602 @@ }, "type": "object" }, + "VmExtensionPoliciesScopedList": { + "id": "VmExtensionPoliciesScopedList", + "properties": { + "vmExtensionPolicies": { + "description": "List of VmExtensionPolicy resources contained in this scope.", + "items": { + "$ref": "VmExtensionPolicy" + }, + "type": "array" + }, + "warning": { + "description": "Informational warning which replaces the list of\nbackend services when the list is empty.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed\noperation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as\ndeprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as\nexperimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden.\nDeprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the\nnetwork.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite\nthe mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "Quota information is not available to client requests (e.g:\nregions.list).", + "The user attempted to use a resource that requires a TOS they have not\naccepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "VmExtensionPolicy": { + "description": "Represents a VM extension policy.", + "id": "VmExtensionPolicy", + "properties": { + "creationTimestamp": { + "description": "[Output Only] Creation timestamp inRFC3339\ntext format.", + "type": "string" + }, + "description": { + "description": "An optional description of this resource.", + "type": "string" + }, + "extensionPolicies": { + "additionalProperties": { + "$ref": "VmExtensionPolicyExtensionPolicy" + }, + "description": "Required. A map of extension names (e.g., \"cloudops\") to their corresponding policy\nconfigurations.", + "type": "object" + }, + "globalResourceLink": { + "description": "Optional. [Output Only] Link to the global policy that manages this zone policy, if\napplicable.", + "type": "string" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.", + "format": "uint64", + "type": "string" + }, + "instanceSelectors": { + "description": "Optional. Selectors to target VMs for this policy. VMs are selected if they match\n*any* of the provided selectors (logical OR). If this list is empty, the\npolicy applies to all VMs.", + "items": { + "$ref": "VmExtensionPolicyInstanceSelector" + }, + "type": "array" + }, + "kind": { + "default": "compute#vmExtensionPolicy", + "description": "[Output Only] Type of the resource. Alwayscompute#vmExtensionPolicy.", + "type": "string" + }, + "managedByGlobal": { + "description": "Optional. [Output Only] Indicates if this policy is managed by a global policy.", + "type": "boolean" + }, + "name": { + "annotations": { + "required": [ + "compute.zoneVmExtensionPolicies.insert" + ] + }, + "description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?`\nwhich means the first character must be a lowercase letter, and all\nfollowing characters must be a dash, lowercase letter, or digit, except\nthe last character, which cannot be a dash.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, + "priority": { + "description": "Optional. Priority of this policy. Used to resolve conflicts when multiple policies\napply to the same extension.\nThe policy priority is an integer from 0 to 65535, inclusive. Lower\nintegers indicate higher priorities. If you do not specify a priority when\ncreating a rule, it is assigned a priority of 1000. If priorities are\nequal, the policy with the more recent creation timestamp takes precedence.", + "format": "int32", + "type": "integer" + }, + "selfLink": { + "description": "[Output Only] Server-defined fully-qualified URL for this resource.", + "type": "string" + }, + "selfLinkWithId": { + "description": "[Output Only] Server-defined URL for this resource's resource id.", + "type": "string" + }, + "state": { + "description": "Optional. [Output Only] Current state of the policy: ACTIVE or DELETING.", + "enum": [ + "ACTIVE", + "DELETING", + "STATE_UNSPECIFIED" + ], + "enumDescriptions": [ + "The policy is active and applied to matching VMs.\nNewly created VMs that match the policy will also receive the\nextension policy.", + "The policy is in the process of being deleted. After the extension is\nremoved from all matching VMs, the policy will be deleted.", + "Default value. Do not use." + ], + "type": "string" + }, + "updateTimestamp": { + "description": "[Output Only] Update timestamp inRFC3339\ntext format.", + "type": "string" + } + }, + "type": "object" + }, + "VmExtensionPolicyAggregatedListResponse": { + "description": "Response for the aggregated list of VM extension policies.", + "id": "VmExtensionPolicyAggregatedListResponse", + "properties": { + "etag": { + "type": "string" + }, + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "additionalProperties": { + "$ref": "VmExtensionPoliciesScopedList", + "description": "Name of the scope containing this set of VmExtensionPolicies." + }, + "description": "A list of VmExtensionPoliciesScopedList resources.", + "type": "object" + }, + "kind": { + "default": "compute#VmExtensionPolicyAggregatedList", + "description": "[Output Only] Type of resource. Alwayscompute#VmExtensionPolicyAggregatedList for lists of\nVmExtensionPolicies.", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "unreachables": { + "description": "[Output Only] Unreachable resources.", + "items": { + "type": "string" + }, + "type": "array" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed\noperation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as\ndeprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as\nexperimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden.\nDeprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the\nnetwork.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite\nthe mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "Quota information is not available to client requests (e.g:\nregions.list).", + "The user attempted to use a resource that requires a TOS they have not\naccepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "VmExtensionPolicyExtensionPolicy": { + "description": "Configuration for a specific VM extension.", + "id": "VmExtensionPolicyExtensionPolicy", + "properties": { + "pinnedVersion": { + "description": "Optional. The specific version of the extension to install. If not set, the latest\nversion is used.", + "type": "string" + }, + "stringConfig": { + "description": "Optional. String-based configuration data for the extension.", + "type": "string" + } + }, + "type": "object" + }, + "VmExtensionPolicyInstanceSelector": { + "description": "Defines how to select VMs to apply a zone VM extension policy.", + "id": "VmExtensionPolicyInstanceSelector", + "properties": { + "labelSelector": { + "$ref": "VmExtensionPolicyLabelSelector", + "description": "Optional. LabelSelector selects VMs based on their labels." + } + }, + "type": "object" + }, + "VmExtensionPolicyLabelSelector": { + "description": "A LabelSelector is applied to a VM only if it matches all the specified\nlabels.", + "id": "VmExtensionPolicyLabelSelector", + "properties": { + "inclusionLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. A map of key-value pairs representing VM labels.\nVMs must have all of the labels specified in this map to be selected\n(logical AND).\n\ne.g. If the `inclusion_labels` are {(\"key1\", \"value1\"), (\"key2\",\n\"value2\")}, the VM labels must contain both (\"key1\", \"value1\") and\n(\"key2\", \"value2\") to be selected. If the VM labels are (\"key1\",\n\"value1\") and (\"something\", \"else\"), it will not be selected.\n\nIf the map is empty, it's considered a match.", + "type": "object" + } + }, + "type": "object" + }, + "VmExtensionPolicyList": { + "id": "VmExtensionPolicyList", + "properties": { + "etag": { + "description": "[Output Only] Fingerprint of this resource. A hash of the contents stored\nin this object. This field is used in optimistic locking. This field will\nbe ignored when inserting a VmExtensionPolicy. An up-to-date\nfingerprint must be provided in order to update the VmExtensionPolicy.\n\nTo see the latest value of the fingerprint, make a get() request to\nretrieve a VmExtensionPolicy.", + "type": "string" + }, + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "[Output Only] A list of VM extension policy resources.", + "items": { + "$ref": "VmExtensionPolicy" + }, + "type": "array" + }, + "kind": { + "default": "compute#vmExtensionPolicyList", + "description": "Type of resource.", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "unreachables": { + "description": "[Output Only] Unreachable resources.", + "items": { + "type": "string" + }, + "type": "array" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "QUOTA_INFO_UNAVAILABLE", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed\noperation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as\ndeprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as\nexperimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden.\nDeprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the\nnetwork.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite\nthe mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "Quota information is not available to client requests (e.g:\nregions.list).", + "The user attempted to use a resource that requires a TOS they have not\naccepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, "VpnGateway": { "description": "Represents a HA VPN gateway.\n\nHA VPN is a high-availability (HA) Cloud VPN solution that lets you securely\nconnect your on-premises network to your Google Cloud Virtual Private Cloud\nnetwork through an IPsec VPN connection in a single region.\nFor more information about Cloud HA VPN solutions, see\nCloud VPN topologies .", "id": "VpnGateway", diff --git a/discovery/compute-v1.json b/discovery/compute-v1.json index 3e4a603d18..f58e38a5b6 100644 --- a/discovery/compute-v1.json +++ b/discovery/compute-v1.json @@ -126,7 +126,7 @@ "acceleratorTypes": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of accelerator types.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", + "description": "Retrieves an aggregated list of accelerator types.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/acceleratorTypes", "httpMethod": "GET", "id": "compute.acceleratorTypes.aggregatedList", @@ -302,7 +302,7 @@ "addresses": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of addresses.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", + "description": "Retrieves an aggregated list of addresses.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/addresses", "httpMethod": "GET", "id": "compute.addresses.aggregatedList", @@ -713,7 +713,7 @@ "autoscalers": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of autoscalers.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", + "description": "Retrieves an aggregated list of autoscalers.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/autoscalers", "httpMethod": "GET", "id": "compute.autoscalers.aggregatedList", @@ -1609,7 +1609,7 @@ ] }, "aggregatedList": { - "description": "Retrieves the list of all BackendService resources, regional and global,\navailable to the specified project.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", + "description": "Retrieves the list of all BackendService resources, regional and global,\navailable to the specified project.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/backendServices", "httpMethod": "GET", "id": "compute.backendServices.aggregatedList", @@ -2518,7 +2518,7 @@ "diskTypes": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of disk types.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", + "description": "Retrieves an aggregated list of disk types.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/diskTypes", "httpMethod": "GET", "id": "compute.diskTypes.aggregatedList", @@ -2744,7 +2744,7 @@ ] }, "aggregatedList": { - "description": "Retrieves an aggregated list of persistent disks.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", + "description": "Retrieves an aggregated list of persistent disks.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/disks", "httpMethod": "GET", "id": "compute.disks.aggregatedList", @@ -4707,6 +4707,44 @@ "https://www.googleapis.com/auth/compute" ] }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource.", + "flatPath": "projects/{project}/global/firewalls/{resource}/testIamPermissions", + "httpMethod": "POST", + "id": "compute.firewalls.testIamPermissions", + "parameterOrder": [ + "project", + "resource" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/global/firewalls/{resource}/testIamPermissions", + "request": { + "$ref": "TestPermissionsRequest" + }, + "response": { + "$ref": "TestPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, "update": { "description": "Updates the specified firewall rule with the data included in the\nrequest.\nNote that all fields will be updated if using PUT, even fields that are not\nspecified. To update individual fields, please use PATCH instead.", "flatPath": "projects/{project}/global/firewalls/{firewall}", @@ -4754,7 +4792,7 @@ "forwardingRules": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of forwarding rules.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", + "description": "Retrieves an aggregated list of forwarding rules.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/forwardingRules", "httpMethod": "GET", "id": "compute.forwardingRules.aggregatedList", @@ -5169,7 +5207,7 @@ "futureReservations": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of future reservations.\n\nTo prevent failure, recommendation is that you set the\n`returnPartialSuccess` parameter to `true`.", + "description": "Retrieves an aggregated list of future reservations.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/futureReservations", "httpMethod": "GET", "id": "compute.futureReservations.aggregatedList", @@ -17735,7 +17773,7 @@ ] }, "aggregatedList": { - "description": "Retrieves an aggregated list of network firewall policies, listing network\nfirewall policies from all applicable scopes (global and regional) and\ngrouping the results per scope.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", + "description": "Retrieves an aggregated list of network firewall policies, listing network\nfirewall policies from all applicable scopes (global and regional) and\ngrouping the results per scope.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/firewallPolicies", "httpMethod": "GET", "id": "compute.networkFirewallPolicies.aggregatedList", @@ -21880,7 +21918,7 @@ }, "moveDisk": { "deprecated": true, - "description": "Starting September 29, 2025, you can't use the moveDisk API on new\nprojects. To move a disk to a different region or zone, follow the steps in\n[Change the location of a\ndisk](https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd).\n\nProjects that already use the moveDisk API can continue usage until\nSeptember 29, 2026.\n\nStarting November 1, 2025, API responses will include a warning message in\nthe response body about the upcoming deprecation. You can skip the message\nto continue using the service without interruption.", + "description": "Moves a persistent disk from one zone to another.\n*Note*: The moveDisk API will be deprecated on September 29, 2026.\n\nStarting September 29, 2025, you can't use the moveDisk API on new\nprojects. To move a disk to a different region or zone, follow the steps in\n[Change the location of a\ndisk](https://cloud.google.com/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd).\n\nProjects that already use the moveDisk API can continue usage until\nSeptember 29, 2026.\n\nStarting November 1, 2025, API responses will include a warning message in\nthe response body about the upcoming deprecation. You can skip the message\nto continue using the service without interruption.", "flatPath": "projects/{project}/moveDisk", "httpMethod": "POST", "id": "compute.projects.moveDisk", @@ -23672,7 +23710,7 @@ "regionCommitments": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of commitments by region.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", + "description": "Retrieves an aggregated list of commitments by region.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/commitments", "httpMethod": "GET", "id": "compute.regionCommitments.aggregatedList", @@ -31510,6 +31548,63 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. May be empty if no such\npolicy or resource exists.", + "flatPath": "projects/{project}/zones/{zone}/reservations/{parentResource}/reservationBlocks/{resource}/getIamPolicy", + "httpMethod": "GET", + "id": "compute.reservationBlocks.getIamPolicy", + "parameterOrder": [ + "project", + "zone", + "parentResource", + "resource" + ], + "parameters": { + "optionsRequestedPolicyVersion": { + "description": "Requested IAM Policy version.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "parentResource": { + "description": "Name or id of parent resource of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-zA-Z0-9/]{0,255}[a-zA-Z0-9])?", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/reservations/{parentResource}/reservationBlocks/{resource}/getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, "list": { "description": "Retrieves a list of reservation blocks under a single reservation.", "flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks", @@ -31631,6 +31726,113 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource.\nReplaces any existing policy.", + "flatPath": "projects/{project}/zones/{zone}/reservations/{parentResource}/reservationBlocks/{resource}/setIamPolicy", + "httpMethod": "POST", + "id": "compute.reservationBlocks.setIamPolicy", + "parameterOrder": [ + "project", + "zone", + "parentResource", + "resource" + ], + "parameters": { + "parentResource": { + "description": "Name or id of parent resource of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-zA-Z0-9/]{0,255}[a-zA-Z0-9])?", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/reservations/{parentResource}/reservationBlocks/{resource}/setIamPolicy", + "request": { + "$ref": "ZoneSetNestedPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource.", + "flatPath": "projects/{project}/zones/{zone}/reservations/{parentResource}/reservationBlocks/{resource}/testIamPermissions", + "httpMethod": "POST", + "id": "compute.reservationBlocks.testIamPermissions", + "parameterOrder": [ + "project", + "zone", + "parentResource", + "resource" + ], + "parameters": { + "parentResource": { + "description": "Name or id of parent resource of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-zA-Z0-9/]{0,255}[a-zA-Z0-9])?", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/reservations/{parentResource}/reservationBlocks/{resource}/testIamPermissions", + "request": { + "$ref": "TestPermissionsRequest" + }, + "response": { + "$ref": "TestPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] } } }, @@ -31666,6 +31868,21 @@ "required": true, "type": "string" }, + "view": { + "description": "View of the subBlock.", + "enum": [ + "SUB_BLOCK_VIEW_BASIC", + "SUB_BLOCK_VIEW_FULL", + "SUB_BLOCK_VIEW_UNSPECIFIED" + ], + "enumDescriptions": [ + "This view includes basic information about the reservation sub block", + "Includes detailed topology view.", + "The default / unset value. The API will default to the BASIC view." + ], + "location": "query", + "type": "string" + }, "zone": { "description": "Name of the zone for this request. Zone name should conform to RFC1035.", "location": "path", @@ -31683,6 +31900,63 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. May be empty if no such\npolicy or resource exists.", + "flatPath": "projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/getIamPolicy", + "httpMethod": "GET", + "id": "compute.reservationSubBlocks.getIamPolicy", + "parameterOrder": [ + "project", + "zone", + "parentResource", + "resource" + ], + "parameters": { + "optionsRequestedPolicyVersion": { + "description": "Requested IAM Policy version.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "parentResource": { + "description": "Name or id of parent resource of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-zA-Z0-9/]{0,255}[a-zA-Z0-9])?", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, "list": { "description": "Retrieves a list of reservation subBlocks under a single reservation.", "flatPath": "projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks", @@ -31855,13 +32129,120 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource.\nReplaces any existing policy.", + "flatPath": "projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/setIamPolicy", + "httpMethod": "POST", + "id": "compute.reservationSubBlocks.setIamPolicy", + "parameterOrder": [ + "project", + "zone", + "parentResource", + "resource" + ], + "parameters": { + "parentResource": { + "description": "Name or id of parent resource of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-zA-Z0-9/]{0,255}[a-zA-Z0-9])?", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/setIamPolicy", + "request": { + "$ref": "ZoneSetNestedPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource.", + "flatPath": "projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/testIamPermissions", + "httpMethod": "POST", + "id": "compute.reservationSubBlocks.testIamPermissions", + "parameterOrder": [ + "project", + "zone", + "parentResource", + "resource" + ], + "parameters": { + "parentResource": { + "description": "Name or id of parent resource of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-zA-Z0-9/]{0,255}[a-zA-Z0-9])?", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/testIamPermissions", + "request": { + "$ref": "TestPermissionsRequest" + }, + "response": { + "$ref": "TestPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] } } }, "reservations": { "methods": { "aggregatedList": { - "description": "Retrieves an aggregated list of reservations.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.", + "description": "Retrieves an aggregated list of reservations.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", "flatPath": "projects/{project}/aggregated/reservations", "httpMethod": "GET", "id": "compute.reservations.aggregatedList", @@ -36744,6 +37125,20 @@ "format": "int64", "location": "query", "type": "string" + }, + "views": { + "description": "Defines the extra views returned back in the subnetwork resource.\nSupported values:\n \n - WITH_UTILIZATION: Utilization data is included in the\n response.", + "enum": [ + "DEFAULT", + "WITH_UTILIZATION" + ], + "enumDescriptions": [ + "", + "Utilization data is included in the response." + ], + "location": "query", + "repeated": true, + "type": "string" } }, "path": "projects/{project}/aggregated/subnetworks", @@ -42028,7 +42423,7 @@ } } }, - "revision": "20250930", + "revision": "20251019", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -42070,6 +42465,66 @@ }, "type": "object" }, + "AcceleratorTopologiesInfo": { + "description": "Info for accelerator topologies within a densely packed reservation.", + "id": "AcceleratorTopologiesInfo", + "properties": { + "acceleratorTopologyInfos": { + "description": "Info for each accelerator topology.", + "items": { + "$ref": "AcceleratorTopologiesInfoAcceleratorTopologyInfo" + }, + "type": "array" + } + }, + "type": "object" + }, + "AcceleratorTopologiesInfoAcceleratorTopologyInfo": { + "description": "Info for a slice of a given topology.", + "id": "AcceleratorTopologiesInfoAcceleratorTopologyInfo", + "properties": { + "acceleratorTopology": { + "description": "The accelerator topology.", + "type": "string" + }, + "infoPerTopologyStates": { + "description": "Info for each topology state.", + "items": { + "$ref": "AcceleratorTopologiesInfoAcceleratorTopologyInfoInfoPerTopologyState" + }, + "type": "array" + } + }, + "type": "object" + }, + "AcceleratorTopologiesInfoAcceleratorTopologyInfoInfoPerTopologyState": { + "description": "Info for each topology state.", + "id": "AcceleratorTopologiesInfoAcceleratorTopologyInfoInfoPerTopologyState", + "properties": { + "count": { + "description": "The number of accelerator topologies in this state.", + "format": "int32", + "type": "integer" + }, + "state": { + "description": "The state of the accelerator topology.", + "enum": [ + "AVAILABLE", + "RUNNING", + "TOPOLOGY_STATE_UNSPECIFIED", + "UNHEALTHY" + ], + "enumDescriptions": [ + "The accelerator topology is available.", + "The accelerator topology is running.", + "The state of the topology is unspecified.", + "The accelerator topology is unhealthy." + ], + "type": "string" + } + }, + "type": "object" + }, "AcceleratorType": { "description": "Represents an Accelerator Type resource.\n\nGoogle Cloud Platform provides graphics processing units (accelerators) that\nyou can add to VM instances to improve or accelerate performance when working\nwith intensive workloads. For more information, readGPUs on Compute Engine.", "id": "AcceleratorType", @@ -44983,7 +45438,7 @@ "id": "BackendBucketCdnPolicyNegativeCachingPolicy", "properties": { "code": { - "description": "The HTTP status code to define a TTL against. Only HTTP status codes\n300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be\nspecified as values, and you cannot specify a status code more than\nonce.", + "description": "The HTTP status code to define a TTL against. Only HTTP status codes\n300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be\nspecified as values, and you cannot specify a status code more than\nonce.", "format": "int32", "type": "integer" }, @@ -45188,7 +45643,7 @@ "type": "number" }, "name": { - "description": "Name of a custom utilization signal. The name must be 1-64 characters\nlong and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, period, underscore, lowercase letter, or\ndigit, except the last character, which cannot be a dash, period, or\nunderscore. For usage guidelines, see Custom Metrics balancing mode. This\nfield can only be used for a global or regional backend service with the\nloadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.", + "description": "Name of a custom utilization signal. The name must be 1-64 characters\nlong and match the regular expression\n`[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, period, underscore, lowercase letter, or\ndigit, except the last character, which cannot be a dash, period, or\nunderscore. For usage guidelines, see Custom Metrics balancing mode. This\nfield can only be used for a global or regional backend service with the\nloadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.", "type": "string" } }, @@ -45810,7 +46265,7 @@ "id": "BackendServiceCdnPolicyNegativeCachingPolicy", "properties": { "code": { - "description": "The HTTP status code to define a TTL against. Only HTTP status codes\n300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be\nspecified as values, and you cannot specify a status code more than\nonce.", + "description": "The HTTP status code to define a TTL against. Only HTTP status codes\n300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be\nspecified as values, and you cannot specify a status code more than\nonce.", "format": "int32", "type": "integer" }, @@ -45875,7 +46330,7 @@ "type": "boolean" }, "name": { - "description": "Name of a custom utilization signal. The name must be 1-64 characters\nlong and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, period, underscore, lowercase letter, or\ndigit, except the last character, which cannot be a dash, period, or\nunderscore. For usage guidelines, see Custom Metrics balancing mode. This\nfield can only be used for a global or regional backend service with the\nloadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.", + "description": "Name of a custom utilization signal. The name must be 1-64 characters\nlong and match the regular expression\n`[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, period, underscore, lowercase letter, or\ndigit, except the last character, which cannot be a dash, period, or\nunderscore. For usage guidelines, see Custom Metrics balancing mode. This\nfield can only be used for a global or regional backend service with the\nloadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.", "type": "string" } }, @@ -52293,6 +52748,20 @@ ], "type": "string" }, + "reservationMode": { + "description": "The reservation mode which determines reservation-termination behavior and\nexpected pricing.", + "enum": [ + "CALENDAR", + "DEFAULT", + "RESERVATION_MODE_UNSPECIFIED" + ], + "enumDescriptions": [ + "The delivered reservations will delivered at specified start time and\nterminated at specified end time along with terminating the VMs running\non it.", + "The delivered reservations do not terminate VMs at the end of\nreservations. This is default mode.", + "" + ], + "type": "string" + }, "reservationName": { "description": "Name of reservations where the capacity is provisioned at the time of\ndelivery of future reservations. If the reservation with the given name\ndoes not exist already, it is created automatically at the time of Approval\nwith INACTIVE state till specified start-time. Either provide the\nreservation_name or a name_prefix.", "type": "string" @@ -53107,6 +53576,35 @@ }, "type": "object" }, + "GRPCTLSHealthCheck": { + "id": "GRPCTLSHealthCheck", + "properties": { + "grpcServiceName": { + "description": "The gRPC service name for the health check. This field is optional. The\nvalue of grpc_service_name has the following meanings by convention: \n\n- Empty service_name means the overall status of all services at the\nbackend. \n\n- Non-empty service_name means the health of that gRPC service, as defined\nby the owner of the service. \n\nThe grpc_service_name can only be ASCII.", + "type": "string" + }, + "port": { + "description": "The TCP port number to which the health check prober sends packets. Valid\nvalues are 1 through 65535.", + "format": "int32", + "type": "integer" + }, + "portSpecification": { + "description": "Specifies how a port is selected for health checking. Can be one of the\nfollowing values: \nUSE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services\nfor passthrough load balancers and backend services for proxy load\nbalancers. Not supported by target pools. The health check supports all\nbackends supported by the backend service provided the backend can be\nhealth checked. For example, GCE_VM_IP network endpoint\ngroups, GCE_VM_IP_PORT network endpoint groups, and instance\ngroup backends. \n USE_NAMED_PORT: Not supported. \nUSE_SERVING_PORT: Provides an indirect method of specifying\nthe health check port by referring to the backend service. Only supported\nby backend services for proxy load balancers. Not supported by target\npools. Not supported by backend services for passthrough load balancers.\nSupports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group\nbackends.\n\nFor GCE_VM_IP_PORT network endpoint group backends, the health\ncheck uses the port number specified for each endpoint in the network\nendpoint group. For instance group backends, the health check uses the\nport number determined by looking up the backend service's named port in\nthe instance group's list of named ports.", + "enum": [ + "USE_FIXED_PORT", + "USE_NAMED_PORT", + "USE_SERVING_PORT" + ], + "enumDescriptions": [ + "The port number in the health check's port is used for health\nchecking. Applies to network endpoint group and instance group backends.", + "Not supported.", + "For network endpoint group backends, the health check uses the port number\nspecified on each endpoint in the network endpoint group. For instance\ngroup backends, the health check uses the port number specified for the\nbackend service's named port defined in the instance group's named ports." + ], + "type": "string" + } + }, + "type": "object" + }, "GlobalAddressesMoveRequest": { "id": "GlobalAddressesMoveRequest", "properties": { @@ -53552,6 +54050,9 @@ "grpcHealthCheck": { "$ref": "GRPCHealthCheck" }, + "grpcTlsHealthCheck": { + "$ref": "GRPCTLSHealthCheck" + }, "healthyThreshold": { "description": "A so-far unhealthy instance will be marked healthy after this\nmany consecutive successes. The default value is 2.", "format": "int32", @@ -53615,6 +54116,7 @@ "description": "Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the\nprotocol-specific health check fields must be specified, which must matchtype field.", "enum": [ "GRPC", + "GRPC_WITH_TLS", "HTTP", "HTTP2", "HTTPS", @@ -53629,6 +54131,7 @@ "", "", "", + "", "" ], "type": "string" @@ -60957,10 +61460,12 @@ "items": { "enum": [ "IF_CROSS_SITE_NETWORK", + "IF_L2_FORWARDING", "IF_MACSEC" ], "enumDescriptions": [ "Cross-Site Networking", + "L2 Interconnect Attachment Forwarding", "Media Access Control security (MACsec)" ], "type": "string" @@ -61103,6 +61608,10 @@ ], "type": "string" }, + "params": { + "$ref": "InterconnectParams", + "description": "Input only. [Input Only] Additional params passed with the request, but not persisted\nas part of resource payload." + }, "peerIpAddress": { "description": "[Output Only] IP address configured on the customer side of the\nInterconnect link. The customer should configure this IP address during\nturnup when prompted by Google NOC. This can be used only for ping tests.", "type": "string" @@ -61121,10 +61630,12 @@ "items": { "enum": [ "IF_CROSS_SITE_NETWORK", + "IF_L2_FORWARDING", "IF_MACSEC" ], "enumDescriptions": [ "Cross-Site Networking", + "L2 Interconnect Attachment Forwarding", "Media Access Control security (MACsec)" ], "type": "string" @@ -61406,6 +61917,10 @@ "description": "[Output Only] Type of the resource. Alwayscompute#interconnectAttachment for interconnect attachments.", "type": "string" }, + "l2Forwarding": { + "$ref": "InterconnectAttachmentL2Forwarding", + "description": "L2 Interconnect Attachment related config. This field is required if the\ntype is L2_DEDICATED.\n\nThe configuration specifies how VLAN tags (like dot1q, qinq, or dot1ad)\nwithin L2 packets are mapped to the destination appliances IP addresses.\nThe packet is then encapsulated with the appliance IP address and sent to\nthe edge appliance." + }, "labelFingerprint": { "description": "A fingerprint for the labels being applied to this InterconnectAttachment,\nwhich is essentially a hash of the labels set used for optimistic locking.\nThe fingerprint is initially generated by Compute Engine and changes after\nevery request to modify or update labels. You must always provide an\nup-to-date fingerprint hash in order to update or change labels,\notherwise the request will fail with error412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to\nretrieve an InterconnectAttachment.", "format": "byte", @@ -61444,6 +61959,10 @@ "description": "[Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not\npresent for DEDICATED].\nThe opaque identifier of a PARTNER attachment used to initiate\nprovisioning with a selected partner.\nOf the form \"XXXXX/region/domain\"", "type": "string" }, + "params": { + "$ref": "InterconnectAttachmentParams", + "description": "Input only. [Input Only] Additional params passed with the request, but not persisted\nas part of resource payload." + }, "partnerAsn": { "description": "Optional BGP ASN for the router supplied by a Layer 3 Partner if they\nconfigured BGP on behalf of the customer.\nOutput only for PARTNER type, input only for PARTNER_PROVIDER, not\navailable for DEDICATED.", "format": "int64", @@ -61517,14 +62036,16 @@ "type": "integer" }, "type": { - "description": "The type of interconnect attachment this is, which can take one of the\nfollowing values:\n \n - DEDICATED: an attachment to a Dedicated Interconnect.\n - PARTNER: an attachment to a Partner Interconnect, created by the\n customer.\n - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by\n the partner.", + "description": "The type of interconnect attachment this is, which can take one of the\nfollowing values:\n \n - DEDICATED: an attachment to a Dedicated Interconnect.\n - PARTNER: an attachment to a Partner Interconnect, created by the\n customer.\n - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by\n the partner.\n\n- L2_DEDICATED: a L2 attachment to a Dedicated Interconnect.", "enum": [ "DEDICATED", + "L2_DEDICATED", "PARTNER", "PARTNER_PROVIDER" ], "enumDescriptions": [ "Attachment to a dedicated interconnect.", + "Attachment to a dedicated interconnect, forwarding L2 packets.", "Attachment to a partner interconnect, created by the customer.", "Attachment to a partner interconnect, created by the partner." ], @@ -62296,6 +62817,88 @@ }, "type": "object" }, + "InterconnectAttachmentL2Forwarding": { + "description": "L2 Interconnect Attachment related configuration.", + "id": "InterconnectAttachmentL2Forwarding", + "properties": { + "applianceMappings": { + "additionalProperties": { + "$ref": "InterconnectAttachmentL2ForwardingApplianceMapping" + }, + "description": "Optional. A map of VLAN tags to appliances and optional inner mapping\nrules. If VLANs are not explicitly mapped to any appliance, the\ndefaultApplianceIpAddress is used.\n\nEach VLAN tag can be a single number or a range of numbers in the range\nof 1 to 4094, e.g., \"1\" or \"4001-4094\". Non-empty and non-overlapping\nVLAN tag ranges are enforced, and violating operations will be rejected.\n\nThe VLAN tags in the Ethernet header must use an ethertype value of\n0x88A8 or 0x8100.", + "type": "object" + }, + "defaultApplianceIpAddress": { + "description": "Optional. A single IPv4 or IPv6 address used as the default destination\nIP when there is no VLAN mapping result found.\n\nUnset field (null-value) indicates the unmatched packet should be\ndropped.", + "type": "string" + }, + "geneveHeader": { + "$ref": "InterconnectAttachmentL2ForwardingGeneveHeader", + "description": "Optional. It represents the structure of a Geneve (Generic Network\nVirtualization Encapsulation) header, as defined in RFC8926. It encapsulates packets from various\nprotocols (e.g., Ethernet, IPv4, IPv6) for use in network virtualization\nenvironments." + }, + "network": { + "description": "Required. Resource URL of the network to which this attachment belongs.", + "type": "string" + }, + "tunnelEndpointIpAddress": { + "description": "Required. A single IPv4 or IPv6 address. This address will be used as the\nsource IP address for packets sent to the appliances, and must be used as\nthe destination IP address for packets that should be sent out through\nthis attachment.", + "type": "string" + } + }, + "type": "object" + }, + "InterconnectAttachmentL2ForwardingApplianceMapping": { + "description": "Two-level VLAN-to-Appliance mapping rule.", + "id": "InterconnectAttachmentL2ForwardingApplianceMapping", + "properties": { + "applianceIpAddress": { + "description": "Optional. A single IPv4 or IPv6 address used as the destination IP\naddress for ingress packets that match on a VLAN tag, but do not match\na more specific inner VLAN tag.\n\nUnset field (null-value) indicates both VLAN tags are required to be\nmapped. Otherwise, defaultApplianceIpAddress is used.", + "type": "string" + }, + "innerVlanToApplianceMappings": { + "description": "Optional. Used to match against the inner VLAN when the packet\ncontains two VLAN tags.\n\nA list of mapping rules from inner VLAN tags to IP addresses. If the\ninner VLAN is not explicitly mapped to an IP address range, the\napplianceIpAddress is used.", + "items": { + "$ref": "InterconnectAttachmentL2ForwardingApplianceMappingInnerVlanToApplianceMapping" + }, + "type": "array" + }, + "name": { + "description": "Optional. The name of this appliance mapping rule.", + "type": "string" + } + }, + "type": "object" + }, + "InterconnectAttachmentL2ForwardingApplianceMappingInnerVlanToApplianceMapping": { + "description": "The inner VLAN-to-Appliance mapping.", + "id": "InterconnectAttachmentL2ForwardingApplianceMappingInnerVlanToApplianceMapping", + "properties": { + "innerApplianceIpAddress": { + "description": "Required in this object. A single IPv4 or IPv6 address used as the\ndestination IP address for ingress packets that match on both VLAN\ntags.", + "type": "string" + }, + "innerVlanTags": { + "description": "Required in this object. Used to match the inner VLAN tag on the\npacket. Each entry can be a single number or a range of numbers in\nthe range of 1 to 4094, e.g., [\"1\", \"4001-4094\"] is valid. Non-empty\nand Non-overlapping VLAN tag ranges are enforced, and violating\noperations will be rejected.\n\nThe inner VLAN tags must have an ethertype value of 0x8100.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "InterconnectAttachmentL2ForwardingGeneveHeader": { + "description": "GeneveHeader related configurations.", + "id": "InterconnectAttachmentL2ForwardingGeneveHeader", + "properties": { + "vni": { + "description": "Optional. VNI is a 24-bit unique virtual network identifier, from 0 to\n16,777,215.", + "format": "uint32", + "type": "integer" + } + }, + "type": "object" + }, "InterconnectAttachmentList": { "description": "Response to the list request, and contains a list of interconnect\nattachments.", "id": "InterconnectAttachmentList", @@ -62451,6 +63054,20 @@ }, "type": "object" }, + "InterconnectAttachmentParams": { + "description": "Additional interconnect attachment parameters.", + "id": "InterconnectAttachmentParams", + "properties": { + "resourceManagerTags": { + "additionalProperties": { + "type": "string" + }, + "description": "Tag keys/values directly bound to this resource.\nTag keys and values have the same definition as resource\nmanager tags. The field is allowed for INSERT\nonly. The keys/values to set on the resource should be specified in\neither ID { : } or Namespaced format\n{ : }.\nFor example the following are valid inputs:\n* {\"tagKeys/333\" : \"tagValues/444\", \"tagKeys/123\" : \"tagValues/456\"}\n* {\"123/environment\" : \"production\", \"345/abc\" : \"xyz\"}\nNote:\n* Invalid combinations of ID & namespaced format is not supported. For\n instance: {\"123/environment\" : \"tagValues/444\"} is invalid.\n* Inconsistent format is not supported. For instance:\n {\"tagKeys/333\" : \"tagValues/444\", \"123/env\" : \"prod\"} is invalid.", + "type": "object" + } + }, + "type": "object" + }, "InterconnectAttachmentPartnerMetadata": { "description": "Informational metadata about Partner attachments from Partners to display\nto customers. These fields are propagated from PARTNER_PROVIDER\nattachments to their corresponding PARTNER attachments.", "id": "InterconnectAttachmentPartnerMetadata", @@ -62836,7 +63453,7 @@ "type": "string" }, "etag": { - "description": "Opaque system-generated token that uniquely identifies the configuration.\nIf provided when patching a configuration in update mode, the provided\ntoken must match the current token or the update is rejected. This provides\na reliable means of doing read-modify-write (optimistic locking) as\ndescribed byAPI 154.", + "description": "Opaque system-generated token that uniquely identifies the configuration.\nIf provided when patching a configuration in update mode, the provided\ntoken must match the current token or the update is rejected. This provides\na reliable means of doing read-modify-write (optimistic locking) as\ndescribed by AIP 154.", "type": "string" }, "id": { @@ -63172,10 +63789,12 @@ "items": { "enum": [ "IF_CROSS_SITE_NETWORK", + "IF_L2_FORWARDING", "IF_MACSEC" ], "enumDescriptions": [ "Cross-Site Networking", + "L2 Interconnect Attachment Forwarding", "Media Access Control security (MACsec)" ], "type": "string" @@ -63621,10 +64240,12 @@ "items": { "enum": [ "IF_CROSS_SITE_NETWORK", + "IF_L2_FORWARDING", "IF_MACSEC" ], "enumDescriptions": [ "Cross-Site Networking", + "L2 Interconnect Attachment Forwarding", "Media Access Control security (MACsec)" ], "type": "string" @@ -63933,6 +64554,10 @@ "format": "int64", "type": "string" }, + "l2ForwardingEnabled": { + "description": "Identifies whether L2 Interconnect Attachments can be created in this\nregion for interconnects that are in this location.", + "type": "boolean" + }, "locationPresence": { "description": "Identifies the network presence of this location.", "enum": [ @@ -64104,6 +64729,20 @@ }, "type": "object" }, + "InterconnectParams": { + "description": "Additional interconnect parameters.", + "id": "InterconnectParams", + "properties": { + "resourceManagerTags": { + "additionalProperties": { + "type": "string" + }, + "description": "Tag keys/values directly bound to this resource.\nTag keys and values have the same definition as resource\nmanager tags. The field is allowed for INSERT\nonly. The keys/values to set on the resource should be specified in\neither ID { : } or Namespaced format\n{ : }.\nFor example the following are valid inputs:\n* {\"tagKeys/333\" : \"tagValues/444\", \"tagKeys/123\" : \"tagValues/456\"}\n* {\"123/environment\" : \"production\", \"345/abc\" : \"xyz\"}\nNote:\n* Invalid combinations of ID & namespaced format is not supported. For\n instance: {\"123/environment\" : \"tagValues/444\"} is invalid.\n* Inconsistent format is not supported. For instance:\n {\"tagKeys/333\" : \"tagValues/444\", \"123/env\" : \"prod\"} is invalid.", + "type": "object" + } + }, + "type": "object" + }, "InterconnectRemoteLocation": { "description": "Represents a Cross-Cloud Interconnect Remote Location resource.\n\nYou can use this resource to find remote location details about an\nInterconnect attachment (VLAN).", "id": "InterconnectRemoteLocation", @@ -68326,6 +68965,18 @@ "format": "byte", "type": "string" }, + "igmpQuery": { + "description": "Indicate whether igmp query is enabled on the network interface\nor not. If enabled, also indicates the version of IGMP supported.", + "enum": [ + "IGMP_QUERY_DISABLED", + "IGMP_QUERY_V2" + ], + "enumDescriptions": [ + "The network interface has disabled IGMP query.", + "The network interface has enabled IGMP query - v2." + ], + "type": "string" + }, "internalIpv6PrefixLength": { "description": "The prefix length of the primary internal IPv6 range.", "format": "int32", @@ -69040,6 +69691,18 @@ ], "type": "string" }, + "allowMulticast": { + "description": "Specifies whether multicast is allowed.", + "enum": [ + "MULTICAST_ALLOWED", + "MULTICAST_BLOCKED" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, "allowNcc": { "description": "Specifies whether NCC is allowed.", "enum": [ @@ -69183,6 +69846,18 @@ }, "type": "array" }, + "multicast": { + "description": "Specifies which type of multicast is supported.", + "enum": [ + "MULTICAST_SDN", + "MULTICAST_ULL" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, "subnetPurposes": { "description": "Specifies which subnetwork purposes are supported.", "items": { @@ -77513,6 +78188,20 @@ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, + "protectionTier": { + "description": "Protection tier for the workload which specifies the workload expectations\nin the event of infrastructure failures at data center (e.g. power\nand/or cooling failures).", + "enum": [ + "CAPACITY_OPTIMIZED", + "PROTECTION_TIER_UNSPECIFIED", + "STANDARD" + ], + "enumDescriptions": [ + "CAPACITY_OPTIMIZED capacity leverages redundancies (e.g. power, cooling)\nat the data center during normal operating conditions. In the event of\ninfrastructure failures at data center (e.g. power and/or cooling\nfailures), this workload may be disrupted. As a consequence, it has a\nweaker availability SLO than STANDARD.", + "Unspecified protection tier.", + "STANDARD protection for workload that should be protected by redundancies\n(e.g. power, cooling) at the data center level. In the event of\ninfrastructure failures at data center (e.g. power and/or cooling\nfailures), this workload is expected to continue as normal using the\nredundancies." + ], + "type": "string" + }, "reservationSharingPolicy": { "$ref": "AllocationReservationSharingPolicy", "description": "Specify the reservation sharing policy. If unspecified, the reservation\nwill not be shared with Google Cloud managed services." @@ -78300,6 +78989,10 @@ "description": "Represents a reservation subBlock resource.", "id": "ReservationSubBlock", "properties": { + "acceleratorTopologiesInfo": { + "$ref": "AcceleratorTopologiesInfo", + "description": "[Output Only] Slice info for the reservation subBlock." + }, "count": { "description": "[Output Only] The number of hosts that are allocated in this\nreservation subBlock.", "format": "int32", @@ -78643,12 +79336,14 @@ "FAULT_BEHAVIOR_UNSPECIFIED", "GPU_ERROR", "PERFORMANCE", + "SILENT_DATA_CORRUPTION", "SWITCH_FAILURE" ], "enumDescriptions": [ "", "The subBlock experienced a GPU error.", "The subBlock experienced performance issues.", + "The subBlock experienced silent data corruption.", "The subBlock experienced a switch failure." ], "type": "string" @@ -80001,7 +80696,7 @@ "type": "integer" }, "routeStatus": { - "description": "[Output only] The status of the route.", + "description": "[Output only] The status of the route. This status only applies to\ndynamic routes learned by Cloud Routers. This status is not applicable\nto static routes.", "enum": [ "ACTIVE", "DROPPED", @@ -84857,6 +85552,14 @@ "description": "A Shielded Instance Identity.", "id": "ShieldedInstanceIdentity", "properties": { + "eccP256EncryptionKey": { + "$ref": "ShieldedInstanceIdentityEntry", + "description": "An Endorsement Key (EK) made by the ECC P256 algorithm\nissued to the Shielded Instance's vTPM." + }, + "eccP256SigningKey": { + "$ref": "ShieldedInstanceIdentityEntry", + "description": "An Attestation Key (AK) made by the ECC P256 algorithm\nissued to the Shielded Instance's vTPM." + }, "encryptionKey": { "$ref": "ShieldedInstanceIdentityEntry", "description": "An Endorsement Key (EK) made by the RSA 2048 algorithm\nissued to the Shielded Instance's vTPM." @@ -93197,6 +93900,7 @@ "FAILURE_NETWORK", "FAILURE_NVLINK", "FAILURE_REDUNDANT_HARDWARE_FAULT", + "FAILURE_TPU", "INFRASTRUCTURE_RELOCATION", "MAINTENANCE_REASON_UNKNOWN", "PLANNED_NETWORK_UPDATE", @@ -93215,6 +93919,7 @@ "Maintenance due to network errors.", "Maintenance due to NVLink failure.", "Maintenance due to redundant hardware fault.", + "Maintenance due to TPU errors.", "Maintenance due to infrastructure relocation.", "Unknown maintenance reason. Do not use this value.", "Maintenance due to planned network update.", @@ -96685,6 +97390,28 @@ }, "type": "object" }, + "ZoneSetNestedPolicyRequest": { + "id": "ZoneSetNestedPolicyRequest", + "properties": { + "bindings": { + "description": "Flatten Policy to create a backwacd compatible wire-format.\nDeprecated. Use 'policy' to specify bindings.", + "items": { + "$ref": "Binding" + }, + "type": "array" + }, + "etag": { + "description": "Flatten Policy to create a backward compatible wire-format.\nDeprecated. Use 'policy' to specify the etag.", + "format": "byte", + "type": "string" + }, + "policy": { + "$ref": "Policy", + "description": "REQUIRED: The complete policy to be applied to the 'resource'. The size of\nthe policy is limited to a few 10s of KB. An empty policy is in general a\nvalid policy but certain services (like Projects) might reject them." + } + }, + "type": "object" + }, "ZoneSetPolicyRequest": { "id": "ZoneSetPolicyRequest", "properties": { diff --git a/discovery/contactcenteraiplatform-v1alpha1.json b/discovery/contactcenteraiplatform-v1alpha1.json index a3634ebf28..1522abe743 100644 --- a/discovery/contactcenteraiplatform-v1alpha1.json +++ b/discovery/contactcenteraiplatform-v1alpha1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -523,7 +523,7 @@ } } }, - "revision": "20250925", + "revision": "20251022", "rootUrl": "https://contactcenteraiplatform.googleapis.com/", "schemas": { "AdminUser": { diff --git a/discovery/contactcenterinsights-v1.json b/discovery/contactcenterinsights-v1.json index 9a5d6cd8e8..b1ed5dd350 100644 --- a/discovery/contactcenterinsights-v1.json +++ b/discovery/contactcenterinsights-v1.json @@ -1215,34 +1215,6 @@ "resources": { "conversations": { "methods": { - "bulkAnalyze": { - "description": "Analyzes multiple conversations in a single request.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations:bulkAnalyze", - "httpMethod": "POST", - "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.bulkAnalyze", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The parent resource to create analyses in.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/conversations:bulkAnalyze", - "request": { - "$ref": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "calculateStats": { "description": "Gets conversation statistics.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations:calculateStats", @@ -1406,129 +1378,6 @@ } }, "resources": { - "analyses": { - "methods": { - "create": { - "description": "Creates an analysis. The long running operation is done when the analysis has completed.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/analyses", - "httpMethod": "POST", - "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The parent resource of the analysis.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/analyses", - "request": { - "$ref": "GoogleCloudContactcenterinsightsV1Analysis" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes an analysis.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/analyses/{analysesId}", - "httpMethod": "DELETE", - "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the analysis to delete.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/analyses/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets an analysis.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/analyses/{analysesId}", - "httpMethod": "GET", - "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the analysis to get.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/analyses/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleCloudContactcenterinsightsV1Analysis" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists analyses.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/analyses", - "httpMethod": "GET", - "id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of analyses to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The value returned by the last `ListAnalysesResponse`; indicates that this is a continuation of a prior `ListAnalyses` call and the system should return the next page of data.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent resource of the analyses.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/analyses", - "response": { - "$ref": "GoogleCloudContactcenterinsightsV1ListAnalysesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, "assessments": { "methods": { "appeal": { @@ -3140,6 +2989,38 @@ ] } } + }, + "segments": { + "methods": { + "bulkAnalyze": { + "description": "Analyzes multiple conversations in a single request.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/segments:bulkAnalyze", + "httpMethod": "POST", + "id": "contactcenterinsights.projects.locations.conversations.segments.bulkAnalyze", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource to create analyses in.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/segments:bulkAnalyze", + "request": { + "$ref": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } } }, @@ -3432,34 +3313,6 @@ "resources": { "conversations": { "methods": { - "bulkAnalyze": { - "description": "Analyzes multiple conversations in a single request.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:bulkAnalyze", - "httpMethod": "POST", - "id": "contactcenterinsights.projects.locations.datasets.conversations.bulkAnalyze", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The parent resource to create analyses in.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/conversations:bulkAnalyze", - "request": { - "$ref": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "bulkDelete": { "description": "Deletes multiple conversations in a single request.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:bulkDelete", @@ -3705,129 +3558,6 @@ } }, "resources": { - "analyses": { - "methods": { - "create": { - "description": "Creates an analysis. The long running operation is done when the analysis has completed.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/analyses", - "httpMethod": "POST", - "id": "contactcenterinsights.projects.locations.datasets.conversations.analyses.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The parent resource of the analysis.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/analyses", - "request": { - "$ref": "GoogleCloudContactcenterinsightsV1Analysis" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes an analysis.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/analyses/{analysesId}", - "httpMethod": "DELETE", - "id": "contactcenterinsights.projects.locations.datasets.conversations.analyses.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the analysis to delete.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+/analyses/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets an analysis.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/analyses/{analysesId}", - "httpMethod": "GET", - "id": "contactcenterinsights.projects.locations.datasets.conversations.analyses.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the analysis to get.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+/analyses/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleCloudContactcenterinsightsV1Analysis" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists analyses.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/analyses", - "httpMethod": "GET", - "id": "contactcenterinsights.projects.locations.datasets.conversations.analyses.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of analyses to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The value returned by the last `ListAnalysesResponse`; indicates that this is a continuation of a prior `ListAnalyses` call and the system should return the next page of data.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent resource of the analyses.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/analyses", - "response": { - "$ref": "GoogleCloudContactcenterinsightsV1ListAnalysesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, "feedbackLabels": { "methods": { "create": { @@ -5648,7 +5378,7 @@ } } }, - "revision": "20251014", + "revision": "20251023", "rootUrl": "https://contactcenterinsights.googleapis.com/", "schemas": { "GoogleCloudContactcenterinsightsV1Analysis": { @@ -7551,6 +7281,26 @@ "description": "Output only. Metadata about the agent dimension.", "readOnly": true }, + "clientSentimentCategoryDimensionMetadata": { + "$ref": "GoogleCloudContactcenterinsightsV1DimensionClientSentimentCategoryDimensionMetadata", + "description": "Output only. Metadata about the client sentiment category dimension.", + "readOnly": true + }, + "conversationProfileDimensionMetadata": { + "$ref": "GoogleCloudContactcenterinsightsV1DimensionConversationProfileDimensionMetadata", + "description": "Output only. Metadata about the conversation profile dimension.", + "readOnly": true + }, + "conversationalAgentsPlaybookDimensionMetadata": { + "$ref": "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsPlaybookDimensionMetadata", + "description": "Output only. Metadata about the Conversational Agents playbook dimension.", + "readOnly": true + }, + "conversationalAgentsToolDimensionMetadata": { + "$ref": "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsToolDimensionMetadata", + "description": "Output only. Metadata about the Conversational Agents tool dimension.", + "readOnly": true + }, "dimensionKey": { "description": "The key of the dimension.", "enum": [ @@ -7564,6 +7314,11 @@ "QA_SCORECARD_ID", "CONVERSATION_PROFILE_ID", "MEDIUM", + "CONVERSATIONAL_AGENTS_PLAYBOOK_ID", + "CONVERSATIONAL_AGENTS_PLAYBOOK_NAME", + "CONVERSATIONAL_AGENTS_TOOL_ID", + "CONVERSATIONAL_AGENTS_TOOL_NAME", + "CLIENT_SENTIMENT_CATEGORY", "AGENT_VERSION_ID", "AGENT_DEPLOYMENT_ID", "AGENT_ASSIST_SUPERVISOR_ID" @@ -7579,6 +7334,11 @@ "The dimension is keyed by QaScorecardIds. Note that: We only group by the ScorecardId and not the revision-id of the scorecard. This allows for showing stats for the same scorecard across different revisions. This metric is mostly only useful if querying the average normalized score per scorecard.", "The dimension is keyed by the conversation profile ID.", "The dimension is keyed by the conversation medium.", + "The dimension is keyed by the Conversational Agents playbook ID.", + "The dimension is keyed by the Conversational Agents playbook display name.", + "The dimension is keyed by the Conversational Agents tool ID.", + "The dimension is keyed by the Conversational Agents tool display name.", + "The dimension is keyed by the client sentiment category.", "The dimension is keyed by the agent version ID.", "The dimension is keyed by the agent deployment ID.", "The dimension is keyed by the supervisor ID of the assigned human supervisor for virtual agents." @@ -7590,6 +7350,11 @@ "description": "Output only. Metadata about the issue dimension.", "readOnly": true }, + "mediumDimensionMetadata": { + "$ref": "GoogleCloudContactcenterinsightsV1DimensionMediumDimensionMetadata", + "description": "Output only. Metadata about the conversation medium dimension.", + "readOnly": true + }, "qaQuestionAnswerDimensionMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1DimensionQaQuestionAnswerDimensionMetadata", "description": "Output only. Metadata about the QA question-answer dimension.", @@ -7643,6 +7408,58 @@ }, "type": "object" }, + "GoogleCloudContactcenterinsightsV1DimensionClientSentimentCategoryDimensionMetadata": { + "description": "Metadata about the client sentiment category dimension.", + "id": "GoogleCloudContactcenterinsightsV1DimensionClientSentimentCategoryDimensionMetadata", + "properties": { + "sentimentCategory": { + "description": "Optional. The client sentiment category.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1DimensionConversationProfileDimensionMetadata": { + "description": "Metadata about the conversation profile dimension.", + "id": "GoogleCloudContactcenterinsightsV1DimensionConversationProfileDimensionMetadata", + "properties": { + "conversationProfileId": { + "description": "Optional. The conversation profile ID.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsPlaybookDimensionMetadata": { + "description": "Metadata about the Conversational Agents playbook dimension.", + "id": "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsPlaybookDimensionMetadata", + "properties": { + "playbookDisplayName": { + "description": "Optional. The dialogflow playbook display name.", + "type": "string" + }, + "playbookId": { + "description": "Optional. The dialogflow playbook ID.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsToolDimensionMetadata": { + "description": "Metadata about the Conversational Agents tool dimension.", + "id": "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsToolDimensionMetadata", + "properties": { + "toolDisplayName": { + "description": "Optional. The dialogflow tool display name.", + "type": "string" + }, + "toolId": { + "description": "Optional. The dialogflow tool ID.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudContactcenterinsightsV1DimensionIssueDimensionMetadata": { "description": "Metadata about the issue dimension.", "id": "GoogleCloudContactcenterinsightsV1DimensionIssueDimensionMetadata", @@ -7662,6 +7479,17 @@ }, "type": "object" }, + "GoogleCloudContactcenterinsightsV1DimensionMediumDimensionMetadata": { + "description": "Metadata about the conversation medium dimension.", + "id": "GoogleCloudContactcenterinsightsV1DimensionMediumDimensionMetadata", + "properties": { + "medium": { + "description": "Optional. The conversation medium. Currently supports : PHONE_CALL, CHAT.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudContactcenterinsightsV1DimensionQaQuestionAnswerDimensionMetadata": { "description": "Metadata about the QA question-answer dimension. This is useful for showing the answer distribution for questions for a given scorecard.", "id": "GoogleCloudContactcenterinsightsV1DimensionQaQuestionAnswerDimensionMetadata", @@ -9527,16 +9355,12 @@ "enum": [ "PREDEFINED_QUESTION_TYPE_UNSPECIFIED", "CONVERSATION_OUTCOME", - "CONVERSATION_OUTCOME_ESCALATION_INITIATOR_ROLE", - "CONVERSATION_OUTCOME_CUSTOMER_SATISFACTION", - "CONVERSATION_OUTCOME_AGENT_HELPFULNESS" + "CONVERSATION_OUTCOME_ESCALATION_INITIATOR_ROLE" ], "enumDescriptions": [ "The type of the predefined question is unspecified.", "A prebuilt classifier classfying the outcome of the conversation. For example, if the customer issue mentioned in a conversation has been resolved or not.", - "A prebuilt classifier classfying the initiator of the conversation escalation. For example, if it was initiated by the customer or the agent.", - "A prebuilt classifier classfying whether the customer is satisfied with the agent's response.", - "A prebuilt classifier classfying whether the agent is helpful to the customer." + "A prebuilt classifier classfying the initiator of the conversation escalation. For example, if it was initiated by the customer or the agent." ], "type": "string" } @@ -12094,6 +11918,26 @@ "description": "Output only. Metadata about the agent dimension.", "readOnly": true }, + "clientSentimentCategoryDimensionMetadata": { + "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionClientSentimentCategoryDimensionMetadata", + "description": "Output only. Metadata about the client sentiment category dimension.", + "readOnly": true + }, + "conversationProfileDimensionMetadata": { + "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationProfileDimensionMetadata", + "description": "Output only. Metadata about the conversation profile dimension.", + "readOnly": true + }, + "conversationalAgentsPlaybookDimensionMetadata": { + "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsPlaybookDimensionMetadata", + "description": "Output only. Metadata about the Conversational Agents playbook dimension.", + "readOnly": true + }, + "conversationalAgentsToolDimensionMetadata": { + "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsToolDimensionMetadata", + "description": "Output only. Metadata about the Conversational Agents tool dimension.", + "readOnly": true + }, "dimensionKey": { "description": "The key of the dimension.", "enum": [ @@ -12107,6 +11951,11 @@ "QA_SCORECARD_ID", "CONVERSATION_PROFILE_ID", "MEDIUM", + "CONVERSATIONAL_AGENTS_PLAYBOOK_ID", + "CONVERSATIONAL_AGENTS_PLAYBOOK_NAME", + "CONVERSATIONAL_AGENTS_TOOL_ID", + "CONVERSATIONAL_AGENTS_TOOL_NAME", + "CLIENT_SENTIMENT_CATEGORY", "AGENT_VERSION_ID", "AGENT_DEPLOYMENT_ID", "AGENT_ASSIST_SUPERVISOR_ID" @@ -12122,6 +11971,11 @@ "The dimension is keyed by QaScorecardIds. Note that: We only group by the ScorecardId and not the revision-id of the scorecard. This allows for showing stats for the same scorecard across different revisions. This metric is mostly only useful if querying the average normalized score per scorecard.", "The dimension is keyed by the conversation profile ID.", "The dimension is keyed by the conversation medium.", + "The dimension is keyed by the Conversational Agents playbook ID.", + "The dimension is keyed by the Conversational Agents playbook display name.", + "The dimension is keyed by the Conversational Agents tool ID.", + "The dimension is keyed by the Conversational Agents tool display name.", + "The dimension is keyed by the client sentiment category.", "The dimension is keyed by the agent version ID.", "The dimension is keyed by the agent deployment ID.", "The dimension is keyed by the supervisor ID of the assigned human supervisor for virtual agents." @@ -12133,6 +11987,11 @@ "description": "Output only. Metadata about the issue dimension.", "readOnly": true }, + "mediumDimensionMetadata": { + "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionMediumDimensionMetadata", + "description": "Output only. Metadata about the conversation medium dimension.", + "readOnly": true + }, "qaQuestionAnswerDimensionMetadata": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionAnswerDimensionMetadata", "description": "Output only. Metadata about the QA question-answer dimension.", @@ -12186,6 +12045,58 @@ }, "type": "object" }, + "GoogleCloudContactcenterinsightsV1alpha1DimensionClientSentimentCategoryDimensionMetadata": { + "description": "Metadata about the client sentiment category dimension.", + "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionClientSentimentCategoryDimensionMetadata", + "properties": { + "sentimentCategory": { + "description": "Optional. The client sentiment category.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationProfileDimensionMetadata": { + "description": "Metadata about the conversation profile dimension.", + "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationProfileDimensionMetadata", + "properties": { + "conversationProfileId": { + "description": "Optional. The conversation profile ID.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsPlaybookDimensionMetadata": { + "description": "Metadata about the Conversational Agents playbook dimension.", + "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsPlaybookDimensionMetadata", + "properties": { + "playbookDisplayName": { + "description": "Optional. The dialogflow playbook display name.", + "type": "string" + }, + "playbookId": { + "description": "Optional. The dialogflow playbook ID.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsToolDimensionMetadata": { + "description": "Metadata about the Conversational Agents tool dimension.", + "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsToolDimensionMetadata", + "properties": { + "toolDisplayName": { + "description": "Optional. The dialogflow tool display name.", + "type": "string" + }, + "toolId": { + "description": "Optional. The dialogflow tool ID.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudContactcenterinsightsV1alpha1DimensionIssueDimensionMetadata": { "description": "Metadata about the issue dimension.", "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionIssueDimensionMetadata", @@ -12205,6 +12116,17 @@ }, "type": "object" }, + "GoogleCloudContactcenterinsightsV1alpha1DimensionMediumDimensionMetadata": { + "description": "Metadata about the conversation medium dimension.", + "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionMediumDimensionMetadata", + "properties": { + "medium": { + "description": "Optional. The conversation medium. Currently supports : PHONE_CALL, CHAT.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionAnswerDimensionMetadata": { "description": "Metadata about the QA question-answer dimension. This is useful for showing the answer distribution for questions for a given scorecard.", "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionAnswerDimensionMetadata", diff --git a/discovery/container-v1.json b/discovery/container-v1.json index 6296c2ff73..6d4c37836a 100644 --- a/discovery/container-v1.json +++ b/discovery/container-v1.json @@ -176,13 +176,13 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" } @@ -253,7 +253,7 @@ ] }, "create": { - "description": "Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.", + "description": "Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters", "httpMethod": "POST", "id": "container.projects.locations.clusters.create", @@ -304,13 +304,13 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" } @@ -377,13 +377,13 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" } @@ -436,13 +436,13 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "location": "query", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides, or \"-\" for all zones. This field has been deprecated and replaced by the parent field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides, or \"-\" for all zones. This field has been deprecated and replaced by the parent field.", "location": "query", "type": "string" } @@ -513,7 +513,7 @@ }, "setLocations": { "deprecated": true, - "description": "Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead.", + "description": "Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLocations", "httpMethod": "POST", "id": "container.projects.locations.clusters.setLocations", @@ -882,13 +882,13 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" } @@ -961,13 +961,13 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" } @@ -1004,13 +1004,13 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "location": "query", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", "location": "query", "type": "string" } @@ -1247,13 +1247,13 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" } @@ -1284,13 +1284,13 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "location": "query", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field.", "location": "query", "type": "string" } @@ -1325,13 +1325,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1367,13 +1367,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1408,13 +1408,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1432,7 +1432,7 @@ ] }, "create": { - "description": "Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.", + "description": "Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.", "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters", "httpMethod": "POST", "id": "container.projects.zones.clusters.create", @@ -1442,13 +1442,13 @@ ], "parameters": { "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" @@ -1488,13 +1488,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1561,13 +1561,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1599,13 +1599,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1638,13 +1638,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides, or \"-\" for all zones. This field has been deprecated and replaced by the parent field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides, or \"-\" for all zones. This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" @@ -1660,7 +1660,7 @@ }, "locations": { "deprecated": true, - "description": "Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead.", + "description": "Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead.", "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations", "httpMethod": "POST", "id": "container.projects.zones.clusters.locations", @@ -1677,13 +1677,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1718,13 +1718,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1759,13 +1759,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1800,13 +1800,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1841,13 +1841,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1882,13 +1882,13 @@ "type": "string" }, "projectId": { - "description": "Required. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects).", + "description": "Required. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects).", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Required. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides.", + "description": "Required. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides.", "location": "path", "required": true, "type": "string" @@ -1923,13 +1923,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1964,13 +1964,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2005,13 +2005,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2046,13 +2046,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2098,13 +2098,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2139,13 +2139,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" @@ -2192,13 +2192,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2272,13 +2272,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2315,13 +2315,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" @@ -2360,13 +2360,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2408,13 +2408,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2456,13 +2456,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2504,13 +2504,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2551,13 +2551,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2597,13 +2597,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2633,13 +2633,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" @@ -2660,7 +2660,7 @@ } } }, - "revision": "20250930", + "revision": "20251021", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2673,7 +2673,7 @@ "type": "string" }, "acceleratorType": { - "description": "The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus)", + "description": "The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)", "type": "string" }, "gpuDriverInstallationConfig": { @@ -2816,7 +2816,7 @@ "kubernetesDashboard": { "$ref": "KubernetesDashboard", "deprecated": true, - "description": "Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards" + "description": "Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards" }, "lustreCsiDriverConfig": { "$ref": "LustreCsiDriverConfig", @@ -3071,7 +3071,7 @@ "id": "AutoprovisioningNodePoolDefaults", "properties": { "bootDiskKmsKey": { - "description": "The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption", + "description": "The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption", "type": "string" }, "diskSizeGb": { @@ -3084,7 +3084,7 @@ "type": "string" }, "imageType": { - "description": "The image type to use for NAP created node. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.", + "description": "The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.", "type": "string" }, "insecureKubeletReadonlyPortEnabled": { @@ -3097,7 +3097,7 @@ }, "minCpuPlatform": { "deprecated": true, - "description": "Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass \"automatic\" as field value.", + "description": "Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass \"automatic\" as field value.", "type": "string" }, "oauthScopes": { @@ -3301,12 +3301,12 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -3480,7 +3480,7 @@ }, "currentNodeVersion": { "deprecated": true, - "description": "Output only. Deprecated, use [NodePools.version](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.", + "description": "Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.", "readOnly": true, "type": "string" }, @@ -3551,7 +3551,7 @@ }, "initialNodeCount": { "deprecated": true, - "description": "The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a \"node_pool\" object, since this configuration (along with the \"node_config\") will be used to create a \"NodePool\" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.", + "description": "The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a \"node_pool\" object, since this configuration (along with the \"node_config\") will be used to create a \"NodePool\" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.", "format": "int32", "type": "integer" }, @@ -3577,12 +3577,12 @@ "description": "Configuration for the legacy ABAC authorization mode." }, "location": { - "description": "Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", + "description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", "readOnly": true, "type": "string" }, "locations": { - "description": "The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.", + "description": "The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.", "items": { "type": "string" }, @@ -3626,7 +3626,7 @@ "type": "string" }, "network": { - "description": "The name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used.", + "description": "The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used.", "type": "string" }, "networkConfig": { @@ -3760,7 +3760,7 @@ "type": "string" }, "subnetwork": { - "description": "The name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/subnetworks) to which the cluster is connected.", + "description": "The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected.", "type": "string" }, "tpuIpv4CidrBlock": { @@ -3783,7 +3783,7 @@ }, "zone": { "deprecated": true, - "description": "Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.", + "description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.", "readOnly": true, "type": "string" } @@ -3795,7 +3795,7 @@ "id": "ClusterAutoscaling", "properties": { "autoprovisioningLocations": { - "description": "The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.", + "description": "The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.", "items": { "type": "string" }, @@ -3926,7 +3926,7 @@ "enumDescriptions": [ "Default value.", "Use the IPTables implementation based on kube-proxy.", - "Use the eBPF based GKE Dataplane V2 with additional features. See the [GKE Dataplane V2 documentation](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/dataplane-v2) for more." + "Use the eBPF based GKE Dataplane V2 with additional features. See the [GKE Dataplane V2 documentation](https://cloud.google.com/kubernetes-engine/docs/how-to/dataplane-v2) for more." ], "type": "string" }, @@ -4015,7 +4015,7 @@ "description": "The desired L4 Internal Load Balancer Subsetting configuration." }, "desiredLocations": { - "description": "The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed.", + "description": "The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed.", "items": { "type": "string" }, @@ -4294,12 +4294,12 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -4446,7 +4446,7 @@ "properties": { "cluster": { "$ref": "Cluster", - "description": "Required. A [cluster resource](https://{$universe.dns_names.final_documentation_domain}/container-engine/reference/rest/v1/projects.locations.clusters)" + "description": "Required. A [cluster resource](https://cloud.google.com/container-engine/reference/rest/v1/projects.locations.clusters)" }, "parent": { "description": "The parent (project and location) where the cluster will be created. Specified in the format `projects/*/locations/*`.", @@ -4454,12 +4454,12 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", "type": "string" } }, @@ -4484,12 +4484,12 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", "type": "string" } }, @@ -4766,7 +4766,7 @@ "type": "integer" }, "localSsdCount": { - "description": "Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.", + "description": "Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.", "format": "int32", "type": "integer" } @@ -4939,7 +4939,7 @@ "type": "object" }, "GCPSecretManagerCertificateConfig": { - "description": "GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager).", + "description": "GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager).", "id": "GCPSecretManagerCertificateConfig", "properties": { "secretUri": { @@ -5546,6 +5546,10 @@ "$ref": "HugepagesConfig", "description": "Optional. Amounts for 2M and 1G hugepages" }, + "nodeKernelModuleLoading": { + "$ref": "NodeKernelModuleLoading", + "description": "Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification." + }, "sysctls": { "additionalProperties": { "type": "string" @@ -5671,7 +5675,7 @@ "id": "LocalNvmeSsdBlockConfig", "properties": { "localSsdCount": { - "description": "Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.", + "description": "Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.", "format": "int32", "type": "integer" } @@ -5766,6 +5770,18 @@ "description": "Represents the Maintenance exclusion option.", "id": "MaintenanceExclusionOptions", "properties": { + "endTimeBehavior": { + "description": "EndTimeBehavior specifies the behavior of the exclusion end time.", + "enum": [ + "END_TIME_BEHAVIOR_UNSPECIFIED", + "UNTIL_END_OF_SUPPORT" + ], + "enumDescriptions": [ + "END_TIME_BEHAVIOR_UNSPECIFIED is the default behavior, which is fixed end time.", + "UNTIL_END_OF_SUPPORT means the exclusion will be in effect until the end of the support of the cluster's current version." + ], + "type": "string" + }, "scope": { "description": "Scope specifies the upgrade scope which upgrades are blocked by the exclusion.", "enum": [ @@ -5860,12 +5876,12 @@ }, "password": { "deprecated": true, - "description": "The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication", + "description": "The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication", "type": "string" }, "username": { "deprecated": true, - "description": "The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication", + "description": "The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication", "type": "string" } }, @@ -6037,7 +6053,7 @@ "enumDescriptions": [ "Default value.", "Use the IPTables implementation based on kube-proxy.", - "Use the eBPF based GKE Dataplane V2 with additional features. See the [GKE Dataplane V2 documentation](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/dataplane-v2) for more." + "Use the eBPF based GKE Dataplane V2 with additional features. See the [GKE Dataplane V2 documentation](https://cloud.google.com/kubernetes-engine/docs/how-to/dataplane-v2) for more." ], "type": "string" }, @@ -6096,7 +6112,7 @@ "type": "string" }, "network": { - "description": "Output only. The relative name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network", + "description": "Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network", "readOnly": true, "type": "string" }, @@ -6125,7 +6141,7 @@ "description": "ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not." }, "subnetwork": { - "description": "Output only. The relative name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet", + "description": "Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet", "readOnly": true, "type": "string" } @@ -6223,7 +6239,7 @@ "type": "object" }, "NodeAffinity": { - "description": "Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).", + "description": "Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).", "id": "NodeAffinity", "properties": { "key": { @@ -6259,7 +6275,7 @@ "id": "NodeConfig", "properties": { "accelerators": { - "description": "A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.", + "description": "A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.", "items": { "$ref": "AcceleratorConfig" }, @@ -6274,7 +6290,7 @@ "description": "The boot disk configuration for the node pool." }, "bootDiskKmsKey": { - "description": " The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption", + "description": " The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption", "type": "string" }, "confidentialNodes": { @@ -6334,7 +6350,7 @@ "description": "Enable or disable gvnic in the node pool." }, "imageType": { - "description": "The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.", + "description": "The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.", "type": "string" }, "kubeletConfig": { @@ -6357,7 +6373,7 @@ "description": "Parameters for using raw-block Local NVMe SSDs." }, "localSsdCount": { - "description": "The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information.", + "description": "The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.", "format": "int32", "type": "integer" }, @@ -6380,7 +6396,7 @@ "description": "Logging configuration." }, "machineType": { - "description": "The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.", + "description": "The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.", "type": "string" }, "maxRunDuration": { @@ -6396,27 +6412,27 @@ "type": "object" }, "minCpuPlatform": { - "description": "Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: \"Intel Haswell\"` or `minCpuPlatform: \"Intel Sandy Bridge\"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform)", + "description": "Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: \"Intel Haswell\"` or `minCpuPlatform: \"Intel Sandy Bridge\"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)", "type": "string" }, "nodeGroup": { - "description": "Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes).", + "description": "Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).", "type": "string" }, "oauthScopes": { - "description": "The set of Google API scopes to be made available on all of the node VMs under the \"default\" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.", + "description": "The set of Google API scopes to be made available on all of the node VMs under the \"default\" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.", "items": { "type": "string" }, "type": "array" }, "preemptible": { - "description": "Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances.", + "description": "Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.", "type": "boolean" }, "reservationAffinity": { "$ref": "ReservationAffinity", - "description": "The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool." + "description": "The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool." }, "resourceLabels": { "additionalProperties": { @@ -6515,6 +6531,27 @@ }, "type": "object" }, + "NodeKernelModuleLoading": { + "description": "Configuration for kernel module loading on nodes.", + "id": "NodeKernelModuleLoading", + "properties": { + "policy": { + "description": "Set the node module loading policy for nodes in the node pool.", + "enum": [ + "POLICY_UNSPECIFIED", + "ENFORCE_SIGNED_MODULES", + "DO_NOT_ENFORCE_SIGNED_MODULES" + ], + "enumDescriptions": [ + "Default behavior. GKE selects the image based on node type. For CPU and TPU nodes, the image will not allow loading external kernel modules. For GPU nodes, the image will allow loading any module, whether it is signed or not.", + "Enforced signature verification: Node pools will use a Container-Optimized OS image configured to allow loading of *Google-signed* external kernel modules. Loadpin is enabled but configured to exclude modules, and kernel module signature checking is enforced.", + "Mirrors existing DEFAULT behavior: For CPU and TPU nodes, the image will not allow loading external kernel modules. For GPU nodes, the image will allow loading any module, whether it is signed or not." + ], + "type": "string" + } + }, + "type": "object" + }, "NodeKubeletConfig": { "description": "Node kubelet configs.", "id": "NodeKubeletConfig", @@ -6737,12 +6774,12 @@ "type": "string" }, "initialNodeCount": { - "description": "The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.", + "description": "The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.", "format": "int32", "type": "integer" }, "instanceGroupUrls": { - "description": "Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.", + "description": "Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.", "items": { "type": "string" }, @@ -6750,7 +6787,7 @@ "type": "array" }, "locations": { - "description": "The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.", + "description": "The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.", "items": { "type": "string" }, @@ -6830,7 +6867,7 @@ "description": "Upgrade settings control disruption and speed of the upgrade." }, "version": { - "description": "The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version).", + "description": "The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version).", "type": "string" } }, @@ -7084,7 +7121,7 @@ "description": "The error result of the operation in case of failure." }, "location": { - "description": "Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", + "description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", "readOnly": true, "type": "string" }, @@ -7149,21 +7186,21 @@ "Not set.", "The cluster is being created. The cluster should be assumed to be unusable until the operation finishes. In the event of the operation failing, the cluster will enter the ERROR state and eventually be deleted.", "The cluster is being deleted. The cluster should be assumed to be unusable as soon as this operation starts. In the event of the operation failing, the cluster will enter the ERROR state and the deletion will be automatically retried until completed.", - "The cluster version is being updated. Note that this includes \"upgrades\" to the same version, which are simply a recreation. This also includes [auto-upgrades](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/cluster-upgrades#upgrading_automatically). For more details, see [documentation on cluster upgrades](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/cluster-upgrades#cluster_upgrades).", - "A node pool is being updated. Despite calling this an \"upgrade\", this includes most forms of updates to node pools. This also includes [auto-upgrades](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/node-auto-upgrades). This operation sets the progress field and may be canceled. The upgrade strategy depends on [node pool configuration](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-pool-upgrade-strategies). The nodes are generally still usable during this operation.", - "A problem has been detected with the control plane and is being repaired. This operation type is initiated by GKE. For more details, see [documentation on repairs](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions#repairs).", - "The cluster is being updated. This is a broad category of operations and includes operations that only change metadata as well as those that must recreate the entire cluster. If the control plane must be recreated, this will cause temporary downtime for zonal clusters. Some features require recreating the nodes as well. Those will be recreated as separate operations and the update may not be completely functional until the node pools recreations finish. Node recreations will generally follow [maintenance policies](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions). Some GKE-initiated operations use this type. This includes certain types of auto-upgrades and incident mitigations.", - "A node pool is being created. The node pool should be assumed to be unusable until this operation finishes. In the event of an error, the node pool may be partially created. If enabled, [node autoprovisioning](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/node-auto-provisioning) may have automatically initiated such operations.", + "The cluster version is being updated. Note that this includes \"upgrades\" to the same version, which are simply a recreation. This also includes [auto-upgrades](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-upgrades#upgrading_automatically). For more details, see [documentation on cluster upgrades](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-upgrades#cluster_upgrades).", + "A node pool is being updated. Despite calling this an \"upgrade\", this includes most forms of updates to node pools. This also includes [auto-upgrades](https://cloud.google.com/kubernetes-engine/docs/how-to/node-auto-upgrades). This operation sets the progress field and may be canceled. The upgrade strategy depends on [node pool configuration](https://cloud.google.com/kubernetes-engine/docs/concepts/node-pool-upgrade-strategies). The nodes are generally still usable during this operation.", + "A problem has been detected with the control plane and is being repaired. This operation type is initiated by GKE. For more details, see [documentation on repairs](https://cloud.google.com/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions#repairs).", + "The cluster is being updated. This is a broad category of operations and includes operations that only change metadata as well as those that must recreate the entire cluster. If the control plane must be recreated, this will cause temporary downtime for zonal clusters. Some features require recreating the nodes as well. Those will be recreated as separate operations and the update may not be completely functional until the node pools recreations finish. Node recreations will generally follow [maintenance policies](https://cloud.google.com/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions). Some GKE-initiated operations use this type. This includes certain types of auto-upgrades and incident mitigations.", + "A node pool is being created. The node pool should be assumed to be unusable until this operation finishes. In the event of an error, the node pool may be partially created. If enabled, [node autoprovisioning](https://cloud.google.com/kubernetes-engine/docs/how-to/node-auto-provisioning) may have automatically initiated such operations.", "The node pool is being deleted. The node pool should be assumed to be unusable as soon as this operation starts.", "The node pool's manamagent field is being updated. These operations only update metadata and may be concurrent with most other operations.", - "A problem has been detected with nodes and [they are being repaired](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/node-auto-repair). This operation type is initiated by GKE, typically automatically. This operation may be concurrent with other operations and there may be multiple repairs occurring on the same node pool.", + "A problem has been detected with nodes and [they are being repaired](https://cloud.google.com/kubernetes-engine/docs/how-to/node-auto-repair). This operation type is initiated by GKE, typically automatically. This operation may be concurrent with other operations and there may be multiple repairs occurring on the same node pool.", "Unused. Automatic node upgrade uses UPGRADE_NODES.", "Unused. Updating labels uses UPDATE_CLUSTER.", "Unused. Updating master auth uses UPDATE_CLUSTER.", "The node pool is being resized. With the exception of resizing to or from size zero, the node pool is generally usable during this operation.", "Unused. Updating network policy uses UPDATE_CLUSTER.", "Unused. Updating maintenance policy uses UPDATE_CLUSTER.", - "The control plane is being resized. This operation type is initiated by GKE. These operations are often performed preemptively to ensure that the control plane has sufficient resources and is not typically an indication of issues. For more details, see [documentation on resizes](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions#repairs).", + "The control plane is being resized. This operation type is initiated by GKE. These operations are often performed preemptively to ensure that the control plane has sufficient resources and is not typically an indication of issues. For more details, see [documentation on resizes](https://cloud.google.com/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions#repairs).", "Fleet features of GKE Enterprise are being upgraded. The cluster should be assumed to be blocked for other upgrades until the operation finishes." ], "readOnly": true, @@ -7216,7 +7253,7 @@ }, "zone": { "deprecated": true, - "description": "Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.", + "description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.", "readOnly": true, "type": "string" } @@ -7324,7 +7361,7 @@ "type": "string" }, "tpuTopology": { - "description": "Optional. TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies", + "description": "Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies", "type": "string" }, "type": { @@ -7650,7 +7687,7 @@ "type": "object" }, "ReservationAffinity": { - "description": "[ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from.", + "description": "[ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from.", "id": "ReservationAffinity", "properties": { "consumeReservationType": { @@ -7684,7 +7721,7 @@ "type": "object" }, "ResourceLabels": { - "description": "Collection of [Resource Manager labels](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-labels).", + "description": "Collection of [Resource Manager labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels).", "id": "ResourceLabels", "properties": { "labels": { @@ -7719,7 +7756,7 @@ "type": "object" }, "ResourceManagerTags": { - "description": "A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values.", + "description": "A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values.", "id": "ResourceManagerTags", "properties": { "tags": { @@ -7771,7 +7808,7 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "respectPdb": { @@ -7780,7 +7817,7 @@ }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8040,12 +8077,12 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8070,7 +8107,7 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "resourceLabels": { @@ -8082,7 +8119,7 @@ }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8107,12 +8144,12 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8128,7 +8165,7 @@ "type": "string" }, "locations": { - "description": "Required. The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone.", + "description": "Required. The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone.", "items": { "type": "string" }, @@ -8140,12 +8177,12 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8170,12 +8207,12 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8198,11 +8235,11 @@ "type": "string" }, "projectId": { - "description": "Required. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects).", + "description": "Required. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects).", "type": "string" }, "zone": { - "description": "Required. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides.", + "description": "Required. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides.", "type": "string" } }, @@ -8239,7 +8276,7 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "update": { @@ -8248,7 +8285,7 @@ }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8273,12 +8310,12 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8303,12 +8340,12 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8338,12 +8375,12 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8373,12 +8410,12 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8409,12 +8446,12 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8502,7 +8539,7 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "rotateCredentials": { @@ -8511,7 +8548,7 @@ }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8686,7 +8723,7 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "update": { @@ -8695,7 +8732,7 @@ }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8731,12 +8768,12 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8747,7 +8784,7 @@ "id": "UpdateNodePoolRequest", "properties": { "accelerators": { - "description": "A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.", + "description": "A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.", "items": { "$ref": "AcceleratorConfig" }, @@ -8800,7 +8837,7 @@ "description": "Enable or disable gvnic on the node pool." }, "imageType": { - "description": "Required. The desired image type for the node pool. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.", + "description": "Required. The desired image type for the node pool. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.", "type": "string" }, "kubeletConfig": { @@ -8816,7 +8853,7 @@ "description": "Parameters that can be configured on Linux nodes." }, "locations": { - "description": "The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed.", + "description": "The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed. Warning: It is recommended to update node pool locations in a standalone API call. Do not combine a location update with changes to other fields (such as `tags`, `labels`, `taints`, etc.) in the same request. Otherwise, the API performs a structural modification where changes to other fields will only apply to newly created nodes and will not be applied to existing nodes in the node pool. To ensure all nodes are updated consistently, use a separate API call for location changes.", "items": { "type": "string" }, @@ -8827,7 +8864,7 @@ "description": "Logging configuration." }, "machineType": { - "description": "Optional. The desired [Google Compute Engine machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified machine type.", + "description": "Optional. The desired [Google Compute Engine machine type](https://cloud.google.com/compute/docs/machine-types) for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified machine type.", "type": "string" }, "maxRunDuration": { @@ -8854,7 +8891,7 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "queuedProvisioning": { @@ -8898,7 +8935,7 @@ }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, diff --git a/discovery/container-v1beta1.json b/discovery/container-v1beta1.json index d9724c29ca..49c88de073 100644 --- a/discovery/container-v1beta1.json +++ b/discovery/container-v1beta1.json @@ -176,13 +176,13 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" } @@ -278,7 +278,7 @@ ] }, "create": { - "description": "Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.", + "description": "Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters", "httpMethod": "POST", "id": "container.projects.locations.clusters.create", @@ -329,13 +329,13 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" } @@ -402,13 +402,13 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" } @@ -461,13 +461,13 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "location": "query", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides, or \"-\" for all zones. This field has been deprecated and replaced by the parent field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides, or \"-\" for all zones. This field has been deprecated and replaced by the parent field.", "location": "query", "type": "string" } @@ -538,7 +538,7 @@ }, "setLocations": { "deprecated": true, - "description": "Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) instead.", + "description": "Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) instead.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLocations", "httpMethod": "POST", "id": "container.projects.locations.clusters.setLocations", @@ -907,13 +907,13 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" } @@ -986,13 +986,13 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" } @@ -1029,13 +1029,13 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "location": "query", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", "location": "query", "type": "string" } @@ -1272,13 +1272,13 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "query", "type": "string" } @@ -1309,13 +1309,13 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "location": "query", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field.", "location": "query", "type": "string" } @@ -1350,13 +1350,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1392,13 +1392,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1433,13 +1433,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1457,7 +1457,7 @@ ] }, "create": { - "description": "Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.", + "description": "Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.", "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters", "httpMethod": "POST", "id": "container.projects.zones.clusters.create", @@ -1467,13 +1467,13 @@ ], "parameters": { "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" @@ -1513,13 +1513,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1586,13 +1586,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1624,13 +1624,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1663,13 +1663,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides, or \"-\" for all zones. This field has been deprecated and replaced by the parent field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides, or \"-\" for all zones. This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" @@ -1685,7 +1685,7 @@ }, "locations": { "deprecated": true, - "description": "Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) instead.", + "description": "Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) instead.", "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations", "httpMethod": "POST", "id": "container.projects.zones.clusters.locations", @@ -1702,13 +1702,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1743,13 +1743,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1784,13 +1784,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1825,13 +1825,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1866,13 +1866,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1907,13 +1907,13 @@ "type": "string" }, "projectId": { - "description": "Required. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects).", + "description": "Required. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects).", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Required. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides.", + "description": "Required. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides.", "location": "path", "required": true, "type": "string" @@ -1948,13 +1948,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -1989,13 +1989,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2030,13 +2030,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2071,13 +2071,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2123,13 +2123,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2164,13 +2164,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" @@ -2217,13 +2217,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2297,13 +2297,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2340,13 +2340,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" @@ -2385,13 +2385,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2433,13 +2433,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2481,13 +2481,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2529,13 +2529,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2576,13 +2576,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2622,13 +2622,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "location": "path", "required": true, "type": "string" @@ -2658,13 +2658,13 @@ "type": "string" }, "projectId": { - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" }, "zone": { - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field.", "location": "path", "required": true, "type": "string" @@ -2685,7 +2685,7 @@ } } }, - "revision": "20250930", + "revision": "20251021", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2698,7 +2698,7 @@ "type": "string" }, "acceleratorType": { - "description": "The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus)", + "description": "The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)", "type": "string" }, "gpuDriverInstallationConfig": { @@ -2857,7 +2857,7 @@ "kubernetesDashboard": { "$ref": "KubernetesDashboard", "deprecated": true, - "description": "Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards" + "description": "Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards" }, "lustreCsiDriverConfig": { "$ref": "LustreCsiDriverConfig", @@ -3137,7 +3137,7 @@ "id": "AutoprovisioningNodePoolDefaults", "properties": { "bootDiskKmsKey": { - "description": " The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption", + "description": " The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption", "type": "string" }, "diskSizeGb": { @@ -3150,7 +3150,7 @@ "type": "string" }, "imageType": { - "description": "The image type to use for NAP created node. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.", + "description": "The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.", "type": "string" }, "insecureKubeletReadonlyPortEnabled": { @@ -3163,11 +3163,11 @@ }, "minCpuPlatform": { "deprecated": true, - "description": "Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass \"automatic\" as field value.", + "description": "Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass \"automatic\" as field value.", "type": "string" }, "oauthScopes": { - "description": "The set of Google API scopes to be made available on all of the node VMs under the \"default\" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.", + "description": "The set of Google API scopes to be made available on all of the node VMs under the \"default\" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.", "items": { "type": "string" }, @@ -3381,6 +3381,23 @@ }, "type": "object" }, + "BootDiskProfile": { + "description": "Swap on the node's boot disk.", + "id": "BootDiskProfile", + "properties": { + "swapSizeGib": { + "description": "Specifies the size of the swap space in gibibytes (GiB).", + "format": "int64", + "type": "string" + }, + "swapSizePercent": { + "description": "Specifies the size of the swap space as a percentage of the boot disk size.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "CancelOperationRequest": { "description": "CancelOperationRequest cancels a single operation.", "id": "CancelOperationRequest", @@ -3396,12 +3413,12 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -3579,7 +3596,7 @@ }, "currentNodeVersion": { "deprecated": true, - "description": "Output only. Deprecated, use [NodePool.version](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.", + "description": "Output only. Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.", "readOnly": true, "type": "string" }, @@ -3650,7 +3667,7 @@ }, "initialNodeCount": { "deprecated": true, - "description": "The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a \"node_pool\" object, since this configuration (along with the \"node_config\") will be used to create a \"NodePool\" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.", + "description": "The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a \"node_pool\" object, since this configuration (along with the \"node_config\") will be used to create a \"NodePool\" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.", "format": "int32", "type": "integer" }, @@ -3676,12 +3693,12 @@ "description": "Configuration for the legacy ABAC authorization mode." }, "location": { - "description": "Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", + "description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", "readOnly": true, "type": "string" }, "locations": { - "description": "The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.", + "description": "The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.", "items": { "type": "string" }, @@ -3734,7 +3751,7 @@ "type": "string" }, "network": { - "description": "The name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. On output this shows the network ID instead of the name.", + "description": "The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. On output this shows the network ID instead of the name.", "type": "string" }, "networkConfig": { @@ -3886,7 +3903,7 @@ "type": "string" }, "subnetwork": { - "description": "The name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name.", + "description": "The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name.", "type": "string" }, "tpuConfig": { @@ -3922,7 +3939,7 @@ }, "zone": { "deprecated": true, - "description": "Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.", + "description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.", "readOnly": true, "type": "string" } @@ -3934,7 +3951,7 @@ "id": "ClusterAutoscaling", "properties": { "autoprovisioningLocations": { - "description": "The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.", + "description": "The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.", "items": { "type": "string" }, @@ -4092,7 +4109,7 @@ "enumDescriptions": [ "Default value.", "Use the IPTables implementation based on kube-proxy.", - "Use the eBPF based GKE Dataplane V2 with additional features. See the [GKE Dataplane V2 documentation](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/dataplane-v2) for more." + "Use the eBPF based GKE Dataplane V2 with additional features. See the [GKE Dataplane V2 documentation](https://cloud.google.com/kubernetes-engine/docs/how-to/dataplane-v2) for more." ], "type": "string" }, @@ -4185,7 +4202,7 @@ "description": "The desired L4 Internal Load Balancer Subsetting configuration." }, "desiredLocations": { - "description": "The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed.", + "description": "The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed.", "items": { "type": "string" }, @@ -4326,6 +4343,10 @@ "$ref": "SecretManagerConfig", "description": "Enable/Disable Secret Manager Config." }, + "desiredSecretSyncConfig": { + "$ref": "SecretSyncConfig", + "description": "Configuration for sync Secret Manager secrets as k8s secrets." + }, "desiredSecurityPostureConfig": { "$ref": "SecurityPostureConfig", "description": "Enable/Disable Security Posture API features for the cluster." @@ -4495,12 +4516,12 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -4647,7 +4668,7 @@ "properties": { "cluster": { "$ref": "Cluster", - "description": "Required. A [cluster resource](https://{$universe.dns_names.final_documentation_domain}/container-engine/reference/rest/v1beta1/projects.locations.clusters)" + "description": "Required. A [cluster resource](https://cloud.google.com/container-engine/reference/rest/v1beta1/projects.locations.clusters)" }, "parent": { "description": "The parent (project and location) where the cluster will be created. Specified in the format `projects/*/locations/*`.", @@ -4655,12 +4676,12 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", "type": "string" } }, @@ -4685,12 +4706,12 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.", "type": "string" } }, @@ -4867,6 +4888,18 @@ }, "type": "object" }, + "DedicatedLocalSsdProfile": { + "description": "Provisions a new, separate local NVMe SSD exclusively for swap.", + "id": "DedicatedLocalSsdProfile", + "properties": { + "diskCount": { + "description": "The number of physical local NVMe SSD disks to attach.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "DefaultComputeClassConfig": { "description": "DefaultComputeClassConfig defines default compute class configuration.", "id": "DefaultComputeClassConfig", @@ -4942,6 +4975,17 @@ "properties": {}, "type": "object" }, + "EncryptionConfig": { + "description": "Defines encryption settings for the swap space.", + "id": "EncryptionConfig", + "properties": { + "disabled": { + "description": "Optional. If true, swap space will not be encrypted. Defaults to false (encrypted).", + "type": "boolean" + } + }, + "type": "object" + }, "EnterpriseConfig": { "deprecated": true, "description": "EnterpriseConfig is the cluster enterprise configuration. Deprecated: GKE Enterprise features are now available without an Enterprise tier.", @@ -4979,12 +5023,29 @@ }, "type": "object" }, + "EphemeralLocalSsdProfile": { + "description": "Swap on the local SSD shared with pod ephemeral storage.", + "id": "EphemeralLocalSsdProfile", + "properties": { + "swapSizeGib": { + "description": "Specifies the size of the swap space in gibibytes (GiB).", + "format": "int64", + "type": "string" + }, + "swapSizePercent": { + "description": "Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "EphemeralStorageConfig": { "description": "EphemeralStorageConfig contains configuration for the ephemeral storage filesystem.", "id": "EphemeralStorageConfig", "properties": { "localSsdCount": { - "description": "Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.", + "description": "Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.", "format": "int32", "type": "integer" } @@ -5001,7 +5062,7 @@ "type": "integer" }, "localSsdCount": { - "description": "Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.", + "description": "Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.", "format": "int32", "type": "integer" } @@ -5174,7 +5235,7 @@ "type": "object" }, "GCPSecretManagerCertificateConfig": { - "description": "GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager).", + "description": "GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager).", "id": "GCPSecretManagerCertificateConfig", "properties": { "secretUri": { @@ -5847,6 +5908,14 @@ "$ref": "HugepagesConfig", "description": "Optional. Amounts for 2M and 1G hugepages" }, + "nodeKernelModuleLoading": { + "$ref": "NodeKernelModuleLoading", + "description": "Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification." + }, + "swapConfig": { + "$ref": "SwapConfig", + "description": "Optional. Enables and configures swap space on nodes. If omitted, swap is disabled." + }, "sysctls": { "additionalProperties": { "type": "string" @@ -5990,7 +6059,7 @@ "id": "LocalNvmeSsdBlockConfig", "properties": { "localSsdCount": { - "description": "Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.", + "description": "Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.", "format": "int32", "type": "integer" } @@ -6114,6 +6183,18 @@ "description": "Represents the Maintenance exclusion option.", "id": "MaintenanceExclusionOptions", "properties": { + "endTimeBehavior": { + "description": "EndTimeBehavior specifies the behavior of the exclusion end time.", + "enum": [ + "END_TIME_BEHAVIOR_UNSPECIFIED", + "UNTIL_END_OF_SUPPORT" + ], + "enumDescriptions": [ + "END_TIME_BEHAVIOR_UNSPECIFIED is the default behavior, which is fixed end time.", + "UNTIL_END_OF_SUPPORT means the exclusion will be in effect until the end of the support of the cluster's current version." + ], + "type": "string" + }, "scope": { "description": "Scope specifies the upgrade scope which upgrades are blocked by the exclusion.", "enum": [ @@ -6214,12 +6295,12 @@ }, "password": { "deprecated": true, - "description": "The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication", + "description": "The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication", "type": "string" }, "username": { "deprecated": true, - "description": "The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication", + "description": "The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication", "type": "string" } }, @@ -6411,7 +6492,7 @@ "enumDescriptions": [ "Default value.", "Use the IPTables implementation based on kube-proxy.", - "Use the eBPF based GKE Dataplane V2 with additional features. See the [GKE Dataplane V2 documentation](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/dataplane-v2) for more." + "Use the eBPF based GKE Dataplane V2 with additional features. See the [GKE Dataplane V2 documentation](https://cloud.google.com/kubernetes-engine/docs/how-to/dataplane-v2) for more." ], "type": "string" }, @@ -6470,7 +6551,7 @@ "type": "string" }, "network": { - "description": "Output only. The relative name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network", + "description": "Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network", "readOnly": true, "type": "string" }, @@ -6499,7 +6580,7 @@ "description": "ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not." }, "subnetwork": { - "description": "Output only. The relative name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet", + "description": "Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet", "readOnly": true, "type": "string" } @@ -6609,7 +6690,7 @@ "type": "object" }, "NodeAffinity": { - "description": "Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).", + "description": "Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).", "id": "NodeAffinity", "properties": { "key": { @@ -6645,7 +6726,7 @@ "id": "NodeConfig", "properties": { "accelerators": { - "description": "A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.", + "description": "A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.", "items": { "$ref": "AcceleratorConfig" }, @@ -6660,7 +6741,7 @@ "description": "Boot disk configuration for the node pool." }, "bootDiskKmsKey": { - "description": " The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption", + "description": " The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption", "type": "string" }, "confidentialNodes": { @@ -6728,7 +6809,7 @@ "description": "HostMaintenancePolicy contains the desired maintenance policy for the Google Compute Engine hosts." }, "imageType": { - "description": "The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.", + "description": "The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.", "type": "string" }, "kubeletConfig": { @@ -6751,7 +6832,7 @@ "description": "Parameters for using raw-block Local NVMe SSDs." }, "localSsdCount": { - "description": "The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information.", + "description": "The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.", "format": "int32", "type": "integer" }, @@ -6774,7 +6855,7 @@ "description": "Logging configuration." }, "machineType": { - "description": "The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.", + "description": "The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.", "type": "string" }, "maxRunDuration": { @@ -6790,27 +6871,27 @@ "type": "object" }, "minCpuPlatform": { - "description": "Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: \"Intel Haswell\"` or `minCpuPlatform: \"Intel Sandy Bridge\"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform).", + "description": "Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: \"Intel Haswell\"` or `minCpuPlatform: \"Intel Sandy Bridge\"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform).", "type": "string" }, "nodeGroup": { - "description": "Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes).", + "description": "Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).", "type": "string" }, "oauthScopes": { - "description": "The set of Google API scopes to be made available on all of the node VMs under the \"default\" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.", + "description": "The set of Google API scopes to be made available on all of the node VMs under the \"default\" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.", "items": { "type": "string" }, "type": "array" }, "preemptible": { - "description": "Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances.", + "description": "Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.", "type": "boolean" }, "reservationAffinity": { "$ref": "ReservationAffinity", - "description": "The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool." + "description": "The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool." }, "resourceLabels": { "additionalProperties": { @@ -6913,6 +6994,27 @@ }, "type": "object" }, + "NodeKernelModuleLoading": { + "description": "Configuration for kernel module loading on nodes.", + "id": "NodeKernelModuleLoading", + "properties": { + "policy": { + "description": "Set the node module loading policy for nodes in the node pool.", + "enum": [ + "POLICY_UNSPECIFIED", + "ENFORCE_SIGNED_MODULES", + "DO_NOT_ENFORCE_SIGNED_MODULES" + ], + "enumDescriptions": [ + "Default behavior. GKE selects the image based on node type. For CPU and TPU nodes, the image will not allow loading external kernel modules. For GPU nodes, the image will allow loading any module, whether it is signed or not.", + "Enforced signature verification: Node pools will use a Container-Optimized OS image configured to allow loading of *Google-signed* external kernel modules. Loadpin is enabled but configured to exclude modules, and kernel module signature checking is enforced.", + "Mirrors existing DEFAULT behavior: For CPU and TPU nodes, the image will not allow loading external kernel modules. For GPU nodes, the image will allow loading any module, whether it is signed or not." + ], + "type": "string" + } + }, + "type": "object" + }, "NodeKubeletConfig": { "description": "Node kubelet configs.", "id": "NodeKubeletConfig", @@ -7046,6 +7148,10 @@ "description": "Parameters for node pool-level network config.", "id": "NodeNetworkConfig", "properties": { + "acceleratorNetworkProfile": { + "description": "Immutable. The accelerator network profile for the node pool. For now the only valid value is \"auto\". If specified, the network configuration of the nodes in this node pool will be managed by this profile for the supported machine types, zone, etc.", + "type": "string" + }, "additionalNodeNetworkConfigs": { "description": "We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface", "items": { @@ -7135,12 +7241,12 @@ "type": "string" }, "initialNodeCount": { - "description": "The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.", + "description": "The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.", "format": "int32", "type": "integer" }, "instanceGroupUrls": { - "description": "Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.", + "description": "Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.", "items": { "type": "string" }, @@ -7148,7 +7254,7 @@ "type": "array" }, "locations": { - "description": "The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.", + "description": "The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.", "items": { "type": "string" }, @@ -7228,7 +7334,7 @@ "description": "Upgrade settings control disruption and speed of the upgrade." }, "version": { - "description": "The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version).", + "description": "The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version).", "type": "string" } }, @@ -7482,7 +7588,7 @@ "description": "The error result of the operation in case of failure." }, "location": { - "description": "Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", + "description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", "readOnly": true, "type": "string" }, @@ -7547,21 +7653,21 @@ "Not set.", "The cluster is being created. The cluster should be assumed to be unusable until the operation finishes. In the event of the operation failing, the cluster will enter the ERROR state and eventually be deleted.", "The cluster is being deleted. The cluster should be assumed to be unusable as soon as this operation starts. In the event of the operation failing, the cluster will enter the ERROR state and the deletion will be automatically retried until completed.", - "The cluster version is being updated. Note that this includes \"upgrades\" to the same version, which are simply a recreation. This also includes [auto-upgrades](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/cluster-upgrades#upgrading_automatically). For more details, see [documentation on cluster upgrades](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/cluster-upgrades#cluster_upgrades).", - "A node pool is being updated. Despite calling this an \"upgrade\", this includes most forms of updates to node pools. This also includes [auto-upgrades](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/node-auto-upgrades). This operation sets the progress field and may be canceled. The upgrade strategy depends on [node pool configuration](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-pool-upgrade-strategies). The nodes are generally still usable during this operation.", - "A problem has been detected with the control plane and is being repaired. This operation type is initiated by GKE. For more details, see [documentation on repairs](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions#repairs).", - "The cluster is being updated. This is a broad category of operations and includes operations that only change metadata as well as those that must recreate the entire cluster. If the control plane must be recreated, this will cause temporary downtime for zonal clusters. Some features require recreating the nodes as well. Those will be recreated as separate operations and the update may not be completely functional until the node pools recreations finish. Node recreations will generally follow [maintenance policies](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions). Some GKE-initiated operations use this type. This includes certain types of auto-upgrades and incident mitigations.", - "A node pool is being created. The node pool should be assumed to be unusable until this operation finishes. In the event of an error, the node pool may be partially created. If enabled, [node autoprovisioning](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/node-auto-provisioning) may have automatically initiated such operations.", + "The cluster version is being updated. Note that this includes \"upgrades\" to the same version, which are simply a recreation. This also includes [auto-upgrades](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-upgrades#upgrading_automatically). For more details, see [documentation on cluster upgrades](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-upgrades#cluster_upgrades).", + "A node pool is being updated. Despite calling this an \"upgrade\", this includes most forms of updates to node pools. This also includes [auto-upgrades](https://cloud.google.com/kubernetes-engine/docs/how-to/node-auto-upgrades). This operation sets the progress field and may be canceled. The upgrade strategy depends on [node pool configuration](https://cloud.google.com/kubernetes-engine/docs/concepts/node-pool-upgrade-strategies). The nodes are generally still usable during this operation.", + "A problem has been detected with the control plane and is being repaired. This operation type is initiated by GKE. For more details, see [documentation on repairs](https://cloud.google.com/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions#repairs).", + "The cluster is being updated. This is a broad category of operations and includes operations that only change metadata as well as those that must recreate the entire cluster. If the control plane must be recreated, this will cause temporary downtime for zonal clusters. Some features require recreating the nodes as well. Those will be recreated as separate operations and the update may not be completely functional until the node pools recreations finish. Node recreations will generally follow [maintenance policies](https://cloud.google.com/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions). Some GKE-initiated operations use this type. This includes certain types of auto-upgrades and incident mitigations.", + "A node pool is being created. The node pool should be assumed to be unusable until this operation finishes. In the event of an error, the node pool may be partially created. If enabled, [node autoprovisioning](https://cloud.google.com/kubernetes-engine/docs/how-to/node-auto-provisioning) may have automatically initiated such operations.", "The node pool is being deleted. The node pool should be assumed to be unusable as soon as this operation starts.", "The node pool's manamagent field is being updated. These operations only update metadata and may be concurrent with most other operations.", - "A problem has been detected with nodes and [they are being repaired](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/node-auto-repair). This operation type is initiated by GKE, typically automatically. This operation may be concurrent with other operations and there may be multiple repairs occurring on the same node pool.", + "A problem has been detected with nodes and [they are being repaired](https://cloud.google.com/kubernetes-engine/docs/how-to/node-auto-repair). This operation type is initiated by GKE, typically automatically. This operation may be concurrent with other operations and there may be multiple repairs occurring on the same node pool.", "Unused. Automatic node upgrade uses UPGRADE_NODES.", "Unused. Updating labels uses UPDATE_CLUSTER.", "Unused. Updating master auth uses UPDATE_CLUSTER.", "The node pool is being resized. With the exception of resizing to or from size zero, the node pool is generally usable during this operation.", "Unused. Updating network policy uses UPDATE_CLUSTER.", "Unused. Updating maintenance policy uses UPDATE_CLUSTER.", - "The control plane is being resized. This operation type is initiated by GKE. These operations are often performed preemptively to ensure that the control plane has sufficient resources and is not typically an indication of issues. For more details, see [documentation on resizes](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions#repairs).", + "The control plane is being resized. This operation type is initiated by GKE. These operations are often performed preemptively to ensure that the control plane has sufficient resources and is not typically an indication of issues. For more details, see [documentation on resizes](https://cloud.google.com/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions#repairs).", "Fleet features of GKE Enterprise are being upgraded. The cluster should be assumed to be blocked for other upgrades until the operation finishes." ], "readOnly": true, @@ -7614,7 +7720,7 @@ }, "zone": { "deprecated": true, - "description": "Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.", + "description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.", "readOnly": true, "type": "string" } @@ -7744,7 +7850,7 @@ "type": "string" }, "tpuTopology": { - "description": "TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies", + "description": "TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies", "type": "string" }, "type": { @@ -8125,7 +8231,7 @@ "type": "object" }, "ReservationAffinity": { - "description": "[ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from.", + "description": "[ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from.", "id": "ReservationAffinity", "properties": { "consumeReservationType": { @@ -8159,7 +8265,7 @@ "type": "object" }, "ResourceLabels": { - "description": "Collection of [Resource Manager labels](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-labels).", + "description": "Collection of [Resource Manager labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels).", "id": "ResourceLabels", "properties": { "labels": { @@ -8194,7 +8300,7 @@ "type": "object" }, "ResourceManagerTags": { - "description": "A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values.", + "description": "A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values.", "id": "ResourceManagerTags", "properties": { "tags": { @@ -8246,7 +8352,7 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "respectPdb": { @@ -8255,7 +8361,7 @@ }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8542,12 +8648,12 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8572,7 +8678,7 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "resourceLabels": { @@ -8584,7 +8690,7 @@ }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8609,12 +8715,12 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8630,7 +8736,7 @@ "type": "string" }, "locations": { - "description": "Required. The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone.", + "description": "Required. The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone.", "items": { "type": "string" }, @@ -8642,12 +8748,12 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8672,12 +8778,12 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8700,11 +8806,11 @@ "type": "string" }, "projectId": { - "description": "Required. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects).", + "description": "Required. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects).", "type": "string" }, "zone": { - "description": "Required. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides.", + "description": "Required. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides.", "type": "string" } }, @@ -8741,7 +8847,7 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "update": { @@ -8750,7 +8856,7 @@ }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8775,12 +8881,12 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8805,12 +8911,12 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8840,12 +8946,12 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8875,12 +8981,12 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -8911,12 +9017,12 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -9004,7 +9110,7 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "rotateCredentials": { @@ -9013,7 +9119,7 @@ }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -9137,6 +9243,33 @@ }, "type": "object" }, + "SwapConfig": { + "description": "Configuration for swap memory on a node pool.", + "id": "SwapConfig", + "properties": { + "bootDiskProfile": { + "$ref": "BootDiskProfile", + "description": "Swap on the node's boot disk." + }, + "dedicatedLocalSsdProfile": { + "$ref": "DedicatedLocalSsdProfile", + "description": "Provisions a new, separate local NVMe SSD exclusively for swap." + }, + "enabled": { + "description": "Optional. Enables or disables swap for the node pool.", + "type": "boolean" + }, + "encryptionConfig": { + "$ref": "EncryptionConfig", + "description": "Optional. If omitted, swap space is encrypted by default." + }, + "ephemeralLocalSsdProfile": { + "$ref": "EphemeralLocalSsdProfile", + "description": "Swap on the local SSD shared with pod ephemeral storage." + } + }, + "type": "object" + }, "SyncRotationConfig": { "description": "SyncRotationConfig is config for secret manager auto rotation.", "id": "SyncRotationConfig", @@ -9224,7 +9357,7 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "update": { @@ -9233,7 +9366,7 @@ }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -9269,12 +9402,12 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -9285,7 +9418,7 @@ "id": "UpdateNodePoolRequest", "properties": { "accelerators": { - "description": "A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.", + "description": "A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.", "items": { "$ref": "AcceleratorConfig" }, @@ -9338,7 +9471,7 @@ "description": "Enable or disable gvnic on the node pool." }, "imageType": { - "description": "Required. The desired image type for the node pool. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.", + "description": "Required. The desired image type for the node pool. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.", "type": "string" }, "kubeletConfig": { @@ -9354,7 +9487,7 @@ "description": "Parameters that can be configured on Linux nodes." }, "locations": { - "description": "The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed.", + "description": "The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed. Warning: It is recommended to update node pool locations in a standalone API call. Do not combine a location update with changes to other fields (such as `tags`, `labels`, `taints`, etc.) in the same request. Otherwise, the API performs a structural modification where changes to other fields will only apply to newly created nodes and will not be applied to existing nodes in the node pool. To ensure all nodes are updated consistently, use a separate API call for location changes.", "items": { "type": "string" }, @@ -9392,7 +9525,7 @@ }, "projectId": { "deprecated": true, - "description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.", "type": "string" }, "queuedProvisioning": { @@ -9436,7 +9569,7 @@ }, "zone": { "deprecated": true, - "description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", + "description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.", "type": "string" } }, @@ -9541,6 +9674,10 @@ "description": "UpgradeEvent is a notification sent to customers by the cluster server when a resource is upgrading.", "id": "UpgradeEvent", "properties": { + "currentEmulatedVersion": { + "description": "The current emulated version before the upgrade.", + "type": "string" + }, "currentVersion": { "description": "The current version before the upgrade.", "type": "string" @@ -9572,6 +9709,10 @@ ], "type": "string" }, + "targetEmulatedVersion": { + "description": "The target emulated version for the upgrade.", + "type": "string" + }, "targetVersion": { "description": "The target version for the upgrade.", "type": "string" @@ -9583,6 +9724,10 @@ "description": "UpgradeInfoEvent is a notification sent to customers about the upgrade information of a resource.", "id": "UpgradeInfoEvent", "properties": { + "currentEmulatedVersion": { + "description": "The current emulated version before the upgrade.", + "type": "string" + }, "currentVersion": { "description": "The current version before the upgrade.", "type": "string" @@ -9668,6 +9813,10 @@ "readOnly": true, "type": "string" }, + "targetEmulatedVersion": { + "description": "The target emulated version for the upgrade.", + "type": "string" + }, "targetVersion": { "description": "The target version for the upgrade.", "type": "string" diff --git a/discovery/dataflow-v1b3.json b/discovery/dataflow-v1b3.json index da1939761c..32d5f9d1b7 100644 --- a/discovery/dataflow-v1b3.json +++ b/discovery/dataflow-v1b3.json @@ -19,6 +19,16 @@ "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/dataflow", "endpoints": [ + { + "description": "Regional Endpoint", + "endpointUrl": "https://dataflow.africa-south1.rep.googleapis.com/", + "location": "africa-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dataflow.asia-east1.rep.googleapis.com/", + "location": "asia-east1" + }, { "description": "Regional Endpoint", "endpointUrl": "https://dataflow.asia-south1.rep.googleapis.com/", @@ -29,6 +39,16 @@ "endpointUrl": "https://dataflow.asia-south2.rep.googleapis.com/", "location": "asia-south2" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dataflow.australia-southeast1.rep.googleapis.com/", + "location": "australia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dataflow.europe-central2.rep.googleapis.com/", + "location": "europe-central2" + }, { "description": "Regional Endpoint", "endpointUrl": "https://dataflow.europe-west3.rep.googleapis.com/", @@ -44,11 +64,26 @@ "endpointUrl": "https://dataflow.europe-west9.rep.googleapis.com/", "location": "europe-west9" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dataflow.me-central1.rep.googleapis.com/", + "location": "me-central1" + }, { "description": "Regional Endpoint", "endpointUrl": "https://dataflow.me-central2.rep.googleapis.com/", "location": "me-central2" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dataflow.northamerica-northeast1.rep.googleapis.com/", + "location": "northamerica-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dataflow.southamerica-west1.rep.googleapis.com/", + "location": "southamerica-west1" + }, { "description": "Regional Endpoint", "endpointUrl": "https://dataflow.us-central1.rep.googleapis.com/", @@ -2260,7 +2295,7 @@ } } }, - "revision": "20251003", + "revision": "20251019", "rootUrl": "https://dataflow.googleapis.com/", "schemas": { "ApproximateProgress": { diff --git a/discovery/dataform-v1.json b/discovery/dataform-v1.json new file mode 100644 index 0000000000..b2c072809e --- /dev/null +++ b/discovery/dataform-v1.json @@ -0,0 +1,4918 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/bigquery": { + "description": "View and manage your data in Google BigQuery and see the email address for your Google Account" + }, + "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." + } + } + } + }, + "basePath": "", + "baseUrl": "https://dataform.googleapis.com/", + "batchPath": "batch", + "description": "Service to develop, version control, and operationalize SQL pipelines in BigQuery.", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/dataform/docs", + "fullyEncodeReservedExpansion": true, + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "dataform:v1", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://dataform.mtls.googleapis.com/", + "name": "dataform", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "description": "Data format for response.", + "enum": [ + "json", + "media", + "proto" + ], + "enumDescriptions": [ + "Responses with Content-Type of application/json", + "Media download with context-dependent Content-Type", + "Responses with Content-Type of application/x-protobuf" + ], + "location": "query", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", + "location": "query", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "projects": { + "resources": { + "locations": { + "methods": { + "get": { + "description": "Gets information about a location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", + "httpMethod": "GET", + "id": "dataform.projects.locations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Resource name for the location.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Location" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getConfig": { + "description": "Get default config for a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/config", + "httpMethod": "GET", + "id": "dataform.projects.locations.getConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The config name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/config$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Config" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists information about the supported locations for this service.", + "flatPath": "v1/projects/{projectsId}/locations", + "httpMethod": "GET", + "id": "dataform.projects.locations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "extraLocationTypes": { + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "location": "query", + "repeated": true, + "type": "string" + }, + "filter": { + "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "name": { + "description": "The resource that owns the locations collection, if applicable.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The maximum number of results to return. If not set, the service selects a default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}/locations", + "response": { + "$ref": "ListLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "updateConfig": { + "description": "Update default config for a given project and location. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/config", + "httpMethod": "PATCH", + "id": "dataform.projects.locations.updateConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The config name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/config$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Specifies the fields to be updated in the config.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "Config" + }, + "response": { + "$ref": "Config" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "folders": { + "methods": { + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/folders/{foldersId}:getIamPolicy", + "httpMethod": "GET", + "id": "dataform.projects.locations.folders.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/folders/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "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}/folders/{foldersId}:setIamPolicy", + "httpMethod": "POST", + "id": "dataform.projects.locations.folders.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/folders/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/folders/{foldersId}:testIamPermissions", + "httpMethod": "POST", + "id": "dataform.projects.locations.folders.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/folders/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "dataform.projects.locations.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "request": { + "$ref": "CancelOperationRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "dataform.projects.locations.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "dataform.projects.locations.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", + "httpMethod": "GET", + "id": "dataform.projects.locations.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "ListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "repositories": { + "methods": { + "commit": { + "description": "Applies a Git commit to a Repository. The Repository must not have a value for `git_remote_settings.url`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:commit", + "httpMethod": "POST", + "id": "dataform.projects.locations.repositories.commit", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The repository's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:commit", + "request": { + "$ref": "CommitRepositoryChangesRequest" + }, + "response": { + "$ref": "CommitRepositoryChangesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "computeAccessTokenStatus": { + "description": "Computes a Repository's Git access token status.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:computeAccessTokenStatus", + "httpMethod": "GET", + "id": "dataform.projects.locations.repositories.computeAccessTokenStatus", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The repository's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:computeAccessTokenStatus", + "response": { + "$ref": "ComputeRepositoryAccessTokenStatusResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a new Repository in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories", + "httpMethod": "POST", + "id": "dataform.projects.locations.repositories.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The location in which to create the repository. Must be in the format `projects/*/locations/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "repositoryId": { + "description": "Required. The ID to use for the repository, which will become the final component of the repository's resource name.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/repositories", + "request": { + "$ref": "Repository" + }, + "response": { + "$ref": "Repository" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single Repository.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}", + "httpMethod": "DELETE", + "id": "dataform.projects.locations.repositories.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "Optional. If set to true, child resources of this repository (compilation results and workflow invocations) will also be deleted. Otherwise, the request will only succeed if the repository has no child resources. **Note:** *This flag doesn't support deletion of workspaces, release configs or workflow configs. If any of such resources exists in the repository, the request will fail.*.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The repository's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "fetchHistory": { + "description": "Fetches a Repository's history of commits. The Repository must not have a value for `git_remote_settings.url`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:fetchHistory", + "httpMethod": "GET", + "id": "dataform.projects.locations.repositories.fetchHistory", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The repository's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "Optional. Maximum number of commits to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Page token received from a previous `FetchRepositoryHistory` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchRepositoryHistory`, with the exception of `page_size`, must match the call that provided the page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:fetchHistory", + "response": { + "$ref": "FetchRepositoryHistoryResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "fetchRemoteBranches": { + "description": "Fetches a Repository's remote branches.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:fetchRemoteBranches", + "httpMethod": "GET", + "id": "dataform.projects.locations.repositories.fetchRemoteBranches", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The repository's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:fetchRemoteBranches", + "response": { + "$ref": "FetchRemoteBranchesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Fetches a single Repository.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}", + "httpMethod": "GET", + "id": "dataform.projects.locations.repositories.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The repository's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Repository" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:getIamPolicy", + "httpMethod": "GET", + "id": "dataform.projects.locations.repositories.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Repositories in a given project and location. **Note:** *This method can return repositories not shown in the [Dataform UI](https://console.cloud.google.com/bigquery/dataform)*.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories", + "httpMethod": "GET", + "id": "dataform.projects.locations.repositories.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter for the returned list.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Maximum number of repositories to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Page token received from a previous `ListRepositories` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRepositories`, with the exception of `page_size`, must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The location in which to list repositories. Must be in the format `projects/*/locations/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/repositories", + "response": { + "$ref": "ListRepositoriesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a single Repository. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}", + "httpMethod": "PATCH", + "id": "dataform.projects.locations.repositories.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The repository's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Specifies the fields to be updated in the repository. If left unset, all fields will be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "Repository" + }, + "response": { + "$ref": "Repository" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "queryDirectoryContents": { + "description": "Returns the contents of a given Repository directory. The Repository must not have a value for `git_remote_settings.url`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:queryDirectoryContents", + "httpMethod": "GET", + "id": "dataform.projects.locations.repositories.queryDirectoryContents", + "parameterOrder": [ + "name" + ], + "parameters": { + "commitSha": { + "description": "Optional. The Commit SHA for the commit to query from. If unset, the directory will be queried from HEAD.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The repository's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Page token received from a previous `QueryRepositoryDirectoryContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryRepositoryDirectoryContents`, with the exception of `page_size`, must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "path": { + "description": "Optional. The directory's full path including directory name, relative to root. If left unset, the root is used.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:queryDirectoryContents", + "response": { + "$ref": "QueryRepositoryDirectoryContentsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "readFile": { + "description": "Returns the contents of a file (inside a Repository). The Repository must not have a value for `git_remote_settings.url`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:readFile", + "httpMethod": "GET", + "id": "dataform.projects.locations.repositories.readFile", + "parameterOrder": [ + "name" + ], + "parameters": { + "commitSha": { + "description": "Optional. The commit SHA for the commit to read from. If unset, the file will be read from HEAD.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The repository's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", + "required": true, + "type": "string" + }, + "path": { + "description": "Required. Full file path to read including filename, from repository root.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:readFile", + "response": { + "$ref": "ReadRepositoryFileResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "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}/repositories/{repositoriesId}:setIamPolicy", + "httpMethod": "POST", + "id": "dataform.projects.locations.repositories.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:testIamPermissions", + "httpMethod": "POST", + "id": "dataform.projects.locations.repositories.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "compilationResults": { + "methods": { + "create": { + "description": "Creates a new CompilationResult in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/compilationResults", + "httpMethod": "POST", + "id": "dataform.projects.locations.repositories.compilationResults.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The repository in which to create the compilation result. Must be in the format `projects/*/locations/*/repositories/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/compilationResults", + "request": { + "$ref": "CompilationResult" + }, + "response": { + "$ref": "CompilationResult" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Fetches a single CompilationResult.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/compilationResults/{compilationResultsId}", + "httpMethod": "GET", + "id": "dataform.projects.locations.repositories.compilationResults.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The compilation result's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/compilationResults/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "CompilationResult" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists CompilationResults in a given Repository.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/compilationResults", + "httpMethod": "GET", + "id": "dataform.projects.locations.repositories.compilationResults.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter for the returned list.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. This field only supports ordering by `name` and `create_time`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Maximum number of compilation results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Page token received from a previous `ListCompilationResults` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCompilationResults`, with the exception of `page_size`, must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The repository in which to list compilation results. Must be in the format `projects/*/locations/*/repositories/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/compilationResults", + "response": { + "$ref": "ListCompilationResultsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "query": { + "description": "Returns CompilationResultActions in a given CompilationResult.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/compilationResults/{compilationResultsId}:query", + "httpMethod": "GET", + "id": "dataform.projects.locations.repositories.compilationResults.query", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "Optional. Optional filter for the returned list. Filtering is only currently supported on the `file_path` field.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The compilation result's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/compilationResults/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "Optional. Maximum number of compilation results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Page token received from a previous `QueryCompilationResultActions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryCompilationResultActions`, with the exception of `page_size`, must match the call that provided the page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:query", + "response": { + "$ref": "QueryCompilationResultActionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "releaseConfigs": { + "methods": { + "create": { + "description": "Creates a new ReleaseConfig in a given Repository.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/releaseConfigs", + "httpMethod": "POST", + "id": "dataform.projects.locations.repositories.releaseConfigs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The repository in which to create the release config. Must be in the format `projects/*/locations/*/repositories/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", + "required": true, + "type": "string" + }, + "releaseConfigId": { + "description": "Required. The ID to use for the release config, which will become the final component of the release config's resource name.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/releaseConfigs", + "request": { + "$ref": "ReleaseConfig" + }, + "response": { + "$ref": "ReleaseConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single ReleaseConfig.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/releaseConfigs/{releaseConfigsId}", + "httpMethod": "DELETE", + "id": "dataform.projects.locations.repositories.releaseConfigs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The release config's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/releaseConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Fetches a single ReleaseConfig.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/releaseConfigs/{releaseConfigsId}", + "httpMethod": "GET", + "id": "dataform.projects.locations.repositories.releaseConfigs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The release config's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/releaseConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "ReleaseConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists ReleaseConfigs in a given Repository.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/releaseConfigs", + "httpMethod": "GET", + "id": "dataform.projects.locations.repositories.releaseConfigs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. Maximum number of release configs to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Page token received from a previous `ListReleaseConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReleaseConfigs`, with the exception of `page_size`, must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The repository in which to list release configs. Must be in the format `projects/*/locations/*/repositories/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/releaseConfigs", + "response": { + "$ref": "ListReleaseConfigsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a single ReleaseConfig. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/releaseConfigs/{releaseConfigsId}", + "httpMethod": "PATCH", + "id": "dataform.projects.locations.repositories.releaseConfigs.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The release config's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/releaseConfigs/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Specifies the fields to be updated in the release config. If left unset, all fields will be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "ReleaseConfig" + }, + "response": { + "$ref": "ReleaseConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "workflowConfigs": { + "methods": { + "create": { + "description": "Creates a new WorkflowConfig in a given Repository.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowConfigs", + "httpMethod": "POST", + "id": "dataform.projects.locations.repositories.workflowConfigs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The repository in which to create the workflow config. Must be in the format `projects/*/locations/*/repositories/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", + "required": true, + "type": "string" + }, + "workflowConfigId": { + "description": "Required. The ID to use for the workflow config, which will become the final component of the workflow config's resource name.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/workflowConfigs", + "request": { + "$ref": "WorkflowConfig" + }, + "response": { + "$ref": "WorkflowConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single WorkflowConfig.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowConfigs/{workflowConfigsId}", + "httpMethod": "DELETE", + "id": "dataform.projects.locations.repositories.workflowConfigs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The workflow config's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workflowConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Fetches a single WorkflowConfig.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowConfigs/{workflowConfigsId}", + "httpMethod": "GET", + "id": "dataform.projects.locations.repositories.workflowConfigs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The workflow config's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workflowConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "WorkflowConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists WorkflowConfigs in a given Repository.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowConfigs", + "httpMethod": "GET", + "id": "dataform.projects.locations.repositories.workflowConfigs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. Maximum number of workflow configs to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Page token received from a previous `ListWorkflowConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkflowConfigs`, with the exception of `page_size`, must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The repository in which to list workflow configs. Must be in the format `projects/*/locations/*/repositories/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/workflowConfigs", + "response": { + "$ref": "ListWorkflowConfigsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a single WorkflowConfig. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowConfigs/{workflowConfigsId}", + "httpMethod": "PATCH", + "id": "dataform.projects.locations.repositories.workflowConfigs.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The workflow config's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workflowConfigs/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Specifies the fields to be updated in the workflow config. If left unset, all fields will be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "WorkflowConfig" + }, + "response": { + "$ref": "WorkflowConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "workflowInvocations": { + "methods": { + "cancel": { + "description": "Requests cancellation of a running WorkflowInvocation.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowInvocations/{workflowInvocationsId}:cancel", + "httpMethod": "POST", + "id": "dataform.projects.locations.repositories.workflowInvocations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The workflow invocation resource's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workflowInvocations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "request": { + "$ref": "CancelWorkflowInvocationRequest" + }, + "response": { + "$ref": "CancelWorkflowInvocationResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a new WorkflowInvocation in a given Repository.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowInvocations", + "httpMethod": "POST", + "id": "dataform.projects.locations.repositories.workflowInvocations.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The repository in which to create the workflow invocation. Must be in the format `projects/*/locations/*/repositories/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/workflowInvocations", + "request": { + "$ref": "WorkflowInvocation" + }, + "response": { + "$ref": "WorkflowInvocation" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single WorkflowInvocation.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowInvocations/{workflowInvocationsId}", + "httpMethod": "DELETE", + "id": "dataform.projects.locations.repositories.workflowInvocations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The workflow invocation resource's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workflowInvocations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Fetches a single WorkflowInvocation.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowInvocations/{workflowInvocationsId}", + "httpMethod": "GET", + "id": "dataform.projects.locations.repositories.workflowInvocations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The workflow invocation resource's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workflowInvocations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "WorkflowInvocation" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists WorkflowInvocations in a given Repository.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowInvocations", + "httpMethod": "GET", + "id": "dataform.projects.locations.repositories.workflowInvocations.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter for the returned list.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Maximum number of workflow invocations to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Page token received from a previous `ListWorkflowInvocations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkflowInvocations`, with the exception of `page_size`, must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource of the WorkflowInvocation type. Must be in the format `projects/*/locations/*/repositories/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/workflowInvocations", + "response": { + "$ref": "ListWorkflowInvocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "query": { + "description": "Returns WorkflowInvocationActions in a given WorkflowInvocation.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowInvocations/{workflowInvocationsId}:query", + "httpMethod": "GET", + "id": "dataform.projects.locations.repositories.workflowInvocations.query", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The workflow invocation's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workflowInvocations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "Optional. Maximum number of workflow invocations to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Page token received from a previous `QueryWorkflowInvocationActions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryWorkflowInvocationActions`, with the exception of `page_size`, must match the call that provided the page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:query", + "response": { + "$ref": "QueryWorkflowInvocationActionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "workspaces": { + "methods": { + "commit": { + "description": "Applies a Git commit for uncommitted files in a Workspace.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:commit", + "httpMethod": "POST", + "id": "dataform.projects.locations.repositories.workspaces.commit", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The workspace's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:commit", + "request": { + "$ref": "CommitWorkspaceChangesRequest" + }, + "response": { + "$ref": "CommitWorkspaceChangesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a new Workspace in a given Repository.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces", + "httpMethod": "POST", + "id": "dataform.projects.locations.repositories.workspaces.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The repository in which to create the workspace. Must be in the format `projects/*/locations/*/repositories/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", + "required": true, + "type": "string" + }, + "workspaceId": { + "description": "Required. The ID to use for the workspace, which will become the final component of the workspace's resource name.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/workspaces", + "request": { + "$ref": "Workspace" + }, + "response": { + "$ref": "Workspace" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single Workspace.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}", + "httpMethod": "DELETE", + "id": "dataform.projects.locations.repositories.workspaces.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The workspace resource's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "fetchFileDiff": { + "description": "Fetches Git diff for an uncommitted file in a Workspace.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:fetchFileDiff", + "httpMethod": "GET", + "id": "dataform.projects.locations.repositories.workspaces.fetchFileDiff", + "parameterOrder": [ + "workspace" + ], + "parameters": { + "path": { + "description": "Required. The file's full path including filename, relative to the workspace root.", + "location": "query", + "type": "string" + }, + "workspace": { + "description": "Required. The workspace's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+workspace}:fetchFileDiff", + "response": { + "$ref": "FetchFileDiffResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "fetchFileGitStatuses": { + "description": "Fetches Git statuses for the files in a Workspace.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:fetchFileGitStatuses", + "httpMethod": "GET", + "id": "dataform.projects.locations.repositories.workspaces.fetchFileGitStatuses", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The workspace's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:fetchFileGitStatuses", + "response": { + "$ref": "FetchFileGitStatusesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "fetchGitAheadBehind": { + "description": "Fetches Git ahead/behind against a remote branch.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:fetchGitAheadBehind", + "httpMethod": "GET", + "id": "dataform.projects.locations.repositories.workspaces.fetchGitAheadBehind", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The workspace's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", + "required": true, + "type": "string" + }, + "remoteBranch": { + "description": "Optional. The name of the branch in the Git remote against which this workspace should be compared. If left unset, the repository's default branch name will be used.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:fetchGitAheadBehind", + "response": { + "$ref": "FetchGitAheadBehindResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Fetches a single Workspace.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}", + "httpMethod": "GET", + "id": "dataform.projects.locations.repositories.workspaces.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The workspace's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Workspace" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:getIamPolicy", + "httpMethod": "GET", + "id": "dataform.projects.locations.repositories.workspaces.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "installNpmPackages": { + "description": "Installs dependency NPM packages (inside a Workspace).", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:installNpmPackages", + "httpMethod": "POST", + "id": "dataform.projects.locations.repositories.workspaces.installNpmPackages", + "parameterOrder": [ + "workspace" + ], + "parameters": { + "workspace": { + "description": "Required. The workspace's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+workspace}:installNpmPackages", + "request": { + "$ref": "InstallNpmPackagesRequest" + }, + "response": { + "$ref": "InstallNpmPackagesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Workspaces in a given Repository.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces", + "httpMethod": "GET", + "id": "dataform.projects.locations.repositories.workspaces.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter for the returned list.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Maximum number of workspaces to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Page token received from a previous `ListWorkspaces` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkspaces`, with the exception of `page_size`, must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The repository in which to list workspaces. Must be in the format `projects/*/locations/*/repositories/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/workspaces", + "response": { + "$ref": "ListWorkspacesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "makeDirectory": { + "description": "Creates a directory inside a Workspace.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:makeDirectory", + "httpMethod": "POST", + "id": "dataform.projects.locations.repositories.workspaces.makeDirectory", + "parameterOrder": [ + "workspace" + ], + "parameters": { + "workspace": { + "description": "Required. The workspace's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+workspace}:makeDirectory", + "request": { + "$ref": "MakeDirectoryRequest" + }, + "response": { + "$ref": "MakeDirectoryResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "moveDirectory": { + "description": "Moves a directory (inside a Workspace), and all of its contents, to a new location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:moveDirectory", + "httpMethod": "POST", + "id": "dataform.projects.locations.repositories.workspaces.moveDirectory", + "parameterOrder": [ + "workspace" + ], + "parameters": { + "workspace": { + "description": "Required. The workspace's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+workspace}:moveDirectory", + "request": { + "$ref": "MoveDirectoryRequest" + }, + "response": { + "$ref": "MoveDirectoryResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "moveFile": { + "description": "Moves a file (inside a Workspace) to a new location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:moveFile", + "httpMethod": "POST", + "id": "dataform.projects.locations.repositories.workspaces.moveFile", + "parameterOrder": [ + "workspace" + ], + "parameters": { + "workspace": { + "description": "Required. The workspace's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+workspace}:moveFile", + "request": { + "$ref": "MoveFileRequest" + }, + "response": { + "$ref": "MoveFileResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "pull": { + "description": "Pulls Git commits from the Repository's remote into a Workspace.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:pull", + "httpMethod": "POST", + "id": "dataform.projects.locations.repositories.workspaces.pull", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The workspace's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:pull", + "request": { + "$ref": "PullGitCommitsRequest" + }, + "response": { + "$ref": "PullGitCommitsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "push": { + "description": "Pushes Git commits from a Workspace to the Repository's remote.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:push", + "httpMethod": "POST", + "id": "dataform.projects.locations.repositories.workspaces.push", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The workspace's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:push", + "request": { + "$ref": "PushGitCommitsRequest" + }, + "response": { + "$ref": "PushGitCommitsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "queryDirectoryContents": { + "description": "Returns the contents of a given Workspace directory.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:queryDirectoryContents", + "httpMethod": "GET", + "id": "dataform.projects.locations.repositories.workspaces.queryDirectoryContents", + "parameterOrder": [ + "workspace" + ], + "parameters": { + "pageSize": { + "description": "Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Page token received from a previous `QueryDirectoryContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryDirectoryContents`, with the exception of `page_size`, must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "path": { + "description": "Optional. The directory's full path including directory name, relative to the workspace root. If left unset, the workspace root is used.", + "location": "query", + "type": "string" + }, + "workspace": { + "description": "Required. The workspace's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+workspace}:queryDirectoryContents", + "response": { + "$ref": "QueryDirectoryContentsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "readFile": { + "description": "Returns the contents of a file (inside a Workspace).", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:readFile", + "httpMethod": "GET", + "id": "dataform.projects.locations.repositories.workspaces.readFile", + "parameterOrder": [ + "workspace" + ], + "parameters": { + "path": { + "description": "Required. The file's full path including filename, relative to the workspace root.", + "location": "query", + "type": "string" + }, + "revision": { + "description": "Optional. The Git revision of the file to return. If left empty, the current contents of `path` will be returned.", + "location": "query", + "type": "string" + }, + "workspace": { + "description": "Required. The workspace's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+workspace}:readFile", + "response": { + "$ref": "ReadFileResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "removeDirectory": { + "description": "Deletes a directory (inside a Workspace) and all of its contents.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:removeDirectory", + "httpMethod": "POST", + "id": "dataform.projects.locations.repositories.workspaces.removeDirectory", + "parameterOrder": [ + "workspace" + ], + "parameters": { + "workspace": { + "description": "Required. The workspace's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+workspace}:removeDirectory", + "request": { + "$ref": "RemoveDirectoryRequest" + }, + "response": { + "$ref": "RemoveDirectoryResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "removeFile": { + "description": "Deletes a file (inside a Workspace).", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:removeFile", + "httpMethod": "POST", + "id": "dataform.projects.locations.repositories.workspaces.removeFile", + "parameterOrder": [ + "workspace" + ], + "parameters": { + "workspace": { + "description": "Required. The workspace's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+workspace}:removeFile", + "request": { + "$ref": "RemoveFileRequest" + }, + "response": { + "$ref": "RemoveFileResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "reset": { + "description": "Performs a Git reset for uncommitted files in a Workspace.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:reset", + "httpMethod": "POST", + "id": "dataform.projects.locations.repositories.workspaces.reset", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The workspace's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:reset", + "request": { + "$ref": "ResetWorkspaceChangesRequest" + }, + "response": { + "$ref": "ResetWorkspaceChangesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "searchFiles": { + "description": "Finds the contents of a given Workspace directory by filter.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:searchFiles", + "httpMethod": "GET", + "id": "dataform.projects.locations.repositories.workspaces.searchFiles", + "parameterOrder": [ + "workspace" + ], + "parameters": { + "filter": { + "description": "Optional. Optional filter for the returned list in filtering format. Filtering is only currently supported on the `path` field. See https://google.aip.dev/160 for details.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Maximum number of search results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Page token received from a previous `SearchFilesRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchFilesRequest`, with the exception of `page_size`, must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "workspace": { + "description": "Required. The workspace's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+workspace}:searchFiles", + "response": { + "$ref": "SearchFilesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "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}/repositories/{repositoriesId}/workspaces/{workspacesId}:setIamPolicy", + "httpMethod": "POST", + "id": "dataform.projects.locations.repositories.workspaces.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:testIamPermissions", + "httpMethod": "POST", + "id": "dataform.projects.locations.repositories.workspaces.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "writeFile": { + "description": "Writes to a file (inside a Workspace).", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:writeFile", + "httpMethod": "POST", + "id": "dataform.projects.locations.repositories.workspaces.writeFile", + "parameterOrder": [ + "workspace" + ], + "parameters": { + "workspace": { + "description": "Required. The workspace's name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+workspace}:writeFile", + "request": { + "$ref": "WriteFileRequest" + }, + "response": { + "$ref": "WriteFileResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "teamFolders": { + "methods": { + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/teamFolders/{teamFoldersId}:getIamPolicy", + "httpMethod": "GET", + "id": "dataform.projects.locations.teamFolders.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/teamFolders/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "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}/teamFolders/{teamFoldersId}:setIamPolicy", + "httpMethod": "POST", + "id": "dataform.projects.locations.teamFolders.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/teamFolders/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/teamFolders/{teamFoldersId}:testIamPermissions", + "httpMethod": "POST", + "id": "dataform.projects.locations.teamFolders.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/teamFolders/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + }, + "revision": "20251007", + "rootUrl": "https://dataform.googleapis.com/", + "schemas": { + "ActionErrorTable": { + "description": "Error table information, used to write error data into a BigQuery table.", + "id": "ActionErrorTable", + "properties": { + "retentionDays": { + "description": "Error table partition expiration in days. Only positive values are allowed.", + "format": "int32", + "type": "integer" + }, + "target": { + "$ref": "Target", + "description": "Error Table target." + } + }, + "type": "object" + }, + "ActionIncrementalLoadMode": { + "description": "Load definition for incremental load modes", + "id": "ActionIncrementalLoadMode", + "properties": { + "column": { + "description": "Column name for incremental load modes", + "type": "string" + } + }, + "type": "object" + }, + "ActionLoadConfig": { + "description": "Simplified load configuration for actions", + "id": "ActionLoadConfig", + "properties": { + "append": { + "$ref": "ActionSimpleLoadMode", + "description": "Append into destination table" + }, + "maximum": { + "$ref": "ActionIncrementalLoadMode", + "description": "Insert records where the value exceeds the previous maximum value for a column in the destination table" + }, + "replace": { + "$ref": "ActionSimpleLoadMode", + "description": "Replace destination table" + }, + "unique": { + "$ref": "ActionIncrementalLoadMode", + "description": "Insert records where the value of a column is not already present in the destination table" + } + }, + "type": "object" + }, + "ActionSimpleLoadMode": { + "description": "Simple load definition", + "id": "ActionSimpleLoadMode", + "properties": {}, + "type": "object" + }, + "ActionSqlDefinition": { + "description": "Definition of a SQL Data Preparation", + "id": "ActionSqlDefinition", + "properties": { + "errorTable": { + "$ref": "ActionErrorTable", + "description": "Error table configuration," + }, + "loadConfig": { + "$ref": "ActionLoadConfig", + "description": "Load configuration." + }, + "query": { + "description": "The SQL query representing the data preparation steps. Formatted as a Pipe SQL query statement.", + "type": "string" + } + }, + "type": "object" + }, + "Assertion": { + "description": "Represents an assertion upon a SQL query which is required return zero rows.", + "id": "Assertion", + "properties": { + "dependencyTargets": { + "description": "A list of actions that this action depends on.", + "items": { + "$ref": "Target" + }, + "type": "array" + }, + "disabled": { + "description": "Whether this action is disabled (i.e. should not be run).", + "type": "boolean" + }, + "parentAction": { + "$ref": "Target", + "description": "The parent action of this assertion. Only set if this assertion was automatically generated." + }, + "relationDescriptor": { + "$ref": "RelationDescriptor", + "description": "Descriptor for the assertion's automatically-generated view and its columns." + }, + "selectQuery": { + "description": "The SELECT query which must return zero rows in order for this assertion to succeed.", + "type": "string" + }, + "tags": { + "description": "Arbitrary, user-defined tags on this action.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "BigQueryAction": { + "description": "Represents a workflow action that will run against BigQuery.", + "id": "BigQueryAction", + "properties": { + "jobId": { + "description": "Output only. The ID of the BigQuery job that executed the SQL in sql_script. Only set once the job has started to run.", + "readOnly": true, + "type": "string" + }, + "sqlScript": { + "description": "Output only. The generated BigQuery SQL script that will be executed.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Binding": { + "description": "Associates `members`, or principals, with a `role`.", + "id": "Binding", + "properties": { + "condition": { + "$ref": "Expr", + "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." + }, + "members": { + "description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "role": { + "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).", + "type": "string" + } + }, + "type": "object" + }, + "CancelOperationRequest": { + "description": "The request message for Operations.CancelOperation.", + "id": "CancelOperationRequest", + "properties": {}, + "type": "object" + }, + "CancelWorkflowInvocationRequest": { + "description": "`CancelWorkflowInvocation` request message.", + "id": "CancelWorkflowInvocationRequest", + "properties": {}, + "type": "object" + }, + "CancelWorkflowInvocationResponse": { + "description": "`CancelWorkflowInvocation` response message.", + "id": "CancelWorkflowInvocationResponse", + "properties": {}, + "type": "object" + }, + "CodeCompilationConfig": { + "description": "Configures various aspects of Dataform code compilation.", + "id": "CodeCompilationConfig", + "properties": { + "assertionSchema": { + "description": "Optional. The default schema (BigQuery dataset ID) for assertions.", + "type": "string" + }, + "builtinAssertionNamePrefix": { + "description": "Optional. The prefix to prepend to built-in assertion names.", + "type": "string" + }, + "databaseSuffix": { + "description": "Optional. The suffix that should be appended to all database (Google Cloud project ID) names.", + "type": "string" + }, + "defaultDatabase": { + "description": "Optional. The default database (Google Cloud project ID).", + "type": "string" + }, + "defaultLocation": { + "description": "Optional. The default BigQuery location to use. Defaults to \"US\". See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations.", + "type": "string" + }, + "defaultNotebookRuntimeOptions": { + "$ref": "NotebookRuntimeOptions", + "description": "Optional. The default notebook runtime options." + }, + "defaultSchema": { + "description": "Optional. The default schema (BigQuery dataset ID).", + "type": "string" + }, + "schemaSuffix": { + "description": "Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.", + "type": "string" + }, + "tablePrefix": { + "description": "Optional. The prefix that should be prepended to all table names.", + "type": "string" + }, + "vars": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. User-defined variables that are made available to project code during compilation.", + "type": "object" + } + }, + "type": "object" + }, + "ColumnDescriptor": { + "description": "Describes a column.", + "id": "ColumnDescriptor", + "properties": { + "bigqueryPolicyTags": { + "description": "A list of BigQuery policy tags that will be applied to the column.", + "items": { + "type": "string" + }, + "type": "array" + }, + "description": { + "description": "A textual description of the column.", + "type": "string" + }, + "path": { + "description": "The identifier for the column. Each entry in `path` represents one level of nesting.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "CommitAuthor": { + "description": "Represents the author of a Git commit.", + "id": "CommitAuthor", + "properties": { + "emailAddress": { + "description": "Required. The commit author's email address.", + "type": "string" + }, + "name": { + "description": "Required. The commit author's name.", + "type": "string" + } + }, + "type": "object" + }, + "CommitLogEntry": { + "description": "Represents a single commit log.", + "id": "CommitLogEntry", + "properties": { + "author": { + "$ref": "CommitAuthor", + "description": "The commit author for this commit log entry." + }, + "commitMessage": { + "description": "The commit message for this commit log entry.", + "type": "string" + }, + "commitSha": { + "description": "The commit SHA for this commit log entry.", + "type": "string" + }, + "commitTime": { + "description": "Commit timestamp.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "CommitMetadata": { + "description": "Represents a Dataform Git commit.", + "id": "CommitMetadata", + "properties": { + "author": { + "$ref": "CommitAuthor", + "description": "Required. The commit's author." + }, + "commitMessage": { + "description": "Optional. The commit's message.", + "type": "string" + } + }, + "type": "object" + }, + "CommitRepositoryChangesRequest": { + "description": "`CommitRepositoryChanges` request message.", + "id": "CommitRepositoryChangesRequest", + "properties": { + "commitMetadata": { + "$ref": "CommitMetadata", + "description": "Required. The changes to commit to the repository." + }, + "fileOperations": { + "additionalProperties": { + "$ref": "FileOperation" + }, + "description": "Optional. A map to the path of the file to the operation. The path is the full file path including filename, from repository root.", + "type": "object" + }, + "requiredHeadCommitSha": { + "description": "Optional. The commit SHA which must be the repository's current HEAD before applying this commit; otherwise this request will fail. If unset, no validation on the current HEAD commit SHA is performed.", + "type": "string" + } + }, + "type": "object" + }, + "CommitRepositoryChangesResponse": { + "description": "`CommitRepositoryChanges` response message.", + "id": "CommitRepositoryChangesResponse", + "properties": { + "commitSha": { + "description": "The commit SHA of the current commit.", + "type": "string" + } + }, + "type": "object" + }, + "CommitWorkspaceChangesRequest": { + "description": "`CommitWorkspaceChanges` request message.", + "id": "CommitWorkspaceChangesRequest", + "properties": { + "author": { + "$ref": "CommitAuthor", + "description": "Required. The commit's author." + }, + "commitMessage": { + "description": "Optional. The commit's message.", + "type": "string" + }, + "paths": { + "description": "Optional. Full file paths to commit including filename, rooted at workspace root. If left empty, all files will be committed.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "CommitWorkspaceChangesResponse": { + "description": "`CommitWorkspaceChanges` response message.", + "id": "CommitWorkspaceChangesResponse", + "properties": {}, + "type": "object" + }, + "CompilationError": { + "description": "An error encountered when attempting to compile a Dataform project.", + "id": "CompilationError", + "properties": { + "actionTarget": { + "$ref": "Target", + "description": "Output only. The identifier of the action where this error occurred, if available.", + "readOnly": true + }, + "message": { + "description": "Output only. The error's top level message.", + "readOnly": true, + "type": "string" + }, + "path": { + "description": "Output only. The path of the file where this error occurred, if available, relative to the project root.", + "readOnly": true, + "type": "string" + }, + "stack": { + "description": "Output only. The error's full stack trace.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "CompilationResult": { + "description": "Represents the result of compiling a Dataform project.", + "id": "CompilationResult", + "properties": { + "codeCompilationConfig": { + "$ref": "CodeCompilationConfig", + "description": "Immutable. If set, fields of `code_compilation_config` override the default compilation settings that are specified in dataform.json." + }, + "compilationErrors": { + "description": "Output only. Errors encountered during project compilation.", + "items": { + "$ref": "CompilationError" + }, + "readOnly": true, + "type": "array" + }, + "createTime": { + "description": "Output only. The timestamp of when the compilation result was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "dataEncryptionState": { + "$ref": "DataEncryptionState", + "description": "Output only. Only set if the repository has a KMS Key.", + "readOnly": true + }, + "dataformCoreVersion": { + "description": "Output only. The version of `@dataform/core` that was used for compilation.", + "readOnly": true, + "type": "string" + }, + "gitCommitish": { + "description": "Immutable. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1`", + "type": "string" + }, + "internalMetadata": { + "description": "Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. The compilation result's name.", + "readOnly": true, + "type": "string" + }, + "releaseConfig": { + "description": "Immutable. The name of the release config to compile. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.", + "type": "string" + }, + "resolvedGitCommitSha": { + "description": "Output only. The fully resolved Git commit SHA of the code that was compiled. Not set for compilation results whose source is a workspace.", + "readOnly": true, + "type": "string" + }, + "workspace": { + "description": "Immutable. The name of the workspace to compile. Must be in the format `projects/*/locations/*/repositories/*/workspaces/*`.", + "type": "string" + } + }, + "type": "object" + }, + "CompilationResultAction": { + "description": "Represents a single Dataform action in a compilation result.", + "id": "CompilationResultAction", + "properties": { + "assertion": { + "$ref": "Assertion", + "description": "The assertion executed by this action." + }, + "canonicalTarget": { + "$ref": "Target", + "description": "The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result." + }, + "dataPreparation": { + "$ref": "DataPreparation", + "description": "The data preparation executed by this action." + }, + "declaration": { + "$ref": "Declaration", + "description": "The declaration declared by this action." + }, + "filePath": { + "description": "The full path including filename in which this action is located, relative to the workspace root.", + "type": "string" + }, + "internalMetadata": { + "description": "Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.", + "readOnly": true, + "type": "string" + }, + "notebook": { + "$ref": "Notebook", + "description": "The notebook executed by this action." + }, + "operations": { + "$ref": "Operations", + "description": "The database operations executed by this action." + }, + "relation": { + "$ref": "Relation", + "description": "The database relation created/updated by this action." + }, + "target": { + "$ref": "Target", + "description": "This action's identifier. Unique within the compilation result." + } + }, + "type": "object" + }, + "ComputeRepositoryAccessTokenStatusResponse": { + "description": "`ComputeRepositoryAccessTokenStatus` response message.", + "id": "ComputeRepositoryAccessTokenStatusResponse", + "properties": { + "tokenStatus": { + "description": "Indicates the status of the Git access token.", + "enum": [ + "TOKEN_STATUS_UNSPECIFIED", + "NOT_FOUND", + "INVALID", + "VALID" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "The token could not be found in Secret Manager (or the Dataform Service Account did not have permission to access it).", + "The token could not be used to authenticate against the Git remote.", + "The token was used successfully to authenticate against the Git remote." + ], + "type": "string" + } + }, + "type": "object" + }, + "Config": { + "description": "Config for all repositories in a given project and location.", + "id": "Config", + "properties": { + "defaultKmsKeyName": { + "description": "Optional. The default KMS key that is used if no encryption key is provided when a repository is created.", + "type": "string" + }, + "internalMetadata": { + "description": "Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Identifier. The config name.", + "type": "string" + } + }, + "type": "object" + }, + "DataEncryptionState": { + "description": "Describes encryption state of a resource.", + "id": "DataEncryptionState", + "properties": { + "kmsKeyVersionName": { + "description": "Required. The KMS key version name with which data of a resource is encrypted.", + "type": "string" + } + }, + "type": "object" + }, + "DataPreparation": { + "description": "Defines a compiled Data Preparation entity", + "id": "DataPreparation", + "properties": { + "contentsSql": { + "$ref": "SqlDefinition", + "description": "SQL definition for a Data Preparation. Contains a SQL query and additional context information." + }, + "contentsYaml": { + "description": "The data preparation definition, stored as a YAML string.", + "type": "string" + }, + "dependencyTargets": { + "description": "A list of actions that this action depends on.", + "items": { + "$ref": "Target" + }, + "type": "array" + }, + "disabled": { + "description": "Whether this action is disabled (i.e. should not be run).", + "type": "boolean" + }, + "tags": { + "description": "Arbitrary, user-defined tags on this action.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "DataPreparationAction": { + "description": "Represents a workflow action that will run a Data Preparation.", + "id": "DataPreparationAction", + "properties": { + "contentsSql": { + "$ref": "ActionSqlDefinition", + "description": "SQL definition for a Data Preparation. Contains a SQL query and additional context information." + }, + "contentsYaml": { + "description": "Output only. YAML representing the contents of the data preparation. Can be used to show the customer what the input was to their workflow.", + "readOnly": true, + "type": "string" + }, + "generatedSql": { + "description": "Output only. The generated BigQuery SQL script that will be executed. For reference only.", + "readOnly": true, + "type": "string" + }, + "jobId": { + "description": "Output only. The ID of the BigQuery job that executed the SQL in sql_script. Only set once the job has started to run.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Declaration": { + "description": "Represents a relation which is not managed by Dataform but which may be referenced by Dataform actions.", + "id": "Declaration", + "properties": { + "relationDescriptor": { + "$ref": "RelationDescriptor", + "description": "Descriptor for the relation and its columns. Used as documentation only, i.e. values here will result in no changes to the relation's metadata." + } + }, + "type": "object" + }, + "DeleteFile": { + "description": "Represents the delete file operation.", + "id": "DeleteFile", + "properties": {}, + "type": "object" + }, + "DirectoryEntry": { + "description": "Represents a single entry in a directory.", + "id": "DirectoryEntry", + "properties": { + "directory": { + "description": "A child directory in the directory.", + "type": "string" + }, + "file": { + "description": "A file in the directory.", + "type": "string" + } + }, + "type": "object" + }, + "DirectorySearchResult": { + "description": "Client-facing representation of a directory entry in search results.", + "id": "DirectorySearchResult", + "properties": { + "path": { + "description": "File system path relative to the workspace root.", + "type": "string" + } + }, + "type": "object" + }, + "Empty": { + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "ErrorTable": { + "description": "Error table information, used to write error data into a BigQuery table.", + "id": "ErrorTable", + "properties": { + "retentionDays": { + "description": "Error table partition expiration in days. Only positive values are allowed.", + "format": "int32", + "type": "integer" + }, + "target": { + "$ref": "Target", + "description": "Error Table target." + } + }, + "type": "object" + }, + "Expr": { + "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", + "id": "Expr", + "properties": { + "description": { + "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", + "type": "string" + }, + "expression": { + "description": "Textual representation of an expression in Common Expression Language syntax.", + "type": "string" + }, + "location": { + "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", + "type": "string" + }, + "title": { + "description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", + "type": "string" + } + }, + "type": "object" + }, + "FetchFileDiffResponse": { + "description": "`FetchFileDiff` response message.", + "id": "FetchFileDiffResponse", + "properties": { + "formattedDiff": { + "description": "The raw formatted Git diff for the file.", + "type": "string" + } + }, + "type": "object" + }, + "FetchFileGitStatusesResponse": { + "description": "`FetchFileGitStatuses` response message.", + "id": "FetchFileGitStatusesResponse", + "properties": { + "uncommittedFileChanges": { + "description": "A list of all files which have uncommitted Git changes. There will only be a single entry for any given file.", + "items": { + "$ref": "UncommittedFileChange" + }, + "type": "array" + } + }, + "type": "object" + }, + "FetchGitAheadBehindResponse": { + "description": "`FetchGitAheadBehind` response message.", + "id": "FetchGitAheadBehindResponse", + "properties": { + "commitsAhead": { + "description": "The number of commits in the remote branch that are not in the workspace.", + "format": "int32", + "type": "integer" + }, + "commitsBehind": { + "description": "The number of commits in the workspace that are not in the remote branch.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "FetchRemoteBranchesResponse": { + "description": "`FetchRemoteBranches` response message.", + "id": "FetchRemoteBranchesResponse", + "properties": { + "branches": { + "description": "The remote repository's branch names.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "FetchRepositoryHistoryResponse": { + "description": "`FetchRepositoryHistory` response message.", + "id": "FetchRepositoryHistoryResponse", + "properties": { + "commits": { + "description": "A list of commit logs, ordered by 'git log' default order.", + "items": { + "$ref": "CommitLogEntry" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, + "FileOperation": { + "description": "Represents a single file operation to the repository.", + "id": "FileOperation", + "properties": { + "deleteFile": { + "$ref": "DeleteFile", + "description": "Represents the delete operation." + }, + "writeFile": { + "$ref": "WriteFile", + "description": "Represents the write operation." + } + }, + "type": "object" + }, + "FileSearchResult": { + "description": "Client-facing representation of a file entry in search results.", + "id": "FileSearchResult", + "properties": { + "path": { + "description": "File system path relative to the workspace root.", + "type": "string" + } + }, + "type": "object" + }, + "GitRemoteSettings": { + "description": "Controls Git remote configuration for a repository.", + "id": "GitRemoteSettings", + "properties": { + "authenticationTokenSecretVersion": { + "description": "Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.", + "type": "string" + }, + "defaultBranch": { + "description": "Required. The Git remote's default branch name.", + "type": "string" + }, + "sshAuthenticationConfig": { + "$ref": "SshAuthenticationConfig", + "description": "Optional. Authentication fields for remote uris using SSH protocol." + }, + "tokenStatus": { + "deprecated": true, + "description": "Output only. Deprecated: The field does not contain any token status information.", + "enum": [ + "TOKEN_STATUS_UNSPECIFIED", + "NOT_FOUND", + "INVALID", + "VALID" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "The token could not be found in Secret Manager (or the Dataform Service Account did not have permission to access it).", + "The token could not be used to authenticate against the Git remote.", + "The token was used successfully to authenticate against the Git remote." + ], + "readOnly": true, + "type": "string" + }, + "url": { + "description": "Required. The Git remote's URL.", + "type": "string" + } + }, + "type": "object" + }, + "IamPolicyOverrideView": { + "description": "Contains metadata about the IAM policy override for a given Dataform resource. If is_active is true, this the policy encoded in iam_policy_name is the source of truth for this resource. Will be provided in internal ESV2 views for: Workspaces, Repositories, Folders, TeamFolders.", + "id": "IamPolicyOverrideView", + "properties": { + "iamPolicyName": { + "$ref": "PolicyName", + "description": "The IAM policy name for the resource." + }, + "isActive": { + "description": "Whether the IAM policy encoded in this view is active.", + "type": "boolean" + } + }, + "type": "object" + }, + "IncrementalLoadMode": { + "description": "Load definition for incremental load modes", + "id": "IncrementalLoadMode", + "properties": { + "column": { + "description": "Column name for incremental load modes", + "type": "string" + } + }, + "type": "object" + }, + "IncrementalTableConfig": { + "description": "Contains settings for relations of type `INCREMENTAL_TABLE`.", + "id": "IncrementalTableConfig", + "properties": { + "incrementalPostOperations": { + "description": "SQL statements to be executed after inserting new rows into the relation.", + "items": { + "type": "string" + }, + "type": "array" + }, + "incrementalPreOperations": { + "description": "SQL statements to be executed before inserting new rows into the relation.", + "items": { + "type": "string" + }, + "type": "array" + }, + "incrementalSelectQuery": { + "description": "The SELECT query which returns rows which should be inserted into the relation if it already exists and is not being refreshed.", + "type": "string" + }, + "refreshDisabled": { + "description": "Whether this table should be protected from being refreshed.", + "type": "boolean" + }, + "uniqueKeyParts": { + "description": "A set of columns or SQL expressions used to define row uniqueness. If any duplicates are discovered (as defined by `unique_key_parts`), only the newly selected rows (as defined by `incremental_select_query`) will be included in the relation.", + "items": { + "type": "string" + }, + "type": "array" + }, + "updatePartitionFilter": { + "description": "A SQL expression conditional used to limit the set of existing rows considered for a merge operation (see `unique_key_parts` for more information).", + "type": "string" + } + }, + "type": "object" + }, + "InstallNpmPackagesRequest": { + "description": "`InstallNpmPackages` request message.", + "id": "InstallNpmPackagesRequest", + "properties": {}, + "type": "object" + }, + "InstallNpmPackagesResponse": { + "description": "`InstallNpmPackages` response message.", + "id": "InstallNpmPackagesResponse", + "properties": {}, + "type": "object" + }, + "Interval": { + "description": "Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.", + "id": "Interval", + "properties": { + "endTime": { + "description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", + "format": "google-datetime", + "type": "string" + }, + "startTime": { + "description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "InvocationConfig": { + "description": "Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included.", + "id": "InvocationConfig", + "properties": { + "fullyRefreshIncrementalTablesEnabled": { + "description": "Optional. When set to true, any incremental tables will be fully refreshed.", + "type": "boolean" + }, + "includedTags": { + "description": "Optional. The set of tags to include.", + "items": { + "type": "string" + }, + "type": "array" + }, + "includedTargets": { + "description": "Optional. The set of action identifiers to include.", + "items": { + "$ref": "Target" + }, + "type": "array" + }, + "queryPriority": { + "description": "Optional. Specifies the priority for query execution in BigQuery. More information can be found at https://cloud.google.com/bigquery/docs/running-queries#queries.", + "enum": [ + "QUERY_PRIORITY_UNSPECIFIED", + "INTERACTIVE", + "BATCH" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Query will be executed in BigQuery with interactive priority. More information can be found at https://cloud.google.com/bigquery/docs/running-queries#queries.", + "Query will be executed in BigQuery with batch priority. More information can be found at https://cloud.google.com/bigquery/docs/running-queries#batchqueries." + ], + "type": "string" + }, + "serviceAccount": { + "description": "Optional. The service account to run workflow invocations under.", + "type": "string" + }, + "transitiveDependenciesIncluded": { + "description": "Optional. When set to true, transitive dependencies of included actions will be executed.", + "type": "boolean" + }, + "transitiveDependentsIncluded": { + "description": "Optional. When set to true, transitive dependents of included actions will be executed.", + "type": "boolean" + } + }, + "type": "object" + }, + "ListCompilationResultsResponse": { + "description": "`ListCompilationResults` response message.", + "id": "ListCompilationResultsResponse", + "properties": { + "compilationResults": { + "description": "List of compilation results.", + "items": { + "$ref": "CompilationResult" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "unreachable": { + "description": "Locations which could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListLocationsResponse": { + "description": "The response message for Locations.ListLocations.", + "id": "ListLocationsResponse", + "properties": { + "locations": { + "description": "A list of locations that matches the specified filter in the request.", + "items": { + "$ref": "Location" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + } + }, + "type": "object" + }, + "ListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "id": "ListOperationsResponse", + "properties": { + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + }, + "operations": { + "description": "A list of operations that matches the specified filter in the request.", + "items": { + "$ref": "Operation" + }, + "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListReleaseConfigsResponse": { + "description": "`ListReleaseConfigs` response message.", + "id": "ListReleaseConfigsResponse", + "properties": { + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "releaseConfigs": { + "description": "List of release configs.", + "items": { + "$ref": "ReleaseConfig" + }, + "type": "array" + }, + "unreachable": { + "description": "Locations which could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListRepositoriesResponse": { + "description": "`ListRepositories` response message.", + "id": "ListRepositoriesResponse", + "properties": { + "nextPageToken": { + "description": "A token which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "repositories": { + "description": "List of repositories.", + "items": { + "$ref": "Repository" + }, + "type": "array" + }, + "unreachable": { + "description": "Locations which could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListWorkflowConfigsResponse": { + "description": "`ListWorkflowConfigs` response message.", + "id": "ListWorkflowConfigsResponse", + "properties": { + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "unreachable": { + "description": "Locations which could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + }, + "workflowConfigs": { + "description": "List of workflow configs.", + "items": { + "$ref": "WorkflowConfig" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListWorkflowInvocationsResponse": { + "description": "`ListWorkflowInvocations` response message.", + "id": "ListWorkflowInvocationsResponse", + "properties": { + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "unreachable": { + "description": "Locations which could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + }, + "workflowInvocations": { + "description": "List of workflow invocations.", + "items": { + "$ref": "WorkflowInvocation" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListWorkspacesResponse": { + "description": "`ListWorkspaces` response message.", + "id": "ListWorkspacesResponse", + "properties": { + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "unreachable": { + "description": "Locations which could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + }, + "workspaces": { + "description": "List of workspaces.", + "items": { + "$ref": "Workspace" + }, + "type": "array" + } + }, + "type": "object" + }, + "LoadConfig": { + "description": "Simplified load configuration for actions", + "id": "LoadConfig", + "properties": { + "append": { + "$ref": "SimpleLoadMode", + "description": "Append into destination table" + }, + "maximum": { + "$ref": "IncrementalLoadMode", + "description": "Insert records where the value exceeds the previous maximum value for a column in the destination table" + }, + "replace": { + "$ref": "SimpleLoadMode", + "description": "Replace destination table" + }, + "unique": { + "$ref": "IncrementalLoadMode", + "description": "Insert records where the value of a column is not already present in the destination table" + } + }, + "type": "object" + }, + "Location": { + "description": "A resource that represents a Google Cloud location.", + "id": "Location", + "properties": { + "displayName": { + "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", + "type": "object" + }, + "locationId": { + "description": "The canonical id for this location. For example: `\"us-east1\"`.", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata. For example the available capacity at the given location.", + "type": "object" + }, + "name": { + "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", + "type": "string" + } + }, + "type": "object" + }, + "MakeDirectoryRequest": { + "description": "`MakeDirectory` request message.", + "id": "MakeDirectoryRequest", + "properties": { + "path": { + "description": "Required. The directory's full path including directory name, relative to the workspace root.", + "type": "string" + } + }, + "type": "object" + }, + "MakeDirectoryResponse": { + "description": "`MakeDirectory` response message.", + "id": "MakeDirectoryResponse", + "properties": {}, + "type": "object" + }, + "MoveDirectoryRequest": { + "description": "`MoveDirectory` request message.", + "id": "MoveDirectoryRequest", + "properties": { + "newPath": { + "description": "Required. The new path for the directory including directory name, rooted at workspace root.", + "type": "string" + }, + "path": { + "description": "Required. The directory's full path including directory name, relative to the workspace root.", + "type": "string" + } + }, + "type": "object" + }, + "MoveDirectoryResponse": { + "description": "`MoveDirectory` response message.", + "id": "MoveDirectoryResponse", + "properties": {}, + "type": "object" + }, + "MoveFileRequest": { + "description": "`MoveFile` request message.", + "id": "MoveFileRequest", + "properties": { + "newPath": { + "description": "Required. The file's new path including filename, relative to the workspace root.", + "type": "string" + }, + "path": { + "description": "Required. The file's full path including filename, relative to the workspace root.", + "type": "string" + } + }, + "type": "object" + }, + "MoveFileResponse": { + "description": "`MoveFile` response message.", + "id": "MoveFileResponse", + "properties": {}, + "type": "object" + }, + "Notebook": { + "description": "Represents a notebook.", + "id": "Notebook", + "properties": { + "contents": { + "description": "The contents of the notebook.", + "type": "string" + }, + "dependencyTargets": { + "description": "A list of actions that this action depends on.", + "items": { + "$ref": "Target" + }, + "type": "array" + }, + "disabled": { + "description": "Whether this action is disabled (i.e. should not be run).", + "type": "boolean" + }, + "tags": { + "description": "Arbitrary, user-defined tags on this action.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "NotebookAction": { + "description": "Represents a workflow action that will run against a Notebook runtime.", + "id": "NotebookAction", + "properties": { + "contents": { + "description": "Output only. The code contents of a Notebook to be run.", + "readOnly": true, + "type": "string" + }, + "jobId": { + "description": "Output only. The ID of the Vertex job that executed the notebook in contents and also the ID used for the outputs created in Google Cloud Storage buckets. Only set once the job has started to run.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "NotebookRuntimeOptions": { + "description": "Configures various aspects of Dataform notebook runtime.", + "id": "NotebookRuntimeOptions", + "properties": { + "aiPlatformNotebookRuntimeTemplate": { + "description": "Optional. The resource name of the [Colab runtime template] (https://cloud.google.com/colab/docs/runtimes), from which a runtime is created for notebook executions. If not specified, a runtime is created with Colab's default specifications.", + "type": "string" + }, + "gcsOutputBucket": { + "description": "Optional. The Google Cloud Storage location to upload the result to. Format: `gs://bucket-name`.", + "type": "string" + } + }, + "type": "object" + }, + "Operation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "Operation", + "properties": { + "done": { + "description": "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.", + "type": "boolean" + }, + "error": { + "$ref": "Status", + "description": "The error result of the operation in case of failure or cancellation." + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "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.", + "type": "object" + }, + "name": { + "description": "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}`.", + "type": "string" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "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`.", + "type": "object" + } + }, + "type": "object" + }, + "OperationMetadata": { + "description": "Represents the metadata of the long-running operation.", + "id": "OperationMetadata", + "properties": { + "apiVersion": { + "description": "Output only. API version used to start the operation.", + "readOnly": true, + "type": "string" + }, + "cancelRequested": { + "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have google.longrunning.Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "readOnly": true, + "type": "boolean" + }, + "createTime": { + "description": "Output only. The time the operation was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "statusDetail": { + "description": "Output only. Human-readable status of the operation, if any.", + "readOnly": true, + "type": "string" + }, + "target": { + "description": "Output only. Server-defined resource path for the target of the operation.", + "readOnly": true, + "type": "string" + }, + "verb": { + "description": "Output only. Name of the verb executed by the operation.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Operations": { + "description": "Represents a list of arbitrary database operations.", + "id": "Operations", + "properties": { + "dependencyTargets": { + "description": "A list of actions that this action depends on.", + "items": { + "$ref": "Target" + }, + "type": "array" + }, + "disabled": { + "description": "Whether this action is disabled (i.e. should not be run).", + "type": "boolean" + }, + "hasOutput": { + "description": "Whether these operations produce an output relation.", + "type": "boolean" + }, + "queries": { + "description": "A list of arbitrary SQL statements that will be executed without alteration.", + "items": { + "type": "string" + }, + "type": "array" + }, + "relationDescriptor": { + "$ref": "RelationDescriptor", + "description": "Descriptor for any output relation and its columns. Only set if `has_output` is true." + }, + "tags": { + "description": "Arbitrary, user-defined tags on this action.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "Policy": { + "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", + "id": "Policy", + "properties": { + "bindings": { + "description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.", + "items": { + "$ref": "Binding" + }, + "type": "array" + }, + "etag": { + "description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.", + "format": "byte", + "type": "string" + }, + "version": { + "description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "PolicyName": { + "description": "An internal name for an IAM policy, based on the resource to which the policy applies. Not to be confused with a resource's external full resource name. For more information on this distinction, see go/iam-full-resource-names.", + "id": "PolicyName", + "properties": { + "id": { + "description": "Identifies an instance of the type. ID format varies by type. The ID format is defined in the IAM .service file that defines the type, either in path_mapping or in a comment.", + "type": "string" + }, + "region": { + "description": "For Cloud IAM: The location of the Policy. Must be empty or \"global\" for Policies owned by global IAM. Must name a region from prodspec/cloud-iam-cloudspec for Regional IAM Policies, see go/iam-faq#where-is-iam-currently-deployed. For Local IAM: This field should be set to \"local\".", + "type": "string" + }, + "type": { + "description": "Resource type. Types are defined in IAM's .service files. Valid values for type might be 'storage_buckets', 'compute_instances', 'resourcemanager_customers', 'billing_accounts', etc.", + "type": "string" + } + }, + "type": "object" + }, + "PullGitCommitsRequest": { + "description": "`PullGitCommits` request message.", + "id": "PullGitCommitsRequest", + "properties": { + "author": { + "$ref": "CommitAuthor", + "description": "Required. The author of any merge commit which may be created as a result of merging fetched Git commits into this workspace." + }, + "remoteBranch": { + "description": "Optional. The name of the branch in the Git remote from which to pull commits. If left unset, the repository's default branch name will be used.", + "type": "string" + } + }, + "type": "object" + }, + "PullGitCommitsResponse": { + "description": "`PullGitCommits` response message.", + "id": "PullGitCommitsResponse", + "properties": {}, + "type": "object" + }, + "PushGitCommitsRequest": { + "description": "`PushGitCommits` request message.", + "id": "PushGitCommitsRequest", + "properties": { + "remoteBranch": { + "description": "Optional. The name of the branch in the Git remote to which commits should be pushed. If left unset, the repository's default branch name will be used.", + "type": "string" + } + }, + "type": "object" + }, + "PushGitCommitsResponse": { + "description": "`PushGitCommits` response message.", + "id": "PushGitCommitsResponse", + "properties": {}, + "type": "object" + }, + "QueryCompilationResultActionsResponse": { + "description": "`QueryCompilationResultActions` response message.", + "id": "QueryCompilationResultActionsResponse", + "properties": { + "compilationResultActions": { + "description": "List of compilation result actions.", + "items": { + "$ref": "CompilationResultAction" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, + "QueryDirectoryContentsResponse": { + "description": "`QueryDirectoryContents` response message.", + "id": "QueryDirectoryContentsResponse", + "properties": { + "directoryEntries": { + "description": "List of entries in the directory.", + "items": { + "$ref": "DirectoryEntry" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, + "QueryRepositoryDirectoryContentsResponse": { + "description": "`QueryRepositoryDirectoryContents` response message.", + "id": "QueryRepositoryDirectoryContentsResponse", + "properties": { + "directoryEntries": { + "description": "List of entries in the directory.", + "items": { + "$ref": "DirectoryEntry" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, + "QueryWorkflowInvocationActionsResponse": { + "description": "`QueryWorkflowInvocationActions` response message.", + "id": "QueryWorkflowInvocationActionsResponse", + "properties": { + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "workflowInvocationActions": { + "description": "List of workflow invocation actions.", + "items": { + "$ref": "WorkflowInvocationAction" + }, + "type": "array" + } + }, + "type": "object" + }, + "ReadFileResponse": { + "description": "`ReadFile` response message.", + "id": "ReadFileResponse", + "properties": { + "fileContents": { + "description": "The file's contents.", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, + "ReadRepositoryFileResponse": { + "description": "`ReadRepositoryFile` response message.", + "id": "ReadRepositoryFileResponse", + "properties": { + "contents": { + "description": "The file's contents.", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, + "Relation": { + "description": "Represents a database relation.", + "id": "Relation", + "properties": { + "additionalOptions": { + "additionalProperties": { + "type": "string" + }, + "description": "Additional options that will be provided as key/value pairs into the options clause of a create table/view statement. See https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language for more information on which options are supported.", + "type": "object" + }, + "clusterExpressions": { + "description": "A list of columns or SQL expressions used to cluster the table.", + "items": { + "type": "string" + }, + "type": "array" + }, + "dependencyTargets": { + "description": "A list of actions that this action depends on.", + "items": { + "$ref": "Target" + }, + "type": "array" + }, + "disabled": { + "description": "Whether this action is disabled (i.e. should not be run).", + "type": "boolean" + }, + "incrementalTableConfig": { + "$ref": "IncrementalTableConfig", + "description": "Configures `INCREMENTAL_TABLE` settings for this relation. Only set if `relation_type` is `INCREMENTAL_TABLE`." + }, + "partitionExpirationDays": { + "description": "Sets the partition expiration in days.", + "format": "int32", + "type": "integer" + }, + "partitionExpression": { + "description": "The SQL expression used to partition the relation.", + "type": "string" + }, + "postOperations": { + "description": "SQL statements to be executed after creating the relation.", + "items": { + "type": "string" + }, + "type": "array" + }, + "preOperations": { + "description": "SQL statements to be executed before creating the relation.", + "items": { + "type": "string" + }, + "type": "array" + }, + "relationDescriptor": { + "$ref": "RelationDescriptor", + "description": "Descriptor for the relation and its columns." + }, + "relationType": { + "description": "The type of this relation.", + "enum": [ + "RELATION_TYPE_UNSPECIFIED", + "TABLE", + "VIEW", + "INCREMENTAL_TABLE", + "MATERIALIZED_VIEW" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "The relation is a table.", + "The relation is a view.", + "The relation is an incrementalized table.", + "The relation is a materialized view." + ], + "type": "string" + }, + "requirePartitionFilter": { + "description": "Specifies whether queries on this table must include a predicate filter that filters on the partitioning column.", + "type": "boolean" + }, + "selectQuery": { + "description": "The SELECT query which returns rows which this relation should contain.", + "type": "string" + }, + "tags": { + "description": "Arbitrary, user-defined tags on this action.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "RelationDescriptor": { + "description": "Describes a relation and its columns.", + "id": "RelationDescriptor", + "properties": { + "bigqueryLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "A set of BigQuery labels that should be applied to the relation.", + "type": "object" + }, + "columns": { + "description": "A list of descriptions of columns within the relation.", + "items": { + "$ref": "ColumnDescriptor" + }, + "type": "array" + }, + "description": { + "description": "A text description of the relation.", + "type": "string" + } + }, + "type": "object" + }, + "ReleaseConfig": { + "description": "Represents a Dataform release configuration.", + "id": "ReleaseConfig", + "properties": { + "codeCompilationConfig": { + "$ref": "CodeCompilationConfig", + "description": "Optional. If set, fields of `code_compilation_config` override the default compilation settings that are specified in dataform.json." + }, + "cronSchedule": { + "description": "Optional. Optional schedule (in cron format) for automatic creation of compilation results.", + "type": "string" + }, + "disabled": { + "description": "Optional. Disables automatic creation of compilation results.", + "type": "boolean" + }, + "gitCommitish": { + "description": "Required. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1`", + "type": "string" + }, + "internalMetadata": { + "description": "Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Identifier. The release config's name.", + "type": "string" + }, + "recentScheduledReleaseRecords": { + "description": "Output only. Records of the 10 most recent scheduled release attempts, ordered in descending order of `release_time`. Updated whenever automatic creation of a compilation result is triggered by cron_schedule.", + "items": { + "$ref": "ScheduledReleaseRecord" + }, + "readOnly": true, + "type": "array" + }, + "releaseCompilationResult": { + "description": "Optional. The name of the currently released compilation result for this release config. This value is updated when a compilation result is automatically created from this release config (using cron_schedule), or when this resource is updated by API call (perhaps to roll back to an earlier release). The compilation result must have been created using this release config. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.", + "type": "string" + }, + "timeZone": { + "description": "Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.", + "type": "string" + } + }, + "type": "object" + }, + "RemoveDirectoryRequest": { + "description": "`RemoveDirectory` request message.", + "id": "RemoveDirectoryRequest", + "properties": { + "path": { + "description": "Required. The directory's full path including directory name, relative to the workspace root.", + "type": "string" + } + }, + "type": "object" + }, + "RemoveDirectoryResponse": { + "description": "`RemoveDirectory` response message.", + "id": "RemoveDirectoryResponse", + "properties": {}, + "type": "object" + }, + "RemoveFileRequest": { + "description": "`RemoveFile` request message.", + "id": "RemoveFileRequest", + "properties": { + "path": { + "description": "Required. The file's full path including filename, relative to the workspace root.", + "type": "string" + } + }, + "type": "object" + }, + "RemoveFileResponse": { + "description": "`RemoveFile` response message.", + "id": "RemoveFileResponse", + "properties": {}, + "type": "object" + }, + "Repository": { + "description": "Represents a Dataform Git repository.", + "id": "Repository", + "properties": { + "createTime": { + "description": "Output only. The timestamp of when the repository was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "dataEncryptionState": { + "$ref": "DataEncryptionState", + "description": "Output only. A data encryption state of a Git repository if this Repository is protected by a KMS key.", + "readOnly": true + }, + "displayName": { + "description": "Optional. The repository's user-friendly name.", + "type": "string" + }, + "gitRemoteSettings": { + "$ref": "GitRemoteSettings", + "description": "Optional. If set, configures this repository to be linked to a Git remote." + }, + "internalMetadata": { + "description": "Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.", + "readOnly": true, + "type": "string" + }, + "kmsKeyName": { + "description": "Optional. The reference to a KMS encryption key. If provided, it will be used to encrypt user data in the repository and all child resources. It is not possible to add or update the encryption key after the repository is created. Example: `projects/{kms_project}/locations/{location}/keyRings/{key_location}/cryptoKeys/{key}`", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Repository user labels.", + "type": "object" + }, + "name": { + "description": "Identifier. The repository's name.", + "type": "string" + }, + "npmrcEnvironmentVariablesSecretVersion": { + "description": "Optional. The name of the Secret Manager secret version to be used to interpolate variables into the .npmrc file for package installation operations. Must be in the format `projects/*/secrets/*/versions/*`. The file itself must be in a JSON format.", + "type": "string" + }, + "serviceAccount": { + "description": "Optional. The service account to run workflow invocations under.", + "type": "string" + }, + "setAuthenticatedUserAdmin": { + "description": "Optional. Input only. If set to true, the authenticated user will be granted the roles/dataform.admin role on the created repository.", + "type": "boolean" + }, + "workspaceCompilationOverrides": { + "$ref": "WorkspaceCompilationOverrides", + "description": "Optional. If set, fields of `workspace_compilation_overrides` override the default compilation settings that are specified in dataform.json when creating workspace-scoped compilation results. See documentation for `WorkspaceCompilationOverrides` for more information." + } + }, + "type": "object" + }, + "ResetWorkspaceChangesRequest": { + "description": "`ResetWorkspaceChanges` request message.", + "id": "ResetWorkspaceChangesRequest", + "properties": { + "clean": { + "description": "Optional. If set to true, untracked files will be deleted.", + "type": "boolean" + }, + "paths": { + "description": "Optional. Full file paths to reset back to their committed state including filename, rooted at workspace root. If left empty, all files will be reset.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ResetWorkspaceChangesResponse": { + "description": "`ResetWorkspaceChanges` response message.", + "id": "ResetWorkspaceChangesResponse", + "properties": {}, + "type": "object" + }, + "ScheduledExecutionRecord": { + "description": "A record of an attempt to create a workflow invocation for this workflow config.", + "id": "ScheduledExecutionRecord", + "properties": { + "errorStatus": { + "$ref": "Status", + "description": "The error status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful." + }, + "executionTime": { + "description": "Output only. The timestamp of this execution attempt.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "workflowInvocation": { + "description": "The name of the created workflow invocation, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/workflowInvocations/*`.", + "type": "string" + } + }, + "type": "object" + }, + "ScheduledReleaseRecord": { + "description": "A record of an attempt to create a compilation result for this release config.", + "id": "ScheduledReleaseRecord", + "properties": { + "compilationResult": { + "description": "The name of the created compilation result, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.", + "type": "string" + }, + "errorStatus": { + "$ref": "Status", + "description": "The error status encountered upon this attempt to create the compilation result, if the attempt was unsuccessful." + }, + "releaseTime": { + "description": "Output only. The timestamp of this release attempt.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "SearchFilesResponse": { + "description": "Client-facing representation of a file search response.", + "id": "SearchFilesResponse", + "properties": { + "nextPageToken": { + "description": "Optional. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "searchResults": { + "description": "List of matched results.", + "items": { + "$ref": "SearchResult" + }, + "type": "array" + } + }, + "type": "object" + }, + "SearchResult": { + "description": "Client-facing representation of a search result entry.", + "id": "SearchResult", + "properties": { + "directory": { + "$ref": "DirectorySearchResult", + "description": "Details when search result is a directory." + }, + "file": { + "$ref": "FileSearchResult", + "description": "Details when search result is a file." + } + }, + "type": "object" + }, + "SetIamPolicyRequest": { + "description": "Request message for `SetIamPolicy` method.", + "id": "SetIamPolicyRequest", + "properties": { + "policy": { + "$ref": "Policy", + "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them." + } + }, + "type": "object" + }, + "SimpleLoadMode": { + "description": "Simple load definition", + "id": "SimpleLoadMode", + "properties": {}, + "type": "object" + }, + "SqlDefinition": { + "description": "Definition of a SQL Data Preparation", + "id": "SqlDefinition", + "properties": { + "errorTable": { + "$ref": "ErrorTable", + "description": "Error table configuration," + }, + "load": { + "$ref": "LoadConfig", + "description": "Load configuration." + }, + "query": { + "description": "The SQL query representing the data preparation steps. Formatted as a Pipe SQL query statement.", + "type": "string" + } + }, + "type": "object" + }, + "SshAuthenticationConfig": { + "description": "Configures fields for performing SSH authentication.", + "id": "SshAuthenticationConfig", + "properties": { + "hostPublicKey": { + "description": "Required. Content of a public SSH key to verify an identity of a remote Git host.", + "type": "string" + }, + "userPrivateKeySecretVersion": { + "description": "Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.", + "type": "string" + } + }, + "type": "object" + }, + "Status": { + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", + "id": "Status", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "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.", + "type": "string" + } + }, + "type": "object" + }, + "Target": { + "description": "Represents an action identifier. If the action writes output, the output will be written to the referenced database object.", + "id": "Target", + "properties": { + "database": { + "description": "Optional. The action's database (Google Cloud project ID) .", + "type": "string" + }, + "name": { + "description": "Optional. The action's name, within `database` and `schema`.", + "type": "string" + }, + "schema": { + "description": "Optional. The action's schema (BigQuery dataset ID), within `database`.", + "type": "string" + } + }, + "type": "object" + }, + "TestIamPermissionsRequest": { + "description": "Request message for `TestIamPermissions` method.", + "id": "TestIamPermissionsRequest", + "properties": { + "permissions": { + "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "TestIamPermissionsResponse": { + "description": "Response message for `TestIamPermissions` method.", + "id": "TestIamPermissionsResponse", + "properties": { + "permissions": { + "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "UncommittedFileChange": { + "description": "Represents the Git state of a file with uncommitted changes.", + "id": "UncommittedFileChange", + "properties": { + "path": { + "description": "The file's full path including filename, relative to the workspace root.", + "type": "string" + }, + "state": { + "description": "Output only. Indicates the status of the file.", + "enum": [ + "STATE_UNSPECIFIED", + "ADDED", + "DELETED", + "MODIFIED", + "HAS_CONFLICTS" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "The file has been newly added.", + "The file has been deleted.", + "The file has been modified.", + "The file contains merge conflicts." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "WorkflowConfig": { + "description": "Represents a Dataform workflow configuration.", + "id": "WorkflowConfig", + "properties": { + "createTime": { + "description": "Output only. The timestamp of when the WorkflowConfig was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "cronSchedule": { + "description": "Optional. Optional schedule (in cron format) for automatic execution of this workflow config.", + "type": "string" + }, + "disabled": { + "description": "Optional. Disables automatic creation of workflow invocations.", + "type": "boolean" + }, + "internalMetadata": { + "description": "Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.", + "readOnly": true, + "type": "string" + }, + "invocationConfig": { + "$ref": "InvocationConfig", + "description": "Optional. If left unset, a default InvocationConfig will be used." + }, + "name": { + "description": "Identifier. The workflow config's name.", + "type": "string" + }, + "recentScheduledExecutionRecords": { + "description": "Output only. Records of the 10 most recent scheduled execution attempts, ordered in descending order of `execution_time`. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.", + "items": { + "$ref": "ScheduledExecutionRecord" + }, + "readOnly": true, + "type": "array" + }, + "releaseConfig": { + "description": "Required. The name of the release config whose release_compilation_result should be executed. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.", + "type": "string" + }, + "timeZone": { + "description": "Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.", + "type": "string" + }, + "updateTime": { + "description": "Output only. The timestamp of when the WorkflowConfig was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "WorkflowInvocation": { + "description": "Represents a single invocation of a compilation result.", + "id": "WorkflowInvocation", + "properties": { + "compilationResult": { + "description": "Immutable. The name of the compilation result to use for this invocation. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.", + "type": "string" + }, + "dataEncryptionState": { + "$ref": "DataEncryptionState", + "description": "Output only. Only set if the repository has a KMS Key.", + "readOnly": true + }, + "internalMetadata": { + "description": "Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.", + "readOnly": true, + "type": "string" + }, + "invocationConfig": { + "$ref": "InvocationConfig", + "description": "Immutable. If left unset, a default InvocationConfig will be used." + }, + "invocationTiming": { + "$ref": "Interval", + "description": "Output only. This workflow invocation's timing details.", + "readOnly": true + }, + "name": { + "description": "Output only. The workflow invocation's name.", + "readOnly": true, + "type": "string" + }, + "resolvedCompilationResult": { + "description": "Output only. The resolved compilation result that was used to create this invocation. Will be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. This workflow invocation's current state.", + "enum": [ + "STATE_UNSPECIFIED", + "RUNNING", + "SUCCEEDED", + "CANCELLED", + "FAILED", + "CANCELING" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "The workflow invocation is currently running.", + "The workflow invocation succeeded. A terminal state.", + "The workflow invocation was cancelled. A terminal state.", + "The workflow invocation failed. A terminal state.", + "The workflow invocation is being cancelled, but some actions are still running." + ], + "readOnly": true, + "type": "string" + }, + "workflowConfig": { + "description": "Immutable. The name of the workflow config to invoke. Must be in the format `projects/*/locations/*/repositories/*/workflowConfigs/*`.", + "type": "string" + } + }, + "type": "object" + }, + "WorkflowInvocationAction": { + "description": "Represents a single action in a workflow invocation.", + "id": "WorkflowInvocationAction", + "properties": { + "bigqueryAction": { + "$ref": "BigQueryAction", + "description": "Output only. The workflow action's bigquery action details.", + "readOnly": true + }, + "canonicalTarget": { + "$ref": "Target", + "description": "Output only. The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result.", + "readOnly": true + }, + "dataPreparationAction": { + "$ref": "DataPreparationAction", + "description": "Output only. The workflow action's data preparation action details.", + "readOnly": true + }, + "failureReason": { + "description": "Output only. If and only if action's state is FAILED a failure reason is set.", + "readOnly": true, + "type": "string" + }, + "internalMetadata": { + "description": "Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.", + "readOnly": true, + "type": "string" + }, + "invocationTiming": { + "$ref": "Interval", + "description": "Output only. This action's timing details. `start_time` will be set if the action is in [RUNNING, SUCCEEDED, CANCELLED, FAILED] state. `end_time` will be set if the action is in [SUCCEEDED, CANCELLED, FAILED] state.", + "readOnly": true + }, + "notebookAction": { + "$ref": "NotebookAction", + "description": "Output only. The workflow action's notebook action details.", + "readOnly": true + }, + "state": { + "description": "Output only. This action's current state.", + "enum": [ + "PENDING", + "RUNNING", + "SKIPPED", + "DISABLED", + "SUCCEEDED", + "CANCELLED", + "FAILED" + ], + "enumDescriptions": [ + "The action has not yet been considered for invocation.", + "The action is currently running.", + "Execution of the action was skipped because upstream dependencies did not all complete successfully. A terminal state.", + "Execution of the action was disabled as per the configuration of the corresponding compilation result action. A terminal state.", + "The action succeeded. A terminal state.", + "The action was cancelled. A terminal state.", + "The action failed. A terminal state." + ], + "readOnly": true, + "type": "string" + }, + "target": { + "$ref": "Target", + "description": "Output only. This action's identifier. Unique within the workflow invocation.", + "readOnly": true + } + }, + "type": "object" + }, + "Workspace": { + "description": "Represents a Dataform Git workspace.", + "id": "Workspace", + "properties": { + "createTime": { + "description": "Output only. The timestamp of when the workspace was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "dataEncryptionState": { + "$ref": "DataEncryptionState", + "description": "Output only. A data encryption state of a Git repository if this Workspace is protected by a KMS key.", + "readOnly": true + }, + "internalMetadata": { + "description": "Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Identifier. The workspace's name.", + "type": "string" + } + }, + "type": "object" + }, + "WorkspaceCompilationOverrides": { + "description": "Configures workspace compilation overrides for a repository.", + "id": "WorkspaceCompilationOverrides", + "properties": { + "defaultDatabase": { + "description": "Optional. The default database (Google Cloud project ID).", + "type": "string" + }, + "schemaSuffix": { + "description": "Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.", + "type": "string" + }, + "tablePrefix": { + "description": "Optional. The prefix that should be prepended to all table names.", + "type": "string" + } + }, + "type": "object" + }, + "WriteFile": { + "description": "Represents the write file operation (for files added or modified).", + "id": "WriteFile", + "properties": { + "contents": { + "description": "The file's contents.", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, + "WriteFileRequest": { + "description": "`WriteFile` request message.", + "id": "WriteFileRequest", + "properties": { + "contents": { + "description": "Required. The file's contents.", + "format": "byte", + "type": "string" + }, + "path": { + "description": "Required. The file.", + "type": "string" + } + }, + "type": "object" + }, + "WriteFileResponse": { + "description": "`WriteFile` response message.", + "id": "WriteFileResponse", + "properties": {}, + "type": "object" + } + }, + "servicePath": "", + "title": "Dataform API", + "version": "v1", + "version_module": true +} \ No newline at end of file diff --git a/discovery/dataplex-v1.json b/discovery/dataplex-v1.json index 18b16f01f7..9f3e58905b 100644 --- a/discovery/dataplex-v1.json +++ b/discovery/dataplex-v1.json @@ -786,7 +786,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -7260,7 +7260,7 @@ } } }, - "revision": "20251012", + "revision": "20251027", "rootUrl": "https://dataplex.googleapis.com/", "schemas": { "Empty": { @@ -9162,6 +9162,11 @@ "description": "The output of a DataQualityScan.", "id": "GoogleCloudDataplexV1DataQualityResult", "properties": { + "anomalyDetectionGeneratedAssets": { + "$ref": "GoogleCloudDataplexV1DataQualityResultAnomalyDetectionGeneratedAssets", + "description": "Output only. The generated assets for anomaly detection.", + "readOnly": true + }, "catalogPublishingStatus": { "$ref": "GoogleCloudDataplexV1DataScanCatalogPublishingStatus", "description": "Output only. The status of publishing the data scan as Dataplex Universal Catalog metadata.", @@ -9221,6 +9226,33 @@ }, "type": "object" }, + "GoogleCloudDataplexV1DataQualityResultAnomalyDetectionGeneratedAssets": { + "description": "The assets generated by Anomaly Detection Data Scan.", + "id": "GoogleCloudDataplexV1DataQualityResultAnomalyDetectionGeneratedAssets", + "properties": { + "dataIntermediateTable": { + "description": "Output only. The intermediate table for data anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID", + "readOnly": true, + "type": "string" + }, + "freshnessIntermediateTable": { + "description": "Output only. The intermediate table for freshness anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID", + "readOnly": true, + "type": "string" + }, + "resultTable": { + "description": "Output only. The result table for anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID If the result table is set at AnomalyDetectionAssets, the result table here would be the same as the one set in the AnomalyDetectionAssets.result_table.", + "readOnly": true, + "type": "string" + }, + "volumeIntermediateTable": { + "description": "Output only. The intermediate table for volume anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDataplexV1DataQualityResultPostScanActionsResult": { "description": "The result of post scan actions of DataQualityScan job.", "id": "GoogleCloudDataplexV1DataQualityResultPostScanActionsResult", @@ -9995,14 +10027,12 @@ "enum": [ "TRIGGER_UNSPECIFIED", "ON_DEMAND", - "SCHEDULE", - "ONE_TIME" + "SCHEDULE" ], "enumDescriptions": [ "An unspecified trigger type.", "Data scan triggers on demand.", - "Data scan triggers as per schedule.", - "Data scan is run one time on creation." + "Data scan triggers as per schedule." ], "type": "string" }, diff --git a/discovery/dataproc-v1.json b/discovery/dataproc-v1.json index 063cd06b3f..d09d7be05f 100644 --- a/discovery/dataproc-v1.json +++ b/discovery/dataproc-v1.json @@ -5022,7 +5022,7 @@ } } }, - "revision": "20251003", + "revision": "20251021", "rootUrl": "https://dataproc.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -5229,6 +5229,7 @@ "type": "string" }, "requestorId": { + "deprecated": true, "description": "Optional. The requestor ID is used to identify if the request comes from a GCA investigation or the old Ask Gemini Experience. ", "type": "string" } @@ -9289,7 +9290,7 @@ "id": "PySparkJob", "properties": { "archiveUris": { - "description": "Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.", + "description": "Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.Note: Spark applications must be deployed in cluster mode (https://spark.apache.org/docs/latest/cluster-overview.html) for correct environment propagation.", "items": { "type": "string" }, diff --git a/discovery/datastream-v1.json b/discovery/datastream-v1.json index 37151f401f..b78b470131 100644 --- a/discovery/datastream-v1.json +++ b/discovery/datastream-v1.json @@ -560,6 +560,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}/operations", @@ -1261,7 +1266,7 @@ } } }, - "revision": "20250827", + "revision": "20251021", "rootUrl": "https://datastream.googleapis.com/", "schemas": { "AppendOnly": { @@ -1782,6 +1787,17 @@ }, "type": "object" }, + "EventFilter": { + "description": "Represents a filter for included data on a stream object.", + "id": "EventFilter", + "properties": { + "sqlWhereClause": { + "description": "An SQL-query Where clause selecting which data should be included, not including the \"WHERE\" keyword. E.g., \"t.key1 = 'value1' AND t.key2 = 'value2'\".", + "type": "string" + } + }, + "type": "object" + }, "FetchStaticIpsResponse": { "description": "Response message for a 'FetchStaticIps' response.", "id": "FetchStaticIpsResponse", @@ -1986,6 +2002,13 @@ "$ref": "Operation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -2160,7 +2183,7 @@ "id": "MongodbChangeStreamPosition", "properties": { "startTime": { - "description": "Required. The timestamp (in epoch seconds) to start change stream from.", + "description": "Required. The timestamp to start change stream from.", "format": "google-datetime", "type": "string" } @@ -3821,7 +3844,12 @@ "StartBackfillJobRequest": { "description": "Request for manually initiating a backfill job for a specific stream object.", "id": "StartBackfillJobRequest", - "properties": {}, + "properties": { + "eventFilter": { + "$ref": "EventFilter", + "description": "Optional. Optional event filter. If not set, or empty, the backfill will be performed on the entire object. This is currently used for partial backfill and only supported for SQL Server sources." + } + }, "type": "object" }, "StartBackfillJobResponse": { diff --git a/discovery/datastream-v1alpha1.json b/discovery/datastream-v1alpha1.json index 6b992c5542..00b5427771 100644 --- a/discovery/datastream-v1alpha1.json +++ b/discovery/datastream-v1alpha1.json @@ -553,6 +553,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1alpha1/{+name}/operations", @@ -1230,7 +1235,7 @@ } } }, - "revision": "20250817", + "revision": "20251021", "rootUrl": "https://datastream.googleapis.com/", "schemas": { "AvroFileFormat": { @@ -1711,6 +1716,13 @@ "$ref": "Operation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/discovery/deploymentmanager-alpha.json b/discovery/deploymentmanager-alpha.json index 2f0cfdbbb3..c1a9b34ef8 100644 --- a/discovery/deploymentmanager-alpha.json +++ b/discovery/deploymentmanager-alpha.json @@ -1676,7 +1676,7 @@ } } }, - "revision": "20250828", + "revision": "20251024", "rootUrl": "https://deploymentmanager.googleapis.com/", "schemas": { "AsyncOptions": { @@ -2704,11 +2704,12 @@ "QUOTA_INFO_UNAVAILABLE", "RESOURCE_USES_GLOBAL_DNS", "RATE_LIMIT_EXCEEDED", - "RESERVED_ENTRY_135", + "UPCOMING_MAINTENANCES_UNAVAILABLE", "RESERVED_ENTRY_136", "RESERVED_ENTRY_139", "RESERVED_ENTRY_141", - "RESERVED_ENTRY_142" + "RESERVED_ENTRY_142", + "RESERVED_ENTRY_143" ], "enumDeprecated": [ false, @@ -2750,6 +2751,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -2788,6 +2790,7 @@ "Quota information is not available to client requests (e.g: regions.list).", "Indicates that a VM is using global DNS. Can also be used to indicate that a resource has attributes that could result in the creation of a VM that uses global DNS.", "Resource can't be retrieved due to api quota exceeded.", + "Upcoming maintenance schedule is unavailable for the resource.", "Reserved entries for quickly adding new warnings without breaking dependent clients.", "", "", @@ -3092,11 +3095,12 @@ "QUOTA_INFO_UNAVAILABLE", "RESOURCE_USES_GLOBAL_DNS", "RATE_LIMIT_EXCEEDED", - "RESERVED_ENTRY_135", + "UPCOMING_MAINTENANCES_UNAVAILABLE", "RESERVED_ENTRY_136", "RESERVED_ENTRY_139", "RESERVED_ENTRY_141", - "RESERVED_ENTRY_142" + "RESERVED_ENTRY_142", + "RESERVED_ENTRY_143" ], "enumDeprecated": [ false, @@ -3138,6 +3142,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -3176,6 +3181,7 @@ "Quota information is not available to client requests (e.g: regions.list).", "Indicates that a VM is using global DNS. Can also be used to indicate that a resource has attributes that could result in the creation of a VM that uses global DNS.", "Resource can't be retrieved due to api quota exceeded.", + "Upcoming maintenance schedule is unavailable for the resource.", "Reserved entries for quickly adding new warnings without breaking dependent clients.", "", "", @@ -3404,11 +3410,12 @@ "QUOTA_INFO_UNAVAILABLE", "RESOURCE_USES_GLOBAL_DNS", "RATE_LIMIT_EXCEEDED", - "RESERVED_ENTRY_135", + "UPCOMING_MAINTENANCES_UNAVAILABLE", "RESERVED_ENTRY_136", "RESERVED_ENTRY_139", "RESERVED_ENTRY_141", - "RESERVED_ENTRY_142" + "RESERVED_ENTRY_142", + "RESERVED_ENTRY_143" ], "enumDeprecated": [ false, @@ -3450,6 +3457,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -3488,6 +3496,7 @@ "Quota information is not available to client requests (e.g: regions.list).", "Indicates that a VM is using global DNS. Can also be used to indicate that a resource has attributes that could result in the creation of a VM that uses global DNS.", "Resource can't be retrieved due to api quota exceeded.", + "Upcoming maintenance schedule is unavailable for the resource.", "Reserved entries for quickly adding new warnings without breaking dependent clients.", "", "", diff --git a/discovery/deploymentmanager-v2.json b/discovery/deploymentmanager-v2.json index fa0beb48e3..b9c6bba492 100644 --- a/discovery/deploymentmanager-v2.json +++ b/discovery/deploymentmanager-v2.json @@ -1028,7 +1028,7 @@ } } }, - "revision": "20250828", + "revision": "20251024", "rootUrl": "https://deploymentmanager.googleapis.com/", "schemas": { "AuditConfig": { @@ -1754,11 +1754,12 @@ "QUOTA_INFO_UNAVAILABLE", "RESOURCE_USES_GLOBAL_DNS", "RATE_LIMIT_EXCEEDED", - "RESERVED_ENTRY_135", + "UPCOMING_MAINTENANCES_UNAVAILABLE", "RESERVED_ENTRY_136", "RESERVED_ENTRY_139", "RESERVED_ENTRY_141", - "RESERVED_ENTRY_142" + "RESERVED_ENTRY_142", + "RESERVED_ENTRY_143" ], "enumDeprecated": [ false, @@ -1800,6 +1801,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -1838,6 +1840,7 @@ "Quota information is not available to client requests (e.g: regions.list).", "Indicates that a VM is using global DNS. Can also be used to indicate that a resource has attributes that could result in the creation of a VM that uses global DNS.", "Resource can't be retrieved due to api quota exceeded.", + "Upcoming maintenance schedule is unavailable for the resource.", "Reserved entries for quickly adding new warnings without breaking dependent clients.", "", "", @@ -2061,11 +2064,12 @@ "QUOTA_INFO_UNAVAILABLE", "RESOURCE_USES_GLOBAL_DNS", "RATE_LIMIT_EXCEEDED", - "RESERVED_ENTRY_135", + "UPCOMING_MAINTENANCES_UNAVAILABLE", "RESERVED_ENTRY_136", "RESERVED_ENTRY_139", "RESERVED_ENTRY_141", - "RESERVED_ENTRY_142" + "RESERVED_ENTRY_142", + "RESERVED_ENTRY_143" ], "enumDeprecated": [ false, @@ -2107,6 +2111,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -2145,6 +2150,7 @@ "Quota information is not available to client requests (e.g: regions.list).", "Indicates that a VM is using global DNS. Can also be used to indicate that a resource has attributes that could result in the creation of a VM that uses global DNS.", "Resource can't be retrieved due to api quota exceeded.", + "Upcoming maintenance schedule is unavailable for the resource.", "Reserved entries for quickly adding new warnings without breaking dependent clients.", "", "", @@ -2350,11 +2356,12 @@ "QUOTA_INFO_UNAVAILABLE", "RESOURCE_USES_GLOBAL_DNS", "RATE_LIMIT_EXCEEDED", - "RESERVED_ENTRY_135", + "UPCOMING_MAINTENANCES_UNAVAILABLE", "RESERVED_ENTRY_136", "RESERVED_ENTRY_139", "RESERVED_ENTRY_141", - "RESERVED_ENTRY_142" + "RESERVED_ENTRY_142", + "RESERVED_ENTRY_143" ], "enumDeprecated": [ false, @@ -2396,6 +2403,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -2434,6 +2442,7 @@ "Quota information is not available to client requests (e.g: regions.list).", "Indicates that a VM is using global DNS. Can also be used to indicate that a resource has attributes that could result in the creation of a VM that uses global DNS.", "Resource can't be retrieved due to api quota exceeded.", + "Upcoming maintenance schedule is unavailable for the resource.", "Reserved entries for quickly adding new warnings without breaking dependent clients.", "", "", diff --git a/discovery/deploymentmanager-v2beta.json b/discovery/deploymentmanager-v2beta.json index 2613a4cc55..e126cea494 100644 --- a/discovery/deploymentmanager-v2beta.json +++ b/discovery/deploymentmanager-v2beta.json @@ -1636,7 +1636,7 @@ } } }, - "revision": "20250828", + "revision": "20251024", "rootUrl": "https://deploymentmanager.googleapis.com/", "schemas": { "AsyncOptions": { @@ -2603,11 +2603,12 @@ "QUOTA_INFO_UNAVAILABLE", "RESOURCE_USES_GLOBAL_DNS", "RATE_LIMIT_EXCEEDED", - "RESERVED_ENTRY_135", + "UPCOMING_MAINTENANCES_UNAVAILABLE", "RESERVED_ENTRY_136", "RESERVED_ENTRY_139", "RESERVED_ENTRY_141", - "RESERVED_ENTRY_142" + "RESERVED_ENTRY_142", + "RESERVED_ENTRY_143" ], "enumDeprecated": [ false, @@ -2649,6 +2650,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -2687,6 +2689,7 @@ "Quota information is not available to client requests (e.g: regions.list).", "Indicates that a VM is using global DNS. Can also be used to indicate that a resource has attributes that could result in the creation of a VM that uses global DNS.", "Resource can't be retrieved due to api quota exceeded.", + "Upcoming maintenance schedule is unavailable for the resource.", "Reserved entries for quickly adding new warnings without breaking dependent clients.", "", "", @@ -2968,11 +2971,12 @@ "QUOTA_INFO_UNAVAILABLE", "RESOURCE_USES_GLOBAL_DNS", "RATE_LIMIT_EXCEEDED", - "RESERVED_ENTRY_135", + "UPCOMING_MAINTENANCES_UNAVAILABLE", "RESERVED_ENTRY_136", "RESERVED_ENTRY_139", "RESERVED_ENTRY_141", - "RESERVED_ENTRY_142" + "RESERVED_ENTRY_142", + "RESERVED_ENTRY_143" ], "enumDeprecated": [ false, @@ -3014,6 +3018,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -3052,6 +3057,7 @@ "Quota information is not available to client requests (e.g: regions.list).", "Indicates that a VM is using global DNS. Can also be used to indicate that a resource has attributes that could result in the creation of a VM that uses global DNS.", "Resource can't be retrieved due to api quota exceeded.", + "Upcoming maintenance schedule is unavailable for the resource.", "Reserved entries for quickly adding new warnings without breaking dependent clients.", "", "", @@ -3257,11 +3263,12 @@ "QUOTA_INFO_UNAVAILABLE", "RESOURCE_USES_GLOBAL_DNS", "RATE_LIMIT_EXCEEDED", - "RESERVED_ENTRY_135", + "UPCOMING_MAINTENANCES_UNAVAILABLE", "RESERVED_ENTRY_136", "RESERVED_ENTRY_139", "RESERVED_ENTRY_141", - "RESERVED_ENTRY_142" + "RESERVED_ENTRY_142", + "RESERVED_ENTRY_143" ], "enumDeprecated": [ false, @@ -3303,6 +3310,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -3341,6 +3349,7 @@ "Quota information is not available to client requests (e.g: regions.list).", "Indicates that a VM is using global DNS. Can also be used to indicate that a resource has attributes that could result in the creation of a VM that uses global DNS.", "Resource can't be retrieved due to api quota exceeded.", + "Upcoming maintenance schedule is unavailable for the resource.", "Reserved entries for quickly adding new warnings without breaking dependent clients.", "", "", diff --git a/discovery/developerconnect-v1.json b/discovery/developerconnect-v1.json index 1ba99b8df5..6b8a27fc9d 100644 --- a/discovery/developerconnect-v1.json +++ b/discovery/developerconnect-v1.json @@ -1606,7 +1606,7 @@ } } }, - "revision": "20251003", + "revision": "20251016", "rootUrl": "https://developerconnect.googleapis.com/", "schemas": { "AccountConnector": { @@ -1659,6 +1659,28 @@ }, "type": "object" }, + "AppHubService": { + "description": "AppHubService represents the App Hub Service.", + "id": "AppHubService", + "properties": { + "apphubService": { + "description": "Required. Output only. Immutable. The name of the App Hub Service. Format: `projects/{project}/locations/{location}/applications/{application}/services/{service}`.", + "readOnly": true, + "type": "string" + }, + "criticality": { + "description": "Output only. The criticality of the App Hub Service.", + "readOnly": true, + "type": "string" + }, + "environment": { + "description": "Output only. The environment of the App Hub Service.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "AppHubWorkload": { "description": "AppHubWorkload represents the App Hub Workload.", "id": "AppHubWorkload", @@ -2298,6 +2320,17 @@ }, "type": "object" }, + "GoogleCloudRun": { + "description": "GoogleCloudRun represents the Cloud Run runtime.", + "id": "GoogleCloudRun", + "properties": { + "serviceUri": { + "description": "Required. Immutable. The name of the Cloud Run service. Format: `projects/{project}/locations/{location}/services/{service}`.", + "type": "string" + } + }, + "type": "object" + }, "HttpBody": { "description": "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.", "id": "HttpBody", @@ -2873,6 +2906,11 @@ "description": "RuntimeConfig represents the runtimes where the application is deployed.", "id": "RuntimeConfig", "properties": { + "appHubService": { + "$ref": "AppHubService", + "description": "Output only. App Hub Service.", + "readOnly": true + }, "appHubWorkload": { "$ref": "AppHubWorkload", "description": "Output only. App Hub Workload.", @@ -2883,6 +2921,11 @@ "description": "Output only. Google Kubernetes Engine runtime.", "readOnly": true }, + "googleCloudRun": { + "$ref": "GoogleCloudRun", + "description": "Output only. Cloud Run runtime.", + "readOnly": true + }, "state": { "description": "Output only. The state of the Runtime.", "enum": [ diff --git a/discovery/dialogflow-v2.json b/discovery/dialogflow-v2.json index 2eb575aa79..d2db6ca433 100644 --- a/discovery/dialogflow-v2.json +++ b/discovery/dialogflow-v2.json @@ -4407,7 +4407,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -9258,7 +9258,7 @@ } } }, - "revision": "20251007", + "revision": "20251027", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -11402,6 +11402,10 @@ "description": "Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used.", "type": "object" }, + "serviceAccountAuthConfig": { + "$ref": "GoogleCloudDialogflowCxV3WebhookGenericWebServiceServiceAccountAuthConfig", + "description": "Optional. Configuration for service account authentication." + }, "serviceAgentAuth": { "description": "Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.", "enum": [ @@ -11485,6 +11489,17 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3WebhookGenericWebServiceServiceAccountAuthConfig": { + "description": "Configuration for authentication using a service account.", + "id": "GoogleCloudDialogflowCxV3WebhookGenericWebServiceServiceAccountAuthConfig", + "properties": { + "serviceAccount": { + "description": "Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3WebhookRequest": { "description": "The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.", "id": "GoogleCloudDialogflowCxV3WebhookRequest", @@ -13832,6 +13847,10 @@ "description": "Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used.", "type": "object" }, + "serviceAccountAuthConfig": { + "$ref": "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceServiceAccountAuthConfig", + "description": "Optional. Configuration for service account authentication." + }, "serviceAgentAuth": { "description": "Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.", "enum": [ @@ -13915,6 +13934,17 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceServiceAccountAuthConfig": { + "description": "Configuration for authentication using a service account.", + "id": "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceServiceAccountAuthConfig", + "properties": { + "serviceAccount": { + "description": "Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1WebhookRequest": { "description": "The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.", "id": "GoogleCloudDialogflowCxV3beta1WebhookRequest", @@ -22187,7 +22217,7 @@ "id": "GoogleCloudDialogflowV2ToolTLSConfigCACert", "properties": { "cert": { - "description": "Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with \"subject alt name\". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \\ -signkey example.com.key \\ -out example.com.crt \\ -extfile <(printf \"\\nsubjectAltName='DNS:www.example.com'\")", + "description": "Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with \"subject alt name\". For instance a certificate can be self-signed using the following command, ``` openssl x509 -req -days 200 -in example.com.csr \\ -signkey example.com.key \\ -out example.com.crt \\ -extfile <(printf \"\\nsubjectAltName='DNS:www.example.com'\") ```", "format": "byte", "type": "string" }, diff --git a/discovery/dialogflow-v2beta1.json b/discovery/dialogflow-v2beta1.json index d3eba77530..1ddac58e16 100644 --- a/discovery/dialogflow-v2beta1.json +++ b/discovery/dialogflow-v2beta1.json @@ -4172,7 +4172,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -8898,7 +8898,7 @@ } } }, - "revision": "20251007", + "revision": "20251027", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -11042,6 +11042,10 @@ "description": "Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used.", "type": "object" }, + "serviceAccountAuthConfig": { + "$ref": "GoogleCloudDialogflowCxV3WebhookGenericWebServiceServiceAccountAuthConfig", + "description": "Optional. Configuration for service account authentication." + }, "serviceAgentAuth": { "description": "Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.", "enum": [ @@ -11125,6 +11129,17 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3WebhookGenericWebServiceServiceAccountAuthConfig": { + "description": "Configuration for authentication using a service account.", + "id": "GoogleCloudDialogflowCxV3WebhookGenericWebServiceServiceAccountAuthConfig", + "properties": { + "serviceAccount": { + "description": "Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3WebhookRequest": { "description": "The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.", "id": "GoogleCloudDialogflowCxV3WebhookRequest", @@ -13472,6 +13487,10 @@ "description": "Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used.", "type": "object" }, + "serviceAccountAuthConfig": { + "$ref": "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceServiceAccountAuthConfig", + "description": "Optional. Configuration for service account authentication." + }, "serviceAgentAuth": { "description": "Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.", "enum": [ @@ -13555,6 +13574,17 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceServiceAccountAuthConfig": { + "description": "Configuration for authentication using a service account.", + "id": "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceServiceAccountAuthConfig", + "properties": { + "serviceAccount": { + "description": "Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1WebhookRequest": { "description": "The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.", "id": "GoogleCloudDialogflowCxV3beta1WebhookRequest", @@ -25059,7 +25089,7 @@ "id": "GoogleCloudDialogflowV2beta1ToolTLSConfigCACert", "properties": { "cert": { - "description": "Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with \"subject alt name\". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \\ -signkey example.com.key \\ -out example.com.crt \\ -extfile <(printf \"\\nsubjectAltName='DNS:www.example.com'\")", + "description": "Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with \"subject alt name\". For instance a certificate can be self-signed using the following command, ``` openssl x509 -req -days 200 -in example.com.csr \\ -signkey example.com.key \\ -out example.com.crt \\ -extfile <(printf \"\\nsubjectAltName='DNS:www.example.com'\") ```", "format": "byte", "type": "string" }, diff --git a/discovery/dialogflow-v3.json b/discovery/dialogflow-v3.json index 056f0f667b..9254756b75 100644 --- a/discovery/dialogflow-v3.json +++ b/discovery/dialogflow-v3.json @@ -148,7 +148,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -5319,7 +5319,7 @@ } } }, - "revision": "20250929", + "revision": "20251027", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3Action": { @@ -6010,6 +6010,17 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3CodeBlock": { + "description": "Represents a code block.", + "id": "GoogleCloudDialogflowCxV3CodeBlock", + "properties": { + "code": { + "description": "Optional. Source code of the block in Python.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3CompareVersionsRequest": { "description": "The request message for Versions.CompareVersions.", "id": "GoogleCloudDialogflowCxV3CompareVersionsRequest", @@ -9640,6 +9651,10 @@ "description": "Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result.", "id": "GoogleCloudDialogflowCxV3Playbook", "properties": { + "codeBlock": { + "$ref": "GoogleCloudDialogflowCxV3CodeBlock", + "description": "Optional. The playbook's scoped code block, which may implement handlers and actions." + }, "createTime": { "description": "Output only. The timestamp of initial playbook creation.", "format": "google-datetime", @@ -9661,6 +9676,14 @@ }, "type": "array" }, + "inlineActions": { + "description": "Optional. Output only. Names of inline actions scoped to this playbook. These actions are in addition to those belonging to referenced tools, child playbooks, and flows, e.g. actions that are defined in the playbook's code block.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "inputParameterDefinitions": { "description": "Optional. Defined structured input parameters for this playbook.", "items": { @@ -11261,6 +11284,10 @@ "$ref": "GoogleCloudDialogflowCxV3ToolAuthenticationOAuthConfig", "description": "Config for OAuth." }, + "serviceAccountAuthConfig": { + "$ref": "GoogleCloudDialogflowCxV3ToolAuthenticationServiceAccountAuthConfig", + "description": "Configuration for service account authentication." + }, "serviceAgentAuthConfig": { "$ref": "GoogleCloudDialogflowCxV3ToolAuthenticationServiceAgentAuthConfig", "description": "Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth." @@ -11358,6 +11385,17 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3ToolAuthenticationServiceAccountAuthConfig": { + "description": "Configuration for authentication using a service account.", + "id": "GoogleCloudDialogflowCxV3ToolAuthenticationServiceAccountAuthConfig", + "properties": { + "serviceAccount": { + "description": "Required. The email address of the service account used to authenticate the tool call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the tool request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3ToolAuthenticationServiceAgentAuthConfig": { "description": "Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).", "id": "GoogleCloudDialogflowCxV3ToolAuthenticationServiceAgentAuthConfig", @@ -12243,6 +12281,10 @@ "description": "Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used.", "type": "object" }, + "serviceAccountAuthConfig": { + "$ref": "GoogleCloudDialogflowCxV3WebhookGenericWebServiceServiceAccountAuthConfig", + "description": "Optional. Configuration for service account authentication." + }, "serviceAgentAuth": { "description": "Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.", "enum": [ @@ -12326,6 +12368,17 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3WebhookGenericWebServiceServiceAccountAuthConfig": { + "description": "Configuration for authentication using a service account.", + "id": "GoogleCloudDialogflowCxV3WebhookGenericWebServiceServiceAccountAuthConfig", + "properties": { + "serviceAccount": { + "description": "Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3WebhookRequest": { "description": "The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.", "id": "GoogleCloudDialogflowCxV3WebhookRequest", @@ -14673,6 +14726,10 @@ "description": "Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used.", "type": "object" }, + "serviceAccountAuthConfig": { + "$ref": "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceServiceAccountAuthConfig", + "description": "Optional. Configuration for service account authentication." + }, "serviceAgentAuth": { "description": "Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.", "enum": [ @@ -14756,6 +14813,17 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceServiceAccountAuthConfig": { + "description": "Configuration for authentication using a service account.", + "id": "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceServiceAccountAuthConfig", + "properties": { + "serviceAccount": { + "description": "Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1WebhookRequest": { "description": "The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.", "id": "GoogleCloudDialogflowCxV3beta1WebhookRequest", diff --git a/discovery/dialogflow-v3beta1.json b/discovery/dialogflow-v3beta1.json index c43fad8d46..f5ba010fa0 100644 --- a/discovery/dialogflow-v3beta1.json +++ b/discovery/dialogflow-v3beta1.json @@ -148,7 +148,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -5446,7 +5446,7 @@ } } }, - "revision": "20251009", + "revision": "20251027", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -7590,6 +7590,10 @@ "description": "Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used.", "type": "object" }, + "serviceAccountAuthConfig": { + "$ref": "GoogleCloudDialogflowCxV3WebhookGenericWebServiceServiceAccountAuthConfig", + "description": "Optional. Configuration for service account authentication." + }, "serviceAgentAuth": { "description": "Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.", "enum": [ @@ -7673,6 +7677,17 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3WebhookGenericWebServiceServiceAccountAuthConfig": { + "description": "Configuration for authentication using a service account.", + "id": "GoogleCloudDialogflowCxV3WebhookGenericWebServiceServiceAccountAuthConfig", + "properties": { + "serviceAccount": { + "description": "Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3WebhookRequest": { "description": "The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.", "id": "GoogleCloudDialogflowCxV3WebhookRequest", @@ -8811,6 +8826,17 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1CodeBlock": { + "description": "Represents a code block.", + "id": "GoogleCloudDialogflowCxV3beta1CodeBlock", + "properties": { + "code": { + "description": "Optional. Source code of the block in Python.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1CompareVersionsRequest": { "description": "The request message for Versions.CompareVersions.", "id": "GoogleCloudDialogflowCxV3beta1CompareVersionsRequest", @@ -13011,6 +13037,10 @@ "description": "Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result.", "id": "GoogleCloudDialogflowCxV3beta1Playbook", "properties": { + "codeBlock": { + "$ref": "GoogleCloudDialogflowCxV3beta1CodeBlock", + "description": "Optional. The playbook's scoped code block, which may implement handlers and actions." + }, "createTime": { "description": "Output only. The timestamp of initial playbook creation.", "format": "google-datetime", @@ -13032,6 +13062,14 @@ }, "type": "array" }, + "inlineActions": { + "description": "Optional. Output only. Names of inline actions scoped to this playbook. These actions are in addition to those belonging to referenced tools, child playbooks, and flows, e.g. actions that are defined in the playbook's code block.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "inputParameterDefinitions": { "description": "Optional. Defined structured input parameters for this playbook.", "items": { @@ -14755,6 +14793,10 @@ "$ref": "GoogleCloudDialogflowCxV3beta1ToolAuthenticationOAuthConfig", "description": "Config for OAuth." }, + "serviceAccountAuthConfig": { + "$ref": "GoogleCloudDialogflowCxV3beta1ToolAuthenticationServiceAccountAuthConfig", + "description": "Configuration for service account authentication." + }, "serviceAgentAuthConfig": { "$ref": "GoogleCloudDialogflowCxV3beta1ToolAuthenticationServiceAgentAuthConfig", "description": "Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth." @@ -14852,6 +14894,17 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1ToolAuthenticationServiceAccountAuthConfig": { + "description": "Configuration for authentication using a service account.", + "id": "GoogleCloudDialogflowCxV3beta1ToolAuthenticationServiceAccountAuthConfig", + "properties": { + "serviceAccount": { + "description": "Required. The email address of the service account used to authenticate the tool call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the tool request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1ToolAuthenticationServiceAgentAuthConfig": { "description": "Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).", "id": "GoogleCloudDialogflowCxV3beta1ToolAuthenticationServiceAgentAuthConfig", @@ -15922,6 +15975,10 @@ "description": "Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used.", "type": "object" }, + "serviceAccountAuthConfig": { + "$ref": "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceServiceAccountAuthConfig", + "description": "Optional. Configuration for service account authentication." + }, "serviceAgentAuth": { "description": "Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.", "enum": [ @@ -16005,6 +16062,17 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceServiceAccountAuthConfig": { + "description": "Configuration for authentication using a service account.", + "id": "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceServiceAccountAuthConfig", + "properties": { + "serviceAccount": { + "description": "Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1WebhookRequest": { "description": "The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.", "id": "GoogleCloudDialogflowCxV3beta1WebhookRequest", diff --git a/discovery/discoveryengine-v1.json b/discovery/discoveryengine-v1.json index bcf2029ba1..c742b5e8d8 100644 --- a/discovery/discoveryengine-v1.json +++ b/discovery/discoveryengine-v1.json @@ -7795,6 +7795,127 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite" ] + }, + "create": { + "description": "Creates a new User Store.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/userStores", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.userStores.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent collection resource name, such as `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "userStoreId": { + "description": "Required. The ID of the User Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/userStores", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1UserStore" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1UserStore" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + }, + "delete": { + "description": "Deletes the User Store.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}", + "httpMethod": "DELETE", + "id": "discoveryengine.projects.locations.userStores.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the User Store to delete. Format: `projects/{project}/locations/{location}/userStores/{user_store_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + }, + "get": { + "description": "Gets the User Store.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.userStores.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the User Store to get. Format: `projects/{project}/locations/{location}/userStores/{user_store_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1UserStore" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + }, + "patch": { + "description": "Updates the User Store.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}", + "httpMethod": "PATCH", + "id": "discoveryengine.projects.locations.userStores.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The list of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1UserStore" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1UserStore" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] } }, "resources": { @@ -7957,7 +8078,7 @@ } } }, - "revision": "20251017", + "revision": "20251026", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GdataBlobstore2Info": { @@ -13154,6 +13275,12 @@ ], "type": "string" }, + "configurableBillingApproachUpdateTime": { + "description": "Output only. The timestamp when configurable_billing_approach was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -15405,6 +15532,11 @@ "description": "Metadata and configurations for a Google Cloud project in the service.", "id": "GoogleCloudDiscoveryengineV1Project", "properties": { + "configurableBillingStatus": { + "$ref": "GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus", + "description": "Output only. The current status of the project's configurable billing.", + "readOnly": true + }, "createTime": { "description": "Output only. The timestamp when this project is created.", "format": "google-datetime", @@ -15437,6 +15569,28 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus": { + "description": "Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month).", + "id": "GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus", + "properties": { + "effectiveIndexingCoreThreshold": { + "description": "Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.", + "format": "int64", + "type": "string" + }, + "effectiveSearchQpmThreshold": { + "description": "Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.", + "format": "int64", + "type": "string" + }, + "startTime": { + "description": "Optional. The start time of the currently active billing subscription.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig": { "description": "Customer provided configurations.", "id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig", @@ -15455,6 +15609,10 @@ "modelArmorConfig": { "$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", "description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses." + }, + "optOutNotebookSharing": { + "description": "Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.", + "type": "boolean" } }, "type": "object" @@ -18358,6 +18516,33 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1UserStore": { + "description": "Configures metadata that is used for End User entities.", + "id": "GoogleCloudDiscoveryengineV1UserStore", + "properties": { + "defaultLicenseConfig": { + "description": "Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.", + "type": "string" + }, + "displayName": { + "description": "The display name of the User Store.", + "type": "string" + }, + "enableExpiredLicenseAutoUpdate": { + "description": "Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.", + "type": "boolean" + }, + "enableLicenseAutoRegister": { + "description": "Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.", + "type": "boolean" + }, + "name": { + "description": "Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1WorkspaceConfig": { "description": "Config to store data store type configuration for workspace data", "id": "GoogleCloudDiscoveryengineV1WorkspaceConfig", @@ -20994,6 +21179,12 @@ ], "type": "string" }, + "configurableBillingApproachUpdateTime": { + "description": "Output only. The timestamp when configurable_billing_approach was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -21334,6 +21525,23 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaDeleteUserStoreMetadata": { + "description": "Metadata related to the progress of the UserStoreService.DeleteUserStore operation. This will be returned by the google.longrunning.Operation.metadata field. Delete UserStore will delete all the end users under the user store, return the number of end users successfully deleted or failed to delete in the metadata.", + "id": "GoogleCloudDiscoveryengineV1alphaDeleteUserStoreMetadata", + "properties": { + "failureCount": { + "description": "The number of end users under the user store that failed to be deleted.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "The number of end users under the user store that were successfully deleted.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaDestinationConfig": { "description": "Defines target endpoints used to connect to third-party sources.", "id": "GoogleCloudDiscoveryengineV1alphaDestinationConfig", @@ -22932,6 +23140,11 @@ "description": "Metadata and configurations for a Google Cloud project in the service.", "id": "GoogleCloudDiscoveryengineV1alphaProject", "properties": { + "configurableBillingStatus": { + "$ref": "GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus", + "description": "Output only. The current status of the project's configurable billing.", + "readOnly": true + }, "createTime": { "description": "Output only. The timestamp when this project is created.", "format": "google-datetime", @@ -22964,6 +23177,28 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus": { + "description": "Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month).", + "id": "GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus", + "properties": { + "effectiveIndexingCoreThreshold": { + "description": "Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.", + "format": "int64", + "type": "string" + }, + "effectiveSearchQpmThreshold": { + "description": "Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.", + "format": "int64", + "type": "string" + }, + "startTime": { + "description": "Optional. The start time of the currently active billing subscription.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig": { "description": "Customer provided configurations.", "id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig", @@ -22982,6 +23217,10 @@ "modelArmorConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", "description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses." + }, + "optOutNotebookSharing": { + "description": "Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.", + "type": "boolean" } }, "type": "object" @@ -25701,6 +25940,12 @@ ], "type": "string" }, + "configurableBillingApproachUpdateTime": { + "description": "Output only. The timestamp when configurable_billing_approach was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -27164,6 +27409,11 @@ "description": "Metadata and configurations for a Google Cloud project in the service.", "id": "GoogleCloudDiscoveryengineV1betaProject", "properties": { + "configurableBillingStatus": { + "$ref": "GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus", + "description": "Output only. The current status of the project's configurable billing.", + "readOnly": true + }, "createTime": { "description": "Output only. The timestamp when this project is created.", "format": "google-datetime", @@ -27196,6 +27446,28 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus": { + "description": "Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month).", + "id": "GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus", + "properties": { + "effectiveIndexingCoreThreshold": { + "description": "Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.", + "format": "int64", + "type": "string" + }, + "effectiveSearchQpmThreshold": { + "description": "Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.", + "format": "int64", + "type": "string" + }, + "startTime": { + "description": "Optional. The start time of the currently active billing subscription.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig": { "description": "Customer provided configurations.", "id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig", @@ -27214,6 +27486,10 @@ "modelArmorConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", "description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses." + }, + "optOutNotebookSharing": { + "description": "Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.", + "type": "boolean" } }, "type": "object" @@ -28753,6 +29029,33 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaUserStore": { + "description": "Configures metadata that is used for End User entities.", + "id": "GoogleCloudDiscoveryengineV1betaUserStore", + "properties": { + "defaultLicenseConfig": { + "description": "Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.", + "type": "string" + }, + "displayName": { + "description": "The display name of the User Store.", + "type": "string" + }, + "enableExpiredLicenseAutoUpdate": { + "description": "Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.", + "type": "boolean" + }, + "enableLicenseAutoRegister": { + "description": "Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.", + "type": "boolean" + }, + "name": { + "description": "Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaWorkspaceConfig": { "description": "Config to store data store type configuration for workspace data", "id": "GoogleCloudDiscoveryengineV1betaWorkspaceConfig", diff --git a/discovery/discoveryengine-v1alpha.json b/discovery/discoveryengine-v1alpha.json index 4f2e90a837..fcc9a29add 100644 --- a/discovery/discoveryengine-v1alpha.json +++ b/discovery/discoveryengine-v1alpha.json @@ -141,6 +141,72 @@ }, "protocol": "rest", "resources": { + "billingAccounts": { + "resources": { + "billingAccountLicenseConfigs": { + "methods": { + "distributeLicenseConfig": { + "description": "Distributes a LicenseConfig from billing account level to project level.", + "flatPath": "v1alpha/billingAccounts/{billingAccountsId}/billingAccountLicenseConfigs/{billingAccountLicenseConfigsId}:distributeLicenseConfig", + "httpMethod": "POST", + "id": "discoveryengine.billingAccounts.billingAccountLicenseConfigs.distributeLicenseConfig", + "parameterOrder": [ + "billingAccountLicenseConfig" + ], + "parameters": { + "billingAccountLicenseConfig": { + "description": "Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`.", + "location": "path", + "pattern": "^billingAccounts/[^/]+/billingAccountLicenseConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+billingAccountLicenseConfig}:distributeLicenseConfig", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigRequest" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + }, + "retractLicenseConfig": { + "description": "This method is called from the billing account side to retract the LicenseConfig from the given project back to the billing account.", + "flatPath": "v1alpha/billingAccounts/{billingAccountsId}/billingAccountLicenseConfigs/{billingAccountLicenseConfigsId}:retractLicenseConfig", + "httpMethod": "POST", + "id": "discoveryengine.billingAccounts.billingAccountLicenseConfigs.retractLicenseConfig", + "parameterOrder": [ + "billingAccountLicenseConfig" + ], + "parameters": { + "billingAccountLicenseConfig": { + "description": "Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`.", + "location": "path", + "pattern": "^billingAccounts/[^/]+/billingAccountLicenseConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+billingAccountLicenseConfig}:retractLicenseConfig", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigRequest" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + } + } + } + } + }, "media": { "methods": { "download": { @@ -696,6 +762,168 @@ } }, "resources": { + "authorizations": { + "methods": { + "create": { + "description": "Creates an Authorization.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/authorizations", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.authorizations.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "authorizationId": { + "description": "Required. The ID to use for the authorization, which will become the final component of the resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource name. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/authorizations", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAuthorization" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAuthorization" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + }, + "delete": { + "description": "Deletes an Authorization.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/authorizations/{authorizationsId}", + "httpMethod": "DELETE", + "id": "discoveryengine.projects.locations.authorizations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of Authorization. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` If the caller does not have permission to delete the authorization, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the authorization to delete does not exist, a `NOT_FOUND` error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/authorizations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + }, + "get": { + "description": "Gets an Authorization.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/authorizations/{authorizationsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.authorizations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of Authorization. Format: `projects/{project}/locations/{location}/authorizations/{authorization}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/authorizations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAuthorization" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + }, + "list": { + "description": "Lists all Authorizations under an Engine.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/authorizations", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.authorizations.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Maximum number of Authorizations to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token ListAuthorizationsResponse.next_page_token, received from a previous AuthorizationService.ListAuthorizations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAuthorizations must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource name. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/authorizations", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaListAuthorizationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + }, + "patch": { + "description": "Updates an Authorization", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/authorizations/{authorizationsId}", + "httpMethod": "PATCH", + "id": "discoveryengine.projects.locations.authorizations.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. Resource name of the authorization. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` It must be a UTF-8 encoded string with a length limit of 1024 characters.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/authorizations/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The list of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAuthorization" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAuthorization" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + } + } + }, "cmekConfigs": { "methods": { "delete": { @@ -4833,6 +5061,180 @@ "https://www.googleapis.com/auth/discoveryengine.readwrite" ] } + }, + "resources": { + "cannedQueries": { + "methods": { + "create": { + "description": "Creates a CannedQuery.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/cannedQueries", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.collections.engines.assistants.cannedQueries.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "cannedQueryId": { + "description": "Required. The ID to use for the canned query, which will become the final component of the canned query's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource name. 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/{+parent}/cannedQueries", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCannedQuery" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCannedQuery" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + }, + "delete": { + "description": "Deletes a CannedQuery.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/cannedQueries/{cannedQueriesId}", + "httpMethod": "DELETE", + "id": "discoveryengine.projects.locations.collections.engines.assistants.cannedQueries.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of CannedQuery. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` If the caller does not have permission to delete the canned query, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the canned query to delete does not exist, a `NOT_FOUND` error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/cannedQueries/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + }, + "get": { + "description": "Gets a CannedQuery.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/cannedQueries/{cannedQueriesId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.engines.assistants.cannedQueries.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of CannedQuery. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/cannedQueries/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCannedQuery" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + }, + "list": { + "description": "Lists all CannedQuerys under an Assistant.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/cannedQueries", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.engines.assistants.cannedQueries.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The filter expression. Supported fields: * `enabled` * `google_defined` Examples: * `enabled=true` * `google_defined=true` * `enabled=true AND google_defined=true`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Maximum number of canned queries to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token received from a previous CannedQueryService.ListCannedQueries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to CannedQueryService.ListCannedQueries must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource name. 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/{+parent}/cannedQueries", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaListCannedQueriesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + }, + "patch": { + "description": "Updates a CannedQuery.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/cannedQueries/{cannedQueriesId}", + "httpMethod": "PATCH", + "id": "discoveryengine.projects.locations.collections.engines.assistants.cannedQueries.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. Resource name of the canned query. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` It must be a UTF-8 encoded string with a length limit of 1024 characters.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/cannedQueries/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The list of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCannedQuery" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCannedQuery" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + } + } + } } }, "completionConfig": { @@ -10385,6 +10787,127 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite" ] + }, + "create": { + "description": "Creates a new User Store.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userStores", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.userStores.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent collection resource name, such as `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "userStoreId": { + "description": "Required. The ID of the User Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters.", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+parent}/userStores", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaUserStore" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaUserStore" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + }, + "delete": { + "description": "Deletes the User Store.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}", + "httpMethod": "DELETE", + "id": "discoveryengine.projects.locations.userStores.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the User Store to delete. Format: `projects/{project}/locations/{location}/userStores/{user_store_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + }, + "get": { + "description": "Gets the User Store.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.userStores.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the User Store to get. Format: `projects/{project}/locations/{location}/userStores/{user_store_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaUserStore" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + }, + "patch": { + "description": "Updates the User Store.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}", + "httpMethod": "PATCH", + "id": "discoveryengine.projects.locations.userStores.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The list of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaUserStore" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaUserStore" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] } }, "resources": { @@ -10595,7 +11118,7 @@ } } }, - "revision": "20251017", + "revision": "20251026", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "ApiservingMediaRequestInfo": { @@ -13050,6 +13573,12 @@ ], "type": "string" }, + "configurableBillingApproachUpdateTime": { + "description": "Output only. The timestamp when configurable_billing_approach was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -14315,6 +14844,11 @@ "description": "Metadata and configurations for a Google Cloud project in the service.", "id": "GoogleCloudDiscoveryengineV1Project", "properties": { + "configurableBillingStatus": { + "$ref": "GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus", + "description": "Output only. The current status of the project's configurable billing.", + "readOnly": true + }, "createTime": { "description": "Output only. The timestamp when this project is created.", "format": "google-datetime", @@ -14347,6 +14881,28 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus": { + "description": "Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month).", + "id": "GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus", + "properties": { + "effectiveIndexingCoreThreshold": { + "description": "Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.", + "format": "int64", + "type": "string" + }, + "effectiveSearchQpmThreshold": { + "description": "Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.", + "format": "int64", + "type": "string" + }, + "startTime": { + "description": "Optional. The start time of the currently active billing subscription.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig": { "description": "Customer provided configurations.", "id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig", @@ -14365,6 +14921,10 @@ "modelArmorConfig": { "$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", "description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses." + }, + "optOutNotebookSharing": { + "description": "Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.", + "type": "boolean" } }, "type": "object" @@ -15310,6 +15870,33 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1UserStore": { + "description": "Configures metadata that is used for End User entities.", + "id": "GoogleCloudDiscoveryengineV1UserStore", + "properties": { + "defaultLicenseConfig": { + "description": "Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.", + "type": "string" + }, + "displayName": { + "description": "The display name of the User Store.", + "type": "string" + }, + "enableExpiredLicenseAutoUpdate": { + "description": "Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.", + "type": "boolean" + }, + "enableLicenseAutoRegister": { + "description": "Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.", + "type": "boolean" + }, + "name": { + "description": "Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1WorkspaceConfig": { "description": "Config to store data store type configuration for workspace data", "id": "GoogleCloudDiscoveryengineV1WorkspaceConfig", @@ -17745,6 +18332,55 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaAuthorization": { + "description": "Discovery Engine Authorization resource.", + "id": "GoogleCloudDiscoveryengineV1alphaAuthorization", + "properties": { + "displayName": { + "description": "Required. The display name of the authorization. It must be a UTF-8 encoded string with a length limit of 128 characters.", + "type": "string" + }, + "name": { + "description": "Identifier. Resource name of the authorization. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` It must be a UTF-8 encoded string with a length limit of 1024 characters.", + "type": "string" + }, + "serverSideOauth2": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAuthorizationServerSideOAuth2", + "description": "Server-side OAuth2 configuration." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAuthorizationServerSideOAuth2": { + "description": "OAuth2 configuration.", + "id": "GoogleCloudDiscoveryengineV1alphaAuthorizationServerSideOAuth2", + "properties": { + "authorizationUri": { + "description": "Required. The URI the user is directed to when they need to authorize. Should include everything required for a successful authorization: OAuth ID, extra flags, etc. Example: `https://accounts.google.com/o/oauth2/v2/auth?client_id=OAUTH_ID&scope=https://www.googleapis.com/auth/calendar.events&response_type=code&access_type=offline&prompt=consent` The `redirect_uri` parameter will be overwritten by the Vertex AI Search frontend.", + "type": "string" + }, + "clientId": { + "description": "Required. The OAuth2 client ID.", + "type": "string" + }, + "clientSecret": { + "description": "Required. The OAuth2 client secret. Encrypted at rest.", + "type": "string" + }, + "scopes": { + "description": "Required. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events`", + "items": { + "type": "string" + }, + "type": "array" + }, + "tokenUri": { + "description": "Required. The HTTP endpoint that exchanges a client authorization for an access token.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaBAPConfig": { "description": "The configuration for the BAP connector.", "id": "GoogleCloudDiscoveryengineV1alphaBAPConfig", @@ -18220,6 +18856,92 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaCannedQuery": { + "description": "Canned query resource of Assistant. It represents a short-cut to a predefined conversation start.", + "id": "GoogleCloudDiscoveryengineV1alphaCannedQuery", + "properties": { + "defaultTexts": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCannedQueryCannedQueryTexts", + "description": "Required. The default (non-localized) values for the text attributes." + }, + "displayName": { + "description": "The display name of the canned query. It must be a UTF-8 encoded string with a length limit of 128 characters.", + "type": "string" + }, + "enabled": { + "description": "Whether this canned query is enabled.", + "type": "boolean" + }, + "googleDefined": { + "description": "Output only. Whether this is a Google-defined, read-only canned query.", + "readOnly": true, + "type": "boolean" + }, + "localizedTexts": { + "additionalProperties": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCannedQueryCannedQueryTexts" + }, + "description": "Optional. The translations of the text attributes. The keys should be BCP-47 language codes.", + "type": "object" + }, + "name": { + "description": "Immutable. Resource name of the canned query. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` It must be a UTF-8 encoded string with a length limit of 1024 characters.", + "type": "string" + }, + "requiredCapabilities": { + "description": "Optional. The capabilities the Assistant needs to have to use this canned query.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCannedQueryAssistantCapability" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaCannedQueryAssistantCapability": { + "description": "Capability of an assistant needed to use this canned query.", + "id": "GoogleCloudDiscoveryengineV1alphaCannedQueryAssistantCapability", + "properties": { + "actionName": { + "description": "The name of the action that the Assistant needs to have set up to use this canned query.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaCannedQueryCannedQueryTexts": { + "description": "The text pieces for the canned query, which can be localized.", + "id": "GoogleCloudDiscoveryengineV1alphaCannedQueryCannedQueryTexts", + "properties": { + "prefix": { + "description": "Optional. The prefix that `suggested_prompts` should start with.", + "type": "string" + }, + "suggestedPrompts": { + "description": "Required. The prompts the canned query will offer to the user.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCannedQuerySuggestedPrompt" + }, + "type": "array" + }, + "title": { + "description": "Required. The title that is for the end user.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaCannedQuerySuggestedPrompt": { + "description": "A suggested prompt for the canned query.", + "id": "GoogleCloudDiscoveryengineV1alphaCannedQuerySuggestedPrompt", + "properties": { + "promptText": { + "description": "Required. The text of the suggested prompt.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest": { "description": "Request message for GroundedGenerationService.CheckGrounding method.", "id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest", @@ -20399,6 +21121,12 @@ ], "type": "string" }, + "configurableBillingApproachUpdateTime": { + "description": "Output only. The timestamp when configurable_billing_approach was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -20739,6 +21467,23 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaDeleteUserStoreMetadata": { + "description": "Metadata related to the progress of the UserStoreService.DeleteUserStore operation. This will be returned by the google.longrunning.Operation.metadata field. Delete UserStore will delete all the end users under the user store, return the number of end users successfully deleted or failed to delete in the metadata.", + "id": "GoogleCloudDiscoveryengineV1alphaDeleteUserStoreMetadata", + "properties": { + "failureCount": { + "description": "The number of end users under the user store that failed to be deleted.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "The number of end users under the user store that were successfully deleted.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaDestinationConfig": { "description": "Defines target endpoints used to connect to third-party sources.", "id": "GoogleCloudDiscoveryengineV1alphaDestinationConfig", @@ -20814,6 +21559,42 @@ "properties": {}, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigRequest": { + "description": "Request message for LicenseConfigService.DistributeLicenseConfig method.", + "id": "GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigRequest", + "properties": { + "licenseConfigId": { + "description": "Optional. Distribute seats to this license config instead of creating a new one. If not specified, a new license config will be created from the billing account license config.", + "type": "string" + }, + "licenseCount": { + "description": "Required. The number of licenses to distribute.", + "format": "int64", + "type": "string" + }, + "location": { + "description": "Required. The target GCP project region to distribute the license config to.", + "type": "string" + }, + "projectNumber": { + "description": "Required. The target GCP project number to distribute the license config to.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigResponse": { + "description": "Response message for LicenseConfigService.DistributeLicenseConfig method.", + "id": "GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigResponse", + "properties": { + "licenseConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaLicenseConfig", + "description": "The updated or created LicenseConfig." + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaDocument": { "description": "Document captures all raw metadata information of items to be recommended or searched.", "id": "GoogleCloudDiscoveryengineV1alphaDocument", @@ -23241,6 +24022,24 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaListAuthorizationsResponse": { + "description": "Response message for the AuthorizationService.ListAuthorizations method.", + "id": "GoogleCloudDiscoveryengineV1alphaListAuthorizationsResponse", + "properties": { + "authorizations": { + "description": "All the customer's Authorizations.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAuthorization" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token that can be sent as ListAuthorizationsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaListBranchesResponse": { "description": "Response for BranchService.ListBranches method.", "id": "GoogleCloudDiscoveryengineV1alphaListBranchesResponse", @@ -23255,6 +24054,24 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaListCannedQueriesResponse": { + "description": "Response message for the CannedQueryService.ListCannedQueries method.", + "id": "GoogleCloudDiscoveryengineV1alphaListCannedQueriesResponse", + "properties": { + "cannedQueries": { + "description": "The list of CannedQuerys matching the request.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCannedQuery" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token that can be sent as ListCannedQueriesRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaListChunksResponse": { "description": "Response message for ChunkService.ListChunks method.", "id": "GoogleCloudDiscoveryengineV1alphaListChunksResponse", @@ -23901,6 +24718,11 @@ "description": "Metadata and configurations for a Google Cloud project in the service.", "id": "GoogleCloudDiscoveryengineV1alphaProject", "properties": { + "configurableBillingStatus": { + "$ref": "GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus", + "description": "Output only. The current status of the project's configurable billing.", + "readOnly": true + }, "createTime": { "description": "Output only. The timestamp when this project is created.", "format": "google-datetime", @@ -23933,6 +24755,28 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus": { + "description": "Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month).", + "id": "GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus", + "properties": { + "effectiveIndexingCoreThreshold": { + "description": "Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.", + "format": "int64", + "type": "string" + }, + "effectiveSearchQpmThreshold": { + "description": "Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.", + "format": "int64", + "type": "string" + }, + "startTime": { + "description": "Optional. The start time of the currently active billing subscription.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig": { "description": "Customer provided configurations.", "id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig", @@ -23951,6 +24795,10 @@ "modelArmorConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", "description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses." + }, + "optOutNotebookSharing": { + "description": "Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.", + "type": "boolean" } }, "type": "object" @@ -25038,6 +25886,37 @@ "properties": {}, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigRequest": { + "description": "Request message for LicenseConfigService.RetractLicenseConfig method.", + "id": "GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigRequest", + "properties": { + "fullRetract": { + "description": "Optional. If set to true, retract the entire license config. Otherwise, retract the specified license count.", + "type": "boolean" + }, + "licenseConfig": { + "description": "Required. Full resource name of LicenseConfig. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config_id}`.", + "type": "string" + }, + "licenseCount": { + "description": "Optional. The number of licenses to retract. Only used when full_retract is false.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigResponse": { + "description": "Response message for LicenseConfigService.RetractLicenseConfig method.", + "id": "GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigResponse", + "properties": { + "licenseConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaLicenseConfig", + "description": "The updated LicenseConfig." + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaSafetyRating": { "description": "Safety rating corresponding to the generated content.", "id": "GoogleCloudDiscoveryengineV1alphaSafetyRating", @@ -28258,6 +29137,33 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaUserStore": { + "description": "Configures metadata that is used for End User entities.", + "id": "GoogleCloudDiscoveryengineV1alphaUserStore", + "properties": { + "defaultLicenseConfig": { + "description": "Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.", + "type": "string" + }, + "displayName": { + "description": "The display name of the User Store.", + "type": "string" + }, + "enableExpiredLicenseAutoUpdate": { + "description": "Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.", + "type": "boolean" + }, + "enableLicenseAutoRegister": { + "description": "Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.", + "type": "boolean" + }, + "name": { + "description": "Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaVideoCharacteristics": { "description": "Standard characteristics of a video media view.", "id": "GoogleCloudDiscoveryengineV1alphaVideoCharacteristics", @@ -28480,6 +29386,11 @@ "description": "The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed.", "type": "object" }, + "geminiBundle": { + "description": "Output only. Whether the subscription is gemini bundle or not.", + "readOnly": true, + "type": "boolean" + }, "homepageSetting": { "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSetting", "description": "Optional. Describes the homepage settings of the widget." @@ -28830,7 +29741,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSetting", "properties": { "shortcuts": { - "description": "Optional. The shortcuts to display on the homepage. LINT.IfChange(max_shortcuts_number) LINT.ThenChange(//depot/google3/cloud/console/web/ai/unified_cloud_search/components/widget_preview/widget_homepage_shortcut_config_form.ts:max_shortcuts_number)", + "description": "Optional. The shortcuts to display on the homepage. LINT.IfChange(max_shortcuts_number) LINT.ThenChange( //depot/google3/cloud/console/web/ai/unified_cloud_search/components/widget_preview/widget_homepage_shortcut_config_form.ts:max_shortcuts_number )", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSettingShortcut" }, @@ -29749,6 +30660,12 @@ ], "type": "string" }, + "configurableBillingApproachUpdateTime": { + "description": "Output only. The timestamp when configurable_billing_approach was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -31212,6 +32129,11 @@ "description": "Metadata and configurations for a Google Cloud project in the service.", "id": "GoogleCloudDiscoveryengineV1betaProject", "properties": { + "configurableBillingStatus": { + "$ref": "GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus", + "description": "Output only. The current status of the project's configurable billing.", + "readOnly": true + }, "createTime": { "description": "Output only. The timestamp when this project is created.", "format": "google-datetime", @@ -31244,6 +32166,28 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus": { + "description": "Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month).", + "id": "GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus", + "properties": { + "effectiveIndexingCoreThreshold": { + "description": "Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.", + "format": "int64", + "type": "string" + }, + "effectiveSearchQpmThreshold": { + "description": "Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.", + "format": "int64", + "type": "string" + }, + "startTime": { + "description": "Optional. The start time of the currently active billing subscription.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig": { "description": "Customer provided configurations.", "id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig", @@ -31262,6 +32206,10 @@ "modelArmorConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", "description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses." + }, + "optOutNotebookSharing": { + "description": "Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.", + "type": "boolean" } }, "type": "object" @@ -32801,6 +33749,33 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaUserStore": { + "description": "Configures metadata that is used for End User entities.", + "id": "GoogleCloudDiscoveryengineV1betaUserStore", + "properties": { + "defaultLicenseConfig": { + "description": "Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.", + "type": "string" + }, + "displayName": { + "description": "The display name of the User Store.", + "type": "string" + }, + "enableExpiredLicenseAutoUpdate": { + "description": "Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.", + "type": "boolean" + }, + "enableLicenseAutoRegister": { + "description": "Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.", + "type": "boolean" + }, + "name": { + "description": "Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaWorkspaceConfig": { "description": "Config to store data store type configuration for workspace data", "id": "GoogleCloudDiscoveryengineV1betaWorkspaceConfig", diff --git a/discovery/discoveryengine-v1beta.json b/discovery/discoveryengine-v1beta.json index dacdb277b2..27933e7c8a 100644 --- a/discovery/discoveryengine-v1beta.json +++ b/discovery/discoveryengine-v1beta.json @@ -8548,6 +8548,127 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite" ] + }, + "create": { + "description": "Creates a new User Store.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/userStores", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.userStores.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent collection resource name, such as `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "userStoreId": { + "description": "Required. The ID of the User Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+parent}/userStores", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1betaUserStore" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaUserStore" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + }, + "delete": { + "description": "Deletes the User Store.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}", + "httpMethod": "DELETE", + "id": "discoveryengine.projects.locations.userStores.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the User Store to delete. Format: `projects/{project}/locations/{location}/userStores/{user_store_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + }, + "get": { + "description": "Gets the User Store.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.userStores.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the User Store to get. Format: `projects/{project}/locations/{location}/userStores/{user_store_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaUserStore" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + }, + "patch": { + "description": "Updates the User Store.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}", + "httpMethod": "PATCH", + "id": "discoveryengine.projects.locations.userStores.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The list of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+name}", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1betaUserStore" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaUserStore" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] } }, "resources": { @@ -8681,7 +8802,7 @@ } } }, - "revision": "20251017", + "revision": "20251026", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GdataBlobstore2Info": { @@ -10969,6 +11090,12 @@ ], "type": "string" }, + "configurableBillingApproachUpdateTime": { + "description": "Output only. The timestamp when configurable_billing_approach was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -12234,6 +12361,11 @@ "description": "Metadata and configurations for a Google Cloud project in the service.", "id": "GoogleCloudDiscoveryengineV1Project", "properties": { + "configurableBillingStatus": { + "$ref": "GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus", + "description": "Output only. The current status of the project's configurable billing.", + "readOnly": true + }, "createTime": { "description": "Output only. The timestamp when this project is created.", "format": "google-datetime", @@ -12266,6 +12398,28 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus": { + "description": "Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month).", + "id": "GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus", + "properties": { + "effectiveIndexingCoreThreshold": { + "description": "Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.", + "format": "int64", + "type": "string" + }, + "effectiveSearchQpmThreshold": { + "description": "Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.", + "format": "int64", + "type": "string" + }, + "startTime": { + "description": "Optional. The start time of the currently active billing subscription.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig": { "description": "Customer provided configurations.", "id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig", @@ -12284,6 +12438,10 @@ "modelArmorConfig": { "$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", "description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses." + }, + "optOutNotebookSharing": { + "description": "Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.", + "type": "boolean" } }, "type": "object" @@ -13229,6 +13387,33 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1UserStore": { + "description": "Configures metadata that is used for End User entities.", + "id": "GoogleCloudDiscoveryengineV1UserStore", + "properties": { + "defaultLicenseConfig": { + "description": "Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.", + "type": "string" + }, + "displayName": { + "description": "The display name of the User Store.", + "type": "string" + }, + "enableExpiredLicenseAutoUpdate": { + "description": "Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.", + "type": "boolean" + }, + "enableLicenseAutoRegister": { + "description": "Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.", + "type": "boolean" + }, + "name": { + "description": "Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1WorkspaceConfig": { "description": "Config to store data store type configuration for workspace data", "id": "GoogleCloudDiscoveryengineV1WorkspaceConfig", @@ -15865,6 +16050,12 @@ ], "type": "string" }, + "configurableBillingApproachUpdateTime": { + "description": "Output only. The timestamp when configurable_billing_approach was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -16205,6 +16396,23 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaDeleteUserStoreMetadata": { + "description": "Metadata related to the progress of the UserStoreService.DeleteUserStore operation. This will be returned by the google.longrunning.Operation.metadata field. Delete UserStore will delete all the end users under the user store, return the number of end users successfully deleted or failed to delete in the metadata.", + "id": "GoogleCloudDiscoveryengineV1alphaDeleteUserStoreMetadata", + "properties": { + "failureCount": { + "description": "The number of end users under the user store that failed to be deleted.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "The number of end users under the user store that were successfully deleted.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaDestinationConfig": { "description": "Defines target endpoints used to connect to third-party sources.", "id": "GoogleCloudDiscoveryengineV1alphaDestinationConfig", @@ -17803,6 +18011,11 @@ "description": "Metadata and configurations for a Google Cloud project in the service.", "id": "GoogleCloudDiscoveryengineV1alphaProject", "properties": { + "configurableBillingStatus": { + "$ref": "GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus", + "description": "Output only. The current status of the project's configurable billing.", + "readOnly": true + }, "createTime": { "description": "Output only. The timestamp when this project is created.", "format": "google-datetime", @@ -17835,6 +18048,28 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus": { + "description": "Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month).", + "id": "GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus", + "properties": { + "effectiveIndexingCoreThreshold": { + "description": "Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.", + "format": "int64", + "type": "string" + }, + "effectiveSearchQpmThreshold": { + "description": "Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.", + "format": "int64", + "type": "string" + }, + "startTime": { + "description": "Optional. The start time of the currently active billing subscription.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig": { "description": "Customer provided configurations.", "id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig", @@ -17853,6 +18088,10 @@ "modelArmorConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", "description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses." + }, + "optOutNotebookSharing": { + "description": "Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.", + "type": "boolean" } }, "type": "object" @@ -23816,6 +24055,12 @@ ], "type": "string" }, + "configurableBillingApproachUpdateTime": { + "description": "Output only. The timestamp when configurable_billing_approach was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -26410,6 +26655,11 @@ "description": "Metadata and configurations for a Google Cloud project in the service.", "id": "GoogleCloudDiscoveryengineV1betaProject", "properties": { + "configurableBillingStatus": { + "$ref": "GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus", + "description": "Output only. The current status of the project's configurable billing.", + "readOnly": true + }, "createTime": { "description": "Output only. The timestamp when this project is created.", "format": "google-datetime", @@ -26442,6 +26692,28 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus": { + "description": "Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month).", + "id": "GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus", + "properties": { + "effectiveIndexingCoreThreshold": { + "description": "Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.", + "format": "int64", + "type": "string" + }, + "effectiveSearchQpmThreshold": { + "description": "Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.", + "format": "int64", + "type": "string" + }, + "startTime": { + "description": "Optional. The start time of the currently active billing subscription.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig": { "description": "Customer provided configurations.", "id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig", @@ -26460,6 +26732,10 @@ "modelArmorConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", "description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses." + }, + "optOutNotebookSharing": { + "description": "Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.", + "type": "boolean" } }, "type": "object" @@ -30141,6 +30417,33 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaUserStore": { + "description": "Configures metadata that is used for End User entities.", + "id": "GoogleCloudDiscoveryengineV1betaUserStore", + "properties": { + "defaultLicenseConfig": { + "description": "Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.", + "type": "string" + }, + "displayName": { + "description": "The display name of the User Store.", + "type": "string" + }, + "enableExpiredLicenseAutoUpdate": { + "description": "Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.", + "type": "boolean" + }, + "enableLicenseAutoRegister": { + "description": "Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.", + "type": "boolean" + }, + "name": { + "description": "Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaWorkspaceConfig": { "description": "Config to store data store type configuration for workspace data", "id": "GoogleCloudDiscoveryengineV1betaWorkspaceConfig", diff --git a/discovery/displayvideo-v2.json b/discovery/displayvideo-v2.json index 1bc9e190e3..7d7bc4f987 100644 --- a/discovery/displayvideo-v2.json +++ b/discovery/displayvideo-v2.json @@ -9081,7 +9081,7 @@ } } }, - "revision": "20250925", + "revision": "20251027", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActivateManualTriggerRequest": { @@ -12074,7 +12074,8 @@ "SDF_VERSION_8", "SDF_VERSION_8_1", "SDF_VERSION_9", - "SDF_VERSION_9_1" + "SDF_VERSION_9_1", + "SDF_VERSION_9_2" ], "enumDeprecated": [ false, @@ -12094,6 +12095,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -12114,7 +12116,8 @@ "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version.", "SDF version 8.1.", "SDF version 9. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version.", - "SDF version 9.1." + "SDF version 9.1.", + "SDF version 9.2." ], "type": "string" } @@ -15926,12 +15929,14 @@ "enum": [ "SUSPICIOUS_ACTIVITY_UNSPECIFIED", "SUSPICIOUS_ACTIVITY_HR", - "SUSPICIOUS_ACTIVITY_HMR" + "SUSPICIOUS_ACTIVITY_HMR", + "SUSPICIOUS_ACTIVITY_FD" ], "enumDescriptions": [ "This enum is only a placeholder and it doesn't specify any ad fraud prevention options.", "Ad Fraud - Exclude High Risk.", - "Ad Fraud - Exclude High and Moderate Risk." + "Ad Fraud - Exclude High and Moderate Risk.", + "Ad Fraud - Exclude Fraudulent Device." ], "type": "string" }, @@ -19420,7 +19425,8 @@ "SDF_VERSION_8", "SDF_VERSION_8_1", "SDF_VERSION_9", - "SDF_VERSION_9_1" + "SDF_VERSION_9_1", + "SDF_VERSION_9_2" ], "enumDeprecated": [ false, @@ -19440,6 +19446,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -19460,7 +19467,8 @@ "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version.", "SDF version 8.1.", "SDF version 9. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version.", - "SDF version 9.1." + "SDF version 9.1.", + "SDF version 9.2." ], "type": "string" } @@ -19512,7 +19520,8 @@ "SDF_VERSION_8", "SDF_VERSION_8_1", "SDF_VERSION_9", - "SDF_VERSION_9_1" + "SDF_VERSION_9_1", + "SDF_VERSION_9_2" ], "enumDeprecated": [ false, @@ -19532,6 +19541,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -19552,7 +19562,8 @@ "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version.", "SDF version 8.1.", "SDF version 9. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version.", - "SDF version 9.1." + "SDF version 9.1.", + "SDF version 9.2." ], "type": "string" } diff --git a/discovery/displayvideo-v3.json b/discovery/displayvideo-v3.json index df2eb255bd..a7f7da6c77 100644 --- a/discovery/displayvideo-v3.json +++ b/discovery/displayvideo-v3.json @@ -9268,7 +9268,7 @@ } } }, - "revision": "20250925", + "revision": "20251027", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActiveViewVideoViewabilityMetricConfig": { @@ -9401,8 +9401,7 @@ "AD_GROUP_FORMAT_AUDIO", "AD_GROUP_FORMAT_RESPONSIVE", "AD_GROUP_FORMAT_REACH", - "AD_GROUP_FORMAT_MASTHEAD", - "AD_GROUP_FORMAT_DEMAND_GEN" + "AD_GROUP_FORMAT_MASTHEAD" ], "enumDescriptions": [ "Format value is not specified or is unknown in this version.", @@ -9413,8 +9412,7 @@ "Non-skippable in-stream audio ads.", "Responsive ads.", "[Effective reach ad groups] (https://support.google.com/displayvideo/answer/9173684), including in-stream and bumper ads.", - "Masthead Ad that is surfaced on the top slot on the YouTube homepage.", - "Demand Gen ads." + "Masthead Ad that is surfaced on the top slot on the YouTube homepage." ], "type": "string" }, @@ -9486,10 +9484,14 @@ "type": "string" }, "adGroupId": { - "description": "The unique ID of the ad group that the ad belongs to.", + "description": "The unique ID of the ad group that the ad belongs to. *Caution*: Parent ad groups for Demand Gen ads are not currently retrieveable using `advertisers.adGroups.list` or `advertisers.adGroups.get`. Demand Gen ads can be identified by the absence of the `ad_details` union field.", "format": "int64", "type": "string" }, + "adPolicy": { + "$ref": "AdPolicy", + "description": "The policy approval status of the ad." + }, "adUrls": { "description": "List of URLs used by the ad.", "items": { @@ -9581,6 +9583,565 @@ }, "type": "object" }, + "AdPolicy": { + "description": "A single ad policy associated with an ad group ad.", + "id": "AdPolicy", + "properties": { + "adPolicyApprovalStatus": { + "description": "The policy approval status of an ad, indicating the approval decision.", + "enum": [ + "AD_POLICY_APPROVAL_STATUS_UNKNOWN", + "DISAPPROVED", + "APPROVED_LIMITED", + "APPROVED", + "AREA_OF_INTEREST_ONLY" + ], + "enumDescriptions": [ + "Unknown or not specified.", + "Will not serve.", + "Will serve with restrictions.", + "Will serve without restrictions.", + "Will not serve in targeted countries, but may serve for users who are searching for information about the targeted countries." + ], + "type": "string" + }, + "adPolicyReviewStatus": { + "description": "The policy review status of an ad, indicating where in the review process the ad is currently.", + "enum": [ + "AD_POLICY_REVIEW_STATUS_UNKNOWN", + "REVIEW_IN_PROGRESS", + "REVIEWED", + "UNDER_APPEAL", + "ELIGIBLE_MAY_SERVE" + ], + "enumDescriptions": [ + "Unknown or not specified.", + "Currently under review.", + "Primary review complete. Other reviews may still be in progress.", + "Resubmitted for approval or a policy decision has been appealed.", + "Deemed eligible and may be serving. Further review could still follow." + ], + "type": "string" + }, + "adPolicyTopicEntry": { + "description": "The entries for each policy topic identified as relating to the ad. Each entry includes the topic, restriction level, and guidance on how to fix policy issues.", + "items": { + "$ref": "AdPolicyTopicEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "AdPolicyCriterionRestriction": { + "description": "Represents a country restriction.", + "id": "AdPolicyCriterionRestriction", + "properties": { + "countryCriterionId": { + "description": "The country criterion id.", + "format": "int64", + "type": "string" + }, + "countryLabel": { + "description": "Localized name for the country. May be empty.", + "type": "string" + } + }, + "type": "object" + }, + "AdPolicyTopicAppealInfo": { + "description": "Information on how to appeal a policy decision.", + "id": "AdPolicyTopicAppealInfo", + "properties": { + "appealFormLink": { + "description": "Only available when appeal_type is `APPEAL_FORM`.", + "type": "string" + }, + "appealType": { + "description": "Whether the decision can be appealed through a self-service appeal or an appeal form.", + "enum": [ + "AD_POLICY_APPEAL_TYPE_UNKNOWN", + "SELF_SERVICE_APPEAL", + "APPEAL_FORM" + ], + "enumDescriptions": [ + "Unknown or not specified.", + "The decision can be appealed through a self-service appeal.", + "The decision can be appealed using an appeal form." + ], + "type": "string" + } + }, + "type": "object" + }, + "AdPolicyTopicConstraint": { + "description": "Details on ad serving constraints.", + "id": "AdPolicyTopicConstraint", + "properties": { + "certificateDomainMismatchCountryList": { + "$ref": "AdPolicyTopicConstraintAdPolicyCountryConstraintList", + "description": "Countries where the resource's domain is not covered by the certificates associated with it." + }, + "certificateMissingCountryList": { + "$ref": "AdPolicyTopicConstraintAdPolicyCountryConstraintList", + "description": "Countries where a certificate is required for serving." + }, + "countryConstraint": { + "$ref": "AdPolicyTopicConstraintAdPolicyCountryConstraintList", + "description": "Countries where the ad cannot serve." + }, + "globalCertificateDomainMismatch": { + "$ref": "AdPolicyTopicConstraintAdPolicyGlobalCertificateDomainMismatchConstraint", + "description": "Certificate is required to serve in any country and the existing certificate does not cover the ad's domain." + }, + "globalCertificateMissing": { + "$ref": "AdPolicyTopicConstraintAdPolicyGlobalCertificateMissingConstraint", + "description": "Certificate is required to serve in any country." + }, + "requestCertificateFormLink": { + "description": "Link to the form to request a certificate for the constraint.", + "type": "string" + }, + "resellerConstraint": { + "$ref": "AdPolicyTopicConstraintAdPolicyResellerConstraint", + "description": "Reseller constraint." + } + }, + "type": "object" + }, + "AdPolicyTopicConstraintAdPolicyCountryConstraintList": { + "description": "A list of countries where the ad cannot serve due to policy constraints.", + "id": "AdPolicyTopicConstraintAdPolicyCountryConstraintList", + "properties": { + "countries": { + "description": "Countries where the ad cannot serve.", + "items": { + "$ref": "AdPolicyCriterionRestriction" + }, + "type": "array" + } + }, + "type": "object" + }, + "AdPolicyTopicConstraintAdPolicyGlobalCertificateDomainMismatchConstraint": { + "description": "Certificate is required to serve in any country and the existing certificate does not cover the ad's domain.", + "id": "AdPolicyTopicConstraintAdPolicyGlobalCertificateDomainMismatchConstraint", + "properties": {}, + "type": "object" + }, + "AdPolicyTopicConstraintAdPolicyGlobalCertificateMissingConstraint": { + "description": "Certificate is required to serve in any country.", + "id": "AdPolicyTopicConstraintAdPolicyGlobalCertificateMissingConstraint", + "properties": {}, + "type": "object" + }, + "AdPolicyTopicConstraintAdPolicyResellerConstraint": { + "description": "Policy topic was constrained due to disapproval of the website for reseller purposes.", + "id": "AdPolicyTopicConstraintAdPolicyResellerConstraint", + "properties": {}, + "type": "object" + }, + "AdPolicyTopicEntry": { + "description": "An entry describing how an ad has been identified as relating to an ad policy.", + "id": "AdPolicyTopicEntry", + "properties": { + "appealInfo": { + "$ref": "AdPolicyTopicAppealInfo", + "description": "Information on how to appeal the policy decision." + }, + "helpCenterLink": { + "description": "Ad policy help center link for the policy topic.", + "type": "string" + }, + "policyDecisionType": { + "description": "The source of the policy decision.", + "enum": [ + "AD_POLICY_DECISION_TYPE_UNKNOWN", + "PURSUANT_TO_NOTICE", + "GOOGLE_INVESTIGATION" + ], + "enumDescriptions": [ + "Unknown or not specified.", + "The decision is from a legal notice, court order, or trademark content owner complaint, etc.", + "The decision is from a Google-owned investigation." + ], + "type": "string" + }, + "policyEnforcementMeans": { + "description": "The policy enforcement means used in the policy review.", + "enum": [ + "AD_POLICY_ENFORCEMENT_MEANS_UNKNOWN", + "AUTOMATED", + "HUMAN_REVIEW" + ], + "enumDescriptions": [ + "Unknown or not specified.", + "The enforcement process was fully automated.", + "A human was partially or fully involved in the decision enforcement process." + ], + "type": "string" + }, + "policyLabel": { + "description": "Localized label text for policy. Examples include \"Trademarks in text\", \"Contains Alcohol\", etc.", + "type": "string" + }, + "policyTopic": { + "description": "The policy topic. Examples include \"TRADEMARKS\", \"ALCOHOL\", etc.", + "type": "string" + }, + "policyTopicConstraints": { + "description": "The serving constraints relevant to the policy decision.", + "items": { + "$ref": "AdPolicyTopicConstraint" + }, + "type": "array" + }, + "policyTopicDescription": { + "description": "A short summary description of the policy topic.", + "type": "string" + }, + "policyTopicEvidences": { + "description": "The evidence used in the policy decision.", + "items": { + "$ref": "AdPolicyTopicEvidence" + }, + "type": "array" + }, + "policyTopicType": { + "description": "How ad serving will be affected due to the relation to the ad policy topic.", + "enum": [ + "AD_POLICY_TOPIC_ENTRY_TYPE_UNKNOWN", + "PROHIBITED", + "FULLY_LIMITED", + "LIMITED", + "DESCRIPTIVE", + "BROADENING", + "AREA_OF_INTEREST_ONLY" + ], + "enumDescriptions": [ + "Unknown or not specified.", + "The resource will not serve.", + "The resource will not serve in all targeted countries.", + "The resource cannot serve in some countries.", + "The resource can serve.", + "The resource can serve, and may serve beyond normal coverage.", + "The resource is constrained for all targeted countries, but may serve for users who are searching for information about the targeted countries." + ], + "type": "string" + } + }, + "type": "object" + }, + "AdPolicyTopicEvidence": { + "description": "Evidence information used in the policy decision.", + "id": "AdPolicyTopicEvidence", + "properties": { + "counterfeit": { + "$ref": "AdPolicyTopicEvidenceCounterfeit", + "description": "Counterfeit enforcement that caused a policy violation." + }, + "destinationMismatch": { + "$ref": "AdPolicyTopicEvidenceDestinationMismatch", + "description": "A mismatch between the ad destination URLs." + }, + "destinationNotWorking": { + "$ref": "AdPolicyTopicEvidenceDestinationNotWorking", + "description": "Information on HTTP or DNS errors related to the ad destination." + }, + "destinationTextList": { + "$ref": "AdPolicyTopicEvidenceDestinationTextList", + "description": "The text in the destination of the ad that is causing a policy violation." + }, + "httpCode": { + "description": "HTTP code returned when the final URL was crawled.", + "format": "int32", + "type": "integer" + }, + "languageCode": { + "description": "The language the ad was detected to be written in. This field uses IETF language tags, such as \"en-US\".", + "type": "string" + }, + "legalRemoval": { + "$ref": "AdPolicyTopicEvidenceLegalRemoval", + "description": "Legal related regulation enforcement that caused a policy violation." + }, + "regionalRequirements": { + "$ref": "AdPolicyTopicEvidenceRegionalRequirements", + "description": "T&S proactive enforcement that caused a policy violation." + }, + "textList": { + "$ref": "AdPolicyTopicEvidenceTextList", + "description": "List of evidence found in the text of the ad." + }, + "trademark": { + "$ref": "AdPolicyTopicEvidenceTrademark", + "description": "Trademark terms that caused a policy violation." + }, + "websiteList": { + "$ref": "AdPolicyTopicEvidenceWebsiteList", + "description": "List of websites linked with the ad." + } + }, + "type": "object" + }, + "AdPolicyTopicEvidenceCounterfeit": { + "description": "Details on the counterfeit enforcement that caused a policy violation.", + "id": "AdPolicyTopicEvidenceCounterfeit", + "properties": { + "owners": { + "description": "The content or product owners that made a complaint.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "AdPolicyTopicEvidenceDestinationMismatch": { + "description": "Details on a mismatch between destination URL types.", + "id": "AdPolicyTopicEvidenceDestinationMismatch", + "properties": { + "uriTypes": { + "description": "The set of URLs that do not match. The list can include single or multiple uri types. Example 1: [`DISPLAY_URL`, `FINAL_URL`] means ad display URL does not match with the ad final URL. Example 2: [`FINAL_URL`] means ad final URL did not match the crawled url, which is also considered as destination mismatch.", + "items": { + "enum": [ + "AD_POLICY_TOPIC_EVIDENCE_DESTINATION_MISMATCH_URL_TYPE_UNKNOWN", + "DISPLAY_URL", + "FINAL_URL", + "FINAL_MOBILE_URL", + "TRACKING_URL", + "MOBILE_TRACKING_URL" + ], + "enumDescriptions": [ + "Not specified or unknown.", + "The display URL.", + "The final URL.", + "The final mobile URL.", + "The tracking URL.", + "The mobile tracking URL." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "AdPolicyTopicEvidenceDestinationNotWorking": { + "description": "Details for on HTTP or DNS errors related to the ad destination.", + "id": "AdPolicyTopicEvidenceDestinationNotWorking", + "properties": { + "device": { + "description": "The device where visiting the URL resulted in the error.", + "enum": [ + "AD_POLICY_TOPIC_EVIDENCE_DESTINATION_NOT_WORKING_DEVICE_TYPE_UNKNOWN", + "DESKTOP", + "ANDROID", + "IOS" + ], + "enumDescriptions": [ + "Not specified or unknown.", + "Desktop device.", + "Android device.", + "iOS device." + ], + "type": "string" + }, + "dnsErrorType": { + "description": "The type of DNS error.", + "enum": [ + "AD_POLICY_TOPIC_EVIDENCE_DESTINATION_NOT_WORKING_DNS_ERROR_TYPE_UNKNOWN", + "HOSTNAME_NOT_FOUND", + "GOOGLE_CRAWLER_DNS_ISSUE" + ], + "enumDescriptions": [ + "Not specified or unknown.", + "Host name not found in DNS when fetching landing page.", + "Google could not crawl the landing page when communicating with DNS." + ], + "type": "string" + }, + "expandedUri": { + "description": "The full URL that didn't work.", + "type": "string" + }, + "httpErrorCode": { + "description": "The HTTP error code.", + "format": "int64", + "type": "string" + }, + "lastCheckedTime": { + "description": "The last time the error was seen when navigating to URL.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "AdPolicyTopicEvidenceDestinationTextList": { + "description": "A list of destination text that violated the policy.", + "id": "AdPolicyTopicEvidenceDestinationTextList", + "properties": { + "destinationTexts": { + "description": "Destination text that caused the policy finding.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "AdPolicyTopicEvidenceLegalRemoval": { + "description": "Legal related regulation enforcement, either from DMCA or local legal regulation.", + "id": "AdPolicyTopicEvidenceLegalRemoval", + "properties": { + "complaintType": { + "description": "The type of complaint causing the legal removal.", + "enum": [ + "AD_POLICY_TOPIC_EVIDENCE_LEGAL_REMOVAL_COMPLAINT_TYPE_UNKNOWN", + "COPYRIGHT", + "COURT_ORDER", + "LOCAL_LEGAL" + ], + "enumDescriptions": [ + "Not specified or unknown.", + "Copyright. Only applies to DMCA.", + "Court order. Only applies to local legal.", + "Local legal regulation. Only applies to local legal." + ], + "type": "string" + }, + "countryRestrictions": { + "description": "The countries restricted due to the legal removal.", + "items": { + "$ref": "AdPolicyCriterionRestriction" + }, + "type": "array" + }, + "dmca": { + "$ref": "AdPolicyTopicEvidenceLegalRemovalDmca", + "description": "Details on the DMCA regulation legal removal." + }, + "localLegal": { + "$ref": "AdPolicyTopicEvidenceLegalRemovalLocalLegal", + "description": "Details on the local legal regulation legal removal." + }, + "restrictedUris": { + "description": "The urls restricted due to the legal removal.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "AdPolicyTopicEvidenceLegalRemovalDmca": { + "description": "DMCA complaint details.", + "id": "AdPolicyTopicEvidenceLegalRemovalDmca", + "properties": { + "complainant": { + "description": "The entity who made the legal complaint.", + "type": "string" + } + }, + "type": "object" + }, + "AdPolicyTopicEvidenceLegalRemovalLocalLegal": { + "description": "Local legal regulation details.", + "id": "AdPolicyTopicEvidenceLegalRemovalLocalLegal", + "properties": { + "lawType": { + "description": "Type of law for the legal notice.", + "type": "string" + } + }, + "type": "object" + }, + "AdPolicyTopicEvidenceRegionalRequirements": { + "description": "Trust & Safety (T&S) proactive enforcement for policies meant to address regional requirements. This is considered a Google-owned investigation instead of a regulation notice since it's proactive T&S enforcement.", + "id": "AdPolicyTopicEvidenceRegionalRequirements", + "properties": { + "regionalRequirementsEntries": { + "description": "List of regional requirements.", + "items": { + "$ref": "AdPolicyTopicEvidenceRegionalRequirementsRegionalRequirementsEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "AdPolicyTopicEvidenceRegionalRequirementsRegionalRequirementsEntry": { + "description": "Policy level regional legal violation details.", + "id": "AdPolicyTopicEvidenceRegionalRequirementsRegionalRequirementsEntry", + "properties": { + "countryRestrictions": { + "description": "The countries restricted due to the legal policy.", + "items": { + "$ref": "AdPolicyCriterionRestriction" + }, + "type": "array" + }, + "legalPolicy": { + "description": "The legal policy that is being violated.", + "type": "string" + } + }, + "type": "object" + }, + "AdPolicyTopicEvidenceTextList": { + "description": "A list of fragments of text that violated the policy.", + "id": "AdPolicyTopicEvidenceTextList", + "properties": { + "texts": { + "description": "The fragments of text from the resource that caused the policy finding.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "AdPolicyTopicEvidenceTrademark": { + "description": "Trademark terms that caused a policy violation.", + "id": "AdPolicyTopicEvidenceTrademark", + "properties": { + "countryRestrictions": { + "description": "Countries where the policy violation is relevant.", + "items": { + "$ref": "AdPolicyCriterionRestriction" + }, + "type": "array" + }, + "owner": { + "description": "The trademark content owner.", + "type": "string" + }, + "term": { + "description": "The trademark term.", + "type": "string" + } + }, + "type": "object" + }, + "AdPolicyTopicEvidenceWebsiteList": { + "description": "A list of websites that violated the policy.", + "id": "AdPolicyTopicEvidenceWebsiteList", + "properties": { + "websites": { + "description": "Websites that caused the policy finding.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "AdUrl": { "description": "Additional URLs related to the ad, including beacons.", "id": "AdUrl", @@ -10768,7 +11329,7 @@ "Creative height and width in pixels. Value is stored in the creativeDimensionValue field of the comparison value.", "Video content duration. Value is stored in the contentDurationValue field of the comparison value. The comparisonOperator field must be set to `LIST_CONTAINS`.", "Video delivery type. Value is stored in the contentStreamTypeValue field of the comparison value. The comparisonOperator field must be set to `LIST_CONTAINS`.", - "Video genre id. Value is stored in the int64Value field of the comparison value. The comparisonOperator field must be set to `LIST_CONTAINS`." + "Video genre id. Value is stored in the contentGenreIdValue field of the comparison value. The comparisonOperator field must be set to `LIST_CONTAINS`." ], "type": "string" } @@ -13580,7 +14141,8 @@ "SDF_VERSION_8", "SDF_VERSION_8_1", "SDF_VERSION_9", - "SDF_VERSION_9_1" + "SDF_VERSION_9_1", + "SDF_VERSION_9_2" ], "enumDeprecated": [ false, @@ -13600,6 +14162,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -13620,7 +14183,8 @@ "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version.", "SDF version 8.1.", "SDF version 9. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version.", - "SDF version 9.1." + "SDF version 9.1.", + "SDF version 9.2." ], "type": "string" } @@ -17893,12 +18457,14 @@ "enum": [ "SUSPICIOUS_ACTIVITY_UNSPECIFIED", "SUSPICIOUS_ACTIVITY_HR", - "SUSPICIOUS_ACTIVITY_HMR" + "SUSPICIOUS_ACTIVITY_HMR", + "SUSPICIOUS_ACTIVITY_FD" ], "enumDescriptions": [ "This enum is only a placeholder and it doesn't specify any ad fraud prevention options.", "Ad Fraud - Exclude High Risk.", - "Ad Fraud - Exclude High and Moderate Risk." + "Ad Fraud - Exclude High and Moderate Risk.", + "Ad Fraud - Exclude Fraudulent Device." ], "type": "string" }, @@ -21506,7 +22072,8 @@ "SDF_VERSION_8", "SDF_VERSION_8_1", "SDF_VERSION_9", - "SDF_VERSION_9_1" + "SDF_VERSION_9_1", + "SDF_VERSION_9_2" ], "enumDeprecated": [ false, @@ -21526,6 +22093,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -21546,7 +22114,8 @@ "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version.", "SDF version 8.1.", "SDF version 9. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version.", - "SDF version 9.1." + "SDF version 9.1.", + "SDF version 9.2." ], "type": "string" } @@ -21598,7 +22167,8 @@ "SDF_VERSION_8", "SDF_VERSION_8_1", "SDF_VERSION_9", - "SDF_VERSION_9_1" + "SDF_VERSION_9_1", + "SDF_VERSION_9_2" ], "enumDeprecated": [ false, @@ -21618,6 +22188,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -21638,7 +22209,8 @@ "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version.", "SDF version 8.1.", "SDF version 9. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version.", - "SDF version 9.1." + "SDF version 9.1.", + "SDF version 9.2." ], "type": "string" } diff --git a/discovery/displayvideo-v4.json b/discovery/displayvideo-v4.json index f24a8fd0e7..c5e2d57ee0 100644 --- a/discovery/displayvideo-v4.json +++ b/discovery/displayvideo-v4.json @@ -374,6 +374,191 @@ } }, "resources": { + "adAssets": { + "methods": { + "bulkCreate": { + "description": "Creates multiple ad assets in a single request. Returns the newly-created ad assets if successful. Only supports the creation of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.", + "flatPath": "v4/advertisers/{advertisersId}/adAssets:bulkCreate", + "httpMethod": "POST", + "id": "displayvideo.advertisers.adAssets.bulkCreate", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser these ad assets belong to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/adAssets:bulkCreate", + "request": { + "$ref": "BulkCreateAdAssetsRequest" + }, + "response": { + "$ref": "BulkCreateAdAssetsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "create": { + "description": "Creates an ad asset. Returns the newly-created ad asset if successful. Only supports the creation of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.", + "flatPath": "v4/advertisers/{advertisersId}/adAssets", + "httpMethod": "POST", + "id": "displayvideo.advertisers.adAssets.create", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser this ad asset belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/adAssets", + "request": { + "$ref": "CreateAdAssetRequest" + }, + "response": { + "$ref": "AdAsset" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Gets an ad asset. Only supports the retrieval of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.", + "flatPath": "v4/advertisers/{advertisersId}/adAssets/{adAssetsId}", + "httpMethod": "GET", + "id": "displayvideo.advertisers.adAssets.get", + "parameterOrder": [ + "advertiserId", + "adAssetId" + ], + "parameters": { + "adAssetId": { + "description": "Required. The ID of the ad asset to fetch. Only supports assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "advertiserId": { + "description": "Required. The ID of the advertiser this ad asset belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/adAssets/{+adAssetId}", + "response": { + "$ref": "AdAsset" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists ad assets under an advertiser ID. Only supports the retrieval of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.", + "flatPath": "v4/advertisers/{advertisersId}/adAssets", + "httpMethod": "GET", + "id": "displayvideo.advertisers.adAssets.list", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser the ad assets belong to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Optional. Allows filtering of the results by ad asset fields. Supported syntax: * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `youtubeVideoAsset.youtubeVideoId` * `entityStatus` Examples: * All active YouTube video ad assets under an advertiser: `entityStatus=ENTITY_STATUS_ACTIVE`", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Field by which to sort the list. Acceptable values are: * `entityStatus` * `youtubeVideoAsset.youtubeVideoId` * `adAssetId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `adAssetId desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Must be between `1` and `5000`. If unspecified will default to `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdAssets` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/adAssets", + "response": { + "$ref": "ListAdAssetsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "upload": { + "description": "Uploads and creates an ad asset. Returns the ID of the newly-created ad asset if successful. Only supports the uploading of assets with the AdAssetType `AD_ASSET_TYPE_IMAGE`.", + "flatPath": "v4/advertisers/{advertisersId}/adAssets:uploadAdAsset", + "httpMethod": "POST", + "id": "displayvideo.advertisers.adAssets.upload", + "mediaUpload": { + "accept": [ + "*/*" + ], + "protocols": { + "simple": { + "multipart": true, + "path": "/upload/v4/advertisers/{+advertiserId}/adAssets:uploadAdAsset" + } + } + }, + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser this ad asset belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/adAssets:uploadAdAsset", + "request": { + "$ref": "UploadAdAssetRequest" + }, + "response": { + "$ref": "UploadAdAssetResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ], + "supportsMediaUpload": true + } + } + }, "adGroupAds": { "methods": { "get": { @@ -930,142 +1115,252 @@ } } } - } - } - }, - "assets": { - "methods": { - "upload": { - "description": "Uploads an asset. Returns the ID of the newly uploaded asset if successful. The asset file size should be no more than 10 MB for images, 200 MB for ZIP files, and 1 GB for videos. Must be used within the [multipart media upload process](/display-video/api/guides/how-tos/upload#multipart). Examples using provided client libraries can be found in our [Creating Creatives guide](/display-video/api/guides/creating-creatives/overview#upload_an_asset).", - "flatPath": "v4/advertisers/{advertisersId}/assets", - "httpMethod": "POST", - "id": "displayvideo.advertisers.assets.upload", - "mediaUpload": { - "accept": [ - "*/*" - ], - "protocols": { - "simple": { - "multipart": true, - "path": "/upload/v4/advertisers/{+advertiserId}/assets" - } - } - }, - "parameterOrder": [ - "advertiserId" - ], - "parameters": { - "advertiserId": { - "description": "Required. The ID of the advertiser this asset belongs to.", - "format": "int64", - "location": "path", - "pattern": "^[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v4/advertisers/{+advertiserId}/assets", - "request": { - "$ref": "CreateAssetRequest" - }, - "response": { - "$ref": "CreateAssetResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/display-video" - ], - "supportsMediaUpload": true - } - } - }, - "campaigns": { - "methods": { - "create": { - "description": "Creates a new campaign. Returns the newly created campaign if successful.", - "flatPath": "v4/advertisers/{advertisersId}/campaigns", - "httpMethod": "POST", - "id": "displayvideo.advertisers.campaigns.create", - "parameterOrder": [ - "advertiserId" - ], - "parameters": { - "advertiserId": { - "description": "Output only. The unique ID of the advertiser the campaign belongs to.", - "format": "int64", - "location": "path", - "pattern": "^[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v4/advertisers/{+advertiserId}/campaigns", - "request": { - "$ref": "Campaign" - }, - "response": { - "$ref": "Campaign" - }, - "scopes": [ - "https://www.googleapis.com/auth/display-video", - "https://www.googleapis.com/auth/display-video-mediaplanning" - ] }, - "delete": { - "description": "Permanently deletes a campaign. A deleted campaign cannot be recovered. The campaign should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.", - "flatPath": "v4/advertisers/{advertisersId}/campaigns/{campaignsId}", - "httpMethod": "DELETE", - "id": "displayvideo.advertisers.campaigns.delete", - "parameterOrder": [ - "advertiserId", - "campaignId" - ], - "parameters": { - "advertiserId": { - "description": "The ID of the advertiser this campaign belongs to.", - "format": "int64", - "location": "path", - "pattern": "^[^/]+$", - "required": true, - "type": "string" - }, - "campaignId": { - "description": "The ID of the campaign we need to delete.", - "format": "int64", - "location": "path", - "pattern": "^[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v4/advertisers/{+advertiserId}/campaigns/{+campaignId}", - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/display-video", - "https://www.googleapis.com/auth/display-video-mediaplanning" - ] - }, - "get": { - "description": "Gets a campaign.", - "flatPath": "v4/advertisers/{advertisersId}/campaigns/{campaignsId}", - "httpMethod": "GET", - "id": "displayvideo.advertisers.campaigns.get", + "youtubeAssetTypes": { + "resources": { + "youtubeAssetAssociations": { + "methods": { + "create": { + "description": "Creates a new association between the identified resource and a YouTube asset. Returns the newly-created association. *Warning:* This method is only available to an informed subset of users.", + "flatPath": "v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations", + "httpMethod": "POST", + "id": "displayvideo.advertisers.adGroups.youtubeAssetTypes.youtubeAssetAssociations.create", + "parameterOrder": [ + "advertiserId", + "adGroupId", + "youtubeAssetType" + ], + "parameters": { + "adGroupId": { + "description": "The ID of an ad group.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "advertiserId": { + "description": "Required. The ID of the advertiser that the linked entity belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "linkedEntity.lineItemId": { + "description": "The ID of a line item.", + "format": "int64", + "location": "query", + "type": "string" + }, + "youtubeAssetType": { + "description": "Required. The type of YouTube asset associated with the resource.", + "enum": [ + "YOUTUBE_ASSET_TYPE_UNSPECIFIED", + "YOUTUBE_ASSET_TYPE_LOCATION", + "YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION", + "YOUTUBE_ASSET_TYPE_SITELINK" + ], + "enumDescriptions": [ + "YouTube asset type is not specified or is unknown in this version.", + "Location asset.", + "Affiliate location asset.", + "Sitelink asset." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations", + "request": { + "$ref": "YoutubeAssetAssociation" + }, + "response": { + "$ref": "YoutubeAssetAssociation" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "delete": { + "description": "Deletes an existing association between the identified resource and a YouTube asset. *Warning:* This method is only available to an informed subset of users.", + "flatPath": "v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations/{youtubeAssetAssociationsId}", + "httpMethod": "DELETE", + "id": "displayvideo.advertisers.adGroups.youtubeAssetTypes.youtubeAssetAssociations.delete", + "parameterOrder": [ + "advertiserId", + "adGroupId", + "youtubeAssetType", + "youtubeAssetAssociationId" + ], + "parameters": { + "adGroupId": { + "description": "The ID of an ad group.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "advertiserId": { + "description": "Required. The ID of the advertiser that the linked entity belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "linkedEntity.lineItemId": { + "description": "The ID of a line item.", + "format": "int64", + "location": "query", + "type": "string" + }, + "youtubeAssetAssociationId": { + "description": "Required. The ID of the YouTube asset in the association. For `YOUTUBE_ASSET_TYPE_LOCATION` and `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION` associations: This should be the ID of the asset set linked, or 0 if the location_asset_filter or affiliate_location_asset_filter is `DISABLED`. For `YOUTUBE_ASSET_TYPE_SITELINK` associations: This should be the ID of the sitelink asset linked.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "youtubeAssetType": { + "description": "Required. The type of YouTube asset associated with the resource.", + "enum": [ + "YOUTUBE_ASSET_TYPE_UNSPECIFIED", + "YOUTUBE_ASSET_TYPE_LOCATION", + "YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION", + "YOUTUBE_ASSET_TYPE_SITELINK" + ], + "enumDescriptions": [ + "YouTube asset type is not specified or is unknown in this version.", + "Location asset.", + "Affiliate location asset.", + "Sitelink asset." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations/{+youtubeAssetAssociationId}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists the YouTube asset associations linked to the given resource.", + "flatPath": "v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations", + "httpMethod": "GET", + "id": "displayvideo.advertisers.adGroups.youtubeAssetTypes.youtubeAssetAssociations.list", + "parameterOrder": [ + "advertiserId", + "adGroupId", + "youtubeAssetType" + ], + "parameters": { + "adGroupId": { + "description": "The ID of an ad group.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "advertiserId": { + "description": "Required. The ID of the advertiser that the linked entity belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "linkedEntity.lineItemId": { + "description": "The ID of a line item.", + "format": "int64", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Field by which to sort the list. The only acceptable values are: * `linkedYoutubeAsset.locationAssetFilter.assetSetId`, * `linkedYoutubeAsset.affiliateLocationAssetFilter.assetSetId`, * `linkedYoutubeAsset.sitelinkAsset.assetId` The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be added to the field name. Example: `linkedYoutubeAsset.sitelinkAsset.assetId desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListYoutubeAssetAssociations` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "youtubeAssetType": { + "description": "Required. The type of YouTube asset being associated with the resource.", + "enum": [ + "YOUTUBE_ASSET_TYPE_UNSPECIFIED", + "YOUTUBE_ASSET_TYPE_LOCATION", + "YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION", + "YOUTUBE_ASSET_TYPE_SITELINK" + ], + "enumDescriptions": [ + "YouTube asset type is not specified or is unknown in this version.", + "Location asset.", + "Affiliate location asset.", + "Sitelink asset." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations", + "response": { + "$ref": "ListYoutubeAssetAssociationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + } + } + } + } + } + }, + "assets": { + "methods": { + "upload": { + "description": "Uploads an asset. Returns the ID of the newly uploaded asset if successful. The asset file size should be no more than 10 MB for images, 200 MB for ZIP files, and 1 GB for videos. Must be used within the [multipart media upload process](/display-video/api/guides/how-tos/upload#multipart). Examples using provided client libraries can be found in our [Creating Creatives guide](/display-video/api/guides/creating-creatives/overview#upload_an_asset).", + "flatPath": "v4/advertisers/{advertisersId}/assets", + "httpMethod": "POST", + "id": "displayvideo.advertisers.assets.upload", + "mediaUpload": { + "accept": [ + "*/*" + ], + "protocols": { + "simple": { + "multipart": true, + "path": "/upload/v4/advertisers/{+advertiserId}/assets" + } + } + }, "parameterOrder": [ - "advertiserId", - "campaignId" + "advertiserId" ], "parameters": { "advertiserId": { - "description": "Required. The ID of the advertiser this campaign belongs to.", - "format": "int64", - "location": "path", - "pattern": "^[^/]+$", - "required": true, - "type": "string" - }, - "campaignId": { - "description": "Required. The ID of the campaign to fetch.", + "description": "Required. The ID of the advertiser this asset belongs to.", "format": "int64", "location": "path", "pattern": "^[^/]+$", @@ -1073,75 +1368,184 @@ "type": "string" } }, - "path": "v4/advertisers/{+advertiserId}/campaigns/{+campaignId}", + "path": "v4/advertisers/{+advertiserId}/assets", + "request": { + "$ref": "CreateAssetRequest" + }, "response": { - "$ref": "Campaign" + "$ref": "CreateAssetResponse" }, "scopes": [ - "https://www.googleapis.com/auth/display-video", - "https://www.googleapis.com/auth/display-video-mediaplanning" - ] - }, - "list": { - "description": "Lists campaigns in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, campaigns with `ENTITY_STATUS_ARCHIVED` will not be included in the results.", + "https://www.googleapis.com/auth/display-video" + ], + "supportsMediaUpload": true + } + } + }, + "campaigns": { + "methods": { + "create": { + "description": "Creates a new campaign. Returns the newly created campaign if successful.", "flatPath": "v4/advertisers/{advertisersId}/campaigns", - "httpMethod": "GET", - "id": "displayvideo.advertisers.campaigns.list", + "httpMethod": "POST", + "id": "displayvideo.advertisers.campaigns.create", "parameterOrder": [ "advertiserId" ], "parameters": { "advertiserId": { - "description": "The ID of the advertiser to list campaigns for.", + "description": "Output only. The unique ID of the advertiser the campaign belongs to.", "format": "int64", "location": "path", "pattern": "^[^/]+$", "required": true, "type": "string" - }, - "filter": { - "description": "Allows filtering by campaign fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` campaigns under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\")` * All campaigns with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<=\"2020-11-04T18:54:47Z\"` * All campaigns with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>=\"2020-11-04T18:54:47Z\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCampaigns` method. If not specified, the first page of results will be returned.", - "location": "query", - "type": "string" } }, "path": "v4/advertisers/{+advertiserId}/campaigns", + "request": { + "$ref": "Campaign" + }, "response": { - "$ref": "ListCampaignsResponse" + "$ref": "Campaign" }, "scopes": [ "https://www.googleapis.com/auth/display-video", "https://www.googleapis.com/auth/display-video-mediaplanning" ] }, - "listAssignedTargetingOptions": { - "description": "Lists assigned targeting options of a campaign across targeting types.", - "flatPath": "v4/advertisers/{advertisersId}/campaigns/{campaignsId}:listAssignedTargetingOptions", - "httpMethod": "GET", - "id": "displayvideo.advertisers.campaigns.listAssignedTargetingOptions", + "delete": { + "description": "Permanently deletes a campaign. A deleted campaign cannot be recovered. The campaign should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.", + "flatPath": "v4/advertisers/{advertisersId}/campaigns/{campaignsId}", + "httpMethod": "DELETE", + "id": "displayvideo.advertisers.campaigns.delete", "parameterOrder": [ "advertiserId", "campaignId" ], "parameters": { "advertiserId": { - "description": "Required. The ID of the advertiser the campaign belongs to.", + "description": "The ID of the advertiser this campaign belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "campaignId": { + "description": "The ID of the campaign we need to delete.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/campaigns/{+campaignId}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video", + "https://www.googleapis.com/auth/display-video-mediaplanning" + ] + }, + "get": { + "description": "Gets a campaign.", + "flatPath": "v4/advertisers/{advertisersId}/campaigns/{campaignsId}", + "httpMethod": "GET", + "id": "displayvideo.advertisers.campaigns.get", + "parameterOrder": [ + "advertiserId", + "campaignId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser this campaign belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "campaignId": { + "description": "Required. The ID of the campaign to fetch.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/campaigns/{+campaignId}", + "response": { + "$ref": "Campaign" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video", + "https://www.googleapis.com/auth/display-video-mediaplanning" + ] + }, + "list": { + "description": "Lists campaigns in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, campaigns with `ENTITY_STATUS_ARCHIVED` will not be included in the results.", + "flatPath": "v4/advertisers/{advertisersId}/campaigns", + "httpMethod": "GET", + "id": "displayvideo.advertisers.campaigns.list", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser to list campaigns for.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Allows filtering by campaign fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` campaigns under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\")` * All campaigns with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<=\"2020-11-04T18:54:47Z\"` * All campaigns with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>=\"2020-11-04T18:54:47Z\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCampaigns` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/campaigns", + "response": { + "$ref": "ListCampaignsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video", + "https://www.googleapis.com/auth/display-video-mediaplanning" + ] + }, + "listAssignedTargetingOptions": { + "description": "Lists assigned targeting options of a campaign across targeting types.", + "flatPath": "v4/advertisers/{advertisersId}/campaigns/{campaignsId}:listAssignedTargetingOptions", + "httpMethod": "GET", + "id": "displayvideo.advertisers.campaigns.listAssignedTargetingOptions", + "parameterOrder": [ + "advertiserId", + "campaignId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser the campaign belongs to.", "format": "int64", "location": "path", "pattern": "^[^/]+$", @@ -4165,155 +4569,249 @@ } } } - } - } - }, - "locationLists": { - "methods": { - "create": { - "description": "Creates a new location list. Returns the newly created location list if successful.", - "flatPath": "v4/advertisers/{advertisersId}/locationLists", - "httpMethod": "POST", - "id": "displayvideo.advertisers.locationLists.create", - "parameterOrder": [ - "advertiserId" - ], - "parameters": { - "advertiserId": { - "description": "Required. The ID of the DV360 advertiser to which the location list belongs.", - "format": "int64", - "location": "path", - "pattern": "^[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v4/advertisers/{+advertiserId}/locationLists", - "request": { - "$ref": "LocationList" - }, - "response": { - "$ref": "LocationList" - }, - "scopes": [ - "https://www.googleapis.com/auth/display-video" - ] - }, - "get": { - "description": "Gets a location list.", - "flatPath": "v4/advertisers/{advertisersId}/locationLists/{locationListsId}", - "httpMethod": "GET", - "id": "displayvideo.advertisers.locationLists.get", - "parameterOrder": [ - "advertiserId", - "locationListId" - ], - "parameters": { - "advertiserId": { - "description": "Required. The ID of the DV360 advertiser to which the fetched location list belongs.", - "format": "int64", - "location": "path", - "pattern": "^[^/]+$", - "required": true, - "type": "string" - }, - "locationListId": { - "description": "Required. The ID of the location list to fetch.", - "format": "int64", - "location": "path", - "pattern": "^[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v4/advertisers/{+advertiserId}/locationLists/{+locationListId}", - "response": { - "$ref": "LocationList" - }, - "scopes": [ - "https://www.googleapis.com/auth/display-video" - ] - }, - "list": { - "description": "Lists location lists based on a given advertiser id.", - "flatPath": "v4/advertisers/{advertisersId}/locationLists", - "httpMethod": "GET", - "id": "displayvideo.advertisers.locationLists.list", - "parameterOrder": [ - "advertiserId" - ], - "parameters": { - "advertiserId": { - "description": "Required. The ID of the DV360 advertiser to which the fetched location lists belong.", - "format": "int64", - "location": "path", - "pattern": "^[^/]+$", - "required": true, - "type": "string" - }, - "filter": { - "description": "Allows filtering by location list fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `locationType` Examples: * All regional location list: `locationType=\"TARGETING_LOCATION_TYPE_REGIONAL\"` * All proximity location list: `locationType=\"TARGETING_LOCATION_TYPE_PROXIMITY\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "Field by which to sort the list. Acceptable values are: * `locationListId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Requested page size. Must be between `1` and `200`. Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLocationLists` method. If not specified, the first page of results will be returned.", - "location": "query", - "type": "string" - } - }, - "path": "v4/advertisers/{+advertiserId}/locationLists", - "response": { - "$ref": "ListLocationListsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/display-video" - ] }, - "patch": { - "description": "Updates a location list. Returns the updated location list if successful.", - "flatPath": "v4/advertisers/{advertisersId}/locationLists/{locationListId}", - "httpMethod": "PATCH", - "id": "displayvideo.advertisers.locationLists.patch", - "parameterOrder": [ - "advertiserId", - "locationListId" - ], - "parameters": { - "advertiserId": { - "description": "Required. The ID of the DV360 advertiser to which the location lists belongs.", - "format": "int64", - "location": "path", - "pattern": "^[^/]+$", - "required": true, - "type": "string" - }, - "locationListId": { - "description": "Output only. The unique ID of the location list. Assigned by the system.", + "youtubeAssetTypes": { + "resources": { + "youtubeAssetAssociations": { + "methods": { + "create": { + "description": "Creates a new association between the identified resource and a YouTube asset. Returns the newly-created association. *Warning:* This method is only available to an informed subset of users.", + "flatPath": "v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations", + "httpMethod": "POST", + "id": "displayvideo.advertisers.lineItems.youtubeAssetTypes.youtubeAssetAssociations.create", + "parameterOrder": [ + "advertiserId", + "lineItemId", + "youtubeAssetType" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser that the linked entity belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "lineItemId": { + "description": "The ID of a line item.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "linkedEntity.adGroupId": { + "description": "The ID of an ad group.", + "format": "int64", + "location": "query", + "type": "string" + }, + "youtubeAssetType": { + "description": "Required. The type of YouTube asset associated with the resource.", + "enum": [ + "YOUTUBE_ASSET_TYPE_UNSPECIFIED", + "YOUTUBE_ASSET_TYPE_LOCATION", + "YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION", + "YOUTUBE_ASSET_TYPE_SITELINK" + ], + "enumDescriptions": [ + "YouTube asset type is not specified or is unknown in this version.", + "Location asset.", + "Affiliate location asset.", + "Sitelink asset." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations", + "request": { + "$ref": "YoutubeAssetAssociation" + }, + "response": { + "$ref": "YoutubeAssetAssociation" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "delete": { + "description": "Deletes an existing association between the identified resource and a YouTube asset. *Warning:* This method is only available to an informed subset of users.", + "flatPath": "v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations/{youtubeAssetAssociationsId}", + "httpMethod": "DELETE", + "id": "displayvideo.advertisers.lineItems.youtubeAssetTypes.youtubeAssetAssociations.delete", + "parameterOrder": [ + "advertiserId", + "lineItemId", + "youtubeAssetType", + "youtubeAssetAssociationId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser that the linked entity belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "lineItemId": { + "description": "The ID of a line item.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "linkedEntity.adGroupId": { + "description": "The ID of an ad group.", + "format": "int64", + "location": "query", + "type": "string" + }, + "youtubeAssetAssociationId": { + "description": "Required. The ID of the YouTube asset in the association. For `YOUTUBE_ASSET_TYPE_LOCATION` and `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION` associations: This should be the ID of the asset set linked, or 0 if the location_asset_filter or affiliate_location_asset_filter is `DISABLED`. For `YOUTUBE_ASSET_TYPE_SITELINK` associations: This should be the ID of the sitelink asset linked.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "youtubeAssetType": { + "description": "Required. The type of YouTube asset associated with the resource.", + "enum": [ + "YOUTUBE_ASSET_TYPE_UNSPECIFIED", + "YOUTUBE_ASSET_TYPE_LOCATION", + "YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION", + "YOUTUBE_ASSET_TYPE_SITELINK" + ], + "enumDescriptions": [ + "YouTube asset type is not specified or is unknown in this version.", + "Location asset.", + "Affiliate location asset.", + "Sitelink asset." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations/{+youtubeAssetAssociationId}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists the YouTube asset associations linked to the given resource.", + "flatPath": "v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations", + "httpMethod": "GET", + "id": "displayvideo.advertisers.lineItems.youtubeAssetTypes.youtubeAssetAssociations.list", + "parameterOrder": [ + "advertiserId", + "lineItemId", + "youtubeAssetType" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser that the linked entity belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "lineItemId": { + "description": "The ID of a line item.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "linkedEntity.adGroupId": { + "description": "The ID of an ad group.", + "format": "int64", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Field by which to sort the list. The only acceptable values are: * `linkedYoutubeAsset.locationAssetFilter.assetSetId`, * `linkedYoutubeAsset.affiliateLocationAssetFilter.assetSetId`, * `linkedYoutubeAsset.sitelinkAsset.assetId` The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be added to the field name. Example: `linkedYoutubeAsset.sitelinkAsset.assetId desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListYoutubeAssetAssociations` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "youtubeAssetType": { + "description": "Required. The type of YouTube asset being associated with the resource.", + "enum": [ + "YOUTUBE_ASSET_TYPE_UNSPECIFIED", + "YOUTUBE_ASSET_TYPE_LOCATION", + "YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION", + "YOUTUBE_ASSET_TYPE_SITELINK" + ], + "enumDescriptions": [ + "YouTube asset type is not specified or is unknown in this version.", + "Location asset.", + "Affiliate location asset.", + "Sitelink asset." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations", + "response": { + "$ref": "ListYoutubeAssetAssociationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + } + } + } + } + } + }, + "locationLists": { + "methods": { + "create": { + "description": "Creates a new location list. Returns the newly created location list if successful.", + "flatPath": "v4/advertisers/{advertisersId}/locationLists", + "httpMethod": "POST", + "id": "displayvideo.advertisers.locationLists.create", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the DV360 advertiser to which the location list belongs.", "format": "int64", "location": "path", + "pattern": "^[^/]+$", "required": true, "type": "string" - }, - "updateMask": { - "description": "Required. The mask to control which fields to update.", - "format": "google-fieldmask", - "location": "query", - "type": "string" } }, - "path": "v4/advertisers/{+advertiserId}/locationLists/{locationListId}", + "path": "v4/advertisers/{+advertiserId}/locationLists", "request": { "$ref": "LocationList" }, @@ -4323,70 +4821,195 @@ "scopes": [ "https://www.googleapis.com/auth/display-video" ] - } - }, - "resources": { - "assignedLocations": { - "methods": { - "bulkEdit": { - "description": "Bulk edits multiple assignments between locations and a single location list. The operation will delete the assigned locations provided in deletedAssignedLocations and then create the assigned locations provided in createdAssignedLocations.", - "flatPath": "v4/advertisers/{advertiserId}/locationLists/{locationListsId}/assignedLocations:bulkEdit", - "httpMethod": "POST", - "id": "displayvideo.advertisers.locationLists.assignedLocations.bulkEdit", - "parameterOrder": [ - "advertiserId", - "locationListId" - ], - "parameters": { - "advertiserId": { - "description": "Required. The ID of the DV360 advertiser to which the location list belongs.", - "format": "int64", - "location": "path", - "required": true, - "type": "string" - }, - "locationListId": { - "description": "Required. The ID of the location list to which these assignments are assigned.", - "format": "int64", - "location": "path", - "pattern": "^[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v4/advertisers/{advertiserId}/locationLists/{+locationListId}/assignedLocations:bulkEdit", - "request": { - "$ref": "BulkEditAssignedLocationsRequest" - }, - "response": { - "$ref": "BulkEditAssignedLocationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/display-video" - ] + }, + "get": { + "description": "Gets a location list.", + "flatPath": "v4/advertisers/{advertisersId}/locationLists/{locationListsId}", + "httpMethod": "GET", + "id": "displayvideo.advertisers.locationLists.get", + "parameterOrder": [ + "advertiserId", + "locationListId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the DV360 advertiser to which the fetched location list belongs.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" }, - "create": { - "description": "Creates an assignment between a location and a location list.", - "flatPath": "v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations", - "httpMethod": "POST", - "id": "displayvideo.advertisers.locationLists.assignedLocations.create", - "parameterOrder": [ - "advertiserId", - "locationListId" - ], - "parameters": { - "advertiserId": { - "description": "Required. The ID of the DV360 advertiser to which the location list belongs.", - "format": "int64", - "location": "path", - "required": true, - "type": "string" - }, - "locationListId": { - "description": "Required. The ID of the location list for which the assignment will be created.", - "format": "int64", - "location": "path", - "required": true, + "locationListId": { + "description": "Required. The ID of the location list to fetch.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/locationLists/{+locationListId}", + "response": { + "$ref": "LocationList" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists location lists based on a given advertiser id.", + "flatPath": "v4/advertisers/{advertisersId}/locationLists", + "httpMethod": "GET", + "id": "displayvideo.advertisers.locationLists.list", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the DV360 advertiser to which the fetched location lists belong.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Allows filtering by location list fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `locationType` Examples: * All regional location list: `locationType=\"TARGETING_LOCATION_TYPE_REGIONAL\"` * All proximity location list: `locationType=\"TARGETING_LOCATION_TYPE_PROXIMITY\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `locationListId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLocationLists` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/locationLists", + "response": { + "$ref": "ListLocationListsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "patch": { + "description": "Updates a location list. Returns the updated location list if successful.", + "flatPath": "v4/advertisers/{advertisersId}/locationLists/{locationListId}", + "httpMethod": "PATCH", + "id": "displayvideo.advertisers.locationLists.patch", + "parameterOrder": [ + "advertiserId", + "locationListId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the DV360 advertiser to which the location lists belongs.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "locationListId": { + "description": "Output only. The unique ID of the location list. Assigned by the system.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The mask to control which fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v4/advertisers/{+advertiserId}/locationLists/{locationListId}", + "request": { + "$ref": "LocationList" + }, + "response": { + "$ref": "LocationList" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + }, + "resources": { + "assignedLocations": { + "methods": { + "bulkEdit": { + "description": "Bulk edits multiple assignments between locations and a single location list. The operation will delete the assigned locations provided in deletedAssignedLocations and then create the assigned locations provided in createdAssignedLocations.", + "flatPath": "v4/advertisers/{advertiserId}/locationLists/{locationListsId}/assignedLocations:bulkEdit", + "httpMethod": "POST", + "id": "displayvideo.advertisers.locationLists.assignedLocations.bulkEdit", + "parameterOrder": [ + "advertiserId", + "locationListId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the DV360 advertiser to which the location list belongs.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "locationListId": { + "description": "Required. The ID of the location list to which these assignments are assigned.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v4/advertisers/{advertiserId}/locationLists/{+locationListId}/assignedLocations:bulkEdit", + "request": { + "$ref": "BulkEditAssignedLocationsRequest" + }, + "response": { + "$ref": "BulkEditAssignedLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "create": { + "description": "Creates an assignment between a location and a location list.", + "flatPath": "v4/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations", + "httpMethod": "POST", + "id": "displayvideo.advertisers.locationLists.assignedLocations.create", + "parameterOrder": [ + "advertiserId", + "locationListId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the DV360 advertiser to which the location list belongs.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "locationListId": { + "description": "Required. The ID of the location list for which the assignment will be created.", + "format": "int64", + "location": "path", + "required": true, "type": "string" } }, @@ -9302,7 +9925,7 @@ } } }, - "revision": "20250930", + "revision": "20251027", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActiveViewVideoViewabilityMetricConfig": { @@ -9363,254 +9986,871 @@ ], "type": "string" }, - "minimumQuartile": { - "description": "The minimum visible video duration required, based on the video quartiles, in order for an impression to be recorded. You must specify minimum_duration, minimum_quartile or both. If both are specified, an impression meets the metric criteria if either requirement is met (whichever happens first).", + "minimumQuartile": { + "description": "The minimum visible video duration required, based on the video quartiles, in order for an impression to be recorded. You must specify minimum_duration, minimum_quartile or both. If both are specified, an impression meets the metric criteria if either requirement is met (whichever happens first).", + "enum": [ + "VIDEO_DURATION_QUARTILE_UNSPECIFIED", + "VIDEO_DURATION_QUARTILE_NONE", + "VIDEO_DURATION_QUARTILE_FIRST", + "VIDEO_DURATION_QUARTILE_SECOND", + "VIDEO_DURATION_QUARTILE_THIRD", + "VIDEO_DURATION_QUARTILE_FOURTH" + ], + "enumDescriptions": [ + "Value is not specified or is unknown in this version.", + "No quartile value.", + "First quartile.", + "Second quartile (midpoint).", + "Third quartile.", + "Fourth quartile (completion)." + ], + "type": "string" + }, + "minimumViewability": { + "description": "Required. The minimum percentage of the video ad's pixels visible on the screen in order for an impression to be recorded.", + "enum": [ + "VIEWABILITY_PERCENT_UNSPECIFIED", + "VIEWABILITY_PERCENT_0", + "VIEWABILITY_PERCENT_25", + "VIEWABILITY_PERCENT_50", + "VIEWABILITY_PERCENT_75", + "VIEWABILITY_PERCENT_100" + ], + "enumDescriptions": [ + "Value is not specified or is unknown in this version.", + "0% viewable.", + "25% viewable.", + "50% viewable.", + "75% viewable.", + "100% viewable." + ], + "type": "string" + }, + "minimumVolume": { + "description": "Required. The minimum percentage of the video ad's volume required in order for an impression to be recorded.", + "enum": [ + "VIDEO_VOLUME_PERCENT_UNSPECIFIED", + "VIDEO_VOLUME_PERCENT_0", + "VIDEO_VOLUME_PERCENT_10" + ], + "enumDescriptions": [ + "Value is not specified or is unknown in this version.", + "0% volume.", + "10% volume." + ], + "type": "string" + } + }, + "type": "object" + }, + "AdAsset": { + "description": "A single ad asset.", + "id": "AdAsset", + "properties": { + "adAssetId": { + "description": "Output only. The ID of the ad asset. Referred to as the asset ID when assigned to an ad.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "adAssetType": { + "description": "Required. The type of the ad asset.", + "enum": [ + "AD_ASSET_TYPE_UNSPECIFIED", + "AD_ASSET_TYPE_IMAGE", + "AD_ASSET_TYPE_YOUTUBE_VIDEO" + ], + "enumDescriptions": [ + "The ad asset type is unspecified.", + "The ad asset is a YouTube/DemandGen image.", + "The ad asset is a YouTube video." + ], + "type": "string" + }, + "entityStatus": { + "description": "Output only. The entity status of the ad asset.", + "enum": [ + "ENTITY_STATUS_UNSPECIFIED", + "ENTITY_STATUS_ACTIVE", + "ENTITY_STATUS_ARCHIVED", + "ENTITY_STATUS_DRAFT", + "ENTITY_STATUS_PAUSED", + "ENTITY_STATUS_SCHEDULED_FOR_DELETION" + ], + "enumDescriptions": [ + "Default value when status is not specified or is unknown in this version.", + "The entity is enabled to bid and spend budget.", + "The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", + "The entity is under draft. Bidding and budget spending are disabled.", + "Bidding and budget spending are paused for the entity.", + "The entity is scheduled for deletion." + ], + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Identifier. The resource name of the ad asset.", + "type": "string" + }, + "youtubeVideoAsset": { + "$ref": "YoutubeVideoAsset", + "description": "Youtube video asset data." + } + }, + "type": "object" + }, + "AdGroup": { + "description": "A single ad group associated with a line item.", + "id": "AdGroup", + "properties": { + "adGroupFormat": { + "description": "The format of the ads in the ad group.", + "enum": [ + "AD_GROUP_FORMAT_UNSPECIFIED", + "AD_GROUP_FORMAT_IN_STREAM", + "AD_GROUP_FORMAT_VIDEO_DISCOVERY", + "AD_GROUP_FORMAT_BUMPER", + "AD_GROUP_FORMAT_NON_SKIPPABLE_IN_STREAM", + "AD_GROUP_FORMAT_AUDIO", + "AD_GROUP_FORMAT_RESPONSIVE", + "AD_GROUP_FORMAT_REACH", + "AD_GROUP_FORMAT_MASTHEAD" + ], + "enumDescriptions": [ + "Format value is not specified or is unknown in this version.", + "In-stream ads.", + "In-feed ads.", + "Bumper ads.", + "Non-skippable in-stream ads.", + "Non-skippable in-stream audio ads.", + "Responsive ads.", + "[Effective reach ad groups] (https://support.google.com/displayvideo/answer/9173684), including in-stream and bumper ads.", + "Masthead Ad that is surfaced on the top slot on the YouTube homepage." + ], + "type": "string" + }, + "adGroupId": { + "description": "The unique ID of the ad group. Assigned by the system.", + "format": "int64", + "type": "string" + }, + "advertiserId": { + "description": "The unique ID of the advertiser the ad group belongs to.", + "format": "int64", + "type": "string" + }, + "bidStrategy": { + "$ref": "BiddingStrategy", + "description": "The bidding strategy used by the ad group. Only the youtubeAndPartnersBid field can be used in the bidding strategy." + }, + "displayName": { + "description": "The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.", + "type": "string" + }, + "entityStatus": { + "description": "Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group's parent line item is not active, the ad group can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.", + "enum": [ + "ENTITY_STATUS_UNSPECIFIED", + "ENTITY_STATUS_ACTIVE", + "ENTITY_STATUS_ARCHIVED", + "ENTITY_STATUS_DRAFT", + "ENTITY_STATUS_PAUSED", + "ENTITY_STATUS_SCHEDULED_FOR_DELETION" + ], + "enumDescriptions": [ + "Default value when status is not specified or is unknown in this version.", + "The entity is enabled to bid and spend budget.", + "The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", + "The entity is under draft. Bidding and budget spending are disabled.", + "Bidding and budget spending are paused for the entity.", + "The entity is scheduled for deletion." + ], + "type": "string" + }, + "lineItemId": { + "description": "The unique ID of the line item that the ad group belongs to.", + "format": "int64", + "type": "string" + }, + "name": { + "description": "The resource name of the ad group.", + "type": "string" + }, + "productFeedData": { + "$ref": "ProductFeedData", + "description": "The settings of the product feed in this ad group." + }, + "targetingExpansion": { + "$ref": "TargetingExpansionConfig", + "description": "The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the ad group." + } + }, + "type": "object" + }, + "AdGroupAd": { + "description": "A single ad associated with an ad group.", + "id": "AdGroupAd", + "properties": { + "adGroupAdId": { + "description": "The unique ID of the ad. Assigned by the system.", + "format": "int64", + "type": "string" + }, + "adGroupId": { + "description": "The unique ID of the ad group that the ad belongs to. *Caution*: Parent ad groups for Demand Gen ads are not currently retrieveable using `advertisers.adGroups.list` or `advertisers.adGroups.get`. Demand Gen ads can be identified by the absence of the `ad_details` union field.", + "format": "int64", + "type": "string" + }, + "adPolicy": { + "$ref": "AdPolicy", + "description": "The policy approval status of the ad." + }, + "adUrls": { + "description": "List of URLs used by the ad.", + "items": { + "$ref": "AdUrl" + }, + "type": "array" + }, + "advertiserId": { + "description": "The unique ID of the advertiser the ad belongs to.", + "format": "int64", + "type": "string" + }, + "audioAd": { + "$ref": "AudioAd", + "description": "Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives." + }, + "bumperAd": { + "$ref": "BumperAd", + "description": "Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach." + }, + "displayName": { + "description": "The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes.", + "type": "string" + }, + "displayVideoSourceAd": { + "$ref": "DisplayVideoSourceAd", + "description": "Details of an ad sourced from a Display & Video 360 creative." + }, + "entityStatus": { + "description": "The entity status of the ad.", + "enum": [ + "ENTITY_STATUS_UNSPECIFIED", + "ENTITY_STATUS_ACTIVE", + "ENTITY_STATUS_ARCHIVED", + "ENTITY_STATUS_DRAFT", + "ENTITY_STATUS_PAUSED", + "ENTITY_STATUS_SCHEDULED_FOR_DELETION" + ], + "enumDescriptions": [ + "Default value when status is not specified or is unknown in this version.", + "The entity is enabled to bid and spend budget.", + "The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", + "The entity is under draft. Bidding and budget spending are disabled.", + "Bidding and budget spending are paused for the entity.", + "The entity is scheduled for deletion." + ], + "type": "string" + }, + "inStreamAd": { + "$ref": "InStreamAd", + "description": "Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives." + }, + "mastheadAd": { + "$ref": "MastheadAd", + "description": "Details of an [ad served on the YouTube Home feed](//support.google.com/google-ads/answer/9709826)." + }, + "name": { + "description": "The resource name of the ad.", + "type": "string" + }, + "nonSkippableAd": { + "$ref": "NonSkippableAd", + "description": "Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives." + }, + "videoDiscoverAd": { + "$ref": "VideoDiscoveryAd", + "description": "Details of an [ad promoting a video](//support.google.com/displayvideo/answer/6274216) that shows in places of discovery." + }, + "videoPerformanceAd": { + "$ref": "VideoPerformanceAd", + "description": "Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product." + } + }, + "type": "object" + }, + "AdGroupAssignedTargetingOption": { + "description": "Wrapper object associating an AssignedTargetingOption resource and the ad group it is assigned to.", + "id": "AdGroupAssignedTargetingOption", + "properties": { + "adGroupId": { + "description": "The ID of the ad group the assigned targeting option is assigned to.", + "format": "int64", + "type": "string" + }, + "assignedTargetingOption": { + "$ref": "AssignedTargetingOption", + "description": "The assigned targeting option resource." + } + }, + "type": "object" + }, + "AdPolicy": { + "description": "A single ad policy associated with an ad group ad.", + "id": "AdPolicy", + "properties": { + "adPolicyApprovalStatus": { + "description": "The policy approval status of an ad, indicating the approval decision.", + "enum": [ + "AD_POLICY_APPROVAL_STATUS_UNKNOWN", + "DISAPPROVED", + "APPROVED_LIMITED", + "APPROVED", + "AREA_OF_INTEREST_ONLY" + ], + "enumDescriptions": [ + "Unknown or not specified.", + "Will not serve.", + "Will serve with restrictions.", + "Will serve without restrictions.", + "Will not serve in targeted countries, but may serve for users who are searching for information about the targeted countries." + ], + "type": "string" + }, + "adPolicyReviewStatus": { + "description": "The policy review status of an ad, indicating where in the review process the ad is currently.", + "enum": [ + "AD_POLICY_REVIEW_STATUS_UNKNOWN", + "REVIEW_IN_PROGRESS", + "REVIEWED", + "UNDER_APPEAL", + "ELIGIBLE_MAY_SERVE" + ], + "enumDescriptions": [ + "Unknown or not specified.", + "Currently under review.", + "Primary review complete. Other reviews may still be in progress.", + "Resubmitted for approval or a policy decision has been appealed.", + "Deemed eligible and may be serving. Further review could still follow." + ], + "type": "string" + }, + "adPolicyTopicEntry": { + "description": "The entries for each policy topic identified as relating to the ad. Each entry includes the topic, restriction level, and guidance on how to fix policy issues.", + "items": { + "$ref": "AdPolicyTopicEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "AdPolicyCriterionRestriction": { + "description": "Represents a country restriction.", + "id": "AdPolicyCriterionRestriction", + "properties": { + "countryCriterionId": { + "description": "The country criterion id.", + "format": "int64", + "type": "string" + }, + "countryLabel": { + "description": "Localized name for the country. May be empty.", + "type": "string" + } + }, + "type": "object" + }, + "AdPolicyTopicAppealInfo": { + "description": "Information on how to appeal a policy decision.", + "id": "AdPolicyTopicAppealInfo", + "properties": { + "appealFormLink": { + "description": "Only available when appeal_type is `APPEAL_FORM`.", + "type": "string" + }, + "appealType": { + "description": "Whether the decision can be appealed through a self-service appeal or an appeal form.", + "enum": [ + "AD_POLICY_APPEAL_TYPE_UNKNOWN", + "SELF_SERVICE_APPEAL", + "APPEAL_FORM" + ], + "enumDescriptions": [ + "Unknown or not specified.", + "The decision can be appealed through a self-service appeal.", + "The decision can be appealed using an appeal form." + ], + "type": "string" + } + }, + "type": "object" + }, + "AdPolicyTopicConstraint": { + "description": "Details on ad serving constraints.", + "id": "AdPolicyTopicConstraint", + "properties": { + "certificateDomainMismatchCountryList": { + "$ref": "AdPolicyTopicConstraintAdPolicyCountryConstraintList", + "description": "Countries where the resource's domain is not covered by the certificates associated with it." + }, + "certificateMissingCountryList": { + "$ref": "AdPolicyTopicConstraintAdPolicyCountryConstraintList", + "description": "Countries where a certificate is required for serving." + }, + "countryConstraint": { + "$ref": "AdPolicyTopicConstraintAdPolicyCountryConstraintList", + "description": "Countries where the ad cannot serve." + }, + "globalCertificateDomainMismatch": { + "$ref": "AdPolicyTopicConstraintAdPolicyGlobalCertificateDomainMismatchConstraint", + "description": "Certificate is required to serve in any country and the existing certificate does not cover the ad's domain." + }, + "globalCertificateMissing": { + "$ref": "AdPolicyTopicConstraintAdPolicyGlobalCertificateMissingConstraint", + "description": "Certificate is required to serve in any country." + }, + "requestCertificateFormLink": { + "description": "Link to the form to request a certificate for the constraint.", + "type": "string" + }, + "resellerConstraint": { + "$ref": "AdPolicyTopicConstraintAdPolicyResellerConstraint", + "description": "Reseller constraint." + } + }, + "type": "object" + }, + "AdPolicyTopicConstraintAdPolicyCountryConstraintList": { + "description": "A list of countries where the ad cannot serve due to policy constraints.", + "id": "AdPolicyTopicConstraintAdPolicyCountryConstraintList", + "properties": { + "countries": { + "description": "Countries where the ad cannot serve.", + "items": { + "$ref": "AdPolicyCriterionRestriction" + }, + "type": "array" + } + }, + "type": "object" + }, + "AdPolicyTopicConstraintAdPolicyGlobalCertificateDomainMismatchConstraint": { + "description": "Certificate is required to serve in any country and the existing certificate does not cover the ad's domain.", + "id": "AdPolicyTopicConstraintAdPolicyGlobalCertificateDomainMismatchConstraint", + "properties": {}, + "type": "object" + }, + "AdPolicyTopicConstraintAdPolicyGlobalCertificateMissingConstraint": { + "description": "Certificate is required to serve in any country.", + "id": "AdPolicyTopicConstraintAdPolicyGlobalCertificateMissingConstraint", + "properties": {}, + "type": "object" + }, + "AdPolicyTopicConstraintAdPolicyResellerConstraint": { + "description": "Policy topic was constrained due to disapproval of the website for reseller purposes.", + "id": "AdPolicyTopicConstraintAdPolicyResellerConstraint", + "properties": {}, + "type": "object" + }, + "AdPolicyTopicEntry": { + "description": "An entry describing how an ad has been identified as relating to an ad policy.", + "id": "AdPolicyTopicEntry", + "properties": { + "appealInfo": { + "$ref": "AdPolicyTopicAppealInfo", + "description": "Information on how to appeal the policy decision." + }, + "helpCenterLink": { + "description": "Ad policy help center link for the policy topic.", + "type": "string" + }, + "policyDecisionType": { + "description": "The source of the policy decision.", "enum": [ - "VIDEO_DURATION_QUARTILE_UNSPECIFIED", - "VIDEO_DURATION_QUARTILE_NONE", - "VIDEO_DURATION_QUARTILE_FIRST", - "VIDEO_DURATION_QUARTILE_SECOND", - "VIDEO_DURATION_QUARTILE_THIRD", - "VIDEO_DURATION_QUARTILE_FOURTH" + "AD_POLICY_DECISION_TYPE_UNKNOWN", + "PURSUANT_TO_NOTICE", + "GOOGLE_INVESTIGATION" ], "enumDescriptions": [ - "Value is not specified or is unknown in this version.", - "No quartile value.", - "First quartile.", - "Second quartile (midpoint).", - "Third quartile.", - "Fourth quartile (completion)." + "Unknown or not specified.", + "The decision is from a legal notice, court order, or trademark content owner complaint, etc.", + "The decision is from a Google-owned investigation." ], "type": "string" }, - "minimumViewability": { - "description": "Required. The minimum percentage of the video ad's pixels visible on the screen in order for an impression to be recorded.", + "policyEnforcementMeans": { + "description": "The policy enforcement means used in the policy review.", "enum": [ - "VIEWABILITY_PERCENT_UNSPECIFIED", - "VIEWABILITY_PERCENT_0", - "VIEWABILITY_PERCENT_25", - "VIEWABILITY_PERCENT_50", - "VIEWABILITY_PERCENT_75", - "VIEWABILITY_PERCENT_100" + "AD_POLICY_ENFORCEMENT_MEANS_UNKNOWN", + "AUTOMATED", + "HUMAN_REVIEW" ], "enumDescriptions": [ - "Value is not specified or is unknown in this version.", - "0% viewable.", - "25% viewable.", - "50% viewable.", - "75% viewable.", - "100% viewable." + "Unknown or not specified.", + "The enforcement process was fully automated.", + "A human was partially or fully involved in the decision enforcement process." ], "type": "string" }, - "minimumVolume": { - "description": "Required. The minimum percentage of the video ad's volume required in order for an impression to be recorded.", + "policyLabel": { + "description": "Localized label text for policy. Examples include \"Trademarks in text\", \"Contains Alcohol\", etc.", + "type": "string" + }, + "policyTopic": { + "description": "The policy topic. Examples include \"TRADEMARKS\", \"ALCOHOL\", etc.", + "type": "string" + }, + "policyTopicConstraints": { + "description": "The serving constraints relevant to the policy decision.", + "items": { + "$ref": "AdPolicyTopicConstraint" + }, + "type": "array" + }, + "policyTopicDescription": { + "description": "A short summary description of the policy topic.", + "type": "string" + }, + "policyTopicEvidences": { + "description": "The evidence used in the policy decision.", + "items": { + "$ref": "AdPolicyTopicEvidence" + }, + "type": "array" + }, + "policyTopicType": { + "description": "How ad serving will be affected due to the relation to the ad policy topic.", "enum": [ - "VIDEO_VOLUME_PERCENT_UNSPECIFIED", - "VIDEO_VOLUME_PERCENT_0", - "VIDEO_VOLUME_PERCENT_10" + "AD_POLICY_TOPIC_ENTRY_TYPE_UNKNOWN", + "PROHIBITED", + "FULLY_LIMITED", + "LIMITED", + "DESCRIPTIVE", + "BROADENING", + "AREA_OF_INTEREST_ONLY" ], "enumDescriptions": [ - "Value is not specified or is unknown in this version.", - "0% volume.", - "10% volume." + "Unknown or not specified.", + "The resource will not serve.", + "The resource will not serve in all targeted countries.", + "The resource cannot serve in some countries.", + "The resource can serve.", + "The resource can serve, and may serve beyond normal coverage.", + "The resource is constrained for all targeted countries, but may serve for users who are searching for information about the targeted countries." ], "type": "string" } }, "type": "object" }, - "AdGroup": { - "description": "A single ad group associated with a line item.", - "id": "AdGroup", + "AdPolicyTopicEvidence": { + "description": "Evidence information used in the policy decision.", + "id": "AdPolicyTopicEvidence", "properties": { - "adGroupFormat": { - "description": "The format of the ads in the ad group.", + "counterfeit": { + "$ref": "AdPolicyTopicEvidenceCounterfeit", + "description": "Counterfeit enforcement that caused a policy violation." + }, + "destinationMismatch": { + "$ref": "AdPolicyTopicEvidenceDestinationMismatch", + "description": "A mismatch between the ad destination URLs." + }, + "destinationNotWorking": { + "$ref": "AdPolicyTopicEvidenceDestinationNotWorking", + "description": "Information on HTTP or DNS errors related to the ad destination." + }, + "destinationTextList": { + "$ref": "AdPolicyTopicEvidenceDestinationTextList", + "description": "The text in the destination of the ad that is causing a policy violation." + }, + "httpCode": { + "description": "HTTP code returned when the final URL was crawled.", + "format": "int32", + "type": "integer" + }, + "languageCode": { + "description": "The language the ad was detected to be written in. This field uses IETF language tags, such as \"en-US\".", + "type": "string" + }, + "legalRemoval": { + "$ref": "AdPolicyTopicEvidenceLegalRemoval", + "description": "Legal related regulation enforcement that caused a policy violation." + }, + "regionalRequirements": { + "$ref": "AdPolicyTopicEvidenceRegionalRequirements", + "description": "T&S proactive enforcement that caused a policy violation." + }, + "textList": { + "$ref": "AdPolicyTopicEvidenceTextList", + "description": "List of evidence found in the text of the ad." + }, + "trademark": { + "$ref": "AdPolicyTopicEvidenceTrademark", + "description": "Trademark terms that caused a policy violation." + }, + "websiteList": { + "$ref": "AdPolicyTopicEvidenceWebsiteList", + "description": "List of websites linked with the ad." + } + }, + "type": "object" + }, + "AdPolicyTopicEvidenceCounterfeit": { + "description": "Details on the counterfeit enforcement that caused a policy violation.", + "id": "AdPolicyTopicEvidenceCounterfeit", + "properties": { + "owners": { + "description": "The content or product owners that made a complaint.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "AdPolicyTopicEvidenceDestinationMismatch": { + "description": "Details on a mismatch between destination URL types.", + "id": "AdPolicyTopicEvidenceDestinationMismatch", + "properties": { + "uriTypes": { + "description": "The set of URLs that do not match. The list can include single or multiple uri types. Example 1: [`DISPLAY_URL`, `FINAL_URL`] means ad display URL does not match with the ad final URL. Example 2: [`FINAL_URL`] means ad final URL did not match the crawled url, which is also considered as destination mismatch.", + "items": { + "enum": [ + "AD_POLICY_TOPIC_EVIDENCE_DESTINATION_MISMATCH_URL_TYPE_UNKNOWN", + "DISPLAY_URL", + "FINAL_URL", + "FINAL_MOBILE_URL", + "TRACKING_URL", + "MOBILE_TRACKING_URL" + ], + "enumDescriptions": [ + "Not specified or unknown.", + "The display URL.", + "The final URL.", + "The final mobile URL.", + "The tracking URL.", + "The mobile tracking URL." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "AdPolicyTopicEvidenceDestinationNotWorking": { + "description": "Details for on HTTP or DNS errors related to the ad destination.", + "id": "AdPolicyTopicEvidenceDestinationNotWorking", + "properties": { + "device": { + "description": "The device where visiting the URL resulted in the error.", "enum": [ - "AD_GROUP_FORMAT_UNSPECIFIED", - "AD_GROUP_FORMAT_IN_STREAM", - "AD_GROUP_FORMAT_VIDEO_DISCOVERY", - "AD_GROUP_FORMAT_BUMPER", - "AD_GROUP_FORMAT_NON_SKIPPABLE_IN_STREAM", - "AD_GROUP_FORMAT_AUDIO", - "AD_GROUP_FORMAT_RESPONSIVE", - "AD_GROUP_FORMAT_REACH", - "AD_GROUP_FORMAT_MASTHEAD", - "AD_GROUP_FORMAT_DEMAND_GEN" + "AD_POLICY_TOPIC_EVIDENCE_DESTINATION_NOT_WORKING_DEVICE_TYPE_UNKNOWN", + "DESKTOP", + "ANDROID", + "IOS" ], "enumDescriptions": [ - "Format value is not specified or is unknown in this version.", - "In-stream ads.", - "In-feed ads.", - "Bumper ads.", - "Non-skippable in-stream ads.", - "Non-skippable in-stream audio ads.", - "Responsive ads.", - "[Effective reach ad groups] (https://support.google.com/displayvideo/answer/9173684), including in-stream and bumper ads.", - "Masthead Ad that is surfaced on the top slot on the YouTube homepage.", - "Demand Gen ads." + "Not specified or unknown.", + "Desktop device.", + "Android device.", + "iOS device." ], "type": "string" }, - "adGroupId": { - "description": "The unique ID of the ad group. Assigned by the system.", - "format": "int64", + "dnsErrorType": { + "description": "The type of DNS error.", + "enum": [ + "AD_POLICY_TOPIC_EVIDENCE_DESTINATION_NOT_WORKING_DNS_ERROR_TYPE_UNKNOWN", + "HOSTNAME_NOT_FOUND", + "GOOGLE_CRAWLER_DNS_ISSUE" + ], + "enumDescriptions": [ + "Not specified or unknown.", + "Host name not found in DNS when fetching landing page.", + "Google could not crawl the landing page when communicating with DNS." + ], "type": "string" }, - "advertiserId": { - "description": "The unique ID of the advertiser the ad group belongs to.", - "format": "int64", + "expandedUri": { + "description": "The full URL that didn't work.", "type": "string" }, - "bidStrategy": { - "$ref": "BiddingStrategy", - "description": "The bidding strategy used by the ad group. Only the youtubeAndPartnersBid field can be used in the bidding strategy." - }, - "displayName": { - "description": "The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.", + "httpErrorCode": { + "description": "The HTTP error code.", + "format": "int64", "type": "string" }, - "entityStatus": { - "description": "Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group's parent line item is not active, the ad group can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.", + "lastCheckedTime": { + "description": "The last time the error was seen when navigating to URL.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "AdPolicyTopicEvidenceDestinationTextList": { + "description": "A list of destination text that violated the policy.", + "id": "AdPolicyTopicEvidenceDestinationTextList", + "properties": { + "destinationTexts": { + "description": "Destination text that caused the policy finding.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "AdPolicyTopicEvidenceLegalRemoval": { + "description": "Legal related regulation enforcement, either from DMCA or local legal regulation.", + "id": "AdPolicyTopicEvidenceLegalRemoval", + "properties": { + "complaintType": { + "description": "The type of complaint causing the legal removal.", "enum": [ - "ENTITY_STATUS_UNSPECIFIED", - "ENTITY_STATUS_ACTIVE", - "ENTITY_STATUS_ARCHIVED", - "ENTITY_STATUS_DRAFT", - "ENTITY_STATUS_PAUSED", - "ENTITY_STATUS_SCHEDULED_FOR_DELETION" + "AD_POLICY_TOPIC_EVIDENCE_LEGAL_REMOVAL_COMPLAINT_TYPE_UNKNOWN", + "COPYRIGHT", + "COURT_ORDER", + "LOCAL_LEGAL" ], "enumDescriptions": [ - "Default value when status is not specified or is unknown in this version.", - "The entity is enabled to bid and spend budget.", - "The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", - "The entity is under draft. Bidding and budget spending are disabled.", - "Bidding and budget spending are paused for the entity.", - "The entity is scheduled for deletion." + "Not specified or unknown.", + "Copyright. Only applies to DMCA.", + "Court order. Only applies to local legal.", + "Local legal regulation. Only applies to local legal." ], "type": "string" }, - "lineItemId": { - "description": "The unique ID of the line item that the ad group belongs to.", - "format": "int64", - "type": "string" + "countryRestrictions": { + "description": "The countries restricted due to the legal removal.", + "items": { + "$ref": "AdPolicyCriterionRestriction" + }, + "type": "array" }, - "name": { - "description": "The resource name of the ad group.", - "type": "string" + "dmca": { + "$ref": "AdPolicyTopicEvidenceLegalRemovalDmca", + "description": "Details on the DMCA regulation legal removal." }, - "productFeedData": { - "$ref": "ProductFeedData", - "description": "The settings of the product feed in this ad group." + "localLegal": { + "$ref": "AdPolicyTopicEvidenceLegalRemovalLocalLegal", + "description": "Details on the local legal regulation legal removal." }, - "targetingExpansion": { - "$ref": "TargetingExpansionConfig", - "description": "The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the ad group." + "restrictedUris": { + "description": "The urls restricted due to the legal removal.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "AdPolicyTopicEvidenceLegalRemovalDmca": { + "description": "DMCA complaint details.", + "id": "AdPolicyTopicEvidenceLegalRemovalDmca", + "properties": { + "complainant": { + "description": "The entity who made the legal complaint.", + "type": "string" + } + }, + "type": "object" + }, + "AdPolicyTopicEvidenceLegalRemovalLocalLegal": { + "description": "Local legal regulation details.", + "id": "AdPolicyTopicEvidenceLegalRemovalLocalLegal", + "properties": { + "lawType": { + "description": "Type of law for the legal notice.", + "type": "string" + } + }, + "type": "object" + }, + "AdPolicyTopicEvidenceRegionalRequirements": { + "description": "Trust & Safety (T&S) proactive enforcement for policies meant to address regional requirements. This is considered a Google-owned investigation instead of a regulation notice since it's proactive T&S enforcement.", + "id": "AdPolicyTopicEvidenceRegionalRequirements", + "properties": { + "regionalRequirementsEntries": { + "description": "List of regional requirements.", + "items": { + "$ref": "AdPolicyTopicEvidenceRegionalRequirementsRegionalRequirementsEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "AdPolicyTopicEvidenceRegionalRequirementsRegionalRequirementsEntry": { + "description": "Policy level regional legal violation details.", + "id": "AdPolicyTopicEvidenceRegionalRequirementsRegionalRequirementsEntry", + "properties": { + "countryRestrictions": { + "description": "The countries restricted due to the legal policy.", + "items": { + "$ref": "AdPolicyCriterionRestriction" + }, + "type": "array" + }, + "legalPolicy": { + "description": "The legal policy that is being violated.", + "type": "string" + } + }, + "type": "object" + }, + "AdPolicyTopicEvidenceTextList": { + "description": "A list of fragments of text that violated the policy.", + "id": "AdPolicyTopicEvidenceTextList", + "properties": { + "texts": { + "description": "The fragments of text from the resource that caused the policy finding.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "AdGroupAd": { - "description": "A single ad associated with an ad group.", - "id": "AdGroupAd", + "AdPolicyTopicEvidenceTrademark": { + "description": "Trademark terms that caused a policy violation.", + "id": "AdPolicyTopicEvidenceTrademark", "properties": { - "adGroupAdId": { - "description": "The unique ID of the ad. Assigned by the system.", - "format": "int64", - "type": "string" - }, - "adGroupId": { - "description": "The unique ID of the ad group that the ad belongs to.", - "format": "int64", - "type": "string" - }, - "adUrls": { - "description": "List of URLs used by the ad.", + "countryRestrictions": { + "description": "Countries where the policy violation is relevant.", "items": { - "$ref": "AdUrl" + "$ref": "AdPolicyCriterionRestriction" }, "type": "array" }, - "advertiserId": { - "description": "The unique ID of the advertiser the ad belongs to.", - "format": "int64", - "type": "string" - }, - "audioAd": { - "$ref": "AudioAd", - "description": "Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives." - }, - "bumperAd": { - "$ref": "BumperAd", - "description": "Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach." - }, - "displayName": { - "description": "The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes.", - "type": "string" - }, - "displayVideoSourceAd": { - "$ref": "DisplayVideoSourceAd", - "description": "Details of an ad sourced from a Display & Video 360 creative." - }, - "entityStatus": { - "description": "The entity status of the ad.", - "enum": [ - "ENTITY_STATUS_UNSPECIFIED", - "ENTITY_STATUS_ACTIVE", - "ENTITY_STATUS_ARCHIVED", - "ENTITY_STATUS_DRAFT", - "ENTITY_STATUS_PAUSED", - "ENTITY_STATUS_SCHEDULED_FOR_DELETION" - ], - "enumDescriptions": [ - "Default value when status is not specified or is unknown in this version.", - "The entity is enabled to bid and spend budget.", - "The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", - "The entity is under draft. Bidding and budget spending are disabled.", - "Bidding and budget spending are paused for the entity.", - "The entity is scheduled for deletion." - ], + "owner": { + "description": "The trademark content owner.", "type": "string" }, - "inStreamAd": { - "$ref": "InStreamAd", - "description": "Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives." - }, - "mastheadAd": { - "$ref": "MastheadAd", - "description": "Details of an [ad served on the YouTube Home feed](//support.google.com/google-ads/answer/9709826)." - }, - "name": { - "description": "The resource name of the ad.", + "term": { + "description": "The trademark term.", "type": "string" - }, - "nonSkippableAd": { - "$ref": "NonSkippableAd", - "description": "Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives." - }, - "videoDiscoverAd": { - "$ref": "VideoDiscoveryAd", - "description": "Details of an [ad promoting a video](//support.google.com/displayvideo/answer/6274216) that shows in places of discovery." - }, - "videoPerformanceAd": { - "$ref": "VideoPerformanceAd", - "description": "Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product." } }, "type": "object" }, - "AdGroupAssignedTargetingOption": { - "description": "Wrapper object associating an AssignedTargetingOption resource and the ad group it is assigned to.", - "id": "AdGroupAssignedTargetingOption", + "AdPolicyTopicEvidenceWebsiteList": { + "description": "A list of websites that violated the policy.", + "id": "AdPolicyTopicEvidenceWebsiteList", "properties": { - "adGroupId": { - "description": "The ID of the ad group the assigned targeting option is assigned to.", - "format": "int64", - "type": "string" - }, - "assignedTargetingOption": { - "$ref": "AssignedTargetingOption", - "description": "The assigned targeting option resource." + "websites": { + "description": "Websites that caused the policy finding.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -10802,7 +12042,7 @@ "Creative height and width in pixels. Value is stored in the creativeDimensionValue field of the comparison value.", "Video content duration. Value is stored in the contentDurationValue field of the comparison value. The comparisonOperator field must be set to `LIST_CONTAINS`.", "Video delivery type. Value is stored in the contentStreamTypeValue field of the comparison value. The comparisonOperator field must be set to `LIST_CONTAINS`.", - "Video genre id. Value is stored in the int64Value field of the comparison value. The comparisonOperator field must be set to `LIST_CONTAINS`." + "Video genre id. Value is stored in the contentGenreIdValue field of the comparison value. The comparisonOperator field must be set to `LIST_CONTAINS`." ], "type": "string" } @@ -11798,6 +13038,34 @@ }, "type": "object" }, + "BulkCreateAdAssetsRequest": { + "description": "A request message for BulkCreateAdAssets.", + "id": "BulkCreateAdAssetsRequest", + "properties": { + "adAssets": { + "description": "Required. Ad assets to create. Only supports assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.", + "items": { + "$ref": "AdAsset" + }, + "type": "array" + } + }, + "type": "object" + }, + "BulkCreateAdAssetsResponse": { + "description": "A response message for BulkCreateAdAssets.", + "id": "BulkCreateAdAssetsResponse", + "properties": { + "adAssets": { + "description": "The created ad assets.", + "items": { + "$ref": "AdAsset" + }, + "type": "array" + } + }, + "type": "object" + }, "BulkEditAdvertiserAssignedTargetingOptionsRequest": { "description": "Request message for BulkEditAdvertiserAssignedTargetingOptions.", "id": "BulkEditAdvertiserAssignedTargetingOptionsRequest", @@ -13424,6 +14692,17 @@ }, "type": "object" }, + "CreateAdAssetRequest": { + "description": "A request message for CreateAdAsset.", + "id": "CreateAdAssetRequest", + "properties": { + "adAsset": { + "$ref": "AdAsset", + "description": "Required. The ad asset to create. Only supports assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`." + } + }, + "type": "object" + }, "CreateAssetRequest": { "description": "A request message for CreateAsset.", "id": "CreateAssetRequest", @@ -13614,7 +14893,8 @@ "SDF_VERSION_8", "SDF_VERSION_8_1", "SDF_VERSION_9", - "SDF_VERSION_9_1" + "SDF_VERSION_9_1", + "SDF_VERSION_9_2" ], "enumDeprecated": [ false, @@ -13634,6 +14914,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -13654,7 +14935,8 @@ "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version.", "SDF version 8.1.", "SDF version 9. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version.", - "SDF version 9.1." + "SDF version 9.1.", + "SDF version 9.2." ], "type": "string" } @@ -17943,12 +19225,14 @@ "enum": [ "SUSPICIOUS_ACTIVITY_UNSPECIFIED", "SUSPICIOUS_ACTIVITY_HR", - "SUSPICIOUS_ACTIVITY_HMR" + "SUSPICIOUS_ACTIVITY_HMR", + "SUSPICIOUS_ACTIVITY_FD" ], "enumDescriptions": [ "This enum is only a placeholder and it doesn't specify any ad fraud prevention options.", "Ad Fraud - Exclude High Risk.", - "Ad Fraud - Exclude High and Moderate Risk." + "Ad Fraud - Exclude High and Moderate Risk.", + "Ad Fraud - Exclude Fraudulent Device." ], "type": "string" }, @@ -19230,6 +20514,24 @@ }, "type": "object" }, + "ListAdAssetsResponse": { + "description": "A response message for ListAdAssets.", + "id": "ListAdAssetsResponse", + "properties": { + "adAssets": { + "description": "The list of ad assets. The list will only contain assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`. This list will be absent if empty.", + "items": { + "$ref": "AdAsset" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAdAssets` method to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, "ListAdGroupAdsResponse": { "id": "ListAdGroupAdsResponse", "properties": { @@ -19836,6 +21138,24 @@ }, "type": "object" }, + "ListYoutubeAssetAssociationsResponse": { + "description": "Response message for YoutubeAssetAssociationService.ListYoutubeAssetAssociations.", + "id": "ListYoutubeAssetAssociationsResponse", + "properties": { + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListYoutubeAssetAssociations` method to retrieve the next page of results.", + "type": "string" + }, + "youtubeAssetAssociations": { + "description": "The list of asset associations. This list will be absent if empty.", + "items": { + "$ref": "YoutubeAssetAssociation" + }, + "type": "array" + } + }, + "type": "object" + }, "LocationList": { "description": "A list of locations used for targeting.", "id": "LocationList", @@ -21486,7 +22806,8 @@ "SDF_VERSION_8", "SDF_VERSION_8_1", "SDF_VERSION_9", - "SDF_VERSION_9_1" + "SDF_VERSION_9_1", + "SDF_VERSION_9_2" ], "enumDeprecated": [ false, @@ -21506,6 +22827,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -21526,7 +22848,8 @@ "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version.", "SDF version 8.1.", "SDF version 9. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version.", - "SDF version 9.1." + "SDF version 9.1.", + "SDF version 9.2." ], "type": "string" } @@ -21578,7 +22901,8 @@ "SDF_VERSION_8", "SDF_VERSION_8_1", "SDF_VERSION_9", - "SDF_VERSION_9_1" + "SDF_VERSION_9_1", + "SDF_VERSION_9_2" ], "enumDeprecated": [ false, @@ -21598,6 +22922,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -21618,7 +22943,8 @@ "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version.", "SDF version 8.1.", "SDF version 9. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version.", - "SDF version 9.1." + "SDF version 9.1.", + "SDF version 9.2." ], "type": "string" } @@ -22509,6 +23835,42 @@ }, "type": "object" }, + "UploadAdAssetRequest": { + "description": "A request message for UploadAdAsset.", + "id": "UploadAdAssetRequest", + "properties": { + "adAssetType": { + "description": "Required. The type of the ad asset. Only `AD_ASSET_TYPE_IMAGE` is supported.", + "enum": [ + "AD_ASSET_TYPE_UNSPECIFIED", + "AD_ASSET_TYPE_IMAGE", + "AD_ASSET_TYPE_YOUTUBE_VIDEO" + ], + "enumDescriptions": [ + "The ad asset type is unspecified.", + "The ad asset is a YouTube/DemandGen image.", + "The ad asset is a YouTube video." + ], + "type": "string" + }, + "filename": { + "description": "Required. The filename of the ad asset, including the file extension. The filename must be UTF-8 encoded with a maximum size of 240 bytes.", + "type": "string" + } + }, + "type": "object" + }, + "UploadAdAssetResponse": { + "description": "A response message for UploadAdAsset.", + "id": "UploadAdAssetResponse", + "properties": { + "adAsset": { + "$ref": "AdAsset", + "description": "The created ad asset." + } + }, + "type": "object" + }, "UrlAssignedTargetingOptionDetails": { "description": "Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`.", "id": "UrlAssignedTargetingOptionDetails", @@ -23101,6 +24463,188 @@ }, "type": "object" }, + "YoutubeAssetAssociation": { + "description": "An association between a resource and a YouTube asset.", + "id": "YoutubeAssetAssociation", + "properties": { + "linkedYoutubeAsset": { + "$ref": "YoutubeAssetAssociationLinkedYouTubeAsset", + "description": "Required. The YouTube asset associated with the resource." + }, + "name": { + "description": "Identifier. The resource name of the association. For line item-level associations: The name pattern is `advertisers/{advertiser_id}/lineItems/{line_item_id}/youtubeAssetTypes/{youtube_asset_type}/youtubeAssetAssociations/{youtube_asset_association_id}`. For ad group-level associations: The name pattern is `advertisers/{advertiser_id}/adGroups/{ad_group_id}/youtubeAssetTypes/{youtube_asset_type}/youtubeAssetAssociations/{youtube_asset_association_id}`. For `YOUTUBE_ASSET_TYPE_LOCATION` and `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION` associations: `youtube_asset_association_id` is the ID of the asset set linked, or 0 if the location_matching_type or affiliate_location_matching_type is `DISABLED`. For `YOUTUBE_ASSET_TYPE_SITELINK` associations: `youtube_asset_association_id` is be the ID of the sitelink asset linked.", + "type": "string" + }, + "youtubeAssetType": { + "description": "Required. The type of YouTube asset associated with the resource.", + "enum": [ + "YOUTUBE_ASSET_TYPE_UNSPECIFIED", + "YOUTUBE_ASSET_TYPE_LOCATION", + "YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION", + "YOUTUBE_ASSET_TYPE_SITELINK" + ], + "enumDescriptions": [ + "YouTube asset type is not specified or is unknown in this version.", + "Location asset.", + "Affiliate location asset.", + "Sitelink asset." + ], + "type": "string" + } + }, + "type": "object" + }, + "YoutubeAssetAssociationAffiliateLocationAssetFilter": { + "description": "An asset filter that matches eligible affiliate location assets for serving.", + "id": "YoutubeAssetAssociationAffiliateLocationAssetFilter", + "properties": { + "affiliateLocationMatchingFunction": { + "$ref": "YoutubeAssetAssociationAffiliateLocationAssetFilterAffiliateLocationMatchingFunction", + "description": "Optional. The matching function that determines how the affiliate location asset filter matches affiliate location assets. This field is required and can only be set for if affiliate_location_matching_type is `SELECTED_CHAINS`." + }, + "affiliateLocationMatchingType": { + "description": "Required. The matching type of this affiliate location asset filter.", + "enum": [ + "AFFILIATE_LOCATION_MATCHING_TYPE_UNSPECIFIED", + "SELECT_ALL", + "SELECTED_CHAINS", + "DISABLED" + ], + "enumDescriptions": [ + "Affiliate location matching type is not specified or is unknown in this version.", + "All available affiliate location assets are eligible for serving.", + "The selected affiliate location assets can serve.", + "No affiliate location assets can serve." + ], + "type": "string" + }, + "assetSetId": { + "description": "Output only. The ID of the asset set that matches the affiliate location assets eligible for serving.", + "format": "int64", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "YoutubeAssetAssociationAffiliateLocationAssetFilterAffiliateLocationChain": { + "description": "A chain of affiliate locations.", + "id": "YoutubeAssetAssociationAffiliateLocationAssetFilterAffiliateLocationChain", + "properties": { + "chainId": { + "description": "Required. ID of the affiliate location chain.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "YoutubeAssetAssociationAffiliateLocationAssetFilterAffiliateLocationMatchingFunction": { + "description": "The matching function for an affiliate location asset filter.", + "id": "YoutubeAssetAssociationAffiliateLocationAssetFilterAffiliateLocationMatchingFunction", + "properties": { + "chains": { + "description": "Optional. The selected affiliate location chain IDs. This field is required if affiliate_location_matching_type is `SELECTED_CHAINS`.", + "items": { + "$ref": "YoutubeAssetAssociationAffiliateLocationAssetFilterAffiliateLocationChain" + }, + "type": "array" + } + }, + "type": "object" + }, + "YoutubeAssetAssociationLinkedYouTubeAsset": { + "description": "A YouTube asset linked to a resource in a YoutubeAssetAssociation.", + "id": "YoutubeAssetAssociationLinkedYouTubeAsset", + "properties": { + "affiliateLocationAssetFilter": { + "$ref": "YoutubeAssetAssociationAffiliateLocationAssetFilter", + "description": "An affiliate location asset filter. This can be set only when youtube_asset_type is `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION`." + }, + "locationAssetFilter": { + "$ref": "YoutubeAssetAssociationLocationAssetFilter", + "description": "A location asset filter. This can be set only when youtube_asset_type is `YOUTUBE_ASSET_TYPE_LOCATION`." + }, + "sitelinkAsset": { + "$ref": "YoutubeAssetAssociationSitelinkAsset", + "description": "A sitelink asset. This can be set only when youtube_asset_type is `YOUTUBE_ASSET_TYPE_SITELINK`." + } + }, + "type": "object" + }, + "YoutubeAssetAssociationLocationAssetFilter": { + "description": "An asset filter that matches eligible location assets for serving.", + "id": "YoutubeAssetAssociationLocationAssetFilter", + "properties": { + "assetSetId": { + "description": "Output only. The ID of the asset set that matches the location assets eligible for serving.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "locationMatchingFunction": { + "$ref": "YoutubeAssetAssociationLocationAssetFilterLocationMatchingFunction", + "description": "Optional. The matching function that determines how the location asset filter matches location assets. This field is required and can only be set for if location_matching_type is `FILTER` or `SELECTED_ASSETS`." + }, + "locationMatchingType": { + "description": "Required. The matching type of this location asset filter.", + "enum": [ + "LOCATION_MATCHING_TYPE_UNSPECIFIED", + "SELECT_ALL", + "FILTER", + "SELECTED_ASSETS", + "DISABLED" + ], + "enumDescriptions": [ + "Location matching type is not specified or is unknown in this version.", + "All available location assets are eligible for serving.", + "The location assets that match a provided business name and/or label filters can serve.", + "Only the selected location assets can serve.", + "No location assets can serve." + ], + "type": "string" + } + }, + "type": "object" + }, + "YoutubeAssetAssociationLocationAssetFilterLocationMatchingFunction": { + "description": "The matching function for a location asset filter.", + "id": "YoutubeAssetAssociationLocationAssetFilterLocationMatchingFunction", + "properties": { + "business": { + "description": "Optional. The business name to match with. This field is optional and can only be set if location_matching_type is `FILTER`.", + "type": "string" + }, + "labels": { + "description": "Optional. The labels to match with. Labels are logically OR'ed together. This field is optional and can only be set if location_matching_type is `FILTER`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "locationAssetIds": { + "description": "Optional. The selected location asset IDs. This field is required if location_matching_type is `SELECTED_ASSETS`.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "YoutubeAssetAssociationSitelinkAsset": { + "description": "A sitelink asset.", + "id": "YoutubeAssetAssociationSitelinkAsset", + "properties": { + "assetId": { + "description": "Required. ID of the sitelink asset.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "YoutubeChannelAssignedTargetingOptionDetails": { "description": "Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.", "id": "YoutubeChannelAssignedTargetingOptionDetails", @@ -23116,6 +24660,17 @@ }, "type": "object" }, + "YoutubeVideoAsset": { + "description": "Data for a YouTube video ad asset.", + "id": "YoutubeVideoAsset", + "properties": { + "youtubeVideoId": { + "description": "Required. The YouTube video id of the asset. This is the 11 char string value used in the YouTube video URL.", + "type": "string" + } + }, + "type": "object" + }, "YoutubeVideoAssignedTargetingOptionDetails": { "description": "Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.", "id": "YoutubeVideoAssignedTargetingOptionDetails", diff --git a/discovery/dlp-v2.json b/discovery/dlp-v2.json index 6820f707ef..49a611466b 100644 --- a/discovery/dlp-v2.json +++ b/discovery/dlp-v2.json @@ -5123,7 +5123,7 @@ } } }, - "revision": "20251012", + "revision": "20251019", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { @@ -7032,8 +7032,7 @@ "id": "GooglePrivacyDlpV2DataSourceType", "properties": { "dataSource": { - "description": "Output only. An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket", - "readOnly": true, + "description": "An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket", "type": "string" } }, @@ -13039,11 +13038,11 @@ "type": "object" }, "GooglePrivacyDlpV2VertexDatasetResourceReference": { - "description": "Identifies a single Vertex AI dataset.", + "description": "Identifies a single Vertex AI resource. Currently only datasets are supported.", "id": "GooglePrivacyDlpV2VertexDatasetResourceReference", "properties": { "datasetResourceName": { - "description": "Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project.", + "description": "Required. The name of the Vertex AI resource. If set within a project-level configuration, the specified resource must be within the project. Examples: * `projects/{project}/locations/{location}/datasets/{dataset}`", "type": "string" } }, diff --git a/discovery/docs-v1.json b/discovery/docs-v1.json index 1eef13812e..4593144a5f 100644 --- a/discovery/docs-v1.json +++ b/discovery/docs-v1.json @@ -221,7 +221,7 @@ } } }, - "revision": "20251013", + "revision": "20251022", "rootUrl": "https://docs.googleapis.com/", "schemas": { "AutoText": { @@ -952,11 +952,11 @@ "description": "The background of the document. Documents cannot have a transparent background color." }, "defaultFooterId": { - "description": "The ID of the default footer. If not set, there's no default footer. This property is read-only.", + "description": "The ID of the default footer. If not set, there's no default footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.", "type": "string" }, "defaultHeaderId": { - "description": "The ID of the default header. If not set, there's no default header. This property is read-only.", + "description": "The ID of the default header. If not set, there's no default header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.", "type": "string" }, "documentFormat": { @@ -964,68 +964,68 @@ "description": "Specifies document-level format settings, such as the document mode (pages vs pageless)." }, "evenPageFooterId": { - "description": "The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only.", + "description": "The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.", "type": "string" }, "evenPageHeaderId": { - "description": "The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only.", + "description": "The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.", "type": "string" }, "firstPageFooterId": { - "description": "The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only.", + "description": "The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.", "type": "string" }, "firstPageHeaderId": { - "description": "The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only.", + "description": "The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.", "type": "string" }, "flipPageOrientation": { - "description": "Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape.", + "description": "Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. If DocumentMode is PAGELESS, this property will not be rendered.", "type": "boolean" }, "marginBottom": { "$ref": "Dimension", - "description": "The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles." + "description": "The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered." }, "marginFooter": { "$ref": "Dimension", - "description": "The amount of space between the bottom of the page and the contents of the footer." + "description": "The amount of space between the bottom of the page and the contents of the footer. If DocumentMode is PAGELESS, this property will not be rendered." }, "marginHeader": { "$ref": "Dimension", - "description": "The amount of space between the top of the page and the contents of the header." + "description": "The amount of space between the top of the page and the contents of the header. If DocumentMode is PAGELESS, this property will not be rendered." }, "marginLeft": { "$ref": "Dimension", - "description": "The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections." + "description": "The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered." }, "marginRight": { "$ref": "Dimension", - "description": "The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections." + "description": "The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered." }, "marginTop": { "$ref": "Dimension", - "description": "The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles." + "description": "The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered." }, "pageNumberStart": { - "description": "The page number from which to start counting the number of pages.", + "description": "The page number from which to start counting the number of pages. If DocumentMode is PAGELESS, this property will not be rendered.", "format": "int32", "type": "integer" }, "pageSize": { "$ref": "Size", - "description": "The size of a page in the document." + "description": "The size of a page in the document. If DocumentMode is PAGELESS, this property will not be rendered." }, "useCustomHeaderFooterMargins": { - "description": "Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. This property is read-only.", + "description": "Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.", "type": "boolean" }, "useEvenPageHeaderFooter": { - "description": "Indicates whether to use the even page header / footer IDs for the even pages.", + "description": "Indicates whether to use the even page header / footer IDs for the even pages. If DocumentMode is PAGELESS, this property will not be rendered.", "type": "boolean" }, "useFirstPageHeaderFooter": { - "description": "Indicates whether to use the first page header / footer IDs for the first page.", + "description": "Indicates whether to use the first page header / footer IDs for the first page. If DocumentMode is PAGELESS, this property will not be rendered.", "type": "boolean" } }, @@ -1784,11 +1784,11 @@ "properties": { "endOfSegmentLocation": { "$ref": "EndOfSegmentLocation", - "description": "Inserts the person at the end of a header, footer, footnote or the document body." + "description": "Inserts the person mention at the end of a header, footer, footnote or the document body." }, "location": { "$ref": "Location", - "description": "Inserts the person at a specific index in the document. The person mention must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). People cannot be inserted inside an equation." + "description": "Inserts the person mention at a specific index in the document. The person mention must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). People cannot be inserted inside an equation." }, "personProperties": { "$ref": "PersonProperties", @@ -3399,59 +3399,59 @@ "type": "string" }, "defaultFooterId": { - "description": "The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only.", + "description": "The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.", "type": "string" }, "defaultHeaderId": { - "description": "The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only.", + "description": "The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.", "type": "string" }, "evenPageFooterId": { - "description": "The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only.", + "description": "The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.", "type": "string" }, "evenPageHeaderId": { - "description": "The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only.", + "description": "The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.", "type": "string" }, "firstPageFooterId": { - "description": "The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only.", + "description": "The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.", "type": "string" }, "firstPageHeaderId": { - "description": "The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only.", + "description": "The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.", "type": "string" }, "flipPageOrientation": { - "description": "Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.", + "description": "Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.", "type": "boolean" }, "marginBottom": { "$ref": "Dimension", - "description": "The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error." + "description": "The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error." }, "marginFooter": { "$ref": "Dimension", - "description": "The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error." + "description": "The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error." }, "marginHeader": { "$ref": "Dimension", - "description": "The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error." + "description": "The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error." }, "marginLeft": { "$ref": "Dimension", - "description": "The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error." + "description": "The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error." }, "marginRight": { "$ref": "Dimension", - "description": "The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error." + "description": "The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error." }, "marginTop": { "$ref": "Dimension", - "description": "The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error." + "description": "The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error." }, "pageNumberStart": { - "description": "The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.", + "description": "The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.", "format": "int32", "type": "integer" }, @@ -3470,7 +3470,7 @@ "type": "string" }, "useFirstPageHeaderFooter": { - "description": "Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.", + "description": "Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.", "type": "boolean" } }, diff --git a/discovery/documentai-v1.json b/discovery/documentai-v1.json index 606239ece7..e4e5e707a0 100644 --- a/discovery/documentai-v1.json +++ b/discovery/documentai-v1.json @@ -1018,6 +1018,345 @@ } } } + }, + "schemas": { + "methods": { + "create": { + "description": "Creates a schema.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas", + "httpMethod": "POST", + "id": "documentai.projects.locations.schemas.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent (project and location) under which to create the Schema. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/schemas", + "request": { + "$ref": "GoogleCloudDocumentaiV1NextSchema" + }, + "response": { + "$ref": "GoogleCloudDocumentaiV1NextSchema" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a schema.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}", + "httpMethod": "DELETE", + "id": "documentai.projects.locations.schemas.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "Optional. If set to true, any child resources of this Schema will also be deleted. (Otherwise, the request will only work if the Schema has no child resources.)", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the Schema to be deleted. Format: `projects/{project}/locations/{location}/schemas/{schema}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a schema.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}", + "httpMethod": "GET", + "id": "documentai.projects.locations.schemas.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Schema to get. Format: `projects/{project}/locations/{location}/schemas/{schema}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudDocumentaiV1NextSchema" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Schemas.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas", + "httpMethod": "GET", + "id": "documentai.projects.locations.schemas.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of schema groups to return. If unspecified, at most `10` Schema will be returned. The maximum value is `20`. Values above `20` will be coerced to `20`.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. We will return the schema groups sorted by creation time. The page token will point to the next Schema.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/schemas", + "response": { + "$ref": "GoogleCloudDocumentaiV1ListSchemasResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a schema. Editable fields are: - `display_name` - `labels`", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}", + "httpMethod": "PATCH", + "id": "documentai.projects.locations.schemas.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name. - labels.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudDocumentaiV1NextSchema" + }, + "response": { + "$ref": "GoogleCloudDocumentaiV1NextSchema" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "schemaVersions": { + "methods": { + "create": { + "description": "Creates a schema version.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions", + "httpMethod": "POST", + "id": "documentai.projects.locations.schemas.schemaVersions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent (project and location) under which to create the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/schemaVersions", + "request": { + "$ref": "GoogleCloudDocumentaiV1SchemaVersion" + }, + "response": { + "$ref": "GoogleCloudDocumentaiV1SchemaVersion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a schema version.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions/{schemaVersionsId}", + "httpMethod": "DELETE", + "id": "documentai.projects.locations.schemas.schemaVersions.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the SchemaVersion to delete. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+/schemaVersions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "generate": { + "description": "Generates a schema version.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions:generate", + "httpMethod": "POST", + "id": "documentai.projects.locations.schemas.schemaVersions.generate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent (project, location and schema) under which to generate the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/schemaVersions:generate", + "request": { + "$ref": "GoogleCloudDocumentaiV1GenerateSchemaVersionRequest" + }, + "response": { + "$ref": "GoogleCloudDocumentaiV1GenerateSchemaVersionResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a schema version.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions/{schemaVersionsId}", + "httpMethod": "GET", + "id": "documentai.projects.locations.schemas.schemaVersions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the SchemaVersion to get. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+/schemaVersions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudDocumentaiV1SchemaVersion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists SchemaVersions.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions", + "httpMethod": "GET", + "id": "documentai.projects.locations.schemas.schemaVersions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of SchemaVersion to return. If unspecified, at most `10` SchemaVersion will be returned. The maximum value is `20`. Values above `20` will be coerced to `20`.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. We will return the SchemaVersion sorted by creation time. The page token will point to the next SchemaVersion.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Format: `projects/{project}/locations/{location}/schemas/{schema}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/schemaVersions", + "response": { + "$ref": "GoogleCloudDocumentaiV1ListSchemaVersionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a schema version. Editable fields are: - `display_name` - `labels`", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions/{schemaVersionsId}", + "httpMethod": "PATCH", + "id": "documentai.projects.locations.schemas.schemaVersions.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+/schemaVersions/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name. - labels.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudDocumentaiV1SchemaVersion" + }, + "response": { + "$ref": "GoogleCloudDocumentaiV1SchemaVersion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } } } }, @@ -1053,7 +1392,7 @@ } } }, - "revision": "20251013", + "revision": "20251020", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "CloudAiDocumentaiLabHifiaToolsValidationValidatorInput": { @@ -1678,15 +2017,178 @@ }, "type": "object" }, - "GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata": { - "description": "The long-running operation metadata for the EnableProcessor method.", - "id": "GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata", + "GoogleCloudDocumentaiUiv1beta3DocumentSchema": { + "description": "The schema defines the output of the processed document by a processor.", + "id": "GoogleCloudDocumentaiUiv1beta3DocumentSchema", "properties": { - "commonMetadata": { - "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long-running operation." - } - }, + "description": { + "description": "Description of the schema.", + "type": "string" + }, + "displayName": { + "description": "Display name to show to users.", + "type": "string" + }, + "entityTypes": { + "description": "Entity types of the schema.", + "items": { + "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType" + }, + "type": "array" + }, + "metadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata", + "description": "Metadata of the schema." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType": { + "description": "EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.", + "id": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType", + "properties": { + "baseTypes": { + "description": "The entity type that this type is derived from. For now, one and only one should be set.", + "items": { + "type": "string" + }, + "type": "array" + }, + "description": { + "description": "The description of the entity type. Could be used to provide more information about the entity type for model calls.", + "type": "string" + }, + "displayName": { + "description": "User defined name for the type.", + "type": "string" + }, + "entityTypeMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata", + "description": "Metadata for the entity type." + }, + "enumValues": { + "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues", + "description": "If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file." + }, + "name": { + "description": "Name of the type. It must be unique within the schema file and cannot be a \"Common Type\". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.", + "type": "string" + }, + "properties": { + "description": "Description the nested structure, or composition of an entity.", + "items": { + "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues": { + "description": "Defines the a list of enum values.", + "id": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues", + "properties": { + "values": { + "description": "The individual values that this enum values type can include.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty": { + "description": "Defines properties that can be part of the entity type.", + "id": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty", + "properties": { + "description": { + "description": "The description of the property. Could be used to provide more information about the property for model calls.", + "type": "string" + }, + "displayName": { + "description": "User defined name for the property.", + "type": "string" + }, + "method": { + "description": "Specifies how the entity's value is obtained.", + "enum": [ + "METHOD_UNSPECIFIED", + "EXTRACT", + "DERIVE" + ], + "enumDescriptions": [ + "Unspecified method. It defaults to `EXTRACT`.", + "The entity's value is directly extracted as-is from the document text.", + "The entity's value is derived through inference and is not necessarily an exact text extraction from the document." + ], + "type": "string" + }, + "name": { + "description": "The name of the property. Follows the same guidelines as the EntityType name.", + "type": "string" + }, + "occurrenceType": { + "description": "Occurrence type limits the number of instances an entity type appears in the document.", + "enum": [ + "OCCURRENCE_TYPE_UNSPECIFIED", + "OPTIONAL_ONCE", + "OPTIONAL_MULTIPLE", + "REQUIRED_ONCE", + "REQUIRED_MULTIPLE" + ], + "enumDescriptions": [ + "Unspecified occurrence type.", + "There will be zero or one instance of this entity type. The same entity instance may be mentioned multiple times.", + "The entity type will appear zero or multiple times.", + "The entity type will only appear exactly once. The same entity instance may be mentioned multiple times.", + "The entity type will appear once or more times." + ], + "type": "string" + }, + "propertyMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3PropertyMetadata", + "description": "Any additional metadata about the property can be added here." + }, + "valueType": { + "description": "A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata": { + "description": "Metadata for global schema behavior.", + "id": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata", + "properties": { + "documentAllowMultipleLabels": { + "description": "If true, on a given page, there can be multiple `document` annotations covering it.", + "type": "boolean" + }, + "documentSplitter": { + "description": "If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).", + "type": "boolean" + }, + "prefixedNamingOnProperties": { + "description": "If set, all the nested entities must be prefixed with the parents.", + "type": "boolean" + }, + "skipNamingValidation": { + "description": "If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata": { + "description": "The long-running operation metadata for the EnableProcessor method.", + "id": "GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata", + "properties": { + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", + "description": "The basic metadata of the long-running operation." + } + }, "type": "object" }, "GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse": { @@ -1695,6 +2197,37 @@ "properties": {}, "type": "object" }, + "GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata": { + "description": "Metadata about an entity type.", + "id": "GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata", + "properties": { + "fieldTierMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3FieldTierMetadata", + "description": "Field tier metadata on the property" + }, + "humanReviewLabelingMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata", + "description": "Human review labeling config on the entity." + }, + "humanReviewMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata", + "description": "Human review config on the entity." + }, + "inactive": { + "description": "Whether the entity type should be considered inactive.", + "type": "boolean" + }, + "schemaEditabilityMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata", + "description": "Schema editability metadata on the entity." + }, + "schemaInferenceMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata", + "description": "Schema inference metadata on the entity." + } + }, + "type": "object" + }, "GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata": { "description": "Metadata of the EvaluateProcessorVersion method.", "id": "GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata", @@ -1717,6 +2250,91 @@ }, "type": "object" }, + "GoogleCloudDocumentaiUiv1beta3EvaluationMetrics": { + "description": "Evaluation metrics, either in aggregate or about a specific entity.", + "id": "GoogleCloudDocumentaiUiv1beta3EvaluationMetrics", + "properties": { + "f1Score": { + "description": "The calculated f1 score.", + "format": "float", + "type": "number" + }, + "falseNegativesCount": { + "description": "The amount of false negatives.", + "format": "int32", + "type": "integer" + }, + "falsePositivesCount": { + "description": "The amount of false positives.", + "format": "int32", + "type": "integer" + }, + "groundTruthDocumentCount": { + "description": "The amount of documents with a ground truth occurrence.", + "format": "int32", + "type": "integer" + }, + "groundTruthOccurrencesCount": { + "description": "The amount of occurrences in ground truth documents.", + "format": "int32", + "type": "integer" + }, + "precision": { + "description": "The calculated precision.", + "format": "float", + "type": "number" + }, + "predictedDocumentCount": { + "description": "The amount of documents with a predicted occurrence.", + "format": "int32", + "type": "integer" + }, + "predictedOccurrencesCount": { + "description": "The amount of occurrences in predicted documents.", + "format": "int32", + "type": "integer" + }, + "recall": { + "description": "The calculated recall.", + "format": "float", + "type": "number" + }, + "totalDocumentsCount": { + "description": "The amount of documents that had an occurrence of this label.", + "format": "int32", + "type": "integer" + }, + "truePositivesCount": { + "description": "The amount of true positives.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3EvaluationReference": { + "description": "Gives a short summary of an evaluation, and links to the evaluation itself.", + "id": "GoogleCloudDocumentaiUiv1beta3EvaluationReference", + "properties": { + "aggregateMetrics": { + "$ref": "GoogleCloudDocumentaiUiv1beta3EvaluationMetrics", + "description": "An aggregate of the statistics for the evaluation with fuzzy matching on." + }, + "aggregateMetricsExact": { + "$ref": "GoogleCloudDocumentaiUiv1beta3EvaluationMetrics", + "description": "An aggregate of the statistics for the evaluation with fuzzy matching off." + }, + "evaluation": { + "description": "The resource name of the evaluation.", + "type": "string" + }, + "operation": { + "description": "The resource name of the Long Running Operation for the evaluation.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata": { "description": "Metadata of the batch export documents operation.", "id": "GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata", @@ -1817,26 +2435,91 @@ }, "type": "object" }, - "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata": { - "description": "Metadata of the import document operation.", - "id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata", + "GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata": { + "description": "Metadata for how this field value is extracted.", + "id": "GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata", "properties": { - "commonMetadata": { - "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long-running operation." - }, - "importConfigValidationResults": { - "description": "Validation statuses of the batch documents import config.", - "items": { - "$ref": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult" - }, - "type": "array" + "entityQuery": { + "$ref": "GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery", + "description": "Entity query config." }, - "individualImportStatuses": { - "description": "The list of response details of each document.", - "items": { - "$ref": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus" - }, + "summaryOptions": { + "$ref": "GoogleCloudDocumentaiUiv1beta3SummaryOptions", + "description": "Summary options config." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery": { + "description": "Message for entity query.", + "id": "GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery", + "properties": { + "userEntityQuery": { + "description": "The original entity query inputed by the user.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3FieldTierMetadata": { + "description": "Metadata for the field tier of a property.", + "id": "GoogleCloudDocumentaiUiv1beta3FieldTierMetadata", + "properties": { + "tierLevel": { + "description": "Integer that indicates the tier of a property. e.g. Invoice has entities that are classified as tier 1 which is the most important, while tier 2 and tier 3 less so. This attribute can be used to filter schema attributes before running eval. e.g. compute F1 score for only tier 1 entities. If not present this attribute should be inferred as 1.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata": { + "description": "Metadata for human review labeling config.", + "id": "GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata", + "properties": { + "enableNormalizationEditing": { + "description": "Whether to enable normalization editing.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata": { + "description": "Metadata for Human Review config.", + "id": "GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata", + "properties": { + "confidenceThreshold": { + "description": "The confidence threshold if human review validation is enabled.", + "format": "float", + "type": "number" + }, + "enableValidation": { + "description": "Whether to enable human review validation.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata": { + "description": "Metadata of the import document operation.", + "id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata", + "properties": { + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", + "description": "The basic metadata of the long-running operation." + }, + "importConfigValidationResults": { + "description": "Validation statuses of the batch documents import config.", + "items": { + "$ref": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult" + }, + "type": "array" + }, + "individualImportStatuses": { + "description": "The list of response details of each document.", + "items": { + "$ref": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus" + }, "type": "array" }, "totalDocumentCount": { @@ -1913,1606 +2596,1737 @@ }, "type": "object" }, - "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata": { - "description": "The metadata proto of `ResyncDataset` method.", - "id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata", + "GoogleCloudDocumentaiUiv1beta3Processor": { + "description": "The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.", + "id": "GoogleCloudDocumentaiUiv1beta3Processor", "properties": { - "commonMetadata": { - "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long-running operation." + "activeSchemaVersion": { + "description": "Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}", + "type": "string" }, - "datasetResyncStatuses": { - "description": "The list of dataset resync statuses. Not checked when ResyncDatasetRequest.dataset_documents is specified.", - "items": { - "$ref": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus" - }, - "type": "array" + "createTime": { + "description": "Output only. The time the processor was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "individualDocumentResyncStatuses": { - "description": "The list of document resync statuses. The same document could have multiple `individual_document_resync_statuses` if it has multiple inconsistencies.", + "defaultProcessorVersion": { + "description": "The default processor version.", + "type": "string" + }, + "displayName": { + "description": "The display name of the processor.", + "type": "string" + }, + "kmsKeyName": { + "description": "The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios.", + "type": "string" + }, + "name": { + "description": "Output only. Immutable. The resource name of the processor. Format: `projects/{project}/locations/{location}/processors/{processor}`", + "readOnly": true, + "type": "string" + }, + "processEndpoint": { + "description": "Output only. Immutable. The http endpoint that can be called to invoke processing.", + "readOnly": true, + "type": "string" + }, + "processorVersionAliases": { + "description": "Output only. The processor version aliases.", "items": { - "$ref": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus" + "$ref": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias" }, + "readOnly": true, "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus": { - "description": "Resync status against inconsistency types on the dataset level.", - "id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus", - "properties": { - "datasetInconsistencyType": { - "description": "The type of the inconsistency of the dataset.", + }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "state": { + "description": "Output only. The state of the processor.", "enum": [ - "DATASET_INCONSISTENCY_TYPE_UNSPECIFIED", - "DATASET_INCONSISTENCY_TYPE_NO_STORAGE_MARKER" + "STATE_UNSPECIFIED", + "ENABLED", + "DISABLED", + "ENABLING", + "DISABLING", + "CREATING", + "FAILED", + "DELETING" ], "enumDescriptions": [ - "Default value.", - "The marker file under the dataset folder is not found." + "The processor is in an unspecified state.", + "The processor is enabled, i.e., has an enabled version which can currently serve processing requests and all the feature dependencies have been successfully initialized.", + "The processor is disabled.", + "The processor is being enabled, will become `ENABLED` if successful.", + "The processor is being disabled, will become `DISABLED` if successful.", + "The processor is being created, will become either `ENABLED` (for successful creation) or `FAILED` (for failed ones). Once a processor is in this state, it can then be used for document processing, but the feature dependencies of the processor might not be fully created yet.", + "The processor failed during creation or initialization of feature dependencies. The user should delete the processor and recreate one as all the functionalities of the processor are disabled.", + "The processor is being deleted, will be removed if successful." ], + "readOnly": true, "type": "string" }, - "status": { - "$ref": "GoogleRpcStatus", - "description": "The status of resyncing the dataset with regards to the detected inconsistency. Empty if ResyncDatasetRequest.validate_only is `true`." + "type": { + "description": "The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor types, see FetchProcessorTypes.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus": { - "description": "Resync status for each document per inconsistency type.", - "id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus", + "GoogleCloudDocumentaiUiv1beta3ProcessorVersion": { + "description": "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.", + "id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersion", "properties": { - "documentId": { - "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentId", - "description": "The document identifier." + "createTime": { + "description": "Output only. The time the processor version was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "documentInconsistencyType": { - "description": "The type of document inconsistency.", - "enum": [ - "DOCUMENT_INCONSISTENCY_TYPE_UNSPECIFIED", - "DOCUMENT_INCONSISTENCY_TYPE_INVALID_DOCPROTO", - "DOCUMENT_INCONSISTENCY_TYPE_MISMATCHED_METADATA", - "DOCUMENT_INCONSISTENCY_TYPE_NO_PAGE_IMAGE" - ], - "enumDescriptions": [ - "Default value.", - "The document proto is invalid.", - "Indexed docproto metadata is mismatched.", - "The page image or thumbnails are missing." - ], + "deploymentAllowed": { + "description": "Output only. Denotes that this `ProcessorVersion` can be deployed and undeployed.", + "readOnly": true, + "type": "boolean" + }, + "deprecationInfo": { + "$ref": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo", + "description": "Output only. If set, information about the eventual deprecation of this version.", + "readOnly": true + }, + "displayName": { + "description": "The display name of the processor version.", "type": "string" }, - "status": { - "$ref": "GoogleRpcStatus", - "description": "The status of resyncing the document with regards to the detected inconsistency. Empty if ResyncDatasetRequest.validate_only is `true`." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse": { - "description": "The response proto of ResyncDataset method.", - "id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse", - "properties": {}, - "type": "object" - }, - "GoogleCloudDocumentaiUiv1beta3RevisionRef": { - "description": "The revision reference specifies which revision on the document to read.", - "id": "GoogleCloudDocumentaiUiv1beta3RevisionRef", - "properties": { - "latestProcessorVersion": { - "description": "Reads the revision generated by the processor version. The format takes the full resource name of processor version. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`", + "documentSchema": { + "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentSchema", + "description": "Output only. The schema of the processor version. Describes the output.", + "readOnly": true + }, + "genAiModelInfo": { + "$ref": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo", + "description": "Output only. Information about Generative AI model-based processor versions.", + "readOnly": true + }, + "googleManaged": { + "description": "Output only. Denotes that this `ProcessorVersion` is managed by Google.", + "readOnly": true, + "type": "boolean" + }, + "kmsKeyName": { + "description": "Output only. The KMS key name used for encryption.", + "readOnly": true, "type": "string" }, - "revisionCase": { - "description": "Reads the revision by the predefined case.", + "kmsKeyVersionName": { + "description": "Output only. The KMS key version with which data is encrypted.", + "readOnly": true, + "type": "string" + }, + "latestEvaluation": { + "$ref": "GoogleCloudDocumentaiUiv1beta3EvaluationReference", + "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.", "enum": [ - "REVISION_CASE_UNSPECIFIED", - "LATEST_HUMAN_REVIEW", - "LATEST_TIMESTAMP", - "BASE_OCR_REVISION" + "MODEL_TYPE_UNSPECIFIED", + "MODEL_TYPE_GENERATIVE", + "MODEL_TYPE_CUSTOM" ], "enumDescriptions": [ - "Unspecified case, fall back to read the `LATEST_HUMAN_REVIEW`.", - "The latest revision made by a human.", - "The latest revision based on timestamp.", - "The first (OCR) revision." + "The processor version has unspecified model type.", + "The processor version has generative model type.", + "The processor version has custom model type." ], + "readOnly": true, "type": "string" }, - "revisionId": { - "description": "Reads the revision given by the id.", + "name": { + "description": "Identifier. The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`", + "type": "string" + }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "schema": { + "$ref": "GoogleCloudDocumentaiUiv1beta3Schema", + "description": "The schema of the processor version. Describes the output." + }, + "state": { + "description": "Output only. The state of the processor version.", + "enum": [ + "STATE_UNSPECIFIED", + "DEPLOYED", + "DEPLOYING", + "UNDEPLOYED", + "UNDEPLOYING", + "CREATING", + "DELETING", + "FAILED", + "IMPORTING" + ], + "enumDescriptions": [ + "The processor version is in an unspecified state.", + "The processor version is deployed and can be used for processing.", + "The processor version is being deployed.", + "The processor version is not deployed and cannot be used for processing.", + "The processor version is being undeployed.", + "The processor version is being created.", + "The processor version is being deleted.", + "The processor version failed and is in an indeterminate state.", + "The processor version is being imported." + ], + "readOnly": true, "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata": { - "description": "Metadata of the sample documents operation.", - "id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata", - "properties": { - "commonMetadata": { - "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long-running operation." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse": { - "description": "Response of the sample documents operation.", - "id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse", + "GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias": { + "description": "Contains the alias and the aliased resource name of processor version.", + "id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias", "properties": { - "sampleTestStatus": { - "$ref": "GoogleRpcStatus", - "description": "The status of sampling documents in test split." - }, - "sampleTrainingStatus": { - "$ref": "GoogleRpcStatus", - "description": "The status of sampling documents in training split." + "alias": { + "description": "The alias in the form of `processor_version` resource name.", + "type": "string" }, - "selectedDocuments": { - "description": "The result of the sampling process.", - "items": { - "$ref": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument" - }, - "type": "array" + "processorVersion": { + "description": "The resource name of aliased processor version.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument": { - "id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument", + "GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo": { + "description": "Information about the upcoming deprecation of this processor version.", + "id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo", "properties": { - "documentId": { - "description": "An internal identifier for document.", + "deprecationTime": { + "description": "The time at which this processor version will be deprecated.", + "format": "google-datetime", + "type": "string" + }, + "replacementProcessorVersion": { + "description": "If set, the processor version that will be used as a replacement.", "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata": { - "description": "The long-running operation metadata for the SetDefaultProcessorVersion method.", - "id": "GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata", + "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo": { + "description": "Information about Generative AI model-based processor versions.", + "id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo", "properties": { - "commonMetadata": { - "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long-running operation." + "customGenAiModelInfo": { + "$ref": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo", + "description": "Information for a custom Generative AI model created by the user." + }, + "foundationGenAiModelInfo": { + "$ref": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo", + "description": "Information for a pretrained Google-managed foundation model." } }, "type": "object" }, - "GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse": { - "description": "Response message for the SetDefaultProcessorVersion method.", - "id": "GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse", - "properties": {}, - "type": "object" - }, - "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata": { - "description": "The metadata that represents a processor version being created.", - "id": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata", + "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo": { + "description": "Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs.", + "id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo", "properties": { - "commonMetadata": { - "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long-running operation." - }, - "testDatasetValidation": { - "$ref": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation", - "description": "The test dataset validation information." + "baseProcessorVersionId": { + "description": "The base processor version ID for the custom model.", + "type": "string" }, - "trainingDatasetValidation": { - "$ref": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation", - "description": "The training dataset validation information." + "customModelType": { + "description": "The type of custom model created by the user.", + "enum": [ + "CUSTOM_MODEL_TYPE_UNSPECIFIED", + "VERSIONED_FOUNDATION", + "FINE_TUNED" + ], + "enumDescriptions": [ + "The model type is unspecified.", + "The model is a versioned foundation model.", + "The model is a finetuned foundation model." + ], + "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation": { - "description": "The dataset validation information. This includes any and all errors with documents and the dataset.", - "id": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation", + "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo": { + "description": "Information for a pretrained Google-managed foundation model.", + "id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo", "properties": { - "datasetErrorCount": { - "description": "The total number of dataset errors.", - "format": "int32", - "type": "integer" - }, - "datasetErrors": { - "description": "Error information for the dataset as a whole. A maximum of 10 dataset errors will be returned. A single dataset error is terminal for training.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" + "finetuningAllowed": { + "description": "Whether finetuning is allowed for this base processor version.", + "type": "boolean" }, - "documentErrorCount": { - "description": "The total number of document errors.", + "minTrainLabeledDocuments": { + "description": "The minimum number of labeled documents in the training dataset required for finetuning.", "format": "int32", "type": "integer" - }, - "documentErrors": { - "description": "Error information pertaining to specific documents. A maximum of 10 document errors will be returned. Any document with errors will not be used throughout training.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" } }, "type": "object" }, - "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse": { - "description": "The response for TrainProcessorVersion.", - "id": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse", + "GoogleCloudDocumentaiUiv1beta3PropertyMetadata": { + "description": "Metadata about a property.", + "id": "GoogleCloudDocumentaiUiv1beta3PropertyMetadata", "properties": { - "processorVersion": { - "description": "The resource name of the processor version produced by training.", - "type": "string" + "fieldExtractionMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata", + "description": "Field extraction metadata on the property." + }, + "fieldTierMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3FieldTierMetadata", + "description": "Field tier metadata on the property" + }, + "humanReviewLabelingMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata", + "description": "Human review labeling config on the property." + }, + "humanReviewMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata", + "description": "Human review validation config on the property." + }, + "inactive": { + "description": "Whether the property should be considered as \"inactive\".", + "type": "boolean" + }, + "schemaEditabilityMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata", + "description": "Schema editability metadata on the property." + }, + "schemaInferenceMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata", + "description": "Schema inference metadata on the property." } }, "type": "object" }, - "GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata": { - "description": "The long-running operation metadata for the UndeployProcessorVersion method.", - "id": "GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata", + "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata": { + "description": "The metadata proto of `ResyncDataset` method.", + "id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", "description": "The basic metadata of the long-running operation." + }, + "datasetResyncStatuses": { + "description": "The list of dataset resync statuses. Not checked when ResyncDatasetRequest.dataset_documents is specified.", + "items": { + "$ref": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus" + }, + "type": "array" + }, + "individualDocumentResyncStatuses": { + "description": "The list of document resync statuses. The same document could have multiple `individual_document_resync_statuses` if it has multiple inconsistencies.", + "items": { + "$ref": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse": { - "description": "Response message for the UndeployProcessorVersion method.", - "id": "GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse", - "properties": {}, - "type": "object" - }, - "GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata": { - "id": "GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata", + "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus": { + "description": "Resync status against inconsistency types on the dataset level.", + "id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus", "properties": { - "commonMetadata": { - "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long-running operation." + "datasetInconsistencyType": { + "description": "The type of the inconsistency of the dataset.", + "enum": [ + "DATASET_INCONSISTENCY_TYPE_UNSPECIFIED", + "DATASET_INCONSISTENCY_TYPE_NO_STORAGE_MARKER" + ], + "enumDescriptions": [ + "Default value.", + "The marker file under the dataset folder is not found." + ], + "type": "string" + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "The status of resyncing the dataset with regards to the detected inconsistency. Empty if ResyncDatasetRequest.validate_only is `true`." } }, "type": "object" }, - "GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata": { - "description": "The long-running operation metadata for updating the human review configuration.", - "id": "GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata", + "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus": { + "description": "Resync status for each document per inconsistency type.", + "id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus", "properties": { - "commonMetadata": { - "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long-running operation." + "documentId": { + "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentId", + "description": "The document identifier." + }, + "documentInconsistencyType": { + "description": "The type of document inconsistency.", + "enum": [ + "DOCUMENT_INCONSISTENCY_TYPE_UNSPECIFIED", + "DOCUMENT_INCONSISTENCY_TYPE_INVALID_DOCPROTO", + "DOCUMENT_INCONSISTENCY_TYPE_MISMATCHED_METADATA", + "DOCUMENT_INCONSISTENCY_TYPE_NO_PAGE_IMAGE" + ], + "enumDescriptions": [ + "Default value.", + "The document proto is invalid.", + "Indexed docproto metadata is mismatched.", + "The page image or thumbnails are missing." + ], + "type": "string" + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "The status of resyncing the document with regards to the detected inconsistency. Empty if ResyncDatasetRequest.validate_only is `true`." } }, "type": "object" }, - "GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata": { - "description": "The long-running operation metadata for UpdateLabelerPool.", - "id": "GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata", - "properties": { - "commonMetadata": { - "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long-running operation." - } - }, + "GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse": { + "description": "The response proto of ResyncDataset method.", + "id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse", + "properties": {}, "type": "object" }, - "GoogleCloudDocumentaiV1Barcode": { - "description": "Encodes the detailed information of a barcode.", - "id": "GoogleCloudDocumentaiV1Barcode", + "GoogleCloudDocumentaiUiv1beta3RevisionRef": { + "description": "The revision reference specifies which revision on the document to read.", + "id": "GoogleCloudDocumentaiUiv1beta3RevisionRef", "properties": { - "format": { - "description": "Format of a barcode. The supported formats are: - `CODE_128`: Code 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - `DATABAR`: GS1 DataBar code type.", + "latestProcessorVersion": { + "description": "Reads the revision generated by the processor version. The format takes the full resource name of processor version. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`", "type": "string" }, - "rawValue": { - "description": "Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`.", + "revisionCase": { + "description": "Reads the revision by the predefined case.", + "enum": [ + "REVISION_CASE_UNSPECIFIED", + "LATEST_HUMAN_REVIEW", + "LATEST_TIMESTAMP", + "BASE_OCR_REVISION" + ], + "enumDescriptions": [ + "Unspecified case, fall back to read the `LATEST_HUMAN_REVIEW`.", + "The latest revision made by a human.", + "The latest revision based on timestamp.", + "The first (OCR) revision." + ], "type": "string" }, - "valueFormat": { - "description": "Value format describes the format of the value that a barcode encodes. The supported formats are: - `CONTACT_INFO`: Contact information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar event. - `DRIVER_LICENSE`: Driver's license.", + "revisionId": { + "description": "Reads the revision given by the id.", "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1BatchDocumentsInputConfig": { - "description": "The common config to specify a set of documents used as input.", - "id": "GoogleCloudDocumentaiV1BatchDocumentsInputConfig", + "GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata": { + "description": "Metadata of the sample documents operation.", + "id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata", "properties": { - "gcsDocuments": { - "$ref": "GoogleCloudDocumentaiV1GcsDocuments", - "description": "The set of documents individually specified on Cloud Storage." - }, - "gcsPrefix": { - "$ref": "GoogleCloudDocumentaiV1GcsPrefix", - "description": "The set of documents that match the specified Cloud Storage `gcs_prefix`." + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, - "GoogleCloudDocumentaiV1BatchProcessMetadata": { - "description": "The long-running operation metadata for BatchProcessDocuments.", - "id": "GoogleCloudDocumentaiV1BatchProcessMetadata", + "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse": { + "description": "Response of the sample documents operation.", + "id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse", "properties": { - "createTime": { - "description": "The creation time of the operation.", - "format": "google-datetime", - "type": "string" + "sampleTestStatus": { + "$ref": "GoogleRpcStatus", + "description": "The status of sampling documents in test split." }, - "individualProcessStatuses": { - "description": "The list of response details of each document.", + "sampleTrainingStatus": { + "$ref": "GoogleRpcStatus", + "description": "The status of sampling documents in training split." + }, + "selectedDocuments": { + "description": "The result of the sampling process.", "items": { - "$ref": "GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus" + "$ref": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument" }, "type": "array" - }, - "state": { - "description": "The state of the current batch processing.", - "enum": [ - "STATE_UNSPECIFIED", - "WAITING", - "RUNNING", - "SUCCEEDED", - "CANCELLING", - "CANCELLED", - "FAILED" - ], - "enumDescriptions": [ - "The default value. This value is used if the state is omitted.", - "Request operation is waiting for scheduling.", - "Request is being processed.", - "The batch processing completed successfully.", - "The batch processing was being cancelled.", - "The batch processing was cancelled.", - "The batch processing has failed." - ], - "type": "string" - }, - "stateMessage": { - "description": "A message providing more details about the current state of processing. For example, the error message if the operation is failed.", - "type": "string" - }, - "updateTime": { - "description": "The last update time of the operation.", - "format": "google-datetime", - "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus": { - "description": "The status of a each individual document in the batch process.", - "id": "GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus", + "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument": { + "id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument", "properties": { - "humanReviewStatus": { - "$ref": "GoogleCloudDocumentaiV1HumanReviewStatus", - "description": "The status of human review on the processed document." - }, - "inputGcsSource": { - "description": "The source of the document, same as the input_gcs_source field in the request when the batch process started.", - "type": "string" - }, - "outputGcsDestination": { - "description": "The Cloud Storage output destination (in the request as DocumentOutputConfig.GcsOutputConfig.gcs_uri) of the processed document if it was successful, otherwise empty.", + "documentId": { + "description": "An internal identifier for document.", "type": "string" - }, - "status": { - "$ref": "GoogleRpcStatus", - "description": "The status processing the document." } }, "type": "object" }, - "GoogleCloudDocumentaiV1BatchProcessRequest": { - "description": "Request message for BatchProcessDocuments.", - "id": "GoogleCloudDocumentaiV1BatchProcessRequest", + "GoogleCloudDocumentaiUiv1beta3Schema": { + "description": "The schema defines the output of the processed document by a processor.", + "id": "GoogleCloudDocumentaiUiv1beta3Schema", "properties": { - "documentOutputConfig": { - "$ref": "GoogleCloudDocumentaiV1DocumentOutputConfig", - "description": "The output configuration for the BatchProcessDocuments method." + "description": { + "description": "Description of the schema.", + "type": "string" }, - "inputDocuments": { - "$ref": "GoogleCloudDocumentaiV1BatchDocumentsInputConfig", - "description": "The input documents for the BatchProcessDocuments method." + "displayName": { + "description": "Display name to show to users.", + "type": "string" }, - "labels": { - "additionalProperties": { - "type": "string" + "entityTypes": { + "description": "Entity types of the schema.", + "items": { + "$ref": "GoogleCloudDocumentaiUiv1beta3SchemaEntityType" }, - "description": "Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.", - "type": "object" - }, - "processOptions": { - "$ref": "GoogleCloudDocumentaiV1ProcessOptions", - "description": "Inference-time options for the process API" - }, - "skipHumanReview": { - "description": "Whether human review should be skipped for this request. Default to `false`.", - "type": "boolean" + "type": "array" } }, "type": "object" }, - "GoogleCloudDocumentaiV1BatchProcessResponse": { - "description": "Response message for BatchProcessDocuments.", - "id": "GoogleCloudDocumentaiV1BatchProcessResponse", - "properties": {}, - "type": "object" - }, - "GoogleCloudDocumentaiV1BoundingPoly": { - "description": "A bounding polygon for the detected image annotation.", - "id": "GoogleCloudDocumentaiV1BoundingPoly", + "GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata": { + "description": "Metadata that specifies whether a label is editable and reasons why. These fields are read-only. Changing these fields has no impact on the backend.", + "id": "GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata", "properties": { - "normalizedVertices": { - "description": "The bounding polygon normalized vertices.", - "items": { - "$ref": "GoogleCloudDocumentaiV1NormalizedVertex" - }, - "type": "array" + "editable": { + "description": "Explicit flag that controls whether the label is editable.", + "type": "boolean" }, - "vertices": { - "description": "The bounding polygon vertices.", + "processorVersions": { + "description": "Full resource name of processor versions that contain this label. e.g. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`", "items": { - "$ref": "GoogleCloudDocumentaiV1Vertex" + "type": "string" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDocumentaiV1CommonOperationMetadata": { - "description": "The common metadata for long running operations.", - "id": "GoogleCloudDocumentaiV1CommonOperationMetadata", + "GoogleCloudDocumentaiUiv1beta3SchemaEntityType": { + "description": "EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.", + "id": "GoogleCloudDocumentaiUiv1beta3SchemaEntityType", "properties": { - "createTime": { - "description": "The creation time of the operation.", - "format": "google-datetime", + "baseType": { "type": "string" }, - "resource": { - "description": "A related resource to this operation.", + "description": { + "description": "Description of the entity type.", "type": "string" }, - "state": { - "description": "The state of the operation.", + "enumValues": { + "description": "If specified, lists all the possible values for this entity.", + "items": { + "type": "string" + }, + "type": "array" + }, + "hide": { + "description": "If the entity type is hidden in the schema. This provides the functionality to temporally \"disable\" an entity without deleting it.", + "type": "boolean" + }, + "method": { + "description": "Specifies how the entity's value is obtained.", "enum": [ - "STATE_UNSPECIFIED", - "RUNNING", - "CANCELLING", - "SUCCEEDED", - "FAILED", - "CANCELLED" + "METHOD_UNSPECIFIED", + "EXTRACT", + "DERIVE" ], "enumDescriptions": [ - "Unspecified state.", - "Operation is still running.", - "Operation is being cancelled.", - "Operation succeeded.", - "Operation failed.", - "Operation is cancelled." + "Unspecified method. It defaults to `EXTRACT`.", + "The entity's value is directly extracted as-is from the document text.", + "The entity's value is derived through inference and is not necessarily an exact text extraction from the document." ], "type": "string" }, - "stateMessage": { - "description": "A message providing more details about the current state of processing.", + "occurrenceType": { + "description": "Occurrence type limits the number of times an entity type appears in the document.", + "enum": [ + "OCCURRENCE_TYPE_UNSPECIFIED", + "OPTIONAL_ONCE", + "OPTIONAL_MULTIPLE", + "REQUIRED_ONCE", + "REQUIRED_MULTIPLE" + ], + "enumDescriptions": [ + "Unspecified occurrence type.", + "The entity type will appear zero times or once.", + "The entity type will appear zero or multiple times.", + "The entity type will only appear exactly once.", + "The entity type will appear once or more times." + ], "type": "string" }, - "updateTime": { - "description": "The last update time of the operation.", - "format": "google-datetime", + "properties": { + "description": "Describing the nested structure of an entity. An EntityType may consist of several other EntityTypes. For example, in a document there can be an EntityType `ID`, which consists of EntityType `name` and `address`, with corresponding attributes, such as TEXT for both types and ONCE for occurrence types.", + "items": { + "$ref": "GoogleCloudDocumentaiUiv1beta3SchemaEntityType" + }, + "type": "array" + }, + "source": { + "description": "Source of this entity type.", + "enum": [ + "SOURCE_UNSPECIFIED", + "PREDEFINED", + "USER_INPUT" + ], + "enumDescriptions": [ + "Unspecified source.", + "The entity type is in the predefined schema of a pretrained version of a processor.", + "The entity type is added by the users either: - during an uptraining of an existing processor, or - during the process of creating a customized processor." + ], + "type": "string" + }, + "type": { + "description": "Name of the type. It must satisfy the following constraints: 1. Must be unique within the set of same level types (with case-insensitive match). 2. Maximum 64 characters. 3. Must start with a letter. 4. Allowed characters: ASCII letters [a-zA-Z], ASCII digits [0-9], or one of the following punctuation characters: * underscore '_' (recommended) * hyphen '-' (allowed, not recommended) * colon ':' (allowed, not recommended) NOTE: Whitespace characters are not allowed. 5. Cannot end with a punctuation character. 6. Cannot contain the following restricted strings: \"google\", \"DocumentAI\" (case-insensitive match). 7. A slash character '/' is reserved as a separator in flattened representations of nested entity types (e.g., \"line_item/amount\") in which case each part (e.g., \"line_item\", \"amount\") must comply with the rules defined above. We recommend using the snake case (\"snake_case\") in entity type names.", "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1DeleteProcessorMetadata": { - "description": "The long-running operation metadata for the DeleteProcessor method.", - "id": "GoogleCloudDocumentaiV1DeleteProcessorMetadata", + "GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata": { + "description": "Metadata for schema inference. Only used on dataset.schema for schema inference, can be safely ignored elsewhere.", + "id": "GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata", + "properties": { + "inferred": { + "description": "True if is inferred by schema inference.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata": { + "description": "The long-running operation metadata for the SetDefaultProcessorVersion method.", + "id": "GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata", "properties": { "commonMetadata": { - "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", + "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", "description": "The basic metadata of the long-running operation." } }, "type": "object" }, - "GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata": { - "description": "The long-running operation metadata for the DeleteProcessorVersion method.", - "id": "GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata", + "GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse": { + "description": "Response message for the SetDefaultProcessorVersion method.", + "id": "GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3SummaryOptions": { + "description": "Metadata for document summarization.", + "id": "GoogleCloudDocumentaiUiv1beta3SummaryOptions", + "properties": { + "format": { + "description": "The format the summary should be in.", + "enum": [ + "FORMAT_UNSPECIFIED", + "PARAGRAPH", + "BULLETS" + ], + "enumDescriptions": [ + "Default.", + "Format the output in paragraphs.", + "Format the output in bullets." + ], + "type": "string" + }, + "length": { + "description": "How long the summary should be.", + "enum": [ + "LENGTH_UNSPECIFIED", + "BRIEF", + "MODERATE", + "COMPREHENSIVE" + ], + "enumDescriptions": [ + "Default.", + "A brief summary of one or two sentences.", + "A paragraph-length summary.", + "The longest option available." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata": { + "description": "The metadata that represents a processor version being created.", + "id": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata", "properties": { "commonMetadata": { - "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", + "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", "description": "The basic metadata of the long-running operation." + }, + "testDatasetValidation": { + "$ref": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation", + "description": "The test dataset validation information." + }, + "trainingDatasetValidation": { + "$ref": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation", + "description": "The training dataset validation information." } }, "type": "object" }, - "GoogleCloudDocumentaiV1DeployProcessorVersionMetadata": { - "description": "The long-running operation metadata for the DeployProcessorVersion method.", - "id": "GoogleCloudDocumentaiV1DeployProcessorVersionMetadata", + "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation": { + "description": "The dataset validation information. This includes any and all errors with documents and the dataset.", + "id": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation", + "properties": { + "datasetErrorCount": { + "description": "The total number of dataset errors.", + "format": "int32", + "type": "integer" + }, + "datasetErrors": { + "description": "Error information for the dataset as a whole. A maximum of 10 dataset errors will be returned. A single dataset error is terminal for training.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "documentErrorCount": { + "description": "The total number of document errors.", + "format": "int32", + "type": "integer" + }, + "documentErrors": { + "description": "Error information pertaining to specific documents. A maximum of 10 document errors will be returned. Any document with errors will not be used throughout training.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse": { + "description": "The response for TrainProcessorVersion.", + "id": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse", + "properties": { + "processorVersion": { + "description": "The resource name of the processor version produced by training.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata": { + "description": "The long-running operation metadata for the UndeployProcessorVersion method.", + "id": "GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata", "properties": { "commonMetadata": { - "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", + "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", "description": "The basic metadata of the long-running operation." } }, "type": "object" }, - "GoogleCloudDocumentaiV1DeployProcessorVersionRequest": { - "description": "Request message for the DeployProcessorVersion method.", - "id": "GoogleCloudDocumentaiV1DeployProcessorVersionRequest", + "GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse": { + "description": "Response message for the UndeployProcessorVersion method.", + "id": "GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse", "properties": {}, "type": "object" }, - "GoogleCloudDocumentaiV1DeployProcessorVersionResponse": { - "description": "Response message for the DeployProcessorVersion method.", - "id": "GoogleCloudDocumentaiV1DeployProcessorVersionResponse", - "properties": {}, + "GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata": { + "id": "GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata", + "properties": { + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", + "description": "The basic metadata of the long-running operation." + } + }, "type": "object" }, - "GoogleCloudDocumentaiV1DisableProcessorMetadata": { - "description": "The long-running operation metadata for the DisableProcessor method.", - "id": "GoogleCloudDocumentaiV1DisableProcessorMetadata", + "GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata": { + "description": "The long-running operation metadata for updating the human review configuration.", + "id": "GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata", "properties": { "commonMetadata": { - "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", + "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", "description": "The basic metadata of the long-running operation." } }, "type": "object" }, - "GoogleCloudDocumentaiV1DisableProcessorRequest": { - "description": "Request message for the DisableProcessor method.", - "id": "GoogleCloudDocumentaiV1DisableProcessorRequest", - "properties": {}, + "GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata": { + "description": "The long-running operation metadata for UpdateLabelerPool.", + "id": "GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata", + "properties": { + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", + "description": "The basic metadata of the long-running operation." + } + }, "type": "object" }, - "GoogleCloudDocumentaiV1DisableProcessorResponse": { - "description": "Response message for the DisableProcessor method. Intentionally empty proto for adding fields in future.", - "id": "GoogleCloudDocumentaiV1DisableProcessorResponse", - "properties": {}, + "GoogleCloudDocumentaiUiv1beta3UpdateProcessorVersionMetadata": { + "description": "The long-running operation metadata for the UpdateProcessorVersion method.", + "id": "GoogleCloudDocumentaiUiv1beta3UpdateProcessorVersionMetadata", + "properties": { + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", + "description": "The basic metadata for the long-running operation." + } + }, "type": "object" }, - "GoogleCloudDocumentaiV1Document": { - "description": "Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality.", - "id": "GoogleCloudDocumentaiV1Document", + "GoogleCloudDocumentaiV1Barcode": { + "description": "Encodes the detailed information of a barcode.", + "id": "GoogleCloudDocumentaiV1Barcode", "properties": { - "chunkedDocument": { - "$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocument", - "description": "Document chunked based on chunking config." - }, - "content": { - "description": "Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64.", - "format": "byte", + "format": { + "description": "Format of a barcode. The supported formats are: - `CODE_128`: Code 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - `DATABAR`: GS1 DataBar code type.", "type": "string" }, - "docid": { - "description": "Optional. An internal identifier for document. Should be loggable (no PII).", + "rawValue": { + "description": "Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`.", "type": "string" }, - "documentLayout": { - "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayout", - "description": "Parsed layout of the document." - }, - "entities": { - "description": "A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.", - "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentEntity" - }, - "type": "array" - }, - "entitiesRevisionId": { - "description": "The entity revision id that `document.entities` field is based on. If this field is set and `entities_revisions` is not empty, the entities in `document.entities` field are the entities in the entity revision with this id and `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision.", + "valueFormat": { + "description": "Value format describes the format of the value that a barcode encodes. The supported formats are: - `CONTACT_INFO`: Contact information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar event. - `DRIVER_LICENSE`: Driver's license.", "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1BatchDocumentsInputConfig": { + "description": "The common config to specify a set of documents used as input.", + "id": "GoogleCloudDocumentaiV1BatchDocumentsInputConfig", + "properties": { + "gcsDocuments": { + "$ref": "GoogleCloudDocumentaiV1GcsDocuments", + "description": "The set of documents individually specified on Cloud Storage." }, - "entitiesRevisions": { - "description": "A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing.", - "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentEntitiesRevision" - }, - "type": "array" + "gcsPrefix": { + "$ref": "GoogleCloudDocumentaiV1GcsPrefix", + "description": "The set of documents that match the specified Cloud Storage `gcs_prefix`." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1BatchProcessMetadata": { + "description": "The long-running operation metadata for BatchProcessDocuments.", + "id": "GoogleCloudDocumentaiV1BatchProcessMetadata", + "properties": { + "createTime": { + "description": "The creation time of the operation.", + "format": "google-datetime", + "type": "string" }, - "entityRelations": { - "description": "Placeholder. Relationship among Document.entities.", + "individualProcessStatuses": { + "description": "The list of response details of each document.", "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentEntityRelation" + "$ref": "GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus" }, "type": "array" }, - "entityValidationOutput": { - "$ref": "GoogleCloudDocumentaiV1DocumentEntityValidationOutput", - "description": "The entity validation output for the document. This is the validation output for `document.entities` field." - }, - "error": { - "$ref": "GoogleRpcStatus", - "description": "Any error that occurred while processing this document." + "state": { + "description": "The state of the current batch processing.", + "enum": [ + "STATE_UNSPECIFIED", + "WAITING", + "RUNNING", + "SUCCEEDED", + "CANCELLING", + "CANCELLED", + "FAILED" + ], + "enumDescriptions": [ + "The default value. This value is used if the state is omitted.", + "Request operation is waiting for scheduling.", + "Request is being processed.", + "The batch processing completed successfully.", + "The batch processing was being cancelled.", + "The batch processing was cancelled.", + "The batch processing has failed." + ], + "type": "string" }, - "mimeType": { - "description": "An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml).", + "stateMessage": { + "description": "A message providing more details about the current state of processing. For example, the error message if the operation is failed.", "type": "string" }, - "pages": { - "description": "Visual page layout for the Document.", - "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentPage" - }, - "type": "array" - }, - "revisions": { - "description": "Placeholder. Revision history of this document.", - "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentRevision" - }, - "type": "array" - }, - "shardInfo": { - "$ref": "GoogleCloudDocumentaiV1DocumentShardInfo", - "description": "Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified." - }, - "text": { - "description": "Optional. UTF-8 encoded text in reading order from the document.", - "type": "string" - }, - "textChanges": { - "description": "Placeholder. A list of text corrections made to Document.text. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap with each other.", - "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentTextChange" - }, - "type": "array" - }, - "textStyles": { - "deprecated": true, - "description": "Styles for the Document.text.", - "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentStyle" - }, - "type": "array" - }, - "uri": { - "description": "Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. For more information, refer to [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris).", + "updateTime": { + "description": "The last update time of the operation.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentChunkedDocument": { - "description": "Represents the chunks that the document is divided into.", - "id": "GoogleCloudDocumentaiV1DocumentChunkedDocument", + "GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus": { + "description": "The status of a each individual document in the batch process.", + "id": "GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus", "properties": { - "chunks": { - "description": "List of chunks.", - "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk" - }, - "type": "array" + "humanReviewStatus": { + "$ref": "GoogleCloudDocumentaiV1HumanReviewStatus", + "description": "The status of human review on the processed document." + }, + "inputGcsSource": { + "description": "The source of the document, same as the input_gcs_source field in the request when the batch process started.", + "type": "string" + }, + "outputGcsDestination": { + "description": "The Cloud Storage output destination (in the request as DocumentOutputConfig.GcsOutputConfig.gcs_uri) of the processed document if it was successful, otherwise empty.", + "type": "string" + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "The status processing the document." } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk": { - "description": "Represents a chunk.", - "id": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk", + "GoogleCloudDocumentaiV1BatchProcessRequest": { + "description": "Request message for BatchProcessDocuments.", + "id": "GoogleCloudDocumentaiV1BatchProcessRequest", "properties": { - "chunkId": { - "description": "ID of the chunk.", - "type": "string" + "documentOutputConfig": { + "$ref": "GoogleCloudDocumentaiV1DocumentOutputConfig", + "description": "The output configuration for the BatchProcessDocuments method." }, - "content": { - "description": "Text content of the chunk.", - "type": "string" + "inputDocuments": { + "$ref": "GoogleCloudDocumentaiV1BatchDocumentsInputConfig", + "description": "The input documents for the BatchProcessDocuments method." }, - "pageFooters": { - "description": "Page footers associated with the chunk.", - "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter" + "labels": { + "additionalProperties": { + "type": "string" }, - "type": "array" + "description": "Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.", + "type": "object" }, - "pageHeaders": { - "description": "Page headers associated with the chunk.", + "processOptions": { + "$ref": "GoogleCloudDocumentaiV1ProcessOptions", + "description": "Inference-time options for the process API" + }, + "skipHumanReview": { + "description": "Whether human review should be skipped for this request. Default to `false`.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1BatchProcessResponse": { + "description": "Response message for BatchProcessDocuments.", + "id": "GoogleCloudDocumentaiV1BatchProcessResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDocumentaiV1BoundingPoly": { + "description": "A bounding polygon for the detected image annotation.", + "id": "GoogleCloudDocumentaiV1BoundingPoly", + "properties": { + "normalizedVertices": { + "description": "The bounding polygon normalized vertices.", "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader" + "$ref": "GoogleCloudDocumentaiV1NormalizedVertex" }, "type": "array" }, - "pageSpan": { - "$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan", - "description": "Page span of the chunk." - }, - "sourceBlockIds": { - "description": "Unused.", + "vertices": { + "description": "The bounding polygon vertices.", "items": { - "type": "string" + "$ref": "GoogleCloudDocumentaiV1Vertex" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter": { - "description": "Represents the page footer associated with the chunk.", - "id": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter", + "GoogleCloudDocumentaiV1CommonOperationMetadata": { + "description": "The common metadata for long running operations.", + "id": "GoogleCloudDocumentaiV1CommonOperationMetadata", "properties": { - "pageSpan": { - "$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan", - "description": "Page span of the footer." + "createTime": { + "description": "The creation time of the operation.", + "format": "google-datetime", + "type": "string" }, - "text": { - "description": "Footer in text format.", + "resource": { + "description": "A related resource to this operation.", "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader": { - "description": "Represents the page header associated with the chunk.", - "id": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader", - "properties": { - "pageSpan": { - "$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan", - "description": "Page span of the header." }, - "text": { - "description": "Header in text format.", + "state": { + "description": "The state of the operation.", + "enum": [ + "STATE_UNSPECIFIED", + "RUNNING", + "CANCELLING", + "SUCCEEDED", + "FAILED", + "CANCELLED" + ], + "enumDescriptions": [ + "Unspecified state.", + "Operation is still running.", + "Operation is being cancelled.", + "Operation succeeded.", + "Operation failed.", + "Operation is cancelled." + ], + "type": "string" + }, + "stateMessage": { + "description": "A message providing more details about the current state of processing.", + "type": "string" + }, + "updateTime": { + "description": "The last update time of the operation.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan": { - "description": "Represents where the chunk starts and ends in the document.", - "id": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan", + "GoogleCloudDocumentaiV1DeleteProcessorMetadata": { + "description": "The long-running operation metadata for the DeleteProcessor method.", + "id": "GoogleCloudDocumentaiV1DeleteProcessorMetadata", "properties": { - "pageEnd": { - "description": "Page where chunk ends in the document.", - "format": "int32", - "type": "integer" - }, - "pageStart": { - "description": "Page where chunk starts in the document.", - "format": "int32", - "type": "integer" + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentDocumentLayout": { - "description": "Represents the parsed layout of a document as a collection of blocks that the document is divided into.", - "id": "GoogleCloudDocumentaiV1DocumentDocumentLayout", + "GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata": { + "description": "The long-running operation metadata for the DeleteProcessorVersion method.", + "id": "GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata", "properties": { - "blocks": { - "description": "List of blocks in the document.", - "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock" - }, - "type": "array" + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock": { - "description": "Represents a block. A block could be one of the various types (text, table, list) supported.", - "id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock", + "GoogleCloudDocumentaiV1DeployProcessorVersionMetadata": { + "description": "The long-running operation metadata for the DeployProcessorVersion method.", + "id": "GoogleCloudDocumentaiV1DeployProcessorVersionMetadata", "properties": { - "blockId": { - "description": "ID of the block.", - "type": "string" - }, - "boundingBox": { - "$ref": "GoogleCloudDocumentaiV1BoundingPoly", - "description": "Identifies the bounding box for the block." - }, - "listBlock": { - "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock", - "description": "Block consisting of list content/structure." - }, - "pageSpan": { - "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan", - "description": "Page span of the block." - }, - "tableBlock": { - "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock", - "description": "Block consisting of table content/structure." - }, - "textBlock": { - "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock", - "description": "Block consisting of text content." + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock": { - "description": "Represents a list type block.", - "id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock", - "properties": { - "listEntries": { - "description": "List entries that constitute a list block.", - "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry" - }, - "type": "array" - }, - "type": { - "description": "Type of the list_entries (if exist). Available options are `ordered` and `unordered`.", - "type": "string" - } - }, + "GoogleCloudDocumentaiV1DeployProcessorVersionRequest": { + "description": "Request message for the DeployProcessorVersion method.", + "id": "GoogleCloudDocumentaiV1DeployProcessorVersionRequest", + "properties": {}, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry": { - "description": "Represents an entry in the list.", - "id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry", - "properties": { - "blocks": { - "description": "A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks.", - "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock" - }, - "type": "array" - } - }, + "GoogleCloudDocumentaiV1DeployProcessorVersionResponse": { + "description": "Response message for the DeployProcessorVersion method.", + "id": "GoogleCloudDocumentaiV1DeployProcessorVersionResponse", + "properties": {}, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan": { - "description": "Represents where the block starts and ends in the document.", - "id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan", + "GoogleCloudDocumentaiV1DisableProcessorMetadata": { + "description": "The long-running operation metadata for the DisableProcessor method.", + "id": "GoogleCloudDocumentaiV1DisableProcessorMetadata", "properties": { - "pageEnd": { - "description": "Page where block ends in the document.", - "format": "int32", - "type": "integer" - }, - "pageStart": { - "description": "Page where block starts in the document.", - "format": "int32", - "type": "integer" + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock": { - "description": "Represents a table type block.", - "id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock", + "GoogleCloudDocumentaiV1DisableProcessorRequest": { + "description": "Request message for the DisableProcessor method.", + "id": "GoogleCloudDocumentaiV1DisableProcessorRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudDocumentaiV1DisableProcessorResponse": { + "description": "Response message for the DisableProcessor method. Intentionally empty proto for adding fields in future.", + "id": "GoogleCloudDocumentaiV1DisableProcessorResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDocumentaiV1Document": { + "description": "Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality.", + "id": "GoogleCloudDocumentaiV1Document", "properties": { - "bodyRows": { - "description": "Body rows containing main table content.", + "chunkedDocument": { + "$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocument", + "description": "Document chunked based on chunking config." + }, + "content": { + "description": "Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64.", + "format": "byte", + "type": "string" + }, + "docid": { + "description": "Optional. An internal identifier for document. Should be loggable (no PII).", + "type": "string" + }, + "documentLayout": { + "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayout", + "description": "Parsed layout of the document." + }, + "entities": { + "description": "A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.", "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow" + "$ref": "GoogleCloudDocumentaiV1DocumentEntity" }, "type": "array" }, - "caption": { - "description": "Table caption/title.", + "entitiesRevisionId": { + "description": "The entity revision id that `document.entities` field is based on. If this field is set and `entities_revisions` is not empty, the entities in `document.entities` field are the entities in the entity revision with this id and `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision.", "type": "string" }, - "headerRows": { - "description": "Header rows at the top of the table.", + "entitiesRevisions": { + "description": "A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing.", "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow" + "$ref": "GoogleCloudDocumentaiV1DocumentEntitiesRevision" }, "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell": { - "description": "Represents a cell in a table row.", - "id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell", - "properties": { - "blocks": { - "description": "A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks.", + }, + "entityRelations": { + "description": "Placeholder. Relationship among Document.entities.", "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock" + "$ref": "GoogleCloudDocumentaiV1DocumentEntityRelation" }, "type": "array" }, - "colSpan": { - "description": "How many columns this cell spans.", - "format": "int32", - "type": "integer" + "entityValidationOutput": { + "$ref": "GoogleCloudDocumentaiV1DocumentEntityValidationOutput", + "description": "The entity validation output for the document. This is the validation output for `document.entities` field." }, - "rowSpan": { - "description": "How many rows this cell spans.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow": { - "description": "Represents a row in a table.", - "id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow", - "properties": { - "cells": { - "description": "A table row is a list of table cells.", + "error": { + "$ref": "GoogleRpcStatus", + "description": "Any error that occurred while processing this document." + }, + "mimeType": { + "description": "An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml).", + "type": "string" + }, + "pages": { + "description": "Visual page layout for the Document.", "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell" + "$ref": "GoogleCloudDocumentaiV1DocumentPage" }, "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock": { - "description": "Represents a text type block.", - "id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock", - "properties": { - "blocks": { - "description": "A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks.", + }, + "revisions": { + "description": "Placeholder. Revision history of this document.", "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock" + "$ref": "GoogleCloudDocumentaiV1DocumentRevision" }, "type": "array" }, + "shardInfo": { + "$ref": "GoogleCloudDocumentaiV1DocumentShardInfo", + "description": "Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified." + }, "text": { - "description": "Text content stored in the block.", + "description": "Optional. UTF-8 encoded text in reading order from the document.", "type": "string" }, - "type": { - "description": "Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`.", + "textChanges": { + "description": "Placeholder. A list of text corrections made to Document.text. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap with each other.", + "items": { + "$ref": "GoogleCloudDocumentaiV1DocumentTextChange" + }, + "type": "array" + }, + "textStyles": { + "deprecated": true, + "description": "Styles for the Document.text.", + "items": { + "$ref": "GoogleCloudDocumentaiV1DocumentStyle" + }, + "type": "array" + }, + "uri": { + "description": "Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. For more information, refer to [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris).", "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentEntitiesRevision": { - "description": "Entity revision.", - "id": "GoogleCloudDocumentaiV1DocumentEntitiesRevision", + "GoogleCloudDocumentaiV1DocumentChunkedDocument": { + "description": "Represents the chunks that the document is divided into.", + "id": "GoogleCloudDocumentaiV1DocumentChunkedDocument", "properties": { - "entities": { - "description": "The entities in this revision.", + "chunks": { + "description": "List of chunks.", "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentEntity" + "$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk" }, "type": "array" - }, - "entityValidationOutput": { - "$ref": "GoogleCloudDocumentaiV1DocumentEntityValidationOutput", - "description": "The entity validation output for this revision." - }, - "revisionId": { - "description": "The revision id.", - "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentEntity": { - "description": "An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.", - "id": "GoogleCloudDocumentaiV1DocumentEntity", + "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk": { + "description": "Represents a chunk.", + "id": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk", "properties": { - "confidence": { - "description": "Optional. Confidence of detected Schema entity. Range `[0, 1]`.", - "format": "float", - "type": "number" - }, - "id": { - "description": "Optional. Canonical id. This will be a unique value in the entity list for this document.", - "type": "string" - }, - "mentionId": { - "description": "Optional. Deprecated. Use `id` field instead.", + "chunkId": { + "description": "ID of the chunk.", "type": "string" }, - "mentionText": { - "description": "Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`.", + "content": { + "description": "Text content of the chunk.", "type": "string" }, - "method": { - "description": "Optional. Specifies how the entity's value is obtained.", - "enum": [ - "METHOD_UNSPECIFIED", - "EXTRACT", - "DERIVE" - ], - "enumDescriptions": [ - "When the method is not specified, it should be treated as `EXTRACT`.", - "The entity's value is directly extracted as-is from the document text.", - "The entity's value is derived through inference and is not necessarily an exact text extraction from the document." - ], - "type": "string" + "pageFooters": { + "description": "Page footers associated with the chunk.", + "items": { + "$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter" + }, + "type": "array" }, - "normalizedValue": { - "$ref": "GoogleCloudDocumentaiV1DocumentEntityNormalizedValue", - "description": "Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types." - }, - "pageAnchor": { - "$ref": "GoogleCloudDocumentaiV1DocumentPageAnchor", - "description": "Optional. Represents the provenance of this entity wrt. the location on the page where it was found." - }, - "properties": { - "description": "Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.", + "pageHeaders": { + "description": "Page headers associated with the chunk.", "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentEntity" + "$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader" }, "type": "array" }, - "provenance": { - "$ref": "GoogleCloudDocumentaiV1DocumentProvenance", - "description": "Optional. The history of this annotation." - }, - "redacted": { - "description": "Optional. Whether the entity will be redacted for de-identification purposes.", - "type": "boolean" - }, - "textAnchor": { - "$ref": "GoogleCloudDocumentaiV1DocumentTextAnchor", - "description": "Optional. Provenance of the entity. Text anchor indexing into the Document.text." + "pageSpan": { + "$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan", + "description": "Page span of the chunk." }, - "type": { - "description": "Required. Entity type from a schema e.g. `Address`.", - "type": "string" + "sourceBlockIds": { + "description": "Unused.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentEntityNormalizedValue": { - "description": "Parsed and normalized entity value.", - "id": "GoogleCloudDocumentaiV1DocumentEntityNormalizedValue", + "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter": { + "description": "Represents the page footer associated with the chunk.", + "id": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter", "properties": { - "addressValue": { - "$ref": "GoogleTypePostalAddress", - "description": "Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto" - }, - "booleanValue": { - "description": "Boolean value. Can be used for entities with binary values, or for checkboxes.", - "type": "boolean" - }, - "dateValue": { - "$ref": "GoogleTypeDate", - "description": "Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto" - }, - "datetimeValue": { - "$ref": "GoogleTypeDateTime", - "description": "DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto" - }, - "floatValue": { - "description": "Float value.", - "format": "float", - "type": "number" - }, - "integerValue": { - "description": "Integer value.", - "format": "int32", - "type": "integer" - }, - "moneyValue": { - "$ref": "GoogleTypeMoney", - "description": "Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto" - }, - "signatureValue": { - "description": "A signature - a graphical representation of a person's name, often used to sign a document.", - "type": "boolean" + "pageSpan": { + "$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan", + "description": "Page span of the footer." }, "text": { - "description": "Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.", + "description": "Footer in text format.", "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentEntityRelation": { - "description": "Relationship between Entities.", - "id": "GoogleCloudDocumentaiV1DocumentEntityRelation", + "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader": { + "description": "Represents the page header associated with the chunk.", + "id": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader", "properties": { - "objectId": { - "description": "Object entity id.", - "type": "string" - }, - "relation": { - "description": "Relationship description.", - "type": "string" + "pageSpan": { + "$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan", + "description": "Page span of the header." }, - "subjectId": { - "description": "Subject entity id.", + "text": { + "description": "Header in text format.", "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentEntityValidationOutput": { - "description": "The output of the validation given the document and the validation rules.", - "id": "GoogleCloudDocumentaiV1DocumentEntityValidationOutput", + "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan": { + "description": "Represents where the chunk starts and ends in the document.", + "id": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan", "properties": { - "passAllRules": { - "description": "The overall result of the validation, true if all applicable rules are valid.", - "type": "boolean" + "pageEnd": { + "description": "Page where chunk ends in the document.", + "format": "int32", + "type": "integer" }, - "validationResults": { - "description": "The result of each validation rule.", + "pageStart": { + "description": "Page where chunk starts in the document.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1DocumentDocumentLayout": { + "description": "Represents the parsed layout of a document as a collection of blocks that the document is divided into.", + "id": "GoogleCloudDocumentaiV1DocumentDocumentLayout", + "properties": { + "blocks": { + "description": "List of blocks in the document.", "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentEntityValidationOutputValidationResult" + "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentEntityValidationOutputValidationResult": { - "description": "Validation result for a single validation rule.", - "id": "GoogleCloudDocumentaiV1DocumentEntityValidationOutputValidationResult", + "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock": { + "description": "Represents a block. A block could be one of the various types (text, table, list) supported.", + "id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock", "properties": { - "ruleDescription": { - "description": "The description of the validation rule.", + "blockId": { + "description": "ID of the block.", "type": "string" }, - "ruleName": { - "description": "The name of the validation rule.", - "type": "string" + "boundingBox": { + "$ref": "GoogleCloudDocumentaiV1BoundingPoly", + "description": "Identifies the bounding box for the block." }, - "validationDetails": { - "description": "The detailed information of the running the validation process using the entity from the document based on the validation rule.", - "type": "string" + "listBlock": { + "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock", + "description": "Block consisting of list content/structure." }, - "validationResultType": { - "description": "The result of the validation rule.", - "enum": [ - "VALIDATION_RESULT_TYPE_UNSPECIFIED", - "VALIDATION_RESULT_TYPE_VALID", - "VALIDATION_RESULT_TYPE_INVALID", - "VALIDATION_RESULT_TYPE_SKIPPED", - "VALIDATION_RESULT_TYPE_NOT_APPLICABLE" - ], - "enumDescriptions": [ - "The validation result type is unspecified.", - "The validation is valid.", - "The validation is invalid.", - "The validation is skipped.", - "The validation is not applicable." - ], - "type": "string" + "pageSpan": { + "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan", + "description": "Page span of the block." + }, + "tableBlock": { + "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock", + "description": "Block consisting of table content/structure." + }, + "textBlock": { + "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock", + "description": "Block consisting of text content." } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentOutputConfig": { - "description": "Config that controls the output of documents. All documents will be written as a JSON file.", - "id": "GoogleCloudDocumentaiV1DocumentOutputConfig", + "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock": { + "description": "Represents a list type block.", + "id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock", "properties": { - "gcsOutputConfig": { - "$ref": "GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig", - "description": "Output config to write the results to Cloud Storage." + "listEntries": { + "description": "List entries that constitute a list block.", + "items": { + "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry" + }, + "type": "array" + }, + "type": { + "description": "Type of the list_entries (if exist). Available options are `ordered` and `unordered`.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig": { - "description": "The configuration used when outputting documents.", - "id": "GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig", + "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry": { + "description": "Represents an entry in the list.", + "id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry", "properties": { - "fieldMask": { - "description": "Specifies which fields to include in the output documents. Only supports top level document and pages field so it must be in the form of `{document_field_name}` or `pages.{page_field_name}`.", - "format": "google-fieldmask", - "type": "string" - }, - "gcsUri": { - "description": "The Cloud Storage uri (a directory) of the output.", - "type": "string" - }, - "shardingConfig": { - "$ref": "GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig", - "description": "Specifies the sharding config for the output document." + "blocks": { + "description": "A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks.", + "items": { + "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig": { - "description": "The sharding config for the output document.", - "id": "GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig", + "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan": { + "description": "Represents where the block starts and ends in the document.", + "id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan", "properties": { - "pagesOverlap": { - "description": "The number of overlapping pages between consecutive shards.", + "pageEnd": { + "description": "Page where block ends in the document.", "format": "int32", "type": "integer" }, - "pagesPerShard": { - "description": "The number of pages per shard.", + "pageStart": { + "description": "Page where block starts in the document.", "format": "int32", "type": "integer" } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentPage": { - "description": "A page in a Document.", - "id": "GoogleCloudDocumentaiV1DocumentPage", + "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock": { + "description": "Represents a table type block.", + "id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock", "properties": { - "blocks": { - "description": "A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.", + "bodyRows": { + "description": "Body rows containing main table content.", "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentPageBlock" + "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow" }, "type": "array" }, - "detectedBarcodes": { - "description": "A list of detected barcodes.", - "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentPageDetectedBarcode" - }, - "type": "array" + "caption": { + "description": "Table caption/title.", + "type": "string" }, - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "dimension": { - "$ref": "GoogleCloudDocumentaiV1DocumentPageDimension", - "description": "Physical dimension of the page." - }, - "formFields": { - "description": "A list of visually detected form fields on the page.", + "headerRows": { + "description": "Header rows at the top of the table.", "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentPageFormField" + "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow" }, "type": "array" - }, - "image": { - "$ref": "GoogleCloudDocumentaiV1DocumentPageImage", - "description": "Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned." - }, - "imageQualityScores": { - "$ref": "GoogleCloudDocumentaiV1DocumentPageImageQualityScores", - "description": "Image quality scores." - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1DocumentPageLayout", - "description": "Layout for the page." - }, - "lines": { - "description": "A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.", + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell": { + "description": "Represents a cell in a table row.", + "id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell", + "properties": { + "blocks": { + "description": "A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks.", "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentPageLine" + "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock" }, "type": "array" }, - "pageNumber": { - "description": "1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing.", + "colSpan": { + "description": "How many columns this cell spans.", "format": "int32", "type": "integer" }, - "paragraphs": { - "description": "A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.", - "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentPageParagraph" - }, - "type": "array" - }, - "provenance": { - "$ref": "GoogleCloudDocumentaiV1DocumentProvenance", - "deprecated": true, - "description": "The history of this page." - }, - "symbols": { - "description": "A list of visually detected symbols on the page.", - "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentPageSymbol" - }, - "type": "array" - }, - "tables": { - "description": "A list of visually detected tables on the page.", + "rowSpan": { + "description": "How many rows this cell spans.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow": { + "description": "Represents a row in a table.", + "id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow", + "properties": { + "cells": { + "description": "A table row is a list of table cells.", "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentPageTable" + "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell" }, "type": "array" - }, - "tokens": { - "description": "A list of visually detected tokens on the page.", + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock": { + "description": "Represents a text type block.", + "id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock", + "properties": { + "blocks": { + "description": "A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks.", "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentPageToken" + "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock" }, "type": "array" }, - "transforms": { - "description": "Transformation matrices that were applied to the original document image to produce Page.image.", - "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentPageMatrix" - }, - "type": "array" + "text": { + "description": "Text content stored in the block.", + "type": "string" }, - "visualElements": { - "description": "A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.", - "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentPageVisualElement" - }, - "type": "array" + "type": { + "description": "Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentPageAnchor": { - "description": "Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types.", - "id": "GoogleCloudDocumentaiV1DocumentPageAnchor", + "GoogleCloudDocumentaiV1DocumentEntitiesRevision": { + "description": "Entity revision.", + "id": "GoogleCloudDocumentaiV1DocumentEntitiesRevision", "properties": { - "pageRefs": { - "description": "One or more references to visual page elements", + "entities": { + "description": "The entities in this revision.", "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentPageAnchorPageRef" + "$ref": "GoogleCloudDocumentaiV1DocumentEntity" }, "type": "array" + }, + "entityValidationOutput": { + "$ref": "GoogleCloudDocumentaiV1DocumentEntityValidationOutput", + "description": "The entity validation output for this revision." + }, + "revisionId": { + "description": "The revision id.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentPageAnchorPageRef": { - "description": "Represents a weak reference to a page element within a document.", - "id": "GoogleCloudDocumentaiV1DocumentPageAnchorPageRef", + "GoogleCloudDocumentaiV1DocumentEntity": { + "description": "An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.", + "id": "GoogleCloudDocumentaiV1DocumentEntity", "properties": { - "boundingPoly": { - "$ref": "GoogleCloudDocumentaiV1BoundingPoly", - "description": "Optional. Identifies the bounding polygon of a layout element on the page. If `layout_type` is set, the bounding polygon must be exactly the same to the layout element it's referring to." - }, "confidence": { - "description": "Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.", + "description": "Optional. Confidence of detected Schema entity. Range `[0, 1]`.", "format": "float", "type": "number" }, - "layoutId": { - "deprecated": true, - "description": "Optional. Deprecated. Use PageRef.bounding_poly instead.", + "id": { + "description": "Optional. Canonical id. This will be a unique value in the entity list for this document.", "type": "string" }, - "layoutType": { - "description": "Optional. The type of the layout element that is being referenced if any.", + "mentionId": { + "description": "Optional. Deprecated. Use `id` field instead.", + "type": "string" + }, + "mentionText": { + "description": "Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`.", + "type": "string" + }, + "method": { + "description": "Optional. Specifies how the entity's value is obtained.", "enum": [ - "LAYOUT_TYPE_UNSPECIFIED", - "BLOCK", - "PARAGRAPH", - "LINE", - "TOKEN", - "VISUAL_ELEMENT", - "TABLE", - "FORM_FIELD" + "METHOD_UNSPECIFIED", + "EXTRACT", + "DERIVE" ], "enumDescriptions": [ - "Layout Unspecified.", - "References a Page.blocks element.", - "References a Page.paragraphs element.", - "References a Page.lines element.", - "References a Page.tokens element.", - "References a Page.visual_elements element.", - "Refrrences a Page.tables element.", - "References a Page.form_fields element." + "When the method is not specified, it should be treated as `EXTRACT`.", + "The entity's value is directly extracted as-is from the document text.", + "The entity's value is derived through inference and is not necessarily an exact text extraction from the document." ], "type": "string" }, - "page": { - "description": "Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See https://developers.google.com/protocol-buffers/docs/proto3#json.", - "format": "int64", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1DocumentPageBlock": { - "description": "A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.", - "id": "GoogleCloudDocumentaiV1DocumentPageBlock", - "properties": { - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", + "normalizedValue": { + "$ref": "GoogleCloudDocumentaiV1DocumentEntityNormalizedValue", + "description": "Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types." + }, + "pageAnchor": { + "$ref": "GoogleCloudDocumentaiV1DocumentPageAnchor", + "description": "Optional. Represents the provenance of this entity wrt. the location on the page where it was found." + }, + "properties": { + "description": "Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.", "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentPageDetectedLanguage" + "$ref": "GoogleCloudDocumentaiV1DocumentEntity" }, "type": "array" }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1DocumentPageLayout", - "description": "Layout for Block." - }, "provenance": { "$ref": "GoogleCloudDocumentaiV1DocumentProvenance", - "deprecated": true, - "description": "The history of this annotation." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1DocumentPageDetectedBarcode": { - "description": "A detected barcode.", - "id": "GoogleCloudDocumentaiV1DocumentPageDetectedBarcode", - "properties": { - "barcode": { - "$ref": "GoogleCloudDocumentaiV1Barcode", - "description": "Detailed barcode information of the DetectedBarcode." + "description": "Optional. The history of this annotation." }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1DocumentPageLayout", - "description": "Layout for DetectedBarcode." + "redacted": { + "description": "Optional. Whether the entity will be redacted for de-identification purposes.", + "type": "boolean" + }, + "textAnchor": { + "$ref": "GoogleCloudDocumentaiV1DocumentTextAnchor", + "description": "Optional. Provenance of the entity. Text anchor indexing into the Document.text." + }, + "type": { + "description": "Required. Entity type from a schema e.g. `Address`.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentPageDetectedLanguage": { - "description": "Detected language for a structural component.", - "id": "GoogleCloudDocumentaiV1DocumentPageDetectedLanguage", + "GoogleCloudDocumentaiV1DocumentEntityNormalizedValue": { + "description": "Parsed and normalized entity value.", + "id": "GoogleCloudDocumentaiV1DocumentEntityNormalizedValue", "properties": { - "confidence": { - "description": "Confidence of detected language. Range `[0, 1]`.", - "format": "float", + "addressValue": { + "$ref": "GoogleTypePostalAddress", + "description": "Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto" + }, + "booleanValue": { + "description": "Boolean value. Can be used for entities with binary values, or for checkboxes.", + "type": "boolean" + }, + "dateValue": { + "$ref": "GoogleTypeDate", + "description": "Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto" + }, + "datetimeValue": { + "$ref": "GoogleTypeDateTime", + "description": "DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto" + }, + "floatValue": { + "description": "Float value.", + "format": "float", "type": "number" }, - "languageCode": { - "description": "The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.", + "integerValue": { + "description": "Integer value.", + "format": "int32", + "type": "integer" + }, + "moneyValue": { + "$ref": "GoogleTypeMoney", + "description": "Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto" + }, + "signatureValue": { + "description": "A signature - a graphical representation of a person's name, often used to sign a document.", + "type": "boolean" + }, + "text": { + "description": "Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.", "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentPageDimension": { - "description": "Dimension for the page.", - "id": "GoogleCloudDocumentaiV1DocumentPageDimension", + "GoogleCloudDocumentaiV1DocumentEntityRelation": { + "description": "Relationship between Entities.", + "id": "GoogleCloudDocumentaiV1DocumentEntityRelation", "properties": { - "height": { - "description": "Page height.", - "format": "float", - "type": "number" + "objectId": { + "description": "Object entity id.", + "type": "string" }, - "unit": { - "description": "Dimension unit.", + "relation": { + "description": "Relationship description.", "type": "string" }, - "width": { - "description": "Page width.", - "format": "float", - "type": "number" + "subjectId": { + "description": "Subject entity id.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentPageFormField": { - "description": "A form field detected on the page.", - "id": "GoogleCloudDocumentaiV1DocumentPageFormField", + "GoogleCloudDocumentaiV1DocumentEntityValidationOutput": { + "description": "The output of the validation given the document and the validation rules.", + "id": "GoogleCloudDocumentaiV1DocumentEntityValidationOutput", "properties": { - "correctedKeyText": { - "description": "Created for Labeling UI to export key text. If corrections were made to the text identified by the `field_name.text_anchor`, this field will contain the correction.", - "type": "string" - }, - "correctedValueText": { - "description": "Created for Labeling UI to export value text. If corrections were made to the text identified by the `field_value.text_anchor`, this field will contain the correction.", - "type": "string" - }, - "fieldName": { - "$ref": "GoogleCloudDocumentaiV1DocumentPageLayout", - "description": "Layout for the FormField name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc." - }, - "fieldValue": { - "$ref": "GoogleCloudDocumentaiV1DocumentPageLayout", - "description": "Layout for the FormField value." - }, - "nameDetectedLanguages": { - "description": "A list of detected languages for name together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "provenance": { - "$ref": "GoogleCloudDocumentaiV1DocumentProvenance", - "description": "The history of this annotation." + "passAllRules": { + "description": "The overall result of the validation, true if all applicable rules are valid.", + "type": "boolean" }, - "valueDetectedLanguages": { - "description": "A list of detected languages for value together with confidence.", + "validationResults": { + "description": "The result of each validation rule.", "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentPageDetectedLanguage" + "$ref": "GoogleCloudDocumentaiV1DocumentEntityValidationOutputValidationResult" }, "type": "array" - }, - "valueType": { - "description": "If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the `field_value` is normal text) - `unfilled_checkbox` - `filled_checkbox`", - "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentPageImage": { - "description": "Rendered image contents for this page.", - "id": "GoogleCloudDocumentaiV1DocumentPageImage", + "GoogleCloudDocumentaiV1DocumentEntityValidationOutputValidationResult": { + "description": "Validation result for a single validation rule.", + "id": "GoogleCloudDocumentaiV1DocumentEntityValidationOutputValidationResult", "properties": { - "content": { - "description": "Raw byte content of the image.", - "format": "byte", + "rule": { + "description": "Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}`", "type": "string" }, - "height": { - "description": "Height of the image in pixels.", - "format": "int32", - "type": "integer" + "ruleDescription": { + "description": "The description of the validation rule.", + "type": "string" }, - "mimeType": { - "description": "Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image.", + "ruleName": { + "description": "The display name of the validation rule.", "type": "string" }, - "width": { - "description": "Width of the image in pixels.", - "format": "int32", - "type": "integer" + "validationDetails": { + "description": "The detailed information of the running the validation process using the entity from the document based on the validation rule.", + "type": "string" + }, + "validationResultType": { + "description": "The result of the validation rule.", + "enum": [ + "VALIDATION_RESULT_TYPE_UNSPECIFIED", + "VALIDATION_RESULT_TYPE_VALID", + "VALIDATION_RESULT_TYPE_INVALID", + "VALIDATION_RESULT_TYPE_SKIPPED", + "VALIDATION_RESULT_TYPE_NOT_APPLICABLE" + ], + "enumDescriptions": [ + "The validation result type is unspecified.", + "The validation is valid.", + "The validation is invalid.", + "The validation is skipped.", + "The validation is not applicable." + ], + "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentPageImageQualityScores": { - "description": "Image quality scores for the page image.", - "id": "GoogleCloudDocumentaiV1DocumentPageImageQualityScores", + "GoogleCloudDocumentaiV1DocumentOutputConfig": { + "description": "Config that controls the output of documents. All documents will be written as a JSON file.", + "id": "GoogleCloudDocumentaiV1DocumentOutputConfig", "properties": { - "detectedDefects": { - "description": "A list of detected defects.", - "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect" - }, - "type": "array" - }, - "qualityScore": { - "description": "The overall quality score. Range `[0, 1]` where `1` is perfect quality.", - "format": "float", - "type": "number" + "gcsOutputConfig": { + "$ref": "GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig", + "description": "Output config to write the results to Cloud Storage." } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect": { - "description": "Image Quality Defects", - "id": "GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect", + "GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig": { + "description": "The configuration used when outputting documents.", + "id": "GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig", "properties": { - "confidence": { - "description": "Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists.", - "format": "float", - "type": "number" + "fieldMask": { + "description": "Specifies which fields to include in the output documents. Only supports top level document and pages field so it must be in the form of `{document_field_name}` or `pages.{page_field_name}`.", + "format": "google-fieldmask", + "type": "string" }, - "type": { - "description": "Name of the defect type. Supported values are: - `quality/defect_blurry` - `quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `quality/defect_text_too_small` - `quality/defect_document_cutoff` - `quality/defect_text_cutoff` - `quality/defect_glare`", + "gcsUri": { + "description": "The Cloud Storage uri (a directory) of the output.", "type": "string" + }, + "shardingConfig": { + "$ref": "GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig", + "description": "Specifies the sharding config for the output document." } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentPageLayout": { - "description": "Visual element describing a layout unit on a page.", - "id": "GoogleCloudDocumentaiV1DocumentPageLayout", + "GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig": { + "description": "The sharding config for the output document.", + "id": "GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig", "properties": { - "boundingPoly": { - "$ref": "GoogleCloudDocumentaiV1BoundingPoly", - "description": "The bounding polygon for the Layout." - }, - "confidence": { - "description": "Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.", - "format": "float", - "type": "number" - }, - "orientation": { - "description": "Detected orientation for the Layout.", - "enum": [ - "ORIENTATION_UNSPECIFIED", - "PAGE_UP", - "PAGE_RIGHT", - "PAGE_DOWN", - "PAGE_LEFT" - ], - "enumDescriptions": [ - "Unspecified orientation.", - "Orientation is aligned with page up.", - "Orientation is aligned with page right. Turn the head 90 degrees clockwise from upright to read.", - "Orientation is aligned with page down. Turn the head 180 degrees from upright to read.", - "Orientation is aligned with page left. Turn the head 90 degrees counterclockwise from upright to read." - ], - "type": "string" + "pagesOverlap": { + "description": "The number of overlapping pages between consecutive shards.", + "format": "int32", + "type": "integer" }, - "textAnchor": { - "$ref": "GoogleCloudDocumentaiV1DocumentTextAnchor", - "description": "Text anchor indexing into the Document.text." + "pagesPerShard": { + "description": "The number of pages per shard.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentPageLine": { - "description": "A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.", - "id": "GoogleCloudDocumentaiV1DocumentPageLine", + "GoogleCloudDocumentaiV1DocumentPage": { + "description": "A page in a Document.", + "id": "GoogleCloudDocumentaiV1DocumentPage", "properties": { + "blocks": { + "description": "A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.", + "items": { + "$ref": "GoogleCloudDocumentaiV1DocumentPageBlock" + }, + "type": "array" + }, + "detectedBarcodes": { + "description": "A list of detected barcodes.", + "items": { + "$ref": "GoogleCloudDocumentaiV1DocumentPageDetectedBarcode" + }, + "type": "array" + }, "detectedLanguages": { "description": "A list of detected languages together with confidence.", "items": { @@ -3520,173 +4334,159 @@ }, "type": "array" }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1DocumentPageLayout", - "description": "Layout for Line." + "dimension": { + "$ref": "GoogleCloudDocumentaiV1DocumentPageDimension", + "description": "Physical dimension of the page." }, - "provenance": { - "$ref": "GoogleCloudDocumentaiV1DocumentProvenance", - "deprecated": true, - "description": "The history of this annotation." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1DocumentPageMatrix": { - "description": "Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.", - "id": "GoogleCloudDocumentaiV1DocumentPageMatrix", - "properties": { - "cols": { - "description": "Number of columns in the matrix.", - "format": "int32", - "type": "integer" + "formFields": { + "description": "A list of visually detected form fields on the page.", + "items": { + "$ref": "GoogleCloudDocumentaiV1DocumentPageFormField" + }, + "type": "array" }, - "data": { - "description": "The matrix data.", - "format": "byte", - "type": "string" + "image": { + "$ref": "GoogleCloudDocumentaiV1DocumentPageImage", + "description": "Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned." }, - "rows": { - "description": "Number of rows in the matrix.", - "format": "int32", - "type": "integer" + "imageQualityScores": { + "$ref": "GoogleCloudDocumentaiV1DocumentPageImageQualityScores", + "description": "Image quality scores." }, - "type": { - "description": "This encodes information about what data type the matrix uses. For example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of OpenCV primitive data types, please refer to https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html", + "layout": { + "$ref": "GoogleCloudDocumentaiV1DocumentPageLayout", + "description": "Layout for the page." + }, + "lines": { + "description": "A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.", + "items": { + "$ref": "GoogleCloudDocumentaiV1DocumentPageLine" + }, + "type": "array" + }, + "pageNumber": { + "description": "1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing.", "format": "int32", "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1DocumentPageParagraph": { - "description": "A collection of lines that a human would perceive as a paragraph.", - "id": "GoogleCloudDocumentaiV1DocumentPageParagraph", - "properties": { - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", + }, + "paragraphs": { + "description": "A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.", "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentPageDetectedLanguage" + "$ref": "GoogleCloudDocumentaiV1DocumentPageParagraph" }, "type": "array" }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1DocumentPageLayout", - "description": "Layout for Paragraph." - }, "provenance": { "$ref": "GoogleCloudDocumentaiV1DocumentProvenance", "deprecated": true, - "description": "The history of this annotation." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1DocumentPageSymbol": { - "description": "A detected symbol.", - "id": "GoogleCloudDocumentaiV1DocumentPageSymbol", - "properties": { - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", + "description": "The history of this page." + }, + "symbols": { + "description": "A list of visually detected symbols on the page.", "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentPageDetectedLanguage" + "$ref": "GoogleCloudDocumentaiV1DocumentPageSymbol" }, "type": "array" }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1DocumentPageLayout", - "description": "Layout for Symbol." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1DocumentPageTable": { - "description": "A table representation similar to HTML table structure.", - "id": "GoogleCloudDocumentaiV1DocumentPageTable", - "properties": { - "bodyRows": { - "description": "Body rows of the table.", + "tables": { + "description": "A list of visually detected tables on the page.", "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentPageTableTableRow" + "$ref": "GoogleCloudDocumentaiV1DocumentPageTable" }, "type": "array" }, - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", + "tokens": { + "description": "A list of visually detected tokens on the page.", "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentPageDetectedLanguage" + "$ref": "GoogleCloudDocumentaiV1DocumentPageToken" }, "type": "array" }, - "headerRows": { - "description": "Header rows of the table.", + "transforms": { + "description": "Transformation matrices that were applied to the original document image to produce Page.image.", "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentPageTableTableRow" + "$ref": "GoogleCloudDocumentaiV1DocumentPageMatrix" }, "type": "array" }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1DocumentPageLayout", - "description": "Layout for Table." - }, - "provenance": { - "$ref": "GoogleCloudDocumentaiV1DocumentProvenance", - "deprecated": true, - "description": "The history of this table." + "visualElements": { + "description": "A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.", + "items": { + "$ref": "GoogleCloudDocumentaiV1DocumentPageVisualElement" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentPageTableTableCell": { - "description": "A cell representation inside the table.", - "id": "GoogleCloudDocumentaiV1DocumentPageTableTableCell", + "GoogleCloudDocumentaiV1DocumentPageAnchor": { + "description": "Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types.", + "id": "GoogleCloudDocumentaiV1DocumentPageAnchor", "properties": { - "colSpan": { - "description": "How many columns this cell spans.", - "format": "int32", - "type": "integer" - }, - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", + "pageRefs": { + "description": "One or more references to visual page elements", "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentPageDetectedLanguage" + "$ref": "GoogleCloudDocumentaiV1DocumentPageAnchorPageRef" }, "type": "array" - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1DocumentPageLayout", - "description": "Layout for TableCell." - }, - "rowSpan": { - "description": "How many rows this cell spans.", - "format": "int32", - "type": "integer" } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentPageTableTableRow": { - "description": "A row of table cells.", - "id": "GoogleCloudDocumentaiV1DocumentPageTableTableRow", + "GoogleCloudDocumentaiV1DocumentPageAnchorPageRef": { + "description": "Represents a weak reference to a page element within a document.", + "id": "GoogleCloudDocumentaiV1DocumentPageAnchorPageRef", "properties": { - "cells": { - "description": "Cells that make up this row.", - "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentPageTableTableCell" - }, - "type": "array" + "boundingPoly": { + "$ref": "GoogleCloudDocumentaiV1BoundingPoly", + "description": "Optional. Identifies the bounding polygon of a layout element on the page. If `layout_type` is set, the bounding polygon must be exactly the same to the layout element it's referring to." + }, + "confidence": { + "description": "Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.", + "format": "float", + "type": "number" + }, + "layoutId": { + "deprecated": true, + "description": "Optional. Deprecated. Use PageRef.bounding_poly instead.", + "type": "string" + }, + "layoutType": { + "description": "Optional. The type of the layout element that is being referenced if any.", + "enum": [ + "LAYOUT_TYPE_UNSPECIFIED", + "BLOCK", + "PARAGRAPH", + "LINE", + "TOKEN", + "VISUAL_ELEMENT", + "TABLE", + "FORM_FIELD" + ], + "enumDescriptions": [ + "Layout Unspecified.", + "References a Page.blocks element.", + "References a Page.paragraphs element.", + "References a Page.lines element.", + "References a Page.tokens element.", + "References a Page.visual_elements element.", + "Refrrences a Page.tables element.", + "References a Page.form_fields element." + ], + "type": "string" + }, + "page": { + "description": "Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See https://developers.google.com/protocol-buffers/docs/proto3#json.", + "format": "int64", + "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentPageToken": { - "description": "A detected token.", - "id": "GoogleCloudDocumentaiV1DocumentPageToken", + "GoogleCloudDocumentaiV1DocumentPageBlock": { + "description": "A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.", + "id": "GoogleCloudDocumentaiV1DocumentPageBlock", "properties": { - "detectedBreak": { - "$ref": "GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak", - "description": "Detected break at the end of a Token." - }, "detectedLanguages": { "description": "A list of detected languages together with confidence.", "items": { @@ -3696,2080 +4496,3373 @@ }, "layout": { "$ref": "GoogleCloudDocumentaiV1DocumentPageLayout", - "description": "Layout for Token." + "description": "Layout for Block." }, "provenance": { "$ref": "GoogleCloudDocumentaiV1DocumentProvenance", "deprecated": true, "description": "The history of this annotation." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1DocumentPageDetectedBarcode": { + "description": "A detected barcode.", + "id": "GoogleCloudDocumentaiV1DocumentPageDetectedBarcode", + "properties": { + "barcode": { + "$ref": "GoogleCloudDocumentaiV1Barcode", + "description": "Detailed barcode information of the DetectedBarcode." }, - "styleInfo": { - "$ref": "GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo", - "description": "Text style attributes." + "layout": { + "$ref": "GoogleCloudDocumentaiV1DocumentPageLayout", + "description": "Layout for DetectedBarcode." } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak": { - "description": "Detected break at the end of a Token.", - "id": "GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak", + "GoogleCloudDocumentaiV1DocumentPageDetectedLanguage": { + "description": "Detected language for a structural component.", + "id": "GoogleCloudDocumentaiV1DocumentPageDetectedLanguage", "properties": { - "type": { - "description": "Detected break type.", - "enum": [ - "TYPE_UNSPECIFIED", - "SPACE", - "WIDE_SPACE", - "HYPHEN" - ], - "enumDescriptions": [ - "Unspecified break type.", - "A single whitespace.", - "A wider whitespace.", - "A hyphen that indicates that a token has been split across lines." - ], + "confidence": { + "description": "Confidence of detected language. Range `[0, 1]`.", + "format": "float", + "type": "number" + }, + "languageCode": { + "description": "The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.", "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo": { - "description": "Font and other text style attributes.", - "id": "GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo", + "GoogleCloudDocumentaiV1DocumentPageDimension": { + "description": "Dimension for the page.", + "id": "GoogleCloudDocumentaiV1DocumentPageDimension", "properties": { - "backgroundColor": { - "$ref": "GoogleTypeColor", - "description": "Color of the background." - }, - "bold": { - "description": "Whether the text is bold (equivalent to font_weight is at least `700`).", - "type": "boolean" - }, - "fontSize": { - "description": "Font size in points (`1` point is `¹⁄₇₂` inches).", - "format": "int32", - "type": "integer" + "height": { + "description": "Page height.", + "format": "float", + "type": "number" }, - "fontType": { - "description": "Name or style of the font.", + "unit": { + "description": "Dimension unit.", "type": "string" }, - "fontWeight": { - "description": "TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). Normal is `400`, bold is `700`.", - "format": "int32", - "type": "integer" - }, - "handwritten": { - "description": "Whether the text is handwritten.", - "type": "boolean" - }, - "italic": { - "description": "Whether the text is italic.", - "type": "boolean" - }, - "letterSpacing": { - "description": "Letter spacing in points.", - "format": "double", - "type": "number" - }, - "pixelFontSize": { - "description": "Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ `72.0`.", - "format": "double", + "width": { + "description": "Page width.", + "format": "float", "type": "number" - }, - "smallcaps": { - "description": "Whether the text is in small caps. This feature is not supported yet.", - "type": "boolean" - }, - "strikeout": { - "description": "Whether the text is strikethrough. This feature is not supported yet.", - "type": "boolean" - }, - "subscript": { - "description": "Whether the text is a subscript. This feature is not supported yet.", - "type": "boolean" - }, - "superscript": { - "description": "Whether the text is a superscript. This feature is not supported yet.", - "type": "boolean" - }, - "textColor": { - "$ref": "GoogleTypeColor", - "description": "Color of the text." - }, - "underlined": { - "description": "Whether the text is underlined.", - "type": "boolean" } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentPageVisualElement": { - "description": "Detected non-text visual elements e.g. checkbox, signature etc. on the page.", - "id": "GoogleCloudDocumentaiV1DocumentPageVisualElement", + "GoogleCloudDocumentaiV1DocumentPageFormField": { + "description": "A form field detected on the page.", + "id": "GoogleCloudDocumentaiV1DocumentPageFormField", "properties": { - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", + "correctedKeyText": { + "description": "Created for Labeling UI to export key text. If corrections were made to the text identified by the `field_name.text_anchor`, this field will contain the correction.", + "type": "string" + }, + "correctedValueText": { + "description": "Created for Labeling UI to export value text. If corrections were made to the text identified by the `field_value.text_anchor`, this field will contain the correction.", + "type": "string" + }, + "fieldName": { + "$ref": "GoogleCloudDocumentaiV1DocumentPageLayout", + "description": "Layout for the FormField name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc." + }, + "fieldValue": { + "$ref": "GoogleCloudDocumentaiV1DocumentPageLayout", + "description": "Layout for the FormField value." + }, + "nameDetectedLanguages": { + "description": "A list of detected languages for name together with confidence.", "items": { "$ref": "GoogleCloudDocumentaiV1DocumentPageDetectedLanguage" }, "type": "array" }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1DocumentPageLayout", - "description": "Layout for VisualElement." - }, - "type": { - "description": "Type of the VisualElement.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1DocumentProvenance": { - "description": "Structure to identify provenance relationships between annotations in different revisions.", - "id": "GoogleCloudDocumentaiV1DocumentProvenance", - "properties": { - "id": { - "deprecated": true, - "description": "The Id of this operation. Needs to be unique within the scope of the revision.", - "format": "int32", - "type": "integer" + "provenance": { + "$ref": "GoogleCloudDocumentaiV1DocumentProvenance", + "description": "The history of this annotation." }, - "parents": { - "description": "References to the original elements that are replaced.", + "valueDetectedLanguages": { + "description": "A list of detected languages for value together with confidence.", "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentProvenanceParent" + "$ref": "GoogleCloudDocumentaiV1DocumentPageDetectedLanguage" }, "type": "array" }, - "revision": { - "deprecated": true, - "description": "The index of the revision that produced this element.", - "format": "int32", - "type": "integer" - }, - "type": { - "description": "The type of provenance operation.", - "enum": [ - "OPERATION_TYPE_UNSPECIFIED", - "ADD", - "REMOVE", - "UPDATE", - "REPLACE", - "EVAL_REQUESTED", - "EVAL_APPROVED", - "EVAL_SKIPPED" - ], - "enumDeprecated": [ - false, - false, - false, - false, - false, - true, - true, - true - ], - "enumDescriptions": [ - "Operation type unspecified. If no operation is specified a provenance entry is simply used to match against a `parent`.", - "Add an element.", - "Remove an element identified by `parent`.", - "Updates any fields within the given provenance scope of the message. It overwrites the fields rather than replacing them. Use this when you want to update a field value of an entity without also updating all the child properties.", - "Currently unused. Replace an element identified by `parent`.", - "Deprecated. Request human review for the element identified by `parent`.", - "Deprecated. Element is reviewed and approved at human review, confidence will be set to 1.0.", - "Deprecated. Element is skipped in the validation process." - ], + "valueType": { + "description": "If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the `field_value` is normal text) - `unfilled_checkbox` - `filled_checkbox`", "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentProvenanceParent": { - "description": "The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.", - "id": "GoogleCloudDocumentaiV1DocumentProvenanceParent", + "GoogleCloudDocumentaiV1DocumentPageImage": { + "description": "Rendered image contents for this page.", + "id": "GoogleCloudDocumentaiV1DocumentPageImage", "properties": { - "id": { - "deprecated": true, - "description": "The id of the parent provenance.", - "format": "int32", - "type": "integer" + "content": { + "description": "Raw byte content of the image.", + "format": "byte", + "type": "string" }, - "index": { - "description": "The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.", + "height": { + "description": "Height of the image in pixels.", "format": "int32", "type": "integer" }, - "revision": { - "description": "The index of the index into current revision's parent_ids list.", + "mimeType": { + "description": "Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image.", + "type": "string" + }, + "width": { + "description": "Width of the image in pixels.", "format": "int32", "type": "integer" } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentRevision": { - "description": "Contains past or forward revisions of this document.", - "id": "GoogleCloudDocumentaiV1DocumentRevision", + "GoogleCloudDocumentaiV1DocumentPageImageQualityScores": { + "description": "Image quality scores for the page image.", + "id": "GoogleCloudDocumentaiV1DocumentPageImageQualityScores", "properties": { - "agent": { - "description": "If the change was made by a person specify the name or id of that person.", - "type": "string" - }, - "createTime": { - "description": "The time that the revision was created, internally generated by doc proto storage at the time of create.", - "format": "google-datetime", - "type": "string" - }, - "humanReview": { - "$ref": "GoogleCloudDocumentaiV1DocumentRevisionHumanReview", - "description": "Human Review information of this revision." - }, - "id": { - "description": "Id of the revision, internally generated by doc proto storage. Unique within the context of the document.", - "type": "string" - }, - "parent": { - "deprecated": true, - "description": "The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field.", - "items": { - "format": "int32", - "type": "integer" - }, - "type": "array" - }, - "parentIds": { - "description": "The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field.", + "detectedDefects": { + "description": "A list of detected defects.", "items": { - "type": "string" + "$ref": "GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect" }, "type": "array" }, - "processor": { - "description": "If the annotation was made by processor identify the processor by its resource name.", - "type": "string" + "qualityScore": { + "description": "The overall quality score. Range `[0, 1]` where `1` is perfect quality.", + "format": "float", + "type": "number" } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentRevisionHumanReview": { - "description": "Human Review information of the document.", - "id": "GoogleCloudDocumentaiV1DocumentRevisionHumanReview", + "GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect": { + "description": "Image Quality Defects", + "id": "GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect", "properties": { - "state": { - "description": "Human review state. e.g. `requested`, `succeeded`, `rejected`.", - "type": "string" + "confidence": { + "description": "Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists.", + "format": "float", + "type": "number" }, - "stateMessage": { - "description": "A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`.", + "type": { + "description": "Name of the defect type. Supported values are: - `quality/defect_blurry` - `quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `quality/defect_text_too_small` - `quality/defect_document_cutoff` - `quality/defect_text_cutoff` - `quality/defect_glare`", "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentSchema": { - "description": "The schema defines the output of the processed document by a processor.", - "id": "GoogleCloudDocumentaiV1DocumentSchema", + "GoogleCloudDocumentaiV1DocumentPageLayout": { + "description": "Visual element describing a layout unit on a page.", + "id": "GoogleCloudDocumentaiV1DocumentPageLayout", "properties": { - "description": { - "description": "Description of the schema.", - "type": "string" + "boundingPoly": { + "$ref": "GoogleCloudDocumentaiV1BoundingPoly", + "description": "The bounding polygon for the Layout." }, - "displayName": { - "description": "Display name to show to users.", - "type": "string" + "confidence": { + "description": "Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.", + "format": "float", + "type": "number" }, - "entityTypes": { - "description": "Entity types of the schema.", - "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentSchemaEntityType" - }, - "type": "array" + "orientation": { + "description": "Detected orientation for the Layout.", + "enum": [ + "ORIENTATION_UNSPECIFIED", + "PAGE_UP", + "PAGE_RIGHT", + "PAGE_DOWN", + "PAGE_LEFT" + ], + "enumDescriptions": [ + "Unspecified orientation.", + "Orientation is aligned with page up.", + "Orientation is aligned with page right. Turn the head 90 degrees clockwise from upright to read.", + "Orientation is aligned with page down. Turn the head 180 degrees from upright to read.", + "Orientation is aligned with page left. Turn the head 90 degrees counterclockwise from upright to read." + ], + "type": "string" }, - "metadata": { - "$ref": "GoogleCloudDocumentaiV1DocumentSchemaMetadata", - "description": "Metadata of the schema." + "textAnchor": { + "$ref": "GoogleCloudDocumentaiV1DocumentTextAnchor", + "description": "Text anchor indexing into the Document.text." } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentSchemaEntityType": { - "description": "EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.", - "id": "GoogleCloudDocumentaiV1DocumentSchemaEntityType", + "GoogleCloudDocumentaiV1DocumentPageLine": { + "description": "A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.", + "id": "GoogleCloudDocumentaiV1DocumentPageLine", "properties": { - "baseTypes": { - "description": "The entity type that this type is derived from. For now, one and only one should be set.", + "detectedLanguages": { + "description": "A list of detected languages together with confidence.", "items": { - "type": "string" + "$ref": "GoogleCloudDocumentaiV1DocumentPageDetectedLanguage" }, "type": "array" }, - "displayName": { - "description": "User defined name for the type.", - "type": "string" + "layout": { + "$ref": "GoogleCloudDocumentaiV1DocumentPageLayout", + "description": "Layout for Line." }, - "enumValues": { - "$ref": "GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues", - "description": "If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file." + "provenance": { + "$ref": "GoogleCloudDocumentaiV1DocumentProvenance", + "deprecated": true, + "description": "The history of this annotation." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1DocumentPageMatrix": { + "description": "Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.", + "id": "GoogleCloudDocumentaiV1DocumentPageMatrix", + "properties": { + "cols": { + "description": "Number of columns in the matrix.", + "format": "int32", + "type": "integer" }, - "name": { - "description": "Name of the type. It must be unique within the schema file and cannot be a \"Common Type\". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.", + "data": { + "description": "The matrix data.", + "format": "byte", "type": "string" }, - "properties": { - "description": "Description the nested structure, or composition of an entity.", + "rows": { + "description": "Number of rows in the matrix.", + "format": "int32", + "type": "integer" + }, + "type": { + "description": "This encodes information about what data type the matrix uses. For example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of OpenCV primitive data types, please refer to https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1DocumentPageParagraph": { + "description": "A collection of lines that a human would perceive as a paragraph.", + "id": "GoogleCloudDocumentaiV1DocumentPageParagraph", + "properties": { + "detectedLanguages": { + "description": "A list of detected languages together with confidence.", "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty" + "$ref": "GoogleCloudDocumentaiV1DocumentPageDetectedLanguage" }, "type": "array" + }, + "layout": { + "$ref": "GoogleCloudDocumentaiV1DocumentPageLayout", + "description": "Layout for Paragraph." + }, + "provenance": { + "$ref": "GoogleCloudDocumentaiV1DocumentProvenance", + "deprecated": true, + "description": "The history of this annotation." } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues": { - "description": "Defines the a list of enum values.", - "id": "GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues", + "GoogleCloudDocumentaiV1DocumentPageSymbol": { + "description": "A detected symbol.", + "id": "GoogleCloudDocumentaiV1DocumentPageSymbol", "properties": { - "values": { - "description": "The individual values that this enum values type can include.", + "detectedLanguages": { + "description": "A list of detected languages together with confidence.", "items": { - "type": "string" + "$ref": "GoogleCloudDocumentaiV1DocumentPageDetectedLanguage" }, "type": "array" + }, + "layout": { + "$ref": "GoogleCloudDocumentaiV1DocumentPageLayout", + "description": "Layout for Symbol." } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty": { - "description": "Defines properties that can be part of the entity type.", - "id": "GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty", + "GoogleCloudDocumentaiV1DocumentPageTable": { + "description": "A table representation similar to HTML table structure.", + "id": "GoogleCloudDocumentaiV1DocumentPageTable", "properties": { - "displayName": { - "description": "User defined name for the property.", - "type": "string" + "bodyRows": { + "description": "Body rows of the table.", + "items": { + "$ref": "GoogleCloudDocumentaiV1DocumentPageTableTableRow" + }, + "type": "array" }, - "method": { - "description": "Specifies how the entity's value is obtained.", - "enum": [ - "METHOD_UNSPECIFIED", - "EXTRACT", - "DERIVE" - ], - "enumDescriptions": [ - "Unspecified method. It defaults to `EXTRACT`.", - "The entity's value is directly extracted as-is from the document text.", - "The entity's value is derived through inference and is not necessarily an exact text extraction from the document." - ], - "type": "string" + "detectedLanguages": { + "description": "A list of detected languages together with confidence.", + "items": { + "$ref": "GoogleCloudDocumentaiV1DocumentPageDetectedLanguage" + }, + "type": "array" }, - "name": { - "description": "The name of the property. Follows the same guidelines as the EntityType name.", - "type": "string" + "headerRows": { + "description": "Header rows of the table.", + "items": { + "$ref": "GoogleCloudDocumentaiV1DocumentPageTableTableRow" + }, + "type": "array" }, - "occurrenceType": { - "description": "Occurrence type limits the number of instances an entity type appears in the document.", - "enum": [ - "OCCURRENCE_TYPE_UNSPECIFIED", - "OPTIONAL_ONCE", - "OPTIONAL_MULTIPLE", - "REQUIRED_ONCE", - "REQUIRED_MULTIPLE" - ], - "enumDescriptions": [ - "Unspecified occurrence type.", - "There will be zero or one instance of this entity type. The same entity instance may be mentioned multiple times.", - "The entity type will appear zero or multiple times.", - "The entity type will only appear exactly once. The same entity instance may be mentioned multiple times.", - "The entity type will appear once or more times." - ], - "type": "string" + "layout": { + "$ref": "GoogleCloudDocumentaiV1DocumentPageLayout", + "description": "Layout for Table." }, - "valueType": { - "description": "A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field.", - "type": "string" + "provenance": { + "$ref": "GoogleCloudDocumentaiV1DocumentProvenance", + "deprecated": true, + "description": "The history of this table." } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentSchemaMetadata": { - "description": "Metadata for global schema behavior.", - "id": "GoogleCloudDocumentaiV1DocumentSchemaMetadata", + "GoogleCloudDocumentaiV1DocumentPageTableTableCell": { + "description": "A cell representation inside the table.", + "id": "GoogleCloudDocumentaiV1DocumentPageTableTableCell", "properties": { - "documentAllowMultipleLabels": { - "description": "If true, on a given page, there can be multiple `document` annotations covering it.", - "type": "boolean" + "colSpan": { + "description": "How many columns this cell spans.", + "format": "int32", + "type": "integer" }, - "documentSplitter": { - "description": "If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).", - "type": "boolean" + "detectedLanguages": { + "description": "A list of detected languages together with confidence.", + "items": { + "$ref": "GoogleCloudDocumentaiV1DocumentPageDetectedLanguage" + }, + "type": "array" }, - "prefixedNamingOnProperties": { - "description": "If set, all the nested entities must be prefixed with the parents.", - "type": "boolean" + "layout": { + "$ref": "GoogleCloudDocumentaiV1DocumentPageLayout", + "description": "Layout for TableCell." }, - "skipNamingValidation": { - "description": "If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.", - "type": "boolean" - } + "rowSpan": { + "description": "How many rows this cell spans.", + "format": "int32", + "type": "integer" + } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentShardInfo": { - "description": "For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is.", - "id": "GoogleCloudDocumentaiV1DocumentShardInfo", + "GoogleCloudDocumentaiV1DocumentPageTableTableRow": { + "description": "A row of table cells.", + "id": "GoogleCloudDocumentaiV1DocumentPageTableTableRow", "properties": { - "shardCount": { - "description": "Total number of shards.", - "format": "int64", - "type": "string" + "cells": { + "description": "Cells that make up this row.", + "items": { + "$ref": "GoogleCloudDocumentaiV1DocumentPageTableTableCell" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1DocumentPageToken": { + "description": "A detected token.", + "id": "GoogleCloudDocumentaiV1DocumentPageToken", + "properties": { + "detectedBreak": { + "$ref": "GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak", + "description": "Detected break at the end of a Token." }, - "shardIndex": { - "description": "The 0-based index of this shard.", - "format": "int64", - "type": "string" + "detectedLanguages": { + "description": "A list of detected languages together with confidence.", + "items": { + "$ref": "GoogleCloudDocumentaiV1DocumentPageDetectedLanguage" + }, + "type": "array" }, - "textOffset": { - "description": "The index of the first character in Document.text in the overall document global text.", - "format": "int64", + "layout": { + "$ref": "GoogleCloudDocumentaiV1DocumentPageLayout", + "description": "Layout for Token." + }, + "provenance": { + "$ref": "GoogleCloudDocumentaiV1DocumentProvenance", + "deprecated": true, + "description": "The history of this annotation." + }, + "styleInfo": { + "$ref": "GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo", + "description": "Text style attributes." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak": { + "description": "Detected break at the end of a Token.", + "id": "GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak", + "properties": { + "type": { + "description": "Detected break type.", + "enum": [ + "TYPE_UNSPECIFIED", + "SPACE", + "WIDE_SPACE", + "HYPHEN" + ], + "enumDescriptions": [ + "Unspecified break type.", + "A single whitespace.", + "A wider whitespace.", + "A hyphen that indicates that a token has been split across lines." + ], "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentStyle": { - "description": "Annotation for common text style attributes. This adheres to CSS conventions as much as possible.", - "id": "GoogleCloudDocumentaiV1DocumentStyle", + "GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo": { + "description": "Font and other text style attributes.", + "id": "GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo", "properties": { "backgroundColor": { "$ref": "GoogleTypeColor", - "description": "Text background color." - }, - "color": { - "$ref": "GoogleTypeColor", - "description": "Text color." + "description": "Color of the background." }, - "fontFamily": { - "description": "Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/cssref/pr_font_font-family.asp", - "type": "string" + "bold": { + "description": "Whether the text is bold (equivalent to font_weight is at least `700`).", + "type": "boolean" }, "fontSize": { - "$ref": "GoogleCloudDocumentaiV1DocumentStyleFontSize", - "description": "Font size." + "description": "Font size in points (`1` point is `¹⁄₇₂` inches).", + "format": "int32", + "type": "integer" }, - "fontWeight": { - "description": "[Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`.", + "fontType": { + "description": "Name or style of the font.", "type": "string" }, - "textAnchor": { - "$ref": "GoogleCloudDocumentaiV1DocumentTextAnchor", - "description": "Text anchor indexing into the Document.text." + "fontWeight": { + "description": "TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). Normal is `400`, bold is `700`.", + "format": "int32", + "type": "integer" }, - "textDecoration": { - "description": "[Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard. ", - "type": "string" + "handwritten": { + "description": "Whether the text is handwritten.", + "type": "boolean" }, - "textStyle": { - "description": "[Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1DocumentStyleFontSize": { - "description": "Font size with unit.", - "id": "GoogleCloudDocumentaiV1DocumentStyleFontSize", - "properties": { - "size": { - "description": "Font size for the text.", - "format": "float", + "italic": { + "description": "Whether the text is italic.", + "type": "boolean" + }, + "letterSpacing": { + "description": "Letter spacing in points.", + "format": "double", "type": "number" }, - "unit": { - "description": "Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`).", - "type": "string" + "pixelFontSize": { + "description": "Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ `72.0`.", + "format": "double", + "type": "number" + }, + "smallcaps": { + "description": "Whether the text is in small caps. This feature is not supported yet.", + "type": "boolean" + }, + "strikeout": { + "description": "Whether the text is strikethrough. This feature is not supported yet.", + "type": "boolean" + }, + "subscript": { + "description": "Whether the text is a subscript. This feature is not supported yet.", + "type": "boolean" + }, + "superscript": { + "description": "Whether the text is a superscript. This feature is not supported yet.", + "type": "boolean" + }, + "textColor": { + "$ref": "GoogleTypeColor", + "description": "Color of the text." + }, + "underlined": { + "description": "Whether the text is underlined.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentTextAnchor": { - "description": "Text reference indexing into the Document.text.", - "id": "GoogleCloudDocumentaiV1DocumentTextAnchor", + "GoogleCloudDocumentaiV1DocumentPageVisualElement": { + "description": "Detected non-text visual elements e.g. checkbox, signature etc. on the page.", + "id": "GoogleCloudDocumentaiV1DocumentPageVisualElement", "properties": { - "content": { - "description": "Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.", - "type": "string" - }, - "textSegments": { - "description": "The text segments from the Document.text.", + "detectedLanguages": { + "description": "A list of detected languages together with confidence.", "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment" + "$ref": "GoogleCloudDocumentaiV1DocumentPageDetectedLanguage" }, "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment": { - "description": "A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset", - "id": "GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment", - "properties": { - "endIndex": { - "description": "TextSegment half open end UTF-8 char index in the Document.text.", - "format": "int64", - "type": "string" }, - "startIndex": { - "description": "TextSegment start UTF-8 char index in the Document.text.", - "format": "int64", + "layout": { + "$ref": "GoogleCloudDocumentaiV1DocumentPageLayout", + "description": "Layout for VisualElement." + }, + "type": { + "description": "Type of the VisualElement.", "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1DocumentTextChange": { - "description": "This message is used for text changes aka. OCR corrections.", - "id": "GoogleCloudDocumentaiV1DocumentTextChange", + "GoogleCloudDocumentaiV1DocumentProvenance": { + "description": "Structure to identify provenance relationships between annotations in different revisions.", + "id": "GoogleCloudDocumentaiV1DocumentProvenance", "properties": { - "changedText": { - "description": "The text that replaces the text identified in the `text_anchor`.", - "type": "string" - }, - "provenance": { + "id": { "deprecated": true, - "description": "The history of this annotation.", + "description": "The Id of this operation. Needs to be unique within the scope of the revision.", + "format": "int32", + "type": "integer" + }, + "parents": { + "description": "References to the original elements that are replaced.", "items": { - "$ref": "GoogleCloudDocumentaiV1DocumentProvenance" + "$ref": "GoogleCloudDocumentaiV1DocumentProvenanceParent" }, "type": "array" }, - "textAnchor": { - "$ref": "GoogleCloudDocumentaiV1DocumentTextAnchor", - "description": "Provenance of the correction. Text anchor indexing into the Document.text. There can only be a single `TextAnchor.text_segments` element. If the start and end index of the text segment are the same, the text change is inserted before that index." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1EnableProcessorMetadata": { - "description": "The long-running operation metadata for the EnableProcessor method.", - "id": "GoogleCloudDocumentaiV1EnableProcessorMetadata", - "properties": { - "commonMetadata": { - "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", - "description": "The basic metadata of the long-running operation." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1EnableProcessorRequest": { - "description": "Request message for the EnableProcessor method.", - "id": "GoogleCloudDocumentaiV1EnableProcessorRequest", - "properties": {}, - "type": "object" - }, - "GoogleCloudDocumentaiV1EnableProcessorResponse": { - "description": "Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future.", - "id": "GoogleCloudDocumentaiV1EnableProcessorResponse", - "properties": {}, - "type": "object" - }, - "GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata": { - "description": "Metadata of the EvaluateProcessorVersion method.", - "id": "GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata", - "properties": { - "commonMetadata": { - "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", - "description": "The basic metadata of the long-running operation." + "revision": { + "deprecated": true, + "description": "The index of the revision that produced this element.", + "format": "int32", + "type": "integer" + }, + "type": { + "description": "The type of provenance operation.", + "enum": [ + "OPERATION_TYPE_UNSPECIFIED", + "ADD", + "REMOVE", + "UPDATE", + "REPLACE", + "EVAL_REQUESTED", + "EVAL_APPROVED", + "EVAL_SKIPPED" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + true, + true, + true + ], + "enumDescriptions": [ + "Operation type unspecified. If no operation is specified a provenance entry is simply used to match against a `parent`.", + "Add an element.", + "Remove an element identified by `parent`.", + "Updates any fields within the given provenance scope of the message. It overwrites the fields rather than replacing them. Use this when you want to update a field value of an entity without also updating all the child properties.", + "Currently unused. Replace an element identified by `parent`.", + "Deprecated. Request human review for the element identified by `parent`.", + "Deprecated. Element is reviewed and approved at human review, confidence will be set to 1.0.", + "Deprecated. Element is skipped in the validation process." + ], + "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest": { - "description": "Evaluates the given ProcessorVersion against the supplied documents.", - "id": "GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest", + "GoogleCloudDocumentaiV1DocumentProvenanceParent": { + "description": "The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.", + "id": "GoogleCloudDocumentaiV1DocumentProvenanceParent", "properties": { - "evaluationDocuments": { - "$ref": "GoogleCloudDocumentaiV1BatchDocumentsInputConfig", - "description": "Optional. The documents used in the evaluation. If unspecified, use the processor's dataset as evaluation input." + "id": { + "deprecated": true, + "description": "The id of the parent provenance.", + "format": "int32", + "type": "integer" + }, + "index": { + "description": "The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.", + "format": "int32", + "type": "integer" + }, + "revision": { + "description": "The index of the index into current revision's parent_ids list.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse": { - "description": "Response of the EvaluateProcessorVersion method.", - "id": "GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse", + "GoogleCloudDocumentaiV1DocumentRevision": { + "description": "Contains past or forward revisions of this document.", + "id": "GoogleCloudDocumentaiV1DocumentRevision", "properties": { - "evaluation": { - "description": "The resource name of the created evaluation.", + "agent": { + "description": "If the change was made by a person specify the name or id of that person.", "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1Evaluation": { - "description": "An evaluation of a ProcessorVersion's performance.", - "id": "GoogleCloudDocumentaiV1Evaluation", - "properties": { - "allEntitiesMetrics": { - "$ref": "GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics", - "description": "Metrics for all the entities in aggregate." }, "createTime": { - "description": "The time that the evaluation was created.", + "description": "The time that the revision was created, internally generated by doc proto storage at the time of create.", "format": "google-datetime", "type": "string" }, - "documentCounters": { - "$ref": "GoogleCloudDocumentaiV1EvaluationCounters", - "description": "Counters for the documents used in the evaluation." - }, - "entityMetrics": { - "additionalProperties": { - "$ref": "GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics" - }, - "description": "Metrics across confidence levels, for different entities.", - "type": "object" + "humanReview": { + "$ref": "GoogleCloudDocumentaiV1DocumentRevisionHumanReview", + "description": "Human Review information of this revision." }, - "kmsKeyName": { - "description": "The KMS key name used for encryption.", + "id": { + "description": "Id of the revision, internally generated by doc proto storage. Unique within the context of the document.", "type": "string" }, - "kmsKeyVersionName": { - "description": "The KMS key version with which data is encrypted.", - "type": "string" + "parent": { + "deprecated": true, + "description": "The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" }, - "name": { - "description": "The resource name of the evaluation. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}`", + "parentIds": { + "description": "The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field.", + "items": { + "type": "string" + }, + "type": "array" + }, + "processor": { + "description": "If the annotation was made by processor identify the processor by its resource name.", "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics": { - "description": "Evaluations metrics, at a specific confidence level.", - "id": "GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics", + "GoogleCloudDocumentaiV1DocumentRevisionHumanReview": { + "description": "Human Review information of the document.", + "id": "GoogleCloudDocumentaiV1DocumentRevisionHumanReview", "properties": { - "confidenceLevel": { - "description": "The confidence level.", - "format": "float", - "type": "number" + "state": { + "description": "Human review state. e.g. `requested`, `succeeded`, `rejected`.", + "type": "string" }, - "metrics": { - "$ref": "GoogleCloudDocumentaiV1EvaluationMetrics", - "description": "The metrics at the specific confidence level." + "stateMessage": { + "description": "A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1EvaluationCounters": { - "description": "Evaluation counters for the documents that were used.", - "id": "GoogleCloudDocumentaiV1EvaluationCounters", + "GoogleCloudDocumentaiV1DocumentSchema": { + "description": "The schema defines the output of the processed document by a processor.", + "id": "GoogleCloudDocumentaiV1DocumentSchema", "properties": { - "evaluatedDocumentsCount": { - "description": "How many documents were used in the evaluation.", - "format": "int32", - "type": "integer" + "description": { + "description": "Description of the schema.", + "type": "string" }, - "failedDocumentsCount": { - "description": "How many documents were not included in the evaluation as Document AI failed to process them.", - "format": "int32", - "type": "integer" + "displayName": { + "description": "Display name to show to users.", + "type": "string" }, - "inputDocumentsCount": { - "description": "How many documents were sent for evaluation.", - "format": "int32", - "type": "integer" + "entityTypes": { + "description": "Entity types of the schema.", + "items": { + "$ref": "GoogleCloudDocumentaiV1DocumentSchemaEntityType" + }, + "type": "array" }, - "invalidDocumentsCount": { - "description": "How many documents were not included in the evaluation as they didn't pass validation.", - "format": "int32", - "type": "integer" + "metadata": { + "$ref": "GoogleCloudDocumentaiV1DocumentSchemaMetadata", + "description": "Metadata of the schema." } }, "type": "object" }, - "GoogleCloudDocumentaiV1EvaluationMetrics": { - "description": "Evaluation metrics, either in aggregate or about a specific entity.", - "id": "GoogleCloudDocumentaiV1EvaluationMetrics", + "GoogleCloudDocumentaiV1DocumentSchemaEntityType": { + "description": "EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.", + "id": "GoogleCloudDocumentaiV1DocumentSchemaEntityType", "properties": { - "f1Score": { - "description": "The calculated f1 score.", - "format": "float", - "type": "number" - }, - "falseNegativesCount": { - "description": "The amount of false negatives.", - "format": "int32", - "type": "integer" - }, - "falsePositivesCount": { - "description": "The amount of false positives.", - "format": "int32", - "type": "integer" - }, - "groundTruthDocumentCount": { - "description": "The amount of documents with a ground truth occurrence.", - "format": "int32", - "type": "integer" - }, - "groundTruthOccurrencesCount": { - "description": "The amount of occurrences in ground truth documents.", - "format": "int32", - "type": "integer" - }, - "precision": { - "description": "The calculated precision.", - "format": "float", - "type": "number" + "baseTypes": { + "description": "The entity type that this type is derived from. For now, one and only one should be set.", + "items": { + "type": "string" + }, + "type": "array" }, - "predictedDocumentCount": { - "description": "The amount of documents with a predicted occurrence.", - "format": "int32", - "type": "integer" + "displayName": { + "description": "User defined name for the type.", + "type": "string" }, - "predictedOccurrencesCount": { - "description": "The amount of occurrences in predicted documents.", - "format": "int32", - "type": "integer" + "enumValues": { + "$ref": "GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues", + "description": "If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file." }, - "recall": { - "description": "The calculated recall.", - "format": "float", - "type": "number" + "name": { + "description": "Name of the type. It must be unique within the schema file and cannot be a \"Common Type\". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.", + "type": "string" }, - "totalDocumentsCount": { - "description": "The amount of documents that had an occurrence of this label.", - "format": "int32", - "type": "integer" - }, - "truePositivesCount": { - "description": "The amount of true positives.", - "format": "int32", - "type": "integer" + "properties": { + "description": "Description the nested structure, or composition of an entity.", + "items": { + "$ref": "GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics": { - "description": "Metrics across multiple confidence levels.", - "id": "GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics", + "GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues": { + "description": "Defines the a list of enum values.", + "id": "GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues", "properties": { - "auprc": { - "description": "The calculated area under the precision recall curve (AUPRC), computed by integrating over all confidence thresholds.", - "format": "float", - "type": "number" - }, - "auprcExact": { - "description": "The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching only.", - "format": "float", - "type": "number" - }, - "confidenceLevelMetrics": { - "description": "Metrics across confidence levels with fuzzy matching enabled.", - "items": { - "$ref": "GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics" - }, - "type": "array" - }, - "confidenceLevelMetricsExact": { - "description": "Metrics across confidence levels with only exact matching.", + "values": { + "description": "The individual values that this enum values type can include.", "items": { - "$ref": "GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics" + "type": "string" }, "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty": { + "description": "Defines properties that can be part of the entity type.", + "id": "GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty", + "properties": { + "displayName": { + "description": "User defined name for the property.", + "type": "string" }, - "estimatedCalibrationError": { - "description": "The Estimated Calibration Error (ECE) of the confidence of the predicted entities.", - "format": "float", - "type": "number" + "method": { + "description": "Specifies how the entity's value is obtained.", + "enum": [ + "METHOD_UNSPECIFIED", + "EXTRACT", + "DERIVE" + ], + "enumDescriptions": [ + "Unspecified method. It defaults to `EXTRACT`.", + "The entity's value is directly extracted as-is from the document text.", + "The entity's value is derived through inference and is not necessarily an exact text extraction from the document." + ], + "type": "string" }, - "estimatedCalibrationErrorExact": { - "description": "The ECE for the predicted entities with fuzzy matching disabled, i.e., exact matching only.", - "format": "float", - "type": "number" + "name": { + "description": "The name of the property. Follows the same guidelines as the EntityType name.", + "type": "string" }, - "metricsType": { - "description": "The metrics type for the label.", + "occurrenceType": { + "description": "Occurrence type limits the number of instances an entity type appears in the document.", "enum": [ - "METRICS_TYPE_UNSPECIFIED", - "AGGREGATE" + "OCCURRENCE_TYPE_UNSPECIFIED", + "OPTIONAL_ONCE", + "OPTIONAL_MULTIPLE", + "REQUIRED_ONCE", + "REQUIRED_MULTIPLE" ], "enumDescriptions": [ - "The metrics type is unspecified. By default, metrics without a particular specification are for leaf entity types (i.e., top-level entity types without child types, or child types which are not parent types themselves).", - "Indicates whether metrics for this particular label type represent an aggregate of metrics for other types instead of being based on actual TP/FP/FN values for the label type. Metrics for parent (i.e., non-leaf) entity types are an aggregate of metrics for their children." + "Unspecified occurrence type.", + "There will be zero or one instance of this entity type. The same entity instance may be mentioned multiple times.", + "The entity type will appear zero or multiple times.", + "The entity type will only appear exactly once. The same entity instance may be mentioned multiple times.", + "The entity type will appear once or more times." ], "type": "string" + }, + "valueType": { + "description": "A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1EvaluationReference": { - "description": "Gives a short summary of an evaluation, and links to the evaluation itself.", - "id": "GoogleCloudDocumentaiV1EvaluationReference", + "GoogleCloudDocumentaiV1DocumentSchemaMetadata": { + "description": "Metadata for global schema behavior.", + "id": "GoogleCloudDocumentaiV1DocumentSchemaMetadata", "properties": { - "aggregateMetrics": { - "$ref": "GoogleCloudDocumentaiV1EvaluationMetrics", - "description": "An aggregate of the statistics for the evaluation with fuzzy matching on." + "documentAllowMultipleLabels": { + "description": "If true, on a given page, there can be multiple `document` annotations covering it.", + "type": "boolean" }, - "aggregateMetricsExact": { - "$ref": "GoogleCloudDocumentaiV1EvaluationMetrics", - "description": "An aggregate of the statistics for the evaluation with fuzzy matching off." + "documentSplitter": { + "description": "If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).", + "type": "boolean" }, - "evaluation": { - "description": "The resource name of the evaluation.", + "prefixedNamingOnProperties": { + "description": "If set, all the nested entities must be prefixed with the parents.", + "type": "boolean" + }, + "skipNamingValidation": { + "description": "If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1DocumentShardInfo": { + "description": "For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is.", + "id": "GoogleCloudDocumentaiV1DocumentShardInfo", + "properties": { + "shardCount": { + "description": "Total number of shards.", + "format": "int64", "type": "string" }, - "operation": { - "description": "The resource name of the Long Running Operation for the evaluation.", + "shardIndex": { + "description": "The 0-based index of this shard.", + "format": "int64", + "type": "string" + }, + "textOffset": { + "description": "The index of the first character in Document.text in the overall document global text.", + "format": "int64", "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1FetchProcessorTypesResponse": { - "description": "Response message for the FetchProcessorTypes method.", - "id": "GoogleCloudDocumentaiV1FetchProcessorTypesResponse", + "GoogleCloudDocumentaiV1DocumentStyle": { + "description": "Annotation for common text style attributes. This adheres to CSS conventions as much as possible.", + "id": "GoogleCloudDocumentaiV1DocumentStyle", "properties": { - "processorTypes": { - "description": "The list of processor types.", - "items": { - "$ref": "GoogleCloudDocumentaiV1ProcessorType" - }, - "type": "array" + "backgroundColor": { + "$ref": "GoogleTypeColor", + "description": "Text background color." + }, + "color": { + "$ref": "GoogleTypeColor", + "description": "Text color." + }, + "fontFamily": { + "description": "Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/cssref/pr_font_font-family.asp", + "type": "string" + }, + "fontSize": { + "$ref": "GoogleCloudDocumentaiV1DocumentStyleFontSize", + "description": "Font size." + }, + "fontWeight": { + "description": "[Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`.", + "type": "string" + }, + "textAnchor": { + "$ref": "GoogleCloudDocumentaiV1DocumentTextAnchor", + "description": "Text anchor indexing into the Document.text." + }, + "textDecoration": { + "description": "[Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard. ", + "type": "string" + }, + "textStyle": { + "description": "[Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1GcsDocument": { - "description": "Specifies a document stored on Cloud Storage.", - "id": "GoogleCloudDocumentaiV1GcsDocument", + "GoogleCloudDocumentaiV1DocumentStyleFontSize": { + "description": "Font size with unit.", + "id": "GoogleCloudDocumentaiV1DocumentStyleFontSize", "properties": { - "gcsUri": { - "description": "The Cloud Storage object uri.", - "type": "string" + "size": { + "description": "Font size for the text.", + "format": "float", + "type": "number" }, - "mimeType": { - "description": "An IANA MIME type (RFC6838) of the content.", + "unit": { + "description": "Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`).", "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1GcsDocuments": { - "description": "Specifies a set of documents on Cloud Storage.", - "id": "GoogleCloudDocumentaiV1GcsDocuments", + "GoogleCloudDocumentaiV1DocumentTextAnchor": { + "description": "Text reference indexing into the Document.text.", + "id": "GoogleCloudDocumentaiV1DocumentTextAnchor", "properties": { - "documents": { - "description": "The list of documents.", + "content": { + "description": "Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.", + "type": "string" + }, + "textSegments": { + "description": "The text segments from the Document.text.", "items": { - "$ref": "GoogleCloudDocumentaiV1GcsDocument" + "$ref": "GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDocumentaiV1GcsPrefix": { - "description": "Specifies all documents on Cloud Storage with a common prefix.", - "id": "GoogleCloudDocumentaiV1GcsPrefix", + "GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment": { + "description": "A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset", + "id": "GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment", "properties": { - "gcsUriPrefix": { - "description": "The URI prefix.", + "endIndex": { + "description": "TextSegment half open end UTF-8 char index in the Document.text.", + "format": "int64", + "type": "string" + }, + "startIndex": { + "description": "TextSegment start UTF-8 char index in the Document.text.", + "format": "int64", "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1HumanReviewStatus": { - "description": "The status of human review on a processed document.", - "id": "GoogleCloudDocumentaiV1HumanReviewStatus", + "GoogleCloudDocumentaiV1DocumentTextChange": { + "description": "This message is used for text changes aka. OCR corrections.", + "id": "GoogleCloudDocumentaiV1DocumentTextChange", "properties": { - "humanReviewOperation": { - "description": "The name of the operation triggered by the processed document. This field is populated only when the state is `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as the long-running operation returned by ReviewDocument.", + "changedText": { + "description": "The text that replaces the text identified in the `text_anchor`.", "type": "string" }, - "state": { - "description": "The state of human review on the processing request.", - "enum": [ - "STATE_UNSPECIFIED", - "SKIPPED", - "VALIDATION_PASSED", - "IN_PROGRESS", - "ERROR" - ], - "enumDescriptions": [ - "Human review state is unspecified. Most likely due to an internal error.", - "Human review is skipped for the document. This can happen because human review isn't enabled on the processor or the processing request has been set to skip this document.", - "Human review validation is triggered and passed, so no review is needed.", - "Human review validation is triggered and the document is under review.", - "Some error happened during triggering human review, see the state_message for details." - ], - "type": "string" + "provenance": { + "deprecated": true, + "description": "The history of this annotation.", + "items": { + "$ref": "GoogleCloudDocumentaiV1DocumentProvenance" + }, + "type": "array" }, - "stateMessage": { - "description": "A message providing more details about the human review state.", - "type": "string" + "textAnchor": { + "$ref": "GoogleCloudDocumentaiV1DocumentTextAnchor", + "description": "Provenance of the correction. Text anchor indexing into the Document.text. There can only be a single `TextAnchor.text_segments` element. If the start and end index of the text segment are the same, the text change is inserted before that index." } }, "type": "object" }, - "GoogleCloudDocumentaiV1ListEvaluationsResponse": { - "description": "The response from `ListEvaluations`.", - "id": "GoogleCloudDocumentaiV1ListEvaluationsResponse", + "GoogleCloudDocumentaiV1Documents": { + "description": "A set of inline documents.", + "id": "GoogleCloudDocumentaiV1Documents", "properties": { - "evaluations": { - "description": "The evaluations requested.", + "documents": { + "description": "The list of documents.", "items": { - "$ref": "GoogleCloudDocumentaiV1Evaluation" + "$ref": "GoogleCloudDocumentaiV1Document" }, "type": "array" - }, - "nextPageToken": { - "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", - "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1ListProcessorTypesResponse": { - "description": "Response message for the ListProcessorTypes method.", - "id": "GoogleCloudDocumentaiV1ListProcessorTypesResponse", + "GoogleCloudDocumentaiV1EnableProcessorMetadata": { + "description": "The long-running operation metadata for the EnableProcessor method.", + "id": "GoogleCloudDocumentaiV1EnableProcessorMetadata", "properties": { - "nextPageToken": { - "description": "Points to the next page, otherwise empty.", - "type": "string" - }, - "processorTypes": { - "description": "The processor types.", - "items": { - "$ref": "GoogleCloudDocumentaiV1ProcessorType" - }, - "type": "array" + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, - "GoogleCloudDocumentaiV1ListProcessorVersionsResponse": { - "description": "Response message for the ListProcessorVersions method.", - "id": "GoogleCloudDocumentaiV1ListProcessorVersionsResponse", + "GoogleCloudDocumentaiV1EnableProcessorRequest": { + "description": "Request message for the EnableProcessor method.", + "id": "GoogleCloudDocumentaiV1EnableProcessorRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudDocumentaiV1EnableProcessorResponse": { + "description": "Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future.", + "id": "GoogleCloudDocumentaiV1EnableProcessorResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata": { + "description": "Metadata of the EvaluateProcessorVersion method.", + "id": "GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata", "properties": { - "nextPageToken": { - "description": "Points to the next processor, otherwise empty.", - "type": "string" - }, - "processorVersions": { - "description": "The list of processors.", - "items": { - "$ref": "GoogleCloudDocumentaiV1ProcessorVersion" - }, - "type": "array" + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, - "GoogleCloudDocumentaiV1ListProcessorsResponse": { - "description": "Response message for the ListProcessors method.", - "id": "GoogleCloudDocumentaiV1ListProcessorsResponse", + "GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest": { + "description": "Evaluates the given ProcessorVersion against the supplied documents.", + "id": "GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest", "properties": { - "nextPageToken": { - "description": "Points to the next processor, otherwise empty.", - "type": "string" - }, - "processors": { - "description": "The list of processors.", - "items": { - "$ref": "GoogleCloudDocumentaiV1Processor" - }, - "type": "array" + "evaluationDocuments": { + "$ref": "GoogleCloudDocumentaiV1BatchDocumentsInputConfig", + "description": "Optional. The documents used in the evaluation. If unspecified, use the processor's dataset as evaluation input." } }, "type": "object" }, - "GoogleCloudDocumentaiV1NormalizedVertex": { - "description": "A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.", - "id": "GoogleCloudDocumentaiV1NormalizedVertex", + "GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse": { + "description": "Response of the EvaluateProcessorVersion method.", + "id": "GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse", "properties": { - "x": { - "description": "X coordinate.", - "format": "float", - "type": "number" - }, - "y": { - "description": "Y coordinate (starts from the top of the image).", - "format": "float", - "type": "number" + "evaluation": { + "description": "The resource name of the created evaluation.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1OcrConfig": { - "description": "Config for Document OCR.", - "id": "GoogleCloudDocumentaiV1OcrConfig", + "GoogleCloudDocumentaiV1Evaluation": { + "description": "An evaluation of a ProcessorVersion's performance.", + "id": "GoogleCloudDocumentaiV1Evaluation", "properties": { - "advancedOcrOptions": { - "description": "A list of advanced OCR options to further fine-tune OCR behavior. Current valid values are: - `legacy_layout`: a heuristics layout detection algorithm, which serves as an alternative to the current ML-based layout detection algorithm. Customers can choose the best suitable layout algorithm based on their situation.", - "items": { - "type": "string" - }, - "type": "array" - }, - "computeStyleInfo": { - "deprecated": true, - "description": "Turn on font identification model and return font style information. Deprecated, use PremiumFeatures.compute_style_info instead.", - "type": "boolean" + "allEntitiesMetrics": { + "$ref": "GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics", + "description": "Metrics for all the entities in aggregate." }, - "disableCharacterBoxesDetection": { - "description": "Turn off character box detector in OCR engine. Character box detection is enabled by default in OCR 2.0 (and later) processors.", - "type": "boolean" + "createTime": { + "description": "The time that the evaluation was created.", + "format": "google-datetime", + "type": "string" }, - "enableImageQualityScores": { - "description": "Enables intelligent document quality scores after OCR. Can help with diagnosing why OCR responses are of poor quality for a given input. Adds additional latency comparable to regular OCR to the process call.", - "type": "boolean" + "documentCounters": { + "$ref": "GoogleCloudDocumentaiV1EvaluationCounters", + "description": "Counters for the documents used in the evaluation." }, - "enableNativePdfParsing": { - "description": "Enables special handling for PDFs with existing text information. Results in better text extraction quality in such PDF inputs.", - "type": "boolean" + "entityMetrics": { + "additionalProperties": { + "$ref": "GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics" + }, + "description": "Metrics across confidence levels, for different entities.", + "type": "object" }, - "enableSymbol": { - "description": "Includes symbol level OCR information if set to true.", - "type": "boolean" + "kmsKeyName": { + "description": "The KMS key name used for encryption.", + "type": "string" }, - "hints": { - "$ref": "GoogleCloudDocumentaiV1OcrConfigHints", - "description": "Hints for the OCR model." + "kmsKeyVersionName": { + "description": "The KMS key version with which data is encrypted.", + "type": "string" }, - "premiumFeatures": { - "$ref": "GoogleCloudDocumentaiV1OcrConfigPremiumFeatures", - "description": "Configurations for premium OCR features." + "name": { + "description": "The resource name of the evaluation. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}`", + "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1OcrConfigHints": { - "description": "Hints for OCR Engine", - "id": "GoogleCloudDocumentaiV1OcrConfigHints", + "GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics": { + "description": "Evaluations metrics, at a specific confidence level.", + "id": "GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics", "properties": { - "languageHints": { - "description": "List of BCP-47 language codes to use for OCR. In most cases, not specifying it yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting hints is not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a significant hindrance if the hint is wrong).", - "items": { - "type": "string" - }, - "type": "array" + "confidenceLevel": { + "description": "The confidence level.", + "format": "float", + "type": "number" + }, + "metrics": { + "$ref": "GoogleCloudDocumentaiV1EvaluationMetrics", + "description": "The metrics at the specific confidence level." } }, "type": "object" }, - "GoogleCloudDocumentaiV1OcrConfigPremiumFeatures": { - "description": "Configurations for premium OCR features.", - "id": "GoogleCloudDocumentaiV1OcrConfigPremiumFeatures", + "GoogleCloudDocumentaiV1EvaluationCounters": { + "description": "Evaluation counters for the documents that were used.", + "id": "GoogleCloudDocumentaiV1EvaluationCounters", "properties": { - "computeStyleInfo": { - "description": "Turn on font identification model and return font style information.", - "type": "boolean" + "evaluatedDocumentsCount": { + "description": "How many documents were used in the evaluation.", + "format": "int32", + "type": "integer" }, - "enableMathOcr": { - "description": "Turn on the model that can extract LaTeX math formulas.", - "type": "boolean" + "failedDocumentsCount": { + "description": "How many documents were not included in the evaluation as Document AI failed to process them.", + "format": "int32", + "type": "integer" }, - "enableSelectionMarkDetection": { - "description": "Turn on selection mark detector in OCR engine. Only available in OCR 2.0 (and later) processors.", - "type": "boolean" + "inputDocumentsCount": { + "description": "How many documents were sent for evaluation.", + "format": "int32", + "type": "integer" + }, + "invalidDocumentsCount": { + "description": "How many documents were not included in the evaluation as they didn't pass validation.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GoogleCloudDocumentaiV1ProcessOptions": { - "description": "Options for Process API", - "id": "GoogleCloudDocumentaiV1ProcessOptions", + "GoogleCloudDocumentaiV1EvaluationMetrics": { + "description": "Evaluation metrics, either in aggregate or about a specific entity.", + "id": "GoogleCloudDocumentaiV1EvaluationMetrics", "properties": { - "fromEnd": { - "description": "Only process certain pages from the end, same as above.", + "f1Score": { + "description": "The calculated f1 score.", + "format": "float", + "type": "number" + }, + "falseNegativesCount": { + "description": "The amount of false negatives.", "format": "int32", "type": "integer" }, - "fromStart": { - "description": "Only process certain pages from the start. Process all if the document has fewer pages.", + "falsePositivesCount": { + "description": "The amount of false positives.", "format": "int32", "type": "integer" }, - "individualPageSelector": { - "$ref": "GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector", - "description": "Which pages to process (1-indexed)." - }, - "layoutConfig": { - "$ref": "GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig", - "description": "Optional. Only applicable to `LAYOUT_PARSER_PROCESSOR`. Returns error if set on other processor types." + "groundTruthDocumentCount": { + "description": "The amount of documents with a ground truth occurrence.", + "format": "int32", + "type": "integer" }, - "ocrConfig": { - "$ref": "GoogleCloudDocumentaiV1OcrConfig", - "description": "Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. Returns error if set on other processor types." + "groundTruthOccurrencesCount": { + "description": "The amount of occurrences in ground truth documents.", + "format": "int32", + "type": "integer" }, - "schemaOverride": { - "$ref": "GoogleCloudDocumentaiV1DocumentSchema", - "description": "Optional. Override the schema of the ProcessorVersion. Will return an Invalid Argument error if this field is set when the underlying ProcessorVersion doesn't support schema override." + "precision": { + "description": "The calculated precision.", + "format": "float", + "type": "number" + }, + "predictedDocumentCount": { + "description": "The amount of documents with a predicted occurrence.", + "format": "int32", + "type": "integer" + }, + "predictedOccurrencesCount": { + "description": "The amount of occurrences in predicted documents.", + "format": "int32", + "type": "integer" + }, + "recall": { + "description": "The calculated recall.", + "format": "float", + "type": "number" + }, + "totalDocumentsCount": { + "description": "The amount of documents that had an occurrence of this label.", + "format": "int32", + "type": "integer" + }, + "truePositivesCount": { + "description": "The amount of true positives.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector": { - "description": "A list of individual page numbers.", - "id": "GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector", + "GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics": { + "description": "Metrics across multiple confidence levels.", + "id": "GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics", "properties": { - "pages": { - "description": "Optional. Indices of the pages (starting from 1).", + "auprc": { + "description": "The calculated area under the precision recall curve (AUPRC), computed by integrating over all confidence thresholds.", + "format": "float", + "type": "number" + }, + "auprcExact": { + "description": "The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching only.", + "format": "float", + "type": "number" + }, + "confidenceLevelMetrics": { + "description": "Metrics across confidence levels with fuzzy matching enabled.", "items": { - "format": "int32", - "type": "integer" + "$ref": "GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics" + }, + "type": "array" + }, + "confidenceLevelMetricsExact": { + "description": "Metrics across confidence levels with only exact matching.", + "items": { + "$ref": "GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics" }, "type": "array" + }, + "estimatedCalibrationError": { + "description": "The Estimated Calibration Error (ECE) of the confidence of the predicted entities.", + "format": "float", + "type": "number" + }, + "estimatedCalibrationErrorExact": { + "description": "The ECE for the predicted entities with fuzzy matching disabled, i.e., exact matching only.", + "format": "float", + "type": "number" + }, + "metricsType": { + "description": "The metrics type for the label.", + "enum": [ + "METRICS_TYPE_UNSPECIFIED", + "AGGREGATE" + ], + "enumDescriptions": [ + "The metrics type is unspecified. By default, metrics without a particular specification are for leaf entity types (i.e., top-level entity types without child types, or child types which are not parent types themselves).", + "Indicates whether metrics for this particular label type represent an aggregate of metrics for other types instead of being based on actual TP/FP/FN values for the label type. Metrics for parent (i.e., non-leaf) entity types are an aggregate of metrics for their children." + ], + "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig": { - "description": "Serving config for layout parser processor.", - "id": "GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig", + "GoogleCloudDocumentaiV1EvaluationReference": { + "description": "Gives a short summary of an evaluation, and links to the evaluation itself.", + "id": "GoogleCloudDocumentaiV1EvaluationReference", "properties": { - "chunkingConfig": { - "$ref": "GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig", - "description": "Optional. Config for chunking in layout parser processor." + "aggregateMetrics": { + "$ref": "GoogleCloudDocumentaiV1EvaluationMetrics", + "description": "An aggregate of the statistics for the evaluation with fuzzy matching on." }, - "returnBoundingBoxes": { - "description": "Optional. Whether to include bounding boxes in layout parser processor response.", - "type": "boolean" + "aggregateMetricsExact": { + "$ref": "GoogleCloudDocumentaiV1EvaluationMetrics", + "description": "An aggregate of the statistics for the evaluation with fuzzy matching off." }, - "returnImages": { - "description": "Optional. Whether to include images in layout parser processor response.", - "type": "boolean" + "evaluation": { + "description": "The resource name of the evaluation.", + "type": "string" + }, + "operation": { + "description": "The resource name of the Long Running Operation for the evaluation.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig": { - "description": "Serving config for chunking.", - "id": "GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig", + "GoogleCloudDocumentaiV1FetchProcessorTypesResponse": { + "description": "Response message for the FetchProcessorTypes method.", + "id": "GoogleCloudDocumentaiV1FetchProcessorTypesResponse", "properties": { - "chunkSize": { - "description": "Optional. The chunk sizes to use when splitting documents, in order of level.", - "format": "int32", - "type": "integer" - }, - "includeAncestorHeadings": { - "description": "Optional. Whether or not to include ancestor headings when splitting.", - "type": "boolean" + "processorTypes": { + "description": "The list of processor types.", + "items": { + "$ref": "GoogleCloudDocumentaiV1ProcessorType" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDocumentaiV1ProcessRequest": { - "description": "Request message for the ProcessDocument method.", - "id": "GoogleCloudDocumentaiV1ProcessRequest", + "GoogleCloudDocumentaiV1GcsDocument": { + "description": "Specifies a document stored on Cloud Storage.", + "id": "GoogleCloudDocumentaiV1GcsDocument", "properties": { - "fieldMask": { - "description": "Specifies which fields to include in the ProcessResponse.document output. Only supports top-level document and pages field, so it must be in the form of `{document_field_name}` or `pages.{page_field_name}`.", - "format": "google-fieldmask", + "gcsUri": { + "description": "The Cloud Storage object uri.", "type": "string" }, - "gcsDocument": { - "$ref": "GoogleCloudDocumentaiV1GcsDocument", - "description": "A raw document on Google Cloud Storage." - }, - "imagelessMode": { - "description": "Optional. Option to remove images from the document.", - "type": "boolean" - }, - "inlineDocument": { - "$ref": "GoogleCloudDocumentaiV1Document", - "description": "An inline document proto." - }, - "labels": { - "additionalProperties": { - "type": "string" + "mimeType": { + "description": "An IANA MIME type (RFC6838) of the content.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1GcsDocuments": { + "description": "Specifies a set of documents on Cloud Storage.", + "id": "GoogleCloudDocumentaiV1GcsDocuments", + "properties": { + "documents": { + "description": "The list of documents.", + "items": { + "$ref": "GoogleCloudDocumentaiV1GcsDocument" }, - "description": "Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.", - "type": "object" - }, - "processOptions": { - "$ref": "GoogleCloudDocumentaiV1ProcessOptions", - "description": "Inference-time options for the process API" - }, - "rawDocument": { - "$ref": "GoogleCloudDocumentaiV1RawDocument", - "description": "A raw document content (bytes)." - }, - "skipHumanReview": { - "description": "Whether human review should be skipped for this request. Default to `false`.", - "type": "boolean" + "type": "array" } }, "type": "object" }, - "GoogleCloudDocumentaiV1ProcessResponse": { - "description": "Response message for the ProcessDocument method.", - "id": "GoogleCloudDocumentaiV1ProcessResponse", + "GoogleCloudDocumentaiV1GcsPrefix": { + "description": "Specifies all documents on Cloud Storage with a common prefix.", + "id": "GoogleCloudDocumentaiV1GcsPrefix", "properties": { - "document": { - "$ref": "GoogleCloudDocumentaiV1Document", - "description": "The document payload, will populate fields based on the processor's behavior." - }, - "humanReviewStatus": { - "$ref": "GoogleCloudDocumentaiV1HumanReviewStatus", - "description": "The status of human review on the processed document." + "gcsUriPrefix": { + "description": "The URI prefix.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1Processor": { - "description": "The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.", - "id": "GoogleCloudDocumentaiV1Processor", + "GoogleCloudDocumentaiV1GenerateSchemaVersionRequest": { + "description": "Request message for GenerateSchemaVersion.", + "id": "GoogleCloudDocumentaiV1GenerateSchemaVersionRequest", "properties": { - "createTime": { - "description": "Output only. The time the processor was created.", - "format": "google-datetime", - "readOnly": true, + "baseSchemaVersion": { + "description": "The base schema version name to use for the schema generation. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`", "type": "string" }, - "defaultProcessorVersion": { - "description": "The default processor version.", - "type": "string" + "gcsDocuments": { + "$ref": "GoogleCloudDocumentaiV1GcsDocuments", + "description": "The set of documents placed on Cloud Storage." }, - "displayName": { - "description": "The display name of the processor.", - "type": "string" + "gcsPrefix": { + "$ref": "GoogleCloudDocumentaiV1GcsPrefix", + "description": "The common prefix of documents placed on Cloud Storage." }, - "kmsKeyName": { - "description": "The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios.", - "type": "string" + "generateSchemaVersionParams": { + "$ref": "GoogleCloudDocumentaiV1GenerateSchemaVersionRequestGenerateSchemaVersionParams", + "description": "Optional. User specified parameters for the schema generation." }, - "name": { - "description": "Output only. Immutable. The resource name of the processor. Format: `projects/{project}/locations/{location}/processors/{processor}`", - "readOnly": true, - "type": "string" + "inlineDocuments": { + "$ref": "GoogleCloudDocumentaiV1Documents", + "description": "The set of documents specified inline." }, - "processEndpoint": { - "description": "Output only. Immutable. The http endpoint that can be called to invoke processing.", - "readOnly": true, - "type": "string" + "rawDocuments": { + "$ref": "GoogleCloudDocumentaiV1RawDocuments", + "description": "The set of raw documents." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1GenerateSchemaVersionRequestGenerateSchemaVersionParams": { + "description": "The parameters for the schema generation.", + "id": "GoogleCloudDocumentaiV1GenerateSchemaVersionRequestGenerateSchemaVersionParams", + "properties": { + "history": { + "$ref": "GoogleCloudDocumentaiV1SchemaGenerationHistory", + "description": "Optional. Previous prompt-answers in a chronological order." }, - "processorVersionAliases": { - "description": "Output only. The processor version aliases.", - "items": { - "$ref": "GoogleCloudDocumentaiV1ProcessorVersionAlias" - }, - "readOnly": true, - "type": "array" - }, - "satisfiesPzi": { - "description": "Output only. Reserved for future use.", - "readOnly": true, - "type": "boolean" - }, - "satisfiesPzs": { - "description": "Output only. Reserved for future use.", - "readOnly": true, - "type": "boolean" + "prompt": { + "description": "Optional. The prompt used for the schema generation.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1GenerateSchemaVersionResponse": { + "description": "Response message for GenerateSchemaVersion.", + "id": "GoogleCloudDocumentaiV1GenerateSchemaVersionResponse", + "properties": { + "schemaVersion": { + "$ref": "GoogleCloudDocumentaiV1SchemaVersion", + "description": "The schema version generated by the model." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1HumanReviewStatus": { + "description": "The status of human review on a processed document.", + "id": "GoogleCloudDocumentaiV1HumanReviewStatus", + "properties": { + "humanReviewOperation": { + "description": "The name of the operation triggered by the processed document. This field is populated only when the state is `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as the long-running operation returned by ReviewDocument.", + "type": "string" }, "state": { - "description": "Output only. The state of the processor.", + "description": "The state of human review on the processing request.", "enum": [ "STATE_UNSPECIFIED", - "ENABLED", - "DISABLED", - "ENABLING", - "DISABLING", - "CREATING", - "FAILED", - "DELETING" + "SKIPPED", + "VALIDATION_PASSED", + "IN_PROGRESS", + "ERROR" ], "enumDescriptions": [ - "The processor is in an unspecified state.", - "The processor is enabled, i.e., has an enabled version which can currently serve processing requests and all the feature dependencies have been successfully initialized.", - "The processor is disabled.", - "The processor is being enabled, will become `ENABLED` if successful.", - "The processor is being disabled, will become `DISABLED` if successful.", - "The processor is being created, will become either `ENABLED` (for successful creation) or `FAILED` (for failed ones). Once a processor is in this state, it can then be used for document processing, but the feature dependencies of the processor might not be fully created yet.", - "The processor failed during creation or initialization of feature dependencies. The user should delete the processor and recreate one as all the functionalities of the processor are disabled.", - "The processor is being deleted, will be removed if successful." + "Human review state is unspecified. Most likely due to an internal error.", + "Human review is skipped for the document. This can happen because human review isn't enabled on the processor or the processing request has been set to skip this document.", + "Human review validation is triggered and passed, so no review is needed.", + "Human review validation is triggered and the document is under review.", + "Some error happened during triggering human review, see the state_message for details." ], - "readOnly": true, "type": "string" }, - "type": { - "description": "The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor types, see FetchProcessorTypes.", + "stateMessage": { + "description": "A message providing more details about the human review state.", "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1ProcessorType": { - "description": "A processor type is responsible for performing a certain document understanding task on a certain type of document.", - "id": "GoogleCloudDocumentaiV1ProcessorType", + "GoogleCloudDocumentaiV1ListEvaluationsResponse": { + "description": "The response from `ListEvaluations`.", + "id": "GoogleCloudDocumentaiV1ListEvaluationsResponse", "properties": { - "allowCreation": { - "description": "Whether the processor type allows creation. If true, users can create a processor of this processor type. Otherwise, users need to request access.", - "type": "boolean" - }, - "availableLocations": { - "description": "The locations in which this processor is available.", + "evaluations": { + "description": "The evaluations requested.", "items": { - "$ref": "GoogleCloudDocumentaiV1ProcessorTypeLocationInfo" + "$ref": "GoogleCloudDocumentaiV1Evaluation" }, "type": "array" }, - "category": { - "description": "The processor category, used by UI to group processor types.", + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" - }, - "launchStage": { - "description": "Launch stage of the processor type", - "enum": [ - "LAUNCH_STAGE_UNSPECIFIED", - "UNIMPLEMENTED", - "PRELAUNCH", - "EARLY_ACCESS", - "ALPHA", - "BETA", - "GA", - "DEPRECATED" - ], - "enumDescriptions": [ - "Do not use this default value.", - "The feature is not yet implemented. Users can not use it.", - "Prelaunch features are hidden from users and are only visible internally.", - "Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.", - "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", - "Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.", - "GA features are open to all developers and are considered stable and fully qualified for production use.", - "Deprecated features are scheduled to be shut down and removed. For more information, see the \"Deprecation Policy\" section of our [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation." - ], + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1ListProcessorTypesResponse": { + "description": "Response message for the ListProcessorTypes method.", + "id": "GoogleCloudDocumentaiV1ListProcessorTypesResponse", + "properties": { + "nextPageToken": { + "description": "Points to the next page, otherwise empty.", "type": "string" }, - "name": { - "description": "The resource name of the processor type. Format: `projects/{project}/processorTypes/{processor_type}`", + "processorTypes": { + "description": "The processor types.", + "items": { + "$ref": "GoogleCloudDocumentaiV1ProcessorType" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1ListProcessorVersionsResponse": { + "description": "Response message for the ListProcessorVersions method.", + "id": "GoogleCloudDocumentaiV1ListProcessorVersionsResponse", + "properties": { + "nextPageToken": { + "description": "Points to the next processor, otherwise empty.", "type": "string" }, - "sampleDocumentUris": { - "description": "A set of Cloud Storage URIs of sample documents for this processor.", + "processorVersions": { + "description": "The list of processors.", "items": { - "type": "string" + "$ref": "GoogleCloudDocumentaiV1ProcessorVersion" }, "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1ListProcessorsResponse": { + "description": "Response message for the ListProcessors method.", + "id": "GoogleCloudDocumentaiV1ListProcessorsResponse", + "properties": { + "nextPageToken": { + "description": "Points to the next processor, otherwise empty.", + "type": "string" }, - "type": { - "description": "The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.", + "processors": { + "description": "The list of processors.", + "items": { + "$ref": "GoogleCloudDocumentaiV1Processor" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1ListSchemaVersionsResponse": { + "description": "Response message for ListSchemaVersions.", + "id": "GoogleCloudDocumentaiV1ListSchemaVersionsResponse", + "properties": { + "nextPageToken": { + "description": "Points to the next SchemaVersion, otherwise empty.", "type": "string" + }, + "schemaVersions": { + "description": "The list of SchemaVersions.", + "items": { + "$ref": "GoogleCloudDocumentaiV1SchemaVersion" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDocumentaiV1ProcessorTypeLocationInfo": { - "description": "The location information about where the processor is available.", - "id": "GoogleCloudDocumentaiV1ProcessorTypeLocationInfo", + "GoogleCloudDocumentaiV1ListSchemasResponse": { + "description": "Response message for ListSchemas.", + "id": "GoogleCloudDocumentaiV1ListSchemasResponse", "properties": { - "locationId": { - "description": "The location ID. For supported locations, refer to [regional and multi-regional support](/document-ai/docs/regions).", + "nextPageToken": { + "description": "Points to the next Schema, otherwise empty.", "type": "string" + }, + "schemas": { + "description": "The list of Schemas.", + "items": { + "$ref": "GoogleCloudDocumentaiV1NextSchema" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDocumentaiV1ProcessorVersion": { - "description": "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.", - "id": "GoogleCloudDocumentaiV1ProcessorVersion", + "GoogleCloudDocumentaiV1NextSchema": { + "description": "NextSchema is a collection of SchemaVersions.", + "id": "GoogleCloudDocumentaiV1NextSchema", "properties": { "createTime": { - "description": "Output only. The time the processor version was created.", + "description": "Output only. The time when the Schema was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, - "deprecationInfo": { - "$ref": "GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo", - "description": "Output only. If set, information about the eventual deprecation of this version.", - "readOnly": true - }, "displayName": { - "description": "The display name of the processor version.", + "description": "Optional. The user-defined name of the Schema.", "type": "string" }, - "documentSchema": { - "$ref": "GoogleCloudDocumentaiV1DocumentSchema", - "description": "Output only. The schema of the processor version. Describes the output.", - "readOnly": true - }, - "genAiModelInfo": { - "$ref": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo", - "description": "Output only. Information about Generative AI model-based processor versions.", - "readOnly": true - }, - "googleManaged": { - "description": "Output only. Denotes that this `ProcessorVersion` is managed by Google.", - "readOnly": true, - "type": "boolean" + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The GCP labels for the Schema.", + "type": "object" }, - "kmsKeyName": { - "description": "Output only. The KMS key name used for encryption.", - "readOnly": true, + "name": { + "description": "Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}`", "type": "string" }, - "kmsKeyVersionName": { - "description": "Output only. The KMS key version with which data is encrypted.", + "updateTime": { + "description": "Output only. The time when the Schema was last updated.", + "format": "google-datetime", "readOnly": true, "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1NormalizedVertex": { + "description": "A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.", + "id": "GoogleCloudDocumentaiV1NormalizedVertex", + "properties": { + "x": { + "description": "X coordinate.", + "format": "float", + "type": "number" }, - "latestEvaluation": { - "$ref": "GoogleCloudDocumentaiV1EvaluationReference", - "description": "Output only. The most recently invoked evaluation for the processor version.", - "readOnly": true + "y": { + "description": "Y coordinate (starts from the top of the image).", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1OcrConfig": { + "description": "Config for Document OCR.", + "id": "GoogleCloudDocumentaiV1OcrConfig", + "properties": { + "advancedOcrOptions": { + "description": "A list of advanced OCR options to further fine-tune OCR behavior. Current valid values are: - `legacy_layout`: a heuristics layout detection algorithm, which serves as an alternative to the current ML-based layout detection algorithm. Customers can choose the best suitable layout algorithm based on their situation.", + "items": { + "type": "string" + }, + "type": "array" }, - "modelType": { - "description": "Output only. The model type of this processor version.", - "enum": [ - "MODEL_TYPE_UNSPECIFIED", - "MODEL_TYPE_GENERATIVE", - "MODEL_TYPE_CUSTOM" - ], - "enumDescriptions": [ - "The processor version has unspecified model type.", - "The processor version has generative model type.", - "The processor version has custom model type." - ], - "readOnly": true, - "type": "string" + "computeStyleInfo": { + "deprecated": true, + "description": "Turn on font identification model and return font style information. Deprecated, use PremiumFeatures.compute_style_info instead.", + "type": "boolean" }, - "name": { - "description": "Identifier. The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`", - "type": "string" + "disableCharacterBoxesDetection": { + "description": "Turn off character box detector in OCR engine. Character box detection is enabled by default in OCR 2.0 (and later) processors.", + "type": "boolean" }, - "satisfiesPzi": { - "description": "Output only. Reserved for future use.", - "readOnly": true, + "enableImageQualityScores": { + "description": "Enables intelligent document quality scores after OCR. Can help with diagnosing why OCR responses are of poor quality for a given input. Adds additional latency comparable to regular OCR to the process call.", "type": "boolean" }, - "satisfiesPzs": { - "description": "Output only. Reserved for future use.", - "readOnly": true, + "enableNativePdfParsing": { + "description": "Enables special handling for PDFs with existing text information. Results in better text extraction quality in such PDF inputs.", "type": "boolean" }, - "state": { - "description": "Output only. The state of the processor version.", - "enum": [ - "STATE_UNSPECIFIED", - "DEPLOYED", - "DEPLOYING", - "UNDEPLOYED", - "UNDEPLOYING", - "CREATING", - "DELETING", - "FAILED", - "IMPORTING" - ], - "enumDescriptions": [ - "The processor version is in an unspecified state.", - "The processor version is deployed and can be used for processing.", - "The processor version is being deployed.", - "The processor version is not deployed and cannot be used for processing.", - "The processor version is being undeployed.", - "The processor version is being created.", - "The processor version is being deleted.", - "The processor version failed and is in an indeterminate state.", - "The processor version is being imported." - ], - "readOnly": true, - "type": "string" + "enableSymbol": { + "description": "Includes symbol level OCR information if set to true.", + "type": "boolean" + }, + "hints": { + "$ref": "GoogleCloudDocumentaiV1OcrConfigHints", + "description": "Hints for the OCR model." + }, + "premiumFeatures": { + "$ref": "GoogleCloudDocumentaiV1OcrConfigPremiumFeatures", + "description": "Configurations for premium OCR features." } }, "type": "object" }, - "GoogleCloudDocumentaiV1ProcessorVersionAlias": { - "description": "Contains the alias and the aliased resource name of processor version.", - "id": "GoogleCloudDocumentaiV1ProcessorVersionAlias", + "GoogleCloudDocumentaiV1OcrConfigHints": { + "description": "Hints for OCR Engine", + "id": "GoogleCloudDocumentaiV1OcrConfigHints", "properties": { - "alias": { - "description": "The alias in the form of `processor_version` resource name.", - "type": "string" - }, - "processorVersion": { - "description": "The resource name of aliased processor version.", - "type": "string" + "languageHints": { + "description": "List of BCP-47 language codes to use for OCR. In most cases, not specifying it yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting hints is not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a significant hindrance if the hint is wrong).", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo": { - "description": "Information about the upcoming deprecation of this processor version.", - "id": "GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo", + "GoogleCloudDocumentaiV1OcrConfigPremiumFeatures": { + "description": "Configurations for premium OCR features.", + "id": "GoogleCloudDocumentaiV1OcrConfigPremiumFeatures", "properties": { - "deprecationTime": { - "description": "The time at which this processor version will be deprecated.", - "format": "google-datetime", - "type": "string" + "computeStyleInfo": { + "description": "Turn on font identification model and return font style information.", + "type": "boolean" }, - "replacementProcessorVersion": { - "description": "If set, the processor version that will be used as a replacement.", - "type": "string" + "enableMathOcr": { + "description": "Turn on the model that can extract LaTeX math formulas.", + "type": "boolean" + }, + "enableSelectionMarkDetection": { + "description": "Turn on selection mark detector in OCR engine. Only available in OCR 2.0 (and later) processors.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo": { - "description": "Information about Generative AI model-based processor versions.", - "id": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo", + "GoogleCloudDocumentaiV1ProcessOptions": { + "description": "Options for Process API", + "id": "GoogleCloudDocumentaiV1ProcessOptions", "properties": { - "customGenAiModelInfo": { - "$ref": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo", - "description": "Information for a custom Generative AI model created by the user." + "fromEnd": { + "description": "Only process certain pages from the end, same as above.", + "format": "int32", + "type": "integer" }, - "foundationGenAiModelInfo": { - "$ref": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo", - "description": "Information for a pretrained Google-managed foundation model." + "fromStart": { + "description": "Only process certain pages from the start. Process all if the document has fewer pages.", + "format": "int32", + "type": "integer" + }, + "individualPageSelector": { + "$ref": "GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector", + "description": "Which pages to process (1-indexed)." + }, + "layoutConfig": { + "$ref": "GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig", + "description": "Optional. Only applicable to `LAYOUT_PARSER_PROCESSOR`. Returns error if set on other processor types." + }, + "ocrConfig": { + "$ref": "GoogleCloudDocumentaiV1OcrConfig", + "description": "Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. Returns error if set on other processor types." + }, + "schemaOverride": { + "$ref": "GoogleCloudDocumentaiV1DocumentSchema", + "description": "Optional. Override the schema of the ProcessorVersion. Will return an Invalid Argument error if this field is set when the underlying ProcessorVersion doesn't support schema override." } }, "type": "object" }, - "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo": { - "description": "Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs.", - "id": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo", + "GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector": { + "description": "A list of individual page numbers.", + "id": "GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector", "properties": { - "baseProcessorVersionId": { - "description": "The base processor version ID for the custom model.", - "type": "string" - }, - "customModelType": { - "description": "The type of custom model created by the user.", - "enum": [ - "CUSTOM_MODEL_TYPE_UNSPECIFIED", - "VERSIONED_FOUNDATION", - "FINE_TUNED" - ], - "enumDescriptions": [ - "The model type is unspecified.", - "The model is a versioned foundation model.", - "The model is a finetuned foundation model." - ], - "type": "string" + "pages": { + "description": "Optional. Indices of the pages (starting from 1).", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo": { - "description": "Information for a pretrained Google-managed foundation model.", - "id": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo", + "GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig": { + "description": "Serving config for layout parser processor.", + "id": "GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig", "properties": { - "finetuningAllowed": { - "description": "Whether finetuning is allowed for this base processor version.", + "chunkingConfig": { + "$ref": "GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig", + "description": "Optional. Config for chunking in layout parser processor." + }, + "enableImageAnnotation": { + "description": "Optional. Whether to include image annotations in layout parser response.", "type": "boolean" }, - "minTrainLabeledDocuments": { - "description": "The minimum number of labeled documents in the training dataset required for finetuning.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1RawDocument": { - "description": "Payload message of raw document content (bytes).", - "id": "GoogleCloudDocumentaiV1RawDocument", - "properties": { - "content": { - "description": "Inline document content.", - "format": "byte", - "type": "string" + "enableTableAnnotation": { + "description": "Optional. Whether to include table annotations in layout parser response.", + "type": "boolean" }, - "displayName": { - "description": "The display name of the document, it supports all Unicode characters except the following: `*`, `?`, `[`, `]`, `%`, `{`, `}`,`'`, `\\\"`, `,` `~`, `=` and `:` are reserved. If not specified, a default ID is generated.", - "type": "string" + "returnBoundingBoxes": { + "description": "Optional. Whether to include bounding boxes in layout parser processor response.", + "type": "boolean" }, - "mimeType": { - "description": "An IANA MIME type (RFC6838) indicating the nature and format of the content.", - "type": "string" + "returnImages": { + "description": "Optional. Whether to include images in layout parser processor response.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata": { - "description": "The long-running operation metadata for the ReviewDocument method.", - "id": "GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata", + "GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig": { + "description": "Serving config for chunking.", + "id": "GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig", "properties": { - "commonMetadata": { - "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", - "description": "The basic metadata of the long-running operation." + "chunkSize": { + "description": "Optional. The chunk sizes to use when splitting documents, in order of level.", + "format": "int32", + "type": "integer" }, - "questionId": { - "description": "The Crowd Compute question ID.", - "type": "string" + "includeAncestorHeadings": { + "description": "Optional. Whether or not to include ancestor headings when splitting.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDocumentaiV1ReviewDocumentRequest": { - "description": "Request message for the ReviewDocument method.", - "id": "GoogleCloudDocumentaiV1ReviewDocumentRequest", + "GoogleCloudDocumentaiV1ProcessRequest": { + "description": "Request message for the ProcessDocument method.", + "id": "GoogleCloudDocumentaiV1ProcessRequest", "properties": { - "documentSchema": { - "$ref": "GoogleCloudDocumentaiV1DocumentSchema", - "description": "The document schema of the human review task." + "fieldMask": { + "description": "Specifies which fields to include in the ProcessResponse.document output. Only supports top-level document and pages field, so it must be in the form of `{document_field_name}` or `pages.{page_field_name}`.", + "format": "google-fieldmask", + "type": "string" }, - "enableSchemaValidation": { - "description": "Whether the validation should be performed on the ad-hoc review request.", + "gcsDocument": { + "$ref": "GoogleCloudDocumentaiV1GcsDocument", + "description": "A raw document on Google Cloud Storage." + }, + "imagelessMode": { + "description": "Optional. Option to remove images from the document.", "type": "boolean" }, "inlineDocument": { "$ref": "GoogleCloudDocumentaiV1Document", "description": "An inline document proto." }, - "priority": { - "description": "The priority of the human review task.", - "enum": [ - "DEFAULT", - "URGENT" + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.", + "type": "object" + }, + "processOptions": { + "$ref": "GoogleCloudDocumentaiV1ProcessOptions", + "description": "Inference-time options for the process API" + }, + "rawDocument": { + "$ref": "GoogleCloudDocumentaiV1RawDocument", + "description": "A raw document content (bytes)." + }, + "skipHumanReview": { + "description": "Whether human review should be skipped for this request. Default to `false`.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1ProcessResponse": { + "description": "Response message for the ProcessDocument method.", + "id": "GoogleCloudDocumentaiV1ProcessResponse", + "properties": { + "document": { + "$ref": "GoogleCloudDocumentaiV1Document", + "description": "The document payload, will populate fields based on the processor's behavior." + }, + "humanReviewStatus": { + "$ref": "GoogleCloudDocumentaiV1HumanReviewStatus", + "description": "The status of human review on the processed document." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1Processor": { + "description": "The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.", + "id": "GoogleCloudDocumentaiV1Processor", + "properties": { + "activeSchemaVersion": { + "description": "Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}", + "type": "string" + }, + "createTime": { + "description": "Output only. The time the processor was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "defaultProcessorVersion": { + "description": "The default processor version.", + "type": "string" + }, + "displayName": { + "description": "The display name of the processor.", + "type": "string" + }, + "kmsKeyName": { + "description": "The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios.", + "type": "string" + }, + "name": { + "description": "Output only. Immutable. The resource name of the processor. Format: `projects/{project}/locations/{location}/processors/{processor}`", + "readOnly": true, + "type": "string" + }, + "processEndpoint": { + "description": "Output only. Immutable. The http endpoint that can be called to invoke processing.", + "readOnly": true, + "type": "string" + }, + "processorVersionAliases": { + "description": "Output only. The processor version aliases.", + "items": { + "$ref": "GoogleCloudDocumentaiV1ProcessorVersionAlias" + }, + "readOnly": true, + "type": "array" + }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "state": { + "description": "Output only. The state of the processor.", + "enum": [ + "STATE_UNSPECIFIED", + "ENABLED", + "DISABLED", + "ENABLING", + "DISABLING", + "CREATING", + "FAILED", + "DELETING" + ], + "enumDescriptions": [ + "The processor is in an unspecified state.", + "The processor is enabled, i.e., has an enabled version which can currently serve processing requests and all the feature dependencies have been successfully initialized.", + "The processor is disabled.", + "The processor is being enabled, will become `ENABLED` if successful.", + "The processor is being disabled, will become `DISABLED` if successful.", + "The processor is being created, will become either `ENABLED` (for successful creation) or `FAILED` (for failed ones). Once a processor is in this state, it can then be used for document processing, but the feature dependencies of the processor might not be fully created yet.", + "The processor failed during creation or initialization of feature dependencies. The user should delete the processor and recreate one as all the functionalities of the processor are disabled.", + "The processor is being deleted, will be removed if successful." + ], + "readOnly": true, + "type": "string" + }, + "type": { + "description": "The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor types, see FetchProcessorTypes.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1ProcessorType": { + "description": "A processor type is responsible for performing a certain document understanding task on a certain type of document.", + "id": "GoogleCloudDocumentaiV1ProcessorType", + "properties": { + "allowCreation": { + "description": "Whether the processor type allows creation. If true, users can create a processor of this processor type. Otherwise, users need to request access.", + "type": "boolean" + }, + "availableLocations": { + "description": "The locations in which this processor is available.", + "items": { + "$ref": "GoogleCloudDocumentaiV1ProcessorTypeLocationInfo" + }, + "type": "array" + }, + "category": { + "description": "The processor category, used by UI to group processor types.", + "type": "string" + }, + "launchStage": { + "description": "Launch stage of the processor type", + "enum": [ + "LAUNCH_STAGE_UNSPECIFIED", + "UNIMPLEMENTED", + "PRELAUNCH", + "EARLY_ACCESS", + "ALPHA", + "BETA", + "GA", + "DEPRECATED" + ], + "enumDescriptions": [ + "Do not use this default value.", + "The feature is not yet implemented. Users can not use it.", + "Prelaunch features are hidden from users and are only visible internally.", + "Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.", + "Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.", + "Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.", + "GA features are open to all developers and are considered stable and fully qualified for production use.", + "Deprecated features are scheduled to be shut down and removed. For more information, see the \"Deprecation Policy\" section of our [Terms of Service](https://cloud.google.com/terms/) and the [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) documentation." + ], + "type": "string" + }, + "name": { + "description": "The resource name of the processor type. Format: `projects/{project}/processorTypes/{processor_type}`", + "type": "string" + }, + "sampleDocumentUris": { + "description": "A set of Cloud Storage URIs of sample documents for this processor.", + "items": { + "type": "string" + }, + "type": "array" + }, + "type": { + "description": "The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1ProcessorTypeLocationInfo": { + "description": "The location information about where the processor is available.", + "id": "GoogleCloudDocumentaiV1ProcessorTypeLocationInfo", + "properties": { + "locationId": { + "description": "The location ID. For supported locations, refer to [regional and multi-regional support](/document-ai/docs/regions).", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1ProcessorVersion": { + "description": "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.", + "id": "GoogleCloudDocumentaiV1ProcessorVersion", + "properties": { + "createTime": { + "description": "Output only. The time the processor version was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "deprecationInfo": { + "$ref": "GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo", + "description": "Output only. If set, information about the eventual deprecation of this version.", + "readOnly": true + }, + "displayName": { + "description": "The display name of the processor version.", + "type": "string" + }, + "documentSchema": { + "$ref": "GoogleCloudDocumentaiV1DocumentSchema", + "description": "Output only. The schema of the processor version. Describes the output.", + "readOnly": true + }, + "genAiModelInfo": { + "$ref": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo", + "description": "Output only. Information about Generative AI model-based processor versions.", + "readOnly": true + }, + "googleManaged": { + "description": "Output only. Denotes that this `ProcessorVersion` is managed by Google.", + "readOnly": true, + "type": "boolean" + }, + "kmsKeyName": { + "description": "Output only. The KMS key name used for encryption.", + "readOnly": true, + "type": "string" + }, + "kmsKeyVersionName": { + "description": "Output only. The KMS key version with which data is encrypted.", + "readOnly": true, + "type": "string" + }, + "latestEvaluation": { + "$ref": "GoogleCloudDocumentaiV1EvaluationReference", + "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.", + "enum": [ + "MODEL_TYPE_UNSPECIFIED", + "MODEL_TYPE_GENERATIVE", + "MODEL_TYPE_CUSTOM" + ], + "enumDescriptions": [ + "The processor version has unspecified model type.", + "The processor version has generative model type.", + "The processor version has custom model type." + ], + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Identifier. The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`", + "type": "string" + }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "state": { + "description": "Output only. The state of the processor version.", + "enum": [ + "STATE_UNSPECIFIED", + "DEPLOYED", + "DEPLOYING", + "UNDEPLOYED", + "UNDEPLOYING", + "CREATING", + "DELETING", + "FAILED", + "IMPORTING" + ], + "enumDescriptions": [ + "The processor version is in an unspecified state.", + "The processor version is deployed and can be used for processing.", + "The processor version is being deployed.", + "The processor version is not deployed and cannot be used for processing.", + "The processor version is being undeployed.", + "The processor version is being created.", + "The processor version is being deleted.", + "The processor version failed and is in an indeterminate state.", + "The processor version is being imported." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1ProcessorVersionAlias": { + "description": "Contains the alias and the aliased resource name of processor version.", + "id": "GoogleCloudDocumentaiV1ProcessorVersionAlias", + "properties": { + "alias": { + "description": "The alias in the form of `processor_version` resource name.", + "type": "string" + }, + "processorVersion": { + "description": "The resource name of aliased processor version.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo": { + "description": "Information about the upcoming deprecation of this processor version.", + "id": "GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo", + "properties": { + "deprecationTime": { + "description": "The time at which this processor version will be deprecated.", + "format": "google-datetime", + "type": "string" + }, + "replacementProcessorVersion": { + "description": "If set, the processor version that will be used as a replacement.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo": { + "description": "Information about Generative AI model-based processor versions.", + "id": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo", + "properties": { + "customGenAiModelInfo": { + "$ref": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo", + "description": "Information for a custom Generative AI model created by the user." + }, + "foundationGenAiModelInfo": { + "$ref": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo", + "description": "Information for a pretrained Google-managed foundation model." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo": { + "description": "Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs.", + "id": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo", + "properties": { + "baseProcessorVersionId": { + "description": "The base processor version ID for the custom model.", + "type": "string" + }, + "customModelType": { + "description": "The type of custom model created by the user.", + "enum": [ + "CUSTOM_MODEL_TYPE_UNSPECIFIED", + "VERSIONED_FOUNDATION", + "FINE_TUNED" + ], + "enumDescriptions": [ + "The model type is unspecified.", + "The model is a versioned foundation model.", + "The model is a finetuned foundation model." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo": { + "description": "Information for a pretrained Google-managed foundation model.", + "id": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo", + "properties": { + "finetuningAllowed": { + "description": "Whether finetuning is allowed for this base processor version.", + "type": "boolean" + }, + "minTrainLabeledDocuments": { + "description": "The minimum number of labeled documents in the training dataset required for finetuning.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1RawDocument": { + "description": "Payload message of raw document content (bytes).", + "id": "GoogleCloudDocumentaiV1RawDocument", + "properties": { + "content": { + "description": "Inline document content.", + "format": "byte", + "type": "string" + }, + "displayName": { + "description": "The display name of the document, it supports all Unicode characters except the following: `*`, `?`, `[`, `]`, `%`, `{`, `}`,`'`, `\\\"`, `,` `~`, `=` and `:` are reserved. If not specified, a default ID is generated.", + "type": "string" + }, + "mimeType": { + "description": "An IANA MIME type (RFC6838) indicating the nature and format of the content.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1RawDocuments": { + "description": "Specifies a set of raw documents.", + "id": "GoogleCloudDocumentaiV1RawDocuments", + "properties": { + "documents": { + "description": "Specifies raw document content and mime type.", + "items": { + "$ref": "GoogleCloudDocumentaiV1RawDocument" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata": { + "description": "The long-running operation metadata for the ReviewDocument method.", + "id": "GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata", + "properties": { + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", + "description": "The basic metadata of the long-running operation." + }, + "questionId": { + "description": "The Crowd Compute question ID.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1ReviewDocumentRequest": { + "description": "Request message for the ReviewDocument method.", + "id": "GoogleCloudDocumentaiV1ReviewDocumentRequest", + "properties": { + "documentSchema": { + "$ref": "GoogleCloudDocumentaiV1DocumentSchema", + "description": "The document schema of the human review task." + }, + "enableSchemaValidation": { + "description": "Whether the validation should be performed on the ad-hoc review request.", + "type": "boolean" + }, + "inlineDocument": { + "$ref": "GoogleCloudDocumentaiV1Document", + "description": "An inline document proto." + }, + "priority": { + "description": "The priority of the human review task.", + "enum": [ + "DEFAULT", + "URGENT" + ], + "enumDescriptions": [ + "The default priority level.", + "The urgent priority level. The labeling manager should allocate labeler resource to the urgent task queue to respect this priority level." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1ReviewDocumentResponse": { + "description": "Response message for the ReviewDocument method.", + "id": "GoogleCloudDocumentaiV1ReviewDocumentResponse", + "properties": { + "gcsDestination": { + "description": "The Cloud Storage uri for the human reviewed document if the review is succeeded.", + "type": "string" + }, + "rejectionReason": { + "description": "The reason why the review is rejected by reviewer.", + "type": "string" + }, + "state": { + "description": "The state of the review operation.", + "enum": [ + "STATE_UNSPECIFIED", + "REJECTED", + "SUCCEEDED" + ], + "enumDescriptions": [ + "The default value. This value is used if the state is omitted.", + "The review operation is rejected by the reviewer.", + "The review operation is succeeded." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1SchemaGenerationHistory": { + "description": "The history of schema generation iterations.", + "id": "GoogleCloudDocumentaiV1SchemaGenerationHistory", + "properties": { + "iterations": { + "description": "Required. Previous prompt-answers in a chronological order.", + "items": { + "$ref": "GoogleCloudDocumentaiV1SchemaGenerationIteration" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1SchemaGenerationIteration": { + "description": "A single iteration of the schema generation.", + "id": "GoogleCloudDocumentaiV1SchemaGenerationIteration", + "properties": { + "adjustedSchema": { + "$ref": "GoogleCloudDocumentaiV1SchemaVersion", + "description": "Optional. The previous schema version adjusted by the model." + }, + "generatedSchema": { + "$ref": "GoogleCloudDocumentaiV1SchemaVersion", + "description": "Required. The schema version generated by the model." + }, + "prompt": { + "description": "Optional. The prompt used for the iteration.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1SchemaVersion": { + "description": "SchemaVersion is a version of the Schema which is created in SchemaGroup.", + "id": "GoogleCloudDocumentaiV1SchemaVersion", + "properties": { + "createTime": { + "description": "Output only. The time when the SchemaVersion was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Optional. The user-defined name of the SchemaVersion.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The GCP labels for the SchemaVersion.", + "type": "object" + }, + "name": { + "description": "Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`", + "type": "string" + }, + "schema": { + "$ref": "GoogleCloudDocumentaiV1DocumentSchema", + "description": "Required. The schema of the SchemaVersion." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata": { + "description": "The long-running operation metadata for the SetDefaultProcessorVersion method.", + "id": "GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata", + "properties": { + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", + "description": "The basic metadata of the long-running operation." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest": { + "description": "Request message for the SetDefaultProcessorVersion method.", + "id": "GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest", + "properties": { + "defaultProcessorVersion": { + "description": "Required. The resource name of child ProcessorVersion to use as default. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{version}`", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse": { + "description": "Response message for the SetDefaultProcessorVersion method.", + "id": "GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDocumentaiV1TrainProcessorVersionMetadata": { + "description": "The metadata that represents a processor version being created.", + "id": "GoogleCloudDocumentaiV1TrainProcessorVersionMetadata", + "properties": { + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", + "description": "The basic metadata of the long-running operation." + }, + "testDatasetValidation": { + "$ref": "GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation", + "description": "The test dataset validation information." + }, + "trainingDatasetValidation": { + "$ref": "GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation", + "description": "The training dataset validation information." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation": { + "description": "The dataset validation information. This includes any and all errors with documents and the dataset.", + "id": "GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation", + "properties": { + "datasetErrorCount": { + "description": "The total number of dataset errors.", + "format": "int32", + "type": "integer" + }, + "datasetErrors": { + "description": "Error information for the dataset as a whole. A maximum of 10 dataset errors will be returned. A single dataset error is terminal for training.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "documentErrorCount": { + "description": "The total number of document errors.", + "format": "int32", + "type": "integer" + }, + "documentErrors": { + "description": "Error information pertaining to specific documents. A maximum of 10 document errors will be returned. Any document with errors will not be used throughout training.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1TrainProcessorVersionRequest": { + "description": "Request message for the TrainProcessorVersion method.", + "id": "GoogleCloudDocumentaiV1TrainProcessorVersionRequest", + "properties": { + "baseProcessorVersion": { + "description": "Optional. The processor version to use as a base for training. This processor version must be a child of `parent`. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`.", + "type": "string" + }, + "customDocumentExtractionOptions": { + "$ref": "GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions", + "description": "Options to control Custom Document Extraction (CDE) Processor." + }, + "documentSchema": { + "$ref": "GoogleCloudDocumentaiV1DocumentSchema", + "description": "Optional. The schema the processor version will be trained with." + }, + "foundationModelTuningOptions": { + "$ref": "GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions", + "description": "Options to control foundation model tuning of a processor." + }, + "inputData": { + "$ref": "GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData", + "description": "Optional. The input data used to train the ProcessorVersion." + }, + "processorVersion": { + "$ref": "GoogleCloudDocumentaiV1ProcessorVersion", + "description": "Required. The processor version to be created." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions": { + "description": "Options to control the training of the Custom Document Extraction (CDE) Processor.", + "id": "GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions", + "properties": { + "trainingMethod": { + "description": "Optional. Training method to use for CDE training.", + "enum": [ + "TRAINING_METHOD_UNSPECIFIED", + "MODEL_BASED", + "TEMPLATE_BASED" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions": { + "description": "Options to control foundation model tuning of the processor.", + "id": "GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions", + "properties": { + "learningRateMultiplier": { + "description": "Optional. The multiplier to apply to the recommended learning rate. Valid values are between 0.1 and 10. If not provided, recommended learning rate will be used.", + "format": "float", + "type": "number" + }, + "trainSteps": { + "description": "Optional. The number of steps to run for model tuning. Valid values are between 1 and 400. If not provided, recommended steps will be used.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData": { + "description": "The input data used to train a new ProcessorVersion.", + "id": "GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData", + "properties": { + "testDocuments": { + "$ref": "GoogleCloudDocumentaiV1BatchDocumentsInputConfig", + "description": "The documents used for testing the trained version." + }, + "trainingDocuments": { + "$ref": "GoogleCloudDocumentaiV1BatchDocumentsInputConfig", + "description": "The documents used for training the new version." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1TrainProcessorVersionResponse": { + "description": "The response for TrainProcessorVersion.", + "id": "GoogleCloudDocumentaiV1TrainProcessorVersionResponse", + "properties": { + "processorVersion": { + "description": "The resource name of the processor version produced by training.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata": { + "description": "The long-running operation metadata for the UndeployProcessorVersion method.", + "id": "GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata", + "properties": { + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", + "description": "The basic metadata of the long-running operation." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1UndeployProcessorVersionRequest": { + "description": "Request message for the UndeployProcessorVersion method.", + "id": "GoogleCloudDocumentaiV1UndeployProcessorVersionRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudDocumentaiV1UndeployProcessorVersionResponse": { + "description": "Response message for the UndeployProcessorVersion method.", + "id": "GoogleCloudDocumentaiV1UndeployProcessorVersionResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDocumentaiV1Vertex": { + "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.", + "id": "GoogleCloudDocumentaiV1Vertex", + "properties": { + "x": { + "description": "X coordinate.", + "format": "int32", + "type": "integer" + }, + "y": { + "description": "Y coordinate (starts from the top of the image).", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata": { + "id": "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata", + "properties": { + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", + "description": "The basic metadata of the long-running operation." + }, + "errorDocumentCount": { + "description": "Total number of documents that failed to be deleted in storage.", + "format": "int32", + "type": "integer" + }, + "individualBatchDeleteStatuses": { + "description": "The list of response details of each document.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus" + }, + "type": "array" + }, + "totalDocumentCount": { + "description": "Total number of documents deleting from dataset.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus": { + "description": "The status of each individual document in the batch delete process.", + "id": "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus", + "properties": { + "documentId": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentId", + "description": "The document id of the document." + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "The status of deleting the document in storage." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse": { + "description": "Response of the delete documents operation.", + "id": "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3BatchProcessMetadata": { + "description": "The long-running operation metadata for BatchProcessDocuments.", + "id": "GoogleCloudDocumentaiV1beta3BatchProcessMetadata", + "properties": { + "createTime": { + "description": "The creation time of the operation.", + "format": "google-datetime", + "type": "string" + }, + "individualProcessStatuses": { + "description": "The list of response details of each document.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus" + }, + "type": "array" + }, + "state": { + "description": "The state of the current batch processing.", + "enum": [ + "STATE_UNSPECIFIED", + "WAITING", + "RUNNING", + "SUCCEEDED", + "CANCELLING", + "CANCELLED", + "FAILED" + ], + "enumDescriptions": [ + "The default value. This value is used if the state is omitted.", + "Request operation is waiting for scheduling.", + "Request is being processed.", + "The batch processing completed successfully.", + "The batch processing was being cancelled.", + "The batch processing was cancelled.", + "The batch processing has failed." + ], + "type": "string" + }, + "stateMessage": { + "description": "A message providing more details about the current state of processing. For example, the error message if the operation is failed.", + "type": "string" + }, + "updateTime": { + "description": "The last update time of the operation.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus": { + "description": "The status of a each individual document in the batch process.", + "id": "GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus", + "properties": { + "humanReviewOperation": { + "deprecated": true, + "description": "The name of the operation triggered by the processed document. If the human review process isn't triggered, this field will be empty. It has the same response type and metadata as the long-running operation returned by the ReviewDocument method.", + "type": "string" + }, + "humanReviewStatus": { + "$ref": "GoogleCloudDocumentaiV1beta3HumanReviewStatus", + "description": "The status of human review on the processed document." + }, + "inputGcsSource": { + "description": "The source of the document, same as the input_gcs_source field in the request when the batch process started.", + "type": "string" + }, + "outputGcsDestination": { + "description": "The Cloud Storage output destination (in the request as DocumentOutputConfig.GcsOutputConfig.gcs_uri) of the processed document if it was successful, otherwise empty.", + "type": "string" + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "The status processing the document." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3BatchProcessResponse": { + "description": "Response message for BatchProcessDocuments.", + "id": "GoogleCloudDocumentaiV1beta3BatchProcessResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3CommonOperationMetadata": { + "description": "The common metadata for long running operations.", + "id": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", + "properties": { + "createTime": { + "description": "The creation time of the operation.", + "format": "google-datetime", + "type": "string" + }, + "resource": { + "description": "A related resource to this operation.", + "type": "string" + }, + "state": { + "description": "The state of the operation.", + "enum": [ + "STATE_UNSPECIFIED", + "RUNNING", + "CANCELLING", + "SUCCEEDED", + "FAILED", + "CANCELLED" ], "enumDescriptions": [ - "The default priority level.", - "The urgent priority level. The labeling manager should allocate labeler resource to the urgent task queue to respect this priority level." + "Unspecified state.", + "Operation is still running.", + "Operation is being cancelled.", + "Operation succeeded.", + "Operation failed.", + "Operation is cancelled." + ], + "type": "string" + }, + "stateMessage": { + "description": "A message providing more details about the current state of processing.", + "type": "string" + }, + "updateTime": { + "description": "The last update time of the operation.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3Dataset": { + "description": "A singleton resource under a Processor which configures a collection of documents.", + "id": "GoogleCloudDocumentaiV1beta3Dataset", + "properties": { + "documentWarehouseConfig": { + "$ref": "GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig", + "deprecated": true, + "description": "Optional. Deprecated. Warehouse-based dataset configuration is not supported." + }, + "gcsManagedConfig": { + "$ref": "GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig", + "description": "Optional. User-managed Cloud Storage dataset configuration. Use this configuration if the dataset documents are stored under a user-managed Cloud Storage location." + }, + "name": { + "description": "Dataset resource name. Format: `projects/{project}/locations/{location}/processors/{processor}/dataset`", + "type": "string" + }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "spannerIndexingConfig": { + "$ref": "GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig", + "description": "Optional. A lightweight indexing source with low latency and high reliability, but lacking advanced features like CMEK and content-based search." + }, + "state": { + "description": "Required. State of the dataset. Ignored when updating dataset.", + "enum": [ + "STATE_UNSPECIFIED", + "UNINITIALIZED", + "INITIALIZING", + "INITIALIZED" + ], + "enumDescriptions": [ + "Default unspecified enum, should not be used.", + "Dataset has not been initialized.", + "Dataset is being initialized.", + "Dataset has been initialized." ], "type": "string" + }, + "unmanagedDatasetConfig": { + "$ref": "GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig", + "description": "Optional. Unmanaged dataset configuration. Use this configuration if the dataset documents are managed by the document service internally (not user-managed)." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig": { + "description": "Configuration specific to the Document AI Warehouse-based implementation.", + "id": "GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig", + "properties": { + "collection": { + "description": "Output only. The collection in Document AI Warehouse associated with the dataset.", + "readOnly": true, + "type": "string" + }, + "schema": { + "description": "Output only. The schema in Document AI Warehouse associated with the dataset.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig": { + "description": "Configuration specific to the Cloud Storage-based implementation.", + "id": "GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig", + "properties": { + "gcsPrefix": { + "$ref": "GoogleCloudDocumentaiV1beta3GcsPrefix", + "description": "Required. The Cloud Storage URI (a directory) where the documents belonging to the dataset must be stored." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig": { + "description": "Configuration specific to spanner-based indexing.", + "id": "GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig", + "properties": {}, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig": { + "description": "Configuration specific to an unmanaged dataset.", + "id": "GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig", + "properties": {}, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata": { + "description": "The long-running operation metadata for the DeleteProcessor method.", + "id": "GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata", + "properties": { + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", + "description": "The basic metadata of the long-running operation." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata": { + "description": "The long-running operation metadata for the DeleteProcessorVersion method.", + "id": "GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata", + "properties": { + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", + "description": "The basic metadata of the long-running operation." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata": { + "description": "The long-running operation metadata for the DeployProcessorVersion method.", + "id": "GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata", + "properties": { + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", + "description": "The basic metadata of the long-running operation." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse": { + "description": "Response message for the DeployProcessorVersion method.", + "id": "GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DisableProcessorMetadata": { + "description": "The long-running operation metadata for the DisableProcessor method.", + "id": "GoogleCloudDocumentaiV1beta3DisableProcessorMetadata", + "properties": { + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", + "description": "The basic metadata of the long-running operation." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DisableProcessorResponse": { + "description": "Response message for the DisableProcessor method. Intentionally empty proto for adding fields in future.", + "id": "GoogleCloudDocumentaiV1beta3DisableProcessorResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentId": { + "description": "Document Identifier.", + "id": "GoogleCloudDocumentaiV1beta3DocumentId", + "properties": { + "gcsManagedDocId": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId", + "description": "A document id within user-managed Cloud Storage." + }, + "revisionRef": { + "$ref": "GoogleCloudDocumentaiV1beta3RevisionRef", + "description": "Points to a specific revision of the document if set." + }, + "unmanagedDocId": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId", + "description": "A document id within unmanaged dataset." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId": { + "description": "Identifies a document uniquely within the scope of a dataset in the user-managed Cloud Storage option.", + "id": "GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId", + "properties": { + "cwDocId": { + "deprecated": true, + "description": "Id of the document (indexed) managed by Content Warehouse.", + "type": "string" + }, + "gcsUri": { + "description": "Required. The Cloud Storage URI where the actual document is stored.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId": { + "description": "Identifies a document uniquely within the scope of a dataset in unmanaged option.", + "id": "GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId", + "properties": { + "docId": { + "description": "Required. The id of the document.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentSchema": { + "description": "The schema defines the output of the processed document by a processor.", + "id": "GoogleCloudDocumentaiV1beta3DocumentSchema", + "properties": { + "description": { + "description": "Description of the schema.", + "type": "string" + }, + "displayName": { + "description": "Display name to show to users.", + "type": "string" + }, + "entityTypes": { + "description": "Entity types of the schema.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentSchemaEntityType" + }, + "type": "array" + }, + "metadata": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentSchemaMetadata", + "description": "Metadata of the schema." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentSchemaEntityType": { + "description": "EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.", + "id": "GoogleCloudDocumentaiV1beta3DocumentSchemaEntityType", + "properties": { + "baseTypes": { + "description": "The entity type that this type is derived from. For now, one and only one should be set.", + "items": { + "type": "string" + }, + "type": "array" + }, + "description": { + "description": "The description of the entity type. Could be used to provide more information about the entity type for model calls.", + "type": "string" + }, + "displayName": { + "description": "User defined name for the type.", + "type": "string" + }, + "entityTypeMetadata": { + "$ref": "GoogleCloudDocumentaiV1beta3EntityTypeMetadata", + "description": "Metadata for the entity type." + }, + "enumValues": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues", + "description": "If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file." + }, + "name": { + "description": "Name of the type. It must be unique within the schema file and cannot be a \"Common Type\". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.", + "type": "string" + }, + "properties": { + "description": "Description the nested structure, or composition of an entity.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeProperty" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDocumentaiV1ReviewDocumentResponse": { - "description": "Response message for the ReviewDocument method.", - "id": "GoogleCloudDocumentaiV1ReviewDocumentResponse", + "GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues": { + "description": "Defines the a list of enum values.", + "id": "GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues", "properties": { - "gcsDestination": { - "description": "The Cloud Storage uri for the human reviewed document if the review is succeeded.", + "values": { + "description": "The individual values that this enum values type can include.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeProperty": { + "description": "Defines properties that can be part of the entity type.", + "id": "GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeProperty", + "properties": { + "description": { + "description": "The description of the property. Could be used to provide more information about the property for model calls.", "type": "string" }, - "rejectionReason": { - "description": "The reason why the review is rejected by reviewer.", + "displayName": { + "description": "User defined name for the property.", "type": "string" }, - "state": { - "description": "The state of the review operation.", + "method": { + "description": "Specifies how the entity's value is obtained.", "enum": [ - "STATE_UNSPECIFIED", - "REJECTED", - "SUCCEEDED" + "METHOD_UNSPECIFIED", + "EXTRACT", + "DERIVE" ], "enumDescriptions": [ - "The default value. This value is used if the state is omitted.", - "The review operation is rejected by the reviewer.", - "The review operation is succeeded." + "Unspecified method. It defaults to `EXTRACT`.", + "The entity's value is directly extracted as-is from the document text.", + "The entity's value is derived through inference and is not necessarily an exact text extraction from the document." + ], + "type": "string" + }, + "name": { + "description": "The name of the property. Follows the same guidelines as the EntityType name.", + "type": "string" + }, + "occurrenceType": { + "description": "Occurrence type limits the number of instances an entity type appears in the document.", + "enum": [ + "OCCURRENCE_TYPE_UNSPECIFIED", + "OPTIONAL_ONCE", + "OPTIONAL_MULTIPLE", + "REQUIRED_ONCE", + "REQUIRED_MULTIPLE" + ], + "enumDescriptions": [ + "Unspecified occurrence type.", + "There will be zero or one instance of this entity type. The same entity instance may be mentioned multiple times.", + "The entity type will appear zero or multiple times.", + "The entity type will only appear exactly once. The same entity instance may be mentioned multiple times.", + "The entity type will appear once or more times." ], "type": "string" + }, + "propertyMetadata": { + "$ref": "GoogleCloudDocumentaiV1beta3PropertyMetadata", + "description": "Any additional metadata about the property can be added here." + }, + "valueType": { + "description": "A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata": { - "description": "The long-running operation metadata for the SetDefaultProcessorVersion method.", - "id": "GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata", + "GoogleCloudDocumentaiV1beta3DocumentSchemaMetadata": { + "description": "Metadata for global schema behavior.", + "id": "GoogleCloudDocumentaiV1beta3DocumentSchemaMetadata", "properties": { - "commonMetadata": { - "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", - "description": "The basic metadata of the long-running operation." + "documentAllowMultipleLabels": { + "description": "If true, on a given page, there can be multiple `document` annotations covering it.", + "type": "boolean" + }, + "documentSplitter": { + "description": "If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).", + "type": "boolean" + }, + "prefixedNamingOnProperties": { + "description": "If set, all the nested entities must be prefixed with the parents.", + "type": "boolean" + }, + "skipNamingValidation": { + "description": "If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest": { - "description": "Request message for the SetDefaultProcessorVersion method.", - "id": "GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest", + "GoogleCloudDocumentaiV1beta3EnableProcessorMetadata": { + "description": "The long-running operation metadata for the EnableProcessor method.", + "id": "GoogleCloudDocumentaiV1beta3EnableProcessorMetadata", "properties": { - "defaultProcessorVersion": { - "description": "Required. The resource name of child ProcessorVersion to use as default. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{version}`", - "type": "string" + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", + "description": "The basic metadata of the long-running operation." } }, "type": "object" }, - "GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse": { - "description": "Response message for the SetDefaultProcessorVersion method.", - "id": "GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse", + "GoogleCloudDocumentaiV1beta3EnableProcessorResponse": { + "description": "Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future.", + "id": "GoogleCloudDocumentaiV1beta3EnableProcessorResponse", "properties": {}, "type": "object" }, - "GoogleCloudDocumentaiV1TrainProcessorVersionMetadata": { - "description": "The metadata that represents a processor version being created.", - "id": "GoogleCloudDocumentaiV1TrainProcessorVersionMetadata", + "GoogleCloudDocumentaiV1beta3EntityTypeMetadata": { + "description": "Metadata about an entity type.", + "id": "GoogleCloudDocumentaiV1beta3EntityTypeMetadata", + "properties": { + "inactive": { + "description": "Whether the entity type should be considered inactive.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata": { + "description": "Metadata of the EvaluateProcessorVersion method.", + "id": "GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata", "properties": { "commonMetadata": { - "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", + "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", "description": "The basic metadata of the long-running operation." - }, - "testDatasetValidation": { - "$ref": "GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation", - "description": "The test dataset validation information." - }, - "trainingDatasetValidation": { - "$ref": "GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation", - "description": "The training dataset validation information." } }, "type": "object" }, - "GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation": { - "description": "The dataset validation information. This includes any and all errors with documents and the dataset.", - "id": "GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation", + "GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse": { + "description": "Response of the EvaluateProcessorVersion method.", + "id": "GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse", "properties": { - "datasetErrorCount": { - "description": "The total number of dataset errors.", - "format": "int32", - "type": "integer" - }, - "datasetErrors": { - "description": "Error information for the dataset as a whole. A maximum of 10 dataset errors will be returned. A single dataset error is terminal for training.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" - }, - "documentErrorCount": { - "description": "The total number of document errors.", - "format": "int32", - "type": "integer" - }, - "documentErrors": { - "description": "Error information pertaining to specific documents. A maximum of 10 document errors will be returned. Any document with errors will not be used throughout training.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" + "evaluation": { + "description": "The resource name of the created evaluation.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1TrainProcessorVersionRequest": { - "description": "Request message for the TrainProcessorVersion method.", - "id": "GoogleCloudDocumentaiV1TrainProcessorVersionRequest", + "GoogleCloudDocumentaiV1beta3EvaluationMetrics": { + "description": "Evaluation metrics, either in aggregate or about a specific entity.", + "id": "GoogleCloudDocumentaiV1beta3EvaluationMetrics", "properties": { - "baseProcessorVersion": { - "description": "Optional. The processor version to use as a base for training. This processor version must be a child of `parent`. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`.", - "type": "string" + "f1Score": { + "description": "The calculated f1 score.", + "format": "float", + "type": "number" }, - "customDocumentExtractionOptions": { - "$ref": "GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions", - "description": "Options to control Custom Document Extraction (CDE) Processor." + "falseNegativesCount": { + "description": "The amount of false negatives.", + "format": "int32", + "type": "integer" }, - "documentSchema": { - "$ref": "GoogleCloudDocumentaiV1DocumentSchema", - "description": "Optional. The schema the processor version will be trained with." + "falsePositivesCount": { + "description": "The amount of false positives.", + "format": "int32", + "type": "integer" }, - "foundationModelTuningOptions": { - "$ref": "GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions", - "description": "Options to control foundation model tuning of a processor." + "groundTruthDocumentCount": { + "description": "The amount of documents with a ground truth occurrence.", + "format": "int32", + "type": "integer" }, - "inputData": { - "$ref": "GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData", - "description": "Optional. The input data used to train the ProcessorVersion." + "groundTruthOccurrencesCount": { + "description": "The amount of occurrences in ground truth documents.", + "format": "int32", + "type": "integer" }, - "processorVersion": { - "$ref": "GoogleCloudDocumentaiV1ProcessorVersion", - "description": "Required. The processor version to be created." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions": { - "description": "Options to control the training of the Custom Document Extraction (CDE) Processor.", - "id": "GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions", - "properties": { - "trainingMethod": { - "description": "Optional. Training method to use for CDE training.", - "enum": [ - "TRAINING_METHOD_UNSPECIFIED", - "MODEL_BASED", - "TEMPLATE_BASED" - ], - "enumDescriptions": [ - "", - "", - "" - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions": { - "description": "Options to control foundation model tuning of the processor.", - "id": "GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions", - "properties": { - "learningRateMultiplier": { - "description": "Optional. The multiplier to apply to the recommended learning rate. Valid values are between 0.1 and 10. If not provided, recommended learning rate will be used.", + "precision": { + "description": "The calculated precision.", + "format": "float", + "type": "number" + }, + "predictedDocumentCount": { + "description": "The amount of documents with a predicted occurrence.", + "format": "int32", + "type": "integer" + }, + "predictedOccurrencesCount": { + "description": "The amount of occurrences in predicted documents.", + "format": "int32", + "type": "integer" + }, + "recall": { + "description": "The calculated recall.", "format": "float", "type": "number" }, - "trainSteps": { - "description": "Optional. The number of steps to run for model tuning. Valid values are between 1 and 400. If not provided, recommended steps will be used.", + "totalDocumentsCount": { + "description": "The amount of documents that had an occurrence of this label.", + "format": "int32", + "type": "integer" + }, + "truePositivesCount": { + "description": "The amount of true positives.", "format": "int32", "type": "integer" } }, "type": "object" }, - "GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData": { - "description": "The input data used to train a new ProcessorVersion.", - "id": "GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData", + "GoogleCloudDocumentaiV1beta3EvaluationReference": { + "description": "Gives a short summary of an evaluation, and links to the evaluation itself.", + "id": "GoogleCloudDocumentaiV1beta3EvaluationReference", "properties": { - "testDocuments": { - "$ref": "GoogleCloudDocumentaiV1BatchDocumentsInputConfig", - "description": "The documents used for testing the trained version." + "aggregateMetrics": { + "$ref": "GoogleCloudDocumentaiV1beta3EvaluationMetrics", + "description": "An aggregate of the statistics for the evaluation with fuzzy matching on." }, - "trainingDocuments": { - "$ref": "GoogleCloudDocumentaiV1BatchDocumentsInputConfig", - "description": "The documents used for training the new version." + "aggregateMetricsExact": { + "$ref": "GoogleCloudDocumentaiV1beta3EvaluationMetrics", + "description": "An aggregate of the statistics for the evaluation with fuzzy matching off." + }, + "evaluation": { + "description": "The resource name of the evaluation.", + "type": "string" + }, + "operation": { + "description": "The resource name of the Long Running Operation for the evaluation.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1TrainProcessorVersionResponse": { - "description": "The response for TrainProcessorVersion.", - "id": "GoogleCloudDocumentaiV1TrainProcessorVersionResponse", + "GoogleCloudDocumentaiV1beta3FieldExtractionMetadata": { + "description": "Metadata for how this field value is extracted.", + "id": "GoogleCloudDocumentaiV1beta3FieldExtractionMetadata", "properties": { - "processorVersion": { - "description": "The resource name of the processor version produced by training.", - "type": "string" + "summaryOptions": { + "$ref": "GoogleCloudDocumentaiV1beta3SummaryOptions", + "description": "Summary options config." } }, "type": "object" }, - "GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata": { - "description": "The long-running operation metadata for the UndeployProcessorVersion method.", - "id": "GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata", + "GoogleCloudDocumentaiV1beta3GcsPrefix": { + "description": "Specifies all documents on Cloud Storage with a common prefix.", + "id": "GoogleCloudDocumentaiV1beta3GcsPrefix", "properties": { - "commonMetadata": { - "$ref": "GoogleCloudDocumentaiV1CommonOperationMetadata", - "description": "The basic metadata of the long-running operation." + "gcsUriPrefix": { + "description": "The URI prefix.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1UndeployProcessorVersionRequest": { - "description": "Request message for the UndeployProcessorVersion method.", - "id": "GoogleCloudDocumentaiV1UndeployProcessorVersionRequest", - "properties": {}, - "type": "object" - }, - "GoogleCloudDocumentaiV1UndeployProcessorVersionResponse": { - "description": "Response message for the UndeployProcessorVersion method.", - "id": "GoogleCloudDocumentaiV1UndeployProcessorVersionResponse", - "properties": {}, - "type": "object" - }, - "GoogleCloudDocumentaiV1Vertex": { - "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.", - "id": "GoogleCloudDocumentaiV1Vertex", + "GoogleCloudDocumentaiV1beta3HumanReviewStatus": { + "description": "The status of human review on a processed document.", + "id": "GoogleCloudDocumentaiV1beta3HumanReviewStatus", "properties": { - "x": { - "description": "X coordinate.", - "format": "int32", - "type": "integer" + "humanReviewOperation": { + "description": "The name of the operation triggered by the processed document. This field is populated only when the state is `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as the long-running operation returned by ReviewDocument.", + "type": "string" }, - "y": { - "description": "Y coordinate (starts from the top of the image).", - "format": "int32", - "type": "integer" + "state": { + "description": "The state of human review on the processing request.", + "enum": [ + "STATE_UNSPECIFIED", + "SKIPPED", + "VALIDATION_PASSED", + "IN_PROGRESS", + "ERROR" + ], + "enumDescriptions": [ + "Human review state is unspecified. Most likely due to an internal error.", + "Human review is skipped for the document. This can happen because human review isn't enabled on the processor or the processing request has been set to skip this document.", + "Human review validation is triggered and passed, so no review is needed.", + "Human review validation is triggered and the document is under review.", + "Some error happened during triggering human review, see the state_message for details." + ], + "type": "string" + }, + "stateMessage": { + "description": "A message providing more details about the human review state.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata": { - "id": "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata", + "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata": { + "description": "Metadata of the import document operation.", + "id": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", "description": "The basic metadata of the long-running operation." }, - "errorDocumentCount": { - "description": "Total number of documents that failed to be deleted in storage.", - "format": "int32", - "type": "integer" + "importConfigValidationResults": { + "description": "Validation statuses of the batch documents import config.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult" + }, + "type": "array" }, - "individualBatchDeleteStatuses": { + "individualImportStatuses": { "description": "The list of response details of each document.", "items": { - "$ref": "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus" + "$ref": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus" }, "type": "array" }, "totalDocumentCount": { - "description": "Total number of documents deleting from dataset.", + "description": "Total number of the documents that are qualified for importing.", "format": "int32", "type": "integer" } }, "type": "object" }, - "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus": { - "description": "The status of each individual document in the batch delete process.", - "id": "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus", + "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult": { + "description": "The validation status of each import config. Status is set to an error if there are no documents to import in the `import_config`, or `OK` if the operation will try to proceed with at least one document.", + "id": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult", "properties": { - "documentId": { - "$ref": "GoogleCloudDocumentaiV1beta3DocumentId", - "description": "The document id of the document." + "inputGcsSource": { + "description": "The source Cloud Storage URI specified in the import config.", + "type": "string" }, "status": { "$ref": "GoogleRpcStatus", - "description": "The status of deleting the document in storage." + "description": "The validation status of import config." } }, "type": "object" }, - "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse": { - "description": "Response of the delete documents operation.", - "id": "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse", - "properties": {}, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta3BatchProcessMetadata": { - "description": "The long-running operation metadata for BatchProcessDocuments.", - "id": "GoogleCloudDocumentaiV1beta3BatchProcessMetadata", + "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus": { + "description": "The status of each individual document in the import process.", + "id": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus", "properties": { - "createTime": { - "description": "The creation time of the operation.", - "format": "google-datetime", - "type": "string" - }, - "individualProcessStatuses": { - "description": "The list of response details of each document.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus" - }, - "type": "array" - }, - "state": { - "description": "The state of the current batch processing.", - "enum": [ - "STATE_UNSPECIFIED", - "WAITING", - "RUNNING", - "SUCCEEDED", - "CANCELLING", - "CANCELLED", - "FAILED" - ], - "enumDescriptions": [ - "The default value. This value is used if the state is omitted.", - "Request operation is waiting for scheduling.", - "Request is being processed.", - "The batch processing completed successfully.", - "The batch processing was being cancelled.", - "The batch processing was cancelled.", - "The batch processing has failed." - ], + "inputGcsSource": { + "description": "The source Cloud Storage URI of the document.", "type": "string" }, - "stateMessage": { - "description": "A message providing more details about the current state of processing. For example, the error message if the operation is failed.", - "type": "string" + "outputDocumentId": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentId", + "description": "The document id of imported document if it was successful, otherwise empty." }, - "updateTime": { - "description": "The last update time of the operation.", - "format": "google-datetime", - "type": "string" + "status": { + "$ref": "GoogleRpcStatus", + "description": "The status of the importing of the document." } }, "type": "object" }, - "GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus": { - "description": "The status of a each individual document in the batch process.", - "id": "GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus", + "GoogleCloudDocumentaiV1beta3ImportDocumentsResponse": { + "description": "Response of the import document operation.", + "id": "GoogleCloudDocumentaiV1beta3ImportDocumentsResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata": { + "description": "The long-running operation metadata for the ImportProcessorVersion method.", + "id": "GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata", "properties": { - "humanReviewOperation": { - "deprecated": true, - "description": "The name of the operation triggered by the processed document. If the human review process isn't triggered, this field will be empty. It has the same response type and metadata as the long-running operation returned by the ReviewDocument method.", - "type": "string" - }, - "humanReviewStatus": { - "$ref": "GoogleCloudDocumentaiV1beta3HumanReviewStatus", - "description": "The status of human review on the processed document." - }, - "inputGcsSource": { - "description": "The source of the document, same as the input_gcs_source field in the request when the batch process started.", - "type": "string" - }, - "outputGcsDestination": { - "description": "The Cloud Storage output destination (in the request as DocumentOutputConfig.GcsOutputConfig.gcs_uri) of the processed document if it was successful, otherwise empty.", - "type": "string" - }, - "status": { - "$ref": "GoogleRpcStatus", - "description": "The status processing the document." + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", + "description": "The basic metadata for the long-running operation." } }, "type": "object" }, - "GoogleCloudDocumentaiV1beta3BatchProcessResponse": { - "description": "Response message for BatchProcessDocuments.", - "id": "GoogleCloudDocumentaiV1beta3BatchProcessResponse", - "properties": {}, + "GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse": { + "description": "The response message for the ImportProcessorVersion method.", + "id": "GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse", + "properties": { + "processorVersion": { + "description": "The destination processor version name.", + "type": "string" + } + }, "type": "object" }, - "GoogleCloudDocumentaiV1beta3CommonOperationMetadata": { - "description": "The common metadata for long running operations.", - "id": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", + "GoogleCloudDocumentaiV1beta3Processor": { + "description": "The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.", + "id": "GoogleCloudDocumentaiV1beta3Processor", "properties": { + "activeSchemaVersion": { + "description": "Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}", + "type": "string" + }, "createTime": { - "description": "The creation time of the operation.", + "description": "Output only. The time the processor was created.", "format": "google-datetime", + "readOnly": true, "type": "string" }, - "resource": { - "description": "A related resource to this operation.", + "defaultProcessorVersion": { + "description": "The default processor version.", "type": "string" }, - "state": { - "description": "The state of the operation.", - "enum": [ - "STATE_UNSPECIFIED", - "RUNNING", - "CANCELLING", - "SUCCEEDED", - "FAILED", - "CANCELLED" - ], - "enumDescriptions": [ - "Unspecified state.", - "Operation is still running.", - "Operation is being cancelled.", - "Operation succeeded.", - "Operation failed.", - "Operation is cancelled." - ], + "displayName": { + "description": "The display name of the processor.", "type": "string" }, - "stateMessage": { - "description": "A message providing more details about the current state of processing.", + "kmsKeyName": { + "description": "The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios.", "type": "string" }, - "updateTime": { - "description": "The last update time of the operation.", - "format": "google-datetime", + "name": { + "description": "Output only. Immutable. The resource name of the processor. Format: `projects/{project}/locations/{location}/processors/{processor}`", + "readOnly": true, "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta3Dataset": { - "description": "A singleton resource under a Processor which configures a collection of documents.", - "id": "GoogleCloudDocumentaiV1beta3Dataset", - "properties": { - "documentWarehouseConfig": { - "$ref": "GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig", - "deprecated": true, - "description": "Optional. Deprecated. Warehouse-based dataset configuration is not supported." - }, - "gcsManagedConfig": { - "$ref": "GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig", - "description": "Optional. User-managed Cloud Storage dataset configuration. Use this configuration if the dataset documents are stored under a user-managed Cloud Storage location." }, - "name": { - "description": "Dataset resource name. Format: `projects/{project}/locations/{location}/processors/{processor}/dataset`", + "processEndpoint": { + "description": "Output only. Immutable. The http endpoint that can be called to invoke processing.", + "readOnly": true, "type": "string" }, + "processorVersionAliases": { + "description": "Output only. The processor version aliases.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3ProcessorVersionAlias" + }, + "readOnly": true, + "type": "array" + }, "satisfiesPzi": { "description": "Output only. Reserved for future use.", "readOnly": true, @@ -5780,346 +7873,244 @@ "readOnly": true, "type": "boolean" }, - "spannerIndexingConfig": { - "$ref": "GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig", - "description": "Optional. A lightweight indexing source with low latency and high reliability, but lacking advanced features like CMEK and content-based search." - }, "state": { - "description": "Required. State of the dataset. Ignored when updating dataset.", + "description": "Output only. The state of the processor.", "enum": [ "STATE_UNSPECIFIED", - "UNINITIALIZED", - "INITIALIZING", - "INITIALIZED" + "ENABLED", + "DISABLED", + "ENABLING", + "DISABLING", + "CREATING", + "FAILED", + "DELETING" ], "enumDescriptions": [ - "Default unspecified enum, should not be used.", - "Dataset has not been initialized.", - "Dataset is being initialized.", - "Dataset has been initialized." + "The processor is in an unspecified state.", + "The processor is enabled, i.e., has an enabled version which can currently serve processing requests and all the feature dependencies have been successfully initialized.", + "The processor is disabled.", + "The processor is being enabled, will become `ENABLED` if successful.", + "The processor is being disabled, will become `DISABLED` if successful.", + "The processor is being created, will become either `ENABLED` (for successful creation) or `FAILED` (for failed ones). Once a processor is in this state, it can then be used for document processing, but the feature dependencies of the processor might not be fully created yet.", + "The processor failed during creation or initialization of feature dependencies. The user should delete the processor and recreate one as all the functionalities of the processor are disabled.", + "The processor is being deleted, will be removed if successful." ], + "readOnly": true, "type": "string" }, - "unmanagedDatasetConfig": { - "$ref": "GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig", - "description": "Optional. Unmanaged dataset configuration. Use this configuration if the dataset documents are managed by the document service internally (not user-managed)." + "type": { + "description": "The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor types, see FetchProcessorTypes.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig": { - "description": "Configuration specific to the Document AI Warehouse-based implementation.", - "id": "GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig", + "GoogleCloudDocumentaiV1beta3ProcessorVersion": { + "description": "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.", + "id": "GoogleCloudDocumentaiV1beta3ProcessorVersion", "properties": { - "collection": { - "description": "Output only. The collection in Document AI Warehouse associated with the dataset.", + "createTime": { + "description": "Output only. The time the processor version was created.", + "format": "google-datetime", "readOnly": true, "type": "string" }, - "schema": { - "description": "Output only. The schema in Document AI Warehouse associated with the dataset.", + "deprecationInfo": { + "$ref": "GoogleCloudDocumentaiV1beta3ProcessorVersionDeprecationInfo", + "description": "Output only. If set, information about the eventual deprecation of this version.", + "readOnly": true + }, + "displayName": { + "description": "The display name of the processor version.", + "type": "string" + }, + "documentSchema": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentSchema", + "description": "Output only. The schema of the processor version. Describes the output.", + "readOnly": true + }, + "genAiModelInfo": { + "$ref": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo", + "description": "Output only. Information about Generative AI model-based processor versions.", + "readOnly": true + }, + "googleManaged": { + "description": "Output only. Denotes that this `ProcessorVersion` is managed by Google.", + "readOnly": true, + "type": "boolean" + }, + "kmsKeyName": { + "description": "Output only. The KMS key name used for encryption.", "readOnly": true, "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig": { - "description": "Configuration specific to the Cloud Storage-based implementation.", - "id": "GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig", - "properties": { - "gcsPrefix": { - "$ref": "GoogleCloudDocumentaiV1beta3GcsPrefix", - "description": "Required. The Cloud Storage URI (a directory) where the documents belonging to the dataset must be stored." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig": { - "description": "Configuration specific to spanner-based indexing.", - "id": "GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig", - "properties": {}, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig": { - "description": "Configuration specific to an unmanaged dataset.", - "id": "GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig", - "properties": {}, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata": { - "description": "The long-running operation metadata for the DeleteProcessor method.", - "id": "GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata", - "properties": { - "commonMetadata": { - "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", - "description": "The basic metadata of the long-running operation." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata": { - "description": "The long-running operation metadata for the DeleteProcessorVersion method.", - "id": "GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata", - "properties": { - "commonMetadata": { - "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", - "description": "The basic metadata of the long-running operation." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata": { - "description": "The long-running operation metadata for the DeployProcessorVersion method.", - "id": "GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata", - "properties": { - "commonMetadata": { - "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", - "description": "The basic metadata of the long-running operation." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse": { - "description": "Response message for the DeployProcessorVersion method.", - "id": "GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse", - "properties": {}, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta3DisableProcessorMetadata": { - "description": "The long-running operation metadata for the DisableProcessor method.", - "id": "GoogleCloudDocumentaiV1beta3DisableProcessorMetadata", - "properties": { - "commonMetadata": { - "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", - "description": "The basic metadata of the long-running operation." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta3DisableProcessorResponse": { - "description": "Response message for the DisableProcessor method. Intentionally empty proto for adding fields in future.", - "id": "GoogleCloudDocumentaiV1beta3DisableProcessorResponse", - "properties": {}, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta3DocumentId": { - "description": "Document Identifier.", - "id": "GoogleCloudDocumentaiV1beta3DocumentId", - "properties": { - "gcsManagedDocId": { - "$ref": "GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId", - "description": "A document id within user-managed Cloud Storage." }, - "revisionRef": { - "$ref": "GoogleCloudDocumentaiV1beta3RevisionRef", - "description": "Points to a specific revision of the document if set." + "kmsKeyVersionName": { + "description": "Output only. The KMS key version with which data is encrypted.", + "readOnly": true, + "type": "string" + }, + "latestEvaluation": { + "$ref": "GoogleCloudDocumentaiV1beta3EvaluationReference", + "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.", + "enum": [ + "MODEL_TYPE_UNSPECIFIED", + "MODEL_TYPE_GENERATIVE", + "MODEL_TYPE_CUSTOM" + ], + "enumDescriptions": [ + "The processor version has unspecified model type.", + "The processor version has generative model type.", + "The processor version has custom model type." + ], + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Identifier. The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`", + "type": "string" + }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" }, - "unmanagedDocId": { - "$ref": "GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId", - "description": "A document id within unmanaged dataset." + "state": { + "description": "Output only. The state of the processor version.", + "enum": [ + "STATE_UNSPECIFIED", + "DEPLOYED", + "DEPLOYING", + "UNDEPLOYED", + "UNDEPLOYING", + "CREATING", + "DELETING", + "FAILED", + "IMPORTING" + ], + "enumDescriptions": [ + "The processor version is in an unspecified state.", + "The processor version is deployed and can be used for processing.", + "The processor version is being deployed.", + "The processor version is not deployed and cannot be used for processing.", + "The processor version is being undeployed.", + "The processor version is being created.", + "The processor version is being deleted.", + "The processor version failed and is in an indeterminate state.", + "The processor version is being imported." + ], + "readOnly": true, + "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId": { - "description": "Identifies a document uniquely within the scope of a dataset in the user-managed Cloud Storage option.", - "id": "GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId", + "GoogleCloudDocumentaiV1beta3ProcessorVersionAlias": { + "description": "Contains the alias and the aliased resource name of processor version.", + "id": "GoogleCloudDocumentaiV1beta3ProcessorVersionAlias", "properties": { - "cwDocId": { - "deprecated": true, - "description": "Id of the document (indexed) managed by Content Warehouse.", + "alias": { + "description": "The alias in the form of `processor_version` resource name.", "type": "string" }, - "gcsUri": { - "description": "Required. The Cloud Storage URI where the actual document is stored.", + "processorVersion": { + "description": "The resource name of aliased processor version.", "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId": { - "description": "Identifies a document uniquely within the scope of a dataset in unmanaged option.", - "id": "GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId", + "GoogleCloudDocumentaiV1beta3ProcessorVersionDeprecationInfo": { + "description": "Information about the upcoming deprecation of this processor version.", + "id": "GoogleCloudDocumentaiV1beta3ProcessorVersionDeprecationInfo", "properties": { - "docId": { - "description": "Required. The id of the document.", + "deprecationTime": { + "description": "The time at which this processor version will be deprecated.", + "format": "google-datetime", "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta3EnableProcessorMetadata": { - "description": "The long-running operation metadata for the EnableProcessor method.", - "id": "GoogleCloudDocumentaiV1beta3EnableProcessorMetadata", - "properties": { - "commonMetadata": { - "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", - "description": "The basic metadata of the long-running operation." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta3EnableProcessorResponse": { - "description": "Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future.", - "id": "GoogleCloudDocumentaiV1beta3EnableProcessorResponse", - "properties": {}, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata": { - "description": "Metadata of the EvaluateProcessorVersion method.", - "id": "GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata", - "properties": { - "commonMetadata": { - "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", - "description": "The basic metadata of the long-running operation." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse": { - "description": "Response of the EvaluateProcessorVersion method.", - "id": "GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse", - "properties": { - "evaluation": { - "description": "The resource name of the created evaluation.", + }, + "replacementProcessorVersion": { + "description": "If set, the processor version that will be used as a replacement.", "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1beta3GcsPrefix": { - "description": "Specifies all documents on Cloud Storage with a common prefix.", - "id": "GoogleCloudDocumentaiV1beta3GcsPrefix", + "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo": { + "description": "Information about Generative AI model-based processor versions.", + "id": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo", "properties": { - "gcsUriPrefix": { - "description": "The URI prefix.", - "type": "string" + "customGenAiModelInfo": { + "$ref": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo", + "description": "Information for a custom Generative AI model created by the user." + }, + "foundationGenAiModelInfo": { + "$ref": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo", + "description": "Information for a pretrained Google-managed foundation model." } }, "type": "object" }, - "GoogleCloudDocumentaiV1beta3HumanReviewStatus": { - "description": "The status of human review on a processed document.", - "id": "GoogleCloudDocumentaiV1beta3HumanReviewStatus", + "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo": { + "description": "Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs.", + "id": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo", "properties": { - "humanReviewOperation": { - "description": "The name of the operation triggered by the processed document. This field is populated only when the state is `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as the long-running operation returned by ReviewDocument.", + "baseProcessorVersionId": { + "description": "The base processor version ID for the custom model.", "type": "string" }, - "state": { - "description": "The state of human review on the processing request.", + "customModelType": { + "description": "The type of custom model created by the user.", "enum": [ - "STATE_UNSPECIFIED", - "SKIPPED", - "VALIDATION_PASSED", - "IN_PROGRESS", - "ERROR" + "CUSTOM_MODEL_TYPE_UNSPECIFIED", + "VERSIONED_FOUNDATION", + "FINE_TUNED" ], "enumDescriptions": [ - "Human review state is unspecified. Most likely due to an internal error.", - "Human review is skipped for the document. This can happen because human review isn't enabled on the processor or the processing request has been set to skip this document.", - "Human review validation is triggered and passed, so no review is needed.", - "Human review validation is triggered and the document is under review.", - "Some error happened during triggering human review, see the state_message for details." + "The model type is unspecified.", + "The model is a versioned foundation model.", + "The model is a finetuned foundation model." ], "type": "string" - }, - "stateMessage": { - "description": "A message providing more details about the human review state.", - "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata": { - "description": "Metadata of the import document operation.", - "id": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata", + "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo": { + "description": "Information for a pretrained Google-managed foundation model.", + "id": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo", "properties": { - "commonMetadata": { - "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", - "description": "The basic metadata of the long-running operation." - }, - "importConfigValidationResults": { - "description": "Validation statuses of the batch documents import config.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult" - }, - "type": "array" - }, - "individualImportStatuses": { - "description": "The list of response details of each document.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus" - }, - "type": "array" + "finetuningAllowed": { + "description": "Whether finetuning is allowed for this base processor version.", + "type": "boolean" }, - "totalDocumentCount": { - "description": "Total number of the documents that are qualified for importing.", + "minTrainLabeledDocuments": { + "description": "The minimum number of labeled documents in the training dataset required for finetuning.", "format": "int32", "type": "integer" } }, "type": "object" }, - "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult": { - "description": "The validation status of each import config. Status is set to an error if there are no documents to import in the `import_config`, or `OK` if the operation will try to proceed with at least one document.", - "id": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult", - "properties": { - "inputGcsSource": { - "description": "The source Cloud Storage URI specified in the import config.", - "type": "string" - }, - "status": { - "$ref": "GoogleRpcStatus", - "description": "The validation status of import config." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus": { - "description": "The status of each individual document in the import process.", - "id": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus", + "GoogleCloudDocumentaiV1beta3PropertyMetadata": { + "description": "Metadata about a property.", + "id": "GoogleCloudDocumentaiV1beta3PropertyMetadata", "properties": { - "inputGcsSource": { - "description": "The source Cloud Storage URI of the document.", - "type": "string" - }, - "outputDocumentId": { - "$ref": "GoogleCloudDocumentaiV1beta3DocumentId", - "description": "The document id of imported document if it was successful, otherwise empty." + "fieldExtractionMetadata": { + "$ref": "GoogleCloudDocumentaiV1beta3FieldExtractionMetadata", + "description": "Field extraction metadata on the property." }, - "status": { - "$ref": "GoogleRpcStatus", - "description": "The status of the importing of the document." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta3ImportDocumentsResponse": { - "description": "Response of the import document operation.", - "id": "GoogleCloudDocumentaiV1beta3ImportDocumentsResponse", - "properties": {}, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata": { - "description": "The long-running operation metadata for the ImportProcessorVersion method.", - "id": "GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata", - "properties": { - "commonMetadata": { - "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", - "description": "The basic metadata for the long-running operation." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse": { - "description": "The response message for the ImportProcessorVersion method.", - "id": "GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse", - "properties": { - "processorVersion": { - "description": "The destination processor version name.", - "type": "string" + "inactive": { + "description": "Whether the property should be considered as \"inactive\".", + "type": "boolean" } }, "type": "object" @@ -6250,6 +8241,43 @@ "properties": {}, "type": "object" }, + "GoogleCloudDocumentaiV1beta3SummaryOptions": { + "description": "Metadata for document summarization.", + "id": "GoogleCloudDocumentaiV1beta3SummaryOptions", + "properties": { + "format": { + "description": "The format the summary should be in.", + "enum": [ + "FORMAT_UNSPECIFIED", + "PARAGRAPH", + "BULLETS" + ], + "enumDescriptions": [ + "Default.", + "Format the output in paragraphs.", + "Format the output in bullets." + ], + "type": "string" + }, + "length": { + "description": "How long the summary should be.", + "enum": [ + "LENGTH_UNSPECIFIED", + "BRIEF", + "MODERATE", + "COMPREHENSIVE" + ], + "enumDescriptions": [ + "Default.", + "A brief summary of one or two sentences.", + "A paragraph-length summary.", + "The longest option available." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata": { "description": "The metadata that represents a processor version being created.", "id": "GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata", @@ -6338,6 +8366,17 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3UpdateProcessorVersionMetadata": { + "description": "The long-running operation metadata for the UpdateProcessorVersion method.", + "id": "GoogleCloudDocumentaiV1beta3UpdateProcessorVersionMetadata", + "properties": { + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", + "description": "The basic metadata for the long-running operation." + } + }, + "type": "object" + }, "GoogleCloudLocationListLocationsResponse": { "description": "The response message for Locations.ListLocations.", "id": "GoogleCloudLocationListLocationsResponse", diff --git a/discovery/documentai-v1beta3.json b/discovery/documentai-v1beta3.json index 06898c8ab9..a051f8f958 100644 --- a/discovery/documentai-v1beta3.json +++ b/discovery/documentai-v1beta3.json @@ -1289,13 +1289,352 @@ } } } + }, + "schemas": { + "methods": { + "create": { + "description": "Creates a schema.", + "flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/schemas", + "httpMethod": "POST", + "id": "documentai.projects.locations.schemas.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent (project and location) under which to create the Schema. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta3/{+parent}/schemas", + "request": { + "$ref": "GoogleCloudDocumentaiV1beta3NextSchema" + }, + "response": { + "$ref": "GoogleCloudDocumentaiV1beta3NextSchema" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a schema.", + "flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}", + "httpMethod": "DELETE", + "id": "documentai.projects.locations.schemas.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "Optional. If set to true, any child resources of this Schema will also be deleted. (Otherwise, the request will only work if the Schema has no child resources.)", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the Schema to be deleted. Format: `projects/{project}/locations/{location}/schemas/{schema}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta3/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a schema.", + "flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}", + "httpMethod": "GET", + "id": "documentai.projects.locations.schemas.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Schema to get. Format: `projects/{project}/locations/{location}/schemas/{schema}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta3/{+name}", + "response": { + "$ref": "GoogleCloudDocumentaiV1beta3NextSchema" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Schemas.", + "flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/schemas", + "httpMethod": "GET", + "id": "documentai.projects.locations.schemas.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of schema groups to return. If unspecified, at most `10` Schema will be returned. The maximum value is `20`. Values above `20` will be coerced to `20`.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. We will return the schema groups sorted by creation time. The page token will point to the next Schema.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta3/{+parent}/schemas", + "response": { + "$ref": "GoogleCloudDocumentaiV1beta3ListSchemasResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a schema. Editable fields are: - `display_name` - `labels`", + "flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}", + "httpMethod": "PATCH", + "id": "documentai.projects.locations.schemas.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name. - labels.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta3/{+name}", + "request": { + "$ref": "GoogleCloudDocumentaiV1beta3NextSchema" + }, + "response": { + "$ref": "GoogleCloudDocumentaiV1beta3NextSchema" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "schemaVersions": { + "methods": { + "create": { + "description": "Creates a schema version.", + "flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions", + "httpMethod": "POST", + "id": "documentai.projects.locations.schemas.schemaVersions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent (project and location) under which to create the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta3/{+parent}/schemaVersions", + "request": { + "$ref": "GoogleCloudDocumentaiV1beta3SchemaVersion" + }, + "response": { + "$ref": "GoogleCloudDocumentaiV1beta3SchemaVersion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a schema version.", + "flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions/{schemaVersionsId}", + "httpMethod": "DELETE", + "id": "documentai.projects.locations.schemas.schemaVersions.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the SchemaVersion to delete. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+/schemaVersions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta3/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "generate": { + "description": "Generates a schema version.", + "flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions:generate", + "httpMethod": "POST", + "id": "documentai.projects.locations.schemas.schemaVersions.generate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent (project, location and schema) under which to generate the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta3/{+parent}/schemaVersions:generate", + "request": { + "$ref": "GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequest" + }, + "response": { + "$ref": "GoogleCloudDocumentaiV1beta3GenerateSchemaVersionResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a schema version.", + "flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions/{schemaVersionsId}", + "httpMethod": "GET", + "id": "documentai.projects.locations.schemas.schemaVersions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the SchemaVersion to get. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+/schemaVersions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta3/{+name}", + "response": { + "$ref": "GoogleCloudDocumentaiV1beta3SchemaVersion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists SchemaVersions.", + "flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions", + "httpMethod": "GET", + "id": "documentai.projects.locations.schemas.schemaVersions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of SchemaVersion to return. If unspecified, at most `10` SchemaVersion will be returned. The maximum value is `20`. Values above `20` will be coerced to `20`.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. We will return the SchemaVersion sorted by creation time. The page token will point to the next SchemaVersion.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Format: `projects/{project}/locations/{location}/schemas/{schema}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta3/{+parent}/schemaVersions", + "response": { + "$ref": "GoogleCloudDocumentaiV1beta3ListSchemaVersionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a schema version. Editable fields are: - `display_name` - `labels`", + "flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions/{schemaVersionsId}", + "httpMethod": "PATCH", + "id": "documentai.projects.locations.schemas.schemaVersions.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+/schemaVersions/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name. - labels.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta3/{+name}", + "request": { + "$ref": "GoogleCloudDocumentaiV1beta3SchemaVersion" + }, + "response": { + "$ref": "GoogleCloudDocumentaiV1beta3SchemaVersion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } } } } } } }, - "revision": "20251013", + "revision": "20251020", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "CloudAiDocumentaiLabHifiaToolsValidationValidatorInput": { @@ -1920,9 +2259,172 @@ }, "type": "object" }, - "GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata": { - "description": "The long-running operation metadata for the EnableProcessor method.", - "id": "GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata", + "GoogleCloudDocumentaiUiv1beta3DocumentSchema": { + "description": "The schema defines the output of the processed document by a processor.", + "id": "GoogleCloudDocumentaiUiv1beta3DocumentSchema", + "properties": { + "description": { + "description": "Description of the schema.", + "type": "string" + }, + "displayName": { + "description": "Display name to show to users.", + "type": "string" + }, + "entityTypes": { + "description": "Entity types of the schema.", + "items": { + "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType" + }, + "type": "array" + }, + "metadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata", + "description": "Metadata of the schema." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType": { + "description": "EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.", + "id": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType", + "properties": { + "baseTypes": { + "description": "The entity type that this type is derived from. For now, one and only one should be set.", + "items": { + "type": "string" + }, + "type": "array" + }, + "description": { + "description": "The description of the entity type. Could be used to provide more information about the entity type for model calls.", + "type": "string" + }, + "displayName": { + "description": "User defined name for the type.", + "type": "string" + }, + "entityTypeMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata", + "description": "Metadata for the entity type." + }, + "enumValues": { + "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues", + "description": "If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file." + }, + "name": { + "description": "Name of the type. It must be unique within the schema file and cannot be a \"Common Type\". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.", + "type": "string" + }, + "properties": { + "description": "Description the nested structure, or composition of an entity.", + "items": { + "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues": { + "description": "Defines the a list of enum values.", + "id": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues", + "properties": { + "values": { + "description": "The individual values that this enum values type can include.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty": { + "description": "Defines properties that can be part of the entity type.", + "id": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty", + "properties": { + "description": { + "description": "The description of the property. Could be used to provide more information about the property for model calls.", + "type": "string" + }, + "displayName": { + "description": "User defined name for the property.", + "type": "string" + }, + "method": { + "description": "Specifies how the entity's value is obtained.", + "enum": [ + "METHOD_UNSPECIFIED", + "EXTRACT", + "DERIVE" + ], + "enumDescriptions": [ + "Unspecified method. It defaults to `EXTRACT`.", + "The entity's value is directly extracted as-is from the document text.", + "The entity's value is derived through inference and is not necessarily an exact text extraction from the document." + ], + "type": "string" + }, + "name": { + "description": "The name of the property. Follows the same guidelines as the EntityType name.", + "type": "string" + }, + "occurrenceType": { + "description": "Occurrence type limits the number of instances an entity type appears in the document.", + "enum": [ + "OCCURRENCE_TYPE_UNSPECIFIED", + "OPTIONAL_ONCE", + "OPTIONAL_MULTIPLE", + "REQUIRED_ONCE", + "REQUIRED_MULTIPLE" + ], + "enumDescriptions": [ + "Unspecified occurrence type.", + "There will be zero or one instance of this entity type. The same entity instance may be mentioned multiple times.", + "The entity type will appear zero or multiple times.", + "The entity type will only appear exactly once. The same entity instance may be mentioned multiple times.", + "The entity type will appear once or more times." + ], + "type": "string" + }, + "propertyMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3PropertyMetadata", + "description": "Any additional metadata about the property can be added here." + }, + "valueType": { + "description": "A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata": { + "description": "Metadata for global schema behavior.", + "id": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata", + "properties": { + "documentAllowMultipleLabels": { + "description": "If true, on a given page, there can be multiple `document` annotations covering it.", + "type": "boolean" + }, + "documentSplitter": { + "description": "If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).", + "type": "boolean" + }, + "prefixedNamingOnProperties": { + "description": "If set, all the nested entities must be prefixed with the parents.", + "type": "boolean" + }, + "skipNamingValidation": { + "description": "If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata": { + "description": "The long-running operation metadata for the EnableProcessor method.", + "id": "GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", @@ -1937,6 +2439,37 @@ "properties": {}, "type": "object" }, + "GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata": { + "description": "Metadata about an entity type.", + "id": "GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata", + "properties": { + "fieldTierMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3FieldTierMetadata", + "description": "Field tier metadata on the property" + }, + "humanReviewLabelingMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata", + "description": "Human review labeling config on the entity." + }, + "humanReviewMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata", + "description": "Human review config on the entity." + }, + "inactive": { + "description": "Whether the entity type should be considered inactive.", + "type": "boolean" + }, + "schemaEditabilityMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata", + "description": "Schema editability metadata on the entity." + }, + "schemaInferenceMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata", + "description": "Schema inference metadata on the entity." + } + }, + "type": "object" + }, "GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata": { "description": "Metadata of the EvaluateProcessorVersion method.", "id": "GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata", @@ -1959,6 +2492,91 @@ }, "type": "object" }, + "GoogleCloudDocumentaiUiv1beta3EvaluationMetrics": { + "description": "Evaluation metrics, either in aggregate or about a specific entity.", + "id": "GoogleCloudDocumentaiUiv1beta3EvaluationMetrics", + "properties": { + "f1Score": { + "description": "The calculated f1 score.", + "format": "float", + "type": "number" + }, + "falseNegativesCount": { + "description": "The amount of false negatives.", + "format": "int32", + "type": "integer" + }, + "falsePositivesCount": { + "description": "The amount of false positives.", + "format": "int32", + "type": "integer" + }, + "groundTruthDocumentCount": { + "description": "The amount of documents with a ground truth occurrence.", + "format": "int32", + "type": "integer" + }, + "groundTruthOccurrencesCount": { + "description": "The amount of occurrences in ground truth documents.", + "format": "int32", + "type": "integer" + }, + "precision": { + "description": "The calculated precision.", + "format": "float", + "type": "number" + }, + "predictedDocumentCount": { + "description": "The amount of documents with a predicted occurrence.", + "format": "int32", + "type": "integer" + }, + "predictedOccurrencesCount": { + "description": "The amount of occurrences in predicted documents.", + "format": "int32", + "type": "integer" + }, + "recall": { + "description": "The calculated recall.", + "format": "float", + "type": "number" + }, + "totalDocumentsCount": { + "description": "The amount of documents that had an occurrence of this label.", + "format": "int32", + "type": "integer" + }, + "truePositivesCount": { + "description": "The amount of true positives.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3EvaluationReference": { + "description": "Gives a short summary of an evaluation, and links to the evaluation itself.", + "id": "GoogleCloudDocumentaiUiv1beta3EvaluationReference", + "properties": { + "aggregateMetrics": { + "$ref": "GoogleCloudDocumentaiUiv1beta3EvaluationMetrics", + "description": "An aggregate of the statistics for the evaluation with fuzzy matching on." + }, + "aggregateMetricsExact": { + "$ref": "GoogleCloudDocumentaiUiv1beta3EvaluationMetrics", + "description": "An aggregate of the statistics for the evaluation with fuzzy matching off." + }, + "evaluation": { + "description": "The resource name of the evaluation.", + "type": "string" + }, + "operation": { + "description": "The resource name of the Long Running Operation for the evaluation.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata": { "description": "Metadata of the batch export documents operation.", "id": "GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata", @@ -2048,109 +2666,499 @@ }, "type": "object" }, - "GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse": { - "description": "Response message associated with the ExportProcessorVersion operation.", - "id": "GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse", + "GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse": { + "description": "Response message associated with the ExportProcessorVersion operation.", + "id": "GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse", + "properties": { + "gcsUri": { + "description": "The Cloud Storage URI containing the output artifacts.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata": { + "description": "Metadata for how this field value is extracted.", + "id": "GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata", + "properties": { + "entityQuery": { + "$ref": "GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery", + "description": "Entity query config." + }, + "summaryOptions": { + "$ref": "GoogleCloudDocumentaiUiv1beta3SummaryOptions", + "description": "Summary options config." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery": { + "description": "Message for entity query.", + "id": "GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery", + "properties": { + "userEntityQuery": { + "description": "The original entity query inputed by the user.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3FieldTierMetadata": { + "description": "Metadata for the field tier of a property.", + "id": "GoogleCloudDocumentaiUiv1beta3FieldTierMetadata", + "properties": { + "tierLevel": { + "description": "Integer that indicates the tier of a property. e.g. Invoice has entities that are classified as tier 1 which is the most important, while tier 2 and tier 3 less so. This attribute can be used to filter schema attributes before running eval. e.g. compute F1 score for only tier 1 entities. If not present this attribute should be inferred as 1.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata": { + "description": "Metadata for human review labeling config.", + "id": "GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata", + "properties": { + "enableNormalizationEditing": { + "description": "Whether to enable normalization editing.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata": { + "description": "Metadata for Human Review config.", + "id": "GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata", + "properties": { + "confidenceThreshold": { + "description": "The confidence threshold if human review validation is enabled.", + "format": "float", + "type": "number" + }, + "enableValidation": { + "description": "Whether to enable human review validation.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata": { + "description": "Metadata of the import document operation.", + "id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata", + "properties": { + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", + "description": "The basic metadata of the long-running operation." + }, + "importConfigValidationResults": { + "description": "Validation statuses of the batch documents import config.", + "items": { + "$ref": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult" + }, + "type": "array" + }, + "individualImportStatuses": { + "description": "The list of response details of each document.", + "items": { + "$ref": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus" + }, + "type": "array" + }, + "totalDocumentCount": { + "description": "Total number of the documents that are qualified for importing.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult": { + "description": "The validation status of each import config. Status is set to an error if there are no documents to import in the `import_config`, or `OK` if the operation will try to proceed with at least one document.", + "id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult", + "properties": { + "inputGcsSource": { + "description": "The source Cloud Storage URI specified in the import config.", + "type": "string" + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "The validation status of import config." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus": { + "description": "The status of each individual document in the import process.", + "id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus", + "properties": { + "inputGcsSource": { + "description": "The source Cloud Storage URI of the document.", + "type": "string" + }, + "outputDocumentId": { + "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentId", + "description": "The document id of imported document if it was successful, otherwise empty." + }, + "outputGcsDestination": { + "description": "The output_gcs_destination of the processed document if it was successful, otherwise empty.", + "type": "string" + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "The status of the importing of the document." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse": { + "description": "Response of the import document operation.", + "id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata": { + "description": "The long-running operation metadata for the ImportProcessorVersion method.", + "id": "GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata", + "properties": { + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", + "description": "The basic metadata for the long-running operation." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse": { + "description": "The response message for the ImportProcessorVersion method.", + "id": "GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse", + "properties": { + "processorVersion": { + "description": "The destination processor version name.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3Processor": { + "description": "The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.", + "id": "GoogleCloudDocumentaiUiv1beta3Processor", + "properties": { + "activeSchemaVersion": { + "description": "Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}", + "type": "string" + }, + "createTime": { + "description": "Output only. The time the processor was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "defaultProcessorVersion": { + "description": "The default processor version.", + "type": "string" + }, + "displayName": { + "description": "The display name of the processor.", + "type": "string" + }, + "kmsKeyName": { + "description": "The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios.", + "type": "string" + }, + "name": { + "description": "Output only. Immutable. The resource name of the processor. Format: `projects/{project}/locations/{location}/processors/{processor}`", + "readOnly": true, + "type": "string" + }, + "processEndpoint": { + "description": "Output only. Immutable. The http endpoint that can be called to invoke processing.", + "readOnly": true, + "type": "string" + }, + "processorVersionAliases": { + "description": "Output only. The processor version aliases.", + "items": { + "$ref": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias" + }, + "readOnly": true, + "type": "array" + }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "state": { + "description": "Output only. The state of the processor.", + "enum": [ + "STATE_UNSPECIFIED", + "ENABLED", + "DISABLED", + "ENABLING", + "DISABLING", + "CREATING", + "FAILED", + "DELETING" + ], + "enumDescriptions": [ + "The processor is in an unspecified state.", + "The processor is enabled, i.e., has an enabled version which can currently serve processing requests and all the feature dependencies have been successfully initialized.", + "The processor is disabled.", + "The processor is being enabled, will become `ENABLED` if successful.", + "The processor is being disabled, will become `DISABLED` if successful.", + "The processor is being created, will become either `ENABLED` (for successful creation) or `FAILED` (for failed ones). Once a processor is in this state, it can then be used for document processing, but the feature dependencies of the processor might not be fully created yet.", + "The processor failed during creation or initialization of feature dependencies. The user should delete the processor and recreate one as all the functionalities of the processor are disabled.", + "The processor is being deleted, will be removed if successful." + ], + "readOnly": true, + "type": "string" + }, + "type": { + "description": "The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor types, see FetchProcessorTypes.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3ProcessorVersion": { + "description": "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.", + "id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersion", + "properties": { + "createTime": { + "description": "Output only. The time the processor version was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "deploymentAllowed": { + "description": "Output only. Denotes that this `ProcessorVersion` can be deployed and undeployed.", + "readOnly": true, + "type": "boolean" + }, + "deprecationInfo": { + "$ref": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo", + "description": "Output only. If set, information about the eventual deprecation of this version.", + "readOnly": true + }, + "displayName": { + "description": "The display name of the processor version.", + "type": "string" + }, + "documentSchema": { + "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentSchema", + "description": "Output only. The schema of the processor version. Describes the output.", + "readOnly": true + }, + "genAiModelInfo": { + "$ref": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo", + "description": "Output only. Information about Generative AI model-based processor versions.", + "readOnly": true + }, + "googleManaged": { + "description": "Output only. Denotes that this `ProcessorVersion` is managed by Google.", + "readOnly": true, + "type": "boolean" + }, + "kmsKeyName": { + "description": "Output only. The KMS key name used for encryption.", + "readOnly": true, + "type": "string" + }, + "kmsKeyVersionName": { + "description": "Output only. The KMS key version with which data is encrypted.", + "readOnly": true, + "type": "string" + }, + "latestEvaluation": { + "$ref": "GoogleCloudDocumentaiUiv1beta3EvaluationReference", + "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.", + "enum": [ + "MODEL_TYPE_UNSPECIFIED", + "MODEL_TYPE_GENERATIVE", + "MODEL_TYPE_CUSTOM" + ], + "enumDescriptions": [ + "The processor version has unspecified model type.", + "The processor version has generative model type.", + "The processor version has custom model type." + ], + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Identifier. The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`", + "type": "string" + }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "schema": { + "$ref": "GoogleCloudDocumentaiUiv1beta3Schema", + "description": "The schema of the processor version. Describes the output." + }, + "state": { + "description": "Output only. The state of the processor version.", + "enum": [ + "STATE_UNSPECIFIED", + "DEPLOYED", + "DEPLOYING", + "UNDEPLOYED", + "UNDEPLOYING", + "CREATING", + "DELETING", + "FAILED", + "IMPORTING" + ], + "enumDescriptions": [ + "The processor version is in an unspecified state.", + "The processor version is deployed and can be used for processing.", + "The processor version is being deployed.", + "The processor version is not deployed and cannot be used for processing.", + "The processor version is being undeployed.", + "The processor version is being created.", + "The processor version is being deleted.", + "The processor version failed and is in an indeterminate state.", + "The processor version is being imported." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias": { + "description": "Contains the alias and the aliased resource name of processor version.", + "id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias", "properties": { - "gcsUri": { - "description": "The Cloud Storage URI containing the output artifacts.", + "alias": { + "description": "The alias in the form of `processor_version` resource name.", + "type": "string" + }, + "processorVersion": { + "description": "The resource name of aliased processor version.", "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata": { - "description": "Metadata of the import document operation.", - "id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata", + "GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo": { + "description": "Information about the upcoming deprecation of this processor version.", + "id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo", "properties": { - "commonMetadata": { - "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long-running operation." - }, - "importConfigValidationResults": { - "description": "Validation statuses of the batch documents import config.", - "items": { - "$ref": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult" - }, - "type": "array" - }, - "individualImportStatuses": { - "description": "The list of response details of each document.", - "items": { - "$ref": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus" - }, - "type": "array" + "deprecationTime": { + "description": "The time at which this processor version will be deprecated.", + "format": "google-datetime", + "type": "string" }, - "totalDocumentCount": { - "description": "Total number of the documents that are qualified for importing.", - "format": "int32", - "type": "integer" + "replacementProcessorVersion": { + "description": "If set, the processor version that will be used as a replacement.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult": { - "description": "The validation status of each import config. Status is set to an error if there are no documents to import in the `import_config`, or `OK` if the operation will try to proceed with at least one document.", - "id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult", + "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo": { + "description": "Information about Generative AI model-based processor versions.", + "id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo", "properties": { - "inputGcsSource": { - "description": "The source Cloud Storage URI specified in the import config.", - "type": "string" + "customGenAiModelInfo": { + "$ref": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo", + "description": "Information for a custom Generative AI model created by the user." }, - "status": { - "$ref": "GoogleRpcStatus", - "description": "The validation status of import config." + "foundationGenAiModelInfo": { + "$ref": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo", + "description": "Information for a pretrained Google-managed foundation model." } }, "type": "object" }, - "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus": { - "description": "The status of each individual document in the import process.", - "id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus", + "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo": { + "description": "Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs.", + "id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo", "properties": { - "inputGcsSource": { - "description": "The source Cloud Storage URI of the document.", + "baseProcessorVersionId": { + "description": "The base processor version ID for the custom model.", "type": "string" }, - "outputDocumentId": { - "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentId", - "description": "The document id of imported document if it was successful, otherwise empty." - }, - "outputGcsDestination": { - "description": "The output_gcs_destination of the processed document if it was successful, otherwise empty.", + "customModelType": { + "description": "The type of custom model created by the user.", + "enum": [ + "CUSTOM_MODEL_TYPE_UNSPECIFIED", + "VERSIONED_FOUNDATION", + "FINE_TUNED" + ], + "enumDescriptions": [ + "The model type is unspecified.", + "The model is a versioned foundation model.", + "The model is a finetuned foundation model." + ], "type": "string" - }, - "status": { - "$ref": "GoogleRpcStatus", - "description": "The status of the importing of the document." } }, "type": "object" }, - "GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse": { - "description": "Response of the import document operation.", - "id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse", - "properties": {}, - "type": "object" - }, - "GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata": { - "description": "The long-running operation metadata for the ImportProcessorVersion method.", - "id": "GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata", + "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo": { + "description": "Information for a pretrained Google-managed foundation model.", + "id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo", "properties": { - "commonMetadata": { - "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata for the long-running operation." + "finetuningAllowed": { + "description": "Whether finetuning is allowed for this base processor version.", + "type": "boolean" + }, + "minTrainLabeledDocuments": { + "description": "The minimum number of labeled documents in the training dataset required for finetuning.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse": { - "description": "The response message for the ImportProcessorVersion method.", - "id": "GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse", + "GoogleCloudDocumentaiUiv1beta3PropertyMetadata": { + "description": "Metadata about a property.", + "id": "GoogleCloudDocumentaiUiv1beta3PropertyMetadata", "properties": { - "processorVersion": { - "description": "The destination processor version name.", - "type": "string" + "fieldExtractionMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata", + "description": "Field extraction metadata on the property." + }, + "fieldTierMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3FieldTierMetadata", + "description": "Field tier metadata on the property" + }, + "humanReviewLabelingMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata", + "description": "Human review labeling config on the property." + }, + "humanReviewMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata", + "description": "Human review validation config on the property." + }, + "inactive": { + "description": "Whether the property should be considered as \"inactive\".", + "type": "boolean" + }, + "schemaEditabilityMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata", + "description": "Schema editability metadata on the property." + }, + "schemaInferenceMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata", + "description": "Schema inference metadata on the property." } }, "type": "object" @@ -2257,59 +3265,192 @@ "BASE_OCR_REVISION" ], "enumDescriptions": [ - "Unspecified case, fall back to read the `LATEST_HUMAN_REVIEW`.", - "The latest revision made by a human.", - "The latest revision based on timestamp.", - "The first (OCR) revision." + "Unspecified case, fall back to read the `LATEST_HUMAN_REVIEW`.", + "The latest revision made by a human.", + "The latest revision based on timestamp.", + "The first (OCR) revision." + ], + "type": "string" + }, + "revisionId": { + "description": "Reads the revision given by the id.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata": { + "description": "Metadata of the sample documents operation.", + "id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata", + "properties": { + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", + "description": "The basic metadata of the long-running operation." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse": { + "description": "Response of the sample documents operation.", + "id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse", + "properties": { + "sampleTestStatus": { + "$ref": "GoogleRpcStatus", + "description": "The status of sampling documents in test split." + }, + "sampleTrainingStatus": { + "$ref": "GoogleRpcStatus", + "description": "The status of sampling documents in training split." + }, + "selectedDocuments": { + "description": "The result of the sampling process.", + "items": { + "$ref": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument": { + "id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument", + "properties": { + "documentId": { + "description": "An internal identifier for document.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3Schema": { + "description": "The schema defines the output of the processed document by a processor.", + "id": "GoogleCloudDocumentaiUiv1beta3Schema", + "properties": { + "description": { + "description": "Description of the schema.", + "type": "string" + }, + "displayName": { + "description": "Display name to show to users.", + "type": "string" + }, + "entityTypes": { + "description": "Entity types of the schema.", + "items": { + "$ref": "GoogleCloudDocumentaiUiv1beta3SchemaEntityType" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata": { + "description": "Metadata that specifies whether a label is editable and reasons why. These fields are read-only. Changing these fields has no impact on the backend.", + "id": "GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata", + "properties": { + "editable": { + "description": "Explicit flag that controls whether the label is editable.", + "type": "boolean" + }, + "processorVersions": { + "description": "Full resource name of processor versions that contain this label. e.g. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiUiv1beta3SchemaEntityType": { + "description": "EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.", + "id": "GoogleCloudDocumentaiUiv1beta3SchemaEntityType", + "properties": { + "baseType": { + "type": "string" + }, + "description": { + "description": "Description of the entity type.", + "type": "string" + }, + "enumValues": { + "description": "If specified, lists all the possible values for this entity.", + "items": { + "type": "string" + }, + "type": "array" + }, + "hide": { + "description": "If the entity type is hidden in the schema. This provides the functionality to temporally \"disable\" an entity without deleting it.", + "type": "boolean" + }, + "method": { + "description": "Specifies how the entity's value is obtained.", + "enum": [ + "METHOD_UNSPECIFIED", + "EXTRACT", + "DERIVE" + ], + "enumDescriptions": [ + "Unspecified method. It defaults to `EXTRACT`.", + "The entity's value is directly extracted as-is from the document text.", + "The entity's value is derived through inference and is not necessarily an exact text extraction from the document." ], "type": "string" }, - "revisionId": { - "description": "Reads the revision given by the id.", + "occurrenceType": { + "description": "Occurrence type limits the number of times an entity type appears in the document.", + "enum": [ + "OCCURRENCE_TYPE_UNSPECIFIED", + "OPTIONAL_ONCE", + "OPTIONAL_MULTIPLE", + "REQUIRED_ONCE", + "REQUIRED_MULTIPLE" + ], + "enumDescriptions": [ + "Unspecified occurrence type.", + "The entity type will appear zero times or once.", + "The entity type will appear zero or multiple times.", + "The entity type will only appear exactly once.", + "The entity type will appear once or more times." + ], "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata": { - "description": "Metadata of the sample documents operation.", - "id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata", - "properties": { - "commonMetadata": { - "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", - "description": "The basic metadata of the long-running operation." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse": { - "description": "Response of the sample documents operation.", - "id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse", - "properties": { - "sampleTestStatus": { - "$ref": "GoogleRpcStatus", - "description": "The status of sampling documents in test split." - }, - "sampleTrainingStatus": { - "$ref": "GoogleRpcStatus", - "description": "The status of sampling documents in training split." }, - "selectedDocuments": { - "description": "The result of the sampling process.", + "properties": { + "description": "Describing the nested structure of an entity. An EntityType may consist of several other EntityTypes. For example, in a document there can be an EntityType `ID`, which consists of EntityType `name` and `address`, with corresponding attributes, such as TEXT for both types and ONCE for occurrence types.", "items": { - "$ref": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument" + "$ref": "GoogleCloudDocumentaiUiv1beta3SchemaEntityType" }, "type": "array" + }, + "source": { + "description": "Source of this entity type.", + "enum": [ + "SOURCE_UNSPECIFIED", + "PREDEFINED", + "USER_INPUT" + ], + "enumDescriptions": [ + "Unspecified source.", + "The entity type is in the predefined schema of a pretrained version of a processor.", + "The entity type is added by the users either: - during an uptraining of an existing processor, or - during the process of creating a customized processor." + ], + "type": "string" + }, + "type": { + "description": "Name of the type. It must satisfy the following constraints: 1. Must be unique within the set of same level types (with case-insensitive match). 2. Maximum 64 characters. 3. Must start with a letter. 4. Allowed characters: ASCII letters [a-zA-Z], ASCII digits [0-9], or one of the following punctuation characters: * underscore '_' (recommended) * hyphen '-' (allowed, not recommended) * colon ':' (allowed, not recommended) NOTE: Whitespace characters are not allowed. 5. Cannot end with a punctuation character. 6. Cannot contain the following restricted strings: \"google\", \"DocumentAI\" (case-insensitive match). 7. A slash character '/' is reserved as a separator in flattened representations of nested entity types (e.g., \"line_item/amount\") in which case each part (e.g., \"line_item\", \"amount\") must comply with the rules defined above. We recommend using the snake case (\"snake_case\") in entity type names.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument": { - "id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument", + "GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata": { + "description": "Metadata for schema inference. Only used on dataset.schema for schema inference, can be safely ignored elsewhere.", + "id": "GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata", "properties": { - "documentId": { - "description": "An internal identifier for document.", - "type": "string" + "inferred": { + "description": "True if is inferred by schema inference.", + "type": "boolean" } }, "type": "object" @@ -2331,6 +3472,43 @@ "properties": {}, "type": "object" }, + "GoogleCloudDocumentaiUiv1beta3SummaryOptions": { + "description": "Metadata for document summarization.", + "id": "GoogleCloudDocumentaiUiv1beta3SummaryOptions", + "properties": { + "format": { + "description": "The format the summary should be in.", + "enum": [ + "FORMAT_UNSPECIFIED", + "PARAGRAPH", + "BULLETS" + ], + "enumDescriptions": [ + "Default.", + "Format the output in paragraphs.", + "Format the output in bullets." + ], + "type": "string" + }, + "length": { + "description": "How long the summary should be.", + "enum": [ + "LENGTH_UNSPECIFIED", + "BRIEF", + "MODERATE", + "COMPREHENSIVE" + ], + "enumDescriptions": [ + "Default.", + "A brief summary of one or two sentences.", + "A paragraph-length summary.", + "The longest option available." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata": { "description": "The metadata that represents a processor version being created.", "id": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata", @@ -2441,6 +3619,17 @@ }, "type": "object" }, + "GoogleCloudDocumentaiUiv1beta3UpdateProcessorVersionMetadata": { + "description": "The long-running operation metadata for the UpdateProcessorVersion method.", + "id": "GoogleCloudDocumentaiUiv1beta3UpdateProcessorVersionMetadata", + "properties": { + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", + "description": "The basic metadata for the long-running operation." + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1BatchProcessMetadata": { "description": "The long-running operation metadata for BatchProcessDocuments.", "id": "GoogleCloudDocumentaiV1BatchProcessMetadata", @@ -4057,12 +5246,16 @@ "description": "Validation result for a single validation rule.", "id": "GoogleCloudDocumentaiV1beta3DocumentEntityValidationOutputValidationResult", "properties": { + "rule": { + "description": "Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}`", + "type": "string" + }, "ruleDescription": { "description": "The description of the validation rule.", "type": "string" }, "ruleName": { - "description": "The name of the validation rule.", + "description": "The display name of the validation rule.", "type": "string" }, "validationDetails": { @@ -5386,6 +6579,20 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3Documents": { + "description": "A set of inline documents.", + "id": "GoogleCloudDocumentaiV1beta3Documents", + "properties": { + "documents": { + "description": "The list of documents.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3Document" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3EnableProcessorMetadata": { "description": "The long-running operation metadata for the EnableProcessor method.", "id": "GoogleCloudDocumentaiV1beta3EnableProcessorMetadata", @@ -5738,6 +6945,63 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequest": { + "description": "Request message for GenerateSchemaVersion.", + "id": "GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequest", + "properties": { + "baseSchemaVersion": { + "description": "The base schema version name to use for the schema generation. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`", + "type": "string" + }, + "gcsDocuments": { + "$ref": "GoogleCloudDocumentaiV1beta3GcsDocuments", + "description": "The set of documents placed on Cloud Storage." + }, + "gcsPrefix": { + "$ref": "GoogleCloudDocumentaiV1beta3GcsPrefix", + "description": "The common prefix of documents placed on Cloud Storage." + }, + "generateSchemaVersionParams": { + "$ref": "GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequestGenerateSchemaVersionParams", + "description": "Optional. User specified parameters for the schema generation." + }, + "inlineDocuments": { + "$ref": "GoogleCloudDocumentaiV1beta3Documents", + "description": "The set of documents specified inline." + }, + "rawDocuments": { + "$ref": "GoogleCloudDocumentaiV1beta3RawDocuments", + "description": "The set of raw documents." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequestGenerateSchemaVersionParams": { + "description": "The parameters for the schema generation.", + "id": "GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequestGenerateSchemaVersionParams", + "properties": { + "history": { + "$ref": "GoogleCloudDocumentaiV1beta3SchemaGenerationHistory", + "description": "Optional. Previous prompt-answers in a chronological order." + }, + "prompt": { + "description": "Optional. The prompt used for the schema generation.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3GenerateSchemaVersionResponse": { + "description": "Response message for GenerateSchemaVersion.", + "id": "GoogleCloudDocumentaiV1beta3GenerateSchemaVersionResponse", + "properties": { + "schemaVersion": { + "$ref": "GoogleCloudDocumentaiV1beta3SchemaVersion", + "description": "The schema version generated by the model." + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3GetDocumentResponse": { "id": "GoogleCloudDocumentaiV1beta3GetDocumentResponse", "properties": { @@ -6080,6 +7344,76 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3ListSchemaVersionsResponse": { + "description": "Response message for ListSchemaVersions.", + "id": "GoogleCloudDocumentaiV1beta3ListSchemaVersionsResponse", + "properties": { + "nextPageToken": { + "description": "Points to the next SchemaVersion, otherwise empty.", + "type": "string" + }, + "schemaVersions": { + "description": "The list of SchemaVersions.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3SchemaVersion" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3ListSchemasResponse": { + "description": "Response message for ListSchemas.", + "id": "GoogleCloudDocumentaiV1beta3ListSchemasResponse", + "properties": { + "nextPageToken": { + "description": "Points to the next Schema, otherwise empty.", + "type": "string" + }, + "schemas": { + "description": "The list of Schemas.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3NextSchema" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3NextSchema": { + "description": "NextSchema is a collection of SchemaVersions.", + "id": "GoogleCloudDocumentaiV1beta3NextSchema", + "properties": { + "createTime": { + "description": "Output only. The time when the Schema was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Optional. The user-defined name of the Schema.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The GCP labels for the Schema.", + "type": "object" + }, + "name": { + "description": "Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}`", + "type": "string" + }, + "updateTime": { + "description": "Output only. The time when the Schema was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3NormalizedVertex": { "description": "A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.", "id": "GoogleCloudDocumentaiV1beta3NormalizedVertex", @@ -6353,6 +7687,10 @@ "description": "The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.", "id": "GoogleCloudDocumentaiV1beta3Processor", "properties": { + "activeSchemaVersion": { + "description": "Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}", + "type": "string" + }, "createTime": { "description": "Output only. The time the processor was created.", "format": "google-datetime", @@ -6733,6 +8071,20 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3RawDocuments": { + "description": "Specifies a set of raw documents.", + "id": "GoogleCloudDocumentaiV1beta3RawDocuments", + "properties": { + "documents": { + "description": "Specifies raw document content and mime type.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3RawDocument" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata": { "description": "The long-running operation metadata for the ReviewDocument method.", "id": "GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata", @@ -6878,6 +8230,71 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3SchemaGenerationHistory": { + "description": "The history of schema generation iterations.", + "id": "GoogleCloudDocumentaiV1beta3SchemaGenerationHistory", + "properties": { + "iterations": { + "description": "Required. Previous prompt-answers in a chronological order.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3SchemaGenerationIteration" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3SchemaGenerationIteration": { + "description": "A single iteration of the schema generation.", + "id": "GoogleCloudDocumentaiV1beta3SchemaGenerationIteration", + "properties": { + "adjustedSchema": { + "$ref": "GoogleCloudDocumentaiV1beta3SchemaVersion", + "description": "Optional. The previous schema version adjusted by the model." + }, + "generatedSchema": { + "$ref": "GoogleCloudDocumentaiV1beta3SchemaVersion", + "description": "Required. The schema version generated by the model." + }, + "prompt": { + "description": "Optional. The prompt used for the iteration.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3SchemaVersion": { + "description": "SchemaVersion is a version of the Schema which is created in SchemaGroup.", + "id": "GoogleCloudDocumentaiV1beta3SchemaVersion", + "properties": { + "createTime": { + "description": "Output only. The time when the SchemaVersion was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Optional. The user-defined name of the SchemaVersion.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The GCP labels for the SchemaVersion.", + "type": "object" + }, + "name": { + "description": "Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`", + "type": "string" + }, + "schema": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentSchema", + "description": "Required. The schema of the SchemaVersion." + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata": { "description": "The long-running operation metadata for the SetDefaultProcessorVersion method.", "id": "GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata", @@ -7121,6 +8538,17 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3UpdateProcessorVersionMetadata": { + "description": "The long-running operation metadata for the UpdateProcessorVersion method.", + "id": "GoogleCloudDocumentaiV1beta3UpdateProcessorVersionMetadata", + "properties": { + "commonMetadata": { + "$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", + "description": "The basic metadata for the long-running operation." + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3Vertex": { "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.", "id": "GoogleCloudDocumentaiV1beta3Vertex", diff --git a/discovery/drive-v3.json b/discovery/drive-v3.json index 576d91b2ce..7665bbb452 100644 --- a/discovery/drive-v3.json +++ b/discovery/drive-v3.json @@ -2720,7 +2720,7 @@ } } }, - "revision": "20251013", + "revision": "20251019", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { @@ -3229,6 +3229,11 @@ "description": "A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Manage comments and replies](https://developers.google.com/workspace/drive/api/v3/manage-comments).", "type": "string" }, + "assigneeEmailAddress": { + "description": "Output only. The email of the user who is assigned to this comment, if none is assigned this will be unset.", + "readOnly": true, + "type": "string" + }, "author": { "$ref": "User", "description": "Output only. The author of the comment. The author's email address and permission ID will not be populated." @@ -3265,6 +3270,14 @@ "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#comment\"`.", "type": "string" }, + "mentionedEmailAddresses": { + "description": "Output only. The emails of the users who were mentioned in this comment, if none were mentioned this will be an empty list.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "modifiedTime": { "description": "The last time the comment or any of its replies was modified (RFC 3339 date-time).", "format": "date-time", @@ -4768,6 +4781,11 @@ "description": "The action the reply performed to the parent comment. Valid values are: * `resolve` * `reopen`", "type": "string" }, + "assigneeEmailAddress": { + "description": "Output only. The email of the user who is assigned to this reply, if none is assigned this will be unset.", + "readOnly": true, + "type": "string" + }, "author": { "$ref": "User", "description": "Output only. The author of the reply. The author's email address and permission ID will not be populated." @@ -4803,6 +4821,14 @@ "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#reply\"`.", "type": "string" }, + "mentionedEmailAddresses": { + "description": "Output only. The emails of the users who were mentioned in this reply, if none were mentioned this will be an empty list.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "modifiedTime": { "description": "The last time the reply was modified (RFC 3339 date-time).", "format": "date-time", diff --git a/discovery/eventarc-v1.json b/discovery/eventarc-v1.json index b00edd0b45..e82a86751f 100644 --- a/discovery/eventarc-v1.json +++ b/discovery/eventarc-v1.json @@ -169,7 +169,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2471,7 +2471,7 @@ } } }, - "revision": "20251007", + "revision": "20251024", "rootUrl": "https://eventarc.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/discovery/file-v1.json b/discovery/file-v1.json index f30ba93d5c..bccf76ccd8 100644 --- a/discovery/file-v1.json +++ b/discovery/file-v1.json @@ -891,6 +891,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}/operations", @@ -908,7 +913,7 @@ } } }, - "revision": "20250929", + "revision": "20251015", "rootUrl": "https://file.googleapis.com/", "schemas": { "Backup": { @@ -1113,6 +1118,17 @@ }, "type": "object" }, + "DirectoryServicesConfig": { + "description": "Directory Services configuration for Kerberos-based authentication.", + "id": "DirectoryServicesConfig", + "properties": { + "ldap": { + "$ref": "LdapConfig", + "description": "Configuration for LDAP servers." + } + }, + "type": "object" + }, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "Empty", @@ -1486,6 +1502,10 @@ "description": "The description of the instance (2048 characters or less).", "type": "string" }, + "directoryServices": { + "$ref": "DirectoryServicesConfig", + "description": "Optional. Directory Services configuration for Kerberos-based authentication. Should only be set if protocol is \"NFS_V4_1\"." + }, "etag": { "description": "Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.", "type": "string" @@ -1659,6 +1679,32 @@ }, "type": "object" }, + "LdapConfig": { + "description": "LdapConfig contains all the parameters for connecting to LDAP servers.", + "id": "LdapConfig", + "properties": { + "domain": { + "description": "Required. The LDAP domain name in the format of `my-domain.com`.", + "type": "string" + }, + "groupsOu": { + "description": "Optional. The groups Organizational Unit (OU) is optional. This parameter is a hint to allow faster lookup in the LDAP namespace. In case that this parameter is not provided, Filestore instance will query the whole LDAP namespace.", + "type": "string" + }, + "servers": { + "description": "Required. The servers names are used for specifying the LDAP servers names. The LDAP servers names can come with two formats: 1. DNS name, for example: `ldap.example1.com`, `ldap.example2.com`. 2. IP address, for example: `10.0.0.1`, `10.0.0.2`, `10.0.0.3`. All servers names must be in the same format: either all DNS names or all IP addresses.", + "items": { + "type": "string" + }, + "type": "array" + }, + "usersOu": { + "description": "Optional. The users Organizational Unit (OU) is optional. This parameter is a hint to allow faster lookup in the LDAP namespace. In case that this parameter is not provided, Filestore instance will query the whole LDAP namespace.", + "type": "string" + } + }, + "type": "object" + }, "ListBackupsResponse": { "description": "ListBackupsResponse is the result of ListBackupsRequest.", "id": "ListBackupsResponse", @@ -1741,6 +1787,13 @@ "$ref": "Operation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/discovery/file-v1beta1.json b/discovery/file-v1beta1.json index c3e2e78541..7e8d81ae5e 100644 --- a/discovery/file-v1beta1.json +++ b/discovery/file-v1beta1.json @@ -1114,6 +1114,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -1131,7 +1136,7 @@ } } }, - "revision": "20250929", + "revision": "20251015", "rootUrl": "https://file.googleapis.com/", "schemas": { "Backup": { @@ -2037,6 +2042,13 @@ "$ref": "Operation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/discovery/firebaseappdistribution-v1alpha.json b/discovery/firebaseappdistribution-v1alpha.json index 3311510186..8c81447d92 100644 --- a/discovery/firebaseappdistribution-v1alpha.json +++ b/discovery/firebaseappdistribution-v1alpha.json @@ -647,6 +647,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "clearTestCaseCache": { + "description": "Clears cached test runs for a specific test case and device(s).", + "flatPath": "v1alpha/projects/{projectsId}/apps/{appsId}/testCases/{testCasesId}:clearTestCaseCache", + "httpMethod": "POST", + "id": "firebaseappdistribution.projects.apps.testCases.clearTestCaseCache", + "parameterOrder": [ + "testCase" + ], + "parameters": { + "testCase": { + "description": "Required. The name of the test case resource for which to clear the cache. Format: `projects/{project_number}/apps/{app_id}/testCases/{test_case_id}`", + "location": "path", + "pattern": "^projects/[^/]+/apps/[^/]+/testCases/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+testCase}:clearTestCaseCache", + "request": { + "$ref": "GoogleFirebaseAppdistroV1alphaClearTestCaseCacheRequest" + }, + "response": { + "$ref": "GoogleFirebaseAppdistroV1alphaClearTestCaseCacheResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "create": { "description": "Create a new test case.", "flatPath": "v1alpha/projects/{projectsId}/apps/{appsId}/testCases", @@ -840,7 +868,7 @@ } } }, - "revision": "20251015", + "revision": "20251022", "rootUrl": "https://firebaseappdistribution.googleapis.com/", "schemas": { "AndroidxCrawlerOutputPoint": { @@ -1225,6 +1253,26 @@ "properties": {}, "type": "object" }, + "GoogleFirebaseAppdistroV1alphaClearTestCaseCacheRequest": { + "description": "Request message for `ClearTestCaseCache`.", + "id": "GoogleFirebaseAppdistroV1alphaClearTestCaseCacheRequest", + "properties": { + "testDevices": { + "description": "Optional. The list of devices for which to clear the cache. If not present, clear all of them.", + "items": { + "$ref": "GoogleFirebaseAppdistroV1alphaTestDevice" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleFirebaseAppdistroV1alphaClearTestCaseCacheResponse": { + "description": "Response empty (google.protobuf.Empty) message for `ClearTestCaseCache`", + "id": "GoogleFirebaseAppdistroV1alphaClearTestCaseCacheResponse", + "properties": {}, + "type": "object" + }, "GoogleFirebaseAppdistroV1alphaCreateReleaseNotesRequest": { "description": "The request message for `CreateReleaseNotes`.", "id": "GoogleFirebaseAppdistroV1alphaCreateReleaseNotesRequest", diff --git a/discovery/firebaseapphosting-v1.json b/discovery/firebaseapphosting-v1.json index bb6f3e7dbd..6b4549f14b 100644 --- a/discovery/firebaseapphosting-v1.json +++ b/discovery/firebaseapphosting-v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1084,6 +1084,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}/operations", @@ -1101,7 +1106,7 @@ } } }, - "revision": "20250904", + "revision": "20251023", "rootUrl": "https://firebaseapphosting.googleapis.com/", "schemas": { "ArchiveSource": { @@ -2121,6 +2126,13 @@ "$ref": "Operation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/discovery/firebaseapphosting-v1beta.json b/discovery/firebaseapphosting-v1beta.json index 6fedbcaaf8..a7df26f6ce 100644 --- a/discovery/firebaseapphosting-v1beta.json +++ b/discovery/firebaseapphosting-v1beta.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1081,6 +1081,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1beta/{+name}/operations", @@ -1098,7 +1103,7 @@ } } }, - "revision": "20250918", + "revision": "20251023", "rootUrl": "https://firebaseapphosting.googleapis.com/", "schemas": { "ArchiveSource": { @@ -2147,6 +2152,13 @@ "$ref": "Operation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/discovery/firebasedataconnect-v1.json b/discovery/firebasedataconnect-v1.json index 2b8ecdddfe..01b1d8e3b8 100644 --- a/discovery/firebasedataconnect-v1.json +++ b/discovery/firebasedataconnect-v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -294,6 +294,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}/operations", @@ -1160,7 +1165,7 @@ } } }, - "revision": "20250907", + "revision": "20251021", "rootUrl": "https://firebasedataconnect.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -1355,7 +1360,7 @@ "type": "object" }, "GraphqlError": { - "description": "GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql` and `ExecuteGraphqlRead` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation` and `ExecuteQuery` all return Code.OK with a list of `GraphqlError` in response body.", + "description": "GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql`, `ExecuteGraphqlRead` and `IntrospectGraphql` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation`, `ExecuteQuery`, `IntrospectGraphql`, `ImpersonateQuery` and `ImpersonateMutation` all return Code.OK with a list of `GraphqlError` in response body.", "id": "GraphqlError", "properties": { "extensions": { @@ -1363,7 +1368,7 @@ "description": "Additional error information." }, "locations": { - "description": "The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source.", + "description": "The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `IntrospectGraphql`, `ImpersonateQuery`, `ImpersonateMutation`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source.", "items": { "$ref": "SourceLocation" }, @@ -1437,9 +1442,30 @@ "description": "The source file name where the error occurred. Included only for `UpdateSchema` and `UpdateConnector`, it corresponds to `File.path` of the provided `Source`.", "type": "string" }, - "resource": { - "description": "Distinguish which schema or connector the error originates from. It should be set on errors from control plane APIs (e.g. `UpdateSchema`, `UpdateConnector`).", + "warningLevel": { + "description": "Warning level describes the severity and required action to suppress this warning when Firebase CLI run into it.", + "enum": [ + "WARNING_LEVEL_UNKNOWN", + "LOG_ONLY", + "INTERACTIVE_ACK", + "REQUIRE_ACK", + "REQUIRE_FORCE" + ], + "enumDescriptions": [ + "Warning level is not specified.", + "Display a warning without action needed.", + "Request a confirmation in interactive deployment flow.", + "Require an explicit confirmation in all deployment flows.", + "Require --force in all deployment flows." + ], "type": "string" + }, + "workarounds": { + "description": "Workarounds provide suggestions to address the compile errors or warnings.", + "items": { + "$ref": "Workaround" + }, + "type": "array" } }, "type": "object" @@ -1607,6 +1633,13 @@ "$ref": "Operation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -2007,6 +2040,25 @@ } }, "type": "object" + }, + "Workaround": { + "description": "Workaround provides suggestions to address errors and warnings.", + "id": "Workaround", + "properties": { + "description": { + "description": "Description of this workaround.", + "type": "string" + }, + "reason": { + "description": "Why would this workaround address the error and warning.", + "type": "string" + }, + "replace": { + "description": "A suggested code snippet to fix the error and warning.", + "type": "string" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/discovery/firebasedataconnect-v1beta.json b/discovery/firebasedataconnect-v1beta.json index 459bcce68a..01b7d252ed 100644 --- a/discovery/firebasedataconnect-v1beta.json +++ b/discovery/firebasedataconnect-v1beta.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -294,6 +294,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1beta/{+name}/operations", @@ -1160,7 +1165,7 @@ } } }, - "revision": "20250907", + "revision": "20251021", "rootUrl": "https://firebasedataconnect.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -1355,7 +1360,7 @@ "type": "object" }, "GraphqlError": { - "description": "GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql` and `ExecuteGraphqlRead` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation` and `ExecuteQuery` all return Code.OK with a list of `GraphqlError` in response body.", + "description": "GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql`, `ExecuteGraphqlRead` and `IntrospectGraphql` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation`, `ExecuteQuery`, `IntrospectGraphql`, `ImpersonateQuery` and `ImpersonateMutation` all return Code.OK with a list of `GraphqlError` in response body.", "id": "GraphqlError", "properties": { "extensions": { @@ -1363,7 +1368,7 @@ "description": "Additional error information." }, "locations": { - "description": "The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source.", + "description": "The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `IntrospectGraphql`, `ImpersonateQuery`, `ImpersonateMutation`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source.", "items": { "$ref": "SourceLocation" }, @@ -1437,9 +1442,30 @@ "description": "The source file name where the error occurred. Included only for `UpdateSchema` and `UpdateConnector`, it corresponds to `File.path` of the provided `Source`.", "type": "string" }, - "resource": { - "description": "Distinguish which schema or connector the error originates from. It should be set on errors from control plane APIs (e.g. `UpdateSchema`, `UpdateConnector`).", + "warningLevel": { + "description": "Warning level describes the severity and required action to suppress this warning when Firebase CLI run into it.", + "enum": [ + "WARNING_LEVEL_UNKNOWN", + "LOG_ONLY", + "INTERACTIVE_ACK", + "REQUIRE_ACK", + "REQUIRE_FORCE" + ], + "enumDescriptions": [ + "Warning level is not specified.", + "Display a warning without action needed.", + "Request a confirmation in interactive deployment flow.", + "Require an explicit confirmation in all deployment flows.", + "Require --force in all deployment flows." + ], "type": "string" + }, + "workarounds": { + "description": "Workarounds provide suggestions to address the compile errors or warnings.", + "items": { + "$ref": "Workaround" + }, + "type": "array" } }, "type": "object" @@ -1607,6 +1633,13 @@ "$ref": "Operation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -2007,6 +2040,25 @@ } }, "type": "object" + }, + "Workaround": { + "description": "Workaround provides suggestions to address errors and warnings.", + "id": "Workaround", + "properties": { + "description": { + "description": "Description of this workaround.", + "type": "string" + }, + "reason": { + "description": "Why would this workaround address the error and warning.", + "type": "string" + }, + "replace": { + "description": "A suggested code snippet to fix the error and warning.", + "type": "string" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/discovery/firebaseml-v2beta.json b/discovery/firebaseml-v2beta.json index e950dc8e37..5a0a6e3137 100644 --- a/discovery/firebaseml-v2beta.json +++ b/discovery/firebaseml-v2beta.json @@ -206,7 +206,7 @@ } } }, - "revision": "20251013", + "revision": "20251022", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Date": { @@ -398,16 +398,16 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1Blob": { - "description": "Content blob.", + "description": "A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video.", "id": "GoogleCloudAiplatformV1beta1Blob", "properties": { "data": { - "description": "Required. Raw bytes.", + "description": "Required. The raw bytes of the data.", "format": "byte", "type": "string" }, "displayName": { - "description": "Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.", + "description": "Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.", "type": "string" }, "mimeType": { @@ -422,28 +422,28 @@ "id": "GoogleCloudAiplatformV1beta1Candidate", "properties": { "avgLogprobs": { - "description": "Output only. Average log probability score of the candidate.", + "description": "Output only. The average log probability of the tokens in this candidate. This is a length-normalized score that can be used to compare the quality of candidates of different lengths. A higher average log probability suggests a more confident and coherent response.", "format": "double", "readOnly": true, "type": "number" }, "citationMetadata": { "$ref": "GoogleCloudAiplatformV1beta1CitationMetadata", - "description": "Output only. Source attribution of the generated content.", + "description": "Output only. A collection of citations that apply to the generated content.", "readOnly": true }, "content": { "$ref": "GoogleCloudAiplatformV1beta1Content", - "description": "Output only. Content parts of the candidate.", + "description": "Output only. The content of the candidate.", "readOnly": true }, "finishMessage": { - "description": "Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set.", + "description": "Output only. Describes the reason the model stopped generating tokens in more detail. This field is returned only when `finish_reason` is set.", "readOnly": true, "type": "string" }, "finishReason": { - "description": "Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens.", + "description": "Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating.", "enum": [ "FINISH_REASON_UNSPECIFIED", "STOP", @@ -465,44 +465,44 @@ ], "enumDescriptions": [ "The finish reason is unspecified.", - "Token generation reached a natural stopping point or a configured stop sequence.", - "Token generation reached the configured maximum output tokens.", - "Token generation stopped because the content potentially contains safety violations. NOTE: When streaming, content is empty if content filters blocks the output.", - "The token generation stopped because of potential recitation.", - "All other reasons that stopped the token generation.", - "Token generation stopped because the content contains forbidden terms.", - "Token generation stopped for potentially containing prohibited content.", - "Token generation stopped because the content potentially contains Sensitive Personally Identifiable Information (SPII).", - "The function call generated by the model is syntaxtically invalid (e.g. the function call generated is not parsable).", + "The model reached a natural stopping point or a configured stop sequence.", + "The model generated the maximum number of tokens allowed by the `max_output_tokens` parameter.", + "The model stopped generating because the content potentially violates safety policies. NOTE: When streaming, the `content` field is empty if content filters block the output.", + "The model stopped generating because the content may be a recitation from a source.", + "The model stopped generating for a reason not otherwise specified.", + "The model stopped generating because the content contains a term from a configured blocklist.", + "The model stopped generating because the content may be prohibited.", + "The model stopped generating because the content may contain sensitive personally identifiable information (SPII).", + "The model generated a function call that is syntactically invalid and can't be parsed.", "The model response was blocked by Model Armor.", - "Token generation stopped because generated images has safety violations.", - "Image generation stopped because generated images has other prohibited content.", - "Image generation stopped due to recitation.", - "Image generation stopped because of other miscellaneous issue.", - "The function call generated by the model is semantically invalid (e.g. a function call is generated when function calling is not enabled or the function is not in the function declaration).", - "The model was expected to generate an image, but none was generated." + "The generated image potentially violates safety policies.", + "The generated image may contain prohibited content.", + "The generated image may be a recitation from a source.", + "The image generation stopped for a reason not otherwise specified.", + "The model generated a function call that is semantically invalid. This can happen, for example, if function calling is not enabled or the generated function is not in the function declaration.", + "The model was expected to generate an image, but didn't." ], "readOnly": true, "type": "string" }, "groundingMetadata": { "$ref": "GoogleCloudAiplatformV1beta1GroundingMetadata", - "description": "Output only. Metadata specifies sources used to ground generated content.", + "description": "Output only. Metadata returned when grounding is enabled. It contains the sources used to ground the generated content.", "readOnly": true }, "index": { - "description": "Output only. Index of the candidate.", + "description": "Output only. The 0-based index of this candidate in the list of generated responses. This is useful for distinguishing between multiple candidates when `candidate_count` > 1.", "format": "int32", "readOnly": true, "type": "integer" }, "logprobsResult": { "$ref": "GoogleCloudAiplatformV1beta1LogprobsResult", - "description": "Output only. Log-likelihood scores for the response tokens and top tokens", + "description": "Output only. The detailed log probability information for the tokens in this candidate. This is useful for debugging, understanding model uncertainty, and identifying potential \"hallucinations\".", "readOnly": true }, "safetyRatings": { - "description": "Output only. List of ratings for the safety of a response candidate. There is at most one rating per category.", + "description": "Output only. A list of ratings for the safety of a response candidate. There is at most one rating per category.", "items": { "$ref": "GoogleCloudAiplatformV1beta1SafetyRating" }, @@ -511,45 +511,45 @@ }, "urlContextMetadata": { "$ref": "GoogleCloudAiplatformV1beta1UrlContextMetadata", - "description": "Output only. Metadata related to url context retrieval tool.", + "description": "Output only. Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL.", "readOnly": true } }, "type": "object" }, "GoogleCloudAiplatformV1beta1Citation": { - "description": "Source attributions for content.", + "description": "A citation for a piece of generatedcontent.", "id": "GoogleCloudAiplatformV1beta1Citation", "properties": { "endIndex": { - "description": "Output only. End index into the content.", + "description": "Output only. The end index of the citation in the content.", "format": "int32", "readOnly": true, "type": "integer" }, "license": { - "description": "Output only. License of the attribution.", + "description": "Output only. The license of the source of the citation.", "readOnly": true, "type": "string" }, "publicationDate": { "$ref": "Date", - "description": "Output only. Publication date of the attribution.", + "description": "Output only. The publication date of the source of the citation.", "readOnly": true }, "startIndex": { - "description": "Output only. Start index into the content.", + "description": "Output only. The start index of the citation in the content.", "format": "int32", "readOnly": true, "type": "integer" }, "title": { - "description": "Output only. Title of the attribution.", + "description": "Output only. The title of the source of the citation.", "readOnly": true, "type": "string" }, "uri": { - "description": "Output only. Url reference of the attribution.", + "description": "Output only. The URI of the source of the citation.", "readOnly": true, "type": "string" } @@ -557,11 +557,11 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1CitationMetadata": { - "description": "A collection of source attributions for a piece of content.", + "description": "A collection of citations that apply to a piece of generated content.", "id": "GoogleCloudAiplatformV1beta1CitationMetadata", "properties": { "citations": { - "description": "Output only. List of citations.", + "description": "Output only. A list of citations for the content.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Citation" }, @@ -599,18 +599,18 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1Content": { - "description": "The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.", + "description": "The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.", "id": "GoogleCloudAiplatformV1beta1Content", "properties": { "parts": { - "description": "Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.", + "description": "Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Part" }, "type": "array" }, "role": { - "description": "Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.", + "description": "Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.", "type": "string" } }, @@ -833,15 +833,15 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1FileData": { - "description": "URI based data.", + "description": "URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage.", "id": "GoogleCloudAiplatformV1beta1FileData", "properties": { "displayName": { - "description": "Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.", + "description": "Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.", "type": "string" }, "fileUri": { - "description": "Required. URI.", + "description": "Required. The URI of the file in Google Cloud Storage.", "type": "string" }, "mimeType": { @@ -1249,24 +1249,24 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1GenerationConfig": { - "description": "Generation config.", + "description": "Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output.", "id": "GoogleCloudAiplatformV1beta1GenerationConfig", "properties": { "audioTimestamp": { - "description": "Optional. If enabled, audio timestamp will be included in the request to the model.", + "description": "Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.", "type": "boolean" }, "candidateCount": { - "description": "Optional. Number of candidates to generate.", + "description": "Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.", "format": "int32", "type": "integer" }, "enableAffectiveDialog": { - "description": "Optional. If enabled, the model will detect emotions and adapt its responses accordingly.", + "description": "Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.", "type": "boolean" }, "frequencyPenalty": { - "description": "Optional. Frequency penalties.", + "description": "Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].", "format": "float", "type": "number" }, @@ -1275,17 +1275,17 @@ "description": "Optional. Config for image generation features." }, "logprobs": { - "description": "Optional. Logit probabilities.", + "description": "Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.", "format": "int32", "type": "integer" }, "maxOutputTokens": { - "description": "Optional. The maximum number of output tokens to generate per message.", + "description": "Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses.", "format": "int32", "type": "integer" }, "mediaResolution": { - "description": "Optional. If specified, the media resolution specified will be used.", + "description": "Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.", "enum": [ "MEDIA_RESOLUTION_UNSPECIFIED", "MEDIA_RESOLUTION_LOW", @@ -1306,24 +1306,24 @@ "description": "Optional. Config for model selection." }, "presencePenalty": { - "description": "Optional. Positive penalties.", + "description": "Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].", "format": "float", "type": "number" }, "responseJsonSchema": { - "description": "Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.", + "description": "Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`.", "type": "any" }, "responseLogprobs": { - "description": "Optional. If true, export the logprobs results in response.", + "description": "Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.", "type": "boolean" }, "responseMimeType": { - "description": "Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.", + "description": "Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.", "type": "string" }, "responseModalities": { - "description": "Optional. The modalities of the response.", + "description": "Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image.", "items": { "enum": [ "MODALITY_UNSPECIFIED", @@ -1343,14 +1343,14 @@ }, "responseSchema": { "$ref": "GoogleCloudAiplatformV1beta1Schema", - "description": "Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response." + "description": "Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`." }, "routingConfig": { "$ref": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig", "description": "Optional. Routing configuration." }, "seed": { - "description": "Optional. Seed.", + "description": "Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the \"random\" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results.", "format": "int32", "type": "integer" }, @@ -1359,28 +1359,28 @@ "description": "Optional. The speech generation config." }, "stopSequences": { - "description": "Optional. Stop sequences.", + "description": "Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use [\"\\n\", \"###\"] to stop generation at a new line or a specific marker.", "items": { "type": "string" }, "type": "array" }, "temperature": { - "description": "Optional. Controls the randomness of predictions.", + "description": "Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0].", "format": "float", "type": "number" }, "thinkingConfig": { "$ref": "GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig", - "description": "Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking." + "description": "Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking." }, "topK": { - "description": "Optional. If specified, top-k sampling will be used.", + "description": "Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words.", "format": "float", "type": "number" }, "topP": { - "description": "Optional. If specified, nucleus sampling will be used.", + "description": "Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.", "format": "float", "type": "number" } @@ -1411,22 +1411,22 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig": { - "description": "The configuration for routing the request to a specific model.", + "description": "The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name.", "id": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig", "properties": { "autoMode": { "$ref": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode", - "description": "Automated routing." + "description": "In this mode, the model is selected automatically based on the content of the request." }, "manualMode": { "$ref": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode", - "description": "Manual routing." + "description": "In this mode, the model is specified manually." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode": { - "description": "When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference.", + "description": "The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference.", "id": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode", "properties": { "modelRoutingPreference": { @@ -1439,9 +1439,9 @@ ], "enumDescriptions": [ "Unspecified model routing preference.", - "Prefer higher quality over low cost.", - "Balanced model routing preference.", - "Prefer lower cost over higher quality." + "The model will be selected to prioritize the quality of the response.", + "The model will be selected to balance quality and cost.", + "The model will be selected to prioritize the cost of the request." ], "type": "string" } @@ -1449,26 +1449,26 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode": { - "description": "When manual routing is set, the specified model will be used directly.", + "description": "The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided.", "id": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode", "properties": { "modelName": { - "description": "The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).", + "description": "The name of the model to use. Only public LLM models are accepted.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig": { - "description": "Config for thinking features.", + "description": "Configuration for the model's thinking features. \"Thinking\" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response.", "id": "GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig", "properties": { "includeThoughts": { - "description": "Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.", + "description": "Optional. If true, the model will include its thoughts in the response. \"Thoughts\" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available.", "type": "boolean" }, "thinkingBudget": { - "description": "Optional. Indicates the thinking budget in tokens.", + "description": "Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency.", "format": "int32", "type": "integer" } @@ -1498,57 +1498,57 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1GroundingChunk": { - "description": "Grounding chunk.", + "description": "A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information.", "id": "GoogleCloudAiplatformV1beta1GroundingChunk", "properties": { "maps": { "$ref": "GoogleCloudAiplatformV1beta1GroundingChunkMaps", - "description": "Grounding chunk from Google Maps." + "description": "A grounding chunk from Google Maps. See the `Maps` message for details." }, "retrievedContext": { "$ref": "GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext", - "description": "Grounding chunk from context retrieved by the retrieval tools." + "description": "A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details" }, "web": { "$ref": "GoogleCloudAiplatformV1beta1GroundingChunkWeb", - "description": "Grounding chunk from the web." + "description": "A grounding chunk from a web page, typically from Google Search. See the `Web` message for details." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1GroundingChunkMaps": { - "description": "Chunk from Google Maps.", + "description": "A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains information about a place, such as its name, address, and reviews. This is used to provide the user with rich, location-based information.", "id": "GoogleCloudAiplatformV1beta1GroundingChunkMaps", "properties": { "placeAnswerSources": { "$ref": "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources", - "description": "Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content." + "description": "The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content." }, "placeId": { - "description": "This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place.", + "description": "This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API.", "type": "string" }, "text": { - "description": "Text of the place answer.", + "description": "The text of the place answer.", "type": "string" }, "title": { - "description": "Title of the place.", + "description": "The title of the place.", "type": "string" }, "uri": { - "description": "URI reference of the place.", + "description": "The URI of the place.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources": { - "description": "Sources used to generate the place answer.", + "description": "The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content.", "id": "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources", "properties": { "reviewSnippets": { - "description": "Snippets of reviews that are used to generate the answer.", + "description": "Snippets of reviews that were used to generate the answer.", "items": { "$ref": "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet" }, @@ -1558,7 +1558,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet": { - "description": "Encapsulates a review snippet.", + "description": "A review snippet that is used to generate the answer.", "id": "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet", "properties": { "googleMapsUri": { @@ -1566,81 +1566,81 @@ "type": "string" }, "reviewId": { - "description": "Id of the review referencing the place.", + "description": "The ID of the review that is being referenced.", "type": "string" }, "title": { - "description": "Title of the review.", + "description": "The title of the review.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext": { - "description": "Chunk from context retrieved by the retrieval tools.", + "description": "Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset.", "id": "GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext", "properties": { "documentName": { - "description": "Output only. The full document name for the referenced Vertex AI Search document.", + "description": "Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.", "readOnly": true, "type": "string" }, "ragChunk": { "$ref": "GoogleCloudAiplatformV1beta1RagChunk", - "description": "Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool." + "description": "Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used." }, "text": { - "description": "Text of the attribution.", + "description": "The content of the retrieved data source.", "type": "string" }, "title": { - "description": "Title of the attribution.", + "description": "The title of the retrieved data source.", "type": "string" }, "uri": { - "description": "URI reference of the attribution.", + "description": "The URI of the retrieved data source.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1GroundingChunkWeb": { - "description": "Chunk from the web.", + "description": "A `Web` chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information.", "id": "GoogleCloudAiplatformV1beta1GroundingChunkWeb", "properties": { "domain": { - "description": "Domain of the (original) URI.", + "description": "The domain of the web page that contains the evidence. This can be used to filter out low-quality sources.", "type": "string" }, "title": { - "description": "Title of the chunk.", + "description": "The title of the web page that contains the evidence.", "type": "string" }, "uri": { - "description": "URI reference of the chunk.", + "description": "The URI of the web page that contains the evidence.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1GroundingMetadata": { - "description": "Metadata returned to client when grounding is enabled.", + "description": "Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources.", "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.", + "description": "Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps.", "readOnly": true, "type": "string" }, "groundingChunks": { - "description": "List of supporting references retrieved from specified grounding source.", + "description": "A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps.", "items": { "$ref": "GoogleCloudAiplatformV1beta1GroundingChunk" }, "type": "array" }, "groundingSupports": { - "description": "Optional. List of grounding support.", + "description": "Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search.", "items": { "$ref": "GoogleCloudAiplatformV1beta1GroundingSupport" }, @@ -1648,11 +1648,11 @@ }, "retrievalMetadata": { "$ref": "GoogleCloudAiplatformV1beta1RetrievalMetadata", - "description": "Optional. Output only. Retrieval metadata.", + "description": "Optional. Output only. Metadata related to the retrieval grounding source.", "readOnly": true }, "retrievalQueries": { - "description": "Optional. Queries executed by the retrieval tools.", + "description": "Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search.", "items": { "type": "string" }, @@ -1660,10 +1660,10 @@ }, "searchEntryPoint": { "$ref": "GoogleCloudAiplatformV1beta1SearchEntryPoint", - "description": "Optional. Google search entry for the following-up web searches." + "description": "Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search." }, "sourceFlaggingUris": { - "description": "Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding.", + "description": "Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps.", "items": { "$ref": "GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri" }, @@ -1671,7 +1671,7 @@ "type": "array" }, "webSearchQueries": { - "description": "Optional. Web search queries for the following-up web search.", + "description": "Optional. The web search queries that were used to generate the content. This field is populated only when the grounding source is Google Search.", "items": { "type": "string" }, @@ -1681,26 +1681,26 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri": { - "description": "Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding.", + "description": "A URI that can be used to flag a place or review for inappropriate content. This is populated only when the grounding source is Google Maps.", "id": "GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri", "properties": { "flagContentUri": { - "description": "A link where users can flag a problem with the source (place or review).", + "description": "The URI that can be used to flag the content.", "type": "string" }, "sourceId": { - "description": "Id of the place or review.", + "description": "The ID of the place or review.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1GroundingSupport": { - "description": "Grounding support.", + "description": "A collection of supporting references for a segment of the model's response.", "id": "GoogleCloudAiplatformV1beta1GroundingSupport", "properties": { "confidenceScores": { - "description": "Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored.", + "description": "The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored.", "items": { "format": "float", "type": "number" @@ -1708,7 +1708,7 @@ "type": "array" }, "groundingChunkIndices": { - "description": "A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim.", + "description": "A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment.", "items": { "format": "int32", "type": "integer" @@ -1717,13 +1717,13 @@ }, "segment": { "$ref": "GoogleCloudAiplatformV1beta1Segment", - "description": "Segment of the content this support belongs to." + "description": "The content segment that this support message applies to." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1ImageConfig": { - "description": "Config for image generation features.", + "description": "Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people.", "id": "GoogleCloudAiplatformV1beta1ImageConfig", "properties": { "aspectRatio": { @@ -1743,10 +1743,10 @@ "ALLOW_NONE" ], "enumDescriptions": [ - "Generation images of people unspecified.", - "Generate images that include adults and children.", - "Generate images of adults, but not children.", - "Block generation of images of people." + "The default behavior is unspecified. The model will decide whether to generate images of people.", + "Allows the model to generate images of people, including adults and children.", + "Allows the model to generate images of adults, but not children.", + "Prevents the model from generating images of people." ], "type": "string" } @@ -1770,18 +1770,18 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1LogprobsResult": { - "description": "Logprobs Result", + "description": "The log probabilities of the tokens generated by the model. This is useful for understanding the model's confidence in its predictions and for debugging. For example, you can use log probabilities to identify when the model is making a less confident prediction or to explore alternative responses that the model considered. A low log probability can also indicate that the model is \"hallucinating\" or generating factually incorrect information.", "id": "GoogleCloudAiplatformV1beta1LogprobsResult", "properties": { "chosenCandidates": { - "description": "Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates.", + "description": "A list of the chosen candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. Note that the chosen candidate might not be in `top_candidates`.", "items": { "$ref": "GoogleCloudAiplatformV1beta1LogprobsResultCandidate" }, "type": "array" }, "topCandidates": { - "description": "Length = total number of decoding steps.", + "description": "A list of the top candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps.", "items": { "$ref": "GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates" }, @@ -1791,20 +1791,20 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1LogprobsResultCandidate": { - "description": "Candidate for the logprobs token and score.", + "description": "A single token and its associated log probability.", "id": "GoogleCloudAiplatformV1beta1LogprobsResultCandidate", "properties": { "logProbability": { - "description": "The candidate's log probability.", + "description": "The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain.", "format": "float", "type": "number" }, "token": { - "description": "The candidate's token string value.", + "description": "The token's string representation.", "type": "string" }, "tokenId": { - "description": "The candidate's token id value.", + "description": "The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary.", "format": "int32", "type": "integer" } @@ -1812,11 +1812,11 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates": { - "description": "Candidates with top log probabilities at each decoding step.", + "description": "A list of the top candidate tokens and their log probabilities at each decoding step. This can be used to see what other tokens the model considered.", "id": "GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates", "properties": { "candidates": { - "description": "Sorted by log probability in descending order.", + "description": "The list of candidate tokens, sorted by log probability in descending order.", "items": { "$ref": "GoogleCloudAiplatformV1beta1LogprobsResultCandidate" }, @@ -1826,11 +1826,11 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1ModalityTokenCount": { - "description": "Represents token counting info for a single modality.", + "description": "Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes.", "id": "GoogleCloudAiplatformV1beta1ModalityTokenCount", "properties": { "modality": { - "description": "The modality associated with this token count.", + "description": "The modality that this token count applies to.", "enum": [ "MODALITY_UNSPECIFIED", "TEXT", @@ -1840,17 +1840,17 @@ "DOCUMENT" ], "enumDescriptions": [ - "Unspecified modality.", - "Plain text.", - "Image.", - "Video.", - "Audio.", - "Document, e.g. PDF." + "When a modality is not specified, it is treated as `TEXT`.", + "The `Part` contains plain text.", + "The `Part` contains an image.", + "The `Part` contains a video.", + "The `Part` contains audio.", + "The `Part` contains a document, such as a PDF." ], "type": "string" }, "tokenCount": { - "description": "Number of tokens.", + "description": "The number of tokens counted for this modality.", "format": "int32", "type": "integer" } @@ -1858,22 +1858,22 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1ModelArmorConfig": { - "description": "Configuration for Model Armor integrations of prompt and responses.", + "description": "Configuration for Model Armor. Model Armor is a Google Cloud service that provides safety and security filtering for prompts and responses. It helps protect your AI applications from risks such as harmful content, sensitive data leakage, and prompt injection attacks.", "id": "GoogleCloudAiplatformV1beta1ModelArmorConfig", "properties": { "promptTemplateName": { - "description": "Optional. The name of the Model Armor template to use for prompt sanitization.", + "description": "Optional. The resource name of the Model Armor template to use for prompt screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the user's prompt for safety and security risks before it is sent to the model. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`.", "type": "string" }, "responseTemplateName": { - "description": "Optional. The name of the Model Armor template to use for response sanitization.", + "description": "Optional. The resource name of the Model Armor template to use for response screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the model's response for safety and security risks before it is returned to the user. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1MultiSpeakerVoiceConfig": { - "description": "Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request.", + "description": "Configuration for a multi-speaker text-to-speech request.", "id": "GoogleCloudAiplatformV1beta1MultiSpeakerVoiceConfig", "properties": { "speakerVoiceConfigs": { @@ -1887,39 +1887,39 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1Part": { - "description": "A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.", + "description": "A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.", "id": "GoogleCloudAiplatformV1beta1Part", "properties": { "codeExecutionResult": { "$ref": "GoogleCloudAiplatformV1beta1CodeExecutionResult", - "description": "Optional. Result of executing the [ExecutableCode]." + "description": "Optional. The result of executing the ExecutableCode." }, "executableCode": { "$ref": "GoogleCloudAiplatformV1beta1ExecutableCode", - "description": "Optional. Code generated by the model that is meant to be executed." + "description": "Optional. Code generated by the model that is intended to be executed." }, "fileData": { "$ref": "GoogleCloudAiplatformV1beta1FileData", - "description": "Optional. URI based data." + "description": "Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage." }, "functionCall": { "$ref": "GoogleCloudAiplatformV1beta1FunctionCall", - "description": "Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values." + "description": "Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function." }, "functionResponse": { "$ref": "GoogleCloudAiplatformV1beta1FunctionResponse", - "description": "Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model." + "description": "Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted." }, "inlineData": { "$ref": "GoogleCloudAiplatformV1beta1Blob", - "description": "Optional. Inlined bytes data." + "description": "Optional. The inline data content of the part. This can be used to include images, audio, or video in a request." }, "text": { - "description": "Optional. Text part (can be code).", + "description": "Optional. The text content of the part.", "type": "string" }, "thought": { - "description": "Optional. Indicates if the part is thought from the model.", + "description": "Optional. Indicates whether the `part` represents the model's thought process or reasoning.", "type": "boolean" }, "thoughtSignature": { @@ -1935,11 +1935,11 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1PrebuiltVoiceConfig": { - "description": "The configuration for the prebuilt speaker to use.", + "description": "Configuration for a prebuilt voice.", "id": "GoogleCloudAiplatformV1beta1PrebuiltVoiceConfig", "properties": { "voiceName": { - "description": "The name of the preset voice to use.", + "description": "The name of the prebuilt voice to use.", "type": "string" } }, @@ -2111,11 +2111,11 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1RetrievalMetadata": { - "description": "Metadata related to retrieval in the grounding flow.", + "description": "Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled.", "id": "GoogleCloudAiplatformV1beta1RetrievalMetadata", "properties": { "googleSearchDynamicRetrievalScore": { - "description": "Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search.", + "description": "Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search.", "format": "float", "type": "number" } @@ -2123,16 +2123,16 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1SafetyRating": { - "description": "Safety rating corresponding to the generated content.", + "description": "A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level.", "id": "GoogleCloudAiplatformV1beta1SafetyRating", "properties": { "blocked": { - "description": "Output only. Indicates whether the content was filtered out because of this rating.", + "description": "Output only. Indicates whether the content was blocked because of this rating.", "readOnly": true, "type": "boolean" }, "category": { - "description": "Output only. Harm category.", + "description": "Output only. The harm category of this rating.", "enum": [ "HARM_CATEGORY_UNSPECIFIED", "HARM_CATEGORY_HATE_SPEECH", @@ -2160,17 +2160,17 @@ false ], "enumDescriptions": [ - "The harm category is unspecified.", - "The harm category is hate speech.", - "The harm category is dangerous content.", - "The harm category is harassment.", - "The harm category is sexually explicit content.", + "Default value. This value is unused.", + "Content that promotes violence or incites hatred against individuals or groups based on certain attributes.", + "Content that promotes, facilitates, or enables dangerous activities.", + "Abusive, threatening, or content intended to bully, torment, or ridicule.", + "Content that contains sexually explicit material.", "Deprecated: Election filter is not longer supported. The harm category is civic integrity.", - "The harm category is image hate.", - "The harm category is image dangerous content.", - "The harm category is image harassment.", - "The harm category is image sexually explicit content.", - "The harm category is for jailbreak prompts." + "Images that contain hate speech.", + "Images that contain dangerous content.", + "Images that contain harassment.", + "Images that contain sexually explicit content.", + "Prompts designed to bypass safety filters." ], "readOnly": true, "type": "string" @@ -2186,18 +2186,18 @@ "OFF" ], "enumDescriptions": [ - "Unspecified harm block threshold.", - "Block low threshold and above (i.e. block more).", - "Block medium threshold and above.", - "Block only high threshold (i.e. block less).", - "Block none.", - "Turn off the safety filter." + "The harm block threshold is unspecified.", + "Block content with a low harm probability or higher.", + "Block content with a medium harm probability or higher.", + "Block content with a high harm probability.", + "Do not block any content, regardless of its harm probability.", + "Turn off the safety filter entirely." ], "readOnly": true, "type": "string" }, "probability": { - "description": "Output only. Harm probability levels in the content.", + "description": "Output only. The probability of harm for this category.", "enum": [ "HARM_PROBABILITY_UNSPECIFIED", "NEGLIGIBLE", @@ -2206,23 +2206,23 @@ "HIGH" ], "enumDescriptions": [ - "Harm probability unspecified.", - "Negligible level of harm.", - "Low level of harm.", - "Medium level of harm.", - "High level of harm." + "The harm probability is unspecified.", + "The harm probability is negligible.", + "The harm probability is low.", + "The harm probability is medium.", + "The harm probability is high." ], "readOnly": true, "type": "string" }, "probabilityScore": { - "description": "Output only. Harm probability score.", + "description": "Output only. The probability score of harm for this category.", "format": "float", "readOnly": true, "type": "number" }, "severity": { - "description": "Output only. Harm severity levels in the content.", + "description": "Output only. The severity of harm for this category.", "enum": [ "HARM_SEVERITY_UNSPECIFIED", "HARM_SEVERITY_NEGLIGIBLE", @@ -2231,17 +2231,17 @@ "HARM_SEVERITY_HIGH" ], "enumDescriptions": [ - "Harm severity unspecified.", - "Negligible level of harm severity.", - "Low level of harm severity.", - "Medium level of harm severity.", - "High level of harm severity." + "The harm severity is unspecified.", + "The harm severity is negligible.", + "The harm severity is low.", + "The harm severity is medium.", + "The harm severity is high." ], "readOnly": true, "type": "string" }, "severityScore": { - "description": "Output only. Harm severity score.", + "description": "Output only. The severity score of harm for this category.", "format": "float", "readOnly": true, "type": "number" @@ -2250,11 +2250,11 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1SafetySetting": { - "description": "Safety settings.", + "description": "A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category.", "id": "GoogleCloudAiplatformV1beta1SafetySetting", "properties": { "category": { - "description": "Required. Harm category.", + "description": "Required. The harm category to be blocked.", "enum": [ "HARM_CATEGORY_UNSPECIFIED", "HARM_CATEGORY_HATE_SPEECH", @@ -2282,22 +2282,22 @@ false ], "enumDescriptions": [ - "The harm category is unspecified.", - "The harm category is hate speech.", - "The harm category is dangerous content.", - "The harm category is harassment.", - "The harm category is sexually explicit content.", + "Default value. This value is unused.", + "Content that promotes violence or incites hatred against individuals or groups based on certain attributes.", + "Content that promotes, facilitates, or enables dangerous activities.", + "Abusive, threatening, or content intended to bully, torment, or ridicule.", + "Content that contains sexually explicit material.", "Deprecated: Election filter is not longer supported. The harm category is civic integrity.", - "The harm category is image hate.", - "The harm category is image dangerous content.", - "The harm category is image harassment.", - "The harm category is image sexually explicit content.", - "The harm category is for jailbreak prompts." + "Images that contain hate speech.", + "Images that contain dangerous content.", + "Images that contain harassment.", + "Images that contain sexually explicit content.", + "Prompts designed to bypass safety filters." ], "type": "string" }, "method": { - "description": "Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score.", + "description": "Optional. The method for blocking content. If not specified, the default behavior is to use the probability score.", "enum": [ "HARM_BLOCK_METHOD_UNSPECIFIED", "SEVERITY", @@ -2311,7 +2311,7 @@ "type": "string" }, "threshold": { - "description": "Required. The harm block threshold.", + "description": "Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked.", "enum": [ "HARM_BLOCK_THRESHOLD_UNSPECIFIED", "BLOCK_LOW_AND_ABOVE", @@ -2321,12 +2321,12 @@ "OFF" ], "enumDescriptions": [ - "Unspecified harm block threshold.", - "Block low threshold and above (i.e. block more).", - "Block medium threshold and above.", - "Block only high threshold (i.e. block less).", - "Block none.", - "Turn off the safety filter." + "The harm block threshold is unspecified.", + "Block content with a low harm probability or higher.", + "Block content with a medium harm probability or higher.", + "Block content with a high harm probability.", + "Do not block any content, regardless of its harm probability.", + "Turn off the safety filter entirely." ], "type": "string" } @@ -2487,15 +2487,15 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1SearchEntryPoint": { - "description": "Google search entry point.", + "description": "An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application.", "id": "GoogleCloudAiplatformV1beta1SearchEntryPoint", "properties": { "renderedContent": { - "description": "Optional. Web content snippet that can be embedded in a web page or an app webview.", + "description": "Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result.", "type": "string" }, "sdkBlob": { - "description": "Optional. Base64 encoded JSON representing array of tuple.", + "description": "Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI.", "format": "byte", "type": "string" } @@ -2503,29 +2503,29 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1Segment": { - "description": "Segment of the content.", + "description": "A segment of the content.", "id": "GoogleCloudAiplatformV1beta1Segment", "properties": { "endIndex": { - "description": "Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero.", + "description": "Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index.", "format": "int32", "readOnly": true, "type": "integer" }, "partIndex": { - "description": "Output only. The index of a Part object within its parent Content object.", + "description": "Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content.", "format": "int32", "readOnly": true, "type": "integer" }, "startIndex": { - "description": "Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero.", + "description": "Output only. The start index of the segment in the `Part`, measured in bytes. This marks the beginning of the segment and is inclusive, meaning the byte at this index is the first byte of the segment.", "format": "int32", "readOnly": true, "type": "integer" }, "text": { - "description": "Output only. The text corresponding to the segment from the response.", + "description": "Output only. The text of the segment.", "readOnly": true, "type": "string" } @@ -2533,7 +2533,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1SpeakerVoiceConfig": { - "description": "Configuration for a single speaker in a multi speaker setup.", + "description": "Configuration for a single speaker in a multi-speaker setup.", "id": "GoogleCloudAiplatformV1beta1SpeakerVoiceConfig", "properties": { "speaker": { @@ -2548,11 +2548,11 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1SpeechConfig": { - "description": "The speech generation config.", + "description": "Configuration for speech generation.", "id": "GoogleCloudAiplatformV1beta1SpeechConfig", "properties": { "languageCode": { - "description": "Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.", + "description": "Optional. The language code (ISO 639-1) for the speech synthesis.", "type": "string" }, "multiSpeakerVoiceConfig": { @@ -2561,7 +2561,7 @@ }, "voiceConfig": { "$ref": "GoogleCloudAiplatformV1beta1VoiceConfig", - "description": "The configuration for the speaker to use." + "description": "The configuration for the voice to use." } }, "type": "object" @@ -2636,7 +2636,7 @@ "type": "string" }, "excludedPredefinedFunctions": { - "description": "Optional. By default, predefined functions are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions.", + "description": "Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions.", "items": { "type": "string" }, @@ -2703,11 +2703,11 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1UrlContextMetadata": { - "description": "Metadata related to url context retrieval tool.", + "description": "Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL.", "id": "GoogleCloudAiplatformV1beta1UrlContextMetadata", "properties": { "urlMetadata": { - "description": "Output only. List of url context.", + "description": "Output only. A list of URL metadata, with one entry for each URL retrieved by the tool.", "items": { "$ref": "GoogleCloudAiplatformV1beta1UrlMetadata" }, @@ -2718,15 +2718,15 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1UrlMetadata": { - "description": "Context of the a single url retrieval.", + "description": "The metadata for a single URL retrieval.", "id": "GoogleCloudAiplatformV1beta1UrlMetadata", "properties": { "retrievedUrl": { - "description": "Retrieved url by the tool.", + "description": "The URL retrieved by the tool.", "type": "string" }, "urlRetrievalStatus": { - "description": "Status of the url retrieval.", + "description": "The status of the URL retrieval.", "enum": [ "URL_RETRIEVAL_STATUS_UNSPECIFIED", "URL_RETRIEVAL_STATUS_SUCCESS", @@ -2734,8 +2734,8 @@ ], "enumDescriptions": [ "Default value. This value is unused.", - "Url retrieval is successful.", - "Url retrieval is failed due to error." + "The URL was retrieved successfully.", + "The URL retrieval failed." ], "type": "string" } @@ -2849,7 +2849,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1VideoMetadata": { - "description": "Metadata describes the input video content.", + "description": "Provides metadata for a video, including the start and end offsets for clipping and the frame rate.", "id": "GoogleCloudAiplatformV1beta1VideoMetadata", "properties": { "endOffset": { @@ -2858,7 +2858,7 @@ "type": "string" }, "fps": { - "description": "Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].", + "description": "Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].", "format": "double", "type": "number" }, @@ -2871,12 +2871,12 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1VoiceConfig": { - "description": "The configuration for the voice to use.", + "description": "Configuration for a voice.", "id": "GoogleCloudAiplatformV1beta1VoiceConfig", "properties": { "prebuiltVoiceConfig": { "$ref": "GoogleCloudAiplatformV1beta1PrebuiltVoiceConfig", - "description": "The configuration for the prebuilt voice to use." + "description": "The configuration for a prebuilt voice." } }, "type": "object" diff --git a/discovery/firestore-v1.json b/discovery/firestore-v1.json index afa2a8d17a..8adec12139 100644 --- a/discovery/firestore-v1.json +++ b/discovery/firestore-v1.json @@ -2284,7 +2284,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2416,7 +2416,7 @@ } } }, - "revision": "20251014", + "revision": "20251026", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { diff --git a/discovery/gkeonprem-v1.json b/discovery/gkeonprem-v1.json index c61d36bbec..7d394bb6a9 100644 --- a/discovery/gkeonprem-v1.json +++ b/discovery/gkeonprem-v1.json @@ -618,6 +618,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}/operations", @@ -1514,6 +1519,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}/operations", @@ -1586,6 +1596,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}/operations", @@ -1711,6 +1726,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}/operations", @@ -2128,6 +2148,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}/operations", @@ -2642,6 +2667,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}/operations", @@ -3084,6 +3114,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}/operations", @@ -3105,7 +3140,7 @@ } } }, - "revision": "20250908", + "revision": "20251020", "rootUrl": "https://gkeonprem.googleapis.com/", "schemas": { "Authorization": { @@ -4797,6 +4832,13 @@ "$ref": "Operation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/discovery/healthcare-v1.json b/discovery/healthcare-v1.json index 3db3386976..5a314015c5 100644 --- a/discovery/healthcare-v1.json +++ b/discovery/healthcare-v1.json @@ -3930,7 +3930,7 @@ ] }, "conditionalPatch": { - "description": "If a resource is found with the identifier specified in the query parameters, updates part of that resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard conditional patch interaction, limited to searching by resource identifier. DSTU2 doesn't define a conditional patch method, but the server supports it in the same way it supports STU3. Search term for identifier should be in the pattern `identifier=system|value` or `identifier=value` - similar to the `search` method on resources with a specific identifier. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. 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. For samples that show how to call `conditionalPatch`, see [Conditionally patching a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_patching_a_fhir_resource).", + "description": "If a resource is found with the identifier specified in the query parameters, updates part of that resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard conditional patch interaction, limited to searching by resource identifier. DSTU2 doesn't define a conditional patch method, but the server supports it in the same way it supports STU3. Search term for identifier should be in the pattern `identifier=system|value` or `identifier=value` - similar to the `search` method on resources with a specific identifier. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. If the search criteria doesn't identify any matches, the request returns a `404 Not Found` error. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. 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. For samples that show how to call `conditionalPatch`, see [Conditionally patching a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_patching_a_fhir_resource).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}", "httpMethod": "PATCH", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.conditionalPatch", @@ -5137,7 +5137,7 @@ } } }, - "revision": "20251001", + "revision": "20251009", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { @@ -6839,6 +6839,11 @@ "description": "The total amount of structured storage used by FHIR resources of this resource type in the store.", "format": "int64", "type": "string" + }, + "versionedStorageSizeBytes": { + "description": "The total amount of versioned storage used by versioned FHIR resources of this resource type in the store.", + "format": "int64", + "type": "string" } }, "type": "object" diff --git a/discovery/healthcare-v1beta1.json b/discovery/healthcare-v1beta1.json index 9b6683f905..d5809bf382 100644 --- a/discovery/healthcare-v1beta1.json +++ b/discovery/healthcare-v1beta1.json @@ -4424,7 +4424,7 @@ ] }, "conditionalPatch": { - "description": "If a resource is found based on the search criteria specified in the query parameters, updates part of that resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard conditional patch interaction ([STU3](https://hl7.org/fhir/STU3/http.html#patch), [R4](https://hl7.org/fhir/R4/http.html#patch), [R5](https://hl7.org/fhir/R5/http.html#patch)). DSTU2 doesn't define a conditional patch method, but the server supports it in the same way it supports STU3. Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. 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. This method requires the`healthcare.fhirStores.searchResources` permission on the parent FHIR store and the `healthcare.fhirResources.patch` permission on the requested FHIR store resource. For samples that show how to call `conditionalPatch`, see [Conditionally patching a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_patching_a_fhir_resource).", + "description": "If a resource is found based on the search criteria specified in the query parameters, updates part of that resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard conditional patch interaction ([STU3](https://hl7.org/fhir/STU3/http.html#patch), [R4](https://hl7.org/fhir/R4/http.html#patch), [R5](https://hl7.org/fhir/R5/http.html#patch)). DSTU2 doesn't define a conditional patch method, but the server supports it in the same way it supports STU3. Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. If the search criteria doesn't identify any matches, the request returns a `404 Not Found` error. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. 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. This method requires the`healthcare.fhirStores.searchResources` permission on the parent FHIR store and the `healthcare.fhirResources.patch` permission on the requested FHIR store resource. For samples that show how to call `conditionalPatch`, see [Conditionally patching a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_patching_a_fhir_resource).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}", "httpMethod": "PATCH", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.conditionalPatch", @@ -5684,7 +5684,7 @@ } } }, - "revision": "20251001", + "revision": "20251009", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { @@ -7656,6 +7656,11 @@ "description": "The total amount of structured storage used by FHIR resources of this resource type in the store.", "format": "int64", "type": "string" + }, + "versionedStorageSizeBytes": { + "description": "The total amount of versioned storage used by versioned FHIR resources of this resource type in the store.", + "format": "int64", + "type": "string" } }, "type": "object" diff --git a/discovery/iamcredentials-v1.json b/discovery/iamcredentials-v1.json index 7d8b3f719f..598920d082 100644 --- a/discovery/iamcredentials-v1.json +++ b/discovery/iamcredentials-v1.json @@ -137,68 +137,8 @@ }, "protocol": "rest", "resources": { - "locations": { - "resources": { - "workforcePools": { - "methods": { - "getAllowedLocations": { - "description": "Returns the trust boundary info for a given workforce pool.", - "flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/allowedLocations", - "httpMethod": "GET", - "id": "iamcredentials.locations.workforcePools.getAllowedLocations", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. Resource name of workforce pool.", - "location": "path", - "pattern": "^locations/[^/]+/workforcePools/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}/allowedLocations", - "response": { - "$ref": "WorkforcePoolAllowedLocations" - } - } - } - } - } - }, "projects": { "resources": { - "locations": { - "resources": { - "workloadIdentityPools": { - "methods": { - "getAllowedLocations": { - "description": "Returns the trust boundary info for a given workload identity pool.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/allowedLocations", - "httpMethod": "GET", - "id": "iamcredentials.projects.locations.workloadIdentityPools.getAllowedLocations", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. Resource name of workload identity pool.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}/allowedLocations", - "response": { - "$ref": "WorkloadIdentityPoolAllowedLocations" - } - } - } - } - } - }, "serviceAccounts": { "methods": { "generateAccessToken": { @@ -257,28 +197,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "getAllowedLocations": { - "description": "Returns the trust boundary info for a given service account.", - "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/allowedLocations", - "httpMethod": "GET", - "id": "iamcredentials.projects.serviceAccounts.getAllowedLocations", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. Resource name of service account.", - "location": "path", - "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}/allowedLocations", - "response": { - "$ref": "ServiceAccountAllowedLocations" - } - }, "signBlob": { "description": "Signs a blob using a service account's system-managed private key.", "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:signBlob", @@ -340,7 +258,7 @@ } } }, - "revision": "20250911", + "revision": "20251009", "rootUrl": "https://iamcredentials.googleapis.com/", "schemas": { "GenerateAccessTokenRequest": { @@ -418,26 +336,6 @@ }, "type": "object" }, - "ServiceAccountAllowedLocations": { - "description": "Represents a list of allowed locations for given service account.", - "id": "ServiceAccountAllowedLocations", - "properties": { - "encodedLocations": { - "description": "Output only. The hex encoded bitmap of the trust boundary locations", - "readOnly": true, - "type": "string" - }, - "locations": { - "description": "Output only. The human readable trust boundary locations. For example, [\"us-central1\", \"europe-west1\"]", - "items": { - "type": "string" - }, - "readOnly": true, - "type": "array" - } - }, - "type": "object" - }, "SignBlobRequest": { "id": "SignBlobRequest", "properties": { @@ -501,46 +399,6 @@ } }, "type": "object" - }, - "WorkforcePoolAllowedLocations": { - "description": "Represents a list of allowed locations for given workforce pool.", - "id": "WorkforcePoolAllowedLocations", - "properties": { - "encodedLocations": { - "description": "Output only. The hex encoded bitmap of the trust boundary locations", - "readOnly": true, - "type": "string" - }, - "locations": { - "description": "Output only. The human readable trust boundary locations. For example, [\"us-central1\", \"europe-west1\"]", - "items": { - "type": "string" - }, - "readOnly": true, - "type": "array" - } - }, - "type": "object" - }, - "WorkloadIdentityPoolAllowedLocations": { - "description": "Represents a list of allowed locations for given workload identity pool.", - "id": "WorkloadIdentityPoolAllowedLocations", - "properties": { - "encodedLocations": { - "description": "Output only. The hex encoded bitmap of the trust boundary locations", - "readOnly": true, - "type": "string" - }, - "locations": { - "description": "Output only. The human readable trust boundary locations. For example, [\"us-central1\", \"europe-west1\"]", - "items": { - "type": "string" - }, - "readOnly": true, - "type": "array" - } - }, - "type": "object" } }, "servicePath": "", diff --git a/discovery/ids-v1.json b/discovery/ids-v1.json index 8603ea0c05..56b6ba9cee 100644 --- a/discovery/ids-v1.json +++ b/discovery/ids-v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -476,6 +476,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}/operations", @@ -493,7 +498,7 @@ } } }, - "revision": "20250320", + "revision": "20251020", "rootUrl": "https://ids.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -673,6 +678,13 @@ "$ref": "Operation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/discovery/index.json b/discovery/index.json index ba04b140b8..2f53d5b476 100644 --- a/discovery/index.json +++ b/discovery/index.json @@ -871,7 +871,7 @@ "version": "v1" }, { - "description": "Beyondcorp Enterprise provides identity and context aware access controls for enterprise resources and enables zero-trust access. Using the Beyondcorp Enterprise APIs, enterprises can set up multi-cloud and on-prem connectivity solutions.", + "description": "Chrome Enterprise Premium is a secure enterprise browsing solution that provides secure access to applications and resources, and offers integrated threat and data protection. It adds an extra layer of security to safeguard your Chrome browser environment, including Data Loss Prevention (DLP), real-time URL and file scanning, and Context-Aware Access for SaaS and web apps.", "discoveryRestUrl": "https://beyondcorp.googleapis.com/$discovery/rest?version=v1alpha", "documentationLink": "https://cloud.google.com/", "icons": { @@ -886,7 +886,7 @@ "version": "v1alpha" }, { - "description": "Beyondcorp Enterprise provides identity and context aware access controls for enterprise resources and enables zero-trust access. Using the Beyondcorp Enterprise APIs, enterprises can set up multi-cloud and on-prem connectivity solutions.", + "description": "Chrome Enterprise Premium is a secure enterprise browsing solution that provides secure access to applications and resources, and offers integrated threat and data protection. It adds an extra layer of security to safeguard your Chrome browser environment, including Data Loss Prevention (DLP), real-time URL and file scanning, and Context-Aware Access for SaaS and web apps.", "discoveryRestUrl": "https://beyondcorp.googleapis.com/$discovery/rest?version=v1", "documentationLink": "https://cloud.google.com/", "icons": { @@ -1263,7 +1263,7 @@ { "description": "The Chrome Web Store API provides access to data about apps and extensions, as well as developer tools for managing them.", "discoveryRestUrl": "https://chromewebstore.googleapis.com/$discovery/rest?version=v1.1", - "documentationLink": "https://developer.chrome.com/webstore/api_index", + "documentationLink": "https://developer.chrome.com/docs/webstore/api", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" @@ -1271,10 +1271,25 @@ "id": "chromewebstore:v1.1", "kind": "discovery#directoryItem", "name": "chromewebstore", - "preferred": true, + "preferred": false, "title": "Chrome Web Store API", "version": "v1.1" }, + { + "description": "The Chrome Web Store API provides access to data about apps and extensions, as well as developer tools for managing them.", + "discoveryRestUrl": "https://chromewebstore.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://developer.chrome.com/docs/webstore/api", + "icons": { + "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", + "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" + }, + "id": "chromewebstore:v2", + "kind": "discovery#directoryItem", + "name": "chromewebstore", + "preferred": true, + "title": "Chrome Web Store API", + "version": "v2" + }, { "description": "Provides polling places, early vote locations, contest data, election officials, and government representatives for U.S. residential addresses.", "discoveryRestUrl": "https://civicinfo.googleapis.com/$discovery/rest?version=v2", @@ -2279,10 +2294,25 @@ "id": "dataform:v1beta1", "kind": "discovery#directoryItem", "name": "dataform", - "preferred": true, + "preferred": false, "title": "Dataform API", "version": "v1beta1" }, + { + "description": "Service to develop, version control, and operationalize SQL pipelines in BigQuery.", + "discoveryRestUrl": "https://dataform.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/dataform/docs", + "icons": { + "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", + "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" + }, + "id": "dataform:v1", + "kind": "discovery#directoryItem", + "name": "dataform", + "preferred": true, + "title": "Dataform API", + "version": "v1" + }, { "description": "Cloud Data Fusion is a fully-managed, cloud native, enterprise data integration service for quickly building and managing data pipelines. It provides a graphical interface to increase time efficiency and reduce complexity, and allows business users, developers, and data scientists to easily and reliably build scalable data integration solutions to cleanse, prepare, blend, transfer and transform data without having to wrestle with infrastructure.", "discoveryRestUrl": "https://datafusion.googleapis.com/$discovery/rest?version=v1beta1", diff --git a/discovery/logging-v2.json b/discovery/logging-v2.json index 5607fa05bf..f0e63134b3 100644 --- a/discovery/logging-v2.json +++ b/discovery/logging-v2.json @@ -1381,6 +1381,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to \"projects/example/locations/-\".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v2/{+name}/operations", @@ -3470,6 +3475,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to \"projects/example/locations/-\".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v2/{+name}/operations", @@ -4840,6 +4850,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to \"projects/example/locations/-\".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v2/{+name}/operations", @@ -6300,6 +6315,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to \"projects/example/locations/-\".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v2/{+name}/operations", @@ -8108,6 +8128,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to \"projects/example/locations/-\".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v2/{+name}/operations", @@ -9127,7 +9152,7 @@ } } }, - "revision": "20250919", + "revision": "20251017", "rootUrl": "https://logging.googleapis.com/", "schemas": { "AppHub": { @@ -10096,6 +10121,13 @@ "$ref": "Operation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/discovery/looker-v1.json b/discovery/looker-v1.json index 6536bebea3..69ded3448c 100644 --- a/discovery/looker-v1.json +++ b/discovery/looker-v1.json @@ -715,7 +715,7 @@ } } }, - "revision": "20251001", + "revision": "20251017", "rootUrl": "https://looker.googleapis.com/", "schemas": { "AdminSettings": { @@ -738,6 +738,24 @@ "properties": {}, "type": "object" }, + "ControlledEgressConfig": { + "description": "Controlled egress configuration.", + "id": "ControlledEgressConfig", + "properties": { + "egressFqdns": { + "description": "Optional. List of fully qualified domain names to be added to the allowlist for outbound traffic.", + "items": { + "type": "string" + }, + "type": "array" + }, + "marketplaceEnabled": { + "description": "Optional. Whether marketplace is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, "CustomDomain": { "description": "Custom domain information.", "id": "CustomDomain", @@ -975,6 +993,14 @@ "description": "Network name in the consumer project. Format: `projects/{project}/global/networks/{network}`. Note that the consumer network may be in a different GCP project than the consumer project that is hosting the Looker Instance.", "type": "string" }, + "controlledEgressConfig": { + "$ref": "ControlledEgressConfig", + "description": "Optional. Controlled egress configuration." + }, + "controlledEgressEnabled": { + "description": "Optional. Whether controlled egress is enabled on the Looker instance.", + "type": "boolean" + }, "createTime": { "description": "Output only. The time when the Looker instance provisioning was first requested.", "format": "google-datetime", diff --git a/discovery/managedkafka-v1.json b/discovery/managedkafka-v1.json index 473043ddbf..bb3101c579 100644 --- a/discovery/managedkafka-v1.json +++ b/discovery/managedkafka-v1.json @@ -15,6 +15,13 @@ "description": "Manage Apache Kafka clusters and resources. ", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/managed-service-for-apache-kafka/docs", + "endpoints": [ + { + "description": "Regional Endpoint", + "endpointUrl": "https://managedkafka.us-east7.rep.googleapis.com/", + "location": "us-east7" + } + ], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -144,7 +151,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2939,7 +2946,7 @@ } } }, - "revision": "20251009", + "revision": "20251023", "rootUrl": "https://managedkafka.googleapis.com/", "schemas": { "AccessConfig": { @@ -3263,18 +3270,20 @@ "type": "boolean" }, "state": { - "description": "Output only. The current state of the cluster.", + "description": "Output only. The current state of the Kafka Connect cluster.", "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", - "DELETING" + "DELETING", + "DETACHED" ], "enumDescriptions": [ "A state was not specified.", "The cluster is being created.", "The cluster is active.", - "The cluster is being deleted." + "The cluster is being deleted.", + "The cluster is detached." ], "readOnly": true, "type": "string" diff --git a/discovery/marketingplatformadmin-v1alpha.json b/discovery/marketingplatformadmin-v1alpha.json index ce57768e7c..448f87f9d3 100644 --- a/discovery/marketingplatformadmin-v1alpha.json +++ b/discovery/marketingplatformadmin-v1alpha.json @@ -110,6 +110,35 @@ "resources": { "organizations": { "methods": { + "findSalesPartnerManagedClients": { + "description": "Returns a list of clients managed by the sales partner organization. User needs to be an OrgAdmin/BillingAdmin on the sales partner organization in order to view the end clients.", + "flatPath": "v1alpha/organizations/{organizationsId}:findSalesPartnerManagedClients", + "httpMethod": "POST", + "id": "marketingplatformadmin.organizations.findSalesPartnerManagedClients", + "parameterOrder": [ + "organization" + ], + "parameters": { + "organization": { + "description": "Required. The name of the sales partner organization. Format: organizations/{org_id}", + "location": "path", + "pattern": "^organizations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+organization}:findSalesPartnerManagedClients", + "request": { + "$ref": "FindSalesPartnerManagedClientsRequest" + }, + "response": { + "$ref": "FindSalesPartnerManagedClientsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/marketingplatformadmin.analytics.read", + "https://www.googleapis.com/auth/marketingplatformadmin.analytics.update" + ] + }, "get": { "description": "Lookup for a single organization.", "flatPath": "v1alpha/organizations/{organizationsId}", @@ -135,6 +164,63 @@ "https://www.googleapis.com/auth/marketingplatformadmin.analytics.read", "https://www.googleapis.com/auth/marketingplatformadmin.analytics.update" ] + }, + "list": { + "description": "Returns a list of organizations that the user has access to.", + "flatPath": "v1alpha/organizations", + "httpMethod": "GET", + "id": "marketingplatformadmin.organizations.list", + "parameterOrder": [], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of organizations to return in one call. The service may return fewer than this value. If unspecified, at most 50 organizations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous ListOrganizations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListOrganizations` must match the call that provided the page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/organizations", + "response": { + "$ref": "ListOrganizationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/marketingplatformadmin.analytics.read", + "https://www.googleapis.com/auth/marketingplatformadmin.analytics.update" + ] + }, + "reportPropertyUsage": { + "description": "Get the usage and billing data for properties within the organization for the specified month. Per direct client org, user needs to be OrgAdmin/BillingAdmin on the organization in order to view the billing and usage data. Per sales partner client org, user needs to be OrgAdmin/BillingAdmin on the sales partner org in order to view the billing and usage data, or OrgAdmin/BillingAdmin on the sales partner client org in order to view the usage data only.", + "flatPath": "v1alpha/organizations/{organizationsId}:reportPropertyUsage", + "httpMethod": "POST", + "id": "marketingplatformadmin.organizations.reportPropertyUsage", + "parameterOrder": [ + "organization" + ], + "parameters": { + "organization": { + "description": "Required. Specifies the organization whose property usage will be listed. Format: organizations/{org_id}", + "location": "path", + "pattern": "^organizations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+organization}:reportPropertyUsage", + "request": { + "$ref": "ReportPropertyUsageRequest" + }, + "response": { + "$ref": "ReportPropertyUsageResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/marketingplatformadmin.analytics.read", + "https://www.googleapis.com/auth/marketingplatformadmin.analytics.update" + ] } }, "resources": { @@ -263,7 +349,7 @@ } } }, - "revision": "20240529", + "revision": "20251029", "rootUrl": "https://marketingplatformadmin.googleapis.com/", "schemas": { "AnalyticsAccountLink": { @@ -301,12 +387,101 @@ }, "type": "object" }, + "BillInfo": { + "description": "Contains the bill amount.", + "id": "BillInfo", + "properties": { + "baseFee": { + "$ref": "Money", + "description": "The amount of the monthly base fee." + }, + "eventFee": { + "$ref": "Money", + "description": "The amount of the event fee." + }, + "priceProtectionCredit": { + "$ref": "Money", + "description": "The amount of the price protection credit, this is only available for eligible customers." + }, + "total": { + "$ref": "Money", + "description": "The total amount of the bill." + } + }, + "type": "object" + }, + "ClientData": { + "description": "Contains the client data.", + "id": "ClientData", + "properties": { + "endDate": { + "$ref": "Date", + "description": "The end date of the contract between the sales org and the end client." + }, + "organization": { + "$ref": "Organization", + "description": "The end client that has/had contract with the requested sales org." + }, + "startDate": { + "$ref": "Date", + "description": "The start date of the contract between the sales org and the end client." + } + }, + "type": "object" + }, + "Date": { + "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp", + "id": "Date", + "properties": { + "day": { + "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", + "format": "int32", + "type": "integer" + }, + "month": { + "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", + "format": "int32", + "type": "integer" + }, + "year": { + "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "Empty", "properties": {}, "type": "object" }, + "FindSalesPartnerManagedClientsRequest": { + "description": "Request message for FindSalesPartnerManagedClients RPC.", + "id": "FindSalesPartnerManagedClientsRequest", + "properties": { + "isActive": { + "description": "Optional. If set, only active and just ended clients will be returned.", + "type": "boolean" + } + }, + "type": "object" + }, + "FindSalesPartnerManagedClientsResponse": { + "description": "Response message for FindSalesPartnerManagedClients RPC.", + "id": "FindSalesPartnerManagedClientsResponse", + "properties": { + "clientData": { + "description": "The clients managed by the sales org.", + "items": { + "$ref": "ClientData" + }, + "type": "array" + } + }, + "type": "object" + }, "ListAnalyticsAccountLinksResponse": { "description": "Response message for ListAnalyticsAccountLinks RPC.", "id": "ListAnalyticsAccountLinksResponse", @@ -325,6 +500,45 @@ }, "type": "object" }, + "ListOrganizationsResponse": { + "description": "Response message for ListOrganizations RPC.", + "id": "ListOrganizationsResponse", + "properties": { + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "organizations": { + "description": "The Organization resource that the user has access to, which includes the org id and display name.", + "items": { + "$ref": "Organization" + }, + "type": "array" + } + }, + "type": "object" + }, + "Money": { + "description": "Represents an amount of money with its currency type.", + "id": "Money", + "properties": { + "currencyCode": { + "description": "The three-letter currency code defined in ISO 4217.", + "type": "string" + }, + "nanos": { + "description": "Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.", + "format": "int32", + "type": "integer" + }, + "units": { + "description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "Organization": { "description": "A resource message representing a Google Marketing Platform organization.", "id": "Organization", @@ -340,6 +554,95 @@ }, "type": "object" }, + "PropertyUsage": { + "description": "Contains the count of events received by the property, along with metadata that influences the volume of `billable` events.", + "id": "PropertyUsage", + "properties": { + "accountId": { + "description": "The ID of the property's parent account.", + "format": "int64", + "type": "string" + }, + "billableEventCount": { + "description": "The number of events for which the property is billed in the requested month.", + "format": "int64", + "type": "string" + }, + "displayName": { + "description": "The display name of the property.", + "type": "string" + }, + "property": { + "description": "The name of the Google Analytics Admin API property resource. Format: analyticsadmin.googleapis.com/properties/{property_id}", + "type": "string" + }, + "propertyType": { + "description": "The subtype of the analytics property. This affects the billable event count.", + "enum": [ + "ANALYTICS_PROPERTY_TYPE_UNSPECIFIED", + "ANALYTICS_PROPERTY_TYPE_ORDINARY", + "ANALYTICS_PROPERTY_TYPE_SUBPROPERTY", + "ANALYTICS_PROPERTY_TYPE_ROLLUP" + ], + "enumDescriptions": [ + "Unknown or unspecified property type", + "Ordinary Google Analytics property", + "Google Analytics subproperty", + "Google Analytics rollup property" + ], + "type": "string" + }, + "serviceLevel": { + "description": "The service level of the property.", + "enum": [ + "ANALYTICS_SERVICE_LEVEL_UNSPECIFIED", + "ANALYTICS_SERVICE_LEVEL_STANDARD", + "ANALYTICS_SERVICE_LEVEL_360" + ], + "enumDescriptions": [ + "Service level unspecified.", + "The standard version of Google Analytics.", + "The premium version of Google Analytics." + ], + "type": "string" + }, + "totalEventCount": { + "description": "Total event count that the property received during the requested month.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "ReportPropertyUsageRequest": { + "description": "Request message for ReportPropertyUsage RPC.", + "id": "ReportPropertyUsageRequest", + "properties": { + "month": { + "description": "Required. The target month to list property usages. Format: YYYY-MM. For example, \"2025-05\"", + "type": "string" + } + }, + "type": "object" + }, + "ReportPropertyUsageResponse": { + "description": "Response message for ReportPropertyUsage RPC.", + "id": "ReportPropertyUsageResponse", + "properties": { + "billInfo": { + "$ref": "BillInfo", + "description": "Bill amount in the specified organization and month. Will be empty if user only has access to usage data." + }, + "propertyUsages": { + "description": "Usage data for all properties in the specified organization and month.", + "items": { + "$ref": "PropertyUsage" + }, + "type": "array" + } + }, + "type": "object" + }, "SetPropertyServiceLevelRequest": { "description": "Request message for SetPropertyServiceLevel RPC.", "id": "SetPropertyServiceLevelRequest", diff --git a/discovery/merchantapi-accounts_v1.json b/discovery/merchantapi-accounts_v1.json index 8a46f19759..b0ed83aace 100644 --- a/discovery/merchantapi-accounts_v1.json +++ b/discovery/merchantapi-accounts_v1.json @@ -180,21 +180,6 @@ "https://www.googleapis.com/auth/content" ] }, - "getAccountForGcpRegistration": { - "description": "Retrieves the merchant account that the calling GCP is registered with.", - "flatPath": "accounts/v1/accounts:getAccountForGcpRegistration", - "httpMethod": "GET", - "id": "merchantapi.accounts.getAccountForGcpRegistration", - "parameterOrder": [], - "parameters": {}, - "path": "accounts/v1/accounts:getAccountForGcpRegistration", - "response": { - "$ref": "GetAccountForGcpRegistrationResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/content" - ] - }, "list": { "description": "Note: For the `accounts.list` method, quota and limits usage are charged for each user, and not for the Merchant Center ID or the advanced account ID. To list several sub-accounts, you should use the `accounts.listSubaccounts` method, which is more suitable for advanced accounts use case.", "flatPath": "accounts/v1/accounts", @@ -553,6 +538,21 @@ }, "developerRegistration": { "methods": { + "getAccountForGcpRegistration": { + "description": "Retrieves the merchant account that the calling GCP is registered with.", + "flatPath": "accounts/v1/accounts:getAccountForGcpRegistration", + "httpMethod": "GET", + "id": "merchantapi.accounts.developerRegistration.getAccountForGcpRegistration", + "parameterOrder": [], + "parameters": {}, + "path": "accounts/v1/accounts:getAccountForGcpRegistration", + "response": { + "$ref": "GetAccountForGcpRegistrationResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, "getDeveloperRegistration": { "description": "Retrieves a developer registration for a merchant.", "flatPath": "accounts/v1/accounts/{accountsId}/developerRegistration", @@ -2376,7 +2376,7 @@ } } }, - "revision": "20251002", + "revision": "20251023", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "About": { @@ -5455,7 +5455,7 @@ "type": "object" }, "User": { - "description": "The `User` message represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472).", + "description": "The `User` resource represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472).", "id": "User", "properties": { "accessRights": { diff --git a/discovery/merchantapi-accounts_v1beta.json b/discovery/merchantapi-accounts_v1beta.json index 5ec2c35cf0..8b2cda54cb 100644 --- a/discovery/merchantapi-accounts_v1beta.json +++ b/discovery/merchantapi-accounts_v1beta.json @@ -180,21 +180,6 @@ "https://www.googleapis.com/auth/content" ] }, - "getAccountForGcpRegistration": { - "description": "Retrieves the merchant account that the calling GCP is registered with.", - "flatPath": "accounts/v1beta/accounts:getAccountForGcpRegistration", - "httpMethod": "GET", - "id": "merchantapi.accounts.getAccountForGcpRegistration", - "parameterOrder": [], - "parameters": {}, - "path": "accounts/v1beta/accounts:getAccountForGcpRegistration", - "response": { - "$ref": "GetAccountForGcpRegistrationResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/content" - ] - }, "list": { "description": "Note: For the `accounts.list` method, quota and limits usage are charged for each user, and not for the Merchant Center ID or the advanced account ID. To list several sub-accounts, you should use the `accounts.listSubaccounts` method, which is more suitable for advanced accounts use case.", "flatPath": "accounts/v1beta/accounts", @@ -553,6 +538,21 @@ }, "developerRegistration": { "methods": { + "getAccountForGcpRegistration": { + "description": "Retrieves the merchant account that the calling GCP is registered with.", + "flatPath": "accounts/v1beta/accounts:getAccountForGcpRegistration", + "httpMethod": "GET", + "id": "merchantapi.accounts.developerRegistration.getAccountForGcpRegistration", + "parameterOrder": [], + "parameters": {}, + "path": "accounts/v1beta/accounts:getAccountForGcpRegistration", + "response": { + "$ref": "GetAccountForGcpRegistrationResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, "getDeveloperRegistration": { "description": "Retrieves a developer registration for a merchant.", "flatPath": "accounts/v1beta/accounts/{accountsId}/developerRegistration", @@ -2326,7 +2326,7 @@ } } }, - "revision": "20251002", + "revision": "20251023", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "About": { @@ -5316,7 +5316,7 @@ "type": "object" }, "User": { - "description": "The `User` message represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472).", + "description": "The `User` resource represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472).", "id": "User", "properties": { "accessRights": { diff --git a/discovery/metastore-v1alpha.json b/discovery/metastore-v1alpha.json index d0637948fb..f5237e1ae2 100644 --- a/discovery/metastore-v1alpha.json +++ b/discovery/metastore-v1alpha.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1807,7 +1807,7 @@ } } }, - "revision": "20250925", + "revision": "20251023", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { diff --git a/discovery/metastore-v1beta.json b/discovery/metastore-v1beta.json index 77287ab277..754c301d39 100644 --- a/discovery/metastore-v1beta.json +++ b/discovery/metastore-v1beta.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1807,7 +1807,7 @@ } } }, - "revision": "20250925", + "revision": "20251023", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { diff --git a/discovery/migrationcenter-v1.json b/discovery/migrationcenter-v1.json index a82f271b4c..ecf1960de2 100644 --- a/discovery/migrationcenter-v1.json +++ b/discovery/migrationcenter-v1.json @@ -169,7 +169,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2412,7 +2412,7 @@ } } }, - "revision": "20250930", + "revision": "20251023", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { diff --git a/discovery/migrationcenter-v1alpha1.json b/discovery/migrationcenter-v1alpha1.json index 813ac1824e..9b68873e60 100644 --- a/discovery/migrationcenter-v1alpha1.json +++ b/discovery/migrationcenter-v1alpha1.json @@ -169,7 +169,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2559,7 +2559,7 @@ } } }, - "revision": "20250930", + "revision": "20251023", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { @@ -2795,6 +2795,11 @@ "description": "Output only. Asset information specific for AWS CloudFront distributions.", "readOnly": true }, + "awsDynamodbTableDetails": { + "$ref": "AwsDynamoDBTableDetails", + "description": "Output only. Asset information specific for AWS DynamoDB tables.", + "readOnly": true + }, "awsEcsClusterDetails": { "$ref": "AwsEcsClusterDetails", "description": "Output only. Asset information specific for AWS ECS clusters.", @@ -2820,11 +2825,21 @@ "description": "Output only. Asset information specific for AWS Lambda functions.", "readOnly": true }, + "awsNatGatewayDetails": { + "$ref": "AwsNatGatewayDetails", + "description": "Output only. Asset information specific for AwsNatGatewayDetails", + "readOnly": true + }, "awsRedshiftDetails": { "$ref": "AwsRedshiftDetails", "description": "Output only. Asset information specific for AWS Redshift", "readOnly": true }, + "awsRoute53HostedZoneDetails": { + "$ref": "AwsRoute53HostedZoneDetails", + "description": "Output only. Asset information specific for AwsRoute53HostedZoneDetails", + "readOnly": true + }, "awsS3BucketDetails": { "$ref": "AwsS3BucketDetails", "description": "Output only. Asset information specific for AWS S3 buckets.", @@ -2946,6 +2961,10 @@ "$ref": "AwsCloudFrontDistributionDetails", "description": "Asset information specific for AWS CloudFront distributions." }, + "awsDynamodbTableDetails": { + "$ref": "AwsDynamoDBTableDetails", + "description": "Asset information specific for AWS DynamoDB tables." + }, "awsEcsClusterDetails": { "$ref": "AwsEcsClusterDetails", "description": "Asset information specific for AWS ECS clusters." @@ -2966,10 +2985,18 @@ "$ref": "AwsLambdaFunctionDetails", "description": "Asset information specific for AWS Lambda functions." }, + "awsNatGatewayDetails": { + "$ref": "AwsNatGatewayDetails", + "description": "Asset information specific for AwsNatGatewayDetails" + }, "awsRedshiftDetails": { "$ref": "AwsRedshiftDetails", "description": "Asset information specific for AWS Redshift clusters." }, + "awsRoute53HostedZoneDetails": { + "$ref": "AwsRoute53HostedZoneDetails", + "description": "Asset information specific for AwsRoute53HostedZoneDetails" + }, "awsS3BucketDetails": { "$ref": "AwsS3BucketDetails", "description": "Asset information specific for AWS S3 buckets." @@ -3226,13 +3253,7 @@ "AssetsExportJobNetworkDependencies": { "description": "Configuration for network dependencies exports.", "id": "AssetsExportJobNetworkDependencies", - "properties": { - "maxDays": { - "description": "Optional. When this value is set to a positive integer, network connections data will be returned for the most recent days for which data is available. When this value is unset (or set to zero), all available data is returned.", - "format": "int32", - "type": "integer" - } - }, + "properties": {}, "type": "object" }, "AssetsExportJobPerformanceData": { @@ -3253,6 +3274,12 @@ "properties": {}, "type": "object" }, + "AwsDynamoDBTableDetails": { + "description": "Details of an AWS DynamoDB table.", + "id": "AwsDynamoDBTableDetails", + "properties": {}, + "type": "object" + }, "AwsEc2PlatformDetails": { "description": "AWS EC2 specific details.", "id": "AwsEc2PlatformDetails", @@ -3312,6 +3339,12 @@ "properties": {}, "type": "object" }, + "AwsNatGatewayDetails": { + "description": "Details of an AWS NAT Gateway.", + "id": "AwsNatGatewayDetails", + "properties": {}, + "type": "object" + }, "AwsRds": { "description": "Specific details for an AWS RDS database deployment.", "id": "AwsRds", @@ -3324,6 +3357,12 @@ "properties": {}, "type": "object" }, + "AwsRoute53HostedZoneDetails": { + "description": "Details of an AWS Route 53 Hosted Zone.", + "id": "AwsRoute53HostedZoneDetails", + "properties": {}, + "type": "object" + }, "AwsS3BucketDetails": { "description": "Asset information specific for AWS S3 buckets.", "id": "AwsS3BucketDetails", diff --git a/discovery/mybusinessplaceactions-v1.json b/discovery/mybusinessplaceactions-v1.json index 4987bf8a39..8fe5da5b79 100644 --- a/discovery/mybusinessplaceactions-v1.json +++ b/discovery/mybusinessplaceactions-v1.json @@ -281,7 +281,7 @@ } } }, - "revision": "20221124", + "revision": "20251022", "rootUrl": "https://mybusinessplaceactions.googleapis.com/", "schemas": { "Empty": { @@ -359,7 +359,8 @@ "FOOD_ORDERING", "FOOD_DELIVERY", "FOOD_TAKEOUT", - "SHOP_ONLINE" + "SHOP_ONLINE", + "SOLOPRENEUR_APPOINTMENT" ], "enumDescriptions": [ "Not specified.", @@ -369,7 +370,8 @@ "The action type is ordering food for delivery and/or takeout.", "The action type is ordering food for delivery.", "The action type is ordering food for takeout.", - "The action type is shopping, that can be delivery and/or pickup." + "The action type is shopping, that can be delivery and/or pickup.", + "The action type is booking an appointment with a Solopneuer partner." ], "type": "string" }, @@ -419,7 +421,8 @@ "FOOD_ORDERING", "FOOD_DELIVERY", "FOOD_TAKEOUT", - "SHOP_ONLINE" + "SHOP_ONLINE", + "SOLOPRENEUR_APPOINTMENT" ], "enumDescriptions": [ "Not specified.", @@ -429,7 +432,8 @@ "The action type is ordering food for delivery and/or takeout.", "The action type is ordering food for delivery.", "The action type is ordering food for takeout.", - "The action type is shopping, that can be delivery and/or pickup." + "The action type is shopping, that can be delivery and/or pickup.", + "The action type is booking an appointment with a Solopneuer partner." ], "type": "string" } diff --git a/discovery/netapp-v1.json b/discovery/netapp-v1.json index 92588517f3..05782f8a1b 100644 --- a/discovery/netapp-v1.json +++ b/discovery/netapp-v1.json @@ -2515,7 +2515,7 @@ } } }, - "revision": "20251009", + "revision": "20251018", "rootUrl": "https://netapp.googleapis.com/", "schemas": { "ActiveDirectory": { @@ -3323,7 +3323,7 @@ "type": "string" }, "cryptoKeyName": { - "description": "Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}.", + "description": "Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.", "type": "string" }, "description": { diff --git a/discovery/netapp-v1beta1.json b/discovery/netapp-v1beta1.json index 693c00203a..b1c4e39621 100644 --- a/discovery/netapp-v1beta1.json +++ b/discovery/netapp-v1beta1.json @@ -2543,7 +2543,7 @@ } } }, - "revision": "20251009", + "revision": "20251018", "rootUrl": "https://netapp.googleapis.com/", "schemas": { "ActiveDirectory": { @@ -3377,7 +3377,7 @@ "type": "string" }, "cryptoKeyName": { - "description": "Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}.", + "description": "Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.", "type": "string" }, "description": { diff --git a/discovery/networkservices-v1.json b/discovery/networkservices-v1.json index 4123d3e08c..63af93d407 100644 --- a/discovery/networkservices-v1.json +++ b/discovery/networkservices-v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1348,6 +1348,188 @@ } } }, + "lbEdgeExtensions": { + "methods": { + "create": { + "description": "Creates a new `LbEdgeExtension` resource in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lbEdgeExtensions", + "httpMethod": "POST", + "id": "networkservices.projects.locations.lbEdgeExtensions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "lbEdgeExtensionId": { + "description": "Required. User-provided ID of the `LbEdgeExtension` resource to be created.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource of the `LbEdgeExtension` resource. Must be in the format `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server 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}/lbEdgeExtensions", + "request": { + "$ref": "LbEdgeExtension" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes the specified `LbEdgeExtension` resource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lbEdgeExtensions/{lbEdgeExtensionsId}", + "httpMethod": "DELETE", + "id": "networkservices.projects.locations.lbEdgeExtensions.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the `LbEdgeExtension` resource to delete. Must be in the format `projects/{project}/locations/{location}/lbEdgeExtensions/{lb_edge_extension}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/lbEdgeExtensions/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server 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 the specified `LbEdgeExtension` resource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lbEdgeExtensions/{lbEdgeExtensionsId}", + "httpMethod": "GET", + "id": "networkservices.projects.locations.lbEdgeExtensions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. A name of the `LbEdgeExtension` resource to get. Must be in the format `projects/{project}/locations/{location}/lbEdgeExtensions/{lb_edge_extension}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/lbEdgeExtensions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "LbEdgeExtension" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists `LbEdgeExtension` resources in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lbEdgeExtensions", + "httpMethod": "GET", + "id": "networkservices.projects.locations.lbEdgeExtensions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filtering results.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Hint about how to order the results.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results that the server returns.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The project and location from which the `LbEdgeExtension` resources are listed. These values are specified in the following format: `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/lbEdgeExtensions", + "response": { + "$ref": "ListLbEdgeExtensionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of the specified `LbEdgeExtension` resource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lbEdgeExtensions/{lbEdgeExtensionsId}", + "httpMethod": "PATCH", + "id": "networkservices.projects.locations.lbEdgeExtensions.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Identifier. Name of the `LbEdgeExtension` resource in the following format: `projects/{project}/locations/{location}/lbEdgeExtensions/{lb_edge_extension}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/lbEdgeExtensions/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server 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" + }, + "updateMask": { + "description": "Optional. Used to specify the fields to be overwritten in the `LbEdgeExtension` resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "LbEdgeExtension" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "lbRouteExtensions": { "methods": { "create": { @@ -2052,6 +2234,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}/operations", @@ -3004,7 +3191,7 @@ } } }, - "revision": "20250723", + "revision": "20251017", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuditConfig": { @@ -3136,13 +3323,11 @@ "description": "Optional. The format of communication supported by the callout extension. If not specified, the default value `EXT_PROC_GRPC` is used.", "enum": [ "WIRE_FORMAT_UNSPECIFIED", - "EXT_PROC_GRPC", - "EXT_AUTHZ_GRPC" + "EXT_PROC_GRPC" ], "enumDescriptions": [ "Not specified.", - "The extension service uses ext_proc gRPC API over a gRPC stream. This is the default value if the wire format is not specified. The backend service for the extension must use HTTP2 or H2C as the protocol. All `supported_events` for a client request are sent as part of the same gRPC stream.", - "The extension service uses Envoy's `ext_authz` gRPC API. The backend service for the extension must use HTTP2, or H2C as the protocol. `EXT_AUTHZ_GRPC` is only supported for `AuthzExtension` resources." + "The extension service uses ext_proc gRPC API over a gRPC stream. This is the default value if the wire format is not specified. The backend service for the extension must use HTTP2 or H2C as the protocol. All `supported_events` for a client request are sent as part of the same gRPC stream." ], "type": "string" } @@ -3374,11 +3559,39 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings.", + "description": "Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. For `AuthzExtension` resources, the metadata is available under the namespace `com.google.authz_extension.`. For other types of extensions, the metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings.", "type": "object" }, "name": { - "description": "Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.", + "description": "Optional. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. This field is required except for AuthzExtension.", + "type": "string" + }, + "requestBodySendMode": { + "description": "Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources.", + "enum": [ + "BODY_SEND_MODE_UNSPECIFIED", + "BODY_SEND_MODE_STREAMED", + "BODY_SEND_MODE_FULL_DUPLEX_STREAMED" + ], + "enumDescriptions": [ + "Default value. Do not use.", + "Calls to the extension are executed in the streamed mode. Subsequent chunks will be sent only after the previous chunks have been processed. The content of the body chunks is sent one way to the extension. Extension may send modified chunks back. This is the default value if the processing mode is not specified.", + "Calls are executed in the full duplex mode. Subsequent chunks will be sent for processing without waiting for the response for the previous chunk or for the response for `REQUEST_HEADERS` event. Extension can freely modify or chunk the body contents. If the extension doesn't send the body contents back, the next extension in the chain or the upstream will receive an empty body." + ], + "type": "string" + }, + "responseBodySendMode": { + "description": "Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`.", + "enum": [ + "BODY_SEND_MODE_UNSPECIFIED", + "BODY_SEND_MODE_STREAMED", + "BODY_SEND_MODE_FULL_DUPLEX_STREAMED" + ], + "enumDescriptions": [ + "Default value. Do not use.", + "Calls to the extension are executed in the streamed mode. Subsequent chunks will be sent only after the previous chunks have been processed. The content of the body chunks is sent one way to the extension. Extension may send modified chunks back. This is the default value if the processing mode is not specified.", + "Calls are executed in the full duplex mode. Subsequent chunks will be sent for processing without waiting for the response for the previous chunk or for the response for `REQUEST_HEADERS` event. Extension can freely modify or chunk the body contents. If the extension doesn't send the body contents back, the next extension in the chain or the upstream will receive an empty body." + ], "type": "string" }, "service": { @@ -3386,7 +3599,7 @@ "type": "string" }, "supportedEvents": { - "description": "Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event.", + "description": "Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported.", "items": { "enum": [ "EVENT_TYPE_UNSPECIFIED", @@ -4454,6 +4667,68 @@ }, "type": "object" }, + "LbEdgeExtension": { + "description": "`LbEdgeExtension` is a resource that lets the extension service influence the selection of backend services and Cloud CDN cache keys by modifying request headers.", + "id": "LbEdgeExtension", + "properties": { + "createTime": { + "description": "Output only. The timestamp when the resource was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. A human-readable description of the resource.", + "type": "string" + }, + "extensionChains": { + "description": "Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource.", + "items": { + "$ref": "ExtensionChain" + }, + "type": "array" + }, + "forwardingRules": { + "description": "Required. A list of references to the forwarding rules to which this service extension is attached. At least one forwarding rule is required. Only one `LbEdgeExtension` resource can be associated with a forwarding rule.", + "items": { + "type": "string" + }, + "type": "array" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Set of labels associated with the `LbEdgeExtension` resource. The format must comply with [the requirements for labels](https://cloud.google.com/compute/docs/labeling-resources#requirements) for Google Cloud resources.", + "type": "object" + }, + "loadBalancingScheme": { + "description": "Required. All forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `EXTERNAL_MANAGED`.", + "enum": [ + "LOAD_BALANCING_SCHEME_UNSPECIFIED", + "INTERNAL_MANAGED", + "EXTERNAL_MANAGED" + ], + "enumDescriptions": [ + "Default value. Do not use.", + "Signifies that this is used for Internal HTTP(S) Load Balancing.", + "Signifies that this is used for External Managed HTTP(S) Load Balancing." + ], + "type": "string" + }, + "name": { + "description": "Required. Identifier. Name of the `LbEdgeExtension` resource in the following format: `projects/{project}/locations/{location}/lbEdgeExtensions/{lb_edge_extension}`.", + "type": "string" + }, + "updateTime": { + "description": "Output only. The timestamp when the resource was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "LbRouteExtension": { "description": "`LbRouteExtension` is a resource that lets you control where traffic is routed to for a given request.", "id": "LbRouteExtension", @@ -4744,6 +5019,31 @@ }, "type": "object" }, + "ListLbEdgeExtensionsResponse": { + "description": "Message for response to listing `LbEdgeExtension` resources.", + "id": "ListLbEdgeExtensionsResponse", + "properties": { + "lbEdgeExtensions": { + "description": "The list of `LbEdgeExtension` resources.", + "items": { + "$ref": "LbEdgeExtension" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying a page of results that the server returns.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "ListLbRouteExtensionsResponse": { "description": "Message for response to listing `LbRouteExtension` resources.", "id": "ListLbRouteExtensionsResponse", @@ -4876,6 +5176,13 @@ "$ref": "Operation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/discovery/networkservices-v1beta1.json b/discovery/networkservices-v1beta1.json index 599aa07df0..df7f29e53c 100644 --- a/discovery/networkservices-v1beta1.json +++ b/discovery/networkservices-v1beta1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", + "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2143,6 +2143,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -3095,7 +3100,7 @@ } } }, - "revision": "20250730", + "revision": "20251017", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuthzExtension": { @@ -3179,13 +3184,11 @@ "description": "Optional. The format of communication supported by the callout extension. If not specified, the default value `EXT_PROC_GRPC` is used.", "enum": [ "WIRE_FORMAT_UNSPECIFIED", - "EXT_PROC_GRPC", - "EXT_AUTHZ_GRPC" + "EXT_PROC_GRPC" ], "enumDescriptions": [ "Not specified.", - "The extension service uses ext_proc gRPC API over a gRPC stream. This is the default value if the wire format is not specified. The backend service for the extension must use HTTP2 or H2C as the protocol. All `supported_events` for a client request are sent as part of the same gRPC stream.", - "The extension service uses Envoy's `ext_authz` gRPC API. The backend service for the extension must use HTTP2, or H2C as the protocol. `EXT_AUTHZ_GRPC` is only supported for `AuthzExtension` resources." + "The extension service uses ext_proc gRPC API over a gRPC stream. This is the default value if the wire format is not specified. The backend service for the extension must use HTTP2 or H2C as the protocol. All `supported_events` for a client request are sent as part of the same gRPC stream." ], "type": "string" } @@ -3314,7 +3317,7 @@ "id": "ExtensionChainExtension", "properties": { "allowDynamicForwarding": { - "description": "Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions. Setting it results in a validation error.", + "description": "Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error.", "type": "boolean" }, "authority": { @@ -3337,11 +3340,11 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings.", + "description": "Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. For `AuthzExtension` resources, the metadata is available under the namespace `com.google.authz_extension.`. For other types of extensions, the metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings.", "type": "object" }, "name": { - "description": "Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.", + "description": "Optional. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. This field is required except for AuthzExtension.", "type": "string" }, "requestBodySendMode": { @@ -3359,7 +3362,7 @@ "type": "string" }, "responseBodySendMode": { - "description": "Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`.", + "description": "Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`.", "enum": [ "BODY_SEND_MODE_UNSPECIFIED", "BODY_SEND_MODE_STREAMED", @@ -3377,7 +3380,7 @@ "type": "string" }, "supportedEvents": { - "description": "Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event.", + "description": "Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported.", "items": { "enum": [ "EVENT_TYPE_UNSPECIFIED", @@ -5041,6 +5044,13 @@ "$ref": "Operation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/discovery/observability-v1.json b/discovery/observability-v1.json index e48f977c0d..5e40c622a5 100644 --- a/discovery/observability-v1.json +++ b/discovery/observability-v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -536,7 +536,7 @@ } } }, - "revision": "20250925", + "revision": "20251023", "rootUrl": "https://observability.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/discovery/oracledatabase-v1.json b/discovery/oracledatabase-v1.json index 212671914c..3b3371ecef 100644 --- a/discovery/oracledatabase-v1.json +++ b/discovery/oracledatabase-v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2472,7 +2472,7 @@ } } }, - "revision": "20251009", + "revision": "20251022", "rootUrl": "https://oracledatabase.googleapis.com/", "schemas": { "AllConnectionStrings": { diff --git a/discovery/parametermanager-v1.json b/discovery/parametermanager-v1.json index 171460c361..bcbc773087 100644 --- a/discovery/parametermanager-v1.json +++ b/discovery/parametermanager-v1.json @@ -230,6 +230,16 @@ "description": "Regional Endpoint", "endpointUrl": "https://parametermanager.southamerica-west1.rep.googleapis.com/", "location": "southamerica-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://parametermanager.europe-north2.rep.googleapis.com/", + "location": "europe-north2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://parametermanager.europe-west15.rep.googleapis.com/", + "location": "europe-west15" } ], "fullyEncodeReservedExpansion": true, @@ -361,7 +371,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -811,7 +821,7 @@ } } }, - "revision": "20250917", + "revision": "20251025", "rootUrl": "https://parametermanager.googleapis.com/", "schemas": { "Empty": { diff --git a/discovery/paymentsresellersubscription-v1.json b/discovery/paymentsresellersubscription-v1.json index 5ef544c20e..6ee93e03a7 100644 --- a/discovery/paymentsresellersubscription-v1.json +++ b/discovery/paymentsresellersubscription-v1.json @@ -586,7 +586,7 @@ } } }, - "revision": "20251012", + "revision": "20251026", "rootUrl": "https://paymentsresellersubscription.googleapis.com/", "schemas": { "Amount": { @@ -663,6 +663,10 @@ "description": "Intent message for creating a Subscription resource.", "id": "CreateSubscriptionIntent", "properties": { + "cycleOptions": { + "$ref": "CycleOptions", + "description": "Optional. The cycle options for the subscription." + }, "parent": { "description": "Required. The parent resource name, which is the identifier of the partner.", "type": "string" @@ -997,6 +1001,21 @@ "entitleIntent": { "$ref": "EntitleSubscriptionIntent", "description": "The request to entitle a subscription." + }, + "intentOptions": { + "$ref": "IntentPayloadIntentOptions", + "description": "Optional. The additional features for the intent." + } + }, + "type": "object" + }, + "IntentPayloadIntentOptions": { + "description": "The options for the intent.", + "id": "IntentPayloadIntentOptions", + "properties": { + "enableOfferOverride": { + "description": "Optional. If true, Google may use a different product and promotion id from the ones in the `create_intent` based on the user's eligibility. Only applicable for certain YouTube free trial offers.", + "type": "boolean" } }, "type": "object" diff --git a/discovery/places-v1.json b/discovery/places-v1.json index d69686fc8c..026a74514f 100644 --- a/discovery/places-v1.json +++ b/discovery/places-v1.json @@ -280,7 +280,7 @@ } } }, - "revision": "20251007", + "revision": "20251021", "rootUrl": "https://places.googleapis.com/", "schemas": { "GoogleGeoTypeViewport": { @@ -1166,6 +1166,14 @@ "description": "Place has a children's menu.", "type": "boolean" }, + "movedPlace": { + "description": "If this Place is permanently closed and has moved to a new Place, this field contains the new Place's resource name, in `places/{place_id}` format. If this Place moved multiple times, this field will represent the first moved place. This field will not be populated if this Place has not moved.", + "type": "string" + }, + "movedPlaceId": { + "description": "If this Place is permanently closed and has moved to a new Place, this field contains the new Place's place ID. If this Place moved multiple times, this field will represent the first moved Place. This field will not be populated if this Place has not moved.", + "type": "string" + }, "name": { "description": "This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place.", "type": "string" @@ -1433,7 +1441,7 @@ "properties": { "details": { "$ref": "GoogleMapsPlacesV1PlaceConsumerAlertDetails", - "description": "The details of the consumer alert message.ƒ" + "description": "The details of the consumer alert message." }, "languageCode": { "description": "The language code of the consumer alert message. This is a BCP 47 language code.", @@ -1910,7 +1918,7 @@ }, "visitDate": { "$ref": "GoogleTypeDate", - "description": "The date when the author visited the place. This is trucated to the year and month of the visit." + "description": "The date when the author visited the place. This is truncated to the year and month of the visit." } }, "type": "object" diff --git a/discovery/privateca-v1.json b/discovery/privateca-v1.json index 2937446192..19af0e83ce 100644 --- a/discovery/privateca-v1.json +++ b/discovery/privateca-v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1616,7 +1616,7 @@ } } }, - "revision": "20250926", + "revision": "20251022", "rootUrl": "https://privateca.googleapis.com/", "schemas": { "AccessUrls": { diff --git a/discovery/privateca-v1beta1.json b/discovery/privateca-v1beta1.json index 4d88ce47ec..71dc7ea779 100644 --- a/discovery/privateca-v1beta1.json +++ b/discovery/privateca-v1beta1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -591,7 +591,7 @@ } } }, - "revision": "20250926", + "revision": "20251022", "rootUrl": "https://privateca.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/discovery/recaptchaenterprise-v1.json b/discovery/recaptchaenterprise-v1.json index 2dc800ead7..54addba814 100644 --- a/discovery/recaptchaenterprise-v1.json +++ b/discovery/recaptchaenterprise-v1.json @@ -786,7 +786,7 @@ } } }, - "revision": "20251006", + "revision": "20251026", "rootUrl": "https://recaptchaenterprise.googleapis.com/", "schemas": { "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment": { @@ -918,7 +918,6 @@ "type": "string" }, "annotation": { - "description": "Optional. The annotation that is assigned to the Event. This field can be left empty to provide reasons that apply to an event without concluding whether the event is legitimate or fraudulent.", "enum": [ "ANNOTATION_UNSPECIFIED", "LEGITIMATE", @@ -952,7 +951,6 @@ "description": "Optional. If using an external multi-factor authentication provider, provide phone authentication details for fraud detection purposes." }, "reasons": { - "description": "Optional. Reasons for the annotation that are assigned to the event.", "items": { "enum": [ "REASON_UNSPECIFIED", @@ -1092,7 +1090,7 @@ "id": "GoogleCloudRecaptchaenterpriseV1AssessmentEnvironment", "properties": { "client": { - "description": "Optional. Identifies the client module initiating the CreateAssessment request. This can be the link to the client module's project. Examples include: - \"github.com/GoogleCloudPlatform/recaptcha-enterprise-google-tag-manager\" - \"cloud.google.com/recaptcha/docs/implement-waf-akamai\" - \"cloud.google.com/recaptcha/docs/implement-waf-cloudflare\" - \"wordpress.org/plugins/recaptcha-something\"", + "description": "Optional. Identifies the client module initiating the CreateAssessment request. This can be the link to the client module's project. Examples include: - \"github.com/GoogleCloudPlatform/recaptcha-enterprise-google-tag-manager\" - \"wordpress.org/plugins/recaptcha-something\"", "type": "string" }, "version": { @@ -2177,7 +2175,8 @@ "EXPIRED", "DUPE", "MISSING", - "BROWSER_ERROR" + "BROWSER_ERROR", + "UNEXPECTED_ACTION" ], "enumDescriptions": [ "Default unspecified type.", @@ -2186,7 +2185,8 @@ "The user verification token had expired.", "The user verification had already been seen.", "The user verification token was not present.", - "A retriable error (such as network failure) occurred on the browser. Could easily be simulated by an attacker." + "A retriable error (such as network failure) occurred on the browser. Could easily be simulated by an attacker.", + "The action provided at token generation was different than the `expected_action` in the assessment request. The comparison is case-insensitive. This reason can only be returned if all of the following are true: - your `site_key` has the POLICY_BASED_CHALLENGE integration type - you set an action score threshold higher than 0.0 - you provided a non-empty `expected_action`" ], "readOnly": true, "type": "string" diff --git a/discovery/recommender-v1beta1.json b/discovery/recommender-v1beta1.json index 296fa0e05b..19190d2396 100644 --- a/discovery/recommender-v1beta1.json +++ b/discovery/recommender-v1beta1.json @@ -119,7 +119,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -596,7 +596,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -972,7 +972,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1449,7 +1449,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1944,7 +1944,7 @@ } } }, - "revision": "20250907", + "revision": "20251026", "rootUrl": "https://recommender.googleapis.com/", "schemas": { "GoogleCloudLocationListLocationsResponse": { diff --git a/discovery/redis-v1.json b/discovery/redis-v1.json index 94479fa4d2..ec0506a6e2 100644 --- a/discovery/redis-v1.json +++ b/discovery/redis-v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1078,7 +1078,7 @@ } } }, - "revision": "20251009", + "revision": "20251021", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -1950,7 +1950,8 @@ "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED", "SIGNAL_TYPE_NO_ROOT_PASSWORD", "SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS", - "SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS" + "SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS", + "SIGNAL_TYPE_EXTENDED_SUPPORT" ], "enumDescriptions": [ "Unspecified signal type.", @@ -1958,7 +1959,8 @@ "Represents database auditing is disabled.", "Represents if a database has a password configured for the root account or not.", "Represents if a resource is exposed to public access.", - "Represents if a resources requires all incoming connections to use SSL or not." + "Represents if a resources requires all incoming connections to use SSL or not.", + "Represents if a resource version is in extended support." ], "type": "string" } @@ -2327,7 +2329,8 @@ "SIGNAL_TYPE_OUTDATED_VERSION", "SIGNAL_TYPE_OUTDATED_CLIENT", "SIGNAL_TYPE_DATABOOST_DISABLED", - "SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES" + "SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES", + "SIGNAL_TYPE_EXTENDED_SUPPORT" ], "enumDeprecated": [ false, @@ -2433,6 +2436,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -2539,7 +2543,8 @@ "Outdated version.", "Outdated client.", "Databoost is disabled.", - "Recommended maintenance policy." + "Recommended maintenance policy.", + "Resource version is in extended support." ], "type": "string" }, @@ -2979,7 +2984,8 @@ "SIGNAL_TYPE_OUTDATED_VERSION", "SIGNAL_TYPE_OUTDATED_CLIENT", "SIGNAL_TYPE_DATABOOST_DISABLED", - "SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES" + "SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES", + "SIGNAL_TYPE_EXTENDED_SUPPORT" ], "enumDeprecated": [ false, @@ -3085,6 +3091,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -3191,7 +3198,8 @@ "Outdated version.", "Outdated client.", "Databoost is disabled.", - "Recommended maintenance policy." + "Recommended maintenance policy.", + "Resource version is in extended support." ], "type": "string" } @@ -3244,7 +3252,8 @@ "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED", "SIGNAL_TYPE_NO_ROOT_PASSWORD", "SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS", - "SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS" + "SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS", + "SIGNAL_TYPE_EXTENDED_SUPPORT" ], "enumDescriptions": [ "Unspecified signal type.", @@ -3252,7 +3261,8 @@ "Represents database auditing is disabled.", "Represents if a database has a password configured for the root account or not.", "Represents if a resource is exposed to public access.", - "Represents if a resources requires all incoming connections to use SSL or not." + "Represents if a resources requires all incoming connections to use SSL or not.", + "Represents if a resource version is in extended support." ], "type": "string" } @@ -4985,29 +4995,6 @@ "type": "string" }, "phase": { - "deprecated": true, - "description": "Optional. Phase of the maintenance window. This is to capture order of maintenance. For example, for Cloud SQL resources, this can be used to capture if the maintenance window is in Week1, Week2, Week5, etc. Non production resources are usually part of early phase. For more details, refer to Cloud SQL resources - https://cloud.google.com/sql/docs/mysql/maintenance Deprecated. Use phase instead.", - "enum": [ - "WINDOW_PHASE_UNSPECIFIED", - "WINDOW_PHASE_ANY", - "WINDOW_PHASE_WEEK1", - "WINDOW_PHASE_WEEK2", - "WINDOW_PHASE_WEEK5" - ], - "enumDescriptions": [ - "Phase is unspecified.", - "Any phase.", - "Week 1.", - "Week 2.", - "Week 5." - ], - "type": "string" - }, - "time": { - "$ref": "TimeOfDay", - "description": "Optional. Preferred time to start the maintenance operation on the specified day." - }, - "week": { "description": "Optional. Phase of the maintenance window. This is to capture order of maintenance. For example, for Cloud SQL resources, this can be used to capture if the maintenance window is in Week1, Week2, Week5, etc. Non production resources are usually part of early phase. For more details, refer to Cloud SQL resources - https://cloud.google.com/sql/docs/mysql/maintenance", "enum": [ "PHASE_UNSPECIFIED", @@ -5024,6 +5011,10 @@ "Week 5." ], "type": "string" + }, + "time": { + "$ref": "TimeOfDay", + "description": "Optional. Preferred time to start the maintenance operation on the specified day." } }, "type": "object" diff --git a/discovery/redis-v1beta1.json b/discovery/redis-v1beta1.json index cbc505cf82..f1e993b90c 100644 --- a/discovery/redis-v1beta1.json +++ b/discovery/redis-v1beta1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1078,7 +1078,7 @@ } } }, - "revision": "20251009", + "revision": "20251021", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -1950,7 +1950,8 @@ "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED", "SIGNAL_TYPE_NO_ROOT_PASSWORD", "SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS", - "SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS" + "SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS", + "SIGNAL_TYPE_EXTENDED_SUPPORT" ], "enumDescriptions": [ "Unspecified signal type.", @@ -1958,7 +1959,8 @@ "Represents database auditing is disabled.", "Represents if a database has a password configured for the root account or not.", "Represents if a resource is exposed to public access.", - "Represents if a resources requires all incoming connections to use SSL or not." + "Represents if a resources requires all incoming connections to use SSL or not.", + "Represents if a resource version is in extended support." ], "type": "string" } @@ -2327,7 +2329,8 @@ "SIGNAL_TYPE_OUTDATED_VERSION", "SIGNAL_TYPE_OUTDATED_CLIENT", "SIGNAL_TYPE_DATABOOST_DISABLED", - "SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES" + "SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES", + "SIGNAL_TYPE_EXTENDED_SUPPORT" ], "enumDeprecated": [ false, @@ -2433,6 +2436,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -2539,7 +2543,8 @@ "Outdated version.", "Outdated client.", "Databoost is disabled.", - "Recommended maintenance policy." + "Recommended maintenance policy.", + "Resource version is in extended support." ], "type": "string" }, @@ -2979,7 +2984,8 @@ "SIGNAL_TYPE_OUTDATED_VERSION", "SIGNAL_TYPE_OUTDATED_CLIENT", "SIGNAL_TYPE_DATABOOST_DISABLED", - "SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES" + "SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES", + "SIGNAL_TYPE_EXTENDED_SUPPORT" ], "enumDeprecated": [ false, @@ -3085,6 +3091,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -3191,7 +3198,8 @@ "Outdated version.", "Outdated client.", "Databoost is disabled.", - "Recommended maintenance policy." + "Recommended maintenance policy.", + "Resource version is in extended support." ], "type": "string" } @@ -3244,7 +3252,8 @@ "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED", "SIGNAL_TYPE_NO_ROOT_PASSWORD", "SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS", - "SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS" + "SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS", + "SIGNAL_TYPE_EXTENDED_SUPPORT" ], "enumDescriptions": [ "Unspecified signal type.", @@ -3252,7 +3261,8 @@ "Represents database auditing is disabled.", "Represents if a database has a password configured for the root account or not.", "Represents if a resource is exposed to public access.", - "Represents if a resources requires all incoming connections to use SSL or not." + "Represents if a resources requires all incoming connections to use SSL or not.", + "Represents if a resource version is in extended support." ], "type": "string" } @@ -4992,29 +5002,6 @@ "type": "string" }, "phase": { - "deprecated": true, - "description": "Optional. Phase of the maintenance window. This is to capture order of maintenance. For example, for Cloud SQL resources, this can be used to capture if the maintenance window is in Week1, Week2, Week5, etc. Non production resources are usually part of early phase. For more details, refer to Cloud SQL resources - https://cloud.google.com/sql/docs/mysql/maintenance Deprecated. Use phase instead.", - "enum": [ - "WINDOW_PHASE_UNSPECIFIED", - "WINDOW_PHASE_ANY", - "WINDOW_PHASE_WEEK1", - "WINDOW_PHASE_WEEK2", - "WINDOW_PHASE_WEEK5" - ], - "enumDescriptions": [ - "Phase is unspecified.", - "Any phase.", - "Week 1.", - "Week 2.", - "Week 5." - ], - "type": "string" - }, - "time": { - "$ref": "TimeOfDay", - "description": "Optional. Preferred time to start the maintenance operation on the specified day." - }, - "week": { "description": "Optional. Phase of the maintenance window. This is to capture order of maintenance. For example, for Cloud SQL resources, this can be used to capture if the maintenance window is in Week1, Week2, Week5, etc. Non production resources are usually part of early phase. For more details, refer to Cloud SQL resources - https://cloud.google.com/sql/docs/mysql/maintenance", "enum": [ "PHASE_UNSPECIFIED", @@ -5031,6 +5018,10 @@ "Week 5." ], "type": "string" + }, + "time": { + "$ref": "TimeOfDay", + "description": "Optional. Preferred time to start the maintenance operation on the specified day." } }, "type": "object" diff --git a/discovery/retail-v2alpha.json b/discovery/retail-v2alpha.json index afb3828584..cbbd1bbb21 100644 --- a/discovery/retail-v2alpha.json +++ b/discovery/retail-v2alpha.json @@ -2874,7 +2874,7 @@ } } }, - "revision": "20251002", + "revision": "20251023", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -5123,7 +5123,8 @@ "id": "GoogleCloudRetailV2alphaExportProductsRequest", "properties": { "filter": { - "description": "A filtering expression to specify restrictions on returned events. The expression is a sequence of terms. Each term applies a restriction to the returned products. Use this expression to restrict results to a specific time range, tag, or stock state or to filter products by product type. For example, `lastModifiedTime > \"2012-04-23T18:25:43.511Z\" lastModifiedTime<\"2012-04-23T18:25:43.511Z\" productType=primary` We expect only four types of fields: * `lastModifiedTime`: This can be specified twice, once with a less than operator and once with a greater than operator. The `lastModifiedTime` restriction should result in one, contiguous, valid, last-modified, time range. * `productType`: Supported values are `primary` and `variant`. The Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and must be separated from the `productType` values by a space. * `availability`: Supported values are `IN_STOCK`, `OUT_OF_STOCK`, `PREORDER`, and `BACKORDER`. Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and must be separated from the `availability` values by a space. * `Tag expressions`: Restricts output to products that match all of the specified tags. Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and the operators are separated from the tag values by a space. Also supported is '`-\"tagA\"`', which is equivalent to '`NOT \"tagA\"`'. Tag values must be double-quoted, UTF-8 encoded strings and have a size limit of 1,000 characters. Some examples of valid filters expressions: * Example 1: `lastModifiedTime > \"2012-04-23T18:25:43.511Z\" lastModifiedTime < \"2012-04-23T18:30:43.511Z\"` * Example 2: `lastModifiedTime > \"2012-04-23T18:25:43.511Z\" productType = \"variant\"` * Example 3: `tag=(\"Red\" OR \"Blue\") tag=\"New-Arrival\" tag=(NOT \"promotional\") productType = \"primary\" lastModifiedTime < \"2018-04-23T18:30:43.511Z\"` * Example 4: `lastModifiedTime > \"2012-04-23T18:25:43.511Z\"` * Example 5: `availability = (IN_STOCK OR BACKORDER)`", + "deprecated": true, + "description": "This field is deprecated. Any filter provided will be ignored.", "type": "string" }, "outputConfig": { diff --git a/discovery/retail-v2beta.json b/discovery/retail-v2beta.json index 350d8381f7..6f12e73848 100644 --- a/discovery/retail-v2beta.json +++ b/discovery/retail-v2beta.json @@ -2498,7 +2498,7 @@ } } }, - "revision": "20251002", + "revision": "20251023", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -5395,7 +5395,8 @@ "id": "GoogleCloudRetailV2betaExportProductsRequest", "properties": { "filter": { - "description": "A filtering expression to specify restrictions on returned events. The expression is a sequence of terms. Each term applies a restriction to the returned products. Use this expression to restrict results to a specific time range, tag, or stock state or to filter products by product type. For example, `lastModifiedTime > \"2012-04-23T18:25:43.511Z\" lastModifiedTime<\"2012-04-23T18:25:43.511Z\" productType=primary` We expect only four types of fields: * `lastModifiedTime`: This can be specified twice, once with a less than operator and once with a greater than operator. The `lastModifiedTime` restriction should result in one, contiguous, valid, last-modified, time range. * `productType`: Supported values are `primary` and `variant`. The Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and must be separated from the `productType` values by a space. * `availability`: Supported values are `IN_STOCK`, `OUT_OF_STOCK`, `PREORDER`, and `BACKORDER`. Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and must be separated from the `availability` values by a space. * `Tag expressions`: Restricts output to products that match all of the specified tags. Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and the operators are separated from the tag values by a space. Also supported is '`-\"tagA\"`', which is equivalent to '`NOT \"tagA\"`'. Tag values must be double-quoted, UTF-8 encoded strings and have a size limit of 1,000 characters. Some examples of valid filters expressions: * Example 1: `lastModifiedTime > \"2012-04-23T18:25:43.511Z\" lastModifiedTime < \"2012-04-23T18:30:43.511Z\"` * Example 2: `lastModifiedTime > \"2012-04-23T18:25:43.511Z\" productType = \"variant\"` * Example 3: `tag=(\"Red\" OR \"Blue\") tag=\"New-Arrival\" tag=(NOT \"promotional\") productType = \"primary\" lastModifiedTime < \"2018-04-23T18:30:43.511Z\"` * Example 4: `lastModifiedTime > \"2012-04-23T18:25:43.511Z\"` * Example 5: `availability = (IN_STOCK OR BACKORDER)`", + "deprecated": true, + "description": "This field is deprecated. Any filter provided will be ignored.", "type": "string" }, "outputConfig": { diff --git a/discovery/run-v2.json b/discovery/run-v2.json index 68fb7ad713..6ed80e1e6c 100644 --- a/discovery/run-v2.json +++ b/discovery/run-v2.json @@ -1942,7 +1942,7 @@ } } }, - "revision": "20251003", + "revision": "20251019", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2BinaryAuthorization": { @@ -2311,6 +2311,10 @@ "$ref": "GoogleCloudRunV2ResourceRequirements", "description": "Compute Resource requirements by this container." }, + "source": { + "description": "Optional. Location of the source .tar.gz file in Cloud Storage. examples: - gs://bucket/object.tar.gz. - gs://bucket/object.tar.gz#1234567890 (with object generation)", + "type": "string" + }, "startupProbe": { "$ref": "GoogleCloudRunV2Probe", "description": "Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails." diff --git a/discovery/securitycenter-v1.json b/discovery/securitycenter-v1.json index dfab02ca02..4f66afac0f 100644 --- a/discovery/securitycenter-v1.json +++ b/discovery/securitycenter-v1.json @@ -1769,6 +1769,7 @@ ] }, "updateOrganizationSettings": { + "deprecated": true, "description": "Updates an organization's settings.", "flatPath": "v1/organizations/{organizationsId}/organizationSettings", "httpMethod": "PATCH", @@ -5943,7 +5944,7 @@ } } }, - "revision": "20251006", + "revision": "20251024", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -11843,6 +11844,10 @@ "description": "The AppHub application associated with the resource, if any.", "id": "GoogleCloudSecuritycenterV2IssueResourceApplication", "properties": { + "attributes": { + "$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes", + "description": "Consumer provided attributes for the application" + }, "name": { "description": "The resource name of an Application. Format: `projects/{host-project-id}/locations/{location}/applications/{application-id}`", "type": "string" @@ -11850,6 +11855,103 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes": { + "description": "Consumer provided attributes for the application", + "id": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes", + "properties": { + "businessOwners": { + "description": "Business team that ensures user needs are met and value is delivered", + "items": { + "$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo" + }, + "type": "array" + }, + "criticality": { + "$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesCriticality", + "description": "User-defined criticality information." + }, + "developerOwners": { + "description": "Developer team that owns development and coding.", + "items": { + "$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo" + }, + "type": "array" + }, + "environment": { + "$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesEnvironment", + "description": "User-defined environment information." + }, + "operatorOwners": { + "description": "Operator team that ensures runtime and operations.", + "items": { + "$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo": { + "description": "Contact information of stakeholders.", + "id": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo", + "properties": { + "email": { + "description": "Email address of the contacts.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesCriticality": { + "description": "Criticality of the Application, Service, or Workload", + "id": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesCriticality", + "properties": { + "type": { + "description": "Criticality Type.", + "enum": [ + "CRITICALITY_TYPE_UNSPECIFIED", + "MISSION_CRITICAL", + "HIGH", + "MEDIUM", + "LOW" + ], + "enumDescriptions": [ + "Unspecified type.", + "Mission critical service, application or workload.", + "High impact.", + "Medium impact.", + "Low impact." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesEnvironment": { + "description": "Environment of the Application, Service, or Workload", + "id": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesEnvironment", + "properties": { + "type": { + "description": "Environment Type.", + "enum": [ + "ENVIRONMENT_TYPE_UNSPECIFIED", + "PRODUCTION", + "STAGING", + "TEST", + "DEVELOPMENT" + ], + "enumDescriptions": [ + "Unspecified type.", + "Production environment.", + "Staging environment.", + "Test environment.", + "Development environment." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2IssueResourceAwsMetadata": { "description": "The AWS metadata of a resource associated with an issue.", "id": "GoogleCloudSecuritycenterV2IssueResourceAwsMetadata", diff --git a/discovery/securitycenter-v1beta1.json b/discovery/securitycenter-v1beta1.json index 7744a00d6e..f539d095df 100644 --- a/discovery/securitycenter-v1beta1.json +++ b/discovery/securitycenter-v1beta1.json @@ -150,6 +150,7 @@ ] }, "updateOrganizationSettings": { + "deprecated": true, "description": "Updates an organization's settings.", "flatPath": "v1beta1/organizations/{organizationsId}/organizationSettings", "httpMethod": "PATCH", @@ -918,7 +919,7 @@ } } }, - "revision": "20251006", + "revision": "20251024", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -6513,6 +6514,10 @@ "description": "The AppHub application associated with the resource, if any.", "id": "GoogleCloudSecuritycenterV2IssueResourceApplication", "properties": { + "attributes": { + "$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes", + "description": "Consumer provided attributes for the application" + }, "name": { "description": "The resource name of an Application. Format: `projects/{host-project-id}/locations/{location}/applications/{application-id}`", "type": "string" @@ -6520,6 +6525,103 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes": { + "description": "Consumer provided attributes for the application", + "id": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes", + "properties": { + "businessOwners": { + "description": "Business team that ensures user needs are met and value is delivered", + "items": { + "$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo" + }, + "type": "array" + }, + "criticality": { + "$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesCriticality", + "description": "User-defined criticality information." + }, + "developerOwners": { + "description": "Developer team that owns development and coding.", + "items": { + "$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo" + }, + "type": "array" + }, + "environment": { + "$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesEnvironment", + "description": "User-defined environment information." + }, + "operatorOwners": { + "description": "Operator team that ensures runtime and operations.", + "items": { + "$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo": { + "description": "Contact information of stakeholders.", + "id": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo", + "properties": { + "email": { + "description": "Email address of the contacts.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesCriticality": { + "description": "Criticality of the Application, Service, or Workload", + "id": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesCriticality", + "properties": { + "type": { + "description": "Criticality Type.", + "enum": [ + "CRITICALITY_TYPE_UNSPECIFIED", + "MISSION_CRITICAL", + "HIGH", + "MEDIUM", + "LOW" + ], + "enumDescriptions": [ + "Unspecified type.", + "Mission critical service, application or workload.", + "High impact.", + "Medium impact.", + "Low impact." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesEnvironment": { + "description": "Environment of the Application, Service, or Workload", + "id": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesEnvironment", + "properties": { + "type": { + "description": "Environment Type.", + "enum": [ + "ENVIRONMENT_TYPE_UNSPECIFIED", + "PRODUCTION", + "STAGING", + "TEST", + "DEVELOPMENT" + ], + "enumDescriptions": [ + "Unspecified type.", + "Production environment.", + "Staging environment.", + "Test environment.", + "Development environment." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2IssueResourceAwsMetadata": { "description": "The AWS metadata of a resource associated with an issue.", "id": "GoogleCloudSecuritycenterV2IssueResourceAwsMetadata", diff --git a/discovery/securitycenter-v1beta2.json b/discovery/securitycenter-v1beta2.json index b0a0004213..272b1a35b4 100644 --- a/discovery/securitycenter-v1beta2.json +++ b/discovery/securitycenter-v1beta2.json @@ -2003,7 +2003,7 @@ } } }, - "revision": "20251006", + "revision": "20251017", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -7501,6 +7501,10 @@ "description": "The AppHub application associated with the resource, if any.", "id": "GoogleCloudSecuritycenterV2IssueResourceApplication", "properties": { + "attributes": { + "$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes", + "description": "Consumer provided attributes for the application" + }, "name": { "description": "The resource name of an Application. Format: `projects/{host-project-id}/locations/{location}/applications/{application-id}`", "type": "string" @@ -7508,6 +7512,103 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes": { + "description": "Consumer provided attributes for the application", + "id": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes", + "properties": { + "businessOwners": { + "description": "Business team that ensures user needs are met and value is delivered", + "items": { + "$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo" + }, + "type": "array" + }, + "criticality": { + "$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesCriticality", + "description": "User-defined criticality information." + }, + "developerOwners": { + "description": "Developer team that owns development and coding.", + "items": { + "$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo" + }, + "type": "array" + }, + "environment": { + "$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesEnvironment", + "description": "User-defined environment information." + }, + "operatorOwners": { + "description": "Operator team that ensures runtime and operations.", + "items": { + "$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo": { + "description": "Contact information of stakeholders.", + "id": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo", + "properties": { + "email": { + "description": "Email address of the contacts.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesCriticality": { + "description": "Criticality of the Application, Service, or Workload", + "id": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesCriticality", + "properties": { + "type": { + "description": "Criticality Type.", + "enum": [ + "CRITICALITY_TYPE_UNSPECIFIED", + "MISSION_CRITICAL", + "HIGH", + "MEDIUM", + "LOW" + ], + "enumDescriptions": [ + "Unspecified type.", + "Mission critical service, application or workload.", + "High impact.", + "Medium impact.", + "Low impact." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesEnvironment": { + "description": "Environment of the Application, Service, or Workload", + "id": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesEnvironment", + "properties": { + "type": { + "description": "Environment Type.", + "enum": [ + "ENVIRONMENT_TYPE_UNSPECIFIED", + "PRODUCTION", + "STAGING", + "TEST", + "DEVELOPMENT" + ], + "enumDescriptions": [ + "Unspecified type.", + "Production environment.", + "Staging environment.", + "Test environment.", + "Development environment." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2IssueResourceAwsMetadata": { "description": "The AWS metadata of a resource associated with an issue.", "id": "GoogleCloudSecuritycenterV2IssueResourceAwsMetadata", diff --git a/discovery/securityposture-v1.json b/discovery/securityposture-v1.json index f0be08f19f..6e90ec55d8 100644 --- a/discovery/securityposture-v1.json +++ b/discovery/securityposture-v1.json @@ -220,6 +220,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}/operations", @@ -898,7 +903,7 @@ } } }, - "revision": "20250819", + "revision": "20251028", "rootUrl": "https://securityposture.googleapis.com/", "schemas": { "AssetDetails": { @@ -1265,6 +1270,13 @@ "$ref": "Operation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/discovery/serviceconsumermanagement-v1.json b/discovery/serviceconsumermanagement-v1.json index f9b9d35947..3bb8605621 100644 --- a/discovery/serviceconsumermanagement-v1.json +++ b/discovery/serviceconsumermanagement-v1.json @@ -216,6 +216,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}", @@ -542,7 +547,7 @@ } } }, - "revision": "20250919", + "revision": "20251023", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "AddTenantProjectRequest": { @@ -1789,6 +1794,13 @@ "$ref": "Operation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -3328,6 +3340,10 @@ "description": "P4 service identity resource name. An example name would be: `services/serviceconsumermanagement.googleapis.com/projects/123/serviceIdentities/default`", "type": "string" }, + "projectRole": { + "description": "The project-level IAM role defined in the service agent's grant configuration. This is the standard role intended for this service agent. This field is populated regardless of the `skip_role_attach` option in the request. If `skip_role_attach` is true, the caller can use this value to know which role they are responsible for granting.", + "type": "string" + }, "tag": { "description": "The P4 service identity configuration tag. This must be defined in activation_grants. If not specified when creating the account, the tag is set to \"default\".", "type": "string" diff --git a/discovery/serviceconsumermanagement-v1beta1.json b/discovery/serviceconsumermanagement-v1beta1.json index d2e6c3a404..dd5b96420c 100644 --- a/discovery/serviceconsumermanagement-v1beta1.json +++ b/discovery/serviceconsumermanagement-v1beta1.json @@ -724,7 +724,7 @@ } } }, - "revision": "20250919", + "revision": "20251023", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "Api": { @@ -3452,6 +3452,10 @@ "description": "P4 service identity resource name. An example name would be: `services/serviceconsumermanagement.googleapis.com/projects/123/serviceIdentities/default`", "type": "string" }, + "projectRole": { + "description": "The project-level IAM role defined in the service agent's grant configuration. This is the standard role intended for this service agent. This field is populated regardless of the `skip_role_attach` option in the request. If `skip_role_attach` is true, the caller can use this value to know which role they are responsible for granting.", + "type": "string" + }, "tag": { "description": "The P4 service identity configuration tag. This must be defined in activation_grants. If not specified when creating the account, the tag is set to \"default\".", "type": "string" diff --git a/discovery/servicenetworking-v1.json b/discovery/servicenetworking-v1.json index fc41982569..be8fd90972 100644 --- a/discovery/servicenetworking-v1.json +++ b/discovery/servicenetworking-v1.json @@ -1034,7 +1034,7 @@ } } }, - "revision": "20250929", + "revision": "20251027", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -1932,7 +1932,7 @@ "id": "Control", "properties": { "environment": { - "description": "The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com", + "description": "The service controller environment to use. If empty, no control plane features (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com.", "type": "string" }, "methodPolicies": { diff --git a/discovery/servicenetworking-v1beta.json b/discovery/servicenetworking-v1beta.json index a3876f2e22..124ae87e56 100644 --- a/discovery/servicenetworking-v1beta.json +++ b/discovery/servicenetworking-v1beta.json @@ -307,7 +307,7 @@ } } }, - "revision": "20250722", + "revision": "20251027", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -1076,7 +1076,7 @@ "id": "Control", "properties": { "environment": { - "description": "The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com", + "description": "The service controller environment to use. If empty, no control plane features (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com.", "type": "string" }, "methodPolicies": { diff --git a/discovery/serviceusage-v1.json b/discovery/serviceusage-v1.json index 35b08b432d..910cb5a31e 100644 --- a/discovery/serviceusage-v1.json +++ b/discovery/serviceusage-v1.json @@ -221,6 +221,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/operations", @@ -426,7 +431,7 @@ } } }, - "revision": "20250919", + "revision": "20251021", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -1185,6 +1190,22 @@ }, "type": "object" }, + "ContentSecurityPolicy": { + "description": "Content Security Policy contains the content security related policy of a resource.", + "id": "ContentSecurityPolicy", + "properties": { + "mcpContentSecurity": { + "$ref": "ContentSecurity", + "description": "mcp_content_security contains the content security related settings at resource level for MCP traffic." + }, + "name": { + "description": "Output only. The resource name of the policy. Only the `default` policy is supported. We allow the following formats: `projects/{PROJECT_NUMBER}/contentSecurityPolicies/default`, `projects/{PROJECT_ID}/contentSecurityPolicies/default`, We only support project level content security policy for now.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "ContentSecurityProvider": { "description": "ContentSecurityProvider contains the name of content security provider.", "id": "ContentSecurityProvider", @@ -2301,13 +2322,6 @@ "description": "Consumer Policy is a set of rules that define what services or service groups can be used for a cloud resource hierarchy.", "id": "GoogleApiServiceusageV2betaConsumerPolicy", "properties": { - "annotations": { - "additionalProperties": { - "type": "string" - }, - "description": "Optional. Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. [AIP-128](https://google.aip.dev/128#annotations)", - "type": "object" - }, "createTime": { "description": "Output only. The time the policy was created. For singleton policies, this is the first touch of the policy.", "format": "google-datetime", @@ -2636,6 +2650,13 @@ "$ref": "Operation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -2768,10 +2789,6 @@ "description": "MCP Consumer Policy is a set of rules that define MCP related policy for a cloud resource hierarchy.", "id": "McpPolicy", "properties": { - "contentSecurity": { - "$ref": "ContentSecurity", - "description": "ContentSecurity contains the content security related fields of a MCP policy." - }, "createTime": { "description": "Output only. The time the policy was created. For singleton policies (such as the `default` policy), this is the first touch of the policy.", "format": "google-datetime", @@ -3781,6 +3798,12 @@ "properties": {}, "type": "object" }, + "UpdateContentSecurityPolicyMetadata": { + "description": "Metadata for the `UpdateContentSecurityPolicy` method.", + "id": "UpdateContentSecurityPolicyMetadata", + "properties": {}, + "type": "object" + }, "UpdateMcpPolicyMetadata": { "description": "Metadata for the `UpdateMcpPolicy` method.", "id": "UpdateMcpPolicyMetadata", diff --git a/discovery/serviceusage-v1beta1.json b/discovery/serviceusage-v1beta1.json index 0098ec4fcd..232122a027 100644 --- a/discovery/serviceusage-v1beta1.json +++ b/discovery/serviceusage-v1beta1.json @@ -166,6 +166,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1beta1/operations", @@ -964,7 +969,7 @@ } } }, - "revision": "20250919", + "revision": "20251021", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -1781,6 +1786,22 @@ }, "type": "object" }, + "ContentSecurityPolicy": { + "description": "Content Security Policy contains the content security related policy of a resource.", + "id": "ContentSecurityPolicy", + "properties": { + "mcpContentSecurity": { + "$ref": "ContentSecurity", + "description": "mcp_content_security contains the content security related settings at resource level for MCP traffic." + }, + "name": { + "description": "Output only. The resource name of the policy. Only the `default` policy is supported. We allow the following formats: `projects/{PROJECT_NUMBER}/contentSecurityPolicies/default`, `projects/{PROJECT_ID}/contentSecurityPolicies/default`, We only support project level content security policy for now.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "ContentSecurityProvider": { "description": "ContentSecurityProvider contains the name of content security provider.", "id": "ContentSecurityProvider", @@ -2878,13 +2899,6 @@ "description": "Consumer Policy is a set of rules that define what services or service groups can be used for a cloud resource hierarchy.", "id": "GoogleApiServiceusageV2betaConsumerPolicy", "properties": { - "annotations": { - "additionalProperties": { - "type": "string" - }, - "description": "Optional. Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. [AIP-128](https://google.aip.dev/128#annotations)", - "type": "object" - }, "createTime": { "description": "Output only. The time the policy was created. For singleton policies, this is the first touch of the policy.", "format": "google-datetime", @@ -3331,6 +3345,13 @@ "$ref": "Operation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -3463,10 +3484,6 @@ "description": "MCP Consumer Policy is a set of rules that define MCP related policy for a cloud resource hierarchy.", "id": "McpPolicy", "properties": { - "contentSecurity": { - "$ref": "ContentSecurity", - "description": "ContentSecurity contains the content security related fields of a MCP policy." - }, "createTime": { "description": "Output only. The time the policy was created. For singleton policies (such as the `default` policy), this is the first touch of the policy.", "format": "google-datetime", @@ -4669,6 +4686,12 @@ "properties": {}, "type": "object" }, + "UpdateContentSecurityPolicyMetadata": { + "description": "Metadata for the `UpdateContentSecurityPolicy` method.", + "id": "UpdateContentSecurityPolicyMetadata", + "properties": {}, + "type": "object" + }, "UpdateMcpPolicyMetadata": { "description": "Metadata for the `UpdateMcpPolicy` method.", "id": "UpdateMcpPolicyMetadata", diff --git a/discovery/solar-v1.json b/discovery/solar-v1.json index 142cc55df3..df33782c7c 100644 --- a/discovery/solar-v1.json +++ b/discovery/solar-v1.json @@ -114,6 +114,11 @@ "id": "solar.buildingInsights.findClosest", "parameterOrder": [], "parameters": { + "exactQualityRequired": { + "description": "Optional. Whether to require exact quality of the imagery. If set to false, the `required_quality` field is interpreted as the minimum required quality, such that HIGH quality imagery may be returned when `required_quality` is set to MEDIUM. If set to true, `required_quality` is interpreted as the exact required quality and only `MEDIUM` quality imagery is returned if `required_quality` is set to `MEDIUM`.", + "location": "query", + "type": "boolean" + }, "experiments": { "description": "Optional. Specifies the pre-GA features to enable.", "enum": [ @@ -299,7 +304,7 @@ } } }, - "revision": "20250804", + "revision": "20251027", "rootUrl": "https://solar.googleapis.com/", "schemas": { "BuildingInsights": { diff --git a/discovery/spanner-v1.json b/discovery/spanner-v1.json index e976e8cf27..0c2e120b01 100644 --- a/discovery/spanner-v1.json +++ b/discovery/spanner-v1.json @@ -3406,7 +3406,7 @@ } } }, - "revision": "20250920", + "revision": "20251014", "rootUrl": "https://spanner.googleapis.com/", "schemas": { "AdaptMessageRequest": { @@ -7601,7 +7601,7 @@ ], "enumDescriptions": [ "Default value. If the value is not specified, the `SERIALIZABLE` isolation level is used.", - "All transactions appear as if they executed in a serial order, even if some of the reads, writes, and other operations of distinct transactions actually occurred in parallel. Spanner assigns commit timestamps that reflect the order of committed transactions to implement this property. Spanner offers a stronger guarantee than serializability called external consistency. For further details, please refer to https://cloud.google.com/spanner/docs/true-time-external-consistency#serializability.", + "All transactions appear as if they executed in a serial order, even if some of the reads, writes, and other operations of distinct transactions actually occurred in parallel. Spanner assigns commit timestamps that reflect the order of committed transactions to implement this property. Spanner offers a stronger guarantee than serializability called external consistency. For more information, see [TrueTime and external consistency](https://cloud.google.com/spanner/docs/true-time-external-consistency#serializability).", "All reads performed during the transaction observe a consistent snapshot of the database, and the transaction is only successfully committed in the absence of conflicts between its updates and any concurrent updates that have occurred since that snapshot. Consequently, in contrast to `SERIALIZABLE` transactions, only write-write conflicts are detected in snapshot transactions. This isolation level does not support Read-only and Partitioned DML transactions. When `REPEATABLE_READ` is specified on a read-write transaction, the locking semantics default to `OPTIMISTIC`." ], "type": "string" @@ -7667,7 +7667,8 @@ "JSON", "PROTO", "ENUM", - "INTERVAL" + "INTERVAL", + "UUID" ], "enumDescriptions": [ "Not specified.", @@ -7685,7 +7686,8 @@ "Encoded as a JSON-formatted `string` as described in RFC 7159. The following rules are applied when parsing JSON input: - Whitespace characters are not preserved. - If a JSON object has duplicate keys, only the first key is preserved. - Members of a JSON object are not guaranteed to have their order preserved. - JSON array elements will have their order preserved.", "Encoded as a base64-encoded `string`, as described in RFC 4648, section 4.", "Encoded as `string`, in decimal format.", - "Encoded as `string`, in `ISO8601` duration format - `P[n]Y[n]M[n]DT[n]H[n]M[n[.fraction]]S` where `n` is an integer. For example, `P1Y2M3DT4H5M6.5S` represents time duration of 1 year, 2 months, 3 days, 4 hours, 5 minutes, and 6.5 seconds." + "Encoded as `string`, in `ISO8601` duration format - `P[n]Y[n]M[n]DT[n]H[n]M[n[.fraction]]S` where `n` is an integer. For example, `P1Y2M3DT4H5M6.5S` represents time duration of 1 year, 2 months, 3 days, 4 hours, 5 minutes, and 6.5 seconds.", + "Encoded as `string`, in lower-case hexa-decimal format, as described in RFC 9562, section 4." ], "type": "string" }, diff --git a/discovery/sqladmin-v1.json b/discovery/sqladmin-v1.json index 8653cedd28..5fb839b42e 100644 --- a/discovery/sqladmin-v1.json +++ b/discovery/sqladmin-v1.json @@ -962,13 +962,13 @@ ], "parameters": { "instance": { - "description": "The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID.", + "description": "Required. The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID.", "location": "path", "required": true, "type": "string" }, "project": { - "description": "Project ID of the source as well as the clone Cloud SQL instance.", + "description": "Required. Project ID of the source as well as the clone Cloud SQL instance.", "location": "path", "required": true, "type": "string" @@ -2685,7 +2685,7 @@ } } }, - "revision": "20251006", + "revision": "20251019", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -3626,7 +3626,7 @@ "type": "array" }, "destinationInstanceName": { - "description": "Name of the Cloud SQL instance to be created as a clone.", + "description": "Required. Name of the Cloud SQL instance to be created as a clone.", "type": "string" }, "kind": { @@ -5681,7 +5681,7 @@ "properties": { "cloneContext": { "$ref": "CloneContext", - "description": "Contains details about the clone operation." + "description": "Required. Contains details about the clone operation." } }, "type": "object" @@ -7421,6 +7421,20 @@ "description": "Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.", "type": "boolean" }, + "dataApiAccess": { + "description": "This parameter controls whether to allow using Data API to connect to the instance. Not allowed by default.", + "enum": [ + "DATA_API_ACCESS_UNSPECIFIED", + "DISALLOW_DATA_API", + "ALLOW_DATA_API" + ], + "enumDescriptions": [ + "Unspecified, effectively the same as `DISALLOW_DATA_API`.", + "Disallow using Data API to connect to the instance.", + "Allow using Data API to connect to the instance. For private IP instances, this will allow authorized users to access the instance from the public internet." + ], + "type": "string" + }, "dataCacheConfig": { "$ref": "DataCacheConfig", "description": "Configuration for data cache." diff --git a/discovery/sqladmin-v1beta4.json b/discovery/sqladmin-v1beta4.json index 612d04da8c..7aed7b8d00 100644 --- a/discovery/sqladmin-v1beta4.json +++ b/discovery/sqladmin-v1beta4.json @@ -2685,7 +2685,7 @@ } } }, - "revision": "20251006", + "revision": "20251019", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -7422,6 +7422,20 @@ "description": "Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.", "type": "boolean" }, + "dataApiAccess": { + "description": "This parameter controls whether to allow using Data API to connect to the instance. Not allowed by default.", + "enum": [ + "DATA_API_ACCESS_UNSPECIFIED", + "DISALLOW_DATA_API", + "ALLOW_DATA_API" + ], + "enumDescriptions": [ + "Unspecified, effectively the same as `DISALLOW_DATA_API`.", + "Disallow using Data API to connect to the instance.", + "Allow using Data API to connect to the instance. For private IP instances, this will allow authorized users to access the instance from the public internet." + ], + "type": "string" + }, "dataCacheConfig": { "$ref": "DataCacheConfig", "description": "Configuration for data cache." diff --git a/discovery/storagebatchoperations-v1.json b/discovery/storagebatchoperations-v1.json index 0d1af224e3..76f3188b9e 100644 --- a/discovery/storagebatchoperations-v1.json +++ b/discovery/storagebatchoperations-v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -487,7 +487,7 @@ } } }, - "revision": "20251015", + "revision": "20251022", "rootUrl": "https://storagebatchoperations.googleapis.com/", "schemas": { "Bucket": { diff --git a/discovery/storagetransfer-v1.json b/discovery/storagetransfer-v1.json index 41c8b559bf..559c2d1183 100644 --- a/discovery/storagetransfer-v1.json +++ b/discovery/storagetransfer-v1.json @@ -563,6 +563,11 @@ "description": "The list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}", @@ -632,7 +637,7 @@ } } }, - "revision": "20250801", + "revision": "20251010", "rootUrl": "https://storagetransfer.googleapis.com/", "schemas": { "AgentPool": { @@ -837,7 +842,7 @@ "type": "object" }, "ErrorLogEntry": { - "description": "An entry describing an error that has occurred.", + "description": "LINT.IfChange An entry describing an error that has occurred.", "id": "ErrorLogEntry", "properties": { "errorDetails": { @@ -1040,6 +1045,13 @@ "$ref": "Operation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/discovery/trafficdirector-v2.json b/discovery/trafficdirector-v2.json index 2c3b76ce4e..be8cff3256 100644 --- a/discovery/trafficdirector-v2.json +++ b/discovery/trafficdirector-v2.json @@ -15,6 +15,233 @@ "description": "", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/traffic-director", + "endpoints": [ + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.africa-south1.rep.googleapis.com/", + "location": "africa-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.asia-east1.rep.googleapis.com/", + "location": "asia-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.asia-east2.rep.googleapis.com/", + "location": "asia-east2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.asia-northeast1.rep.googleapis.com/", + "location": "asia-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.asia-northeast2.rep.googleapis.com/", + "location": "asia-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.asia-northeast3.rep.googleapis.com/", + "location": "asia-northeast3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.asia-south1.rep.googleapis.com/", + "location": "asia-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.asia-south2.rep.googleapis.com/", + "location": "asia-south2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.asia-southeast1.rep.googleapis.com/", + "location": "asia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.asia-southeast2.rep.googleapis.com/", + "location": "asia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.australia-southeast1.rep.googleapis.com/", + "location": "australia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.australia-southeast2.rep.googleapis.com/", + "location": "australia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.europe-central2.rep.googleapis.com/", + "location": "europe-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.europe-north1.rep.googleapis.com/", + "location": "europe-north1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.europe-north2.rep.googleapis.com/", + "location": "europe-north2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.europe-southwest1.rep.googleapis.com/", + "location": "europe-southwest1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.europe-west1.rep.googleapis.com/", + "location": "europe-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.europe-west10.rep.googleapis.com/", + "location": "europe-west10" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.europe-west12.rep.googleapis.com/", + "location": "europe-west12" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.europe-west2.rep.googleapis.com/", + "location": "europe-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.europe-west3.rep.googleapis.com/", + "location": "europe-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.europe-west4.rep.googleapis.com/", + "location": "europe-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.europe-west6.rep.googleapis.com/", + "location": "europe-west6" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.europe-west8.rep.googleapis.com/", + "location": "europe-west8" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.europe-west9.rep.googleapis.com/", + "location": "europe-west9" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.me-central1.rep.googleapis.com/", + "location": "me-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.me-central2.rep.googleapis.com/", + "location": "me-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.me-west1.rep.googleapis.com/", + "location": "me-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.northamerica-northeast1.rep.googleapis.com/", + "location": "northamerica-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.northamerica-northeast2.rep.googleapis.com/", + "location": "northamerica-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.northamerica-south1.rep.googleapis.com/", + "location": "northamerica-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.southamerica-east1.rep.googleapis.com/", + "location": "southamerica-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.southamerica-west1.rep.googleapis.com/", + "location": "southamerica-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.us-central1.rep.googleapis.com/", + "location": "us-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.us-central2.rep.googleapis.com/", + "location": "us-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.us-east1.rep.googleapis.com/", + "location": "us-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.us-east4.rep.googleapis.com/", + "location": "us-east4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.us-east5.rep.googleapis.com/", + "location": "us-east5" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.us-east7.rep.googleapis.com/", + "location": "us-east7" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.us-south1.rep.googleapis.com/", + "location": "us-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.us-west1.rep.googleapis.com/", + "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.us-west2.rep.googleapis.com/", + "location": "us-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.us-west3.rep.googleapis.com/", + "location": "us-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.us-west4.rep.googleapis.com/", + "location": "us-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.us-west8.rep.googleapis.com/", + "location": "us-west8" + } + ], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -128,7 +355,7 @@ } } }, - "revision": "20250908", + "revision": "20251015", "rootUrl": "https://trafficdirector.googleapis.com/", "schemas": { "Address": { diff --git a/discovery/trafficdirector-v3.json b/discovery/trafficdirector-v3.json index d43ee9e97b..78c4900b79 100644 --- a/discovery/trafficdirector-v3.json +++ b/discovery/trafficdirector-v3.json @@ -15,6 +15,233 @@ "description": "", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/traffic-director", + "endpoints": [ + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.africa-south1.rep.googleapis.com/", + "location": "africa-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.asia-east1.rep.googleapis.com/", + "location": "asia-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.asia-east2.rep.googleapis.com/", + "location": "asia-east2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.asia-northeast1.rep.googleapis.com/", + "location": "asia-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.asia-northeast2.rep.googleapis.com/", + "location": "asia-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.asia-northeast3.rep.googleapis.com/", + "location": "asia-northeast3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.asia-south1.rep.googleapis.com/", + "location": "asia-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.asia-south2.rep.googleapis.com/", + "location": "asia-south2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.asia-southeast1.rep.googleapis.com/", + "location": "asia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.asia-southeast2.rep.googleapis.com/", + "location": "asia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.australia-southeast1.rep.googleapis.com/", + "location": "australia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.australia-southeast2.rep.googleapis.com/", + "location": "australia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.europe-central2.rep.googleapis.com/", + "location": "europe-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.europe-north1.rep.googleapis.com/", + "location": "europe-north1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.europe-north2.rep.googleapis.com/", + "location": "europe-north2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.europe-southwest1.rep.googleapis.com/", + "location": "europe-southwest1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.europe-west1.rep.googleapis.com/", + "location": "europe-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.europe-west10.rep.googleapis.com/", + "location": "europe-west10" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.europe-west12.rep.googleapis.com/", + "location": "europe-west12" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.europe-west2.rep.googleapis.com/", + "location": "europe-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.europe-west3.rep.googleapis.com/", + "location": "europe-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.europe-west4.rep.googleapis.com/", + "location": "europe-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.europe-west6.rep.googleapis.com/", + "location": "europe-west6" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.europe-west8.rep.googleapis.com/", + "location": "europe-west8" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.europe-west9.rep.googleapis.com/", + "location": "europe-west9" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.me-central1.rep.googleapis.com/", + "location": "me-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.me-central2.rep.googleapis.com/", + "location": "me-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.me-west1.rep.googleapis.com/", + "location": "me-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.northamerica-northeast1.rep.googleapis.com/", + "location": "northamerica-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.northamerica-northeast2.rep.googleapis.com/", + "location": "northamerica-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.northamerica-south1.rep.googleapis.com/", + "location": "northamerica-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.southamerica-east1.rep.googleapis.com/", + "location": "southamerica-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.southamerica-west1.rep.googleapis.com/", + "location": "southamerica-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.us-central1.rep.googleapis.com/", + "location": "us-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.us-central2.rep.googleapis.com/", + "location": "us-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.us-east1.rep.googleapis.com/", + "location": "us-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.us-east4.rep.googleapis.com/", + "location": "us-east4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.us-east5.rep.googleapis.com/", + "location": "us-east5" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.us-east7.rep.googleapis.com/", + "location": "us-east7" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.us-south1.rep.googleapis.com/", + "location": "us-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.us-west1.rep.googleapis.com/", + "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.us-west2.rep.googleapis.com/", + "location": "us-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.us-west3.rep.googleapis.com/", + "location": "us-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.us-west4.rep.googleapis.com/", + "location": "us-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://trafficdirector.us-west8.rep.googleapis.com/", + "location": "us-west8" + } + ], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -128,7 +355,7 @@ } } }, - "revision": "20250908", + "revision": "20251015", "rootUrl": "https://trafficdirector.googleapis.com/", "schemas": { "Address": { diff --git a/discovery/vmmigration-v1.json b/discovery/vmmigration-v1.json index 3b50bd8d81..d4ddaa133f 100644 --- a/discovery/vmmigration-v1.json +++ b/discovery/vmmigration-v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2548,7 +2548,7 @@ } } }, - "revision": "20251002", + "revision": "20251023", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { diff --git a/discovery/vmmigration-v1alpha1.json b/discovery/vmmigration-v1alpha1.json index 17da05a5da..a250a762f7 100644 --- a/discovery/vmmigration-v1alpha1.json +++ b/discovery/vmmigration-v1alpha1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2548,7 +2548,7 @@ } } }, - "revision": "20251002", + "revision": "20251023", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { diff --git a/discovery/vpcaccess-v1.json b/discovery/vpcaccess-v1.json index e7fabfdd5f..c28938f128 100644 --- a/discovery/vpcaccess-v1.json +++ b/discovery/vpcaccess-v1.json @@ -119,7 +119,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -373,6 +373,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}/operations", @@ -390,7 +395,7 @@ } } }, - "revision": "20250916", + "revision": "20251021", "rootUrl": "https://vpcaccess.googleapis.com/", "schemas": { "Connector": { @@ -521,6 +526,13 @@ "$ref": "Operation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/discovery/vpcaccess-v1beta1.json b/discovery/vpcaccess-v1beta1.json index 4b7533022d..b1dcdb4be8 100644 --- a/discovery/vpcaccess-v1beta1.json +++ b/discovery/vpcaccess-v1beta1.json @@ -119,7 +119,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -373,6 +373,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -390,7 +395,7 @@ } } }, - "revision": "20250916", + "revision": "20251021", "rootUrl": "https://vpcaccess.googleapis.com/", "schemas": { "Connector": { @@ -533,6 +538,13 @@ "$ref": "Operation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/discovery/workflows-v1.json b/discovery/workflows-v1.json index 366ab9e328..402f078a47 100644 --- a/discovery/workflows-v1.json +++ b/discovery/workflows-v1.json @@ -266,6 +266,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}/operations", @@ -491,7 +496,7 @@ } } }, - "revision": "20250916", + "revision": "20251013", "rootUrl": "https://workflows.googleapis.com/", "schemas": { "Empty": { @@ -532,6 +537,13 @@ "$ref": "Operation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/discovery/workflows-v1beta.json b/discovery/workflows-v1beta.json index 5ef8a6c5e4..5e5fee7a04 100644 --- a/discovery/workflows-v1beta.json +++ b/discovery/workflows-v1beta.json @@ -266,6 +266,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" + }, + "returnPartialSuccess": { + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, "path": "v1beta/{+name}/operations", @@ -450,7 +455,7 @@ } } }, - "revision": "20250916", + "revision": "20251013", "rootUrl": "https://workflows.googleapis.com/", "schemas": { "Empty": { @@ -491,6 +496,13 @@ "$ref": "Operation" }, "type": "array" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/src/apis/admin/directory_v1.ts b/src/apis/admin/directory_v1.ts index d80625c59c..e08c1e463a 100644 --- a/src/apis/admin/directory_v1.ts +++ b/src/apis/admin/directory_v1.ts @@ -369,6 +369,19 @@ export namespace admin_directory_v1 { */ printServerIds?: string[] | null; } + /** + * Information about a device's Bluetooth adapter. + */ + export interface Schema$BluetoothAdapterInfo { + /** + * Output only. The MAC address of the adapter. + */ + address?: string | null; + /** + * Output only. The number of devices connected to this adapter. + */ + numConnectedDevices?: number | null; + } /** * Public API: Resources.buildings */ @@ -670,6 +683,10 @@ export namespace admin_directory_v1 { * Output only. Contains backlight information for the device. */ backlightInfo?: Schema$BacklightInfo[]; + /** + * Output only. Information about bluetooth adapters of the device. + */ + bluetoothAdapterInfo?: Schema$BluetoothAdapterInfo[]; /** * The boot mode for the device. The possible values are: * `Verified`: The device is running a valid version of the Chrome OS. * `Dev`: The devices's developer hardware switch is enabled. When booted, the device has a command line shell. For an example of a developer switch, see the [Chromebook developer information](https://www.chromium.org/chromium-os/developer-information-for-chrome-os-devices/samsung-series-5-chromebook#TOC-Developer-switch). */ @@ -3725,6 +3742,7 @@ export namespace admin_directory_v1 { * // "autoUpdateExpiration": "my_autoUpdateExpiration", * // "autoUpdateThrough": "my_autoUpdateThrough", * // "backlightInfo": [], + * // "bluetoothAdapterInfo": [], * // "bootMode": "my_bootMode", * // "chromeOsType": "my_chromeOsType", * // "cpuInfo": [], @@ -4217,6 +4235,7 @@ export namespace admin_directory_v1 { * // "autoUpdateExpiration": "my_autoUpdateExpiration", * // "autoUpdateThrough": "my_autoUpdateThrough", * // "backlightInfo": [], + * // "bluetoothAdapterInfo": [], * // "bootMode": "my_bootMode", * // "chromeOsType": "my_chromeOsType", * // "cpuInfo": [], @@ -4277,6 +4296,7 @@ export namespace admin_directory_v1 { * // "autoUpdateExpiration": "my_autoUpdateExpiration", * // "autoUpdateThrough": "my_autoUpdateThrough", * // "backlightInfo": [], + * // "bluetoothAdapterInfo": [], * // "bootMode": "my_bootMode", * // "chromeOsType": "my_chromeOsType", * // "cpuInfo": [], @@ -4470,6 +4490,7 @@ export namespace admin_directory_v1 { * // "autoUpdateExpiration": "my_autoUpdateExpiration", * // "autoUpdateThrough": "my_autoUpdateThrough", * // "backlightInfo": [], + * // "bluetoothAdapterInfo": [], * // "bootMode": "my_bootMode", * // "chromeOsType": "my_chromeOsType", * // "cpuInfo": [], @@ -4530,6 +4551,7 @@ export namespace admin_directory_v1 { * // "autoUpdateExpiration": "my_autoUpdateExpiration", * // "autoUpdateThrough": "my_autoUpdateThrough", * // "backlightInfo": [], + * // "bluetoothAdapterInfo": [], * // "bootMode": "my_bootMode", * // "chromeOsType": "my_chromeOsType", * // "cpuInfo": [], diff --git a/src/apis/aiplatform/v1.ts b/src/apis/aiplatform/v1.ts index 202791a7a3..a571956125 100644 --- a/src/apis/aiplatform/v1.ts +++ b/src/apis/aiplatform/v1.ts @@ -113,12 +113,39 @@ export namespace aiplatform_v1 { export class Aiplatform { context: APIRequestContext; batchPredictionJobs: Resource$Batchpredictionjobs; + customJobs: Resource$Customjobs; + dataLabelingJobs: Resource$Datalabelingjobs; datasets: Resource$Datasets; + deploymentResourcePools: Resource$Deploymentresourcepools; endpoints: Resource$Endpoints; + featureGroups: Resource$Featuregroups; + featureOnlineStores: Resource$Featureonlinestores; + featurestores: Resource$Featurestores; + hyperparameterTuningJobs: Resource$Hyperparametertuningjobs; + indexEndpoints: Resource$Indexendpoints; + indexes: Resource$Indexes; media: Resource$Media; + metadataStores: Resource$Metadatastores; + migratableResources: Resource$Migratableresources; + modelDeploymentMonitoringJobs: Resource$Modeldeploymentmonitoringjobs; + models: Resource$Models; + notebookExecutionJobs: Resource$Notebookexecutionjobs; + notebookRuntimes: Resource$Notebookruntimes; + notebookRuntimeTemplates: Resource$Notebookruntimetemplates; + operations: Resource$Operations; + persistentResources: Resource$Persistentresources; + pipelineJobs: Resource$Pipelinejobs; projects: Resource$Projects; publishers: Resource$Publishers; + ragCorpora: Resource$Ragcorpora; + ragEngineConfig: Resource$Ragengineconfig; reasoningEngines: Resource$Reasoningengines; + schedules: Resource$Schedules; + specialistPools: Resource$Specialistpools; + studies: Resource$Studies; + tensorboards: Resource$Tensorboards; + trainingPipelines: Resource$Trainingpipelines; + tuningJobs: Resource$Tuningjobs; constructor(options: GlobalOptions, google?: GoogleConfigurable) { this.context = { @@ -127,12 +154,48 @@ export namespace aiplatform_v1 { }; this.batchPredictionJobs = new Resource$Batchpredictionjobs(this.context); + this.customJobs = new Resource$Customjobs(this.context); + this.dataLabelingJobs = new Resource$Datalabelingjobs(this.context); this.datasets = new Resource$Datasets(this.context); + this.deploymentResourcePools = new Resource$Deploymentresourcepools( + this.context + ); this.endpoints = new Resource$Endpoints(this.context); + this.featureGroups = new Resource$Featuregroups(this.context); + this.featureOnlineStores = new Resource$Featureonlinestores(this.context); + this.featurestores = new Resource$Featurestores(this.context); + this.hyperparameterTuningJobs = new Resource$Hyperparametertuningjobs( + this.context + ); + this.indexEndpoints = new Resource$Indexendpoints(this.context); + this.indexes = new Resource$Indexes(this.context); this.media = new Resource$Media(this.context); + this.metadataStores = new Resource$Metadatastores(this.context); + this.migratableResources = new Resource$Migratableresources(this.context); + this.modelDeploymentMonitoringJobs = + new Resource$Modeldeploymentmonitoringjobs(this.context); + this.models = new Resource$Models(this.context); + this.notebookExecutionJobs = new Resource$Notebookexecutionjobs( + this.context + ); + this.notebookRuntimes = new Resource$Notebookruntimes(this.context); + this.notebookRuntimeTemplates = new Resource$Notebookruntimetemplates( + this.context + ); + this.operations = new Resource$Operations(this.context); + this.persistentResources = new Resource$Persistentresources(this.context); + this.pipelineJobs = new Resource$Pipelinejobs(this.context); this.projects = new Resource$Projects(this.context); this.publishers = new Resource$Publishers(this.context); + this.ragCorpora = new Resource$Ragcorpora(this.context); + this.ragEngineConfig = new Resource$Ragengineconfig(this.context); this.reasoningEngines = new Resource$Reasoningengines(this.context); + this.schedules = new Resource$Schedules(this.context); + this.specialistPools = new Resource$Specialistpools(this.context); + this.studies = new Resource$Studies(this.context); + this.tensorboards = new Resource$Tensorboards(this.context); + this.trainingPipelines = new Resource$Trainingpipelines(this.context); + this.tuningJobs = new Resource$Tuningjobs(this.context); } } @@ -3666,6 +3729,57 @@ export namespace aiplatform_v1 { */ mode?: string | null; } + /** + * Request message for PredictionService.EmbedContent. + */ + export interface Schema$GoogleCloudAiplatformV1EmbedContentRequest { + /** + * Optional. Whether to silently truncate the input content if it's longer than the maximum sequence length. + */ + autoTruncate?: boolean | null; + /** + * Required. Input content to be embedded. Required. + */ + content?: Schema$GoogleCloudAiplatformV1Content; + /** + * Optional. Optional reduced dimension for the output embedding. If set, excessive values in the output embedding are truncated from the end. + */ + outputDimensionality?: number | null; + /** + * Optional. The task type of the embedding. + */ + taskType?: string | null; + /** + * Optional. An optional title for the text. + */ + title?: string | null; + } + /** + * Response message for PredictionService.EmbedContent. + */ + export interface Schema$GoogleCloudAiplatformV1EmbedContentResponse { + /** + * The embedding generated from the input content. + */ + embedding?: Schema$GoogleCloudAiplatformV1EmbedContentResponseEmbedding; + /** + * Whether the input content was truncated before generating the embedding. + */ + truncated?: boolean | null; + /** + * Metadata about the response(s). + */ + usageMetadata?: Schema$GoogleCloudAiplatformV1UsageMetadata; + } + /** + * A list of floats representing an embedding. + */ + export interface Schema$GoogleCloudAiplatformV1EmbedContentResponseEmbedding { + /** + * Embedding vector values. + */ + values?: number[] | null; + } /** * Represents a customer-managed encryption key spec that can be applied to a top-level resource. */ @@ -4252,6 +4366,10 @@ export namespace aiplatform_v1 { * A single instance to be evaluated. Instances are used to specify the input data for evaluation, from simple string comparisons to complex, multi-turn model evaluations */ export interface Schema$GoogleCloudAiplatformV1EvaluationInstance { + /** + * Optional. Data used for agent evaluation. + */ + agentData?: Schema$GoogleCloudAiplatformV1EvaluationInstanceAgentData; /** * Optional. Other data used to populate placeholders based on their key. */ @@ -4275,6 +4393,79 @@ export namespace aiplatform_v1 { [key: string]: Schema$GoogleCloudAiplatformV1RubricGroup; } | null; } + /** + * Configuration for an Agent. + */ + export interface Schema$GoogleCloudAiplatformV1EvaluationInstanceAgentConfig { + /** + * Optional. A field containing instructions from the developer for the agent. + */ + developerInstruction?: Schema$GoogleCloudAiplatformV1EvaluationInstanceInstanceData; + /** + * List of tools. + */ + tools?: Schema$GoogleCloudAiplatformV1EvaluationInstanceAgentConfigTools; + /** + * A JSON string containing a list of tools available to an agent with info such as name, description, parameters and required parameters. + */ + toolsText?: string | null; + } + /** + * Represents a list of tools for an agent. + */ + export interface Schema$GoogleCloudAiplatformV1EvaluationInstanceAgentConfigTools { + /** + * Optional. List of tools: each tool can have multiple function declarations. + */ + tool?: Schema$GoogleCloudAiplatformV1Tool[]; + } + /** + * Contains data specific to agent evaluations. + */ + export interface Schema$GoogleCloudAiplatformV1EvaluationInstanceAgentData { + /** + * Optional. Agent configuration. + */ + agentConfig?: Schema$GoogleCloudAiplatformV1EvaluationInstanceAgentConfig; + /** + * Optional. A field containing instructions from the developer for the agent. + */ + developerInstruction?: Schema$GoogleCloudAiplatformV1EvaluationInstanceInstanceData; + /** + * A list of events. + */ + events?: Schema$GoogleCloudAiplatformV1EvaluationInstanceAgentDataEvents; + /** + * A JSON string containing a sequence of events. + */ + eventsText?: string | null; + /** + * List of tools. + */ + tools?: Schema$GoogleCloudAiplatformV1EvaluationInstanceAgentDataTools; + /** + * A JSON string containing a list of tools available to an agent with info such as name, description, parameters and required parameters. Example: [ { "name": "search_actors", "description": "Search for actors in a movie. Returns a list of actors, their roles, their birthdate, and their place of birth.", "parameters": [ { "name": "movie_name", "description": "The name of the movie." \}, { "name": "character_name", "description": "The name of the character." \} ], "required": ["movie_name", "character_name"] \} ] + */ + toolsText?: string | null; + } + /** + * Represents a list of events for an agent. + */ + export interface Schema$GoogleCloudAiplatformV1EvaluationInstanceAgentDataEvents { + /** + * Optional. A list of events. + */ + event?: Schema$GoogleCloudAiplatformV1Content[]; + } + /** + * Represents a list of tools for an agent. + */ + export interface Schema$GoogleCloudAiplatformV1EvaluationInstanceAgentDataTools { + /** + * Optional. List of tools: each tool can have multiple function declarations. + */ + tool?: Schema$GoogleCloudAiplatformV1Tool[]; + } /** * Instance data used to populate placeholders in a metric prompt template. */ @@ -4626,6 +4817,10 @@ export namespace aiplatform_v1 { * Required. The name of the metric. */ metric?: string | null; + /** + * The metric config. + */ + metricConfig?: Schema$GoogleCloudAiplatformV1Metric; /** * Spec for a pre-defined metric. */ @@ -6855,11 +7050,62 @@ export namespace aiplatform_v1 { * Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. */ name?: string | null; + /** + * Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + */ + parts?: Schema$GoogleCloudAiplatformV1FunctionResponsePart[]; /** * Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. */ response?: {[key: string]: any} | null; } + /** + * Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. + */ + export interface Schema$GoogleCloudAiplatformV1FunctionResponseBlob { + /** + * Required. Raw bytes. + */ + data?: string | null; + /** + * Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + */ + displayName?: string | null; + /** + * Required. The IANA standard MIME type of the source data. + */ + mimeType?: string | null; + } + /** + * URI based data for function response. + */ + export interface Schema$GoogleCloudAiplatformV1FunctionResponseFileData { + /** + * Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + */ + displayName?: string | null; + /** + * Required. URI. + */ + fileUri?: string | null; + /** + * Required. The IANA standard MIME type of the source data. + */ + mimeType?: string | null; + } + /** + * A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + */ + export interface Schema$GoogleCloudAiplatformV1FunctionResponsePart { + /** + * URI based data. + */ + fileData?: Schema$GoogleCloudAiplatformV1FunctionResponseFileData; + /** + * Inline media bytes. + */ + inlineData?: Schema$GoogleCloudAiplatformV1FunctionResponseBlob; + } /** * The Google Cloud Storage location where the output is to be written to. */ @@ -7062,6 +7308,10 @@ export namespace aiplatform_v1 { * Request message for EvaluationService.GenerateInstanceRubrics. */ export interface Schema$GoogleCloudAiplatformV1GenerateInstanceRubricsRequest { + /** + * Optional. Agent configuration, required for agent-based rubric generation. + */ + agentConfig?: Schema$GoogleCloudAiplatformV1EvaluationInstanceAgentConfig; /** * Required. The prompt to generate rubrics from. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request. */ @@ -7674,6 +7924,27 @@ export namespace aiplatform_v1 { * Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" */ aspectRatio?: string | null; + /** + * Optional. The image output format for generated images. + */ + imageOutputOptions?: Schema$GoogleCloudAiplatformV1ImageConfigImageOutputOptions; + /** + * Optional. Controls whether the model can generate people. + */ + personGeneration?: string | null; + } + /** + * The image output format for generated images. + */ + export interface Schema$GoogleCloudAiplatformV1ImageConfigImageOutputOptions { + /** + * Optional. The compression quality of the output image. + */ + compressionQuality?: number | null; + /** + * Optional. The image format that the output should be saved as. + */ + mimeType?: string | null; } /** * Describes the location from where we import data into a Dataset, together with the labels that will be applied to the DataItems and the Annotations. @@ -10525,7 +10796,7 @@ export namespace aiplatform_v1 { */ export interface Schema$GoogleCloudAiplatformV1MutateDeployedModelRequest { /** - * Required. The DeployedModel to be mutated within the Endpoint. Only the following fields can be mutated: * `min_replica_count` in either DedicatedResources or AutomaticResources * `max_replica_count` in either DedicatedResources or AutomaticResources * `required_replica_count` in DedicatedResources * autoscaling_metric_specs * `disable_container_logging` (v1 only) * `enable_container_logging` (v1beta1 only) + * Required. The DeployedModel to be mutated within the Endpoint. Only the following fields can be mutated: * `min_replica_count` in either DedicatedResources or AutomaticResources * `max_replica_count` in either DedicatedResources or AutomaticResources * `required_replica_count` in DedicatedResources * autoscaling_metric_specs * `disable_container_logging` (v1 only) * `enable_container_logging` (v1beta1 only) * `scale_to_zero_spec` in DedicatedResources (v1beta1 only) * `initial_replica_count` in DedicatedResources (v1beta1 only) */ deployedModel?: Schema$GoogleCloudAiplatformV1DeployedModel; /** @@ -12209,6 +12480,10 @@ export namespace aiplatform_v1 { * Required. The instances that are the input to the prediction call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the prediction call errors in case of AutoML Models, or, in case of customer created Models, the behaviour is as documented by that Model. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri. */ instances?: any[] | null; + /** + * Optional. The user labels for Imagen billing usage only. Only Imagen supports labels. For other use cases, it will be ignored. + */ + labels?: {[key: string]: string} | null; /** * The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' Model's PredictSchemata's parameters_schema_uri. */ @@ -13519,7 +13794,7 @@ export namespace aiplatform_v1 { */ basic?: Schema$GoogleCloudAiplatformV1RagManagedDbConfigBasic; /** - * Sets the RagManagedDb to the Scaled tier. + * Sets the RagManagedDb to the Scaled tier. This is the default tier if not explicitly chosen. */ scaled?: Schema$GoogleCloudAiplatformV1RagManagedDbConfigScaled; /** @@ -13978,6 +14253,10 @@ export namespace aiplatform_v1 { * Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. */ serviceAccount?: string | null; + /** + * Deploy from source code files with a defined entrypoint. + */ + sourceCodeSpec?: Schema$GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpec; } /** * The specification of a Reasoning Engine deployment. @@ -14033,6 +14312,49 @@ export namespace aiplatform_v1 { */ requirementsGcsUri?: string | null; } + /** + * Specification for deploying from source code. + */ + export interface Schema$GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpec { + /** + * Source code is provided directly in the request. + */ + inlineSource?: Schema$GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecInlineSource; + /** + * Configuration for a Python application. + */ + pythonSpec?: Schema$GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecPythonSpec; + } + /** + * Specifies source code provided as a byte stream. + */ + export interface Schema$GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecInlineSource { + /** + * Required. Input only. The application source code archive, provided as a compressed tarball (.tar.gz) file. + */ + sourceArchive?: string | null; + } + /** + * Specification for running a Python application from source. + */ + export interface Schema$GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecPythonSpec { + /** + * Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to "agent". The project root will be added to Python sys.path, allowing imports to be specified relative to the root. + */ + entrypointModule?: string | null; + /** + * Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to "root_agent". + */ + entrypointObject?: string | null; + /** + * Optional. The path to the requirements file, relative to the source root. If not specified, defaults to "requirements.txt". + */ + requirementsFile?: string | null; + /** + * Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, default value is 3.10. + */ + version?: string | null; + } /** * Request message for GenAiTuningService.RebaseTunedModel. */ @@ -19514,6 +19836,10 @@ export namespace aiplatform_v1 { * Optional. CodeExecution tool type. Enables the model to execute code as part of generation. */ codeExecution?: Schema$GoogleCloudAiplatformV1ToolCodeExecution; + /** + * Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + */ + computerUse?: Schema$GoogleCloudAiplatformV1ToolComputerUse; /** * Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. */ @@ -19608,6 +19934,19 @@ export namespace aiplatform_v1 { * Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. */ export interface Schema$GoogleCloudAiplatformV1ToolCodeExecution {} + /** + * Tool to support computer use. + */ + export interface Schema$GoogleCloudAiplatformV1ToolComputerUse { + /** + * Required. The environment being operated. + */ + environment?: string | null; + /** + * Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + */ + excludedPredefinedFunctions?: string[] | null; + } /** * Tool config. This config is shared for all tools provided in the request. */ @@ -20725,6 +21064,55 @@ export namespace aiplatform_v1 { */ urlRetrievalStatus?: string | null; } + /** + * Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. + */ + export interface Schema$GoogleCloudAiplatformV1UsageMetadata { + /** + * Output only. The number of tokens in the cached content that was used for this request. + */ + cachedContentTokenCount?: number | null; + /** + * Output only. A detailed breakdown of the token count for each modality in the cached content. + */ + cacheTokensDetails?: Schema$GoogleCloudAiplatformV1ModalityTokenCount[]; + /** + * The total number of tokens in the generated candidates. + */ + candidatesTokenCount?: number | null; + /** + * Output only. A detailed breakdown of the token count for each modality in the generated candidates. + */ + candidatesTokensDetails?: Schema$GoogleCloudAiplatformV1ModalityTokenCount[]; + /** + * The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. + */ + promptTokenCount?: number | null; + /** + * Output only. A detailed breakdown of the token count for each modality in the prompt. + */ + promptTokensDetails?: Schema$GoogleCloudAiplatformV1ModalityTokenCount[]; + /** + * Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. + */ + thoughtsTokenCount?: number | null; + /** + * Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. + */ + toolUsePromptTokenCount?: number | null; + /** + * Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. + */ + toolUsePromptTokensDetails?: Schema$GoogleCloudAiplatformV1ModalityTokenCount[]; + /** + * The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. + */ + totalTokenCount?: number | null; + /** + * Output only. The traffic type for this request. + */ + trafficType?: string | null; + } /** * References an API call. It contains more information about long running operation and Jobs that are triggered by the API call. */ @@ -21819,18 +22207,23 @@ export namespace aiplatform_v1 { readMask?: string; } - export class Resource$Datasets { + export class Resource$Customjobs { + context: APIRequestContext; + operations: Resource$Customjobs$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Customjobs$Operations(this.context); + } + } + + export class Resource$Customjobs$Operations { context: APIRequestContext; - datasetVersions: Resource$Datasets$Datasetversions; constructor(context: APIRequestContext) { this.context = context; - this.datasetVersions = new Resource$Datasets$Datasetversions( - this.context - ); } /** - * Creates a Dataset. + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -21859,43 +22252,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.datasets.create({ - * // Required. The resource name of the Location to create the Dataset in. Format: `projects/{project\}/locations/{location\}` - * parent: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "dataItemCount": "my_dataItemCount", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, - * // "metadata": {}, - * // "metadataArtifact": "my_metadataArtifact", - * // "metadataSchemaUri": "my_metadataSchemaUri", - * // "modelReference": "my_modelReference", - * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "savedQueries": [], - * // "updateTime": "my_updateTime" - * // } - * }, + * const res = await aiplatform.customJobs.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'customJobs/my-customJob/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -21910,56 +22274,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Datasets$Create, + cancel( + params: Params$Resource$Customjobs$Operations$Cancel, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Datasets$Create, + cancel( + params?: Params$Resource$Customjobs$Operations$Cancel, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Datasets$Create, + ): Promise>; + cancel( + params: Params$Resource$Customjobs$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Datasets$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Datasets$Create, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Customjobs$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Customjobs$Operations$Cancel, + callback: BodyResponseCallback ): void; - create( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Datasets$Create - | BodyResponseCallback + | Params$Resource$Customjobs$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Datasets$Create; + let params = (paramsOrCallback || + {}) as Params$Resource$Customjobs$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Datasets$Create; + params = {} as Params$Resource$Customjobs$Operations$Cancel; options = {}; } @@ -21972,29 +22333,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/datasets').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: [], - pathParams: [], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a Dataset. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -22023,20 +22384,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.datasets.delete({ - * // Required. The resource name of the Dataset to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - * name: 'datasets/my-dataset', + * const res = await aiplatform.customJobs.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'customJobs/my-customJob/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -22052,55 +22407,52 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Datasets$Delete, + params: Params$Resource$Customjobs$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Datasets$Delete, + params?: Params$Resource$Customjobs$Operations$Delete, options?: MethodOptions - ): Promise>; + ): Promise>; delete( - params: Params$Resource$Datasets$Delete, + params: Params$Resource$Customjobs$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Datasets$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Datasets$Delete, - callback: BodyResponseCallback + params: Params$Resource$Customjobs$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - callback: BodyResponseCallback + params: Params$Resource$Customjobs$Operations$Delete, + callback: BodyResponseCallback ): void; + delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Datasets$Delete - | BodyResponseCallback + | Params$Resource$Customjobs$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Datasets$Delete; + let params = (paramsOrCallback || + {}) as Params$Resource$Customjobs$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Datasets$Delete; + params = {} as Params$Resource$Customjobs$Operations$Delete; options = {}; } @@ -22125,17 +22477,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a Dataset. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -22164,32 +22516,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.datasets.get({ - * // Required. The name of the Dataset resource. - * name: 'datasets/my-dataset', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', + * const res = await aiplatform.customJobs.operations.get({ + * // The name of the operation resource. + * name: 'customJobs/my-customJob/operations/my-operation', * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "dataItemCount": "my_dataItemCount", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, + * // "done": false, + * // "error": {}, * // "metadata": {}, - * // "metadataArtifact": "my_metadataArtifact", - * // "metadataSchemaUri": "my_metadataSchemaUri", - * // "modelReference": "my_modelReference", * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "savedQueries": [], - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -22206,55 +22545,56 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Datasets$Get, + params: Params$Resource$Customjobs$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Datasets$Get, + params?: Params$Resource$Customjobs$Operations$Get, options?: MethodOptions - ): Promise>; + ): Promise>; get( - params: Params$Resource$Datasets$Get, + params: Params$Resource$Customjobs$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Datasets$Get, + params: Params$Resource$Customjobs$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Datasets$Get, - callback: BodyResponseCallback + params: Params$Resource$Customjobs$Operations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Datasets$Get - | BodyResponseCallback + | Params$Resource$Customjobs$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Datasets$Get; + let params = (paramsOrCallback || + {}) as Params$Resource$Customjobs$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Datasets$Get; + params = {} as Params$Resource$Customjobs$Operations$Get; options = {}; } @@ -22279,19 +22619,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists Datasets in a Location. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -22320,26 +22658,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.datasets.list({ - * // An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `display_name`: supports = and != * `metadata_schema_uri`: supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. Some examples: * `displayName="myDisplayName"` * `labels.myKey="myValue"` + * const res = await aiplatform.customJobs.operations.list({ + * // The standard list filter. * filter: 'placeholder-value', - * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` - * orderBy: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'customJobs/my-customJob', * // The standard list page size. * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', - * // Required. The name of the Dataset's parent resource. Format: `projects/{project\}/locations/{location\}` - * parent: 'placeholder-value', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "datasets": [], - * // "nextPageToken": "my_nextPageToken" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -22356,59 +22693,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Datasets$List, + params: Params$Resource$Customjobs$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Datasets$List, + params?: Params$Resource$Customjobs$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Datasets$List, + params: Params$Resource$Customjobs$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Datasets$List, + params: Params$Resource$Customjobs$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Datasets$List, - callback: BodyResponseCallback + params: Params$Resource$Customjobs$Operations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Datasets$List - | BodyResponseCallback + | Params$Resource$Customjobs$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Datasets$List; + let params = (paramsOrCallback || + {}) as Params$Resource$Customjobs$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Datasets$List; + params = {} as Params$Resource$Customjobs$Operations$List; options = {}; } @@ -22421,31 +22759,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/datasets').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: [], - pathParams: [], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a Dataset. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -22474,55 +22815,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.datasets.patch({ - * // Output only. Identifier. The resource name of the Dataset. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - * name: 'datasets/my-dataset', - * // Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` * `description` * `labels` - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "dataItemCount": "my_dataItemCount", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, - * // "metadata": {}, - * // "metadataArtifact": "my_metadataArtifact", - * // "metadataSchemaUri": "my_metadataSchemaUri", - * // "modelReference": "my_modelReference", - * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "savedQueries": [], - * // "updateTime": "my_updateTime" - * // } - * }, + * const res = await aiplatform.customJobs.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'customJobs/my-customJob/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "dataItemCount": "my_dataItemCount", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, + * // "done": false, + * // "error": {}, * // "metadata": {}, - * // "metadataArtifact": "my_metadataArtifact", - * // "metadataSchemaUri": "my_metadataSchemaUri", - * // "modelReference": "my_modelReference", * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "savedQueries": [], - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -22538,56 +22845,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Datasets$Patch, + wait( + params: Params$Resource$Customjobs$Operations$Wait, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Datasets$Patch, + wait( + params?: Params$Resource$Customjobs$Operations$Wait, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Datasets$Patch, + ): Promise>; + wait( + params: Params$Resource$Customjobs$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Datasets$Patch, + wait( + params: Params$Resource$Customjobs$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Datasets$Patch, - callback: BodyResponseCallback + wait( + params: Params$Resource$Customjobs$Operations$Wait, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - patch( + wait( paramsOrCallback?: - | Params$Resource$Datasets$Patch - | BodyResponseCallback + | Params$Resource$Customjobs$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Datasets$Patch; + let params = (paramsOrCallback || + {}) as Params$Resource$Customjobs$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Datasets$Patch; + params = {} as Params$Resource$Customjobs$Operations$Wait; options = {}; } @@ -22600,8 +22908,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -22612,54 +22920,47 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Datasets$Create extends StandardParameters { - /** - * Required. The resource name of the Location to create the Dataset in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - + export interface Params$Resource$Customjobs$Operations$Cancel + extends StandardParameters { /** - * Request body metadata + * The name of the operation resource to be cancelled. */ - requestBody?: Schema$GoogleCloudAiplatformV1Dataset; + name?: string; } - export interface Params$Resource$Datasets$Delete extends StandardParameters { + export interface Params$Resource$Customjobs$Operations$Delete + extends StandardParameters { /** - * Required. The resource name of the Dataset to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Datasets$Get extends StandardParameters { + export interface Params$Resource$Customjobs$Operations$Get + extends StandardParameters { /** - * Required. The name of the Dataset resource. + * The name of the operation resource. */ name?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; } - export interface Params$Resource$Datasets$List extends StandardParameters { + export interface Params$Resource$Customjobs$Operations$List + extends StandardParameters { /** - * An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `display_name`: supports = and != * `metadata_schema_uri`: supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. Some examples: * `displayName="myDisplayName"` * `labels.myKey="myValue"` + * The standard list filter. */ filter?: string; /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` + * The name of the operation's parent resource. */ - orderBy?: string; + name?: string; /** * The standard list page size. */ @@ -22669,38 +22970,39 @@ export namespace aiplatform_v1 { */ pageToken?: string; /** - * Required. The name of the Dataset's parent resource. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - readMask?: string; + returnPartialSuccess?: boolean; } - export interface Params$Resource$Datasets$Patch extends StandardParameters { + export interface Params$Resource$Customjobs$Operations$Wait + extends StandardParameters { /** - * Output only. Identifier. The resource name of the Dataset. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + * The name of the operation resource to wait on. */ name?: string; /** - * Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` * `description` * `labels` + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - updateMask?: string; + timeout?: string; + } - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Dataset; + export class Resource$Datalabelingjobs { + context: APIRequestContext; + operations: Resource$Datalabelingjobs$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Datalabelingjobs$Operations(this.context); + } } - export class Resource$Datasets$Datasetversions { + export class Resource$Datalabelingjobs$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Create a version from a Dataset. + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -22729,37 +23031,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.datasets.datasetVersions.create({ - * // Required. The name of the Dataset resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - * parent: 'datasets/my-dataset', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "bigQueryDatasetName": "my_bigQueryDatasetName", - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "metadata": {}, - * // "modelReference": "my_modelReference", - * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime" - * // } - * }, + * const res = await aiplatform.dataLabelingJobs.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'dataLabelingJobs/my-dataLabelingJob/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -22774,57 +23053,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Datasets$Datasetversions$Create, + cancel( + params: Params$Resource$Datalabelingjobs$Operations$Cancel, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Datasets$Datasetversions$Create, + cancel( + params?: Params$Resource$Datalabelingjobs$Operations$Cancel, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Datasets$Datasetversions$Create, + ): Promise>; + cancel( + params: Params$Resource$Datalabelingjobs$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Datasets$Datasetversions$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Datasets$Datasetversions$Create, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Datalabelingjobs$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Datalabelingjobs$Operations$Cancel, + callback: BodyResponseCallback ): void; - create( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Datasets$Datasetversions$Create - | BodyResponseCallback + | Params$Resource$Datalabelingjobs$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Datasets$Datasetversions$Create; + {}) as Params$Resource$Datalabelingjobs$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Datasets$Datasetversions$Create; + params = {} as Params$Resource$Datalabelingjobs$Operations$Cancel; options = {}; } @@ -22837,32 +23112,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/datasetVersions').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a Dataset version. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -22891,20 +23163,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.datasets.datasetVersions.delete({ - * // Required. The resource name of the Dataset version to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` - * name: 'datasets/my-dataset/datasetVersions/my-datasetVersion', + * const res = await aiplatform.dataLabelingJobs.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'dataLabelingJobs/my-dataLabelingJob/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -22920,56 +23186,52 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Datasets$Datasetversions$Delete, + params: Params$Resource$Datalabelingjobs$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Datasets$Datasetversions$Delete, + params?: Params$Resource$Datalabelingjobs$Operations$Delete, options?: MethodOptions - ): Promise>; + ): Promise>; delete( - params: Params$Resource$Datasets$Datasetversions$Delete, + params: Params$Resource$Datalabelingjobs$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Datasets$Datasetversions$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Datasets$Datasetversions$Delete, - callback: BodyResponseCallback + params: Params$Resource$Datalabelingjobs$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - callback: BodyResponseCallback + params: Params$Resource$Datalabelingjobs$Operations$Delete, + callback: BodyResponseCallback ): void; + delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Datasets$Datasetversions$Delete - | BodyResponseCallback + | Params$Resource$Datalabelingjobs$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Datasets$Datasetversions$Delete; + {}) as Params$Resource$Datalabelingjobs$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Datasets$Datasetversions$Delete; + params = {} as Params$Resource$Datalabelingjobs$Operations$Delete; options = {}; } @@ -22994,17 +23256,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a Dataset version. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -23033,26 +23295,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.datasets.datasetVersions.get({ - * // Required. The resource name of the Dataset version to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` - * name: 'datasets/my-dataset/datasetVersions/my-datasetVersion', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', + * const res = await aiplatform.dataLabelingJobs.operations.get({ + * // The name of the operation resource. + * name: 'dataLabelingJobs/my-dataLabelingJob/operations/my-operation', * }); * console.log(res.data); * * // Example response * // { - * // "bigQueryDatasetName": "my_bigQueryDatasetName", - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "etag": "my_etag", + * // "done": false, + * // "error": {}, * // "metadata": {}, - * // "modelReference": "my_modelReference", * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -23069,60 +23324,56 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Datasets$Datasetversions$Get, + params: Params$Resource$Datalabelingjobs$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Datasets$Datasetversions$Get, + params?: Params$Resource$Datalabelingjobs$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; + ): Promise>; get( - params: Params$Resource$Datasets$Datasetversions$Get, + params: Params$Resource$Datalabelingjobs$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Datasets$Datasetversions$Get, + params: Params$Resource$Datalabelingjobs$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Datasets$Datasetversions$Get, - callback: BodyResponseCallback + params: Params$Resource$Datalabelingjobs$Operations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Datasets$Datasetversions$Get - | BodyResponseCallback + | Params$Resource$Datalabelingjobs$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Datasets$Datasetversions$Get; + {}) as Params$Resource$Datalabelingjobs$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Datasets$Datasetversions$Get; + params = {} as Params$Resource$Datalabelingjobs$Operations$Get; options = {}; } @@ -23147,19 +23398,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists DatasetVersions in a Dataset. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -23188,26 +23437,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.datasets.datasetVersions.list({ - * // Optional. The standard list filter. + * const res = await aiplatform.dataLabelingJobs.operations.list({ + * // The standard list filter. * filter: 'placeholder-value', - * // Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. - * orderBy: 'placeholder-value', - * // Optional. The standard list page size. + * // The name of the operation's parent resource. + * name: 'dataLabelingJobs/my-dataLabelingJob', + * // The standard list page size. * pageSize: 'placeholder-value', - * // Optional. The standard list page token. + * // The standard list page token. * pageToken: 'placeholder-value', - * // Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - * parent: 'datasets/my-dataset', - * // Optional. Mask specifying which fields to read. - * readMask: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "datasetVersions": [], - * // "nextPageToken": "my_nextPageToken" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -23224,60 +23472,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Datasets$Datasetversions$List, + params: Params$Resource$Datalabelingjobs$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Datasets$Datasetversions$List, + params?: Params$Resource$Datalabelingjobs$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Datasets$Datasetversions$List, + params: Params$Resource$Datalabelingjobs$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Datasets$Datasetversions$List, + params: Params$Resource$Datalabelingjobs$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Datasets$Datasetversions$List, - callback: BodyResponseCallback + params: Params$Resource$Datalabelingjobs$Operations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Datasets$Datasetversions$List - | BodyResponseCallback + | Params$Resource$Datalabelingjobs$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Datasets$Datasetversions$List; + {}) as Params$Resource$Datalabelingjobs$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Datasets$Datasetversions$List; + params = {} as Params$Resource$Datalabelingjobs$Operations$List; options = {}; } @@ -23290,7 +23538,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/datasetVersions').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -23300,24 +23548,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a DatasetVersion. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -23346,43 +23594,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.datasets.datasetVersions.patch({ - * // Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` - * name: 'datasets/my-dataset/datasetVersions/my-datasetVersion', - * // Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "bigQueryDatasetName": "my_bigQueryDatasetName", - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "metadata": {}, - * // "modelReference": "my_modelReference", - * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime" - * // } - * }, + * const res = await aiplatform.dataLabelingJobs.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'dataLabelingJobs/my-dataLabelingJob/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "bigQueryDatasetName": "my_bigQueryDatasetName", - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "etag": "my_etag", + * // "done": false, + * // "error": {}, * // "metadata": {}, - * // "modelReference": "my_modelReference", * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -23398,61 +23624,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Datasets$Datasetversions$Patch, + wait( + params: Params$Resource$Datalabelingjobs$Operations$Wait, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Datasets$Datasetversions$Patch, + wait( + params?: Params$Resource$Datalabelingjobs$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - patch( - params: Params$Resource$Datasets$Datasetversions$Patch, + ): Promise>; + wait( + params: Params$Resource$Datalabelingjobs$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Datasets$Datasetversions$Patch, + wait( + params: Params$Resource$Datalabelingjobs$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Datasets$Datasetversions$Patch, - callback: BodyResponseCallback + wait( + params: Params$Resource$Datalabelingjobs$Operations$Wait, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - patch( + wait( paramsOrCallback?: - | Params$Resource$Datasets$Datasetversions$Patch - | BodyResponseCallback + | Params$Resource$Datalabelingjobs$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Datasets$Datasetversions$Patch; + {}) as Params$Resource$Datalabelingjobs$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Datasets$Datasetversions$Patch; + params = {} as Params$Resource$Datalabelingjobs$Operations$Wait; options = {}; } @@ -23465,8 +23687,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -23477,19 +23699,94 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Datalabelingjobs$Operations$Cancel + extends StandardParameters { /** - * Restores a dataset version. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Datalabelingjobs$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Datalabelingjobs$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Datalabelingjobs$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Datalabelingjobs$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Datasets { + context: APIRequestContext; + annotationSpecs: Resource$Datasets$Annotationspecs; + dataItems: Resource$Datasets$Dataitems; + datasetVersions: Resource$Datasets$Datasetversions; + operations: Resource$Datasets$Operations; + savedQueries: Resource$Datasets$Savedqueries; + constructor(context: APIRequestContext) { + this.context = context; + this.annotationSpecs = new Resource$Datasets$Annotationspecs( + this.context + ); + this.dataItems = new Resource$Datasets$Dataitems(this.context); + this.datasetVersions = new Resource$Datasets$Datasetversions( + this.context + ); + this.operations = new Resource$Datasets$Operations(this.context); + this.savedQueries = new Resource$Datasets$Savedqueries(this.context); + } + + /** + * Creates a Dataset. * @example * ```js * // Before running the sample: @@ -23518,9 +23815,32 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.datasets.datasetVersions.restore({ - * // Required. The name of the DatasetVersion resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` - * name: 'datasets/my-dataset/datasetVersions/my-datasetVersion', + * const res = await aiplatform.datasets.create({ + * // Required. The resource name of the Location to create the Dataset in. Format: `projects/{project\}/locations/{location\}` + * parent: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "dataItemCount": "my_dataItemCount", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "metadata": {}, + * // "metadataArtifact": "my_metadataArtifact", + * // "metadataSchemaUri": "my_metadataSchemaUri", + * // "modelReference": "my_modelReference", + * // "name": "my_name", + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "savedQueries": [], + * // "updateTime": "my_updateTime" + * // } + * }, * }); * console.log(res.data); * @@ -23546,36 +23866,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - restore( - params: Params$Resource$Datasets$Datasetversions$Restore, + create( + params: Params$Resource$Datasets$Create, options: StreamMethodOptions ): Promise>; - restore( - params?: Params$Resource$Datasets$Datasetversions$Restore, + create( + params?: Params$Resource$Datasets$Create, options?: MethodOptions ): Promise>; - restore( - params: Params$Resource$Datasets$Datasetversions$Restore, + create( + params: Params$Resource$Datasets$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - restore( - params: Params$Resource$Datasets$Datasetversions$Restore, + create( + params: Params$Resource$Datasets$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - restore( - params: Params$Resource$Datasets$Datasetversions$Restore, + create( + params: Params$Resource$Datasets$Create, callback: BodyResponseCallback ): void; - restore( + create( callback: BodyResponseCallback ): void; - restore( + create( paramsOrCallback?: - | Params$Resource$Datasets$Datasetversions$Restore + | Params$Resource$Datasets$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -23590,13 +23910,12 @@ export namespace aiplatform_v1 { | void | Promise> | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Datasets$Datasetversions$Restore; + let params = (paramsOrCallback || {}) as Params$Resource$Datasets$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Datasets$Datasetversions$Restore; + params = {} as Params$Resource$Datasets$Create; options = {}; } @@ -23609,18 +23928,15 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:restore').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/datasets').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: [], + pathParams: [], context: this.context, }; if (callback) { @@ -23632,99 +23948,9 @@ export namespace aiplatform_v1 { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Datasets$Datasetversions$Create - extends StandardParameters { - /** - * Required. The name of the Dataset resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1DatasetVersion; - } - export interface Params$Resource$Datasets$Datasetversions$Delete - extends StandardParameters { - /** - * Required. The resource name of the Dataset version to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` - */ - name?: string; - } - export interface Params$Resource$Datasets$Datasetversions$Get - extends StandardParameters { - /** - * Required. The resource name of the Dataset version to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` - */ - name?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; - } - export interface Params$Resource$Datasets$Datasetversions$List - extends StandardParameters { - /** - * Optional. The standard list filter. - */ - filter?: string; - /** - * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. - */ - orderBy?: string; - /** - * Optional. The standard list page size. - */ - pageSize?: number; - /** - * Optional. The standard list page token. - */ - pageToken?: string; - /** - * Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - */ - parent?: string; - /** - * Optional. Mask specifying which fields to read. - */ - readMask?: string; - } - export interface Params$Resource$Datasets$Datasetversions$Patch - extends StandardParameters { - /** - * Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` - */ - name?: string; - /** - * Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1DatasetVersion; - } - export interface Params$Resource$Datasets$Datasetversions$Restore - extends StandardParameters { - /** - * Required. The name of the DatasetVersion resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` - */ - name?: string; - } - - export class Resource$Endpoints { - context: APIRequestContext; - chat: Resource$Endpoints$Chat; - constructor(context: APIRequestContext) { - this.context = context; - this.chat = new Resource$Endpoints$Chat(this.context); - } /** - * Return a list of tokens based on the input text. + * Deletes a Dataset. * @example * ```js * // Before running the sample: @@ -23753,25 +23979,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.endpoints.computeTokens({ - * // Required. The name of the Endpoint requested to get lists of tokens and token ids. - * endpoint: 'endpoints/my-endpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "contents": [], - * // "instances": [], - * // "model": "my_model" - * // } - * }, + * const res = await aiplatform.datasets.delete({ + * // Required. The resource name of the Dataset to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + * name: 'datasets/my-dataset', * }); * console.log(res.data); * * // Example response * // { - * // "tokensInfo": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -23787,61 +24007,56 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - computeTokens( - params: Params$Resource$Endpoints$Computetokens, + delete( + params: Params$Resource$Datasets$Delete, options: StreamMethodOptions ): Promise>; - computeTokens( - params?: Params$Resource$Endpoints$Computetokens, + delete( + params?: Params$Resource$Datasets$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - computeTokens( - params: Params$Resource$Endpoints$Computetokens, + ): Promise>; + delete( + params: Params$Resource$Datasets$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - computeTokens( - params: Params$Resource$Endpoints$Computetokens, + delete( + params: Params$Resource$Datasets$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - computeTokens( - params: Params$Resource$Endpoints$Computetokens, - callback: BodyResponseCallback + delete( + params: Params$Resource$Datasets$Delete, + callback: BodyResponseCallback ): void; - computeTokens( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - computeTokens( + delete( paramsOrCallback?: - | Params$Resource$Endpoints$Computetokens - | BodyResponseCallback + | Params$Resource$Datasets$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Endpoints$Computetokens; + let params = (paramsOrCallback || {}) as Params$Resource$Datasets$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Endpoints$Computetokens; + params = {} as Params$Resource$Datasets$Delete; options = {}; } @@ -23854,34 +24069,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:computeTokens').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Perform a token counting. + * Gets a Dataset. * @example * ```js * // Before running the sample: @@ -23910,100 +24120,97 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.endpoints.countTokens({ - * // Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: 'endpoints/my-endpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "contents": [], - * // "generationConfig": {}, - * // "instances": [], - * // "model": "my_model", - * // "systemInstruction": {}, - * // "tools": [] - * // } - * }, + * const res = await aiplatform.datasets.get({ + * // Required. The name of the Dataset resource. + * name: 'datasets/my-dataset', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "promptTokensDetails": [], - * // "totalBillableCharacters": 0, - * // "totalTokens": 0 - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - countTokens( - params: Params$Resource$Endpoints$Counttokens, + * // "createTime": "my_createTime", + * // "dataItemCount": "my_dataItemCount", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "metadata": {}, + * // "metadataArtifact": "my_metadataArtifact", + * // "metadataSchemaUri": "my_metadataSchemaUri", + * // "modelReference": "my_modelReference", + * // "name": "my_name", + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "savedQueries": [], + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Datasets$Get, options: StreamMethodOptions ): Promise>; - countTokens( - params?: Params$Resource$Endpoints$Counttokens, + get( + params?: Params$Resource$Datasets$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - countTokens( - params: Params$Resource$Endpoints$Counttokens, + ): Promise>; + get( + params: Params$Resource$Datasets$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - countTokens( - params: Params$Resource$Endpoints$Counttokens, + get( + params: Params$Resource$Datasets$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - countTokens( - params: Params$Resource$Endpoints$Counttokens, - callback: BodyResponseCallback + get( + params: Params$Resource$Datasets$Get, + callback: BodyResponseCallback ): void; - countTokens( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - countTokens( + get( paramsOrCallback?: - | Params$Resource$Endpoints$Counttokens - | BodyResponseCallback + | Params$Resource$Datasets$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Endpoints$Counttokens; + let params = (paramsOrCallback || {}) as Params$Resource$Datasets$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Endpoints$Counttokens; + params = {} as Params$Resource$Datasets$Get; options = {}; } @@ -24016,34 +24223,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:countTokens').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Fetch an asynchronous online prediction operation. + * Lists Datasets in a Location. * @example * ```js * // Before running the sample: @@ -24064,10 +24268,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -24075,27 +24276,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.endpoints.fetchPredictOperation({ - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` - * endpoint: 'endpoints/my-endpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "operationName": "my_operationName" - * // } - * }, + * const res = await aiplatform.datasets.list({ + * // An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `display_name`: supports = and != * `metadata_schema_uri`: supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. Some examples: * `displayName="myDisplayName"` * `labels.myKey="myValue"` + * filter: 'placeholder-value', + * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` + * orderBy: 'placeholder-value', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // Required. The name of the Dataset's parent resource. Format: `projects/{project\}/locations/{location\}` + * parent: 'placeholder-value', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "datasets": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -24111,57 +24311,60 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - fetchPredictOperation( - params: Params$Resource$Endpoints$Fetchpredictoperation, + list( + params: Params$Resource$Datasets$List, options: StreamMethodOptions ): Promise>; - fetchPredictOperation( - params?: Params$Resource$Endpoints$Fetchpredictoperation, + list( + params?: Params$Resource$Datasets$List, options?: MethodOptions - ): Promise>; - fetchPredictOperation( - params: Params$Resource$Endpoints$Fetchpredictoperation, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Datasets$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - fetchPredictOperation( - params: Params$Resource$Endpoints$Fetchpredictoperation, + list( + params: Params$Resource$Datasets$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - fetchPredictOperation( - params: Params$Resource$Endpoints$Fetchpredictoperation, - callback: BodyResponseCallback + list( + params: Params$Resource$Datasets$List, + callback: BodyResponseCallback ): void; - fetchPredictOperation( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - fetchPredictOperation( + list( paramsOrCallback?: - | Params$Resource$Endpoints$Fetchpredictoperation - | BodyResponseCallback + | Params$Resource$Datasets$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Endpoints$Fetchpredictoperation; + let params = (paramsOrCallback || {}) as Params$Resource$Datasets$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Endpoints$Fetchpredictoperation; + params = {} as Params$Resource$Datasets$List; options = {}; } @@ -24174,32 +24377,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:fetchPredictOperation').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/datasets').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: [], + pathParams: [], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Generate content with multimodal inputs. + * Updates a Dataset. * @example * ```js * // Before running the sample: @@ -24220,10 +24422,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -24231,23 +24430,32 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.endpoints.generateContent({ - * // Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * model: 'endpoints/my-endpoint', + * const res = await aiplatform.datasets.patch({ + * // Output only. Identifier. The resource name of the Dataset. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + * name: 'datasets/my-dataset', + * // Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` * `description` * `labels` + * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "cachedContent": "my_cachedContent", - * // "contents": [], - * // "generationConfig": {}, + * // "createTime": "my_createTime", + * // "dataItemCount": "my_dataItemCount", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", * // "labels": {}, - * // "modelArmorConfig": {}, - * // "safetySettings": [], - * // "systemInstruction": {}, - * // "toolConfig": {}, - * // "tools": [] + * // "metadata": {}, + * // "metadataArtifact": "my_metadataArtifact", + * // "metadataSchemaUri": "my_metadataSchemaUri", + * // "modelReference": "my_modelReference", + * // "name": "my_name", + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "savedQueries": [], + * // "updateTime": "my_updateTime" * // } * }, * }); @@ -24255,12 +24463,22 @@ export namespace aiplatform_v1 { * * // Example response * // { - * // "candidates": [], * // "createTime": "my_createTime", - * // "modelVersion": "my_modelVersion", - * // "promptFeedback": {}, - * // "responseId": "my_responseId", - * // "usageMetadata": {} + * // "dataItemCount": "my_dataItemCount", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "metadata": {}, + * // "metadataArtifact": "my_metadataArtifact", + * // "metadataSchemaUri": "my_metadataSchemaUri", + * // "modelReference": "my_modelReference", + * // "name": "my_name", + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "savedQueries": [], + * // "updateTime": "my_updateTime" * // } * } * @@ -24276,61 +24494,56 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - generateContent( - params: Params$Resource$Endpoints$Generatecontent, + patch( + params: Params$Resource$Datasets$Patch, options: StreamMethodOptions ): Promise>; - generateContent( - params?: Params$Resource$Endpoints$Generatecontent, + patch( + params?: Params$Resource$Datasets$Patch, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - generateContent( - params: Params$Resource$Endpoints$Generatecontent, + ): Promise>; + patch( + params: Params$Resource$Datasets$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - generateContent( - params: Params$Resource$Endpoints$Generatecontent, + patch( + params: Params$Resource$Datasets$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - generateContent( - params: Params$Resource$Endpoints$Generatecontent, - callback: BodyResponseCallback + patch( + params: Params$Resource$Datasets$Patch, + callback: BodyResponseCallback ): void; - generateContent( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - generateContent( + patch( paramsOrCallback?: - | Params$Resource$Endpoints$Generatecontent - | BodyResponseCallback + | Params$Resource$Datasets$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Endpoints$Generatecontent; + let params = (paramsOrCallback || {}) as Params$Resource$Datasets$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Endpoints$Generatecontent; + params = {} as Params$Resource$Datasets$Patch; options = {}; } @@ -24343,34 +24556,118 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+model}:generateContent').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['model'], - pathParams: ['model'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Datasets$Create extends StandardParameters { /** - * Perform an online prediction. + * Required. The resource name of the Location to create the Dataset in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Dataset; + } + export interface Params$Resource$Datasets$Delete extends StandardParameters { + /** + * Required. The resource name of the Dataset to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + */ + name?: string; + } + export interface Params$Resource$Datasets$Get extends StandardParameters { + /** + * Required. The name of the Dataset resource. + */ + name?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Datasets$List extends StandardParameters { + /** + * An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `display_name`: supports = and != * `metadata_schema_uri`: supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. Some examples: * `displayName="myDisplayName"` * `labels.myKey="myValue"` + */ + filter?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` + */ + orderBy?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * Required. The name of the Dataset's parent resource. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Datasets$Patch extends StandardParameters { + /** + * Output only. Identifier. The resource name of the Dataset. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + */ + name?: string; + /** + * Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` * `description` * `labels` + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Dataset; + } + + export class Resource$Datasets$Annotationspecs { + context: APIRequestContext; + operations: Resource$Datasets$Annotationspecs$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Datasets$Annotationspecs$Operations( + this.context + ); + } + } + + export class Resource$Datasets$Annotationspecs$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -24391,10 +24688,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -24402,30 +24696,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.endpoints.predict({ - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: 'endpoints/my-endpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "instances": [], - * // "parameters": {} - * // } - * }, + * const res = await aiplatform.datasets.annotationSpecs.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'datasets/my-dataset/annotationSpecs/my-annotationSpec/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "deployedModelId": "my_deployedModelId", - * // "metadata": {}, - * // "model": "my_model", - * // "modelDisplayName": "my_modelDisplayName", - * // "modelVersionId": "my_modelVersionId", - * // "predictions": [] - * // } + * // {} * } * * main().catch(e => { @@ -24440,61 +24718,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - predict( - params: Params$Resource$Endpoints$Predict, + cancel( + params: Params$Resource$Datasets$Annotationspecs$Operations$Cancel, options: StreamMethodOptions ): Promise>; - predict( - params?: Params$Resource$Endpoints$Predict, + cancel( + params?: Params$Resource$Datasets$Annotationspecs$Operations$Cancel, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - predict( - params: Params$Resource$Endpoints$Predict, + ): Promise>; + cancel( + params: Params$Resource$Datasets$Annotationspecs$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - predict( - params: Params$Resource$Endpoints$Predict, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - predict( - params: Params$Resource$Endpoints$Predict, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Datasets$Annotationspecs$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - predict( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Datasets$Annotationspecs$Operations$Cancel, + callback: BodyResponseCallback ): void; - predict( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Endpoints$Predict - | BodyResponseCallback + | Params$Resource$Datasets$Annotationspecs$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Endpoints$Predict; + {}) as Params$Resource$Datasets$Annotationspecs$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Endpoints$Predict; + params = + {} as Params$Resource$Datasets$Annotationspecs$Operations$Cancel; options = {}; } @@ -24507,33 +24778,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:predict').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -24554,10 +24821,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -24565,29 +24829,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.endpoints.predictLongRunning({ - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` - * endpoint: 'endpoints/my-endpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "instances": [], - * // "parameters": {} - * // } - * }, + * const res = await aiplatform.datasets.annotationSpecs.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'datasets/my-dataset/annotationSpecs/my-annotationSpec/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -24602,57 +24851,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - predictLongRunning( - params: Params$Resource$Endpoints$Predictlongrunning, + delete( + params: Params$Resource$Datasets$Annotationspecs$Operations$Delete, options: StreamMethodOptions ): Promise>; - predictLongRunning( - params?: Params$Resource$Endpoints$Predictlongrunning, + delete( + params?: Params$Resource$Datasets$Annotationspecs$Operations$Delete, options?: MethodOptions - ): Promise>; - predictLongRunning( - params: Params$Resource$Endpoints$Predictlongrunning, + ): Promise>; + delete( + params: Params$Resource$Datasets$Annotationspecs$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - predictLongRunning( - params: Params$Resource$Endpoints$Predictlongrunning, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - predictLongRunning( - params: Params$Resource$Endpoints$Predictlongrunning, - callback: BodyResponseCallback + delete( + params: Params$Resource$Datasets$Annotationspecs$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - predictLongRunning( - callback: BodyResponseCallback + delete( + params: Params$Resource$Datasets$Annotationspecs$Operations$Delete, + callback: BodyResponseCallback ): void; - predictLongRunning( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Endpoints$Predictlongrunning - | BodyResponseCallback + | Params$Resource$Datasets$Annotationspecs$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Endpoints$Predictlongrunning; + {}) as Params$Resource$Datasets$Annotationspecs$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Endpoints$Predictlongrunning; + params = + {} as Params$Resource$Datasets$Annotationspecs$Operations$Delete; options = {}; } @@ -24665,32 +24911,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:predictLongRunning').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Generate content with multimodal inputs with streaming support. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -24711,10 +24954,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -24722,36 +24962,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.endpoints.streamGenerateContent({ - * // Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * model: 'endpoints/my-endpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "cachedContent": "my_cachedContent", - * // "contents": [], - * // "generationConfig": {}, - * // "labels": {}, - * // "modelArmorConfig": {}, - * // "safetySettings": [], - * // "systemInstruction": {}, - * // "toolConfig": {}, - * // "tools": [] - * // } - * }, + * const res = await aiplatform.datasets.annotationSpecs.operations.get({ + * // The name of the operation resource. + * name: 'datasets/my-dataset/annotationSpecs/my-annotationSpec/operations/my-operation', * }); * console.log(res.data); * * // Example response * // { - * // "candidates": [], - * // "createTime": "my_createTime", - * // "modelVersion": "my_modelVersion", - * // "promptFeedback": {}, - * // "responseId": "my_responseId", - * // "usageMetadata": {} + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -24767,61 +24990,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - streamGenerateContent( - params: Params$Resource$Endpoints$Streamgeneratecontent, + get( + params: Params$Resource$Datasets$Annotationspecs$Operations$Get, options: StreamMethodOptions ): Promise>; - streamGenerateContent( - params?: Params$Resource$Endpoints$Streamgeneratecontent, + get( + params?: Params$Resource$Datasets$Annotationspecs$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - streamGenerateContent( - params: Params$Resource$Endpoints$Streamgeneratecontent, + ): Promise>; + get( + params: Params$Resource$Datasets$Annotationspecs$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - streamGenerateContent( - params: Params$Resource$Endpoints$Streamgeneratecontent, + get( + params: Params$Resource$Datasets$Annotationspecs$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - streamGenerateContent( - params: Params$Resource$Endpoints$Streamgeneratecontent, - callback: BodyResponseCallback + get( + params: Params$Resource$Datasets$Annotationspecs$Operations$Get, + callback: BodyResponseCallback ): void; - streamGenerateContent( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - streamGenerateContent( + get( paramsOrCallback?: - | Params$Resource$Endpoints$Streamgeneratecontent - | BodyResponseCallback + | Params$Resource$Datasets$Annotationspecs$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Endpoints$Streamgeneratecontent; + {}) as Params$Resource$Datasets$Annotationspecs$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Endpoints$Streamgeneratecontent; + params = {} as Params$Resource$Datasets$Annotationspecs$Operations$Get; options = {}; } @@ -24834,126 +25053,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+model}:streamGenerateContent').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['model'], - pathParams: ['model'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Endpoints$Computetokens - extends StandardParameters { - /** - * Required. The name of the Endpoint requested to get lists of tokens and token ids. - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ComputeTokensRequest; - } - export interface Params$Resource$Endpoints$Counttokens - extends StandardParameters { - /** - * Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1CountTokensRequest; - } - export interface Params$Resource$Endpoints$Fetchpredictoperation - extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1FetchPredictOperationRequest; - } - export interface Params$Resource$Endpoints$Generatecontent - extends StandardParameters { - /** - * Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - model?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1GenerateContentRequest; - } - export interface Params$Resource$Endpoints$Predict - extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1PredictRequest; - } - export interface Params$Resource$Endpoints$Predictlongrunning - extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1PredictLongRunningRequest; - } - export interface Params$Resource$Endpoints$Streamgeneratecontent - extends StandardParameters { - /** - * Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - model?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1GenerateContentRequest; - } - - export class Resource$Endpoints$Chat { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Exposes an OpenAI-compatible endpoint for chat completions. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -24974,10 +25096,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -24985,27 +25104,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.endpoints.chat.completions({ - * // Required. The name of the endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: 'endpoints/my-endpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] - * // } - * }, + * const res = await aiplatform.datasets.annotationSpecs.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'datasets/my-dataset/annotationSpecs/my-annotationSpec', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -25021,53 +25138,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - completions( - params: Params$Resource$Endpoints$Chat$Completions, + list( + params: Params$Resource$Datasets$Annotationspecs$Operations$List, options: StreamMethodOptions ): Promise>; - completions( - params?: Params$Resource$Endpoints$Chat$Completions, + list( + params?: Params$Resource$Datasets$Annotationspecs$Operations$List, options?: MethodOptions - ): Promise>; - completions( - params: Params$Resource$Endpoints$Chat$Completions, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Datasets$Annotationspecs$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - completions( - params: Params$Resource$Endpoints$Chat$Completions, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Datasets$Annotationspecs$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - completions( - params: Params$Resource$Endpoints$Chat$Completions, - callback: BodyResponseCallback + list( + params: Params$Resource$Datasets$Annotationspecs$Operations$List, + callback: BodyResponseCallback ): void; - completions(callback: BodyResponseCallback): void; - completions( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Endpoints$Chat$Completions - | BodyResponseCallback + | Params$Resource$Datasets$Annotationspecs$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Endpoints$Chat$Completions; + {}) as Params$Resource$Datasets$Annotationspecs$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Endpoints$Chat$Completions; + params = {} as Params$Resource$Datasets$Annotationspecs$Operations$List; options = {}; } @@ -25080,52 +25205,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}/chat/completions').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Endpoints$Chat$Completions - extends StandardParameters { - /** - * Required. The name of the endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleApiHttpBody; - } - - export class Resource$Media { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Upload a file into a RagCorpus. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -25154,29 +25261,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.media.upload({ - * // Required. The name of the RagCorpus resource into which to upload the file. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` - * parent: 'projects/my-project/locations/my-location/ragCorpora/[^/]+', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "ragFile": {}, - * // "uploadRagFileConfig": {} - * // } - * }, - * media: { - * mimeType: 'placeholder-value', - * body: 'placeholder-value', - * }, + * const res = await aiplatform.datasets.annotationSpecs.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'datasets/my-dataset/annotationSpecs/my-annotationSpec/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { + * // "done": false, * // "error": {}, - * // "ragFile": {} + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -25192,60 +25291,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - upload( - params: Params$Resource$Media$Upload, + wait( + params: Params$Resource$Datasets$Annotationspecs$Operations$Wait, options: StreamMethodOptions ): Promise>; - upload( - params?: Params$Resource$Media$Upload, + wait( + params?: Params$Resource$Datasets$Annotationspecs$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - upload( - params: Params$Resource$Media$Upload, + ): Promise>; + wait( + params: Params$Resource$Datasets$Annotationspecs$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - upload( - params: Params$Resource$Media$Upload, + wait( + params: Params$Resource$Datasets$Annotationspecs$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - upload( - params: Params$Resource$Media$Upload, - callback: BodyResponseCallback + wait( + params: Params$Resource$Datasets$Annotationspecs$Operations$Wait, + callback: BodyResponseCallback ): void; - upload( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - upload( + wait( paramsOrCallback?: - | Params$Resource$Media$Upload - | BodyResponseCallback + | Params$Resource$Datasets$Annotationspecs$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Media$Upload; + let params = (paramsOrCallback || + {}) as Params$Resource$Datasets$Annotationspecs$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Media$Upload; + params = {} as Params$Resource$Datasets$Annotationspecs$Operations$Wait; options = {}; } @@ -25258,74 +25354,118 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/ragFiles:upload').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - mediaUrl: (rootUrl + '/upload/v1/{+parent}/ragFiles:upload').replace( - /([^:]\/)\/+/g, - '$1' - ), - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Media$Upload extends StandardParameters { + export interface Params$Resource$Datasets$Annotationspecs$Operations$Cancel + extends StandardParameters { /** - * Required. The name of the RagCorpus resource into which to upload the file. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` + * The name of the operation resource to be cancelled. */ - parent?: string; - + name?: string; + } + export interface Params$Resource$Datasets$Annotationspecs$Operations$Delete + extends StandardParameters { /** - * Request body metadata + * The name of the operation resource to be deleted. */ - requestBody?: Schema$GoogleCloudAiplatformV1UploadRagFileRequest; - + name?: string; + } + export interface Params$Resource$Datasets$Annotationspecs$Operations$Get + extends StandardParameters { /** - * Media metadata + * The name of the operation resource. */ - media?: { - /** - * Media mime-type - */ - mimeType?: string; - - /** - * Media body contents - */ - body?: any; - }; + name?: string; } - - export class Resource$Projects { - context: APIRequestContext; - locations: Resource$Projects$Locations; - constructor(context: APIRequestContext) { - this.context = context; - this.locations = new Resource$Projects$Locations(this.context); + export interface Params$Resource$Datasets$Annotationspecs$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Datasets$Annotationspecs$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Datasets$Dataitems { + context: APIRequestContext; + annotations: Resource$Datasets$Dataitems$Annotations; + operations: Resource$Datasets$Dataitems$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.annotations = new Resource$Datasets$Dataitems$Annotations( + this.context + ); + this.operations = new Resource$Datasets$Dataitems$Operations( + this.context + ); + } + } + + export class Resource$Datasets$Dataitems$Annotations { + context: APIRequestContext; + operations: Resource$Datasets$Dataitems$Annotations$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Datasets$Dataitems$Annotations$Operations( + this.context + ); + } + } + + export class Resource$Datasets$Dataitems$Annotations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Gets a GenAI cache config. + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -25354,17 +25494,16 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.getCacheConfig({ - * // Required. Name of the cache config. Format: - `projects/{project\}/cacheConfig`. - * name: 'projects/my-project/cacheConfig', - * }); + * const res = await aiplatform.datasets.dataItems.annotations.operations.cancel( + * { + * // The name of the operation resource to be cancelled. + * name: 'datasets/my-dataset/dataItems/my-dataItem/annotations/my-annotation/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response - * // { - * // "disableCache": false, - * // "name": "my_name" - * // } + * // {} * } * * main().catch(e => { @@ -25379,61 +25518,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getCacheConfig( - params: Params$Resource$Projects$Getcacheconfig, + cancel( + params: Params$Resource$Datasets$Dataitems$Annotations$Operations$Cancel, options: StreamMethodOptions ): Promise>; - getCacheConfig( - params?: Params$Resource$Projects$Getcacheconfig, + cancel( + params?: Params$Resource$Datasets$Dataitems$Annotations$Operations$Cancel, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - getCacheConfig( - params: Params$Resource$Projects$Getcacheconfig, + ): Promise>; + cancel( + params: Params$Resource$Datasets$Dataitems$Annotations$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getCacheConfig( - params: Params$Resource$Projects$Getcacheconfig, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getCacheConfig( - params: Params$Resource$Projects$Getcacheconfig, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Datasets$Dataitems$Annotations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getCacheConfig( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Datasets$Dataitems$Annotations$Operations$Cancel, + callback: BodyResponseCallback ): void; - getCacheConfig( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Getcacheconfig - | BodyResponseCallback + | Params$Resource$Datasets$Dataitems$Annotations$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Getcacheconfig; + {}) as Params$Resource$Datasets$Dataitems$Annotations$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Getcacheconfig; + params = + {} as Params$Resource$Datasets$Dataitems$Annotations$Operations$Cancel; options = {}; } @@ -25446,8 +25578,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -25458,19 +25590,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a cache config. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -25499,29 +25629,16 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.updateCacheConfig({ - * // Identifier. Name of the cache config. Format: - `projects/{project\}/cacheConfig`. - * name: 'projects/my-project/cacheConfig', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "disableCache": false, - * // "name": "my_name" - * // } + * const res = await aiplatform.datasets.dataItems.annotations.operations.delete( + * { + * // The name of the operation resource to be deleted. + * name: 'datasets/my-dataset/dataItems/my-dataItem/annotations/my-annotation/operations/my-operation', * }, - * }); + * ); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -25536,57 +25653,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - updateCacheConfig( - params: Params$Resource$Projects$Updatecacheconfig, + delete( + params: Params$Resource$Datasets$Dataitems$Annotations$Operations$Delete, options: StreamMethodOptions ): Promise>; - updateCacheConfig( - params?: Params$Resource$Projects$Updatecacheconfig, + delete( + params?: Params$Resource$Datasets$Dataitems$Annotations$Operations$Delete, options?: MethodOptions - ): Promise>; - updateCacheConfig( - params: Params$Resource$Projects$Updatecacheconfig, + ): Promise>; + delete( + params: Params$Resource$Datasets$Dataitems$Annotations$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateCacheConfig( - params: Params$Resource$Projects$Updatecacheconfig, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - updateCacheConfig( - params: Params$Resource$Projects$Updatecacheconfig, - callback: BodyResponseCallback + delete( + params: Params$Resource$Datasets$Dataitems$Annotations$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - updateCacheConfig( - callback: BodyResponseCallback + delete( + params: Params$Resource$Datasets$Dataitems$Annotations$Operations$Delete, + callback: BodyResponseCallback ): void; - updateCacheConfig( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Updatecacheconfig - | BodyResponseCallback + | Params$Resource$Datasets$Dataitems$Annotations$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Updatecacheconfig; + {}) as Params$Resource$Datasets$Dataitems$Annotations$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Updatecacheconfig; + params = + {} as Params$Resource$Datasets$Dataitems$Annotations$Operations$Delete; options = {}; } @@ -25600,7 +25714,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options @@ -25611,170 +25725,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Getcacheconfig - extends StandardParameters { - /** - * Required. Name of the cache config. Format: - `projects/{project\}/cacheConfig`. - */ - name?: string; - } - export interface Params$Resource$Projects$Updatecacheconfig - extends StandardParameters { - /** - * Identifier. Name of the cache config. Format: - `projects/{project\}/cacheConfig`. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1CacheConfig; - } - - export class Resource$Projects$Locations { - context: APIRequestContext; - batchPredictionJobs: Resource$Projects$Locations$Batchpredictionjobs; - cachedContents: Resource$Projects$Locations$Cachedcontents; - customJobs: Resource$Projects$Locations$Customjobs; - dataLabelingJobs: Resource$Projects$Locations$Datalabelingjobs; - datasets: Resource$Projects$Locations$Datasets; - deploymentResourcePools: Resource$Projects$Locations$Deploymentresourcepools; - endpoints: Resource$Projects$Locations$Endpoints; - evaluationItems: Resource$Projects$Locations$Evaluationitems; - evaluationRuns: Resource$Projects$Locations$Evaluationruns; - evaluationSets: Resource$Projects$Locations$Evaluationsets; - featureGroups: Resource$Projects$Locations$Featuregroups; - featureOnlineStores: Resource$Projects$Locations$Featureonlinestores; - featurestores: Resource$Projects$Locations$Featurestores; - hyperparameterTuningJobs: Resource$Projects$Locations$Hyperparametertuningjobs; - indexEndpoints: Resource$Projects$Locations$Indexendpoints; - indexes: Resource$Projects$Locations$Indexes; - metadataStores: Resource$Projects$Locations$Metadatastores; - migratableResources: Resource$Projects$Locations$Migratableresources; - modelDeploymentMonitoringJobs: Resource$Projects$Locations$Modeldeploymentmonitoringjobs; - models: Resource$Projects$Locations$Models; - nasJobs: Resource$Projects$Locations$Nasjobs; - notebookExecutionJobs: Resource$Projects$Locations$Notebookexecutionjobs; - notebookRuntimes: Resource$Projects$Locations$Notebookruntimes; - notebookRuntimeTemplates: Resource$Projects$Locations$Notebookruntimetemplates; - operations: Resource$Projects$Locations$Operations; - persistentResources: Resource$Projects$Locations$Persistentresources; - pipelineJobs: Resource$Projects$Locations$Pipelinejobs; - publishers: Resource$Projects$Locations$Publishers; - ragCorpora: Resource$Projects$Locations$Ragcorpora; - ragEngineConfig: Resource$Projects$Locations$Ragengineconfig; - reasoningEngines: Resource$Projects$Locations$Reasoningengines; - schedules: Resource$Projects$Locations$Schedules; - specialistPools: Resource$Projects$Locations$Specialistpools; - studies: Resource$Projects$Locations$Studies; - tensorboards: Resource$Projects$Locations$Tensorboards; - trainingPipelines: Resource$Projects$Locations$Trainingpipelines; - tuningJobs: Resource$Projects$Locations$Tuningjobs; - constructor(context: APIRequestContext) { - this.context = context; - this.batchPredictionJobs = - new Resource$Projects$Locations$Batchpredictionjobs(this.context); - this.cachedContents = new Resource$Projects$Locations$Cachedcontents( - this.context - ); - this.customJobs = new Resource$Projects$Locations$Customjobs( - this.context - ); - this.dataLabelingJobs = new Resource$Projects$Locations$Datalabelingjobs( - this.context - ); - this.datasets = new Resource$Projects$Locations$Datasets(this.context); - this.deploymentResourcePools = - new Resource$Projects$Locations$Deploymentresourcepools(this.context); - this.endpoints = new Resource$Projects$Locations$Endpoints(this.context); - this.evaluationItems = new Resource$Projects$Locations$Evaluationitems( - this.context - ); - this.evaluationRuns = new Resource$Projects$Locations$Evaluationruns( - this.context - ); - this.evaluationSets = new Resource$Projects$Locations$Evaluationsets( - this.context - ); - this.featureGroups = new Resource$Projects$Locations$Featuregroups( - this.context - ); - this.featureOnlineStores = - new Resource$Projects$Locations$Featureonlinestores(this.context); - this.featurestores = new Resource$Projects$Locations$Featurestores( - this.context - ); - this.hyperparameterTuningJobs = - new Resource$Projects$Locations$Hyperparametertuningjobs(this.context); - this.indexEndpoints = new Resource$Projects$Locations$Indexendpoints( - this.context - ); - this.indexes = new Resource$Projects$Locations$Indexes(this.context); - this.metadataStores = new Resource$Projects$Locations$Metadatastores( - this.context - ); - this.migratableResources = - new Resource$Projects$Locations$Migratableresources(this.context); - this.modelDeploymentMonitoringJobs = - new Resource$Projects$Locations$Modeldeploymentmonitoringjobs( - this.context - ); - this.models = new Resource$Projects$Locations$Models(this.context); - this.nasJobs = new Resource$Projects$Locations$Nasjobs(this.context); - this.notebookExecutionJobs = - new Resource$Projects$Locations$Notebookexecutionjobs(this.context); - this.notebookRuntimes = new Resource$Projects$Locations$Notebookruntimes( - this.context - ); - this.notebookRuntimeTemplates = - new Resource$Projects$Locations$Notebookruntimetemplates(this.context); - this.operations = new Resource$Projects$Locations$Operations( - this.context - ); - this.persistentResources = - new Resource$Projects$Locations$Persistentresources(this.context); - this.pipelineJobs = new Resource$Projects$Locations$Pipelinejobs( - this.context - ); - this.publishers = new Resource$Projects$Locations$Publishers( - this.context - ); - this.ragCorpora = new Resource$Projects$Locations$Ragcorpora( - this.context - ); - this.ragEngineConfig = new Resource$Projects$Locations$Ragengineconfig( - this.context - ); - this.reasoningEngines = new Resource$Projects$Locations$Reasoningengines( - this.context - ); - this.schedules = new Resource$Projects$Locations$Schedules(this.context); - this.specialistPools = new Resource$Projects$Locations$Specialistpools( - this.context - ); - this.studies = new Resource$Projects$Locations$Studies(this.context); - this.tensorboards = new Resource$Projects$Locations$Tensorboards( - this.context - ); - this.trainingPipelines = - new Resource$Projects$Locations$Trainingpipelines(this.context); - this.tuningJobs = new Resource$Projects$Locations$Tuningjobs( - this.context - ); - } /** - * Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -25803,26 +25764,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.augmentPrompt({ - * // Required. The resource name of the Location from which to augment prompt. The users must have permission to make a call in the project. Format: `projects/{project\}/locations/{location\}`. - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "contents": [], - * // "model": {}, - * // "vertexRagStore": {} - * // } - * }, + * const res = await aiplatform.datasets.dataItems.annotations.operations.get({ + * // The name of the operation resource. + * name: 'datasets/my-dataset/dataItems/my-dataItem/annotations/my-annotation/operations/my-operation', * }); * console.log(res.data); * * // Example response * // { - * // "augmentedPrompt": [], - * // "facts": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -25838,61 +25792,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - augmentPrompt( - params: Params$Resource$Projects$Locations$Augmentprompt, + get( + params: Params$Resource$Datasets$Dataitems$Annotations$Operations$Get, options: StreamMethodOptions ): Promise>; - augmentPrompt( - params?: Params$Resource$Projects$Locations$Augmentprompt, + get( + params?: Params$Resource$Datasets$Dataitems$Annotations$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - augmentPrompt( - params: Params$Resource$Projects$Locations$Augmentprompt, + ): Promise>; + get( + params: Params$Resource$Datasets$Dataitems$Annotations$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - augmentPrompt( - params: Params$Resource$Projects$Locations$Augmentprompt, + get( + params: Params$Resource$Datasets$Dataitems$Annotations$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - augmentPrompt( - params: Params$Resource$Projects$Locations$Augmentprompt, - callback: BodyResponseCallback + get( + params: Params$Resource$Datasets$Dataitems$Annotations$Operations$Get, + callback: BodyResponseCallback ): void; - augmentPrompt( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - augmentPrompt( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Augmentprompt - | BodyResponseCallback + | Params$Resource$Datasets$Dataitems$Annotations$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Augmentprompt; + {}) as Params$Resource$Datasets$Dataitems$Annotations$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Augmentprompt; + params = + {} as Params$Resource$Datasets$Dataitems$Annotations$Operations$Get; options = {}; } @@ -25905,34 +25856,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}:augmentPrompt').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Given an input text, it returns a score that evaluates the factuality of the text. It also extracts and returns claims from the text and provides supporting facts. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -25961,26 +25907,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.corroborateContent({ - * // Required. The resource name of the Location from which to corroborate text. The users must have permission to make a call in the project. Format: `projects/{project\}/locations/{location\}`. - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "content": {}, - * // "facts": [], - * // "parameters": {} - * // } - * }, + * const res = await aiplatform.datasets.dataItems.annotations.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'datasets/my-dataset/dataItems/my-dataItem/annotations/my-annotation', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "claims": [], - * // "corroborationScore": {} + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -25996,61 +25941,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - corroborateContent( - params: Params$Resource$Projects$Locations$Corroboratecontent, + list( + params: Params$Resource$Datasets$Dataitems$Annotations$Operations$List, options: StreamMethodOptions ): Promise>; - corroborateContent( - params?: Params$Resource$Projects$Locations$Corroboratecontent, + list( + params?: Params$Resource$Datasets$Dataitems$Annotations$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - corroborateContent( - params: Params$Resource$Projects$Locations$Corroboratecontent, + list( + params: Params$Resource$Datasets$Dataitems$Annotations$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - corroborateContent( - params: Params$Resource$Projects$Locations$Corroboratecontent, + list( + params: Params$Resource$Datasets$Dataitems$Annotations$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - corroborateContent( - params: Params$Resource$Projects$Locations$Corroboratecontent, - callback: BodyResponseCallback + list( + params: Params$Resource$Datasets$Dataitems$Annotations$Operations$List, + callback: BodyResponseCallback ): void; - corroborateContent( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - corroborateContent( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Corroboratecontent - | BodyResponseCallback + | Params$Resource$Datasets$Dataitems$Annotations$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Corroboratecontent; + {}) as Params$Resource$Datasets$Dataitems$Annotations$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Corroboratecontent; + params = + {} as Params$Resource$Datasets$Dataitems$Annotations$Operations$List; options = {}; } @@ -26063,34 +26009,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}:corroborateContent').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deploys a model to a new endpoint. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -26119,21 +26065,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.deploy({ - * // Required. The resource name of the Location to deploy the model in. Format: `projects/{project\}/locations/{location\}` - * destination: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "deployConfig": {}, - * // "endpointConfig": {}, - * // "huggingFaceModelId": "my_huggingFaceModelId", - * // "modelConfig": {}, - * // "publisherModelName": "my_publisherModelName" - * // } - * }, + * const res = await aiplatform.datasets.dataItems.annotations.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'datasets/my-dataset/dataItems/my-dataItem/annotations/my-annotation/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * @@ -26159,36 +26095,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - deploy( - params: Params$Resource$Projects$Locations$Deploy, + wait( + params: Params$Resource$Datasets$Dataitems$Annotations$Operations$Wait, options: StreamMethodOptions ): Promise>; - deploy( - params?: Params$Resource$Projects$Locations$Deploy, + wait( + params?: Params$Resource$Datasets$Dataitems$Annotations$Operations$Wait, options?: MethodOptions ): Promise>; - deploy( - params: Params$Resource$Projects$Locations$Deploy, + wait( + params: Params$Resource$Datasets$Dataitems$Annotations$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deploy( - params: Params$Resource$Projects$Locations$Deploy, + wait( + params: Params$Resource$Datasets$Dataitems$Annotations$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deploy( - params: Params$Resource$Projects$Locations$Deploy, + wait( + params: Params$Resource$Datasets$Dataitems$Annotations$Operations$Wait, callback: BodyResponseCallback ): void; - deploy( + wait( callback: BodyResponseCallback ): void; - deploy( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Deploy + | Params$Resource$Datasets$Dataitems$Annotations$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -26204,12 +26140,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Deploy; + {}) as Params$Resource$Datasets$Dataitems$Annotations$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Deploy; + params = + {} as Params$Resource$Datasets$Dataitems$Annotations$Operations$Wait; options = {}; } @@ -26222,18 +26159,15 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+destination}:deploy').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['destination'], - pathParams: ['destination'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -26245,9 +26179,72 @@ export namespace aiplatform_v1 { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Datasets$Dataitems$Annotations$Operations$Cancel + extends StandardParameters { /** - * Evaluates a dataset based on a set of given metrics. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Datasets$Dataitems$Annotations$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Datasets$Dataitems$Annotations$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Datasets$Dataitems$Annotations$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Datasets$Dataitems$Annotations$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Datasets$Dataitems$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -26276,31 +26273,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.evaluateDataset({ - * // Required. The resource name of the Location to evaluate the dataset. Format: `projects/{project\}/locations/{location\}` - * location: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "autoraterConfig": {}, - * // "dataset": {}, - * // "metrics": [], - * // "outputConfig": {} - * // } - * }, + * const res = await aiplatform.datasets.dataItems.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'datasets/my-dataset/dataItems/my-dataItem/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -26315,57 +26295,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - evaluateDataset( - params: Params$Resource$Projects$Locations$Evaluatedataset, + cancel( + params: Params$Resource$Datasets$Dataitems$Operations$Cancel, options: StreamMethodOptions ): Promise>; - evaluateDataset( - params?: Params$Resource$Projects$Locations$Evaluatedataset, + cancel( + params?: Params$Resource$Datasets$Dataitems$Operations$Cancel, options?: MethodOptions - ): Promise>; - evaluateDataset( - params: Params$Resource$Projects$Locations$Evaluatedataset, + ): Promise>; + cancel( + params: Params$Resource$Datasets$Dataitems$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - evaluateDataset( - params: Params$Resource$Projects$Locations$Evaluatedataset, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - evaluateDataset( - params: Params$Resource$Projects$Locations$Evaluatedataset, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Datasets$Dataitems$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - evaluateDataset( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Datasets$Dataitems$Operations$Cancel, + callback: BodyResponseCallback ): void; - evaluateDataset( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Evaluatedataset - | BodyResponseCallback + | Params$Resource$Datasets$Dataitems$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Evaluatedataset; + {}) as Params$Resource$Datasets$Dataitems$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Evaluatedataset; + params = {} as Params$Resource$Datasets$Dataitems$Operations$Cancel; options = {}; } @@ -26378,32 +26354,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+location}:evaluateDataset').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['location'], - pathParams: ['location'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Evaluates instances based on a given metric. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -26432,90 +26405,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.evaluateInstances({ - * // Required. The resource name of the Location to evaluate the instances. Format: `projects/{project\}/locations/{location\}` - * location: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "autoraterConfig": {}, - * // "bleuInput": {}, - * // "coherenceInput": {}, - * // "cometInput": {}, - * // "exactMatchInput": {}, - * // "fluencyInput": {}, - * // "fulfillmentInput": {}, - * // "groundednessInput": {}, - * // "instance": {}, - * // "metrics": [], - * // "metricxInput": {}, - * // "pairwiseMetricInput": {}, - * // "pairwiseQuestionAnsweringQualityInput": {}, - * // "pairwiseSummarizationQualityInput": {}, - * // "pointwiseMetricInput": {}, - * // "questionAnsweringCorrectnessInput": {}, - * // "questionAnsweringHelpfulnessInput": {}, - * // "questionAnsweringQualityInput": {}, - * // "questionAnsweringRelevanceInput": {}, - * // "rougeInput": {}, - * // "rubricBasedInstructionFollowingInput": {}, - * // "safetyInput": {}, - * // "summarizationHelpfulnessInput": {}, - * // "summarizationQualityInput": {}, - * // "summarizationVerbosityInput": {}, - * // "toolCallValidInput": {}, - * // "toolNameMatchInput": {}, - * // "toolParameterKeyMatchInput": {}, - * // "toolParameterKvMatchInput": {}, - * // "trajectoryAnyOrderMatchInput": {}, - * // "trajectoryExactMatchInput": {}, - * // "trajectoryInOrderMatchInput": {}, - * // "trajectoryPrecisionInput": {}, - * // "trajectoryRecallInput": {}, - * // "trajectorySingleToolUseInput": {} - * // } - * }, + * const res = await aiplatform.datasets.dataItems.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'datasets/my-dataset/dataItems/my-dataItem/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "bleuResults": {}, - * // "coherenceResult": {}, - * // "cometResult": {}, - * // "exactMatchResults": {}, - * // "fluencyResult": {}, - * // "fulfillmentResult": {}, - * // "groundednessResult": {}, - * // "metricResults": [], - * // "metricxResult": {}, - * // "pairwiseMetricResult": {}, - * // "pairwiseQuestionAnsweringQualityResult": {}, - * // "pairwiseSummarizationQualityResult": {}, - * // "pointwiseMetricResult": {}, - * // "questionAnsweringCorrectnessResult": {}, - * // "questionAnsweringHelpfulnessResult": {}, - * // "questionAnsweringQualityResult": {}, - * // "questionAnsweringRelevanceResult": {}, - * // "rougeResults": {}, - * // "rubricBasedInstructionFollowingResult": {}, - * // "safetyResult": {}, - * // "summarizationHelpfulnessResult": {}, - * // "summarizationQualityResult": {}, - * // "summarizationVerbosityResult": {}, - * // "toolCallValidResults": {}, - * // "toolNameMatchResults": {}, - * // "toolParameterKeyMatchResults": {}, - * // "toolParameterKvMatchResults": {}, - * // "trajectoryAnyOrderMatchResults": {}, - * // "trajectoryExactMatchResults": {}, - * // "trajectoryInOrderMatchResults": {}, - * // "trajectoryPrecisionResults": {}, - * // "trajectoryRecallResults": {}, - * // "trajectorySingleToolUseResults": {} - * // } + * // {} * } * * main().catch(e => { @@ -26530,61 +26427,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - evaluateInstances( - params: Params$Resource$Projects$Locations$Evaluateinstances, + delete( + params: Params$Resource$Datasets$Dataitems$Operations$Delete, options: StreamMethodOptions ): Promise>; - evaluateInstances( - params?: Params$Resource$Projects$Locations$Evaluateinstances, + delete( + params?: Params$Resource$Datasets$Dataitems$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - evaluateInstances( - params: Params$Resource$Projects$Locations$Evaluateinstances, + ): Promise>; + delete( + params: Params$Resource$Datasets$Dataitems$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - evaluateInstances( - params: Params$Resource$Projects$Locations$Evaluateinstances, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - evaluateInstances( - params: Params$Resource$Projects$Locations$Evaluateinstances, - callback: BodyResponseCallback + delete( + params: Params$Resource$Datasets$Dataitems$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - evaluateInstances( - callback: BodyResponseCallback + delete( + params: Params$Resource$Datasets$Dataitems$Operations$Delete, + callback: BodyResponseCallback ): void; - evaluateInstances( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Evaluateinstances - | BodyResponseCallback + | Params$Resource$Datasets$Dataitems$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Evaluateinstances; + {}) as Params$Resource$Datasets$Dataitems$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Evaluateinstances; + params = {} as Params$Resource$Datasets$Dataitems$Operations$Delete; options = {}; } @@ -26597,34 +26486,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+location}:evaluateInstances').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['location'], - pathParams: ['location'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Generates rubrics for a given prompt. A rubric represents a single testable criterion for evaluation. One input prompt could have multiple rubrics This RPC allows users to get suggested rubrics based on provided prompt, which can then be reviewed and used for subsequent evaluations. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -26653,25 +26537,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.generateInstanceRubrics({ - * // Required. The resource name of the Location to generate rubrics from. Format: `projects/{project\}/locations/{location\}` - * location: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "contents": [], - * // "predefinedRubricGenerationSpec": {}, - * // "rubricGenerationSpec": {} - * // } - * }, + * const res = await aiplatform.datasets.dataItems.operations.get({ + * // The name of the operation resource. + * name: 'datasets/my-dataset/dataItems/my-dataItem/operations/my-operation', * }); * console.log(res.data); * * // Example response * // { - * // "generatedRubrics": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -26687,62 +26565,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - generateInstanceRubrics( - params: Params$Resource$Projects$Locations$Generateinstancerubrics, + get( + params: Params$Resource$Datasets$Dataitems$Operations$Get, options: StreamMethodOptions ): Promise>; - generateInstanceRubrics( - params?: Params$Resource$Projects$Locations$Generateinstancerubrics, + get( + params?: Params$Resource$Datasets$Dataitems$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - generateInstanceRubrics( - params: Params$Resource$Projects$Locations$Generateinstancerubrics, + ): Promise>; + get( + params: Params$Resource$Datasets$Dataitems$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - generateInstanceRubrics( - params: Params$Resource$Projects$Locations$Generateinstancerubrics, + get( + params: Params$Resource$Datasets$Dataitems$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - generateInstanceRubrics( - params: Params$Resource$Projects$Locations$Generateinstancerubrics, - callback: BodyResponseCallback + get( + params: Params$Resource$Datasets$Dataitems$Operations$Get, + callback: BodyResponseCallback ): void; - generateInstanceRubrics( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - generateInstanceRubrics( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Generateinstancerubrics - | BodyResponseCallback + | Params$Resource$Datasets$Dataitems$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Generateinstancerubrics; + {}) as Params$Resource$Datasets$Dataitems$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Generateinstancerubrics; + params = {} as Params$Resource$Datasets$Dataitems$Operations$Get; options = {}; } @@ -26755,34 +26628,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+location}:generateInstanceRubrics').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['location'], - pathParams: ['location'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Generates synthetic data based on the provided configuration. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -26811,26 +26679,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.generateSyntheticData({ - * // Required. The resource name of the Location to run the job. Format: `projects/{project\}/locations/{location\}` - * location: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "count": 0, - * // "examples": [], - * // "outputFieldSpecs": [], - * // "taskDescription": {} - * // } - * }, + * const res = await aiplatform.datasets.dataItems.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'datasets/my-dataset/dataItems/my-dataItem', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "syntheticExamples": [] + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -26846,61 +26713,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - generateSyntheticData( - params: Params$Resource$Projects$Locations$Generatesyntheticdata, + list( + params: Params$Resource$Datasets$Dataitems$Operations$List, options: StreamMethodOptions ): Promise>; - generateSyntheticData( - params?: Params$Resource$Projects$Locations$Generatesyntheticdata, + list( + params?: Params$Resource$Datasets$Dataitems$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - generateSyntheticData( - params: Params$Resource$Projects$Locations$Generatesyntheticdata, + list( + params: Params$Resource$Datasets$Dataitems$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - generateSyntheticData( - params: Params$Resource$Projects$Locations$Generatesyntheticdata, + list( + params: Params$Resource$Datasets$Dataitems$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - generateSyntheticData( - params: Params$Resource$Projects$Locations$Generatesyntheticdata, - callback: BodyResponseCallback + list( + params: Params$Resource$Datasets$Dataitems$Operations$List, + callback: BodyResponseCallback ): void; - generateSyntheticData( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - generateSyntheticData( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Generatesyntheticdata - | BodyResponseCallback + | Params$Resource$Datasets$Dataitems$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Generatesyntheticdata; + {}) as Params$Resource$Datasets$Dataitems$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Generatesyntheticdata; + params = {} as Params$Resource$Datasets$Dataitems$Operations$List; options = {}; } @@ -26913,34 +26780,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+location}:generateSyntheticData').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['location'], - pathParams: ['location'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets information about a location. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -26969,19 +26836,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.get({ - * // Resource name for the location. - * name: 'projects/my-project/locations/my-location', + * const res = await aiplatform.datasets.dataItems.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'datasets/my-dataset/dataItems/my-dataItem/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "displayName": "my_displayName", - * // "labels": {}, - * // "locationId": "my_locationId", + * // "done": false, + * // "error": {}, * // "metadata": {}, - * // "name": "my_name" + * // "name": "my_name", + * // "response": {} * // } * } * @@ -26997,57 +26866,424 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Get, + wait( + params: Params$Resource$Datasets$Dataitems$Operations$Wait, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Get, + wait( + params?: Params$Resource$Datasets$Dataitems$Operations$Wait, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Get, + ): Promise>; + wait( + params: Params$Resource$Datasets$Dataitems$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Get, + wait( + params: Params$Resource$Datasets$Dataitems$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Get, - callback: BodyResponseCallback + wait( + params: Params$Resource$Datasets$Dataitems$Operations$Wait, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - get( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Get - | BodyResponseCallback + | Params$Resource$Datasets$Dataitems$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Get; + {}) as Params$Resource$Datasets$Dataitems$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Get; + params = {} as Params$Resource$Datasets$Dataitems$Operations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Datasets$Dataitems$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Datasets$Dataitems$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Datasets$Dataitems$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Datasets$Dataitems$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Datasets$Dataitems$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Datasets$Datasetversions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Create a version from a Dataset. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.datasets.datasetVersions.create({ + * // Required. The name of the Dataset resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + * parent: 'datasets/my-dataset', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bigQueryDatasetName": "my_bigQueryDatasetName", + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "metadata": {}, + * // "modelReference": "my_modelReference", + * // "name": "my_name", + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Datasets$Datasetversions$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Datasets$Datasetversions$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Datasets$Datasetversions$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Datasets$Datasetversions$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Datasets$Datasetversions$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Datasets$Datasetversions$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Datasets$Datasetversions$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Datasets$Datasetversions$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/datasetVersions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a Dataset version. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.datasets.datasetVersions.delete({ + * // Required. The resource name of the Dataset version to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` + * name: 'datasets/my-dataset/datasetVersions/my-datasetVersion', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Datasets$Datasetversions$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Datasets$Datasetversions$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Datasets$Datasetversions$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Datasets$Datasetversions$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Datasets$Datasetversions$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Datasets$Datasetversions$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Datasets$Datasetversions$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Datasets$Datasetversions$Delete; options = {}; } @@ -27061,7 +27297,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -27072,17 +27308,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a RagEngineConfig. + * Gets a Dataset version. * @example * ```js * // Before running the sample: @@ -27111,16 +27347,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.getRagEngineConfig({ - * // Required. The name of the RagEngineConfig resource. Format: `projects/{project\}/locations/{location\}/ragEngineConfig` - * name: 'projects/my-project/locations/my-location/ragEngineConfig', + * const res = await aiplatform.datasets.datasetVersions.get({ + * // Required. The resource name of the Dataset version to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` + * name: 'datasets/my-dataset/datasetVersions/my-datasetVersion', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { + * // "bigQueryDatasetName": "my_bigQueryDatasetName", + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "metadata": {}, + * // "modelReference": "my_modelReference", * // "name": "my_name", - * // "ragManagedDbConfig": {} + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" * // } * } * @@ -27136,61 +27382,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getRagEngineConfig( - params: Params$Resource$Projects$Locations$Getragengineconfig, + get( + params: Params$Resource$Datasets$Datasetversions$Get, options: StreamMethodOptions ): Promise>; - getRagEngineConfig( - params?: Params$Resource$Projects$Locations$Getragengineconfig, + get( + params?: Params$Resource$Datasets$Datasetversions$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - getRagEngineConfig( - params: Params$Resource$Projects$Locations$Getragengineconfig, + get( + params: Params$Resource$Datasets$Datasetversions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getRagEngineConfig( - params: Params$Resource$Projects$Locations$Getragengineconfig, + get( + params: Params$Resource$Datasets$Datasetversions$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getRagEngineConfig( - params: Params$Resource$Projects$Locations$Getragengineconfig, - callback: BodyResponseCallback + get( + params: Params$Resource$Datasets$Datasetversions$Get, + callback: BodyResponseCallback ): void; - getRagEngineConfig( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - getRagEngineConfig( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Getragengineconfig - | BodyResponseCallback + | Params$Resource$Datasets$Datasetversions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Getragengineconfig; + {}) as Params$Resource$Datasets$Datasetversions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Getragengineconfig; + params = {} as Params$Resource$Datasets$Datasetversions$Get; options = {}; } @@ -27215,19 +27461,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists information about the supported locations for this service. + * Lists DatasetVersions in a Dataset. * @example * ```js * // Before running the sample: @@ -27256,23 +27502,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. - * extraLocationTypes: 'placeholder-value', - * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). + * const res = await aiplatform.datasets.datasetVersions.list({ + * // Optional. The standard list filter. * filter: 'placeholder-value', - * // The resource that owns the locations collection, if applicable. - * name: 'projects/my-project', - * // The maximum number of results to return. If not set, the service selects a default. + * // Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. + * orderBy: 'placeholder-value', + * // Optional. The standard list page size. * pageSize: 'placeholder-value', - * // A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. + * // Optional. The standard list page token. * pageToken: 'placeholder-value', + * // Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + * parent: 'datasets/my-dataset', + * // Optional. Mask specifying which fields to read. + * readMask: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "locations": [], + * // "datasetVersions": [], * // "nextPageToken": "my_nextPageToken" * // } * } @@ -27290,60 +27538,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$List, + params: Params$Resource$Datasets$Datasetversions$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$List, + params?: Params$Resource$Datasets$Datasetversions$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$List, + params: Params$Resource$Datasets$Datasetversions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$List, + params: Params$Resource$Datasets$Datasetversions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$List, - callback: BodyResponseCallback + params: Params$Resource$Datasets$Datasetversions$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$List - | BodyResponseCallback + | Params$Resource$Datasets$Datasetversions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$List; + {}) as Params$Resource$Datasets$Datasetversions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$List; + params = {} as Params$Resource$Datasets$Datasetversions$List; options = {}; } @@ -27356,7 +27604,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/locations').replace( + url: (rootUrl + '/v1/{+parent}/datasetVersions').replace( /([^:]\/)\/+/g, '$1' ), @@ -27366,24 +27614,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Retrieves relevant contexts for a query. + * Updates a DatasetVersion. * @example * ```js * // Before running the sample: @@ -27412,16 +27660,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.retrieveContexts({ - * // Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project\}/locations/{location\}`. - * parent: 'projects/my-project/locations/my-location', + * const res = await aiplatform.datasets.datasetVersions.patch({ + * // Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` + * name: 'datasets/my-dataset/datasetVersions/my-datasetVersion', + * // Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` + * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "query": {}, - * // "vertexRagStore": {} + * // "bigQueryDatasetName": "my_bigQueryDatasetName", + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "metadata": {}, + * // "modelReference": "my_modelReference", + * // "name": "my_name", + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" * // } * }, * }); @@ -27429,7 +27687,16 @@ export namespace aiplatform_v1 { * * // Example response * // { - * // "contexts": {} + * // "bigQueryDatasetName": "my_bigQueryDatasetName", + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "metadata": {}, + * // "modelReference": "my_modelReference", + * // "name": "my_name", + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" * // } * } * @@ -27445,61 +27712,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - retrieveContexts( - params: Params$Resource$Projects$Locations$Retrievecontexts, + patch( + params: Params$Resource$Datasets$Datasetversions$Patch, options: StreamMethodOptions ): Promise>; - retrieveContexts( - params?: Params$Resource$Projects$Locations$Retrievecontexts, + patch( + params?: Params$Resource$Datasets$Datasetversions$Patch, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - retrieveContexts( - params: Params$Resource$Projects$Locations$Retrievecontexts, + patch( + params: Params$Resource$Datasets$Datasetversions$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - retrieveContexts( - params: Params$Resource$Projects$Locations$Retrievecontexts, + patch( + params: Params$Resource$Datasets$Datasetversions$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - retrieveContexts( - params: Params$Resource$Projects$Locations$Retrievecontexts, - callback: BodyResponseCallback + patch( + params: Params$Resource$Datasets$Datasetversions$Patch, + callback: BodyResponseCallback ): void; - retrieveContexts( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - retrieveContexts( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Retrievecontexts - | BodyResponseCallback + | Params$Resource$Datasets$Datasetversions$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Retrievecontexts; + {}) as Params$Resource$Datasets$Datasetversions$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Retrievecontexts; + params = {} as Params$Resource$Datasets$Datasetversions$Patch; options = {}; } @@ -27512,34 +27779,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}:retrieveContexts').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a RagEngineConfig. + * Restores a dataset version. * @example * ```js * // Before running the sample: @@ -27568,18 +27832,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.updateRagEngineConfig({ - * // Identifier. The name of the RagEngineConfig. Format: `projects/{project\}/locations/{location\}/ragEngineConfig` - * name: 'projects/my-project/locations/my-location/ragEngineConfig', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "name": "my_name", - * // "ragManagedDbConfig": {} - * // } - * }, + * const res = await aiplatform.datasets.datasetVersions.restore({ + * // Required. The name of the DatasetVersion resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` + * name: 'datasets/my-dataset/datasetVersions/my-datasetVersion', * }); * console.log(res.data); * @@ -27605,36 +27860,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - updateRagEngineConfig( - params: Params$Resource$Projects$Locations$Updateragengineconfig, + restore( + params: Params$Resource$Datasets$Datasetversions$Restore, options: StreamMethodOptions ): Promise>; - updateRagEngineConfig( - params?: Params$Resource$Projects$Locations$Updateragengineconfig, + restore( + params?: Params$Resource$Datasets$Datasetversions$Restore, options?: MethodOptions ): Promise>; - updateRagEngineConfig( - params: Params$Resource$Projects$Locations$Updateragengineconfig, + restore( + params: Params$Resource$Datasets$Datasetversions$Restore, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateRagEngineConfig( - params: Params$Resource$Projects$Locations$Updateragengineconfig, + restore( + params: Params$Resource$Datasets$Datasetversions$Restore, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateRagEngineConfig( - params: Params$Resource$Projects$Locations$Updateragengineconfig, + restore( + params: Params$Resource$Datasets$Datasetversions$Restore, callback: BodyResponseCallback ): void; - updateRagEngineConfig( + restore( callback: BodyResponseCallback ): void; - updateRagEngineConfig( + restore( paramsOrCallback?: - | Params$Resource$Projects$Locations$Updateragengineconfig + | Params$Resource$Datasets$Datasetversions$Restore | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -27650,12 +27905,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Updateragengineconfig; + {}) as Params$Resource$Datasets$Datasetversions$Restore; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Updateragengineconfig; + params = {} as Params$Resource$Datasets$Datasetversions$Restore; options = {}; } @@ -27668,8 +27923,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+name}:restore').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -27690,160 +27948,95 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Augmentprompt - extends StandardParameters { - /** - * Required. The resource name of the Location from which to augment prompt. The users must have permission to make a call in the project. Format: `projects/{project\}/locations/{location\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1AugmentPromptRequest; - } - export interface Params$Resource$Projects$Locations$Corroboratecontent + export interface Params$Resource$Datasets$Datasetversions$Create extends StandardParameters { /** - * Required. The resource name of the Location from which to corroborate text. The users must have permission to make a call in the project. Format: `projects/{project\}/locations/{location\}`. + * Required. The name of the Dataset resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1CorroborateContentRequest; - } - export interface Params$Resource$Projects$Locations$Deploy - extends StandardParameters { - /** - * Required. The resource name of the Location to deploy the model in. Format: `projects/{project\}/locations/{location\}` - */ - destination?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1DeployRequest; + requestBody?: Schema$GoogleCloudAiplatformV1DatasetVersion; } - export interface Params$Resource$Projects$Locations$Evaluatedataset + export interface Params$Resource$Datasets$Datasetversions$Delete extends StandardParameters { /** - * Required. The resource name of the Location to evaluate the dataset. Format: `projects/{project\}/locations/{location\}` - */ - location?: string; - - /** - * Request body metadata + * Required. The resource name of the Dataset version to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` */ - requestBody?: Schema$GoogleCloudAiplatformV1EvaluateDatasetRequest; + name?: string; } - export interface Params$Resource$Projects$Locations$Evaluateinstances + export interface Params$Resource$Datasets$Datasetversions$Get extends StandardParameters { /** - * Required. The resource name of the Location to evaluate the instances. Format: `projects/{project\}/locations/{location\}` + * Required. The resource name of the Dataset version to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` */ - location?: string; - + name?: string; /** - * Request body metadata + * Mask specifying which fields to read. */ - requestBody?: Schema$GoogleCloudAiplatformV1EvaluateInstancesRequest; + readMask?: string; } - export interface Params$Resource$Projects$Locations$Generateinstancerubrics + export interface Params$Resource$Datasets$Datasetversions$List extends StandardParameters { /** - * Required. The resource name of the Location to generate rubrics from. Format: `projects/{project\}/locations/{location\}` + * Optional. The standard list filter. */ - location?: string; - + filter?: string; /** - * Request body metadata + * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. */ - requestBody?: Schema$GoogleCloudAiplatformV1GenerateInstanceRubricsRequest; - } - export interface Params$Resource$Projects$Locations$Generatesyntheticdata - extends StandardParameters { + orderBy?: string; /** - * Required. The resource name of the Location to run the job. Format: `projects/{project\}/locations/{location\}` + * Optional. The standard list page size. */ - location?: string; - + pageSize?: number; /** - * Request body metadata + * Optional. The standard list page token. */ - requestBody?: Schema$GoogleCloudAiplatformV1GenerateSyntheticDataRequest; - } - export interface Params$Resource$Projects$Locations$Get - extends StandardParameters { + pageToken?: string; /** - * Resource name for the location. + * Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Getragengineconfig - extends StandardParameters { + parent?: string; /** - * Required. The name of the RagEngineConfig resource. Format: `projects/{project\}/locations/{location\}/ragEngineConfig` + * Optional. Mask specifying which fields to read. */ - name?: string; + readMask?: string; } - export interface Params$Resource$Projects$Locations$List + export interface Params$Resource$Datasets$Datasetversions$Patch extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. - */ - extraLocationTypes?: string[]; - /** - * A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). - */ - filter?: string; - /** - * The resource that owns the locations collection, if applicable. + * Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` */ name?: string; /** - * The maximum number of results to return. If not set, the service selects a default. - */ - pageSize?: number; - /** - * A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. - */ - pageToken?: string; - } - export interface Params$Resource$Projects$Locations$Retrievecontexts - extends StandardParameters { - /** - * Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project\}/locations/{location\}`. + * Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` */ - parent?: string; + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1RetrieveContextsRequest; + requestBody?: Schema$GoogleCloudAiplatformV1DatasetVersion; } - export interface Params$Resource$Projects$Locations$Updateragengineconfig + export interface Params$Resource$Datasets$Datasetversions$Restore extends StandardParameters { /** - * Identifier. The name of the RagEngineConfig. Format: `projects/{project\}/locations/{location\}/ragEngineConfig` + * Required. The name of the DatasetVersion resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` */ name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1RagEngineConfig; } - export class Resource$Projects$Locations$Batchpredictionjobs { + export class Resource$Datasets$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Cancels a BatchPredictionJob. Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetBatchPredictionJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its BatchPredictionJob.state is set to `CANCELLED`. Any files already outputted by the job are not deleted. + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -27872,15 +28065,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.batchPredictionJobs.cancel({ - * // Required. The name of the BatchPredictionJob to cancel. Format: `projects/{project\}/locations/{location\}/batchPredictionJobs/{batch_prediction_job\}` - * name: 'projects/my-project/locations/my-location/batchPredictionJobs/my-batchPredictionJob', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, + * const res = await aiplatform.datasets.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'datasets/my-dataset/operations/my-operation', * }); * console.log(res.data); * @@ -27901,31 +28088,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel, + params: Params$Resource$Datasets$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel, + params?: Params$Resource$Datasets$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel, + params: Params$Resource$Datasets$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel, + params: Params$Resource$Datasets$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel, + params: Params$Resource$Datasets$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel + | Params$Resource$Datasets$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -27941,13 +28128,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel; + {}) as Params$Resource$Datasets$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel; + params = {} as Params$Resource$Datasets$Operations$Cancel; options = {}; } @@ -27982,7 +28168,7 @@ export namespace aiplatform_v1 { } /** - * Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -28011,80 +28197,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.batchPredictionJobs.create({ - * // Required. The resource name of the Location to create the BatchPredictionJob in. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "completionStats": {}, - * // "createTime": "my_createTime", - * // "dedicatedResources": {}, - * // "disableContainerLogging": false, - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", - * // "error": {}, - * // "explanationSpec": {}, - * // "generateExplanation": false, - * // "inputConfig": {}, - * // "instanceConfig": {}, - * // "labels": {}, - * // "manualBatchTuningParameters": {}, - * // "model": "my_model", - * // "modelParameters": {}, - * // "modelVersionId": "my_modelVersionId", - * // "name": "my_name", - * // "outputConfig": {}, - * // "outputInfo": {}, - * // "partialFailures": [], - * // "resourcesConsumed": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "serviceAccount": "my_serviceAccount", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "unmanagedContainerModel": {}, - * // "updateTime": "my_updateTime" - * // } - * }, + * const res = await aiplatform.datasets.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'datasets/my-dataset/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "completionStats": {}, - * // "createTime": "my_createTime", - * // "dedicatedResources": {}, - * // "disableContainerLogging": false, - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", - * // "error": {}, - * // "explanationSpec": {}, - * // "generateExplanation": false, - * // "inputConfig": {}, - * // "instanceConfig": {}, - * // "labels": {}, - * // "manualBatchTuningParameters": {}, - * // "model": "my_model", - * // "modelParameters": {}, - * // "modelVersionId": "my_modelVersionId", - * // "name": "my_name", - * // "outputConfig": {}, - * // "outputInfo": {}, - * // "partialFailures": [], - * // "resourcesConsumed": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "serviceAccount": "my_serviceAccount", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "unmanagedContainerModel": {}, - * // "updateTime": "my_updateTime" - * // } + * // {} * } * * main().catch(e => { @@ -28099,62 +28219,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Create, + delete( + params: Params$Resource$Datasets$Operations$Delete, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Batchpredictionjobs$Create, + delete( + params?: Params$Resource$Datasets$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - create( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Create, + ): Promise>; + delete( + params: Params$Resource$Datasets$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Create, - callback: BodyResponseCallback + delete( + params: Params$Resource$Datasets$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + delete( + params: Params$Resource$Datasets$Operations$Delete, + callback: BodyResponseCallback ): void; - create( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Batchpredictionjobs$Create - | BodyResponseCallback + | Params$Resource$Datasets$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Batchpredictionjobs$Create; + {}) as Params$Resource$Datasets$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Batchpredictionjobs$Create; + params = {} as Params$Resource$Datasets$Operations$Delete; options = {}; } @@ -28167,34 +28278,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/batchPredictionJobs').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes a BatchPredictionJob. Can only be called on jobs that already finished. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -28223,9 +28329,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.batchPredictionJobs.delete({ - * // Required. The name of the BatchPredictionJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/batchPredictionJobs/{batch_prediction_job\}` - * name: 'projects/my-project/locations/my-location/batchPredictionJobs/my-batchPredictionJob', + * const res = await aiplatform.datasets.operations.get({ + * // The name of the operation resource. + * name: 'datasets/my-dataset/operations/my-operation', * }); * console.log(res.data); * @@ -28251,36 +28357,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Delete, + get( + params: Params$Resource$Datasets$Operations$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Batchpredictionjobs$Delete, + get( + params?: Params$Resource$Datasets$Operations$Get, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Delete, + get( + params: Params$Resource$Datasets$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Delete, + get( + params: Params$Resource$Datasets$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Delete, + get( + params: Params$Resource$Datasets$Operations$Get, callback: BodyResponseCallback ): void; - delete( + get( callback: BodyResponseCallback ): void; - delete( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Batchpredictionjobs$Delete + | Params$Resource$Datasets$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -28296,13 +28402,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Batchpredictionjobs$Delete; + {}) as Params$Resource$Datasets$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Batchpredictionjobs$Delete; + params = {} as Params$Resource$Datasets$Operations$Get; options = {}; } @@ -28316,7 +28421,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -28337,7 +28442,7 @@ export namespace aiplatform_v1 { } /** - * Gets a BatchPredictionJob + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -28366,43 +28471,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.batchPredictionJobs.get({ - * // Required. The name of the BatchPredictionJob resource. Format: `projects/{project\}/locations/{location\}/batchPredictionJobs/{batch_prediction_job\}` - * name: 'projects/my-project/locations/my-location/batchPredictionJobs/my-batchPredictionJob', + * const res = await aiplatform.datasets.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'datasets/my-dataset', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "completionStats": {}, - * // "createTime": "my_createTime", - * // "dedicatedResources": {}, - * // "disableContainerLogging": false, - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", - * // "error": {}, - * // "explanationSpec": {}, - * // "generateExplanation": false, - * // "inputConfig": {}, - * // "instanceConfig": {}, - * // "labels": {}, - * // "manualBatchTuningParameters": {}, - * // "model": "my_model", - * // "modelParameters": {}, - * // "modelVersionId": "my_modelVersionId", - * // "name": "my_name", - * // "outputConfig": {}, - * // "outputInfo": {}, - * // "partialFailures": [], - * // "resourcesConsumed": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "serviceAccount": "my_serviceAccount", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "unmanagedContainerModel": {}, - * // "updateTime": "my_updateTime" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -28418,62 +28505,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Get, + list( + params: Params$Resource$Datasets$Operations$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Batchpredictionjobs$Get, + list( + params?: Params$Resource$Datasets$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Get, + list( + params: Params$Resource$Datasets$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Get, + list( + params: Params$Resource$Datasets$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Datasets$Operations$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Batchpredictionjobs$Get - | BodyResponseCallback + | Params$Resource$Datasets$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Batchpredictionjobs$Get; + {}) as Params$Resource$Datasets$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Batchpredictionjobs$Get; + params = {} as Params$Resource$Datasets$Operations$List; options = {}; } @@ -28486,7 +28572,10 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -28498,19 +28587,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists BatchPredictionJobs in a Location. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -28539,24 +28628,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.batchPredictionJobs.list({ - * // The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `model_display_name` supports `=`, `!=` comparisons. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` - * filter: 'placeholder-value', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. Typically obtained via ListBatchPredictionJobsResponse.next_page_token of the previous JobService.ListBatchPredictionJobs call. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list the BatchPredictionJobs from. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', + * const res = await aiplatform.datasets.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'datasets/my-dataset/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "batchPredictionJobs": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -28572,62 +28658,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$List, + wait( + params: Params$Resource$Datasets$Operations$Wait, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Batchpredictionjobs$List, + wait( + params?: Params$Resource$Datasets$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$List, + ): Promise>; + wait( + params: Params$Resource$Datasets$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$List, + wait( + params: Params$Resource$Datasets$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$List, - callback: BodyResponseCallback + wait( + params: Params$Resource$Datasets$Operations$Wait, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - list( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Batchpredictionjobs$List - | BodyResponseCallback + | Params$Resource$Datasets$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Batchpredictionjobs$List; + {}) as Params$Resource$Datasets$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Batchpredictionjobs$List; + params = {} as Params$Resource$Datasets$Operations$Wait; options = {}; } @@ -28640,103 +28721,103 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/batchPredictionJobs').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel + export interface Params$Resource$Datasets$Operations$Cancel extends StandardParameters { /** - * Required. The name of the BatchPredictionJob to cancel. Format: `projects/{project\}/locations/{location\}/batchPredictionJobs/{batch_prediction_job\}` + * The name of the operation resource to be cancelled. */ name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1CancelBatchPredictionJobRequest; - } - export interface Params$Resource$Projects$Locations$Batchpredictionjobs$Create - extends StandardParameters { - /** - * Required. The resource name of the Location to create the BatchPredictionJob in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1BatchPredictionJob; } - export interface Params$Resource$Projects$Locations$Batchpredictionjobs$Delete + export interface Params$Resource$Datasets$Operations$Delete extends StandardParameters { /** - * Required. The name of the BatchPredictionJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/batchPredictionJobs/{batch_prediction_job\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Batchpredictionjobs$Get + export interface Params$Resource$Datasets$Operations$Get extends StandardParameters { /** - * Required. The name of the BatchPredictionJob resource. Format: `projects/{project\}/locations/{location\}/batchPredictionJobs/{batch_prediction_job\}` + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Batchpredictionjobs$List + export interface Params$Resource$Datasets$Operations$List extends StandardParameters { /** - * The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `model_display_name` supports `=`, `!=` comparisons. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` + * The standard list filter. */ filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; /** * The standard list page size. */ pageSize?: number; /** - * The standard list page token. Typically obtained via ListBatchPredictionJobsResponse.next_page_token of the previous JobService.ListBatchPredictionJobs call. + * The standard list page token. */ pageToken?: string; /** - * Required. The resource name of the Location to list the BatchPredictionJobs from. Format: `projects/{project\}/locations/{location\}` + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - parent?: string; + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Datasets$Operations$Wait + extends StandardParameters { /** - * Mask specifying which fields to read. + * The name of the operation resource to wait on. */ - readMask?: string; + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; } - export class Resource$Projects$Locations$Cachedcontents { + export class Resource$Datasets$Savedqueries { + context: APIRequestContext; + operations: Resource$Datasets$Savedqueries$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Datasets$Savedqueries$Operations( + this.context + ); + } + } + + export class Resource$Datasets$Savedqueries$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates cached content, this call will initialize the cached content in the data storage, and users need to pay for the cache data storage. + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -28765,48 +28846,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.cachedContents.create({ - * // Required. The parent resource where the cached content will be created - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "contents": [], - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "expireTime": "my_expireTime", - * // "model": "my_model", - * // "name": "my_name", - * // "systemInstruction": {}, - * // "toolConfig": {}, - * // "tools": [], - * // "ttl": "my_ttl", - * // "updateTime": "my_updateTime", - * // "usageMetadata": {} - * // } - * }, + * const res = await aiplatform.datasets.savedQueries.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'datasets/my-dataset/savedQueries/my-savedQuerie/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "contents": [], - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "expireTime": "my_expireTime", - * // "model": "my_model", - * // "name": "my_name", - * // "systemInstruction": {}, - * // "toolConfig": {}, - * // "tools": [], - * // "ttl": "my_ttl", - * // "updateTime": "my_updateTime", - * // "usageMetadata": {} - * // } + * // {} * } * * main().catch(e => { @@ -28821,61 +28868,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Cachedcontents$Create, + cancel( + params: Params$Resource$Datasets$Savedqueries$Operations$Cancel, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Cachedcontents$Create, + cancel( + params?: Params$Resource$Datasets$Savedqueries$Operations$Cancel, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - create( - params: Params$Resource$Projects$Locations$Cachedcontents$Create, + ): Promise>; + cancel( + params: Params$Resource$Datasets$Savedqueries$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Cachedcontents$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Cachedcontents$Create, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Datasets$Savedqueries$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Datasets$Savedqueries$Operations$Cancel, + callback: BodyResponseCallback ): void; - create( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Cachedcontents$Create - | BodyResponseCallback + | Params$Resource$Datasets$Savedqueries$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Cachedcontents$Create; + {}) as Params$Resource$Datasets$Savedqueries$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Cachedcontents$Create; + params = {} as Params$Resource$Datasets$Savedqueries$Operations$Cancel; options = {}; } @@ -28888,34 +28927,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/cachedContents').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes cached content + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -28944,9 +28978,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.cachedContents.delete({ - * // Required. The resource name referring to the cached content - * name: 'projects/my-project/locations/my-location/cachedContents/my-cachedContent', + * const res = await aiplatform.datasets.savedQueries.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'datasets/my-dataset/savedQueries/my-savedQuerie/operations/my-operation', * }); * console.log(res.data); * @@ -28967,31 +29001,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Cachedcontents$Delete, + params: Params$Resource$Datasets$Savedqueries$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Cachedcontents$Delete, + params?: Params$Resource$Datasets$Savedqueries$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Cachedcontents$Delete, + params: Params$Resource$Datasets$Savedqueries$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Cachedcontents$Delete, + params: Params$Resource$Datasets$Savedqueries$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Cachedcontents$Delete, + params: Params$Resource$Datasets$Savedqueries$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Cachedcontents$Delete + | Params$Resource$Datasets$Savedqueries$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -29007,12 +29041,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Cachedcontents$Delete; + {}) as Params$Resource$Datasets$Savedqueries$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Cachedcontents$Delete; + params = {} as Params$Resource$Datasets$Savedqueries$Operations$Delete; options = {}; } @@ -29047,7 +29081,7 @@ export namespace aiplatform_v1 { } /** - * Gets cached content configurations + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -29076,27 +29110,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.cachedContents.get({ - * // Required. The resource name referring to the cached content - * name: 'projects/my-project/locations/my-location/cachedContents/my-cachedContent', + * const res = await aiplatform.datasets.savedQueries.operations.get({ + * // The name of the operation resource. + * name: 'datasets/my-dataset/savedQueries/my-savedQuerie/operations/my-operation', * }); * console.log(res.data); * * // Example response * // { - * // "contents": [], - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "expireTime": "my_expireTime", - * // "model": "my_model", + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "systemInstruction": {}, - * // "toolConfig": {}, - * // "tools": [], - * // "ttl": "my_ttl", - * // "updateTime": "my_updateTime", - * // "usageMetadata": {} + * // "response": {} * // } * } * @@ -29113,60 +29139,56 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Cachedcontents$Get, + params: Params$Resource$Datasets$Savedqueries$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Cachedcontents$Get, + params?: Params$Resource$Datasets$Savedqueries$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; + ): Promise>; get( - params: Params$Resource$Projects$Locations$Cachedcontents$Get, + params: Params$Resource$Datasets$Savedqueries$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Cachedcontents$Get, + params: Params$Resource$Datasets$Savedqueries$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Cachedcontents$Get, - callback: BodyResponseCallback + params: Params$Resource$Datasets$Savedqueries$Operations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Cachedcontents$Get - | BodyResponseCallback + | Params$Resource$Datasets$Savedqueries$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Cachedcontents$Get; + {}) as Params$Resource$Datasets$Savedqueries$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Cachedcontents$Get; + params = {} as Params$Resource$Datasets$Savedqueries$Operations$Get; options = {}; } @@ -29191,19 +29213,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists cached contents in a project + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -29232,20 +29252,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.cachedContents.list({ - * // Optional. The maximum number of cached contents to return. The service may return fewer than this value. If unspecified, some default (under maximum) number of items will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * const res = await aiplatform.datasets.savedQueries.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'datasets/my-dataset/savedQueries/my-savedQuerie', + * // The standard list page size. * pageSize: 'placeholder-value', - * // Optional. A page token, received from a previous `ListCachedContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCachedContents` must match the call that provided the page token. + * // The standard list page token. * pageToken: 'placeholder-value', - * // Required. The parent, which owns this collection of cached contents. - * parent: 'projects/my-project/locations/my-location', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "cachedContents": [], - * // "nextPageToken": "my_nextPageToken" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -29262,60 +29287,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Cachedcontents$List, + params: Params$Resource$Datasets$Savedqueries$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Cachedcontents$List, + params?: Params$Resource$Datasets$Savedqueries$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Cachedcontents$List, + params: Params$Resource$Datasets$Savedqueries$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Cachedcontents$List, + params: Params$Resource$Datasets$Savedqueries$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Cachedcontents$List, - callback: BodyResponseCallback + params: Params$Resource$Datasets$Savedqueries$Operations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Cachedcontents$List - | BodyResponseCallback + | Params$Resource$Datasets$Savedqueries$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Cachedcontents$List; + {}) as Params$Resource$Datasets$Savedqueries$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Cachedcontents$List; + params = {} as Params$Resource$Datasets$Savedqueries$Operations$List; options = {}; } @@ -29328,7 +29353,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/cachedContents').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -29338,24 +29363,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates cached content configurations + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -29384,49 +29409,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.cachedContents.patch({ - * // Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project\}/locations/{location\}/cachedContents/{cached_content\} - * name: 'projects/my-project/locations/my-location/cachedContents/my-cachedContent', - * // Required. The list of fields to update. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "contents": [], - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "expireTime": "my_expireTime", - * // "model": "my_model", - * // "name": "my_name", - * // "systemInstruction": {}, - * // "toolConfig": {}, - * // "tools": [], - * // "ttl": "my_ttl", - * // "updateTime": "my_updateTime", - * // "usageMetadata": {} - * // } - * }, + * const res = await aiplatform.datasets.savedQueries.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'datasets/my-dataset/savedQueries/my-savedQuerie/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "contents": [], - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "expireTime": "my_expireTime", - * // "model": "my_model", + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "systemInstruction": {}, - * // "toolConfig": {}, - * // "tools": [], - * // "ttl": "my_ttl", - * // "updateTime": "my_updateTime", - * // "usageMetadata": {} + * // "response": {} * // } * } * @@ -29442,61 +29439,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Cachedcontents$Patch, + wait( + params: Params$Resource$Datasets$Savedqueries$Operations$Wait, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Cachedcontents$Patch, + wait( + params?: Params$Resource$Datasets$Savedqueries$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - patch( - params: Params$Resource$Projects$Locations$Cachedcontents$Patch, + ): Promise>; + wait( + params: Params$Resource$Datasets$Savedqueries$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Cachedcontents$Patch, + wait( + params: Params$Resource$Datasets$Savedqueries$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Cachedcontents$Patch, - callback: BodyResponseCallback + wait( + params: Params$Resource$Datasets$Savedqueries$Operations$Wait, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - patch( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Cachedcontents$Patch - | BodyResponseCallback + | Params$Resource$Datasets$Savedqueries$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Cachedcontents$Patch; + {}) as Params$Resource$Datasets$Savedqueries$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Cachedcontents$Patch; + params = {} as Params$Resource$Datasets$Savedqueries$Operations$Wait; options = {}; } @@ -29509,8 +29502,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -29521,88 +29514,91 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Cachedcontents$Create + export interface Params$Resource$Datasets$Savedqueries$Operations$Cancel extends StandardParameters { /** - * Required. The parent resource where the cached content will be created - */ - parent?: string; - - /** - * Request body metadata + * The name of the operation resource to be cancelled. */ - requestBody?: Schema$GoogleCloudAiplatformV1CachedContent; + name?: string; } - export interface Params$Resource$Projects$Locations$Cachedcontents$Delete + export interface Params$Resource$Datasets$Savedqueries$Operations$Delete extends StandardParameters { /** - * Required. The resource name referring to the cached content + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Cachedcontents$Get + export interface Params$Resource$Datasets$Savedqueries$Operations$Get extends StandardParameters { /** - * Required. The resource name referring to the cached content + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Cachedcontents$List + export interface Params$Resource$Datasets$Savedqueries$Operations$List extends StandardParameters { /** - * Optional. The maximum number of cached contents to return. The service may return fewer than this value. If unspecified, some default (under maximum) number of items will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. */ pageSize?: number; /** - * Optional. A page token, received from a previous `ListCachedContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCachedContents` must match the call that provided the page token. + * The standard list page token. */ pageToken?: string; /** - * Required. The parent, which owns this collection of cached contents. + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - parent?: string; + returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Cachedcontents$Patch + export interface Params$Resource$Datasets$Savedqueries$Operations$Wait extends StandardParameters { /** - * Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project\}/locations/{location\}/cachedContents/{cached_content\} + * The name of the operation resource to wait on. */ name?: string; /** - * Required. The list of fields to update. - */ - updateMask?: string; - - /** - * Request body metadata + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - requestBody?: Schema$GoogleCloudAiplatformV1CachedContent; + timeout?: string; } - export class Resource$Projects$Locations$Customjobs { + export class Resource$Deploymentresourcepools { context: APIRequestContext; - operations: Resource$Projects$Locations$Customjobs$Operations; + operations: Resource$Deploymentresourcepools$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = new Resource$Projects$Locations$Customjobs$Operations( + this.operations = new Resource$Deploymentresourcepools$Operations( this.context ); } + } + + export class Resource$Deploymentresourcepools$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetCustomJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the CustomJob is not deleted; instead it becomes a job with a CustomJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and CustomJob.state is set to `CANCELLED`. + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -29631,15 +29627,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.customJobs.cancel({ - * // Required. The name of the CustomJob to cancel. Format: `projects/{project\}/locations/{location\}/customJobs/{custom_job\}` - * name: 'projects/my-project/locations/my-location/customJobs/my-customJob', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, + * const res = await aiplatform.deploymentResourcePools.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'deploymentResourcePools/my-deploymentResourcePool/operations/my-operation', * }); * console.log(res.data); * @@ -29660,31 +29650,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Customjobs$Cancel, + params: Params$Resource$Deploymentresourcepools$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Customjobs$Cancel, + params?: Params$Resource$Deploymentresourcepools$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Customjobs$Cancel, + params: Params$Resource$Deploymentresourcepools$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Customjobs$Cancel, + params: Params$Resource$Deploymentresourcepools$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Customjobs$Cancel, + params: Params$Resource$Deploymentresourcepools$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Customjobs$Cancel + | Params$Resource$Deploymentresourcepools$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -29700,12 +29690,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Customjobs$Cancel; + {}) as Params$Resource$Deploymentresourcepools$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Customjobs$Cancel; + params = + {} as Params$Resource$Deploymentresourcepools$Operations$Cancel; options = {}; } @@ -29740,7 +29731,7 @@ export namespace aiplatform_v1 { } /** - * Creates a CustomJob. A created CustomJob right away will be attempted to be run. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -29769,50 +29760,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.customJobs.create({ - * // Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", - * // "error": {}, - * // "jobSpec": {}, - * // "labels": {}, - * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "updateTime": "my_updateTime", - * // "webAccessUris": {} - * // } - * }, + * const res = await aiplatform.deploymentResourcePools.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'deploymentResourcePools/my-deploymentResourcePool/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", - * // "error": {}, - * // "jobSpec": {}, - * // "labels": {}, - * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "updateTime": "my_updateTime", - * // "webAccessUris": {} - * // } + * // {} * } * * main().catch(e => { @@ -29827,61 +29782,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Customjobs$Create, + delete( + params: Params$Resource$Deploymentresourcepools$Operations$Delete, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Customjobs$Create, + delete( + params?: Params$Resource$Deploymentresourcepools$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - create( - params: Params$Resource$Projects$Locations$Customjobs$Create, + ): Promise>; + delete( + params: Params$Resource$Deploymentresourcepools$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Customjobs$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Customjobs$Create, - callback: BodyResponseCallback + delete( + params: Params$Resource$Deploymentresourcepools$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + delete( + params: Params$Resource$Deploymentresourcepools$Operations$Delete, + callback: BodyResponseCallback ): void; - create( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Customjobs$Create - | BodyResponseCallback + | Params$Resource$Deploymentresourcepools$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Customjobs$Create; + {}) as Params$Resource$Deploymentresourcepools$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Customjobs$Create; + params = + {} as Params$Resource$Deploymentresourcepools$Operations$Delete; options = {}; } @@ -29894,34 +29842,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/customJobs').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes a CustomJob. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -29950,9 +29893,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.customJobs.delete({ - * // Required. The name of the CustomJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/customJobs/{custom_job\}` - * name: 'projects/my-project/locations/my-location/customJobs/my-customJob', + * const res = await aiplatform.deploymentResourcePools.operations.get({ + * // The name of the operation resource. + * name: 'deploymentResourcePools/my-deploymentResourcePool/operations/my-operation', * }); * console.log(res.data); * @@ -29978,36 +29921,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Customjobs$Delete, + get( + params: Params$Resource$Deploymentresourcepools$Operations$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Customjobs$Delete, + get( + params?: Params$Resource$Deploymentresourcepools$Operations$Get, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Customjobs$Delete, + get( + params: Params$Resource$Deploymentresourcepools$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Customjobs$Delete, + get( + params: Params$Resource$Deploymentresourcepools$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Customjobs$Delete, + get( + params: Params$Resource$Deploymentresourcepools$Operations$Get, callback: BodyResponseCallback ): void; - delete( + get( callback: BodyResponseCallback ): void; - delete( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Customjobs$Delete + | Params$Resource$Deploymentresourcepools$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -30023,12 +29966,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Customjobs$Delete; + {}) as Params$Resource$Deploymentresourcepools$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Customjobs$Delete; + params = {} as Params$Resource$Deploymentresourcepools$Operations$Get; options = {}; } @@ -30042,7 +29985,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -30063,7 +30006,7 @@ export namespace aiplatform_v1 { } /** - * Gets a CustomJob. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -30092,28 +30035,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.customJobs.get({ - * // Required. The name of the CustomJob resource. Format: `projects/{project\}/locations/{location\}/customJobs/{custom_job\}` - * name: 'projects/my-project/locations/my-location/customJobs/my-customJob', + * const res = await aiplatform.deploymentResourcePools.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'deploymentResourcePools/my-deploymentResourcePool', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", - * // "error": {}, - * // "jobSpec": {}, - * // "labels": {}, - * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "updateTime": "my_updateTime", - * // "webAccessUris": {} + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -30129,61 +30069,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Customjobs$Get, + list( + params: Params$Resource$Deploymentresourcepools$Operations$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Customjobs$Get, + list( + params?: Params$Resource$Deploymentresourcepools$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Customjobs$Get, + list( + params: Params$Resource$Deploymentresourcepools$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Customjobs$Get, + list( + params: Params$Resource$Deploymentresourcepools$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Customjobs$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Deploymentresourcepools$Operations$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Customjobs$Get - | BodyResponseCallback + | Params$Resource$Deploymentresourcepools$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Customjobs$Get; + {}) as Params$Resource$Deploymentresourcepools$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Customjobs$Get; + params = {} as Params$Resource$Deploymentresourcepools$Operations$List; options = {}; } @@ -30196,7 +30136,10 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -30208,19 +30151,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists CustomJobs in a Location. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -30249,24 +30192,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.customJobs.list({ - * // The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` - * filter: 'placeholder-value', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. Typically obtained via ListCustomJobsResponse.next_page_token of the previous JobService.ListCustomJobs call. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list the CustomJobs from. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', + * const res = await aiplatform.deploymentResourcePools.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'deploymentResourcePools/my-deploymentResourcePool/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "customJobs": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -30282,61 +30222,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Customjobs$List, + wait( + params: Params$Resource$Deploymentresourcepools$Operations$Wait, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Customjobs$List, + wait( + params?: Params$Resource$Deploymentresourcepools$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Customjobs$List, + ): Promise>; + wait( + params: Params$Resource$Deploymentresourcepools$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Customjobs$List, + wait( + params: Params$Resource$Deploymentresourcepools$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Customjobs$List, - callback: BodyResponseCallback + wait( + params: Params$Resource$Deploymentresourcepools$Operations$Wait, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - list( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Customjobs$List - | BodyResponseCallback + | Params$Resource$Deploymentresourcepools$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Customjobs$List; + {}) as Params$Resource$Deploymentresourcepools$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Customjobs$List; + params = {} as Params$Resource$Deploymentresourcepools$Operations$Wait; options = {}; } @@ -30349,103 +30285,96 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/customJobs').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Customjobs$Cancel + export interface Params$Resource$Deploymentresourcepools$Operations$Cancel extends StandardParameters { /** - * Required. The name of the CustomJob to cancel. Format: `projects/{project\}/locations/{location\}/customJobs/{custom_job\}` + * The name of the operation resource to be cancelled. */ name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1CancelCustomJobRequest; - } - export interface Params$Resource$Projects$Locations$Customjobs$Create - extends StandardParameters { - /** - * Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1CustomJob; } - export interface Params$Resource$Projects$Locations$Customjobs$Delete + export interface Params$Resource$Deploymentresourcepools$Operations$Delete extends StandardParameters { /** - * Required. The name of the CustomJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/customJobs/{custom_job\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Customjobs$Get + export interface Params$Resource$Deploymentresourcepools$Operations$Get extends StandardParameters { /** - * Required. The name of the CustomJob resource. Format: `projects/{project\}/locations/{location\}/customJobs/{custom_job\}` + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Customjobs$List + export interface Params$Resource$Deploymentresourcepools$Operations$List extends StandardParameters { /** - * The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` + * The standard list filter. */ filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; /** * The standard list page size. */ pageSize?: number; /** - * The standard list page token. Typically obtained via ListCustomJobsResponse.next_page_token of the previous JobService.ListCustomJobs call. + * The standard list page token. */ pageToken?: string; /** - * Required. The resource name of the Location to list the CustomJobs from. Format: `projects/{project\}/locations/{location\}` + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - parent?: string; + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Deploymentresourcepools$Operations$Wait + extends StandardParameters { /** - * Mask specifying which fields to read. + * The name of the operation resource to wait on. */ - readMask?: string; + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; } - export class Resource$Projects$Locations$Customjobs$Operations { + export class Resource$Endpoints { context: APIRequestContext; + chat: Resource$Endpoints$Chat; + operations: Resource$Endpoints$Operations; constructor(context: APIRequestContext) { this.context = context; + this.chat = new Resource$Endpoints$Chat(this.context); + this.operations = new Resource$Endpoints$Operations(this.context); } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Return a list of tokens based on the input text. * @example * ```js * // Before running the sample: @@ -30474,15 +30403,27 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.customJobs.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/customJobs/my-customJob/operations/my-operation', + * const res = await aiplatform.endpoints.computeTokens({ + * // Required. The name of the Endpoint requested to get lists of tokens and token ids. + * endpoint: 'endpoints/my-endpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "contents": [], + * // "instances": [], + * // "model": "my_model" + * // } + * }, * }); * console.log(res.data); * * // Example response - * // {} - * } + * // { + * // "tokensInfo": [] + * // } + * } * * main().catch(e => { * console.error(e); @@ -30496,54 +30437,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Cancel, + computeTokens( + params: Params$Resource$Endpoints$Computetokens, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Customjobs$Operations$Cancel, + computeTokens( + params?: Params$Resource$Endpoints$Computetokens, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Cancel, + ): Promise< + GaxiosResponseWithHTTP2 + >; + computeTokens( + params: Params$Resource$Endpoints$Computetokens, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + computeTokens( + params: Params$Resource$Endpoints$Computetokens, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Cancel, - callback: BodyResponseCallback + computeTokens( + params: Params$Resource$Endpoints$Computetokens, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + computeTokens( + callback: BodyResponseCallback + ): void; + computeTokens( paramsOrCallback?: - | Params$Resource$Projects$Locations$Customjobs$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Endpoints$Computetokens + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Customjobs$Operations$Cancel; + {}) as Params$Resource$Endpoints$Computetokens; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Customjobs$Operations$Cancel; + params = {} as Params$Resource$Endpoints$Computetokens; options = {}; } @@ -30556,29 +30504,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+endpoint}:computeTokens').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Perform a token counting. * @example * ```js * // Before running the sample: @@ -30607,14 +30560,31 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.customJobs.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/customJobs/my-customJob/operations/my-operation', + * const res = await aiplatform.endpoints.countTokens({ + * // Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: 'endpoints/my-endpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "contents": [], + * // "generationConfig": {}, + * // "instances": [], + * // "model": "my_model", + * // "systemInstruction": {}, + * // "tools": [] + * // } + * }, * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "promptTokensDetails": [], + * // "totalBillableCharacters": 0, + * // "totalTokens": 0 + * // } * } * * main().catch(e => { @@ -30629,54 +30599,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Delete, + countTokens( + params: Params$Resource$Endpoints$Counttokens, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Customjobs$Operations$Delete, + countTokens( + params?: Params$Resource$Endpoints$Counttokens, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + countTokens( + params: Params$Resource$Endpoints$Counttokens, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + countTokens( + params: Params$Resource$Endpoints$Counttokens, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Delete, - callback: BodyResponseCallback + countTokens( + params: Params$Resource$Endpoints$Counttokens, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + countTokens( + callback: BodyResponseCallback + ): void; + countTokens( paramsOrCallback?: - | Params$Resource$Projects$Locations$Customjobs$Operations$Delete - | BodyResponseCallback + | Params$Resource$Endpoints$Counttokens + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Customjobs$Operations$Delete; + {}) as Params$Resource$Endpoints$Counttokens; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Customjobs$Operations$Delete; + params = {} as Params$Resource$Endpoints$Counttokens; options = {}; } @@ -30689,29 +30666,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+endpoint}:countTokens').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Fetch an asynchronous online prediction operation. * @example * ```js * // Before running the sample: @@ -30732,7 +30714,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -30740,9 +30725,17 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.customJobs.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/customJobs/my-customJob/operations/my-operation', + * const res = await aiplatform.endpoints.fetchPredictOperation({ + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` + * endpoint: 'endpoints/my-endpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "operationName": "my_operationName" + * // } + * }, * }); * console.log(res.data); * @@ -30768,36 +30761,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Get, + fetchPredictOperation( + params: Params$Resource$Endpoints$Fetchpredictoperation, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Customjobs$Operations$Get, + fetchPredictOperation( + params?: Params$Resource$Endpoints$Fetchpredictoperation, options?: MethodOptions ): Promise>; - get( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Get, + fetchPredictOperation( + params: Params$Resource$Endpoints$Fetchpredictoperation, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Get, + fetchPredictOperation( + params: Params$Resource$Endpoints$Fetchpredictoperation, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Get, + fetchPredictOperation( + params: Params$Resource$Endpoints$Fetchpredictoperation, callback: BodyResponseCallback ): void; - get( + fetchPredictOperation( callback: BodyResponseCallback ): void; - get( + fetchPredictOperation( paramsOrCallback?: - | Params$Resource$Projects$Locations$Customjobs$Operations$Get + | Params$Resource$Endpoints$Fetchpredictoperation | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -30813,13 +30806,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Customjobs$Operations$Get; + {}) as Params$Resource$Endpoints$Fetchpredictoperation; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Customjobs$Operations$Get; + params = {} as Params$Resource$Endpoints$Fetchpredictoperation; options = {}; } @@ -30832,15 +30824,18 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+endpoint}:fetchPredictOperation').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { @@ -30854,7 +30849,7 @@ export namespace aiplatform_v1 { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Generate content with multimodal inputs. * @example * ```js * // Before running the sample: @@ -30875,7 +30870,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -30883,25 +30881,36 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.customJobs.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/customJobs/my-customJob', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', + * const res = await aiplatform.endpoints.generateContent({ + * // Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * model: 'endpoints/my-endpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "cachedContent": "my_cachedContent", + * // "contents": [], + * // "generationConfig": {}, + * // "labels": {}, + * // "modelArmorConfig": {}, + * // "safetySettings": [], + * // "systemInstruction": {}, + * // "toolConfig": {}, + * // "tools": [] + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "candidates": [], + * // "createTime": "my_createTime", + * // "modelVersion": "my_modelVersion", + * // "promptFeedback": {}, + * // "responseId": "my_responseId", + * // "usageMetadata": {} * // } * } * @@ -30917,62 +30926,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Customjobs$Operations$List, + generateContent( + params: Params$Resource$Endpoints$Generatecontent, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Customjobs$Operations$List, + generateContent( + params?: Params$Resource$Endpoints$Generatecontent, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Customjobs$Operations$List, + generateContent( + params: Params$Resource$Endpoints$Generatecontent, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Customjobs$Operations$List, + generateContent( + params: Params$Resource$Endpoints$Generatecontent, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Customjobs$Operations$List, - callback: BodyResponseCallback + generateContent( + params: Params$Resource$Endpoints$Generatecontent, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + generateContent( + callback: BodyResponseCallback ): void; - list( + generateContent( paramsOrCallback?: - | Params$Resource$Projects$Locations$Customjobs$Operations$List - | BodyResponseCallback + | Params$Resource$Endpoints$Generatecontent + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Customjobs$Operations$List; + {}) as Params$Resource$Endpoints$Generatecontent; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Customjobs$Operations$List; + params = {} as Params$Resource$Endpoints$Generatecontent; options = {}; } @@ -30985,34 +30993,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+model}:generateContent').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['model'], + pathParams: ['model'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Perform an online prediction. * @example * ```js * // Before running the sample: @@ -31033,7 +31041,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -31041,21 +31052,30 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.customJobs.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/customJobs/my-customJob/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', + * const res = await aiplatform.endpoints.predict({ + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: 'endpoints/my-endpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "instances": [], + * // "labels": {}, + * // "parameters": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, + * // "deployedModelId": "my_deployedModelId", * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "model": "my_model", + * // "modelDisplayName": "my_modelDisplayName", + * // "modelVersionId": "my_modelVersionId", + * // "predictions": [] * // } * } * @@ -31071,58 +31091,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Wait, + predict( + params: Params$Resource$Endpoints$Predict, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Customjobs$Operations$Wait, + predict( + params?: Params$Resource$Endpoints$Predict, options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Wait, + ): Promise< + GaxiosResponseWithHTTP2 + >; + predict( + params: Params$Resource$Endpoints$Predict, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Wait, + predict( + params: Params$Resource$Endpoints$Predict, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Wait, - callback: BodyResponseCallback + predict( + params: Params$Resource$Endpoints$Predict, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + predict( + callback: BodyResponseCallback ): void; - wait( + predict( paramsOrCallback?: - | Params$Resource$Projects$Locations$Customjobs$Operations$Wait - | BodyResponseCallback + | Params$Resource$Endpoints$Predict + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Customjobs$Operations$Wait; + {}) as Params$Resource$Endpoints$Predict; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Customjobs$Operations$Wait; + params = {} as Params$Resource$Endpoints$Predict; options = {}; } @@ -31135,97 +31158,33 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+endpoint}:predict').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Customjobs$Operations$Cancel - extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Customjobs$Operations$Delete - extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Customjobs$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Customjobs$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Locations$Customjobs$Operations$Wait - extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Datalabelingjobs { - context: APIRequestContext; - operations: Resource$Projects$Locations$Datalabelingjobs$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Datalabelingjobs$Operations( - this.context + return createAPIRequest( + parameters ); + } } /** - * Cancels a DataLabelingJob. Success of cancellation is not guaranteed. * @example * ```js * // Before running the sample: @@ -31246,7 +31205,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -31254,20 +31216,29 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.dataLabelingJobs.cancel({ - * // Required. The name of the DataLabelingJob. Format: `projects/{project\}/locations/{location\}/dataLabelingJobs/{data_labeling_job\}` - * name: 'projects/my-project/locations/my-location/dataLabelingJobs/my-dataLabelingJob', + * const res = await aiplatform.endpoints.predictLongRunning({ + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` + * endpoint: 'endpoints/my-endpoint', * * // Request body metadata * requestBody: { * // request body parameters - * // {} + * // { + * // "instances": [], + * // "parameters": {} + * // } * }, * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -31282,54 +31253,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Cancel, + predictLongRunning( + params: Params$Resource$Endpoints$Predictlongrunning, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Datalabelingjobs$Cancel, + predictLongRunning( + params?: Params$Resource$Endpoints$Predictlongrunning, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Cancel, + ): Promise>; + predictLongRunning( + params: Params$Resource$Endpoints$Predictlongrunning, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + predictLongRunning( + params: Params$Resource$Endpoints$Predictlongrunning, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Cancel, - callback: BodyResponseCallback + predictLongRunning( + params: Params$Resource$Endpoints$Predictlongrunning, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + predictLongRunning( + callback: BodyResponseCallback + ): void; + predictLongRunning( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datalabelingjobs$Cancel - | BodyResponseCallback + | Params$Resource$Endpoints$Predictlongrunning + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Cancel; + {}) as Params$Resource$Endpoints$Predictlongrunning; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datalabelingjobs$Cancel; + params = {} as Params$Resource$Endpoints$Predictlongrunning; options = {}; } @@ -31342,29 +31316,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+endpoint}:predictLongRunning').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates a DataLabelingJob. + * Generate content with multimodal inputs with streaming support. * @example * ```js * // Before running the sample: @@ -31385,7 +31362,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -31393,32 +31373,23 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.dataLabelingJobs.create({ - * // Required. The parent of the DataLabelingJob. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * const res = await aiplatform.endpoints.streamGenerateContent({ + * // Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * model: 'endpoints/my-endpoint', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "activeLearningConfig": {}, - * // "annotationLabels": {}, - * // "createTime": "my_createTime", - * // "currentSpend": {}, - * // "datasets": [], - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "error": {}, - * // "inputs": {}, - * // "inputsSchemaUri": "my_inputsSchemaUri", - * // "instructionUri": "my_instructionUri", - * // "labelerCount": 0, - * // "labelingProgress": 0, + * // "cachedContent": "my_cachedContent", + * // "contents": [], + * // "generationConfig": {}, * // "labels": {}, - * // "name": "my_name", - * // "specialistPools": [], - * // "state": "my_state", - * // "updateTime": "my_updateTime" + * // "modelArmorConfig": {}, + * // "safetySettings": [], + * // "systemInstruction": {}, + * // "toolConfig": {}, + * // "tools": [] * // } * }, * }); @@ -31426,24 +31397,12 @@ export namespace aiplatform_v1 { * * // Example response * // { - * // "activeLearningConfig": {}, - * // "annotationLabels": {}, + * // "candidates": [], * // "createTime": "my_createTime", - * // "currentSpend": {}, - * // "datasets": [], - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "error": {}, - * // "inputs": {}, - * // "inputsSchemaUri": "my_inputsSchemaUri", - * // "instructionUri": "my_instructionUri", - * // "labelerCount": 0, - * // "labelingProgress": 0, - * // "labels": {}, - * // "name": "my_name", - * // "specialistPools": [], - * // "state": "my_state", - * // "updateTime": "my_updateTime" + * // "modelVersion": "my_modelVersion", + * // "promptFeedback": {}, + * // "responseId": "my_responseId", + * // "usageMetadata": {} * // } * } * @@ -31459,62 +31418,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Create, + streamGenerateContent( + params: Params$Resource$Endpoints$Streamgeneratecontent, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Datalabelingjobs$Create, + streamGenerateContent( + params?: Params$Resource$Endpoints$Streamgeneratecontent, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - create( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Create, + streamGenerateContent( + params: Params$Resource$Endpoints$Streamgeneratecontent, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Create, + streamGenerateContent( + params: Params$Resource$Endpoints$Streamgeneratecontent, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Create, - callback: BodyResponseCallback + streamGenerateContent( + params: Params$Resource$Endpoints$Streamgeneratecontent, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + streamGenerateContent( + callback: BodyResponseCallback ): void; - create( + streamGenerateContent( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datalabelingjobs$Create - | BodyResponseCallback + | Params$Resource$Endpoints$Streamgeneratecontent + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Create; + {}) as Params$Resource$Endpoints$Streamgeneratecontent; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datalabelingjobs$Create; + params = {} as Params$Resource$Endpoints$Streamgeneratecontent; options = {}; } @@ -31527,7 +31485,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/dataLabelingJobs').replace( + url: (rootUrl + '/v1/{+model}:streamGenerateContent').replace( /([^:]\/)\/+/g, '$1' ), @@ -31537,24 +31495,116 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['model'], + pathParams: ['model'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Endpoints$Computetokens + extends StandardParameters { /** - * Deletes a DataLabelingJob. + * Required. The name of the Endpoint requested to get lists of tokens and token ids. + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ComputeTokensRequest; + } + export interface Params$Resource$Endpoints$Counttokens + extends StandardParameters { + /** + * Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CountTokensRequest; + } + export interface Params$Resource$Endpoints$Fetchpredictoperation + extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1FetchPredictOperationRequest; + } + export interface Params$Resource$Endpoints$Generatecontent + extends StandardParameters { + /** + * Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + model?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1GenerateContentRequest; + } + export interface Params$Resource$Endpoints$Predict + extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1PredictRequest; + } + export interface Params$Resource$Endpoints$Predictlongrunning + extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1PredictLongRunningRequest; + } + export interface Params$Resource$Endpoints$Streamgeneratecontent + extends StandardParameters { + /** + * Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + model?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1GenerateContentRequest; + } + + export class Resource$Endpoints$Chat { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Exposes an OpenAI-compatible endpoint for chat completions. * @example * ```js * // Before running the sample: @@ -31575,7 +31625,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -31583,19 +31636,27 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.dataLabelingJobs.delete({ - * // Required. The name of the DataLabelingJob to be deleted. Format: `projects/{project\}/locations/{location\}/dataLabelingJobs/{data_labeling_job\}` - * name: 'projects/my-project/locations/my-location/dataLabelingJobs/my-dataLabelingJob', + * const res = await aiplatform.endpoints.chat.completions({ + * // Required. The name of the endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: 'endpoints/my-endpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] * // } * } * @@ -31611,58 +31672,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Delete, + completions( + params: Params$Resource$Endpoints$Chat$Completions, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Datalabelingjobs$Delete, + completions( + params?: Params$Resource$Endpoints$Chat$Completions, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Delete, + ): Promise>; + completions( + params: Params$Resource$Endpoints$Chat$Completions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Delete, - callback: BodyResponseCallback + completions( + params: Params$Resource$Endpoints$Chat$Completions, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + completions( + params: Params$Resource$Endpoints$Chat$Completions, + callback: BodyResponseCallback ): void; - delete( + completions(callback: BodyResponseCallback): void; + completions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datalabelingjobs$Delete - | BodyResponseCallback + | Params$Resource$Endpoints$Chat$Completions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Delete; + {}) as Params$Resource$Endpoints$Chat$Completions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datalabelingjobs$Delete; + params = {} as Params$Resource$Endpoints$Chat$Completions; options = {}; } @@ -31675,29 +31731,52 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+endpoint}/chat/completions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + + export interface Params$Resource$Endpoints$Chat$Completions + extends StandardParameters { + /** + * Required. The name of the endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; /** - * Gets a DataLabelingJob. + * Request body metadata + */ + requestBody?: Schema$GoogleApiHttpBody; + } + + export class Resource$Endpoints$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -31726,33 +31805,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.dataLabelingJobs.get({ - * // Required. The name of the DataLabelingJob. Format: `projects/{project\}/locations/{location\}/dataLabelingJobs/{data_labeling_job\}` - * name: 'projects/my-project/locations/my-location/dataLabelingJobs/my-dataLabelingJob', + * const res = await aiplatform.endpoints.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'endpoints/my-endpoint/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "activeLearningConfig": {}, - * // "annotationLabels": {}, - * // "createTime": "my_createTime", - * // "currentSpend": {}, - * // "datasets": [], - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "error": {}, - * // "inputs": {}, - * // "inputsSchemaUri": "my_inputsSchemaUri", - * // "instructionUri": "my_instructionUri", - * // "labelerCount": 0, - * // "labelingProgress": 0, - * // "labels": {}, - * // "name": "my_name", - * // "specialistPools": [], - * // "state": "my_state", - * // "updateTime": "my_updateTime" - * // } + * // {} * } * * main().catch(e => { @@ -31767,61 +31827,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Get, + cancel( + params: Params$Resource$Endpoints$Operations$Cancel, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Datalabelingjobs$Get, + cancel( + params?: Params$Resource$Endpoints$Operations$Cancel, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Get, + ): Promise>; + cancel( + params: Params$Resource$Endpoints$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Get, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Endpoints$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Endpoints$Operations$Cancel, + callback: BodyResponseCallback ): void; - get( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datalabelingjobs$Get - | BodyResponseCallback + | Params$Resource$Endpoints$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Get; + {}) as Params$Resource$Endpoints$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datalabelingjobs$Get; + params = {} as Params$Resource$Endpoints$Operations$Cancel; options = {}; } @@ -31834,8 +31886,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -31846,19 +31898,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists DataLabelingJobs in a Location. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -31887,376 +31937,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.dataLabelingJobs.list({ - * // The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` - * filter: 'placeholder-value', - * // A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. - * orderBy: 'placeholder-value', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // Required. The parent of the DataLabelingJob. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * // Mask specifying which fields to read. FieldMask represents a set of symbolic field paths. For example, the mask can be `paths: "name"`. The "name" here is a field in DataLabelingJob. If this field is not set, all fields of the DataLabelingJob are returned. - * readMask: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "dataLabelingJobs": [], - * // "nextPageToken": "my_nextPageToken" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - list( - params: Params$Resource$Projects$Locations$Datalabelingjobs$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Datalabelingjobs$List, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Datalabelingjobs$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Datalabelingjobs$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Datalabelingjobs$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datalabelingjobs$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datalabelingjobs$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datalabelingjobs$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/dataLabelingJobs').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Datalabelingjobs$Cancel - extends StandardParameters { - /** - * Required. The name of the DataLabelingJob. Format: `projects/{project\}/locations/{location\}/dataLabelingJobs/{data_labeling_job\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1CancelDataLabelingJobRequest; - } - export interface Params$Resource$Projects$Locations$Datalabelingjobs$Create - extends StandardParameters { - /** - * Required. The parent of the DataLabelingJob. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1DataLabelingJob; - } - export interface Params$Resource$Projects$Locations$Datalabelingjobs$Delete - extends StandardParameters { - /** - * Required. The name of the DataLabelingJob to be deleted. Format: `projects/{project\}/locations/{location\}/dataLabelingJobs/{data_labeling_job\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datalabelingjobs$Get - extends StandardParameters { - /** - * Required. The name of the DataLabelingJob. Format: `projects/{project\}/locations/{location\}/dataLabelingJobs/{data_labeling_job\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datalabelingjobs$List - extends StandardParameters { - /** - * The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` - */ - filter?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. - */ - orderBy?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * Required. The parent of the DataLabelingJob. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. FieldMask represents a set of symbolic field paths. For example, the mask can be `paths: "name"`. The "name" here is a field in DataLabelingJob. If this field is not set, all fields of the DataLabelingJob are returned. - */ - readMask?: string; - } - - export class Resource$Projects$Locations$Datalabelingjobs$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const aiplatform = google.aiplatform('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await aiplatform.projects.locations.dataLabelingJobs.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/dataLabelingJobs/my-dataLabelingJob/operations/my-operation', - * }); - * console.log(res.data); - * - * // Example response - * // {} - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - cancel( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel, - options: StreamMethodOptions - ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel, - options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - cancel( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - cancel( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel, - callback: BodyResponseCallback - ): void; - cancel(callback: BodyResponseCallback): void; - cancel( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const aiplatform = google.aiplatform('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * const res = await aiplatform.endpoints.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'endpoints/my-endpoint/operations/my-operation', * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await aiplatform.projects.locations.dataLabelingJobs.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/dataLabelingJobs/my-dataLabelingJob/operations/my-operation', - * }); * console.log(res.data); * * // Example response @@ -32276,31 +31960,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete, + params: Params$Resource$Endpoints$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete, + params?: Params$Resource$Endpoints$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete, + params: Params$Resource$Endpoints$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete, + params: Params$Resource$Endpoints$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete, + params: Params$Resource$Endpoints$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete + | Params$Resource$Endpoints$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -32316,13 +32000,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete; + {}) as Params$Resource$Endpoints$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete; + params = {} as Params$Resource$Endpoints$Operations$Delete; options = {}; } @@ -32386,11 +32069,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.dataLabelingJobs.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/dataLabelingJobs/my-dataLabelingJob/operations/my-operation', - * }); + * const res = await aiplatform.endpoints.operations.get({ + * // The name of the operation resource. + * name: 'endpoints/my-endpoint/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -32416,27 +32098,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get, + params: Params$Resource$Endpoints$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get, + params?: Params$Resource$Endpoints$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get, + params: Params$Resource$Endpoints$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get, + params: Params$Resource$Endpoints$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get, + params: Params$Resource$Endpoints$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -32444,7 +32126,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get + | Params$Resource$Endpoints$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -32460,13 +32142,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get; + {}) as Params$Resource$Endpoints$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get; + params = {} as Params$Resource$Endpoints$Operations$Get; options = {}; } @@ -32530,19 +32211,18 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.dataLabelingJobs.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/dataLabelingJobs/my-dataLabelingJob', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * const res = await aiplatform.endpoints.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'endpoints/my-endpoint', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -32566,29 +32246,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List, + params: Params$Resource$Endpoints$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List, + params?: Params$Resource$Endpoints$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List, + params: Params$Resource$Endpoints$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List, + params: Params$Resource$Endpoints$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List, + params: Params$Resource$Endpoints$Operations$List, callback: BodyResponseCallback ): void; list( @@ -32596,7 +32276,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List + | Params$Resource$Endpoints$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -32614,13 +32294,12 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List; + {}) as Params$Resource$Endpoints$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List; + params = {} as Params$Resource$Endpoints$Operations$List; options = {}; } @@ -32689,13 +32368,12 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.dataLabelingJobs.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/dataLabelingJobs/my-dataLabelingJob/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); + * const res = await aiplatform.endpoints.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'endpoints/my-endpoint/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -32721,27 +32399,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait, + params: Params$Resource$Endpoints$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait, + params?: Params$Resource$Endpoints$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait, + params: Params$Resource$Endpoints$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait, + params: Params$Resource$Endpoints$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait, + params: Params$Resource$Endpoints$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -32749,7 +32427,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait + | Params$Resource$Endpoints$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -32765,13 +32443,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait; + {}) as Params$Resource$Endpoints$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait; + params = {} as Params$Resource$Endpoints$Operations$Wait; options = {}; } @@ -32806,28 +32483,28 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel + export interface Params$Resource$Endpoints$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete + export interface Params$Resource$Endpoints$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get + export interface Params$Resource$Endpoints$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List + export interface Params$Resource$Endpoints$Operations$List extends StandardParameters { /** * The standard list filter. @@ -32850,7 +32527,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait + export interface Params$Resource$Endpoints$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -32862,32 +32539,36 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Datasets { + export class Resource$Featuregroups { context: APIRequestContext; - annotationSpecs: Resource$Projects$Locations$Datasets$Annotationspecs; - dataItems: Resource$Projects$Locations$Datasets$Dataitems; - datasetVersions: Resource$Projects$Locations$Datasets$Datasetversions; - operations: Resource$Projects$Locations$Datasets$Operations; - savedQueries: Resource$Projects$Locations$Datasets$Savedqueries; + features: Resource$Featuregroups$Features; + operations: Resource$Featuregroups$Operations; constructor(context: APIRequestContext) { this.context = context; - this.annotationSpecs = - new Resource$Projects$Locations$Datasets$Annotationspecs(this.context); - this.dataItems = new Resource$Projects$Locations$Datasets$Dataitems( - this.context - ); - this.datasetVersions = - new Resource$Projects$Locations$Datasets$Datasetversions(this.context); - this.operations = new Resource$Projects$Locations$Datasets$Operations( - this.context - ); - this.savedQueries = new Resource$Projects$Locations$Datasets$Savedqueries( + this.features = new Resource$Featuregroups$Features(this.context); + this.operations = new Resource$Featuregroups$Operations(this.context); + } + } + + export class Resource$Featuregroups$Features { + context: APIRequestContext; + operations: Resource$Featuregroups$Features$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Featuregroups$Features$Operations( this.context ); } + } + + export class Resource$Featuregroups$Features$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Creates a Dataset. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -32916,32 +32597,141 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.datasets.create({ - * // Required. The resource name of the Location to create the Dataset in. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * const res = await aiplatform.featureGroups.features.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'featureGroups/my-featureGroup/features/my-feature/operations/my-operation', + * }); + * console.log(res.data); * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "dataItemCount": "my_dataItemCount", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, - * // "metadata": {}, - * // "metadataArtifact": "my_metadataArtifact", - * // "metadataSchemaUri": "my_metadataSchemaUri", - * // "modelReference": "my_modelReference", - * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "savedQueries": [], - * // "updateTime": "my_updateTime" - * // } - * }, + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Featuregroups$Features$Operations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Featuregroups$Features$Operations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Featuregroups$Features$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Featuregroups$Features$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Featuregroups$Features$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Featuregroups$Features$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Featuregroups$Features$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Featuregroups$Features$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.featureGroups.features.operations.get({ + * // The name of the operation resource. + * name: 'featureGroups/my-featureGroup/features/my-feature/operations/my-operation', * }); * console.log(res.data); * @@ -32967,36 +32757,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Datasets$Create, + get( + params: Params$Resource$Featuregroups$Features$Operations$Get, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Datasets$Create, + get( + params?: Params$Resource$Featuregroups$Features$Operations$Get, options?: MethodOptions ): Promise>; - create( - params: Params$Resource$Projects$Locations$Datasets$Create, + get( + params: Params$Resource$Featuregroups$Features$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datasets$Create, + get( + params: Params$Resource$Featuregroups$Features$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datasets$Create, + get( + params: Params$Resource$Featuregroups$Features$Operations$Get, callback: BodyResponseCallback ): void; - create( + get( callback: BodyResponseCallback ): void; - create( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Create + | Params$Resource$Featuregroups$Features$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -33012,12 +32802,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Create; + {}) as Params$Resource$Featuregroups$Features$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Create; + params = {} as Params$Resource$Featuregroups$Features$Operations$Get; options = {}; } @@ -33030,18 +32820,15 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/datasets').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -33055,7 +32842,7 @@ export namespace aiplatform_v1 { } /** - * Deletes a Dataset. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -33084,19 +32871,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.datasets.delete({ - * // Required. The resource name of the Dataset to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - * name: 'projects/my-project/locations/my-location/datasets/my-dataset', + * const res = await aiplatform.featureGroups.features.operations.listWait({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'featureGroups/my-featureGroup/features/my-feature/operations/my-operation', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -33112,57 +32905,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Datasets$Delete, + listWait( + params: Params$Resource$Featuregroups$Features$Operations$Listwait, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Datasets$Delete, + listWait( + params?: Params$Resource$Featuregroups$Features$Operations$Listwait, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Datasets$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + listWait( + params: Params$Resource$Featuregroups$Features$Operations$Listwait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datasets$Delete, + listWait( + params: Params$Resource$Featuregroups$Features$Operations$Listwait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datasets$Delete, - callback: BodyResponseCallback + listWait( + params: Params$Resource$Featuregroups$Features$Operations$Listwait, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + listWait( + callback: BodyResponseCallback ): void; - delete( + listWait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Delete - | BodyResponseCallback + | Params$Resource$Featuregroups$Features$Operations$Listwait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Delete; + {}) as Params$Resource$Featuregroups$Features$Operations$Listwait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Delete; + params = + {} as Params$Resource$Featuregroups$Features$Operations$Listwait; options = {}; } @@ -33175,8 +32973,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -33187,17 +32985,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Exports data from a Dataset. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -33226,17 +33026,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.datasets.export({ - * // Required. The name of the Dataset resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - * name: 'projects/my-project/locations/my-location/datasets/my-dataset', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "exportConfig": {} - * // } - * }, + * const res = await aiplatform.featureGroups.features.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'featureGroups/my-featureGroup/features/my-feature/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * @@ -33262,36 +33056,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - export( - params: Params$Resource$Projects$Locations$Datasets$Export, + wait( + params: Params$Resource$Featuregroups$Features$Operations$Wait, options: StreamMethodOptions ): Promise>; - export( - params?: Params$Resource$Projects$Locations$Datasets$Export, + wait( + params?: Params$Resource$Featuregroups$Features$Operations$Wait, options?: MethodOptions ): Promise>; - export( - params: Params$Resource$Projects$Locations$Datasets$Export, + wait( + params: Params$Resource$Featuregroups$Features$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - export( - params: Params$Resource$Projects$Locations$Datasets$Export, + wait( + params: Params$Resource$Featuregroups$Features$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - export( - params: Params$Resource$Projects$Locations$Datasets$Export, + wait( + params: Params$Resource$Featuregroups$Features$Operations$Wait, callback: BodyResponseCallback ): void; - export( + wait( callback: BodyResponseCallback ): void; - export( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Export + | Params$Resource$Featuregroups$Features$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -33307,12 +33101,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Export; + {}) as Params$Resource$Featuregroups$Features$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Export; + params = {} as Params$Resource$Featuregroups$Features$Operations$Wait; options = {}; } @@ -33325,7 +33119,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:export').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -33345,9 +33139,65 @@ export namespace aiplatform_v1 { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Featuregroups$Features$Operations$Delete + extends StandardParameters { /** - * Gets a Dataset. + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Featuregroups$Features$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Featuregroups$Features$Operations$Listwait + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Featuregroups$Features$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Featuregroups$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -33376,33 +33226,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.datasets.get({ - * // Required. The name of the Dataset resource. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', + * const res = await aiplatform.featureGroups.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'featureGroups/my-featureGroup/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "createTime": "my_createTime", - * // "dataItemCount": "my_dataItemCount", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, - * // "metadata": {}, - * // "metadataArtifact": "my_metadataArtifact", - * // "metadataSchemaUri": "my_metadataSchemaUri", - * // "modelReference": "my_modelReference", - * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "savedQueries": [], - * // "updateTime": "my_updateTime" - * // } + * // {} * } * * main().catch(e => { @@ -33417,57 +33248,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datasets$Get, + delete( + params: Params$Resource$Featuregroups$Operations$Delete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Datasets$Get, + delete( + params?: Params$Resource$Featuregroups$Operations$Delete, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Datasets$Get, + ): Promise>; + delete( + params: Params$Resource$Featuregroups$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datasets$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Datasets$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Featuregroups$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + delete( + params: Params$Resource$Featuregroups$Operations$Delete, + callback: BodyResponseCallback ): void; - get( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Get - | BodyResponseCallback + | Params$Resource$Featuregroups$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Get; + {}) as Params$Resource$Featuregroups$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Get; + params = {} as Params$Resource$Featuregroups$Operations$Delete; options = {}; } @@ -33481,7 +33308,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -33492,19 +33319,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Imports data into a Dataset. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -33533,17 +33358,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.datasets.import({ - * // Required. The name of the Dataset resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - * name: 'projects/my-project/locations/my-location/datasets/my-dataset', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "importConfigs": [] - * // } - * }, + * const res = await aiplatform.featureGroups.operations.get({ + * // The name of the operation resource. + * name: 'featureGroups/my-featureGroup/operations/my-operation', * }); * console.log(res.data); * @@ -33569,36 +33386,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Datasets$Import, + get( + params: Params$Resource$Featuregroups$Operations$Get, options: StreamMethodOptions ): Promise>; - import( - params?: Params$Resource$Projects$Locations$Datasets$Import, + get( + params?: Params$Resource$Featuregroups$Operations$Get, options?: MethodOptions ): Promise>; - import( - params: Params$Resource$Projects$Locations$Datasets$Import, + get( + params: Params$Resource$Featuregroups$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datasets$Import, + get( + params: Params$Resource$Featuregroups$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datasets$Import, + get( + params: Params$Resource$Featuregroups$Operations$Get, callback: BodyResponseCallback ): void; - import( + get( callback: BodyResponseCallback ): void; - import( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Import + | Params$Resource$Featuregroups$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -33614,12 +33431,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Import; + {}) as Params$Resource$Featuregroups$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Import; + params = {} as Params$Resource$Featuregroups$Operations$Get; options = {}; } @@ -33632,8 +33449,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:import').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -33654,7 +33471,7 @@ export namespace aiplatform_v1 { } /** - * Lists Datasets in a Location. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -33683,26 +33500,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.datasets.list({ - * // An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `display_name`: supports = and != * `metadata_schema_uri`: supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. Some examples: * `displayName="myDisplayName"` * `labels.myKey="myValue"` + * const res = await aiplatform.featureGroups.operations.listWait({ + * // The standard list filter. * filter: 'placeholder-value', - * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` - * orderBy: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'featureGroups/my-featureGroup/operations/my-operation', * // The standard list page size. * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', - * // Required. The name of the Dataset's parent resource. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "datasets": [], - * // "nextPageToken": "my_nextPageToken" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -33718,61 +33534,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datasets$List, + listWait( + params: Params$Resource$Featuregroups$Operations$Listwait, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Datasets$List, + listWait( + params?: Params$Resource$Featuregroups$Operations$Listwait, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Datasets$List, + listWait( + params: Params$Resource$Featuregroups$Operations$Listwait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$List, + listWait( + params: Params$Resource$Featuregroups$Operations$Listwait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$List, - callback: BodyResponseCallback + listWait( + params: Params$Resource$Featuregroups$Operations$Listwait, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + listWait( + callback: BodyResponseCallback ): void; - list( + listWait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$List - | BodyResponseCallback + | Params$Resource$Featuregroups$Operations$Listwait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$List; + {}) as Params$Resource$Featuregroups$Operations$Listwait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$List; + params = {} as Params$Resource$Featuregroups$Operations$Listwait; options = {}; } @@ -33785,34 +33601,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/datasets').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a Dataset. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -33841,55 +33654,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.datasets.patch({ - * // Output only. Identifier. The resource name of the Dataset. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - * name: 'projects/my-project/locations/my-location/datasets/my-dataset', - * // Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` * `description` * `labels` - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "dataItemCount": "my_dataItemCount", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, - * // "metadata": {}, - * // "metadataArtifact": "my_metadataArtifact", - * // "metadataSchemaUri": "my_metadataSchemaUri", - * // "modelReference": "my_modelReference", - * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "savedQueries": [], - * // "updateTime": "my_updateTime" - * // } - * }, - * }); - * console.log(res.data); + * const res = await aiplatform.featureGroups.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'featureGroups/my-featureGroup/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); + * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "dataItemCount": "my_dataItemCount", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, + * // "done": false, + * // "error": {}, * // "metadata": {}, - * // "metadataArtifact": "my_metadataArtifact", - * // "metadataSchemaUri": "my_metadataSchemaUri", - * // "modelReference": "my_modelReference", * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "savedQueries": [], - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -33905,57 +33684,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Datasets$Patch, + wait( + params: Params$Resource$Featuregroups$Operations$Wait, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Datasets$Patch, + wait( + params?: Params$Resource$Featuregroups$Operations$Wait, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Datasets$Patch, + ): Promise>; + wait( + params: Params$Resource$Featuregroups$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datasets$Patch, + wait( + params: Params$Resource$Featuregroups$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datasets$Patch, - callback: BodyResponseCallback + wait( + params: Params$Resource$Featuregroups$Operations$Wait, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - patch( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Patch - | BodyResponseCallback + | Params$Resource$Featuregroups$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Patch; + {}) as Params$Resource$Featuregroups$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Patch; + params = {} as Params$Resource$Featuregroups$Operations$Wait; options = {}; } @@ -33968,8 +33747,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -33980,19 +33759,98 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Featuregroups$Operations$Delete + extends StandardParameters { /** - * Searches DataItems in a Dataset. + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Featuregroups$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Featuregroups$Operations$Listwait + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Featuregroups$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Featureonlinestores { + context: APIRequestContext; + featureViews: Resource$Featureonlinestores$Featureviews; + operations: Resource$Featureonlinestores$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.featureViews = new Resource$Featureonlinestores$Featureviews( + this.context + ); + this.operations = new Resource$Featureonlinestores$Operations( + this.context + ); + } + } + + export class Resource$Featureonlinestores$Featureviews { + context: APIRequestContext; + operations: Resource$Featureonlinestores$Featureviews$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Featureonlinestores$Featureviews$Operations(this.context); + } + } + + export class Resource$Featureonlinestores$Featureviews$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -34021,43 +33879,15 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.datasets.searchDataItems({ - * // An expression that specifies what Annotations will be returned per DataItem. Annotations satisfied either of the conditions will be returned. * `annotation_spec_id` - for = or !=. Must specify `saved_query_id=` - saved query id that annotations should belong to. - * annotationFilters: 'placeholder-value', - * // An expression for filtering the Annotations that will be returned per DataItem. * `annotation_spec_id` - for = or !=. - * annotationsFilter: 'placeholder-value', - * // If set, only up to this many of Annotations will be returned per DataItemView. The maximum value is 1000. If not set, the maximum value will be used. - * annotationsLimit: 'placeholder-value', - * // An expression for filtering the DataItem that will be returned. * `data_item_id` - for = or !=. * `labeled` - for = or !=. * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that have at least one annotation with annotation_spec_id = `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob. For example: * `data_item=1` * `has_annotation(5)` - * dataItemFilter: 'placeholder-value', - * // The resource name of a DataLabelingJob. Format: `projects/{project\}/locations/{location\}/dataLabelingJobs/{data_labeling_job\}` If this field is set, all of the search will be done in the context of this DataLabelingJob. - * dataLabelingJob: 'placeholder-value', - * // Required. The resource name of the Dataset from which to search DataItems. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - * dataset: 'projects/my-project/locations/my-location/datasets/my-dataset', - * // Mask specifying which fields of DataItemView to read. - * fieldMask: 'placeholder-value', - * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. - * orderBy: 'placeholder-value', - * // A comma-separated list of annotation fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Must also specify saved_query. - * 'orderByAnnotation.orderBy': 'placeholder-value', - * // Required. Saved query of the Annotation. Only Annotations belong to this saved query will be considered for ordering. - * 'orderByAnnotation.savedQuery': 'placeholder-value', - * // A comma-separated list of data item fields to order by, sorted in ascending order. Use "desc" after a field name for descending. - * orderByDataItem: 'placeholder-value', - * // Requested page size. Server may return fewer results than requested. Default and maximum page size is 100. - * pageSize: 'placeholder-value', - * // A token identifying a page of results for the server to return Typically obtained via SearchDataItemsResponse.next_page_token of the previous DatasetService.SearchDataItems call. - * pageToken: 'placeholder-value', - * // The resource name of a SavedQuery(annotation set in UI). Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/savedQueries/{saved_query\}` All of the search will be done in the context of this SavedQuery. - * savedQuery: 'placeholder-value', - * }); + * const res = + * await aiplatform.featureOnlineStores.featureViews.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "dataItemViews": [], - * // "nextPageToken": "my_nextPageToken" - * // } + * // {} * } * * main().catch(e => { @@ -34072,62 +33902,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - searchDataItems( - params: Params$Resource$Projects$Locations$Datasets$Searchdataitems, + delete( + params: Params$Resource$Featureonlinestores$Featureviews$Operations$Delete, options: StreamMethodOptions ): Promise>; - searchDataItems( - params?: Params$Resource$Projects$Locations$Datasets$Searchdataitems, + delete( + params?: Params$Resource$Featureonlinestores$Featureviews$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - searchDataItems( - params: Params$Resource$Projects$Locations$Datasets$Searchdataitems, + ): Promise>; + delete( + params: Params$Resource$Featureonlinestores$Featureviews$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - searchDataItems( - params: Params$Resource$Projects$Locations$Datasets$Searchdataitems, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - searchDataItems( - params: Params$Resource$Projects$Locations$Datasets$Searchdataitems, - callback: BodyResponseCallback + delete( + params: Params$Resource$Featureonlinestores$Featureviews$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - searchDataItems( - callback: BodyResponseCallback + delete( + params: Params$Resource$Featureonlinestores$Featureviews$Operations$Delete, + callback: BodyResponseCallback ): void; - searchDataItems( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Searchdataitems - | BodyResponseCallback + | Params$Resource$Featureonlinestores$Featureviews$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Searchdataitems; + {}) as Params$Resource$Featureonlinestores$Featureviews$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Searchdataitems; + {} as Params$Resource$Featureonlinestores$Featureviews$Operations$Delete; options = {}; } @@ -34140,203 +33962,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+dataset}:searchDataItems').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['dataset'], - pathParams: ['dataset'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Datasets$Create - extends StandardParameters { - /** - * Required. The resource name of the Location to create the Dataset in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Dataset; - } - export interface Params$Resource$Projects$Locations$Datasets$Delete - extends StandardParameters { - /** - * Required. The resource name of the Dataset to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Export - extends StandardParameters { - /** - * Required. The name of the Dataset resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ExportDataRequest; - } - export interface Params$Resource$Projects$Locations$Datasets$Get - extends StandardParameters { - /** - * Required. The name of the Dataset resource. - */ - name?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Import - extends StandardParameters { - /** - * Required. The name of the Dataset resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ImportDataRequest; - } - export interface Params$Resource$Projects$Locations$Datasets$List - extends StandardParameters { - /** - * An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `display_name`: supports = and != * `metadata_schema_uri`: supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. Some examples: * `displayName="myDisplayName"` * `labels.myKey="myValue"` - */ - filter?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` - */ - orderBy?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * Required. The name of the Dataset's parent resource. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Patch - extends StandardParameters { - /** - * Output only. Identifier. The resource name of the Dataset. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - */ - name?: string; - /** - * Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` * `description` * `labels` - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Dataset; - } - export interface Params$Resource$Projects$Locations$Datasets$Searchdataitems - extends StandardParameters { - /** - * An expression that specifies what Annotations will be returned per DataItem. Annotations satisfied either of the conditions will be returned. * `annotation_spec_id` - for = or !=. Must specify `saved_query_id=` - saved query id that annotations should belong to. - */ - annotationFilters?: string[]; - /** - * An expression for filtering the Annotations that will be returned per DataItem. * `annotation_spec_id` - for = or !=. - */ - annotationsFilter?: string; - /** - * If set, only up to this many of Annotations will be returned per DataItemView. The maximum value is 1000. If not set, the maximum value will be used. - */ - annotationsLimit?: number; - /** - * An expression for filtering the DataItem that will be returned. * `data_item_id` - for = or !=. * `labeled` - for = or !=. * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that have at least one annotation with annotation_spec_id = `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob. For example: * `data_item=1` * `has_annotation(5)` - */ - dataItemFilter?: string; - /** - * The resource name of a DataLabelingJob. Format: `projects/{project\}/locations/{location\}/dataLabelingJobs/{data_labeling_job\}` If this field is set, all of the search will be done in the context of this DataLabelingJob. - */ - dataLabelingJob?: string; - /** - * Required. The resource name of the Dataset from which to search DataItems. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - */ - dataset?: string; - /** - * Mask specifying which fields of DataItemView to read. - */ - fieldMask?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. - */ - orderBy?: string; - /** - * A comma-separated list of annotation fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Must also specify saved_query. - */ - 'orderByAnnotation.orderBy'?: string; - /** - * Required. Saved query of the Annotation. Only Annotations belong to this saved query will be considered for ordering. - */ - 'orderByAnnotation.savedQuery'?: string; - /** - * A comma-separated list of data item fields to order by, sorted in ascending order. Use "desc" after a field name for descending. - */ - orderByDataItem?: string; - /** - * Requested page size. Server may return fewer results than requested. Default and maximum page size is 100. - */ - pageSize?: number; - /** - * A token identifying a page of results for the server to return Typically obtained via SearchDataItemsResponse.next_page_token of the previous DatasetService.SearchDataItems call. - */ - pageToken?: string; - /** - * The resource name of a SavedQuery(annotation set in UI). Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/savedQueries/{saved_query\}` All of the search will be done in the context of this SavedQuery. - */ - savedQuery?: string; - } - - export class Resource$Projects$Locations$Datasets$Annotationspecs { - context: APIRequestContext; - operations: Resource$Projects$Locations$Datasets$Annotationspecs$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Datasets$Annotationspecs$Operations( - this.context - ); - } /** - * Gets an AnnotationSpec. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -34365,21 +34013,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.datasets.annotationSpecs.get({ - * // Required. The name of the AnnotationSpec resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/annotationSpecs/{annotation_spec\}` - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/annotationSpecs/my-annotationSpec', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', + * const res = await aiplatform.featureOnlineStores.featureViews.operations.get({ + * // The name of the operation resource. + * name: 'featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView/operations/my-operation', * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "etag": "my_etag", + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -34396,61 +34042,57 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get, + params: Params$Resource$Featureonlinestores$Featureviews$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get, + params?: Params$Resource$Featureonlinestores$Featureviews$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; + ): Promise>; get( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get, + params: Params$Resource$Featureonlinestores$Featureviews$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get, + params: Params$Resource$Featureonlinestores$Featureviews$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get, - callback: BodyResponseCallback + params: Params$Resource$Featureonlinestores$Featureviews$Operations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get - | BodyResponseCallback + | Params$Resource$Featureonlinestores$Featureviews$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get; + {}) as Params$Resource$Featureonlinestores$Featureviews$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get; + {} as Params$Resource$Featureonlinestores$Featureviews$Operations$Get; options = {}; } @@ -34475,38 +34117,173 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - export interface Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get - extends StandardParameters { - /** - * Required. The name of the AnnotationSpec resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/annotationSpecs/{annotation_spec\}` - */ - name?: string; /** - * Mask specifying which fields to read. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.featureOnlineStores.featureViews.operations.listWait({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView/operations/my-operation', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. */ - readMask?: string; - } + listWait( + params: Params$Resource$Featureonlinestores$Featureviews$Operations$Listwait, + options: StreamMethodOptions + ): Promise>; + listWait( + params?: Params$Resource$Featureonlinestores$Featureviews$Operations$Listwait, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + listWait( + params: Params$Resource$Featureonlinestores$Featureviews$Operations$Listwait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listWait( + params: Params$Resource$Featureonlinestores$Featureviews$Operations$Listwait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listWait( + params: Params$Resource$Featureonlinestores$Featureviews$Operations$Listwait, + callback: BodyResponseCallback + ): void; + listWait( + callback: BodyResponseCallback + ): void; + listWait( + paramsOrCallback?: + | Params$Resource$Featureonlinestores$Featureviews$Operations$Listwait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Featureonlinestores$Featureviews$Operations$Listwait; + let options = (optionsOrCallback || {}) as MethodOptions; - export class Resource$Projects$Locations$Datasets$Annotationspecs$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Featureonlinestores$Featureviews$Operations$Listwait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -34535,17 +34312,24 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.datasets.annotationSpecs.operations.cancel( - * { - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/annotationSpecs/my-annotationSpec/operations/my-operation', - * }, - * ); + * const res = await aiplatform.featureOnlineStores.featureViews.operations.wait( + * { + * // The name of the operation resource to wait on. + * name: 'featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -34560,54 +34344,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel, + wait( + params: Params$Resource$Featureonlinestores$Featureviews$Operations$Wait, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel, + wait( + params?: Params$Resource$Featureonlinestores$Featureviews$Operations$Wait, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel, + ): Promise>; + wait( + params: Params$Resource$Featureonlinestores$Featureviews$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + wait( + params: Params$Resource$Featureonlinestores$Featureviews$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel, - callback: BodyResponseCallback + wait( + params: Params$Resource$Featureonlinestores$Featureviews$Operations$Wait, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + wait( + callback: BodyResponseCallback + ): void; + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Featureonlinestores$Featureviews$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel; + {}) as Params$Resource$Featureonlinestores$Featureviews$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel; + {} as Params$Resource$Featureonlinestores$Featureviews$Operations$Wait; options = {}; } @@ -34620,7 +34408,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -34632,14 +34420,70 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + + export interface Params$Resource$Featureonlinestores$Featureviews$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Featureonlinestores$Featureviews$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Featureonlinestores$Featureviews$Operations$Listwait + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Featureonlinestores$Featureviews$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Featureonlinestores$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. @@ -34671,13 +34515,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.datasets.annotationSpecs.operations.delete( - * { - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/annotationSpecs/my-annotationSpec/operations/my-operation', - * }, - * ); + * const res = await aiplatform.featureOnlineStores.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'featureOnlineStores/my-featureOnlineStore/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -34697,31 +34538,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete, + params: Params$Resource$Featureonlinestores$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete, + params?: Params$Resource$Featureonlinestores$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete, + params: Params$Resource$Featureonlinestores$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete, + params: Params$Resource$Featureonlinestores$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete, + params: Params$Resource$Featureonlinestores$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete + | Params$Resource$Featureonlinestores$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -34737,13 +34578,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete; + {}) as Params$Resource$Featureonlinestores$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete; + params = {} as Params$Resource$Featureonlinestores$Operations$Delete; options = {}; } @@ -34807,13 +34647,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.datasets.annotationSpecs.operations.get( - * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/annotationSpecs/my-annotationSpec/operations/my-operation', - * }, - * ); + * const res = await aiplatform.featureOnlineStores.operations.get({ + * // The name of the operation resource. + * name: 'featureOnlineStores/my-featureOnlineStore/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -34839,27 +34676,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get, + params: Params$Resource$Featureonlinestores$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get, + params?: Params$Resource$Featureonlinestores$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get, + params: Params$Resource$Featureonlinestores$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get, + params: Params$Resource$Featureonlinestores$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get, + params: Params$Resource$Featureonlinestores$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -34867,7 +34704,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get + | Params$Resource$Featureonlinestores$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -34883,13 +34720,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get; + {}) as Params$Resource$Featureonlinestores$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get; + params = {} as Params$Resource$Featureonlinestores$Operations$Get; options = {}; } @@ -34953,21 +34789,18 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.datasets.annotationSpecs.operations.list( - * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/annotationSpecs/my-annotationSpec', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.featureOnlineStores.operations.listWait({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'featureOnlineStores/my-featureOnlineStore/operations/my-operation', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -34990,38 +34823,38 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List, + listWait( + params: Params$Resource$Featureonlinestores$Operations$Listwait, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List, + listWait( + params?: Params$Resource$Featureonlinestores$Operations$Listwait, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List, + listWait( + params: Params$Resource$Featureonlinestores$Operations$Listwait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List, + listWait( + params: Params$Resource$Featureonlinestores$Operations$Listwait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List, + listWait( + params: Params$Resource$Featureonlinestores$Operations$Listwait, callback: BodyResponseCallback ): void; - list( + listWait( callback: BodyResponseCallback ): void; - list( + listWait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List + | Params$Resource$Featureonlinestores$Operations$Listwait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -35039,13 +34872,12 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List; + {}) as Params$Resource$Featureonlinestores$Operations$Listwait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List; + params = {} as Params$Resource$Featureonlinestores$Operations$Listwait; options = {}; } @@ -35058,10 +34890,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -35114,15 +34943,12 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.datasets.annotationSpecs.operations.wait( - * { - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/annotationSpecs/my-annotationSpec/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.featureOnlineStores.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'featureOnlineStores/my-featureOnlineStore/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -35148,27 +34974,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait, + params: Params$Resource$Featureonlinestores$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait, + params?: Params$Resource$Featureonlinestores$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait, + params: Params$Resource$Featureonlinestores$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait, + params: Params$Resource$Featureonlinestores$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait, + params: Params$Resource$Featureonlinestores$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -35176,7 +35002,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait + | Params$Resource$Featureonlinestores$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -35192,13 +35018,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait; + {}) as Params$Resource$Featureonlinestores$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait; + params = {} as Params$Resource$Featureonlinestores$Operations$Wait; options = {}; } @@ -35233,28 +35058,21 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel - extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete + export interface Params$Resource$Featureonlinestores$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get + export interface Params$Resource$Featureonlinestores$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List + export interface Params$Resource$Featureonlinestores$Operations$Listwait extends StandardParameters { /** * The standard list filter. @@ -35277,7 +35095,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait + export interface Params$Resource$Featureonlinestores$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -35289,24 +35107,52 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Datasets$Dataitems { + export class Resource$Featurestores { context: APIRequestContext; - annotations: Resource$Projects$Locations$Datasets$Dataitems$Annotations; - operations: Resource$Projects$Locations$Datasets$Dataitems$Operations; + entityTypes: Resource$Featurestores$Entitytypes; + operations: Resource$Featurestores$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.entityTypes = new Resource$Featurestores$Entitytypes(this.context); + this.operations = new Resource$Featurestores$Operations(this.context); + } + } + + export class Resource$Featurestores$Entitytypes { + context: APIRequestContext; + features: Resource$Featurestores$Entitytypes$Features; + operations: Resource$Featurestores$Entitytypes$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.features = new Resource$Featurestores$Entitytypes$Features( + this.context + ); + this.operations = new Resource$Featurestores$Entitytypes$Operations( + this.context + ); + } + } + + export class Resource$Featurestores$Entitytypes$Features { + context: APIRequestContext; + operations: Resource$Featurestores$Entitytypes$Features$Operations; constructor(context: APIRequestContext) { this.context = context; - this.annotations = - new Resource$Projects$Locations$Datasets$Dataitems$Annotations( - this.context - ); this.operations = - new Resource$Projects$Locations$Datasets$Dataitems$Operations( + new Resource$Featurestores$Entitytypes$Features$Operations( this.context ); } + } + + export class Resource$Featurestores$Entitytypes$Features$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Lists DataItems in a Dataset. + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -35335,27 +35181,15 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.datasets.dataItems.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. - * orderBy: 'placeholder-value', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Dataset to list DataItems from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - * parent: 'projects/my-project/locations/my-location/datasets/my-dataset', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', - * }); + * const res = + * await aiplatform.featurestores.entityTypes.features.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'featurestores/my-featurestore/entityTypes/my-entityType/features/my-feature/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "dataItems": [], - * // "nextPageToken": "my_nextPageToken" - * // } + * // {} * } * * main().catch(e => { @@ -35370,62 +35204,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$List, + cancel( + params: Params$Resource$Featurestores$Entitytypes$Features$Operations$Cancel, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Datasets$Dataitems$List, + cancel( + params?: Params$Resource$Featurestores$Entitytypes$Features$Operations$Cancel, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$List, + ): Promise>; + cancel( + params: Params$Resource$Featurestores$Entitytypes$Features$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$List, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Featurestores$Entitytypes$Features$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Featurestores$Entitytypes$Features$Operations$Cancel, + callback: BodyResponseCallback ): void; - list( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dataitems$List - | BodyResponseCallback + | Params$Resource$Featurestores$Entitytypes$Features$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$List; + {}) as Params$Resource$Featurestores$Entitytypes$Features$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Dataitems$List; + {} as Params$Resource$Featurestores$Entitytypes$Features$Operations$Cancel; options = {}; } @@ -35438,401 +35264,24 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/dataItems').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Datasets$Dataitems$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. - */ - orderBy?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * Required. The resource name of the Dataset to list DataItems from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; - } - - export class Resource$Projects$Locations$Datasets$Dataitems$Annotations { - context: APIRequestContext; - operations: Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations( - this.context - ); - } - - /** - * Lists Annotations belongs to a dataitem. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const aiplatform = google.aiplatform('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await aiplatform.projects.locations.datasets.dataItems.annotations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. - * orderBy: 'placeholder-value', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // Required. The resource name of the DataItem to list Annotations from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/dataItems/{data_item\}` - * parent: - * 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "annotations": [], - * // "nextPageToken": "my_nextPageToken" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/annotations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. - */ - orderBy?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * Required. The resource name of the DataItem to list Annotations from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/dataItems/{data_item\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; - } - - export class Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const aiplatform = google.aiplatform('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await aiplatform.projects.locations.datasets.dataItems.annotations.operations.cancel( - * { - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem/annotations/my-annotation/operations/my-operation', - * }, - * ); - * console.log(res.data); - * - * // Example response - * // {} - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - cancel( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel, - options: StreamMethodOptions - ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel, - options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - cancel( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - cancel( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel, - callback: BodyResponseCallback - ): void; - cancel(callback: BodyResponseCallback): void; - cancel( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } @@ -35867,12 +35316,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.datasets.dataItems.annotations.operations.delete( - * { - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem/annotations/my-annotation/operations/my-operation', - * }, - * ); + * await aiplatform.featurestores.entityTypes.features.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'featurestores/my-featurestore/entityTypes/my-entityType/features/my-feature/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -35892,31 +35339,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete, + params: Params$Resource$Featurestores$Entitytypes$Features$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete, + params?: Params$Resource$Featurestores$Entitytypes$Features$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete, + params: Params$Resource$Featurestores$Entitytypes$Features$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete, + params: Params$Resource$Featurestores$Entitytypes$Features$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete, + params: Params$Resource$Featurestores$Entitytypes$Features$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete + | Params$Resource$Featurestores$Entitytypes$Features$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -35932,13 +35379,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete; + {}) as Params$Resource$Featurestores$Entitytypes$Features$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete; + {} as Params$Resource$Featurestores$Entitytypes$Features$Operations$Delete; options = {}; } @@ -36003,12 +35450,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.datasets.dataItems.annotations.operations.get( - * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem/annotations/my-annotation/operations/my-operation', - * }, - * ); + * await aiplatform.featurestores.entityTypes.features.operations.get({ + * // The name of the operation resource. + * name: 'featurestores/my-featurestore/entityTypes/my-entityType/features/my-feature/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -36034,27 +35479,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get, + params: Params$Resource$Featurestores$Entitytypes$Features$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get, + params?: Params$Resource$Featurestores$Entitytypes$Features$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get, + params: Params$Resource$Featurestores$Entitytypes$Features$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get, + params: Params$Resource$Featurestores$Entitytypes$Features$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get, + params: Params$Resource$Featurestores$Entitytypes$Features$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -36062,7 +35507,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get + | Params$Resource$Featurestores$Entitytypes$Features$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -36078,13 +35523,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get; + {}) as Params$Resource$Featurestores$Entitytypes$Features$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get; + {} as Params$Resource$Featurestores$Entitytypes$Features$Operations$Get; options = {}; } @@ -36149,20 +35594,18 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.datasets.dataItems.annotations.operations.list( - * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem/annotations/my-annotation', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }, - * ); + * await aiplatform.featurestores.entityTypes.features.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'featurestores/my-featurestore/entityTypes/my-entityType/features/my-feature', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -36186,29 +35629,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List, + params: Params$Resource$Featurestores$Entitytypes$Features$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List, + params?: Params$Resource$Featurestores$Entitytypes$Features$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List, + params: Params$Resource$Featurestores$Entitytypes$Features$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List, + params: Params$Resource$Featurestores$Entitytypes$Features$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List, + params: Params$Resource$Featurestores$Entitytypes$Features$Operations$List, callback: BodyResponseCallback ): void; list( @@ -36216,7 +35659,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List + | Params$Resource$Featurestores$Entitytypes$Features$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -36234,13 +35677,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List; + {}) as Params$Resource$Featurestores$Entitytypes$Features$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List; + {} as Params$Resource$Featurestores$Entitytypes$Features$Operations$List; options = {}; } @@ -36310,14 +35753,12 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.datasets.dataItems.annotations.operations.wait( - * { - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem/annotations/my-annotation/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }, - * ); + * await aiplatform.featurestores.entityTypes.features.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'featurestores/my-featurestore/entityTypes/my-entityType/features/my-feature/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -36343,27 +35784,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait, + params: Params$Resource$Featurestores$Entitytypes$Features$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait, + params?: Params$Resource$Featurestores$Entitytypes$Features$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait, + params: Params$Resource$Featurestores$Entitytypes$Features$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait, + params: Params$Resource$Featurestores$Entitytypes$Features$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait, + params: Params$Resource$Featurestores$Entitytypes$Features$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -36371,7 +35812,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait + | Params$Resource$Featurestores$Entitytypes$Features$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -36387,13 +35828,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait; + {}) as Params$Resource$Featurestores$Entitytypes$Features$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait; + {} as Params$Resource$Featurestores$Entitytypes$Features$Operations$Wait; options = {}; } @@ -36428,28 +35869,28 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel + export interface Params$Resource$Featurestores$Entitytypes$Features$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete + export interface Params$Resource$Featurestores$Entitytypes$Features$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get + export interface Params$Resource$Featurestores$Entitytypes$Features$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List + export interface Params$Resource$Featurestores$Entitytypes$Features$Operations$List extends StandardParameters { /** * The standard list filter. @@ -36472,7 +35913,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait + export interface Params$Resource$Featurestores$Entitytypes$Features$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -36484,7 +35925,7 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Datasets$Dataitems$Operations { + export class Resource$Featurestores$Entitytypes$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -36520,11 +35961,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.datasets.dataItems.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem/operations/my-operation', - * }); + * const res = await aiplatform.featurestores.entityTypes.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'featurestores/my-featurestore/entityTypes/my-entityType/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -36544,31 +35984,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel, + params: Params$Resource$Featurestores$Entitytypes$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel, + params?: Params$Resource$Featurestores$Entitytypes$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel, + params: Params$Resource$Featurestores$Entitytypes$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel, + params: Params$Resource$Featurestores$Entitytypes$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel, + params: Params$Resource$Featurestores$Entitytypes$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel + | Params$Resource$Featurestores$Entitytypes$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -36584,13 +36024,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel; + {}) as Params$Resource$Featurestores$Entitytypes$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel; + {} as Params$Resource$Featurestores$Entitytypes$Operations$Cancel; options = {}; } @@ -36654,11 +36094,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.datasets.dataItems.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem/operations/my-operation', - * }); + * const res = await aiplatform.featurestores.entityTypes.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'featurestores/my-featurestore/entityTypes/my-entityType/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -36678,31 +36117,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete, + params: Params$Resource$Featurestores$Entitytypes$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete, + params?: Params$Resource$Featurestores$Entitytypes$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete, + params: Params$Resource$Featurestores$Entitytypes$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete, + params: Params$Resource$Featurestores$Entitytypes$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete, + params: Params$Resource$Featurestores$Entitytypes$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete + | Params$Resource$Featurestores$Entitytypes$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -36718,13 +36157,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete; + {}) as Params$Resource$Featurestores$Entitytypes$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete; + {} as Params$Resource$Featurestores$Entitytypes$Operations$Delete; options = {}; } @@ -36788,11 +36227,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.datasets.dataItems.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem/operations/my-operation', - * }); + * const res = await aiplatform.featurestores.entityTypes.operations.get({ + * // The name of the operation resource. + * name: 'featurestores/my-featurestore/entityTypes/my-entityType/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -36818,27 +36256,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get, + params: Params$Resource$Featurestores$Entitytypes$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get, + params?: Params$Resource$Featurestores$Entitytypes$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get, + params: Params$Resource$Featurestores$Entitytypes$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get, + params: Params$Resource$Featurestores$Entitytypes$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get, + params: Params$Resource$Featurestores$Entitytypes$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -36846,7 +36284,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get + | Params$Resource$Featurestores$Entitytypes$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -36862,13 +36300,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get; + {}) as Params$Resource$Featurestores$Entitytypes$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get; + params = {} as Params$Resource$Featurestores$Entitytypes$Operations$Get; options = {}; } @@ -36932,19 +36369,18 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.datasets.dataItems.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * const res = await aiplatform.featurestores.entityTypes.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'featurestores/my-featurestore/entityTypes/my-entityType', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -36968,29 +36404,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List, + params: Params$Resource$Featurestores$Entitytypes$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List, + params?: Params$Resource$Featurestores$Entitytypes$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List, + params: Params$Resource$Featurestores$Entitytypes$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List, + params: Params$Resource$Featurestores$Entitytypes$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List, + params: Params$Resource$Featurestores$Entitytypes$Operations$List, callback: BodyResponseCallback ): void; list( @@ -36998,7 +36434,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List + | Params$Resource$Featurestores$Entitytypes$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -37016,13 +36452,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List; + {}) as Params$Resource$Featurestores$Entitytypes$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List; + {} as Params$Resource$Featurestores$Entitytypes$Operations$List; options = {}; } @@ -37091,13 +36527,12 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.datasets.dataItems.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); + * const res = await aiplatform.featurestores.entityTypes.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'featurestores/my-featurestore/entityTypes/my-entityType/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -37123,27 +36558,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait, + params: Params$Resource$Featurestores$Entitytypes$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait, + params?: Params$Resource$Featurestores$Entitytypes$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait, + params: Params$Resource$Featurestores$Entitytypes$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait, + params: Params$Resource$Featurestores$Entitytypes$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait, + params: Params$Resource$Featurestores$Entitytypes$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -37151,7 +36586,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait + | Params$Resource$Featurestores$Entitytypes$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -37167,13 +36602,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait; + {}) as Params$Resource$Featurestores$Entitytypes$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait; + {} as Params$Resource$Featurestores$Entitytypes$Operations$Wait; options = {}; } @@ -37208,28 +36643,28 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel + export interface Params$Resource$Featurestores$Entitytypes$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete + export interface Params$Resource$Featurestores$Entitytypes$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get + export interface Params$Resource$Featurestores$Entitytypes$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List + export interface Params$Resource$Featurestores$Entitytypes$Operations$List extends StandardParameters { /** * The standard list filter. @@ -37252,7 +36687,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait + export interface Params$Resource$Featurestores$Entitytypes$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -37264,14 +36699,14 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Datasets$Datasetversions { + export class Resource$Featurestores$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Create a version from a Dataset. + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -37300,38 +36735,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.datasets.datasetVersions.create({ - * // Required. The name of the Dataset resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - * parent: 'projects/my-project/locations/my-location/datasets/my-dataset', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "bigQueryDatasetName": "my_bigQueryDatasetName", - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "metadata": {}, - * // "modelReference": "my_modelReference", - * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * const res = await aiplatform.featurestores.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'featurestores/my-featurestore/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -37346,58 +36757,185 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Create, + cancel( + params: Params$Resource$Featurestores$Operations$Cancel, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$Create, + cancel( + params?: Params$Resource$Featurestores$Operations$Cancel, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Create, + ): Promise>; + cancel( + params: Params$Resource$Featurestores$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Create, - options: + cancel( + params: Params$Resource$Featurestores$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Featurestores$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Featurestores$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Featurestores$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Featurestores$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.featurestores.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'featurestores/my-featurestore/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Featurestores$Operations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Featurestores$Operations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Featurestores$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Create, - callback: BodyResponseCallback + delete( + params: Params$Resource$Featurestores$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + delete( + params: Params$Resource$Featurestores$Operations$Delete, + callback: BodyResponseCallback ): void; - create( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Datasetversions$Create - | BodyResponseCallback + | Params$Resource$Featurestores$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$Create; + {}) as Params$Resource$Featurestores$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$Create; + params = {} as Params$Resource$Featurestores$Operations$Delete; options = {}; } @@ -37410,32 +36948,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/datasetVersions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a Dataset version. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -37464,11 +36999,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.datasets.datasetVersions.delete({ - * // Required. The resource name of the Dataset version to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/datasetVersions/my-datasetVersion', - * }); + * const res = await aiplatform.featurestores.operations.get({ + * // The name of the operation resource. + * name: 'featurestores/my-featurestore/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -37493,36 +37027,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete, + get( + params: Params$Resource$Featurestores$Operations$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete, + get( + params?: Params$Resource$Featurestores$Operations$Get, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete, + get( + params: Params$Resource$Featurestores$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete, + get( + params: Params$Resource$Featurestores$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete, + get( + params: Params$Resource$Featurestores$Operations$Get, callback: BodyResponseCallback ): void; - delete( + get( callback: BodyResponseCallback ): void; - delete( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete + | Params$Resource$Featurestores$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -37538,13 +37072,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete; + {}) as Params$Resource$Featurestores$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete; + params = {} as Params$Resource$Featurestores$Operations$Get; options = {}; } @@ -37558,7 +37091,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -37579,7 +37112,7 @@ export namespace aiplatform_v1 { } /** - * Gets a Dataset version. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -37608,184 +37141,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.datasets.datasetVersions.get({ - * // Required. The resource name of the Dataset version to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/datasetVersions/my-datasetVersion', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "bigQueryDatasetName": "my_bigQueryDatasetName", - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "metadata": {}, - * // "modelReference": "my_modelReference", - * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - get( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$Get, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Get, - callback: BodyResponseCallback - ): void; - get( - callback: BodyResponseCallback - ): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Datasetversions$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Lists DatasetVersions in a Dataset. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const aiplatform = google.aiplatform('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * const res = await aiplatform.featurestores.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'featurestores/my-featurestore', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await aiplatform.projects.locations.datasets.datasetVersions.list( - * { - * // Optional. The standard list filter. - * filter: 'placeholder-value', - * // Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. - * orderBy: 'placeholder-value', - * // Optional. The standard list page size. - * pageSize: 'placeholder-value', - * // Optional. The standard list page token. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - * parent: 'projects/my-project/locations/my-location/datasets/my-dataset', - * // Optional. Mask specifying which fields to read. - * readMask: 'placeholder-value', - * }, - * ); * console.log(res.data); * * // Example response * // { - * // "datasetVersions": [], - * // "nextPageToken": "my_nextPageToken" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -37802,61 +37176,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$List, + params: Params$Resource$Featurestores$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$List, + params?: Params$Resource$Featurestores$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$List, + params: Params$Resource$Featurestores$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$List, + params: Params$Resource$Featurestores$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$List, - callback: BodyResponseCallback + params: Params$Resource$Featurestores$Operations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Datasetversions$List - | BodyResponseCallback + | Params$Resource$Featurestores$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$List; + {}) as Params$Resource$Featurestores$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$List; + params = {} as Params$Resource$Featurestores$Operations$List; options = {}; } @@ -37869,7 +37242,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/datasetVersions').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -37879,198 +37252,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Updates a DatasetVersion. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const aiplatform = google.aiplatform('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await aiplatform.projects.locations.datasets.datasetVersions.patch({ - * // Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/datasetVersions/my-datasetVersion', - * // Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "bigQueryDatasetName": "my_bigQueryDatasetName", - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "metadata": {}, - * // "modelReference": "my_modelReference", - * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "bigQueryDatasetName": "my_bigQueryDatasetName", - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "metadata": {}, - * // "modelReference": "my_modelReference", - * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - patch( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Patch, - options: StreamMethodOptions - ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$Patch, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - patch( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Patch, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Patch, - callback: BodyResponseCallback - ): void; - patch( - callback: BodyResponseCallback - ): void; - patch( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Datasetversions$Patch - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - apiVersion: '', - }, - options - ), - params, requiredParams: ['name'], pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Restores a dataset version. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -38099,11 +37298,12 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.datasets.datasetVersions.restore({ - * // Required. The name of the DatasetVersion resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/datasetVersions/my-datasetVersion', - * }); + * const res = await aiplatform.featurestores.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'featurestores/my-featurestore/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -38128,36 +37328,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - restore( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore, + wait( + params: Params$Resource$Featurestores$Operations$Wait, options: StreamMethodOptions ): Promise>; - restore( - params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore, + wait( + params?: Params$Resource$Featurestores$Operations$Wait, options?: MethodOptions ): Promise>; - restore( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore, + wait( + params: Params$Resource$Featurestores$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - restore( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore, + wait( + params: Params$Resource$Featurestores$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - restore( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore, + wait( + params: Params$Resource$Featurestores$Operations$Wait, callback: BodyResponseCallback ): void; - restore( + wait( callback: BodyResponseCallback ): void; - restore( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore + | Params$Resource$Featurestores$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -38173,13 +37373,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore; + {}) as Params$Resource$Featurestores$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore; + params = {} as Params$Resource$Featurestores$Operations$Wait; options = {}; } @@ -38192,11 +37391,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:restore').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -38217,88 +37413,74 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$Create + export interface Params$Resource$Featurestores$Operations$Cancel extends StandardParameters { /** - * Required. The name of the Dataset resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - */ - parent?: string; - - /** - * Request body metadata + * The name of the operation resource to be cancelled. */ - requestBody?: Schema$GoogleCloudAiplatformV1DatasetVersion; + name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete + export interface Params$Resource$Featurestores$Operations$Delete extends StandardParameters { /** - * Required. The resource name of the Dataset version to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$Get + export interface Params$Resource$Featurestores$Operations$Get extends StandardParameters { /** - * Required. The resource name of the Dataset version to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` + * The name of the operation resource. */ name?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$List + export interface Params$Resource$Featurestores$Operations$List extends StandardParameters { /** - * Optional. The standard list filter. + * The standard list filter. */ filter?: string; /** - * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. + * The name of the operation's parent resource. */ - orderBy?: string; + name?: string; /** - * Optional. The standard list page size. + * The standard list page size. */ pageSize?: number; /** - * Optional. The standard list page token. + * The standard list page token. */ pageToken?: string; /** - * Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - */ - parent?: string; - /** - * Optional. Mask specifying which fields to read. + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - readMask?: string; + returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$Patch + export interface Params$Resource$Featurestores$Operations$Wait extends StandardParameters { /** - * Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` + * The name of the operation resource to wait on. */ name?: string; /** - * Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` - */ - updateMask?: string; - - /** - * Request body metadata + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - requestBody?: Schema$GoogleCloudAiplatformV1DatasetVersion; + timeout?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore - extends StandardParameters { - /** - * Required. The name of the DatasetVersion resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` - */ - name?: string; + + export class Resource$Hyperparametertuningjobs { + context: APIRequestContext; + operations: Resource$Hyperparametertuningjobs$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Hyperparametertuningjobs$Operations( + this.context + ); + } } - export class Resource$Projects$Locations$Datasets$Operations { + export class Resource$Hyperparametertuningjobs$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -38334,9 +37516,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.datasets.operations.cancel({ + * const res = await aiplatform.hyperparameterTuningJobs.operations.cancel({ * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/operations/my-operation', + * name: 'hyperparameterTuningJobs/my-hyperparameterTuningJob/operations/my-operation', * }); * console.log(res.data); * @@ -38357,31 +37539,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Datasets$Operations$Cancel, + params: Params$Resource$Hyperparametertuningjobs$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Datasets$Operations$Cancel, + params?: Params$Resource$Hyperparametertuningjobs$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Datasets$Operations$Cancel, + params: Params$Resource$Hyperparametertuningjobs$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Datasets$Operations$Cancel, + params: Params$Resource$Hyperparametertuningjobs$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Datasets$Operations$Cancel, + params: Params$Resource$Hyperparametertuningjobs$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Operations$Cancel + | Params$Resource$Hyperparametertuningjobs$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -38397,13 +37579,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Operations$Cancel; + {}) as Params$Resource$Hyperparametertuningjobs$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Operations$Cancel; + {} as Params$Resource$Hyperparametertuningjobs$Operations$Cancel; options = {}; } @@ -38467,9 +37649,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.datasets.operations.delete({ + * const res = await aiplatform.hyperparameterTuningJobs.operations.delete({ * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/operations/my-operation', + * name: 'hyperparameterTuningJobs/my-hyperparameterTuningJob/operations/my-operation', * }); * console.log(res.data); * @@ -38490,31 +37672,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Datasets$Operations$Delete, + params: Params$Resource$Hyperparametertuningjobs$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Datasets$Operations$Delete, + params?: Params$Resource$Hyperparametertuningjobs$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Datasets$Operations$Delete, + params: Params$Resource$Hyperparametertuningjobs$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datasets$Operations$Delete, + params: Params$Resource$Hyperparametertuningjobs$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datasets$Operations$Delete, + params: Params$Resource$Hyperparametertuningjobs$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Operations$Delete + | Params$Resource$Hyperparametertuningjobs$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -38530,13 +37712,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Operations$Delete; + {}) as Params$Resource$Hyperparametertuningjobs$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Operations$Delete; + {} as Params$Resource$Hyperparametertuningjobs$Operations$Delete; options = {}; } @@ -38600,9 +37782,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.datasets.operations.get({ + * const res = await aiplatform.hyperparameterTuningJobs.operations.get({ * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/operations/my-operation', + * name: 'hyperparameterTuningJobs/my-hyperparameterTuningJob/operations/my-operation', * }); * console.log(res.data); * @@ -38629,27 +37811,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datasets$Operations$Get, + params: Params$Resource$Hyperparametertuningjobs$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Datasets$Operations$Get, + params?: Params$Resource$Hyperparametertuningjobs$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Datasets$Operations$Get, + params: Params$Resource$Hyperparametertuningjobs$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datasets$Operations$Get, + params: Params$Resource$Hyperparametertuningjobs$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datasets$Operations$Get, + params: Params$Resource$Hyperparametertuningjobs$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -38657,7 +37839,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Operations$Get + | Params$Resource$Hyperparametertuningjobs$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -38673,13 +37855,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Operations$Get; + {}) as Params$Resource$Hyperparametertuningjobs$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Operations$Get; + params = {} as Params$Resource$Hyperparametertuningjobs$Operations$Get; options = {}; } @@ -38743,11 +37924,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.datasets.operations.list({ + * const res = await aiplatform.hyperparameterTuningJobs.operations.list({ * // The standard list filter. * filter: 'placeholder-value', * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset', + * name: 'hyperparameterTuningJobs/my-hyperparameterTuningJob', * // The standard list page size. * pageSize: 'placeholder-value', * // The standard list page token. @@ -38778,29 +37959,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Datasets$Operations$List, + params: Params$Resource$Hyperparametertuningjobs$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Datasets$Operations$List, + params?: Params$Resource$Hyperparametertuningjobs$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Datasets$Operations$List, + params: Params$Resource$Hyperparametertuningjobs$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datasets$Operations$List, + params: Params$Resource$Hyperparametertuningjobs$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datasets$Operations$List, + params: Params$Resource$Hyperparametertuningjobs$Operations$List, callback: BodyResponseCallback ): void; list( @@ -38808,7 +37989,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Operations$List + | Params$Resource$Hyperparametertuningjobs$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -38826,13 +38007,12 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Operations$List; + {}) as Params$Resource$Hyperparametertuningjobs$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Operations$List; + params = {} as Params$Resource$Hyperparametertuningjobs$Operations$List; options = {}; } @@ -38901,9 +38081,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.datasets.operations.wait({ + * const res = await aiplatform.hyperparameterTuningJobs.operations.wait({ * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/operations/my-operation', + * name: 'hyperparameterTuningJobs/my-hyperparameterTuningJob/operations/my-operation', * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. * timeout: 'placeholder-value', * }); @@ -38932,27 +38112,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Datasets$Operations$Wait, + params: Params$Resource$Hyperparametertuningjobs$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Datasets$Operations$Wait, + params?: Params$Resource$Hyperparametertuningjobs$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Datasets$Operations$Wait, + params: Params$Resource$Hyperparametertuningjobs$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Datasets$Operations$Wait, + params: Params$Resource$Hyperparametertuningjobs$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Datasets$Operations$Wait, + params: Params$Resource$Hyperparametertuningjobs$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -38960,7 +38140,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Operations$Wait + | Params$Resource$Hyperparametertuningjobs$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -38976,13 +38156,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Operations$Wait; + {}) as Params$Resource$Hyperparametertuningjobs$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Operations$Wait; + params = {} as Params$Resource$Hyperparametertuningjobs$Operations$Wait; options = {}; } @@ -39017,28 +38196,28 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Datasets$Operations$Cancel + export interface Params$Resource$Hyperparametertuningjobs$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Operations$Delete + export interface Params$Resource$Hyperparametertuningjobs$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Operations$Get + export interface Params$Resource$Hyperparametertuningjobs$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Operations$List + export interface Params$Resource$Hyperparametertuningjobs$Operations$List extends StandardParameters { /** * The standard list filter. @@ -39061,7 +38240,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Datasets$Operations$Wait + export interface Params$Resource$Hyperparametertuningjobs$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -39073,356 +38252,16 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Datasets$Savedqueries { + export class Resource$Indexendpoints { context: APIRequestContext; - operations: Resource$Projects$Locations$Datasets$Savedqueries$Operations; + operations: Resource$Indexendpoints$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = - new Resource$Projects$Locations$Datasets$Savedqueries$Operations( - this.context - ); - } - - /** - * Deletes a SavedQuery. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const aiplatform = google.aiplatform('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await aiplatform.projects.locations.datasets.savedQueries.delete({ - * // Required. The resource name of the SavedQuery to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/savedQueries/{saved_query\}` - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/savedQueries/my-savedQuerie', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - delete( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete, - options: StreamMethodOptions - ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete, - options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete, - callback: BodyResponseCallback - ): void; - delete( - callback: BodyResponseCallback - ): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Lists SavedQueries in a Dataset. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const aiplatform = google.aiplatform('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await aiplatform.projects.locations.datasets.savedQueries.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. - * orderBy: 'placeholder-value', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Dataset to list SavedQueries from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - * parent: 'projects/my-project/locations/my-location/datasets/my-dataset', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "nextPageToken": "my_nextPageToken", - * // "savedQueries": [] - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - list( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$List, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Savedqueries$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Savedqueries$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/savedQueries').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } + this.operations = new Resource$Indexendpoints$Operations(this.context); } } - export interface Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete - extends StandardParameters { - /** - * Required. The resource name of the SavedQuery to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/savedQueries/{saved_query\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Savedqueries$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. - */ - orderBy?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * Required. The resource name of the Dataset to list SavedQueries from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; - } - - export class Resource$Projects$Locations$Datasets$Savedqueries$Operations { + export class Resource$Indexendpoints$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -39458,13 +38297,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.datasets.savedQueries.operations.cancel( - * { - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/savedQueries/my-savedQuerie/operations/my-operation', - * }, - * ); + * const res = await aiplatform.indexEndpoints.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'indexEndpoints/my-indexEndpoint/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -39484,31 +38320,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel, + params: Params$Resource$Indexendpoints$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel, + params?: Params$Resource$Indexendpoints$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel, + params: Params$Resource$Indexendpoints$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel, + params: Params$Resource$Indexendpoints$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel, + params: Params$Resource$Indexendpoints$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel + | Params$Resource$Indexendpoints$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -39524,13 +38360,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel; + {}) as Params$Resource$Indexendpoints$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel; + params = {} as Params$Resource$Indexendpoints$Operations$Cancel; options = {}; } @@ -39594,13 +38429,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.datasets.savedQueries.operations.delete( - * { - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/savedQueries/my-savedQuerie/operations/my-operation', - * }, - * ); + * const res = await aiplatform.indexEndpoints.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'indexEndpoints/my-indexEndpoint/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -39620,31 +38452,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete, + params: Params$Resource$Indexendpoints$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete, + params?: Params$Resource$Indexendpoints$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete, + params: Params$Resource$Indexendpoints$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete, + params: Params$Resource$Indexendpoints$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete, + params: Params$Resource$Indexendpoints$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete + | Params$Resource$Indexendpoints$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -39660,13 +38492,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete; + {}) as Params$Resource$Indexendpoints$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete; + params = {} as Params$Resource$Indexendpoints$Operations$Delete; options = {}; } @@ -39730,11 +38561,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.datasets.savedQueries.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/savedQueries/my-savedQuerie/operations/my-operation', - * }); + * const res = await aiplatform.indexEndpoints.operations.get({ + * // The name of the operation resource. + * name: 'indexEndpoints/my-indexEndpoint/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -39760,27 +38590,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get, + params: Params$Resource$Indexendpoints$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get, + params?: Params$Resource$Indexendpoints$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get, + params: Params$Resource$Indexendpoints$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get, + params: Params$Resource$Indexendpoints$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get, + params: Params$Resource$Indexendpoints$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -39788,7 +38618,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get + | Params$Resource$Indexendpoints$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -39804,13 +38634,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get; + {}) as Params$Resource$Indexendpoints$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get; + params = {} as Params$Resource$Indexendpoints$Operations$Get; options = {}; } @@ -39874,19 +38703,18 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.datasets.savedQueries.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/savedQueries/my-savedQuerie', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * const res = await aiplatform.indexEndpoints.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'indexEndpoints/my-indexEndpoint', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -39910,29 +38738,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List, + params: Params$Resource$Indexendpoints$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List, + params?: Params$Resource$Indexendpoints$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List, + params: Params$Resource$Indexendpoints$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List, + params: Params$Resource$Indexendpoints$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List, + params: Params$Resource$Indexendpoints$Operations$List, callback: BodyResponseCallback ): void; list( @@ -39940,7 +38768,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List + | Params$Resource$Indexendpoints$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -39958,13 +38786,12 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List; + {}) as Params$Resource$Indexendpoints$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List; + params = {} as Params$Resource$Indexendpoints$Operations$List; options = {}; } @@ -40033,13 +38860,12 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.datasets.savedQueries.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/savedQueries/my-savedQuerie/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); + * const res = await aiplatform.indexEndpoints.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'indexEndpoints/my-indexEndpoint/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -40065,27 +38891,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait, + params: Params$Resource$Indexendpoints$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait, + params?: Params$Resource$Indexendpoints$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait, + params: Params$Resource$Indexendpoints$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait, + params: Params$Resource$Indexendpoints$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait, + params: Params$Resource$Indexendpoints$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -40093,7 +38919,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait + | Params$Resource$Indexendpoints$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -40109,13 +38935,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait; + {}) as Params$Resource$Indexendpoints$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait; + params = {} as Params$Resource$Indexendpoints$Operations$Wait; options = {}; } @@ -40150,28 +38975,28 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel + export interface Params$Resource$Indexendpoints$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete + export interface Params$Resource$Indexendpoints$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get + export interface Params$Resource$Indexendpoints$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List + export interface Params$Resource$Indexendpoints$Operations$List extends StandardParameters { /** * The standard list filter. @@ -40194,7 +39019,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait + export interface Params$Resource$Indexendpoints$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -40206,19 +39031,23 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Deploymentresourcepools { + export class Resource$Indexes { + context: APIRequestContext; + operations: Resource$Indexes$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Indexes$Operations(this.context); + } + } + + export class Resource$Indexes$Operations { context: APIRequestContext; - operations: Resource$Projects$Locations$Deploymentresourcepools$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = - new Resource$Projects$Locations$Deploymentresourcepools$Operations( - this.context - ); } /** - * Create a DeploymentResourcePool. + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -40247,30 +39076,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.deploymentResourcePools.create({ - * // Required. The parent location resource where this DeploymentResourcePool will be created. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "deploymentResourcePool": {}, - * // "deploymentResourcePoolId": "my_deploymentResourcePoolId" - * // } - * }, - * }); + * const res = await aiplatform.indexes.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'indexes/my-indexe/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -40285,58 +39098,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Create, + cancel( + params: Params$Resource$Indexes$Operations$Cancel, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Create, + cancel( + params?: Params$Resource$Indexes$Operations$Cancel, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Create, + ): Promise>; + cancel( + params: Params$Resource$Indexes$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Create, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Indexes$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Indexes$Operations$Cancel, + callback: BodyResponseCallback ): void; - create( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Deploymentresourcepools$Create - | BodyResponseCallback + | Params$Resource$Indexes$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Create; + {}) as Params$Resource$Indexes$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Create; + params = {} as Params$Resource$Indexes$Operations$Cancel; options = {}; } @@ -40349,32 +39157,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/deploymentResourcePools').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Delete a DeploymentResourcePool. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -40403,21 +39208,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.deploymentResourcePools.delete({ - * // Required. The name of the DeploymentResourcePool to delete. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` - * name: 'projects/my-project/locations/my-location/deploymentResourcePools/my-deploymentResourcePool', - * }); + * const res = await aiplatform.indexes.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'indexes/my-indexe/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -40433,57 +39231,52 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Delete, + params: Params$Resource$Indexes$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Delete, + params?: Params$Resource$Indexes$Operations$Delete, options?: MethodOptions - ): Promise>; + ): Promise>; delete( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Delete, + params: Params$Resource$Indexes$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Delete, - callback: BodyResponseCallback + params: Params$Resource$Indexes$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - callback: BodyResponseCallback + params: Params$Resource$Indexes$Operations$Delete, + callback: BodyResponseCallback ): void; + delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Deploymentresourcepools$Delete - | BodyResponseCallback + | Params$Resource$Indexes$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Delete; + {}) as Params$Resource$Indexes$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Delete; + params = {} as Params$Resource$Indexes$Operations$Delete; options = {}; } @@ -40508,17 +39301,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Get a DeploymentResourcePool. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -40547,22 +39340,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.deploymentResourcePools.get({ - * // Required. The name of the DeploymentResourcePool to retrieve. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` - * name: 'projects/my-project/locations/my-location/deploymentResourcePools/my-deploymentResourcePool', + * const res = await aiplatform.indexes.operations.get({ + * // The name of the operation resource. + * name: 'indexes/my-indexe/operations/my-operation', * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "dedicatedResources": {}, - * // "disableContainerLogging": false, - * // "encryptionSpec": {}, + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "serviceAccount": "my_serviceAccount" + * // "response": {} * // } * } * @@ -40579,61 +39369,56 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Get, + params: Params$Resource$Indexes$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Get, + params?: Params$Resource$Indexes$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; + ): Promise>; get( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Get, + params: Params$Resource$Indexes$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Get, + params: Params$Resource$Indexes$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Get, - callback: BodyResponseCallback + params: Params$Resource$Indexes$Operations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Deploymentresourcepools$Get - | BodyResponseCallback + | Params$Resource$Indexes$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Get; + {}) as Params$Resource$Indexes$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Get; + params = {} as Params$Resource$Indexes$Operations$Get; options = {}; } @@ -40658,19 +39443,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * List DeploymentResourcePools in a location. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -40699,20 +39482,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.deploymentResourcePools.list({ - * // The maximum number of DeploymentResourcePools to return. The service may return fewer than this value. + * const res = await aiplatform.indexes.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'indexes/my-indexe', + * // The standard list page size. * pageSize: 'placeholder-value', - * // A page token, received from a previous `ListDeploymentResourcePools` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDeploymentResourcePools` must match the call that provided the page token. + * // The standard list page token. * pageToken: 'placeholder-value', - * // Required. The parent Location which owns this collection of DeploymentResourcePools. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "deploymentResourcePools": [], - * // "nextPageToken": "my_nextPageToken" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -40729,61 +39517,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$List, + params: Params$Resource$Indexes$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Deploymentresourcepools$List, + params?: Params$Resource$Indexes$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$List, + params: Params$Resource$Indexes$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$List, + params: Params$Resource$Indexes$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$List, - callback: BodyResponseCallback + params: Params$Resource$Indexes$Operations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Deploymentresourcepools$List - | BodyResponseCallback + | Params$Resource$Indexes$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$List; + {}) as Params$Resource$Indexes$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Deploymentresourcepools$List; + params = {} as Params$Resource$Indexes$Operations$List; options = {}; } @@ -40796,7 +39583,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/deploymentResourcePools').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -40806,24 +39593,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Update a DeploymentResourcePool. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -40852,29 +39639,12 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.deploymentResourcePools.patch( - * { - * // Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` - * name: 'projects/my-project/locations/my-location/deploymentResourcePools/my-deploymentResourcePool', - * // Required. The list of fields to update. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "dedicatedResources": {}, - * // "disableContainerLogging": false, - * // "encryptionSpec": {}, - * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "serviceAccount": "my_serviceAccount" - * // } - * }, - * }, - * ); + * const res = await aiplatform.indexes.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'indexes/my-indexe/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -40899,36 +39669,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Patch, + wait( + params: Params$Resource$Indexes$Operations$Wait, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Patch, + wait( + params?: Params$Resource$Indexes$Operations$Wait, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Patch, + wait( + params: Params$Resource$Indexes$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Patch, + wait( + params: Params$Resource$Indexes$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Patch, + wait( + params: Params$Resource$Indexes$Operations$Wait, callback: BodyResponseCallback ): void; - patch( + wait( callback: BodyResponseCallback ): void; - patch( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Deploymentresourcepools$Patch + | Params$Resource$Indexes$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -40944,13 +39714,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Patch; + {}) as Params$Resource$Indexes$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Patch; + params = {} as Params$Resource$Indexes$Operations$Wait; options = {}; } @@ -40963,8 +39732,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -40983,9 +39752,72 @@ export namespace aiplatform_v1 { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Indexes$Operations$Cancel + extends StandardParameters { /** - * List DeployedModels that have been deployed on this DeploymentResourcePool. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Indexes$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Indexes$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Indexes$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Indexes$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Media { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Upload a file into a RagCorpus. * @example * ```js * // Before running the sample: @@ -41014,27 +39846,29 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.deploymentResourcePools.queryDeployedModels( - * { - * // Required. The name of the target DeploymentResourcePool to query. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` - * deploymentResourcePool: - * 'projects/my-project/locations/my-location/deploymentResourcePools/my-deploymentResourcePool', - * // The maximum number of DeployedModels to return. The service may return fewer than this value. - * pageSize: 'placeholder-value', - * // A page token, received from a previous `QueryDeployedModels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryDeployedModels` must match the call that provided the page token. - * pageToken: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.media.upload({ + * // Required. The name of the RagCorpus resource into which to upload the file. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` + * parent: 'projects/my-project/locations/my-location/ragCorpora/[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "ragFile": {}, + * // "uploadRagFileConfig": {} + * // } + * }, + * media: { + * mimeType: 'placeholder-value', + * body: 'placeholder-value', + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "deployedModelRefs": [], - * // "deployedModels": [], - * // "nextPageToken": "my_nextPageToken", - * // "totalDeployedModelCount": 0, - * // "totalEndpointCount": 0 + * // "error": {}, + * // "ragFile": {} * // } * } * @@ -41050,62 +39884,60 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - queryDeployedModels( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels, + upload( + params: Params$Resource$Media$Upload, options: StreamMethodOptions ): Promise>; - queryDeployedModels( - params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels, + upload( + params?: Params$Resource$Media$Upload, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - queryDeployedModels( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels, + upload( + params: Params$Resource$Media$Upload, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - queryDeployedModels( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels, + upload( + params: Params$Resource$Media$Upload, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - queryDeployedModels( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels, - callback: BodyResponseCallback + upload( + params: Params$Resource$Media$Upload, + callback: BodyResponseCallback ): void; - queryDeployedModels( - callback: BodyResponseCallback + upload( + callback: BodyResponseCallback ): void; - queryDeployedModels( + upload( paramsOrCallback?: - | Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels - | BodyResponseCallback + | Params$Resource$Media$Upload + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels; + let params = (paramsOrCallback || {}) as Params$Resource$Media$Upload; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels; + params = {} as Params$Resource$Media$Upload; options = {}; } @@ -41118,106 +39950,91 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+deploymentResourcePool}:queryDeployedModels' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+parent}/ragFiles:upload').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['deploymentResourcePool'], - pathParams: ['deploymentResourcePool'], + mediaUrl: (rootUrl + '/upload/v1/{+parent}/ragFiles:upload').replace( + /([^:]\/)\/+/g, + '$1' + ), + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Create - extends StandardParameters { + export interface Params$Resource$Media$Upload extends StandardParameters { /** - * Required. The parent location resource where this DeploymentResourcePool will be created. Format: `projects/{project\}/locations/{location\}` + * Required. The name of the RagCorpus resource into which to upload the file. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest; - } - export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Delete - extends StandardParameters { - /** - * Required. The name of the DeploymentResourcePool to delete. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Get - extends StandardParameters { - /** - * Required. The name of the DeploymentResourcePool to retrieve. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Deploymentresourcepools$List - extends StandardParameters { - /** - * The maximum number of DeploymentResourcePools to return. The service may return fewer than this value. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListDeploymentResourcePools` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDeploymentResourcePools` must match the call that provided the page token. - */ - pageToken?: string; + requestBody?: Schema$GoogleCloudAiplatformV1UploadRagFileRequest; + /** - * Required. The parent Location which owns this collection of DeploymentResourcePools. Format: `projects/{project\}/locations/{location\}` + * Media metadata */ - parent?: string; + media?: { + /** + * Media mime-type + */ + mimeType?: string; + + /** + * Media body contents + */ + body?: any; + }; } - export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Patch - extends StandardParameters { - /** - * Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` - */ - name?: string; - /** - * Required. The list of fields to update. - */ - updateMask?: string; - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1DeploymentResourcePool; + export class Resource$Metadatastores { + context: APIRequestContext; + artifacts: Resource$Metadatastores$Artifacts; + contexts: Resource$Metadatastores$Contexts; + executions: Resource$Metadatastores$Executions; + operations: Resource$Metadatastores$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.artifacts = new Resource$Metadatastores$Artifacts(this.context); + this.contexts = new Resource$Metadatastores$Contexts(this.context); + this.executions = new Resource$Metadatastores$Executions(this.context); + this.operations = new Resource$Metadatastores$Operations(this.context); + } } - export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels - extends StandardParameters { - /** - * Required. The name of the target DeploymentResourcePool to query. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` - */ - deploymentResourcePool?: string; - /** - * The maximum number of DeployedModels to return. The service may return fewer than this value. - */ - pageSize?: number; - /** - * A page token, received from a previous `QueryDeployedModels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryDeployedModels` must match the call that provided the page token. - */ - pageToken?: string; + + export class Resource$Metadatastores$Artifacts { + context: APIRequestContext; + operations: Resource$Metadatastores$Artifacts$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Metadatastores$Artifacts$Operations( + this.context + ); + } } - export class Resource$Projects$Locations$Deploymentresourcepools$Operations { + export class Resource$Metadatastores$Artifacts$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -41253,13 +40070,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.deploymentResourcePools.operations.cancel( - * { - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/deploymentResourcePools/my-deploymentResourcePool/operations/my-operation', - * }, - * ); + * const res = await aiplatform.metadataStores.artifacts.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'metadataStores/my-metadataStore/artifacts/my-artifact/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -41279,31 +40093,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel, + params: Params$Resource$Metadatastores$Artifacts$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel, + params?: Params$Resource$Metadatastores$Artifacts$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel, + params: Params$Resource$Metadatastores$Artifacts$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel, + params: Params$Resource$Metadatastores$Artifacts$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel, + params: Params$Resource$Metadatastores$Artifacts$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel + | Params$Resource$Metadatastores$Artifacts$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -41319,13 +40133,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel; + {}) as Params$Resource$Metadatastores$Artifacts$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel; + {} as Params$Resource$Metadatastores$Artifacts$Operations$Cancel; options = {}; } @@ -41389,13 +40203,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.deploymentResourcePools.operations.delete( - * { - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/deploymentResourcePools/my-deploymentResourcePool/operations/my-operation', - * }, - * ); + * const res = await aiplatform.metadataStores.artifacts.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'metadataStores/my-metadataStore/artifacts/my-artifact/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -41415,31 +40226,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete, + params: Params$Resource$Metadatastores$Artifacts$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete, + params?: Params$Resource$Metadatastores$Artifacts$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete, + params: Params$Resource$Metadatastores$Artifacts$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete, + params: Params$Resource$Metadatastores$Artifacts$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete, + params: Params$Resource$Metadatastores$Artifacts$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete + | Params$Resource$Metadatastores$Artifacts$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -41455,13 +40266,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete; + {}) as Params$Resource$Metadatastores$Artifacts$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete; + {} as Params$Resource$Metadatastores$Artifacts$Operations$Delete; options = {}; } @@ -41525,11 +40336,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.deploymentResourcePools.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/deploymentResourcePools/my-deploymentResourcePool/operations/my-operation', - * }); + * const res = await aiplatform.metadataStores.artifacts.operations.get({ + * // The name of the operation resource. + * name: 'metadataStores/my-metadataStore/artifacts/my-artifact/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -41555,27 +40365,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get, + params: Params$Resource$Metadatastores$Artifacts$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get, + params?: Params$Resource$Metadatastores$Artifacts$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get, + params: Params$Resource$Metadatastores$Artifacts$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get, + params: Params$Resource$Metadatastores$Artifacts$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get, + params: Params$Resource$Metadatastores$Artifacts$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -41583,7 +40393,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get + | Params$Resource$Metadatastores$Artifacts$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -41599,13 +40409,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get; + {}) as Params$Resource$Metadatastores$Artifacts$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get; + params = {} as Params$Resource$Metadatastores$Artifacts$Operations$Get; options = {}; } @@ -41669,21 +40478,18 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.deploymentResourcePools.operations.list( - * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/deploymentResourcePools/my-deploymentResourcePool', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.metadataStores.artifacts.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'metadataStores/my-metadataStore/artifacts/my-artifact', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -41707,29 +40513,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List, + params: Params$Resource$Metadatastores$Artifacts$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List, + params?: Params$Resource$Metadatastores$Artifacts$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List, + params: Params$Resource$Metadatastores$Artifacts$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List, + params: Params$Resource$Metadatastores$Artifacts$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List, + params: Params$Resource$Metadatastores$Artifacts$Operations$List, callback: BodyResponseCallback ): void; list( @@ -41737,7 +40543,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List + | Params$Resource$Metadatastores$Artifacts$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -41755,13 +40561,12 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List; + {}) as Params$Resource$Metadatastores$Artifacts$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List; + params = {} as Params$Resource$Metadatastores$Artifacts$Operations$List; options = {}; } @@ -41830,15 +40635,12 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.deploymentResourcePools.operations.wait( - * { - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/deploymentResourcePools/my-deploymentResourcePool/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.metadataStores.artifacts.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'metadataStores/my-metadataStore/artifacts/my-artifact/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -41864,27 +40666,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait, + params: Params$Resource$Metadatastores$Artifacts$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait, + params?: Params$Resource$Metadatastores$Artifacts$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait, + params: Params$Resource$Metadatastores$Artifacts$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait, + params: Params$Resource$Metadatastores$Artifacts$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait, + params: Params$Resource$Metadatastores$Artifacts$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -41892,7 +40694,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait + | Params$Resource$Metadatastores$Artifacts$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -41908,13 +40710,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait; + {}) as Params$Resource$Metadatastores$Artifacts$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait; + params = {} as Params$Resource$Metadatastores$Artifacts$Operations$Wait; options = {}; } @@ -41949,28 +40750,28 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel + export interface Params$Resource$Metadatastores$Artifacts$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete + export interface Params$Resource$Metadatastores$Artifacts$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get + export interface Params$Resource$Metadatastores$Artifacts$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List + export interface Params$Resource$Metadatastores$Artifacts$Operations$List extends StandardParameters { /** * The standard list filter. @@ -41993,7 +40794,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait + export interface Params$Resource$Metadatastores$Artifacts$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -42005,31 +40806,25 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Endpoints { + export class Resource$Metadatastores$Contexts { context: APIRequestContext; - chat: Resource$Projects$Locations$Endpoints$Chat; - deployedModels: Resource$Projects$Locations$Endpoints$Deployedmodels; - invoke: Resource$Projects$Locations$Endpoints$Invoke; - openapi: Resource$Projects$Locations$Endpoints$Openapi; - operations: Resource$Projects$Locations$Endpoints$Operations; + operations: Resource$Metadatastores$Contexts$Operations; constructor(context: APIRequestContext) { this.context = context; - this.chat = new Resource$Projects$Locations$Endpoints$Chat(this.context); - this.deployedModels = - new Resource$Projects$Locations$Endpoints$Deployedmodels(this.context); - this.invoke = new Resource$Projects$Locations$Endpoints$Invoke( - this.context - ); - this.openapi = new Resource$Projects$Locations$Endpoints$Openapi( - this.context - ); - this.operations = new Resource$Projects$Locations$Endpoints$Operations( + this.operations = new Resource$Metadatastores$Contexts$Operations( this.context ); } + } + + export class Resource$Metadatastores$Contexts$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Return a list of tokens based on the input text. + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -42058,26 +40853,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.computeTokens({ - * // Required. The name of the Endpoint requested to get lists of tokens and token ids. - * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "contents": [], - * // "instances": [], - * // "model": "my_model" - * // } - * }, + * const res = await aiplatform.metadataStores.contexts.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'metadataStores/my-metadataStore/contexts/my-context/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "tokensInfo": [] - * // } + * // {} * } * * main().catch(e => { @@ -42092,62 +40875,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - computeTokens( - params: Params$Resource$Projects$Locations$Endpoints$Computetokens, + cancel( + params: Params$Resource$Metadatastores$Contexts$Operations$Cancel, options: StreamMethodOptions ): Promise>; - computeTokens( - params?: Params$Resource$Projects$Locations$Endpoints$Computetokens, + cancel( + params?: Params$Resource$Metadatastores$Contexts$Operations$Cancel, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - computeTokens( - params: Params$Resource$Projects$Locations$Endpoints$Computetokens, + ): Promise>; + cancel( + params: Params$Resource$Metadatastores$Contexts$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - computeTokens( - params: Params$Resource$Projects$Locations$Endpoints$Computetokens, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - computeTokens( - params: Params$Resource$Projects$Locations$Endpoints$Computetokens, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Metadatastores$Contexts$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - computeTokens( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Metadatastores$Contexts$Operations$Cancel, + callback: BodyResponseCallback ): void; - computeTokens( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Computetokens - | BodyResponseCallback + | Params$Resource$Metadatastores$Contexts$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Computetokens; + {}) as Params$Resource$Metadatastores$Contexts$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Computetokens; + {} as Params$Resource$Metadatastores$Contexts$Operations$Cancel; options = {}; } @@ -42160,34 +40935,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:computeTokens').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Perform a token counting. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -42216,31 +40986,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.countTokens({ - * // Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "contents": [], - * // "generationConfig": {}, - * // "instances": [], - * // "model": "my_model", - * // "systemInstruction": {}, - * // "tools": [] - * // } - * }, + * const res = await aiplatform.metadataStores.contexts.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'metadataStores/my-metadataStore/contexts/my-context/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "promptTokensDetails": [], - * // "totalBillableCharacters": 0, - * // "totalTokens": 0 - * // } + * // {} * } * * main().catch(e => { @@ -42255,61 +41008,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - countTokens( - params: Params$Resource$Projects$Locations$Endpoints$Counttokens, + delete( + params: Params$Resource$Metadatastores$Contexts$Operations$Delete, options: StreamMethodOptions ): Promise>; - countTokens( - params?: Params$Resource$Projects$Locations$Endpoints$Counttokens, + delete( + params?: Params$Resource$Metadatastores$Contexts$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - countTokens( - params: Params$Resource$Projects$Locations$Endpoints$Counttokens, + ): Promise>; + delete( + params: Params$Resource$Metadatastores$Contexts$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - countTokens( - params: Params$Resource$Projects$Locations$Endpoints$Counttokens, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - countTokens( - params: Params$Resource$Projects$Locations$Endpoints$Counttokens, - callback: BodyResponseCallback + delete( + params: Params$Resource$Metadatastores$Contexts$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - countTokens( - callback: BodyResponseCallback + delete( + params: Params$Resource$Metadatastores$Contexts$Operations$Delete, + callback: BodyResponseCallback ): void; - countTokens( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Counttokens - | BodyResponseCallback + | Params$Resource$Metadatastores$Contexts$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Counttokens; + {}) as Params$Resource$Metadatastores$Contexts$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Endpoints$Counttokens; + params = + {} as Params$Resource$Metadatastores$Contexts$Operations$Delete; options = {}; } @@ -42322,34 +41068,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:countTokens').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Creates an Endpoint. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -42378,40 +41119,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.create({ - * // Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are `[0-9]` with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as `?endpoint_id=12345`. This is the fallback for fields that are not included in either the URI or the body. - * endpointId: 'placeholder-value', - * // Required. The resource name of the Location to create the Endpoint in. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "clientConnectionConfig": {}, - * // "createTime": "my_createTime", - * // "dedicatedEndpointDns": "my_dedicatedEndpointDns", - * // "dedicatedEndpointEnabled": false, - * // "deployedModels": [], - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "enablePrivateServiceConnect": false, - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "gdcConfig": {}, - * // "genAiAdvancedFeaturesConfig": {}, - * // "labels": {}, - * // "modelDeploymentMonitoringJob": "my_modelDeploymentMonitoringJob", - * // "name": "my_name", - * // "network": "my_network", - * // "predictRequestResponseLoggingConfig": {}, - * // "privateServiceConnectConfig": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "trafficSplit": {}, - * // "updateTime": "my_updateTime" - * // } - * }, + * const res = await aiplatform.metadataStores.contexts.operations.get({ + * // The name of the operation resource. + * name: 'metadataStores/my-metadataStore/contexts/my-context/operations/my-operation', * }); * console.log(res.data); * @@ -42437,36 +41147,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Endpoints$Create, + get( + params: Params$Resource$Metadatastores$Contexts$Operations$Get, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Endpoints$Create, + get( + params?: Params$Resource$Metadatastores$Contexts$Operations$Get, options?: MethodOptions ): Promise>; - create( - params: Params$Resource$Projects$Locations$Endpoints$Create, + get( + params: Params$Resource$Metadatastores$Contexts$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Endpoints$Create, + get( + params: Params$Resource$Metadatastores$Contexts$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Endpoints$Create, + get( + params: Params$Resource$Metadatastores$Contexts$Operations$Get, callback: BodyResponseCallback ): void; - create( + get( callback: BodyResponseCallback ): void; - create( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Create + | Params$Resource$Metadatastores$Contexts$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -42482,12 +41192,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Create; + {}) as Params$Resource$Metadatastores$Contexts$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Endpoints$Create; + params = {} as Params$Resource$Metadatastores$Contexts$Operations$Get; options = {}; } @@ -42500,18 +41210,15 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/endpoints').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -42525,7 +41232,7 @@ export namespace aiplatform_v1 { } /** - * Deletes an Endpoint. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -42554,19 +41261,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.delete({ - * // Required. The name of the Endpoint resource to be deleted. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * const res = await aiplatform.metadataStores.contexts.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'metadataStores/my-metadataStore/contexts/my-context', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -42582,57 +41295,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Endpoints$Delete, + list( + params: Params$Resource$Metadatastores$Contexts$Operations$List, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Endpoints$Delete, + list( + params?: Params$Resource$Metadatastores$Contexts$Operations$List, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Endpoints$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Metadatastores$Contexts$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Endpoints$Delete, + list( + params: Params$Resource$Metadatastores$Contexts$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Endpoints$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Metadatastores$Contexts$Operations$List, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - delete( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Delete - | BodyResponseCallback + | Params$Resource$Metadatastores$Contexts$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Delete; + {}) as Params$Resource$Metadatastores$Contexts$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Endpoints$Delete; + params = {} as Params$Resource$Metadatastores$Contexts$Operations$List; options = {}; } @@ -42645,8 +41362,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -42657,17 +41377,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deploys a Model into this Endpoint, creating a DeployedModel within it. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -42696,18 +41418,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.deployModel({ - * // Required. The name of the Endpoint resource into which to deploy a Model. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "deployedModel": {}, - * // "trafficSplit": {} - * // } - * }, + * const res = await aiplatform.metadataStores.contexts.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'metadataStores/my-metadataStore/contexts/my-context/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * @@ -42733,36 +41448,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - deployModel( - params: Params$Resource$Projects$Locations$Endpoints$Deploymodel, + wait( + params: Params$Resource$Metadatastores$Contexts$Operations$Wait, options: StreamMethodOptions ): Promise>; - deployModel( - params?: Params$Resource$Projects$Locations$Endpoints$Deploymodel, + wait( + params?: Params$Resource$Metadatastores$Contexts$Operations$Wait, options?: MethodOptions ): Promise>; - deployModel( - params: Params$Resource$Projects$Locations$Endpoints$Deploymodel, + wait( + params: Params$Resource$Metadatastores$Contexts$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deployModel( - params: Params$Resource$Projects$Locations$Endpoints$Deploymodel, + wait( + params: Params$Resource$Metadatastores$Contexts$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deployModel( - params: Params$Resource$Projects$Locations$Endpoints$Deploymodel, + wait( + params: Params$Resource$Metadatastores$Contexts$Operations$Wait, callback: BodyResponseCallback ): void; - deployModel( + wait( callback: BodyResponseCallback ): void; - deployModel( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Deploymodel + | Params$Resource$Metadatastores$Contexts$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -42778,12 +41493,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Deploymodel; + {}) as Params$Resource$Metadatastores$Contexts$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Endpoints$Deploymodel; + params = {} as Params$Resource$Metadatastores$Contexts$Operations$Wait; options = {}; } @@ -42796,18 +41511,15 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:deployModel').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -42819,9 +41531,83 @@ export namespace aiplatform_v1 { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Metadatastores$Contexts$Operations$Cancel + extends StandardParameters { /** - * Perform an unary online prediction request to a gRPC model server for Vertex first-party products and frameworks. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Metadatastores$Contexts$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Metadatastores$Contexts$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Metadatastores$Contexts$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Metadatastores$Contexts$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Metadatastores$Executions { + context: APIRequestContext; + operations: Resource$Metadatastores$Executions$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Metadatastores$Executions$Operations( + this.context + ); + } + } + + export class Resource$Metadatastores$Executions$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -42842,10 +41628,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -42853,26 +41636,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.directPredict({ - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "inputs": [], - * // "parameters": {} - * // } - * }, + * const res = await aiplatform.metadataStores.executions.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'metadataStores/my-metadataStore/executions/my-execution/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "outputs": [], - * // "parameters": {} - * // } + * // {} * } * * main().catch(e => { @@ -42887,62 +41658,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - directPredict( - params: Params$Resource$Projects$Locations$Endpoints$Directpredict, + cancel( + params: Params$Resource$Metadatastores$Executions$Operations$Cancel, options: StreamMethodOptions ): Promise>; - directPredict( - params?: Params$Resource$Projects$Locations$Endpoints$Directpredict, + cancel( + params?: Params$Resource$Metadatastores$Executions$Operations$Cancel, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - directPredict( - params: Params$Resource$Projects$Locations$Endpoints$Directpredict, + ): Promise>; + cancel( + params: Params$Resource$Metadatastores$Executions$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - directPredict( - params: Params$Resource$Projects$Locations$Endpoints$Directpredict, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - directPredict( - params: Params$Resource$Projects$Locations$Endpoints$Directpredict, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Metadatastores$Executions$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - directPredict( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Metadatastores$Executions$Operations$Cancel, + callback: BodyResponseCallback ): void; - directPredict( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Directpredict - | BodyResponseCallback + | Params$Resource$Metadatastores$Executions$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Directpredict; + {}) as Params$Resource$Metadatastores$Executions$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Directpredict; + {} as Params$Resource$Metadatastores$Executions$Operations$Cancel; options = {}; } @@ -42955,34 +41718,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:directPredict').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Perform an unary online prediction request to a gRPC model server for custom containers. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -43003,10 +41761,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -43014,25 +41769,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.directRawPredict({ - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "input": "my_input", - * // "methodName": "my_methodName" - * // } - * }, + * const res = await aiplatform.metadataStores.executions.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'metadataStores/my-metadataStore/executions/my-execution/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "output": "my_output" - * // } + * // {} * } * * main().catch(e => { @@ -43047,62 +41791,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - directRawPredict( - params: Params$Resource$Projects$Locations$Endpoints$Directrawpredict, + delete( + params: Params$Resource$Metadatastores$Executions$Operations$Delete, options: StreamMethodOptions ): Promise>; - directRawPredict( - params?: Params$Resource$Projects$Locations$Endpoints$Directrawpredict, + delete( + params?: Params$Resource$Metadatastores$Executions$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - directRawPredict( - params: Params$Resource$Projects$Locations$Endpoints$Directrawpredict, + ): Promise>; + delete( + params: Params$Resource$Metadatastores$Executions$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - directRawPredict( - params: Params$Resource$Projects$Locations$Endpoints$Directrawpredict, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - directRawPredict( - params: Params$Resource$Projects$Locations$Endpoints$Directrawpredict, - callback: BodyResponseCallback + delete( + params: Params$Resource$Metadatastores$Executions$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - directRawPredict( - callback: BodyResponseCallback + delete( + params: Params$Resource$Metadatastores$Executions$Operations$Delete, + callback: BodyResponseCallback ): void; - directRawPredict( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Directrawpredict - | BodyResponseCallback + | Params$Resource$Metadatastores$Executions$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Directrawpredict; + {}) as Params$Resource$Metadatastores$Executions$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Directrawpredict; + {} as Params$Resource$Metadatastores$Executions$Operations$Delete; options = {}; } @@ -43115,34 +41851,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:directRawPredict').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Perform an online explanation. If deployed_model_id is specified, the corresponding DeployModel must have explanation_spec populated. If deployed_model_id is not specified, all DeployedModels must have explanation_spec populated. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -43163,10 +41894,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -43174,28 +41902,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.explain({ - * // Required. The name of the Endpoint requested to serve the explanation. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "deployedModelId": "my_deployedModelId", - * // "explanationSpecOverride": {}, - * // "instances": [], - * // "parameters": {} - * // } - * }, + * const res = await aiplatform.metadataStores.executions.operations.get({ + * // The name of the operation resource. + * name: 'metadataStores/my-metadataStore/executions/my-execution/operations/my-operation', * }); * console.log(res.data); * * // Example response * // { - * // "deployedModelId": "my_deployedModelId", - * // "explanations": [], - * // "predictions": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -43211,61 +41930,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - explain( - params: Params$Resource$Projects$Locations$Endpoints$Explain, + get( + params: Params$Resource$Metadatastores$Executions$Operations$Get, options: StreamMethodOptions ): Promise>; - explain( - params?: Params$Resource$Projects$Locations$Endpoints$Explain, + get( + params?: Params$Resource$Metadatastores$Executions$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - explain( - params: Params$Resource$Projects$Locations$Endpoints$Explain, + ): Promise>; + get( + params: Params$Resource$Metadatastores$Executions$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - explain( - params: Params$Resource$Projects$Locations$Endpoints$Explain, + get( + params: Params$Resource$Metadatastores$Executions$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - explain( - params: Params$Resource$Projects$Locations$Endpoints$Explain, - callback: BodyResponseCallback + get( + params: Params$Resource$Metadatastores$Executions$Operations$Get, + callback: BodyResponseCallback ): void; - explain( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - explain( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Explain - | BodyResponseCallback + | Params$Resource$Metadatastores$Executions$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Explain; + {}) as Params$Resource$Metadatastores$Executions$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Endpoints$Explain; + params = {} as Params$Resource$Metadatastores$Executions$Operations$Get; options = {}; } @@ -43278,34 +41993,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:explain').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Fetch an asynchronous online prediction operation. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -43326,10 +42036,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -43337,29 +42044,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.endpoints.fetchPredictOperation({ - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` - * endpoint: - * 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "operationName": "my_operationName" - * // } - * }, - * }); + * const res = await aiplatform.metadataStores.executions.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'metadataStores/my-metadataStore/executions/my-execution', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -43375,58 +42078,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - fetchPredictOperation( - params: Params$Resource$Projects$Locations$Endpoints$Fetchpredictoperation, + list( + params: Params$Resource$Metadatastores$Executions$Operations$List, options: StreamMethodOptions ): Promise>; - fetchPredictOperation( - params?: Params$Resource$Projects$Locations$Endpoints$Fetchpredictoperation, + list( + params?: Params$Resource$Metadatastores$Executions$Operations$List, options?: MethodOptions - ): Promise>; - fetchPredictOperation( - params: Params$Resource$Projects$Locations$Endpoints$Fetchpredictoperation, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Metadatastores$Executions$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - fetchPredictOperation( - params: Params$Resource$Projects$Locations$Endpoints$Fetchpredictoperation, + list( + params: Params$Resource$Metadatastores$Executions$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - fetchPredictOperation( - params: Params$Resource$Projects$Locations$Endpoints$Fetchpredictoperation, - callback: BodyResponseCallback + list( + params: Params$Resource$Metadatastores$Executions$Operations$List, + callback: BodyResponseCallback ): void; - fetchPredictOperation( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - fetchPredictOperation( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Fetchpredictoperation - | BodyResponseCallback + | Params$Resource$Metadatastores$Executions$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Fetchpredictoperation; + {}) as Params$Resource$Metadatastores$Executions$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Fetchpredictoperation; + {} as Params$Resource$Metadatastores$Executions$Operations$List; options = {}; } @@ -43439,32 +42146,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:fetchPredictOperation').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Generate content with multimodal inputs. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -43485,10 +42194,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -43496,36 +42202,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.generateContent({ - * // Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * model: 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "cachedContent": "my_cachedContent", - * // "contents": [], - * // "generationConfig": {}, - * // "labels": {}, - * // "modelArmorConfig": {}, - * // "safetySettings": [], - * // "systemInstruction": {}, - * // "toolConfig": {}, - * // "tools": [] - * // } - * }, + * const res = await aiplatform.metadataStores.executions.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'metadataStores/my-metadataStore/executions/my-execution/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "candidates": [], - * // "createTime": "my_createTime", - * // "modelVersion": "my_modelVersion", - * // "promptFeedback": {}, - * // "responseId": "my_responseId", - * // "usageMetadata": {} + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -43541,62 +42232,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - generateContent( - params: Params$Resource$Projects$Locations$Endpoints$Generatecontent, + wait( + params: Params$Resource$Metadatastores$Executions$Operations$Wait, options: StreamMethodOptions ): Promise>; - generateContent( - params?: Params$Resource$Projects$Locations$Endpoints$Generatecontent, + wait( + params?: Params$Resource$Metadatastores$Executions$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - generateContent( - params: Params$Resource$Projects$Locations$Endpoints$Generatecontent, + ): Promise>; + wait( + params: Params$Resource$Metadatastores$Executions$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - generateContent( - params: Params$Resource$Projects$Locations$Endpoints$Generatecontent, + wait( + params: Params$Resource$Metadatastores$Executions$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - generateContent( - params: Params$Resource$Projects$Locations$Endpoints$Generatecontent, - callback: BodyResponseCallback + wait( + params: Params$Resource$Metadatastores$Executions$Operations$Wait, + callback: BodyResponseCallback ): void; - generateContent( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - generateContent( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Generatecontent - | BodyResponseCallback + | Params$Resource$Metadatastores$Executions$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Generatecontent; + {}) as Params$Resource$Metadatastores$Executions$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Generatecontent; + {} as Params$Resource$Metadatastores$Executions$Operations$Wait; options = {}; } @@ -43609,34 +42296,92 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+model}:generateContent').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['model'], - pathParams: ['model'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Metadatastores$Executions$Operations$Cancel + extends StandardParameters { /** - * Gets an Endpoint. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Metadatastores$Executions$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Metadatastores$Executions$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Metadatastores$Executions$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Metadatastores$Executions$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Metadatastores$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -43665,37 +42410,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.get({ - * // Required. The name of the Endpoint resource. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * const res = await aiplatform.metadataStores.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'metadataStores/my-metadataStore/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "clientConnectionConfig": {}, - * // "createTime": "my_createTime", - * // "dedicatedEndpointDns": "my_dedicatedEndpointDns", - * // "dedicatedEndpointEnabled": false, - * // "deployedModels": [], - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "enablePrivateServiceConnect": false, - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "gdcConfig": {}, - * // "genAiAdvancedFeaturesConfig": {}, - * // "labels": {}, - * // "modelDeploymentMonitoringJob": "my_modelDeploymentMonitoringJob", - * // "name": "my_name", - * // "network": "my_network", - * // "predictRequestResponseLoggingConfig": {}, - * // "privateServiceConnectConfig": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "trafficSplit": {}, - * // "updateTime": "my_updateTime" - * // } + * // {} * } * * main().catch(e => { @@ -43710,57 +42432,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Endpoints$Get, + cancel( + params: Params$Resource$Metadatastores$Operations$Cancel, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Endpoints$Get, + cancel( + params?: Params$Resource$Metadatastores$Operations$Cancel, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Endpoints$Get, + ): Promise>; + cancel( + params: Params$Resource$Metadatastores$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Endpoints$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Endpoints$Get, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Metadatastores$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Metadatastores$Operations$Cancel, + callback: BodyResponseCallback ): void; - get( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Get - | BodyResponseCallback + | Params$Resource$Metadatastores$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Get; + {}) as Params$Resource$Metadatastores$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Endpoints$Get; + params = {} as Params$Resource$Metadatastores$Operations$Cancel; options = {}; } @@ -43773,8 +42491,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -43785,19 +42503,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists Endpoints in a Location. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -43826,29 +42542,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.list({ - * // Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports `=` and `!=`. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * `display_name` supports `=` and `!=`. * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:*` or `labels:key` - key existence * A key including a space must be quoted. `labels."a key"`. * `base_model_name` only supports `=`. Some examples: * `endpoint=1` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `baseModelName="text-bison"` - * filter: 'placeholder-value', - * // Optional. Configures the Google Distributed Cloud (GDC) environment for online prediction. Only set this field when the Endpoint is to be deployed in a GDC environment. - * gdcZone: 'placeholder-value', - * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. - * orderBy: 'placeholder-value', - * // Optional. The standard list page size. - * pageSize: 'placeholder-value', - * // Optional. The standard list page token. Typically obtained via ListEndpointsResponse.next_page_token of the previous EndpointService.ListEndpoints call. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location from which to list the Endpoints. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * // Optional. Mask specifying which fields to read. - * readMask: 'placeholder-value', + * const res = await aiplatform.metadataStores.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'metadataStores/my-metadataStore/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "endpoints": [], - * // "nextPageToken": "my_nextPageToken" - * // } + * // {} * } * * main().catch(e => { @@ -43863,61 +42564,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Endpoints$List, + delete( + params: Params$Resource$Metadatastores$Operations$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Endpoints$List, + delete( + params?: Params$Resource$Metadatastores$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Endpoints$List, + ): Promise>; + delete( + params: Params$Resource$Metadatastores$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Endpoints$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Endpoints$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Metadatastores$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Metadatastores$Operations$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$List - | BodyResponseCallback + | Params$Resource$Metadatastores$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$List; + {}) as Params$Resource$Metadatastores$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Endpoints$List; + params = {} as Params$Resource$Metadatastores$Operations$Delete; options = {}; } @@ -43930,34 +42623,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/endpoints').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates an existing deployed model. Updatable fields include `min_replica_count`, `max_replica_count`, `required_replica_count`, `autoscaling_metric_specs`, `disable_container_logging` (v1 only), and `enable_container_logging` (v1beta1 only). + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -43986,22 +42674,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.mutateDeployedModel( - * { - * // Required. The name of the Endpoint resource into which to mutate a DeployedModel. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: - * 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "deployedModel": {}, - * // "updateMask": "my_updateMask" - * // } - * }, - * }, - * ); + * const res = await aiplatform.metadataStores.operations.get({ + * // The name of the operation resource. + * name: 'metadataStores/my-metadataStore/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -44026,36 +42702,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - mutateDeployedModel( - params: Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel, + get( + params: Params$Resource$Metadatastores$Operations$Get, options: StreamMethodOptions ): Promise>; - mutateDeployedModel( - params?: Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel, + get( + params?: Params$Resource$Metadatastores$Operations$Get, options?: MethodOptions ): Promise>; - mutateDeployedModel( - params: Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel, + get( + params: Params$Resource$Metadatastores$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - mutateDeployedModel( - params: Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel, + get( + params: Params$Resource$Metadatastores$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - mutateDeployedModel( - params: Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel, + get( + params: Params$Resource$Metadatastores$Operations$Get, callback: BodyResponseCallback ): void; - mutateDeployedModel( + get( callback: BodyResponseCallback ): void; - mutateDeployedModel( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel + | Params$Resource$Metadatastores$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -44071,13 +42747,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel; + {}) as Params$Resource$Metadatastores$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel; + params = {} as Params$Resource$Metadatastores$Operations$Get; options = {}; } @@ -44090,18 +42765,15 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:mutateDeployedModel').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -44115,7 +42787,7 @@ export namespace aiplatform_v1 { } /** - * Updates an Endpoint. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -44144,67 +42816,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.patch({ - * // Output only. The resource name of the Endpoint. - * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * // Required. The update mask applies to the resource. See google.protobuf.FieldMask. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "clientConnectionConfig": {}, - * // "createTime": "my_createTime", - * // "dedicatedEndpointDns": "my_dedicatedEndpointDns", - * // "dedicatedEndpointEnabled": false, - * // "deployedModels": [], - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "enablePrivateServiceConnect": false, - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "gdcConfig": {}, - * // "genAiAdvancedFeaturesConfig": {}, - * // "labels": {}, - * // "modelDeploymentMonitoringJob": "my_modelDeploymentMonitoringJob", - * // "name": "my_name", - * // "network": "my_network", - * // "predictRequestResponseLoggingConfig": {}, - * // "privateServiceConnectConfig": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "trafficSplit": {}, - * // "updateTime": "my_updateTime" - * // } - * }, + * const res = await aiplatform.metadataStores.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'metadataStores/my-metadataStore', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "clientConnectionConfig": {}, - * // "createTime": "my_createTime", - * // "dedicatedEndpointDns": "my_dedicatedEndpointDns", - * // "dedicatedEndpointEnabled": false, - * // "deployedModels": [], - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "enablePrivateServiceConnect": false, - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "gdcConfig": {}, - * // "genAiAdvancedFeaturesConfig": {}, - * // "labels": {}, - * // "modelDeploymentMonitoringJob": "my_modelDeploymentMonitoringJob", - * // "name": "my_name", - * // "network": "my_network", - * // "predictRequestResponseLoggingConfig": {}, - * // "privateServiceConnectConfig": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "trafficSplit": {}, - * // "updateTime": "my_updateTime" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -44220,57 +42850,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Endpoints$Patch, + list( + params: Params$Resource$Metadatastores$Operations$List, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Endpoints$Patch, + list( + params?: Params$Resource$Metadatastores$Operations$List, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Endpoints$Patch, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Metadatastores$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Endpoints$Patch, + list( + params: Params$Resource$Metadatastores$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Endpoints$Patch, - callback: BodyResponseCallback + list( + params: Params$Resource$Metadatastores$Operations$List, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - patch( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Patch - | BodyResponseCallback + | Params$Resource$Metadatastores$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Patch; + {}) as Params$Resource$Metadatastores$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Endpoints$Patch; + params = {} as Params$Resource$Metadatastores$Operations$List; options = {}; } @@ -44283,8 +42917,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -44295,19 +42932,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Perform an online prediction. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -44328,10 +42965,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -44339,29 +42973,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.predict({ - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "instances": [], - * // "parameters": {} - * // } - * }, + * const res = await aiplatform.metadataStores.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'metadataStores/my-metadataStore/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "deployedModelId": "my_deployedModelId", + * // "done": false, + * // "error": {}, * // "metadata": {}, - * // "model": "my_model", - * // "modelDisplayName": "my_modelDisplayName", - * // "modelVersionId": "my_modelVersionId", - * // "predictions": [] + * // "name": "my_name", + * // "response": {} * // } * } * @@ -44377,61 +43003,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - predict( - params: Params$Resource$Projects$Locations$Endpoints$Predict, + wait( + params: Params$Resource$Metadatastores$Operations$Wait, options: StreamMethodOptions ): Promise>; - predict( - params?: Params$Resource$Projects$Locations$Endpoints$Predict, + wait( + params?: Params$Resource$Metadatastores$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - predict( - params: Params$Resource$Projects$Locations$Endpoints$Predict, + ): Promise>; + wait( + params: Params$Resource$Metadatastores$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - predict( - params: Params$Resource$Projects$Locations$Endpoints$Predict, + wait( + params: Params$Resource$Metadatastores$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - predict( - params: Params$Resource$Projects$Locations$Endpoints$Predict, - callback: BodyResponseCallback + wait( + params: Params$Resource$Metadatastores$Operations$Wait, + callback: BodyResponseCallback ): void; - predict( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - predict( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Predict - | BodyResponseCallback + | Params$Resource$Metadatastores$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Predict; + {}) as Params$Resource$Metadatastores$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Endpoints$Predict; + params = {} as Params$Resource$Metadatastores$Operations$Wait; options = {}; } @@ -44444,33 +43066,103 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:predict').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + + export interface Params$Resource$Metadatastores$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Metadatastores$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Metadatastores$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Metadatastores$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Metadatastores$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Migratableresources { + context: APIRequestContext; + operations: Resource$Migratableresources$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Migratableresources$Operations( + this.context + ); + } + } + + export class Resource$Migratableresources$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -44491,10 +43183,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -44502,29 +43191,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.predictLongRunning({ - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` - * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "instances": [], - * // "parameters": {} - * // } - * }, + * const res = await aiplatform.migratableResources.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'migratableResources/my-migratableResource/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -44539,58 +43213,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - predictLongRunning( - params: Params$Resource$Projects$Locations$Endpoints$Predictlongrunning, + cancel( + params: Params$Resource$Migratableresources$Operations$Cancel, options: StreamMethodOptions ): Promise>; - predictLongRunning( - params?: Params$Resource$Projects$Locations$Endpoints$Predictlongrunning, + cancel( + params?: Params$Resource$Migratableresources$Operations$Cancel, options?: MethodOptions - ): Promise>; - predictLongRunning( - params: Params$Resource$Projects$Locations$Endpoints$Predictlongrunning, + ): Promise>; + cancel( + params: Params$Resource$Migratableresources$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - predictLongRunning( - params: Params$Resource$Projects$Locations$Endpoints$Predictlongrunning, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - predictLongRunning( - params: Params$Resource$Projects$Locations$Endpoints$Predictlongrunning, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Migratableresources$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - predictLongRunning( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Migratableresources$Operations$Cancel, + callback: BodyResponseCallback ): void; - predictLongRunning( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Predictlongrunning - | BodyResponseCallback + | Params$Resource$Migratableresources$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Predictlongrunning; + {}) as Params$Resource$Migratableresources$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Endpoints$Predictlongrunning; + params = {} as Params$Resource$Migratableresources$Operations$Cancel; options = {}; } @@ -44603,32 +43272,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:predictLongRunning').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's DeployedModel that served this prediction. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -44649,10 +43315,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -44660,26 +43323,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.rawPredict({ - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "httpBody": {} - * // } - * }, + * const res = await aiplatform.migratableResources.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'migratableResources/my-migratableResource/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] - * // } + * // {} * } * * main().catch(e => { @@ -44694,53 +43345,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - rawPredict( - params: Params$Resource$Projects$Locations$Endpoints$Rawpredict, + delete( + params: Params$Resource$Migratableresources$Operations$Delete, options: StreamMethodOptions ): Promise>; - rawPredict( - params?: Params$Resource$Projects$Locations$Endpoints$Rawpredict, + delete( + params?: Params$Resource$Migratableresources$Operations$Delete, options?: MethodOptions - ): Promise>; - rawPredict( - params: Params$Resource$Projects$Locations$Endpoints$Rawpredict, + ): Promise>; + delete( + params: Params$Resource$Migratableresources$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - rawPredict( - params: Params$Resource$Projects$Locations$Endpoints$Rawpredict, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Migratableresources$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - rawPredict( - params: Params$Resource$Projects$Locations$Endpoints$Rawpredict, - callback: BodyResponseCallback + delete( + params: Params$Resource$Migratableresources$Operations$Delete, + callback: BodyResponseCallback ): void; - rawPredict(callback: BodyResponseCallback): void; - rawPredict( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Rawpredict - | BodyResponseCallback + | Params$Resource$Migratableresources$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Rawpredict; + {}) as Params$Resource$Migratableresources$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Endpoints$Rawpredict; + params = {} as Params$Resource$Migratableresources$Operations$Delete; options = {}; } @@ -44753,32 +43404,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:rawPredict').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Perform a server-side streaming online prediction request for Vertex LLM streaming. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -44799,10 +43447,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -44810,27 +43455,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.endpoints.serverStreamingPredict({ - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: - * 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "inputs": [], - * // "parameters": {} - * // } - * }, - * }); + * const res = await aiplatform.migratableResources.operations.get({ + * // The name of the operation resource. + * name: 'migratableResources/my-migratableResource/operations/my-operation', + * }); * console.log(res.data); * * // Example response * // { - * // "outputs": [], - * // "parameters": {} + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -44846,62 +43483,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - serverStreamingPredict( - params: Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict, + get( + params: Params$Resource$Migratableresources$Operations$Get, options: StreamMethodOptions ): Promise>; - serverStreamingPredict( - params?: Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict, + get( + params?: Params$Resource$Migratableresources$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - serverStreamingPredict( - params: Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict, + ): Promise>; + get( + params: Params$Resource$Migratableresources$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - serverStreamingPredict( - params: Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict, + get( + params: Params$Resource$Migratableresources$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - serverStreamingPredict( - params: Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict, - callback: BodyResponseCallback + get( + params: Params$Resource$Migratableresources$Operations$Get, + callback: BodyResponseCallback ): void; - serverStreamingPredict( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - serverStreamingPredict( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict - | BodyResponseCallback + | Params$Resource$Migratableresources$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict; + {}) as Params$Resource$Migratableresources$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict; + params = {} as Params$Resource$Migratableresources$Operations$Get; options = {}; } @@ -44914,34 +43546,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:serverStreamingPredict').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Generate content with multimodal inputs with streaming support. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -44962,10 +43589,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -44973,37 +43597,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.endpoints.streamGenerateContent({ - * // Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * model: 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "cachedContent": "my_cachedContent", - * // "contents": [], - * // "generationConfig": {}, - * // "labels": {}, - * // "modelArmorConfig": {}, - * // "safetySettings": [], - * // "systemInstruction": {}, - * // "toolConfig": {}, - * // "tools": [] - * // } - * }, - * }); + * const res = await aiplatform.migratableResources.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'migratableResources/my-migratableResource', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "candidates": [], - * // "createTime": "my_createTime", - * // "modelVersion": "my_modelVersion", - * // "promptFeedback": {}, - * // "responseId": "my_responseId", - * // "usageMetadata": {} + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -45019,62 +43631,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - streamGenerateContent( - params: Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent, + list( + params: Params$Resource$Migratableresources$Operations$List, options: StreamMethodOptions ): Promise>; - streamGenerateContent( - params?: Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent, + list( + params?: Params$Resource$Migratableresources$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - streamGenerateContent( - params: Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent, + list( + params: Params$Resource$Migratableresources$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - streamGenerateContent( - params: Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent, + list( + params: Params$Resource$Migratableresources$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - streamGenerateContent( - params: Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent, - callback: BodyResponseCallback + list( + params: Params$Resource$Migratableresources$Operations$List, + callback: BodyResponseCallback ): void; - streamGenerateContent( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - streamGenerateContent( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent - | BodyResponseCallback + | Params$Resource$Migratableresources$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent; + {}) as Params$Resource$Migratableresources$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent; + params = {} as Params$Resource$Migratableresources$Operations$List; options = {}; } @@ -45087,34 +43698,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+model}:streamGenerateContent').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['model'], - pathParams: ['model'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Perform a streaming online prediction with an arbitrary HTTP payload. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -45135,10 +43746,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -45146,25 +43754,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.streamRawPredict({ - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "httpBody": {} - * // } - * }, + * const res = await aiplatform.migratableResources.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'migratableResources/my-migratableResource/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -45180,56 +43784,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - streamRawPredict( - params: Params$Resource$Projects$Locations$Endpoints$Streamrawpredict, + wait( + params: Params$Resource$Migratableresources$Operations$Wait, options: StreamMethodOptions ): Promise>; - streamRawPredict( - params?: Params$Resource$Projects$Locations$Endpoints$Streamrawpredict, + wait( + params?: Params$Resource$Migratableresources$Operations$Wait, options?: MethodOptions - ): Promise>; - streamRawPredict( - params: Params$Resource$Projects$Locations$Endpoints$Streamrawpredict, + ): Promise>; + wait( + params: Params$Resource$Migratableresources$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - streamRawPredict( - params: Params$Resource$Projects$Locations$Endpoints$Streamrawpredict, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + wait( + params: Params$Resource$Migratableresources$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - streamRawPredict( - params: Params$Resource$Projects$Locations$Endpoints$Streamrawpredict, - callback: BodyResponseCallback + wait( + params: Params$Resource$Migratableresources$Operations$Wait, + callback: BodyResponseCallback ): void; - streamRawPredict( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - streamRawPredict( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Streamrawpredict - | BodyResponseCallback + | Params$Resource$Migratableresources$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Streamrawpredict; + {}) as Params$Resource$Migratableresources$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Endpoints$Streamrawpredict; + params = {} as Params$Resource$Migratableresources$Operations$Wait; options = {}; } @@ -45242,32 +43847,103 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:streamRawPredict').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Migratableresources$Operations$Cancel + extends StandardParameters { /** - * Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Migratableresources$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Migratableresources$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Migratableresources$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Migratableresources$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Modeldeploymentmonitoringjobs { + context: APIRequestContext; + operations: Resource$Modeldeploymentmonitoringjobs$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Modeldeploymentmonitoringjobs$Operations( + this.context + ); + } + } + + export class Resource$Modeldeploymentmonitoringjobs$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -45296,29 +43972,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.undeployModel({ - * // Required. The name of the Endpoint resource from which to undeploy a Model. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "deployedModelId": "my_deployedModelId", - * // "trafficSplit": {} - * // } - * }, + * const res = await aiplatform.modelDeploymentMonitoringJobs.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -45333,58 +43994,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - undeployModel( - params: Params$Resource$Projects$Locations$Endpoints$Undeploymodel, + cancel( + params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Cancel, options: StreamMethodOptions ): Promise>; - undeployModel( - params?: Params$Resource$Projects$Locations$Endpoints$Undeploymodel, + cancel( + params?: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Cancel, options?: MethodOptions - ): Promise>; - undeployModel( - params: Params$Resource$Projects$Locations$Endpoints$Undeploymodel, + ): Promise>; + cancel( + params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - undeployModel( - params: Params$Resource$Projects$Locations$Endpoints$Undeploymodel, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - undeployModel( - params: Params$Resource$Projects$Locations$Endpoints$Undeploymodel, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - undeployModel( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Cancel, + callback: BodyResponseCallback ): void; - undeployModel( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Undeploymodel - | BodyResponseCallback + | Params$Resource$Modeldeploymentmonitoringjobs$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Undeploymodel; + {}) as Params$Resource$Modeldeploymentmonitoringjobs$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Undeploymodel; + {} as Params$Resource$Modeldeploymentmonitoringjobs$Operations$Cancel; options = {}; } @@ -45397,32 +44054,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:undeployModel').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates an Endpoint with a long running operation. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -45451,17 +44105,142 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.update({ - * // Output only. The resource name of the Endpoint. - * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * const res = await aiplatform.modelDeploymentMonitoringJobs.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob/operations/my-operation', + * }); + * console.log(res.data); * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "endpoint": {} - * // } - * }, + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Modeldeploymentmonitoringjobs$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Modeldeploymentmonitoringjobs$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Modeldeploymentmonitoringjobs$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.modelDeploymentMonitoringJobs.operations.get({ + * // The name of the operation resource. + * name: 'modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob/operations/my-operation', * }); * console.log(res.data); * @@ -45487,36 +44266,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - update( - params: Params$Resource$Projects$Locations$Endpoints$Update, + get( + params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Get, options: StreamMethodOptions ): Promise>; - update( - params?: Params$Resource$Projects$Locations$Endpoints$Update, + get( + params?: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Get, options?: MethodOptions ): Promise>; - update( - params: Params$Resource$Projects$Locations$Endpoints$Update, + get( + params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - update( - params: Params$Resource$Projects$Locations$Endpoints$Update, + get( + params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - update( - params: Params$Resource$Projects$Locations$Endpoints$Update, + get( + params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Get, callback: BodyResponseCallback ): void; - update( + get( callback: BodyResponseCallback ): void; - update( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Update + | Params$Resource$Modeldeploymentmonitoringjobs$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -45532,12 +44311,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Update; + {}) as Params$Resource$Modeldeploymentmonitoringjobs$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Endpoints$Update; + params = + {} as Params$Resource$Modeldeploymentmonitoringjobs$Operations$Get; options = {}; } @@ -45550,8 +44330,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:update').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -45570,298 +44350,9 @@ export namespace aiplatform_v1 { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Endpoints$Computetokens - extends StandardParameters { - /** - * Required. The name of the Endpoint requested to get lists of tokens and token ids. - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ComputeTokensRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Counttokens - extends StandardParameters { - /** - * Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1CountTokensRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Create - extends StandardParameters { - /** - * Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are `[0-9]` with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as `?endpoint_id=12345`. This is the fallback for fields that are not included in either the URI or the body. - */ - endpointId?: string; - /** - * Required. The resource name of the Location to create the Endpoint in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Endpoint; - } - export interface Params$Resource$Projects$Locations$Endpoints$Delete - extends StandardParameters { - /** - * Required. The name of the Endpoint resource to be deleted. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Endpoints$Deploymodel - extends StandardParameters { - /** - * Required. The name of the Endpoint resource into which to deploy a Model. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1DeployModelRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Directpredict - extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1DirectPredictRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Directrawpredict - extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1DirectRawPredictRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Explain - extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the explanation. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ExplainRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Fetchpredictoperation - extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1FetchPredictOperationRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Generatecontent - extends StandardParameters { - /** - * Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - model?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1GenerateContentRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Get - extends StandardParameters { - /** - * Required. The name of the Endpoint resource. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Endpoints$List - extends StandardParameters { - /** - * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports `=` and `!=`. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * `display_name` supports `=` and `!=`. * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:*` or `labels:key` - key existence * A key including a space must be quoted. `labels."a key"`. * `base_model_name` only supports `=`. Some examples: * `endpoint=1` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `baseModelName="text-bison"` - */ - filter?: string; - /** - * Optional. Configures the Google Distributed Cloud (GDC) environment for online prediction. Only set this field when the Endpoint is to be deployed in a GDC environment. - */ - gdcZone?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. - */ - orderBy?: string; - /** - * Optional. The standard list page size. - */ - pageSize?: number; - /** - * Optional. The standard list page token. Typically obtained via ListEndpointsResponse.next_page_token of the previous EndpointService.ListEndpoints call. - */ - pageToken?: string; - /** - * Required. The resource name of the Location from which to list the Endpoints. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - /** - * Optional. Mask specifying which fields to read. - */ - readMask?: string; - } - export interface Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel - extends StandardParameters { - /** - * Required. The name of the Endpoint resource into which to mutate a DeployedModel. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1MutateDeployedModelRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Patch - extends StandardParameters { - /** - * Output only. The resource name of the Endpoint. - */ - name?: string; - /** - * Required. The update mask applies to the resource. See google.protobuf.FieldMask. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Endpoint; - } - export interface Params$Resource$Projects$Locations$Endpoints$Predict - extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1PredictRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Predictlongrunning - extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1PredictLongRunningRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Rawpredict - extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1RawPredictRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict - extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1StreamingPredictRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent - extends StandardParameters { - /** - * Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - model?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1GenerateContentRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Streamrawpredict - extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1StreamRawPredictRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Undeploymodel - extends StandardParameters { - /** - * Required. The name of the Endpoint resource from which to undeploy a Model. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1UndeployModelRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Update - extends StandardParameters { - /** - * Output only. The resource name of the Endpoint. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1UpdateEndpointLongRunningRequest; - } - - export class Resource$Projects$Locations$Endpoints$Chat { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Exposes an OpenAI-compatible endpoint for chat completions. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -45882,10 +44373,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -45893,27 +44381,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.chat.completions({ - * // Required. The name of the endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] - * // } - * }, + * const res = await aiplatform.modelDeploymentMonitoringJobs.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -45929,54 +44415,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - completions( - params: Params$Resource$Projects$Locations$Endpoints$Chat$Completions, + list( + params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$List, options: StreamMethodOptions ): Promise>; - completions( - params?: Params$Resource$Projects$Locations$Endpoints$Chat$Completions, + list( + params?: Params$Resource$Modeldeploymentmonitoringjobs$Operations$List, options?: MethodOptions - ): Promise>; - completions( - params: Params$Resource$Projects$Locations$Endpoints$Chat$Completions, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - completions( - params: Params$Resource$Projects$Locations$Endpoints$Chat$Completions, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - completions( - params: Params$Resource$Projects$Locations$Endpoints$Chat$Completions, - callback: BodyResponseCallback + list( + params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$List, + callback: BodyResponseCallback ): void; - completions(callback: BodyResponseCallback): void; - completions( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Chat$Completions - | BodyResponseCallback + | Params$Resource$Modeldeploymentmonitoringjobs$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Chat$Completions; + {}) as Params$Resource$Modeldeploymentmonitoringjobs$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Chat$Completions; + {} as Params$Resource$Modeldeploymentmonitoringjobs$Operations$List; options = {}; } @@ -45989,64 +44483,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}/chat/completions').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Endpoints$Chat$Completions - extends StandardParameters { - /** - * Required. The name of the endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleApiHttpBody; - } - - export class Resource$Projects$Locations$Endpoints$Deployedmodels { - context: APIRequestContext; - invoke: Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke; - constructor(context: APIRequestContext) { - this.context = context; - this.invoke = - new Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke( - this.context + return createAPIRequest( + parameters ); - } - } - - export class Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + } } /** - * Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -46067,10 +44531,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -46078,32 +44539,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.endpoints.deployedModels.invoke.invoke({ - * // ID of the DeployedModel that serves the invoke request. - * deployedModelId: 'placeholder-value', - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: - * 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * - * invokeId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "deployedModelId": "my_deployedModelId", - * // "httpBody": {} - * // } - * }, - * }); + * const res = await aiplatform.modelDeploymentMonitoringJobs.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -46119,54 +44569,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - invoke( - params: Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke, + wait( + params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Wait, options: StreamMethodOptions ): Promise>; - invoke( - params?: Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke, + wait( + params?: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Wait, options?: MethodOptions - ): Promise>; - invoke( - params: Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke, + ): Promise>; + wait( + params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - invoke( - params: Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + wait( + params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - invoke( - params: Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke, - callback: BodyResponseCallback + wait( + params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Wait, + callback: BodyResponseCallback ): void; - invoke(callback: BodyResponseCallback): void; - invoke( + wait( + callback: BodyResponseCallback + ): void; + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke - | BodyResponseCallback + | Params$Resource$Modeldeploymentmonitoringjobs$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke; + {}) as Params$Resource$Modeldeploymentmonitoringjobs$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke; + {} as Params$Resource$Modeldeploymentmonitoringjobs$Operations$Wait; options = {}; } @@ -46179,410 +44633,107 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + - '/v1/{+endpoint}/deployedModels/{deployedModelId}/invoke/{+invokeId}' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['endpoint', 'deployedModelId', 'invokeId'], - pathParams: ['deployedModelId', 'endpoint', 'invokeId'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke + export interface Params$Resource$Modeldeploymentmonitoringjobs$Operations$Cancel extends StandardParameters { /** - * ID of the DeployedModel that serves the invoke request. - */ - deployedModelId?: string; - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - /** - * + * The name of the operation resource to be cancelled. */ - invokeId?: string; - + name?: string; + } + export interface Params$Resource$Modeldeploymentmonitoringjobs$Operations$Delete + extends StandardParameters { /** - * Request body metadata + * The name of the operation resource to be deleted. */ - requestBody?: Schema$GoogleCloudAiplatformV1InvokeRequest; + name?: string; } - - export class Resource$Projects$Locations$Endpoints$Invoke { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - + export interface Params$Resource$Modeldeploymentmonitoringjobs$Operations$Get + extends StandardParameters { /** - * Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const aiplatform = google.aiplatform('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.invoke.invoke({ - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * - * invokeId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "deployedModelId": "my_deployedModelId", - * // "httpBody": {} - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * The name of the operation resource. */ - invoke( - params: Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke, - options: StreamMethodOptions - ): Promise>; - invoke( - params?: Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke, - options?: MethodOptions - ): Promise>; - invoke( - params: Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - invoke( - params: Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - invoke( - params: Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke, - callback: BodyResponseCallback - ): void; - invoke(callback: BodyResponseCallback): void; - invoke( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+endpoint}/invoke/{+invokeId}').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['endpoint', 'invokeId'], - pathParams: ['endpoint', 'invokeId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } + name?: string; } - - export interface Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke + export interface Params$Resource$Modeldeploymentmonitoringjobs$Operations$List extends StandardParameters { /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * The standard list filter. */ - endpoint?: string; + filter?: string; /** - * + * The name of the operation's parent resource. */ - invokeId?: string; - + name?: string; /** - * Request body metadata + * The standard list page size. */ - requestBody?: Schema$GoogleCloudAiplatformV1InvokeRequest; - } - - export class Resource$Projects$Locations$Endpoints$Openapi { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - + pageSize?: number; /** - * Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const aiplatform = google.aiplatform('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.openapi.embeddings({ - * // ID of the DeployedModel that serves the invoke request. - * deployedModelId: 'placeholder-value', - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: 'projects/my-project/locations/my-location/endpoints/openapi', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * The standard list page token. */ - embeddings( - params: Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings, - options: StreamMethodOptions - ): Promise>; - embeddings( - params?: Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings, - options?: MethodOptions - ): Promise>; - embeddings( - params: Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - embeddings( - params: Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - embeddings( - params: Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings, - callback: BodyResponseCallback - ): void; - embeddings(callback: BodyResponseCallback): void; - embeddings( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+endpoint}/embeddings').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } - - export interface Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings + export interface Params$Resource$Modeldeploymentmonitoringjobs$Operations$Wait extends StandardParameters { /** - * ID of the DeployedModel that serves the invoke request. + * The name of the operation resource to wait on. */ - deployedModelId?: string; + name?: string; /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - endpoint?: string; + timeout?: string; + } - /** - * Request body metadata - */ - requestBody?: Schema$GoogleApiHttpBody; + export class Resource$Models { + context: APIRequestContext; + evaluations: Resource$Models$Evaluations; + operations: Resource$Models$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.evaluations = new Resource$Models$Evaluations(this.context); + this.operations = new Resource$Models$Operations(this.context); + } } - export class Resource$Projects$Locations$Endpoints$Operations { + export class Resource$Models$Evaluations { + context: APIRequestContext; + operations: Resource$Models$Evaluations$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Models$Evaluations$Operations( + this.context + ); + } + } + + export class Resource$Models$Evaluations$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -46618,9 +44769,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.operations.cancel({ + * const res = await aiplatform.models.evaluations.operations.cancel({ * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint/operations/my-operation', + * name: 'models/my-model/evaluations/my-evaluation/operations/my-operation', * }); * console.log(res.data); * @@ -46641,31 +44792,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Cancel, + params: Params$Resource$Models$Evaluations$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Endpoints$Operations$Cancel, + params?: Params$Resource$Models$Evaluations$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Cancel, + params: Params$Resource$Models$Evaluations$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Cancel, + params: Params$Resource$Models$Evaluations$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Cancel, + params: Params$Resource$Models$Evaluations$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Operations$Cancel + | Params$Resource$Models$Evaluations$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -46681,13 +44832,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Operations$Cancel; + {}) as Params$Resource$Models$Evaluations$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Endpoints$Operations$Cancel; + params = {} as Params$Resource$Models$Evaluations$Operations$Cancel; options = {}; } @@ -46751,9 +44901,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.operations.delete({ + * const res = await aiplatform.models.evaluations.operations.delete({ * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint/operations/my-operation', + * name: 'models/my-model/evaluations/my-evaluation/operations/my-operation', * }); * console.log(res.data); * @@ -46774,31 +44924,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Delete, + params: Params$Resource$Models$Evaluations$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Endpoints$Operations$Delete, + params?: Params$Resource$Models$Evaluations$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Delete, + params: Params$Resource$Models$Evaluations$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Delete, + params: Params$Resource$Models$Evaluations$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Delete, + params: Params$Resource$Models$Evaluations$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Operations$Delete + | Params$Resource$Models$Evaluations$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -46814,13 +44964,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Operations$Delete; + {}) as Params$Resource$Models$Evaluations$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Endpoints$Operations$Delete; + params = {} as Params$Resource$Models$Evaluations$Operations$Delete; options = {}; } @@ -46884,9 +45033,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.operations.get({ + * const res = await aiplatform.models.evaluations.operations.get({ * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint/operations/my-operation', + * name: 'models/my-model/evaluations/my-evaluation/operations/my-operation', * }); * console.log(res.data); * @@ -46913,27 +45062,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Get, + params: Params$Resource$Models$Evaluations$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Endpoints$Operations$Get, + params?: Params$Resource$Models$Evaluations$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Get, + params: Params$Resource$Models$Evaluations$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Get, + params: Params$Resource$Models$Evaluations$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Get, + params: Params$Resource$Models$Evaluations$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -46941,7 +45090,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Operations$Get + | Params$Resource$Models$Evaluations$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -46957,13 +45106,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Operations$Get; + {}) as Params$Resource$Models$Evaluations$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Endpoints$Operations$Get; + params = {} as Params$Resource$Models$Evaluations$Operations$Get; options = {}; } @@ -47027,11 +45175,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.operations.list({ + * const res = await aiplatform.models.evaluations.operations.list({ * // The standard list filter. * filter: 'placeholder-value', * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * name: 'models/my-model/evaluations/my-evaluation', * // The standard list page size. * pageSize: 'placeholder-value', * // The standard list page token. @@ -47062,29 +45210,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Endpoints$Operations$List, + params: Params$Resource$Models$Evaluations$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Endpoints$Operations$List, + params?: Params$Resource$Models$Evaluations$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Endpoints$Operations$List, + params: Params$Resource$Models$Evaluations$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Endpoints$Operations$List, + params: Params$Resource$Models$Evaluations$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Endpoints$Operations$List, + params: Params$Resource$Models$Evaluations$Operations$List, callback: BodyResponseCallback ): void; list( @@ -47092,7 +45240,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Operations$List + | Params$Resource$Models$Evaluations$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -47110,13 +45258,12 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Operations$List; + {}) as Params$Resource$Models$Evaluations$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Endpoints$Operations$List; + params = {} as Params$Resource$Models$Evaluations$Operations$List; options = {}; } @@ -47185,9 +45332,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.operations.wait({ + * const res = await aiplatform.models.evaluations.operations.wait({ * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint/operations/my-operation', + * name: 'models/my-model/evaluations/my-evaluation/operations/my-operation', * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. * timeout: 'placeholder-value', * }); @@ -47216,27 +45363,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Wait, + params: Params$Resource$Models$Evaluations$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Endpoints$Operations$Wait, + params?: Params$Resource$Models$Evaluations$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Wait, + params: Params$Resource$Models$Evaluations$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Wait, + params: Params$Resource$Models$Evaluations$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Wait, + params: Params$Resource$Models$Evaluations$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -47244,7 +45391,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Operations$Wait + | Params$Resource$Models$Evaluations$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -47260,13 +45407,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Operations$Wait; + {}) as Params$Resource$Models$Evaluations$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Endpoints$Operations$Wait; + params = {} as Params$Resource$Models$Evaluations$Operations$Wait; options = {}; } @@ -47301,28 +45447,28 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Endpoints$Operations$Cancel + export interface Params$Resource$Models$Evaluations$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Endpoints$Operations$Delete + export interface Params$Resource$Models$Evaluations$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Endpoints$Operations$Get + export interface Params$Resource$Models$Evaluations$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Endpoints$Operations$List + export interface Params$Resource$Models$Evaluations$Operations$List extends StandardParameters { /** * The standard list filter. @@ -47345,7 +45491,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Endpoints$Operations$Wait + export interface Params$Resource$Models$Evaluations$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -47357,14 +45503,14 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Evaluationitems { + export class Resource$Models$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates an Evaluation Item. + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -47393,42 +45539,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.evaluationItems.create({ - * // Required. The resource name of the Location to create the Evaluation Item in. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "error": {}, - * // "evaluationItemType": "my_evaluationItemType", - * // "evaluationRequest": {}, - * // "evaluationResponse": {}, - * // "gcsUri": "my_gcsUri", - * // "labels": {}, - * // "metadata": {}, - * // "name": "my_name" - * // } - * }, + * const res = await aiplatform.models.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'models/my-model/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "error": {}, - * // "evaluationItemType": "my_evaluationItemType", - * // "evaluationRequest": {}, - * // "evaluationResponse": {}, - * // "gcsUri": "my_gcsUri", - * // "labels": {}, - * // "metadata": {}, - * // "name": "my_name" - * // } + * // {} * } * * main().catch(e => { @@ -47443,62 +45561,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Evaluationitems$Create, + cancel( + params: Params$Resource$Models$Operations$Cancel, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Evaluationitems$Create, + cancel( + params?: Params$Resource$Models$Operations$Cancel, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - create( - params: Params$Resource$Projects$Locations$Evaluationitems$Create, + ): Promise>; + cancel( + params: Params$Resource$Models$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Evaluationitems$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Evaluationitems$Create, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Models$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Models$Operations$Cancel, + callback: BodyResponseCallback ): void; - create( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Evaluationitems$Create - | BodyResponseCallback + | Params$Resource$Models$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Evaluationitems$Create; + {}) as Params$Resource$Models$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Evaluationitems$Create; + params = {} as Params$Resource$Models$Operations$Cancel; options = {}; } @@ -47511,34 +45620,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/evaluationItems').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes an Evaluation Item. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -47567,20 +45671,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.evaluationItems.delete({ - * // Required. The name of the EvaluationItem resource to be deleted. Format: `projects/{project\}/locations/{location\}/evaluationItems/{evaluation_item\}` - * name: 'projects/my-project/locations/my-location/evaluationItems/my-evaluationItem', + * const res = await aiplatform.models.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'models/my-model/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -47596,57 +45694,52 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Evaluationitems$Delete, + params: Params$Resource$Models$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Evaluationitems$Delete, + params?: Params$Resource$Models$Operations$Delete, options?: MethodOptions - ): Promise>; + ): Promise>; delete( - params: Params$Resource$Projects$Locations$Evaluationitems$Delete, + params: Params$Resource$Models$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Evaluationitems$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Evaluationitems$Delete, - callback: BodyResponseCallback + params: Params$Resource$Models$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - callback: BodyResponseCallback + params: Params$Resource$Models$Operations$Delete, + callback: BodyResponseCallback ): void; + delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Evaluationitems$Delete - | BodyResponseCallback + | Params$Resource$Models$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Evaluationitems$Delete; + {}) as Params$Resource$Models$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Evaluationitems$Delete; + params = {} as Params$Resource$Models$Operations$Delete; options = {}; } @@ -47671,17 +45764,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets an Evaluation Item. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -47710,24 +45803,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.evaluationItems.get({ - * // Required. The name of the EvaluationItem resource. Format: `projects/{project\}/locations/{location\}/evaluationItems/{evaluation_item\}` - * name: 'projects/my-project/locations/my-location/evaluationItems/my-evaluationItem', + * const res = await aiplatform.models.operations.get({ + * // The name of the operation resource. + * name: 'models/my-model/operations/my-operation', * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", + * // "done": false, * // "error": {}, - * // "evaluationItemType": "my_evaluationItemType", - * // "evaluationRequest": {}, - * // "evaluationResponse": {}, - * // "gcsUri": "my_gcsUri", - * // "labels": {}, * // "metadata": {}, - * // "name": "my_name" + * // "name": "my_name", + * // "response": {} * // } * } * @@ -47744,60 +45832,56 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Evaluationitems$Get, + params: Params$Resource$Models$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Evaluationitems$Get, + params?: Params$Resource$Models$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; + ): Promise>; get( - params: Params$Resource$Projects$Locations$Evaluationitems$Get, + params: Params$Resource$Models$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Evaluationitems$Get, + params: Params$Resource$Models$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Evaluationitems$Get, - callback: BodyResponseCallback + params: Params$Resource$Models$Operations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Evaluationitems$Get - | BodyResponseCallback + | Params$Resource$Models$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Evaluationitems$Get; + {}) as Params$Resource$Models$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Evaluationitems$Get; + params = {} as Params$Resource$Models$Operations$Get; options = {}; } @@ -47822,19 +45906,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists Evaluation Items. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -47863,24 +45945,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.evaluationItems.list({ - * // Optional. Filter expression that matches a subset of the EvaluationItems to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160). + * const res = await aiplatform.models.operations.list({ + * // The standard list filter. * filter: 'placeholder-value', - * // Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. - * orderBy: 'placeholder-value', - * // Optional. The maximum number of Evaluation Items to return. + * // The name of the operation's parent resource. + * name: 'models/my-model', + * // The standard list page size. * pageSize: 'placeholder-value', - * // Optional. A page token, received from a previous `ListEvaluationItems` call. Provide this to retrieve the subsequent page. + * // The standard list page token. * pageToken: 'placeholder-value', - * // Required. The resource name of the Location from which to list the Evaluation Items. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "evaluationItems": [], - * // "nextPageToken": "my_nextPageToken" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -47897,60 +45980,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Evaluationitems$List, + params: Params$Resource$Models$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Evaluationitems$List, + params?: Params$Resource$Models$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Evaluationitems$List, + params: Params$Resource$Models$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Evaluationitems$List, + params: Params$Resource$Models$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Evaluationitems$List, - callback: BodyResponseCallback + params: Params$Resource$Models$Operations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Evaluationitems$List - | BodyResponseCallback + | Params$Resource$Models$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Evaluationitems$List; + {}) as Params$Resource$Models$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Evaluationitems$List; + params = {} as Params$Resource$Models$Operations$List; options = {}; } @@ -47963,7 +46046,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/evaluationItems').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -47973,81 +46056,242 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - export interface Params$Resource$Projects$Locations$Evaluationitems$Create - extends StandardParameters { /** - * Required. The resource name of the Location to create the Evaluation Item in. Format: `projects/{project\}/locations/{location\}` + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.models.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'models/my-model/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. */ - parent?: string; + wait( + params: Params$Resource$Models$Operations$Wait, + options: StreamMethodOptions + ): Promise>; + wait( + params?: Params$Resource$Models$Operations$Wait, + options?: MethodOptions + ): Promise>; + wait( + params: Params$Resource$Models$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Models$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Models$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Models$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Models$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Models$Operations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + export interface Params$Resource$Models$Operations$Cancel + extends StandardParameters { /** - * Request body metadata + * The name of the operation resource to be cancelled. */ - requestBody?: Schema$GoogleCloudAiplatformV1EvaluationItem; + name?: string; } - export interface Params$Resource$Projects$Locations$Evaluationitems$Delete + export interface Params$Resource$Models$Operations$Delete extends StandardParameters { /** - * Required. The name of the EvaluationItem resource to be deleted. Format: `projects/{project\}/locations/{location\}/evaluationItems/{evaluation_item\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Evaluationitems$Get + export interface Params$Resource$Models$Operations$Get extends StandardParameters { /** - * Required. The name of the EvaluationItem resource. Format: `projects/{project\}/locations/{location\}/evaluationItems/{evaluation_item\}` + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Evaluationitems$List + export interface Params$Resource$Models$Operations$List extends StandardParameters { /** - * Optional. Filter expression that matches a subset of the EvaluationItems to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160). + * The standard list filter. */ filter?: string; /** - * Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. + * The name of the operation's parent resource. */ - orderBy?: string; + name?: string; /** - * Optional. The maximum number of Evaluation Items to return. + * The standard list page size. */ pageSize?: number; /** - * Optional. A page token, received from a previous `ListEvaluationItems` call. Provide this to retrieve the subsequent page. + * The standard list page token. */ pageToken?: string; /** - * Required. The resource name of the Location from which to list the Evaluation Items. Format: `projects/{project\}/locations/{location\}` + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - parent?: string; + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Models$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; } - export class Resource$Projects$Locations$Evaluationruns { + export class Resource$Notebookexecutionjobs { + context: APIRequestContext; + operations: Resource$Notebookexecutionjobs$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Notebookexecutionjobs$Operations( + this.context + ); + } + } + + export class Resource$Notebookexecutionjobs$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Cancels an Evaluation Run. Attempts to cancel a running Evaluation Run asynchronously. Status of run can be checked via GetEvaluationRun. + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -48076,15 +46320,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.evaluationRuns.cancel({ - * // Required. The name of the EvaluationRun resource to be cancelled. Format: `projects/{project\}/locations/{location\}/evaluationRuns/{evaluation_run\}` - * name: 'projects/my-project/locations/my-location/evaluationRuns/my-evaluationRun', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, + * const res = await aiplatform.notebookExecutionJobs.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'notebookExecutionJobs/my-notebookExecutionJob/operations/my-operation', * }); * console.log(res.data); * @@ -48105,31 +46343,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Evaluationruns$Cancel, + params: Params$Resource$Notebookexecutionjobs$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Evaluationruns$Cancel, + params?: Params$Resource$Notebookexecutionjobs$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Evaluationruns$Cancel, + params: Params$Resource$Notebookexecutionjobs$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Evaluationruns$Cancel, + params: Params$Resource$Notebookexecutionjobs$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Evaluationruns$Cancel, + params: Params$Resource$Notebookexecutionjobs$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Evaluationruns$Cancel + | Params$Resource$Notebookexecutionjobs$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -48145,12 +46383,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Evaluationruns$Cancel; + {}) as Params$Resource$Notebookexecutionjobs$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Evaluationruns$Cancel; + params = {} as Params$Resource$Notebookexecutionjobs$Operations$Cancel; options = {}; } @@ -48185,7 +46423,7 @@ export namespace aiplatform_v1 { } /** - * Creates an Evaluation Run. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -48214,48 +46452,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.evaluationRuns.create({ - * // Required. The resource name of the Location to create the Evaluation Run in. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "completionTime": "my_completionTime", - * // "createTime": "my_createTime", - * // "dataSource": {}, - * // "displayName": "my_displayName", - * // "error": {}, - * // "evaluationConfig": {}, - * // "evaluationResults": {}, - * // "evaluationSetSnapshot": "my_evaluationSetSnapshot", - * // "inferenceConfigs": {}, - * // "labels": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "state": "my_state" - * // } - * }, + * const res = await aiplatform.notebookExecutionJobs.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'notebookExecutionJobs/my-notebookExecutionJob/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "completionTime": "my_completionTime", - * // "createTime": "my_createTime", - * // "dataSource": {}, - * // "displayName": "my_displayName", - * // "error": {}, - * // "evaluationConfig": {}, - * // "evaluationResults": {}, - * // "evaluationSetSnapshot": "my_evaluationSetSnapshot", - * // "inferenceConfigs": {}, - * // "labels": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "state": "my_state" - * // } + * // {} * } * * main().catch(e => { @@ -48270,61 +46474,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Evaluationruns$Create, + delete( + params: Params$Resource$Notebookexecutionjobs$Operations$Delete, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Evaluationruns$Create, + delete( + params?: Params$Resource$Notebookexecutionjobs$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - create( - params: Params$Resource$Projects$Locations$Evaluationruns$Create, + ): Promise>; + delete( + params: Params$Resource$Notebookexecutionjobs$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Evaluationruns$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Evaluationruns$Create, - callback: BodyResponseCallback + delete( + params: Params$Resource$Notebookexecutionjobs$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + delete( + params: Params$Resource$Notebookexecutionjobs$Operations$Delete, + callback: BodyResponseCallback ): void; - create( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Evaluationruns$Create - | BodyResponseCallback + | Params$Resource$Notebookexecutionjobs$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Evaluationruns$Create; + {}) as Params$Resource$Notebookexecutionjobs$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Evaluationruns$Create; + params = {} as Params$Resource$Notebookexecutionjobs$Operations$Delete; options = {}; } @@ -48337,34 +46533,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/evaluationRuns').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes an Evaluation Run. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -48393,9 +46584,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.evaluationRuns.delete({ - * // Required. The name of the EvaluationRun resource to be deleted. Format: `projects/{project\}/locations/{location\}/evaluationRuns/{evaluation_run\}` - * name: 'projects/my-project/locations/my-location/evaluationRuns/my-evaluationRun', + * const res = await aiplatform.notebookExecutionJobs.operations.get({ + * // The name of the operation resource. + * name: 'notebookExecutionJobs/my-notebookExecutionJob/operations/my-operation', * }); * console.log(res.data); * @@ -48421,36 +46612,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Evaluationruns$Delete, + get( + params: Params$Resource$Notebookexecutionjobs$Operations$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Evaluationruns$Delete, + get( + params?: Params$Resource$Notebookexecutionjobs$Operations$Get, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Evaluationruns$Delete, + get( + params: Params$Resource$Notebookexecutionjobs$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Evaluationruns$Delete, + get( + params: Params$Resource$Notebookexecutionjobs$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Evaluationruns$Delete, + get( + params: Params$Resource$Notebookexecutionjobs$Operations$Get, callback: BodyResponseCallback ): void; - delete( + get( callback: BodyResponseCallback ): void; - delete( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Evaluationruns$Delete + | Params$Resource$Notebookexecutionjobs$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -48466,12 +46657,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Evaluationruns$Delete; + {}) as Params$Resource$Notebookexecutionjobs$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Evaluationruns$Delete; + params = {} as Params$Resource$Notebookexecutionjobs$Operations$Get; options = {}; } @@ -48485,7 +46676,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -48506,7 +46697,7 @@ export namespace aiplatform_v1 { } /** - * Gets an Evaluation Run. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -48535,27 +46726,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.evaluationRuns.get({ - * // Required. The name of the EvaluationRun resource. Format: `projects/{project\}/locations/{location\}/evaluationRuns/{evaluation_run\}` - * name: 'projects/my-project/locations/my-location/evaluationRuns/my-evaluationRun', + * const res = await aiplatform.notebookExecutionJobs.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'notebookExecutionJobs/my-notebookExecutionJob', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "completionTime": "my_completionTime", - * // "createTime": "my_createTime", - * // "dataSource": {}, - * // "displayName": "my_displayName", - * // "error": {}, - * // "evaluationConfig": {}, - * // "evaluationResults": {}, - * // "evaluationSetSnapshot": "my_evaluationSetSnapshot", - * // "inferenceConfigs": {}, - * // "labels": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "state": "my_state" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -48571,61 +46760,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Evaluationruns$Get, + list( + params: Params$Resource$Notebookexecutionjobs$Operations$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Evaluationruns$Get, + list( + params?: Params$Resource$Notebookexecutionjobs$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Evaluationruns$Get, + list( + params: Params$Resource$Notebookexecutionjobs$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Evaluationruns$Get, + list( + params: Params$Resource$Notebookexecutionjobs$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Evaluationruns$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Notebookexecutionjobs$Operations$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Evaluationruns$Get - | BodyResponseCallback + | Params$Resource$Notebookexecutionjobs$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Evaluationruns$Get; + {}) as Params$Resource$Notebookexecutionjobs$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Evaluationruns$Get; + params = {} as Params$Resource$Notebookexecutionjobs$Operations$List; options = {}; } @@ -48638,7 +46827,10 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -48650,19 +46842,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists Evaluation Runs. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -48691,24 +46883,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.evaluationRuns.list({ - * // Optional. Filter expression that matches a subset of the EvaluationRuns to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160). - * filter: 'placeholder-value', - * // Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. - * orderBy: 'placeholder-value', - * // Optional. The maximum number of Evaluation Runs to return. - * pageSize: 'placeholder-value', - * // Optional. A page token, received from a previous `ListEvaluationRuns` call. Provide this to retrieve the subsequent page. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location from which to list the Evaluation Runs. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * const res = await aiplatform.notebookExecutionJobs.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'notebookExecutionJobs/my-notebookExecutionJob/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "evaluationRuns": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -48724,61 +46913,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Evaluationruns$List, + wait( + params: Params$Resource$Notebookexecutionjobs$Operations$Wait, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Evaluationruns$List, + wait( + params?: Params$Resource$Notebookexecutionjobs$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Evaluationruns$List, + ): Promise>; + wait( + params: Params$Resource$Notebookexecutionjobs$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Evaluationruns$List, + wait( + params: Params$Resource$Notebookexecutionjobs$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Evaluationruns$List, - callback: BodyResponseCallback + wait( + params: Params$Resource$Notebookexecutionjobs$Operations$Wait, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - list( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Evaluationruns$List - | BodyResponseCallback + | Params$Resource$Notebookexecutionjobs$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Evaluationruns$List; + {}) as Params$Resource$Notebookexecutionjobs$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Evaluationruns$List; + params = {} as Params$Resource$Notebookexecutionjobs$Operations$Wait; options = {}; } @@ -48791,103 +46976,101 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/evaluationRuns').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Evaluationruns$Cancel + export interface Params$Resource$Notebookexecutionjobs$Operations$Cancel extends StandardParameters { /** - * Required. The name of the EvaluationRun resource to be cancelled. Format: `projects/{project\}/locations/{location\}/evaluationRuns/{evaluation_run\}` + * The name of the operation resource to be cancelled. */ name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1CancelEvaluationRunRequest; - } - export interface Params$Resource$Projects$Locations$Evaluationruns$Create - extends StandardParameters { - /** - * Required. The resource name of the Location to create the Evaluation Run in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1EvaluationRun; } - export interface Params$Resource$Projects$Locations$Evaluationruns$Delete + export interface Params$Resource$Notebookexecutionjobs$Operations$Delete extends StandardParameters { /** - * Required. The name of the EvaluationRun resource to be deleted. Format: `projects/{project\}/locations/{location\}/evaluationRuns/{evaluation_run\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Evaluationruns$Get + export interface Params$Resource$Notebookexecutionjobs$Operations$Get extends StandardParameters { /** - * Required. The name of the EvaluationRun resource. Format: `projects/{project\}/locations/{location\}/evaluationRuns/{evaluation_run\}` + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Evaluationruns$List + export interface Params$Resource$Notebookexecutionjobs$Operations$List extends StandardParameters { /** - * Optional. Filter expression that matches a subset of the EvaluationRuns to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160). + * The standard list filter. */ filter?: string; /** - * Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. + * The name of the operation's parent resource. */ - orderBy?: string; + name?: string; /** - * Optional. The maximum number of Evaluation Runs to return. + * The standard list page size. */ pageSize?: number; /** - * Optional. A page token, received from a previous `ListEvaluationRuns` call. Provide this to retrieve the subsequent page. + * The standard list page token. */ pageToken?: string; /** - * Required. The resource name of the Location from which to list the Evaluation Runs. Format: `projects/{project\}/locations/{location\}` + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - parent?: string; + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Notebookexecutionjobs$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; } - export class Resource$Projects$Locations$Evaluationsets { + export class Resource$Notebookruntimes { + context: APIRequestContext; + operations: Resource$Notebookruntimes$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Notebookruntimes$Operations(this.context); + } + } + + export class Resource$Notebookruntimes$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates an Evaluation Set. + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -48916,34 +47099,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.evaluationSets.create({ - * // Required. The resource name of the Location to create the Evaluation Set in. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "evaluationItems": [], - * // "metadata": {}, - * // "name": "my_name", - * // "updateTime": "my_updateTime" - * // } - * }, + * const res = await aiplatform.notebookRuntimes.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'notebookRuntimes/my-notebookRuntime/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "evaluationItems": [], - * // "metadata": {}, - * // "name": "my_name", - * // "updateTime": "my_updateTime" - * // } + * // {} * } * * main().catch(e => { @@ -48958,61 +47121,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Evaluationsets$Create, + cancel( + params: Params$Resource$Notebookruntimes$Operations$Cancel, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Evaluationsets$Create, + cancel( + params?: Params$Resource$Notebookruntimes$Operations$Cancel, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - create( - params: Params$Resource$Projects$Locations$Evaluationsets$Create, + ): Promise>; + cancel( + params: Params$Resource$Notebookruntimes$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Evaluationsets$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Evaluationsets$Create, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Notebookruntimes$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Notebookruntimes$Operations$Cancel, + callback: BodyResponseCallback ): void; - create( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Evaluationsets$Create - | BodyResponseCallback + | Params$Resource$Notebookruntimes$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Evaluationsets$Create; + {}) as Params$Resource$Notebookruntimes$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Evaluationsets$Create; + params = {} as Params$Resource$Notebookruntimes$Operations$Cancel; options = {}; } @@ -49025,34 +47180,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/evaluationSets').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes an Evaluation Set. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -49081,20 +47231,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.evaluationSets.delete({ - * // Required. The name of the EvaluationSet resource to be deleted. Format: `projects/{project\}/locations/{location\}/evaluationSets/{evaluation_set\}` - * name: 'projects/my-project/locations/my-location/evaluationSets/my-evaluationSet', + * const res = await aiplatform.notebookRuntimes.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'notebookRuntimes/my-notebookRuntime/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -49110,56 +47254,52 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Evaluationsets$Delete, + params: Params$Resource$Notebookruntimes$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Evaluationsets$Delete, + params?: Params$Resource$Notebookruntimes$Operations$Delete, options?: MethodOptions - ): Promise>; + ): Promise>; delete( - params: Params$Resource$Projects$Locations$Evaluationsets$Delete, + params: Params$Resource$Notebookruntimes$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Evaluationsets$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Evaluationsets$Delete, - callback: BodyResponseCallback + params: Params$Resource$Notebookruntimes$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - callback: BodyResponseCallback + params: Params$Resource$Notebookruntimes$Operations$Delete, + callback: BodyResponseCallback ): void; + delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Evaluationsets$Delete - | BodyResponseCallback + | Params$Resource$Notebookruntimes$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Evaluationsets$Delete; + {}) as Params$Resource$Notebookruntimes$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Evaluationsets$Delete; + params = {} as Params$Resource$Notebookruntimes$Operations$Delete; options = {}; } @@ -49184,17 +47324,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets an Evaluation Set. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -49223,20 +47363,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.evaluationSets.get({ - * // Required. The name of the EvaluationSet resource. Format: `projects/{project\}/locations/{location\}/evaluationSets/{evaluation_set\}` - * name: 'projects/my-project/locations/my-location/evaluationSets/my-evaluationSet', + * const res = await aiplatform.notebookRuntimes.operations.get({ + * // The name of the operation resource. + * name: 'notebookRuntimes/my-notebookRuntime/operations/my-operation', * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "evaluationItems": [], + * // "done": false, + * // "error": {}, * // "metadata": {}, * // "name": "my_name", - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -49253,60 +47392,56 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Evaluationsets$Get, + params: Params$Resource$Notebookruntimes$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Evaluationsets$Get, + params?: Params$Resource$Notebookruntimes$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; + ): Promise>; get( - params: Params$Resource$Projects$Locations$Evaluationsets$Get, + params: Params$Resource$Notebookruntimes$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Evaluationsets$Get, + params: Params$Resource$Notebookruntimes$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Evaluationsets$Get, - callback: BodyResponseCallback + params: Params$Resource$Notebookruntimes$Operations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Evaluationsets$Get - | BodyResponseCallback + | Params$Resource$Notebookruntimes$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Evaluationsets$Get; + {}) as Params$Resource$Notebookruntimes$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Evaluationsets$Get; + params = {} as Params$Resource$Notebookruntimes$Operations$Get; options = {}; } @@ -49331,19 +47466,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists Evaluation Sets. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -49372,24 +47505,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.evaluationSets.list({ - * // Optional. Filter expression that matches a subset of the EvaluationSets to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160). + * const res = await aiplatform.notebookRuntimes.operations.list({ + * // The standard list filter. * filter: 'placeholder-value', - * // Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. - * orderBy: 'placeholder-value', - * // Optional. The maximum number of Evaluation Sets to return. + * // The name of the operation's parent resource. + * name: 'notebookRuntimes/my-notebookRuntime', + * // The standard list page size. * pageSize: 'placeholder-value', - * // Optional. A page token, received from a previous `ListEvaluationSets` call. Provide this to retrieve the subsequent page. + * // The standard list page token. * pageToken: 'placeholder-value', - * // Required. The resource name of the Location from which to list the Evaluation Sets. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "evaluationSets": [], - * // "nextPageToken": "my_nextPageToken" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -49406,60 +47540,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Evaluationsets$List, + params: Params$Resource$Notebookruntimes$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Evaluationsets$List, + params?: Params$Resource$Notebookruntimes$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Evaluationsets$List, + params: Params$Resource$Notebookruntimes$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Evaluationsets$List, + params: Params$Resource$Notebookruntimes$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Evaluationsets$List, - callback: BodyResponseCallback + params: Params$Resource$Notebookruntimes$Operations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Evaluationsets$List - | BodyResponseCallback + | Params$Resource$Notebookruntimes$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Evaluationsets$List; + {}) as Params$Resource$Notebookruntimes$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Evaluationsets$List; + params = {} as Params$Resource$Notebookruntimes$Operations$List; options = {}; } @@ -49472,7 +47606,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/evaluationSets').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -49482,24 +47616,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates an Evaluation Set. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -49528,35 +47662,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.evaluationSets.patch({ - * // Identifier. The resource name of the EvaluationSet. Format: `projects/{project\}/locations/{location\}/evaluationSets/{evaluation_set\}` - * name: 'projects/my-project/locations/my-location/evaluationSets/my-evaluationSet', - * // Optional. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "evaluationItems": [], - * // "metadata": {}, - * // "name": "my_name", - * // "updateTime": "my_updateTime" - * // } - * }, + * const res = await aiplatform.notebookRuntimes.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'notebookRuntimes/my-notebookRuntime/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "evaluationItems": [], + * // "done": false, + * // "error": {}, * // "metadata": {}, * // "name": "my_name", - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -49572,61 +47692,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Evaluationsets$Patch, + wait( + params: Params$Resource$Notebookruntimes$Operations$Wait, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Evaluationsets$Patch, + wait( + params?: Params$Resource$Notebookruntimes$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - patch( - params: Params$Resource$Projects$Locations$Evaluationsets$Patch, + ): Promise>; + wait( + params: Params$Resource$Notebookruntimes$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Evaluationsets$Patch, + wait( + params: Params$Resource$Notebookruntimes$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Evaluationsets$Patch, - callback: BodyResponseCallback + wait( + params: Params$Resource$Notebookruntimes$Operations$Wait, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - patch( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Evaluationsets$Patch - | BodyResponseCallback + | Params$Resource$Notebookruntimes$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Evaluationsets$Patch; + {}) as Params$Resource$Notebookruntimes$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Evaluationsets$Patch; + params = {} as Params$Resource$Notebookruntimes$Operations$Wait; options = {}; } @@ -49639,8 +47755,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -49651,99 +47767,91 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Evaluationsets$Create + export interface Params$Resource$Notebookruntimes$Operations$Cancel extends StandardParameters { /** - * Required. The resource name of the Location to create the Evaluation Set in. Format: `projects/{project\}/locations/{location\}` + * The name of the operation resource to be cancelled. */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1EvaluationSet; + name?: string; } - export interface Params$Resource$Projects$Locations$Evaluationsets$Delete + export interface Params$Resource$Notebookruntimes$Operations$Delete extends StandardParameters { /** - * Required. The name of the EvaluationSet resource to be deleted. Format: `projects/{project\}/locations/{location\}/evaluationSets/{evaluation_set\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Evaluationsets$Get + export interface Params$Resource$Notebookruntimes$Operations$Get extends StandardParameters { /** - * Required. The name of the EvaluationSet resource. Format: `projects/{project\}/locations/{location\}/evaluationSets/{evaluation_set\}` + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Evaluationsets$List + export interface Params$Resource$Notebookruntimes$Operations$List extends StandardParameters { /** - * Optional. Filter expression that matches a subset of the EvaluationSets to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160). + * The standard list filter. */ filter?: string; /** - * Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. + * The name of the operation's parent resource. */ - orderBy?: string; + name?: string; /** - * Optional. The maximum number of Evaluation Sets to return. + * The standard list page size. */ pageSize?: number; /** - * Optional. A page token, received from a previous `ListEvaluationSets` call. Provide this to retrieve the subsequent page. + * The standard list page token. */ pageToken?: string; /** - * Required. The resource name of the Location from which to list the Evaluation Sets. Format: `projects/{project\}/locations/{location\}` + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - parent?: string; + returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Evaluationsets$Patch + export interface Params$Resource$Notebookruntimes$Operations$Wait extends StandardParameters { /** - * Identifier. The resource name of the EvaluationSet. Format: `projects/{project\}/locations/{location\}/evaluationSets/{evaluation_set\}` + * The name of the operation resource to wait on. */ name?: string; /** - * Optional. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. - */ - updateMask?: string; - - /** - * Request body metadata + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - requestBody?: Schema$GoogleCloudAiplatformV1EvaluationSet; + timeout?: string; } - export class Resource$Projects$Locations$Featuregroups { + export class Resource$Notebookruntimetemplates { context: APIRequestContext; - features: Resource$Projects$Locations$Featuregroups$Features; - operations: Resource$Projects$Locations$Featuregroups$Operations; + operations: Resource$Notebookruntimetemplates$Operations; constructor(context: APIRequestContext) { this.context = context; - this.features = new Resource$Projects$Locations$Featuregroups$Features( + this.operations = new Resource$Notebookruntimetemplates$Operations( this.context ); - this.operations = - new Resource$Projects$Locations$Featuregroups$Operations(this.context); + } + } + + export class Resource$Notebookruntimetemplates$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Creates a new FeatureGroup in a given project and location. + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -49772,38 +47880,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featureGroups.create({ - * // Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location. - * featureGroupId: 'placeholder-value', - * // Required. The resource name of the Location to create FeatureGroups. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "bigQuery": {}, - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "serviceAccountEmail": "my_serviceAccountEmail", - * // "serviceAgentType": "my_serviceAgentType", - * // "updateTime": "my_updateTime" - * // } - * }, + * const res = await aiplatform.notebookRuntimeTemplates.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'notebookRuntimeTemplates/my-notebookRuntimeTemplate/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -49818,57 +47902,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Featuregroups$Create, + cancel( + params: Params$Resource$Notebookruntimetemplates$Operations$Cancel, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Featuregroups$Create, + cancel( + params?: Params$Resource$Notebookruntimetemplates$Operations$Cancel, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Featuregroups$Create, + ): Promise>; + cancel( + params: Params$Resource$Notebookruntimetemplates$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Featuregroups$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Featuregroups$Create, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Notebookruntimetemplates$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Notebookruntimetemplates$Operations$Cancel, + callback: BodyResponseCallback ): void; - create( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Create - | BodyResponseCallback + | Params$Resource$Notebookruntimetemplates$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Create; + {}) as Params$Resource$Notebookruntimetemplates$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Featuregroups$Create; + params = + {} as Params$Resource$Notebookruntimetemplates$Operations$Cancel; options = {}; } @@ -49881,32 +47962,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/featureGroups').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a single FeatureGroup. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -49935,22 +48013,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featureGroups.delete({ - * // If set to true, any Features under this FeatureGroup will also be deleted. (Otherwise, the request will only work if the FeatureGroup has no Features.) - * force: 'placeholder-value', - * // Required. The name of the FeatureGroup to be deleted. Format: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` - * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup', + * const res = await aiplatform.notebookRuntimeTemplates.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'notebookRuntimeTemplates/my-notebookRuntimeTemplate/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -49966,56 +48036,53 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Featuregroups$Delete, + params: Params$Resource$Notebookruntimetemplates$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Featuregroups$Delete, + params?: Params$Resource$Notebookruntimetemplates$Operations$Delete, options?: MethodOptions - ): Promise>; + ): Promise>; delete( - params: Params$Resource$Projects$Locations$Featuregroups$Delete, + params: Params$Resource$Notebookruntimetemplates$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featuregroups$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Featuregroups$Delete, - callback: BodyResponseCallback + params: Params$Resource$Notebookruntimetemplates$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - callback: BodyResponseCallback + params: Params$Resource$Notebookruntimetemplates$Operations$Delete, + callback: BodyResponseCallback ): void; + delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Delete - | BodyResponseCallback + | Params$Resource$Notebookruntimetemplates$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Delete; + {}) as Params$Resource$Notebookruntimetemplates$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Featuregroups$Delete; + params = + {} as Params$Resource$Notebookruntimetemplates$Operations$Delete; options = {}; } @@ -50040,17 +48107,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets details of a single FeatureGroup. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -50079,23 +48146,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featureGroups.get({ - * // Required. The name of the FeatureGroup resource. - * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup', + * const res = await aiplatform.notebookRuntimeTemplates.operations.get({ + * // The name of the operation resource. + * name: 'notebookRuntimeTemplates/my-notebookRuntimeTemplate/operations/my-operation', * }); * console.log(res.data); * * // Example response * // { - * // "bigQuery": {}, - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "etag": "my_etag", - * // "labels": {}, + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "serviceAccountEmail": "my_serviceAccountEmail", - * // "serviceAgentType": "my_serviceAgentType", - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -50112,60 +48175,56 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Featuregroups$Get, + params: Params$Resource$Notebookruntimetemplates$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Featuregroups$Get, + params?: Params$Resource$Notebookruntimetemplates$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; + ): Promise>; get( - params: Params$Resource$Projects$Locations$Featuregroups$Get, + params: Params$Resource$Notebookruntimetemplates$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featuregroups$Get, + params: Params$Resource$Notebookruntimetemplates$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featuregroups$Get, - callback: BodyResponseCallback + params: Params$Resource$Notebookruntimetemplates$Operations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Get - | BodyResponseCallback + | Params$Resource$Notebookruntimetemplates$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Get; + {}) as Params$Resource$Notebookruntimetemplates$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Featuregroups$Get; + params = {} as Params$Resource$Notebookruntimetemplates$Operations$Get; options = {}; } @@ -50190,164 +48249,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const aiplatform = google.aiplatform('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await aiplatform.projects.locations.featureGroups.getIamPolicy({ - * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - * 'options.requestedPolicyVersion': 'placeholder-value', - * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/featureGroups/my-featureGroup', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Featuregroups$Getiampolicy, - options: StreamMethodOptions - ): Promise>; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Featuregroups$Getiampolicy, - options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featuregroups$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featuregroups$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featuregroups$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy( - callback: BodyResponseCallback - ): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featuregroups$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists FeatureGroups in a given project and location. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -50376,24 +48288,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featureGroups.list({ - * // Lists the FeatureGroups that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time \> "2020-01-01" OR update_time \> "2020-01-01"` FeatureGroups created or updated after 2020-01-01. * `labels.env = "prod"` FeatureGroups with label "env" set to "prod". + * const res = await aiplatform.notebookRuntimeTemplates.operations.list({ + * // The standard list filter. * filter: 'placeholder-value', - * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time` * `update_time` - * orderBy: 'placeholder-value', - * // The maximum number of FeatureGroups to return. The service may return fewer than this value. If unspecified, at most 100 FeatureGroups will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. + * // The name of the operation's parent resource. + * name: 'notebookRuntimeTemplates/my-notebookRuntimeTemplate', + * // The standard list page size. * pageSize: 'placeholder-value', - * // A page token, received from a previous FeatureRegistryService.ListFeatureGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureGroups must match the call that provided the page token. + * // The standard list page token. * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list FeatureGroups. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "featureGroups": [], - * // "nextPageToken": "my_nextPageToken" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -50410,60 +48323,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Featuregroups$List, + params: Params$Resource$Notebookruntimetemplates$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Featuregroups$List, + params?: Params$Resource$Notebookruntimetemplates$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Featuregroups$List, + params: Params$Resource$Notebookruntimetemplates$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featuregroups$List, + params: Params$Resource$Notebookruntimetemplates$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featuregroups$List, - callback: BodyResponseCallback + params: Params$Resource$Notebookruntimetemplates$Operations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$List - | BodyResponseCallback + | Params$Resource$Notebookruntimetemplates$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$List; + {}) as Params$Resource$Notebookruntimetemplates$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Featuregroups$List; + params = {} as Params$Resource$Notebookruntimetemplates$Operations$List; options = {}; } @@ -50476,7 +48389,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/featureGroups').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -50486,24 +48399,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates the parameters of a single FeatureGroup. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -50532,27 +48445,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featureGroups.patch({ - * // Identifier. Name of the FeatureGroup. Format: `projects/{project\}/locations/{location\}/featureGroups/{featureGroup\}` - * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup', - * // Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` * `service_agent_type` - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "bigQuery": {}, - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "serviceAccountEmail": "my_serviceAccountEmail", - * // "serviceAgentType": "my_serviceAgentType", - * // "updateTime": "my_updateTime" - * // } - * }, + * const res = await aiplatform.notebookRuntimeTemplates.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'notebookRuntimeTemplates/my-notebookRuntimeTemplate/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * @@ -50578,36 +48475,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Featuregroups$Patch, + wait( + params: Params$Resource$Notebookruntimetemplates$Operations$Wait, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Featuregroups$Patch, + wait( + params?: Params$Resource$Notebookruntimetemplates$Operations$Wait, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Featuregroups$Patch, + wait( + params: Params$Resource$Notebookruntimetemplates$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featuregroups$Patch, + wait( + params: Params$Resource$Notebookruntimetemplates$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featuregroups$Patch, + wait( + params: Params$Resource$Notebookruntimetemplates$Operations$Wait, callback: BodyResponseCallback ): void; - patch( + wait( callback: BodyResponseCallback ): void; - patch( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Patch + | Params$Resource$Notebookruntimetemplates$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -50623,12 +48520,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Patch; + {}) as Params$Resource$Notebookruntimetemplates$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Featuregroups$Patch; + params = {} as Params$Resource$Notebookruntimetemplates$Operations$Wait; options = {}; } @@ -50641,8 +48538,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -50661,9 +48558,72 @@ export namespace aiplatform_v1 { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Notebookruntimetemplates$Operations$Cancel + extends StandardParameters { /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Notebookruntimetemplates$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Notebookruntimetemplates$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Notebookruntimetemplates$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Notebookruntimetemplates$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -50692,27 +48652,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featureGroups.setIamPolicy({ - * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/featureGroups/my-featureGroup', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "policy": {} - * // } - * }, + * const res = await aiplatform.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } + * // {} * } * * main().catch(e => { @@ -50727,56 +48674,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Featuregroups$Setiampolicy, + cancel( + params: Params$Resource$Operations$Cancel, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Featuregroups$Setiampolicy, + cancel( + params?: Params$Resource$Operations$Cancel, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featuregroups$Setiampolicy, + ): Promise>; + cancel( + params: Params$Resource$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featuregroups$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featuregroups$Setiampolicy, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Operations$Cancel, + callback: BodyResponseCallback ): void; - setIamPolicy( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Setiampolicy - | BodyResponseCallback + | Params$Resource$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Setiampolicy; + {}) as Params$Resource$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featuregroups$Setiampolicy; + params = {} as Params$Resource$Operations$Cancel; options = {}; } @@ -50789,32 +48733,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -50843,20 +48784,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureGroups.testIamPermissions({ - * // The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). - * permissions: 'placeholder-value', - * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/featureGroups/my-featureGroup', - * }); + * const res = await aiplatform.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "permissions": [] - * // } + * // {} * } * * main().catch(e => { @@ -50871,62 +48806,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Featuregroups$Testiampermissions, + delete( + params: Params$Resource$Operations$Delete, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Featuregroups$Testiampermissions, + delete( + params?: Params$Resource$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featuregroups$Testiampermissions, + ): Promise>; + delete( + params: Params$Resource$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featuregroups$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featuregroups$Testiampermissions, - callback: BodyResponseCallback + delete( + params: Params$Resource$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + delete( + params: Params$Resource$Operations$Delete, + callback: BodyResponseCallback ): void; - testIamPermissions( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Testiampermissions - | BodyResponseCallback + | Params$Resource$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Testiampermissions; + {}) as Params$Resource$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featuregroups$Testiampermissions; + params = {} as Params$Resource$Operations$Delete; options = {}; } @@ -50939,154 +48865,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Featuregroups$Create - extends StandardParameters { - /** - * Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location. - */ - featureGroupId?: string; - /** - * Required. The resource name of the Location to create FeatureGroups. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1FeatureGroup; - } - export interface Params$Resource$Projects$Locations$Featuregroups$Delete - extends StandardParameters { - /** - * If set to true, any Features under this FeatureGroup will also be deleted. (Otherwise, the request will only work if the FeatureGroup has no Features.) - */ - force?: boolean; - /** - * Required. The name of the FeatureGroup to be deleted. Format: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featuregroups$Get - extends StandardParameters { - /** - * Required. The name of the FeatureGroup resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featuregroups$Getiampolicy - extends StandardParameters { - /** - * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Featuregroups$List - extends StandardParameters { - /** - * Lists the FeatureGroups that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time \> "2020-01-01" OR update_time \> "2020-01-01"` FeatureGroups created or updated after 2020-01-01. * `labels.env = "prod"` FeatureGroups with label "env" set to "prod". - */ - filter?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time` * `update_time` - */ - orderBy?: string; - /** - * The maximum number of FeatureGroups to return. The service may return fewer than this value. If unspecified, at most 100 FeatureGroups will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. - */ - pageSize?: number; - /** - * A page token, received from a previous FeatureRegistryService.ListFeatureGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureGroups must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The resource name of the Location to list FeatureGroups. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Featuregroups$Patch - extends StandardParameters { - /** - * Identifier. Name of the FeatureGroup. Format: `projects/{project\}/locations/{location\}/featureGroups/{featureGroup\}` - */ - name?: string; - /** - * Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` * `service_agent_type` - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1FeatureGroup; - } - export interface Params$Resource$Projects$Locations$Featuregroups$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Featuregroups$Testiampermissions - extends StandardParameters { - /** - * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). - */ - permissions?: string[]; - /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - - export class Resource$Projects$Locations$Featuregroups$Features { - context: APIRequestContext; - operations: Resource$Projects$Locations$Featuregroups$Features$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Featuregroups$Features$Operations( - this.context - ); - } /** - * Creates a batch of Features in a given FeatureGroup. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -51115,20 +48916,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureGroups.features.batchCreate({ - * // Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` - * parent: - * 'projects/my-project/locations/my-location/featureGroups/my-featureGroup', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "requests": [] - * // } - * }, - * }); + * const res = await aiplatform.operations.get({ + * // The name of the operation resource. + * name: 'operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -51153,36 +48944,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchCreate( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate, + get( + params: Params$Resource$Operations$Get, options: StreamMethodOptions ): Promise>; - batchCreate( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate, + get( + params?: Params$Resource$Operations$Get, options?: MethodOptions ): Promise>; - batchCreate( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate, + get( + params: Params$Resource$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate, + get( + params: Params$Resource$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate, + get( + params: Params$Resource$Operations$Get, callback: BodyResponseCallback ): void; - batchCreate( + get( callback: BodyResponseCallback ): void; - batchCreate( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate + | Params$Resource$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -51197,14 +48988,12 @@ export namespace aiplatform_v1 { | void | Promise> | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate; + let params = (paramsOrCallback || {}) as Params$Resource$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate; + params = {} as Params$Resource$Operations$Get; options = {}; } @@ -51217,18 +49006,15 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/features:batchCreate').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -51242,7 +49028,7 @@ export namespace aiplatform_v1 { } /** - * Creates a new Feature in a given FeatureGroup. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -51271,42 +49057,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featureGroups.features.create( - * { - * // Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup. - * featureId: 'placeholder-value', - * // Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` - * parent: - * 'projects/my-project/locations/my-location/featureGroups/my-featureGroup', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "disableMonitoring": false, - * // "etag": "my_etag", - * // "labels": {}, - * // "monitoringStatsAnomalies": [], - * // "name": "my_name", - * // "pointOfContact": "my_pointOfContact", - * // "updateTime": "my_updateTime", - * // "valueType": "my_valueType", - * // "versionColumnName": "my_versionColumnName" - * // } - * }, - * }, - * ); + * const res = await aiplatform.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'placeholder-value', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -51322,58 +49091,60 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Create, + list( + params: Params$Resource$Operations$List, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$Create, + list( + params?: Params$Resource$Operations$List, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Create, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Create, + list( + params: Params$Resource$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Operations$List, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - create( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$Create - | BodyResponseCallback + | Params$Resource$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Create; + let params = (paramsOrCallback || {}) as Params$Resource$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$Create; + params = {} as Params$Resource$Operations$List; options = {}; } @@ -51386,32 +49157,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/features').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/operations').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: [], + pathParams: [], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a single Feature. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -51440,12 +49210,12 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featureGroups.features.delete( - * { - * // Required. The name of the Features to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` - * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/features/my-feature', - * }, - * ); + * const res = await aiplatform.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -51470,36 +49240,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, + wait( + params: Params$Resource$Operations$Wait, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, + wait( + params?: Params$Resource$Operations$Wait, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, + wait( + params: Params$Resource$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, + wait( + params: Params$Resource$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, + wait( + params: Params$Resource$Operations$Wait, callback: BodyResponseCallback ): void; - delete( + wait( callback: BodyResponseCallback ): void; - delete( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$Delete + | Params$Resource$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -51514,14 +49284,12 @@ export namespace aiplatform_v1 { | void | Promise> | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Delete; + let params = (paramsOrCallback || {}) as Params$Resource$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$Delete; + params = {} as Params$Resource$Operations$Wait; options = {}; } @@ -51534,8 +49302,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -51554,322 +49322,80 @@ export namespace aiplatform_v1 { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Operations$Cancel + extends StandardParameters { /** - * Gets details of a single Feature. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const aiplatform = google.aiplatform('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await aiplatform.projects.locations.featureGroups.features.get({ - * // Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` - * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/features/my-feature', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "disableMonitoring": false, - * // "etag": "my_etag", - * // "labels": {}, - * // "monitoringStatsAnomalies": [], - * // "name": "my_name", - * // "pointOfContact": "my_pointOfContact", - * // "updateTime": "my_updateTime", - * // "valueType": "my_valueType", - * // "versionColumnName": "my_versionColumnName" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * The name of the operation resource to be cancelled. */ - get( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Get, - callback: BodyResponseCallback - ): void; - get( - callback: BodyResponseCallback - ): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - + name?: string; + } + export interface Params$Resource$Operations$Delete + extends StandardParameters { /** - * Lists Features in a given FeatureGroup. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const aiplatform = google.aiplatform('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await aiplatform.projects.locations.featureGroups.features.list({ - * // Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --\> Features whose type is DOUBLE. * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any Feature which has a label with 'env' as the key. - * filter: 'placeholder-value', - * // Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats. - * latestStatsCount: 'placeholder-value', - * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time` - * orderBy: 'placeholder-value', - * // The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` - * parent: - * 'projects/my-project/locations/my-location/featureGroups/my-featureGroup', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "features": [], - * // "nextPageToken": "my_nextPageToken" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * The name of the operation resource to be deleted. */ - list( - params: Params$Resource$Projects$Locations$Featuregroups$Features$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$List, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Featuregroups$Features$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Featuregroups$Features$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Featuregroups$Features$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Features$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$List; - options = {}; - } + name?: string; + } + export interface Params$Resource$Operations$Get extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Operations$List extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Operations$Wait extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + export class Resource$Persistentresources { + context: APIRequestContext; + operations: Resource$Persistentresources$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Persistentresources$Operations( + this.context + ); + } + } - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/features').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } + export class Resource$Persistentresources$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Updates the parameters of a single Feature. + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -51898,40 +49424,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featureGroups.features.patch({ - * // Immutable. Name of the Feature. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type. - * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/features/my-feature', - * // Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore) - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "disableMonitoring": false, - * // "etag": "my_etag", - * // "labels": {}, - * // "monitoringStatsAnomalies": [], - * // "name": "my_name", - * // "pointOfContact": "my_pointOfContact", - * // "updateTime": "my_updateTime", - * // "valueType": "my_valueType", - * // "versionColumnName": "my_versionColumnName" - * // } - * }, + * const res = await aiplatform.persistentResources.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'persistentResources/my-persistentResource/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -51946,58 +49446,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, + cancel( + params: Params$Resource$Persistentresources$Operations$Cancel, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, + cancel( + params?: Params$Resource$Persistentresources$Operations$Cancel, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, + ): Promise>; + cancel( + params: Params$Resource$Persistentresources$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Persistentresources$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Persistentresources$Operations$Cancel, + callback: BodyResponseCallback ): void; - patch( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$Patch - | BodyResponseCallback + | Params$Resource$Persistentresources$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Patch; + {}) as Params$Resource$Persistentresources$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$Patch; + params = {} as Params$Resource$Persistentresources$Operations$Cancel; options = {}; } @@ -52010,8 +49505,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -52022,111 +49517,14 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate - extends StandardParameters { - /** - * Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1BatchCreateFeaturesRequest; - } - export interface Params$Resource$Projects$Locations$Featuregroups$Features$Create - extends StandardParameters { - /** - * Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup. - */ - featureId?: string; - /** - * Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Feature; - } - export interface Params$Resource$Projects$Locations$Featuregroups$Features$Delete - extends StandardParameters { - /** - * Required. The name of the Features to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featuregroups$Features$Get - extends StandardParameters { - /** - * Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featuregroups$Features$List - extends StandardParameters { - /** - * Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --\> Features whose type is DOUBLE. * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any Feature which has a label with 'env' as the key. - */ - filter?: string; - /** - * Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats. - */ - latestStatsCount?: number; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time` - */ - orderBy?: string; - /** - * The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; - } - export interface Params$Resource$Projects$Locations$Featuregroups$Features$Patch - extends StandardParameters { - /** - * Immutable. Name of the Feature. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type. - */ - name?: string; - /** - * Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore) - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Feature; - } - - export class Resource$Projects$Locations$Featuregroups$Features$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. @@ -52158,13 +49556,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureGroups.features.operations.delete( - * { - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/features/my-feature/operations/my-operation', - * }, - * ); + * const res = await aiplatform.persistentResources.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'persistentResources/my-persistentResource/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -52184,31 +49579,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, + params: Params$Resource$Persistentresources$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, + params?: Params$Resource$Persistentresources$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, + params: Params$Resource$Persistentresources$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, + params: Params$Resource$Persistentresources$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, + params: Params$Resource$Persistentresources$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete + | Params$Resource$Persistentresources$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -52224,13 +49619,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete; + {}) as Params$Resource$Persistentresources$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete; + params = {} as Params$Resource$Persistentresources$Operations$Delete; options = {}; } @@ -52294,11 +49688,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureGroups.features.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/features/my-feature/operations/my-operation', - * }); + * const res = await aiplatform.persistentResources.operations.get({ + * // The name of the operation resource. + * name: 'persistentResources/my-persistentResource/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -52324,27 +49717,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, + params: Params$Resource$Persistentresources$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, + params?: Params$Resource$Persistentresources$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, + params: Params$Resource$Persistentresources$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, + params: Params$Resource$Persistentresources$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, + params: Params$Resource$Persistentresources$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -52352,7 +49745,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get + | Params$Resource$Persistentresources$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -52368,13 +49761,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get; + {}) as Params$Resource$Persistentresources$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get; + params = {} as Params$Resource$Persistentresources$Operations$Get; options = {}; } @@ -52438,21 +49830,18 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureGroups.features.operations.listWait( - * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/features/my-feature/operations/my-operation', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.persistentResources.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'persistentResources/my-persistentResource', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -52475,38 +49864,38 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listWait( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait, + list( + params: Params$Resource$Persistentresources$Operations$List, options: StreamMethodOptions ): Promise>; - listWait( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait, + list( + params?: Params$Resource$Persistentresources$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; - listWait( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait, + list( + params: Params$Resource$Persistentresources$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listWait( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait, + list( + params: Params$Resource$Persistentresources$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listWait( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait, + list( + params: Params$Resource$Persistentresources$Operations$List, callback: BodyResponseCallback ): void; - listWait( + list( callback: BodyResponseCallback ): void; - listWait( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait + | Params$Resource$Persistentresources$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -52524,13 +49913,12 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait; + {}) as Params$Resource$Persistentresources$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait; + params = {} as Params$Resource$Persistentresources$Operations$List; options = {}; } @@ -52543,7 +49931,10 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -52596,13 +49987,12 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureGroups.features.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/features/my-feature/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); + * const res = await aiplatform.persistentResources.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'persistentResources/my-persistentResource/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -52628,27 +50018,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, + params: Params$Resource$Persistentresources$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, + params?: Params$Resource$Persistentresources$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, + params: Params$Resource$Persistentresources$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, + params: Params$Resource$Persistentresources$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, + params: Params$Resource$Persistentresources$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -52656,7 +50046,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait + | Params$Resource$Persistentresources$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -52672,13 +50062,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait; + {}) as Params$Resource$Persistentresources$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait; + params = {} as Params$Resource$Persistentresources$Operations$Wait; options = {}; } @@ -52713,21 +50102,28 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete + export interface Params$Resource$Persistentresources$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Persistentresources$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get + export interface Params$Resource$Persistentresources$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait + export interface Params$Resource$Persistentresources$Operations$List extends StandardParameters { /** * The standard list filter. @@ -52750,7 +50146,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait + export interface Params$Resource$Persistentresources$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -52762,12 +50158,153 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Featuregroups$Operations { + export class Resource$Pipelinejobs { + context: APIRequestContext; + operations: Resource$Pipelinejobs$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Pipelinejobs$Operations(this.context); + } + } + + export class Resource$Pipelinejobs$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.pipelineJobs.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'pipelineJobs/my-pipelineJob/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Pipelinejobs$Operations$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Pipelinejobs$Operations$Cancel, + options?: MethodOptions + ): Promise>; + cancel( + params: Params$Resource$Pipelinejobs$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Pipelinejobs$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Pipelinejobs$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Pipelinejobs$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Pipelinejobs$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Pipelinejobs$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example @@ -52798,11 +50335,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureGroups.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/operations/my-operation', - * }); + * const res = await aiplatform.pipelineJobs.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'pipelineJobs/my-pipelineJob/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -52822,31 +50358,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, + params: Params$Resource$Pipelinejobs$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, + params?: Params$Resource$Pipelinejobs$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, + params: Params$Resource$Pipelinejobs$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, + params: Params$Resource$Pipelinejobs$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, + params: Params$Resource$Pipelinejobs$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Operations$Delete + | Params$Resource$Pipelinejobs$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -52862,13 +50398,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Operations$Delete; + {}) as Params$Resource$Pipelinejobs$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featuregroups$Operations$Delete; + params = {} as Params$Resource$Pipelinejobs$Operations$Delete; options = {}; } @@ -52932,9 +50467,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featureGroups.operations.get({ + * const res = await aiplatform.pipelineJobs.operations.get({ * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/operations/my-operation', + * name: 'pipelineJobs/my-pipelineJob/operations/my-operation', * }); * console.log(res.data); * @@ -52961,27 +50496,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, + params: Params$Resource$Pipelinejobs$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, + params?: Params$Resource$Pipelinejobs$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, + params: Params$Resource$Pipelinejobs$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, + params: Params$Resource$Pipelinejobs$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, + params: Params$Resource$Pipelinejobs$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -52989,7 +50524,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Operations$Get + | Params$Resource$Pipelinejobs$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -53005,13 +50540,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Operations$Get; + {}) as Params$Resource$Pipelinejobs$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featuregroups$Operations$Get; + params = {} as Params$Resource$Pipelinejobs$Operations$Get; options = {}; } @@ -53075,19 +50609,18 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureGroups.operations.listWait({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/operations/my-operation', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * const res = await aiplatform.pipelineJobs.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'pipelineJobs/my-pipelineJob', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -53110,38 +50643,38 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listWait( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait, + list( + params: Params$Resource$Pipelinejobs$Operations$List, options: StreamMethodOptions ): Promise>; - listWait( - params?: Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait, + list( + params?: Params$Resource$Pipelinejobs$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; - listWait( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait, + list( + params: Params$Resource$Pipelinejobs$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listWait( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait, + list( + params: Params$Resource$Pipelinejobs$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listWait( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait, + list( + params: Params$Resource$Pipelinejobs$Operations$List, callback: BodyResponseCallback ): void; - listWait( + list( callback: BodyResponseCallback ): void; - listWait( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait + | Params$Resource$Pipelinejobs$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -53159,13 +50692,12 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait; + {}) as Params$Resource$Pipelinejobs$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait; + params = {} as Params$Resource$Pipelinejobs$Operations$List; options = {}; } @@ -53178,7 +50710,10 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -53231,14 +50766,12 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featureGroups.operations.wait( - * { - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.pipelineJobs.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'pipelineJobs/my-pipelineJob/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -53264,27 +50797,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, + params: Params$Resource$Pipelinejobs$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, + params?: Params$Resource$Pipelinejobs$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, + params: Params$Resource$Pipelinejobs$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, + params: Params$Resource$Pipelinejobs$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, + params: Params$Resource$Pipelinejobs$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -53292,7 +50825,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Operations$Wait + | Params$Resource$Pipelinejobs$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -53308,13 +50841,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Operations$Wait; + {}) as Params$Resource$Pipelinejobs$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featuregroups$Operations$Wait; + params = {} as Params$Resource$Pipelinejobs$Operations$Wait; options = {}; } @@ -53349,21 +50881,28 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Featuregroups$Operations$Delete + export interface Params$Resource$Pipelinejobs$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Pipelinejobs$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featuregroups$Operations$Get + export interface Params$Resource$Pipelinejobs$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait + export interface Params$Resource$Pipelinejobs$Operations$List extends StandardParameters { /** * The standard list filter. @@ -53386,7 +50925,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Featuregroups$Operations$Wait + export interface Params$Resource$Pipelinejobs$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -53398,24 +50937,16 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Featureonlinestores { + export class Resource$Projects { context: APIRequestContext; - featureViews: Resource$Projects$Locations$Featureonlinestores$Featureviews; - operations: Resource$Projects$Locations$Featureonlinestores$Operations; + locations: Resource$Projects$Locations; constructor(context: APIRequestContext) { this.context = context; - this.featureViews = - new Resource$Projects$Locations$Featureonlinestores$Featureviews( - this.context - ); - this.operations = - new Resource$Projects$Locations$Featureonlinestores$Operations( - this.context - ); + this.locations = new Resource$Projects$Locations(this.context); } /** - * Creates a new FeatureOnlineStore in a given project and location. + * Gets a GenAI cache config. * @example * ```js * // Before running the sample: @@ -53444,40 +50975,16 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featureOnlineStores.create({ - * // Required. The ID to use for this FeatureOnlineStore, which will become the final component of the FeatureOnlineStore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location. - * featureOnlineStoreId: 'placeholder-value', - * // Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "bigtable": {}, - * // "createTime": "my_createTime", - * // "dedicatedServingEndpoint": {}, - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "optimized": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "state": "my_state", - * // "updateTime": "my_updateTime" - * // } - * }, + * const res = await aiplatform.projects.getCacheConfig({ + * // Required. Name of the cache config. Format: - `projects/{project\}/cacheConfig`. + * name: 'projects/my-project/cacheConfig', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "disableCache": false, + * // "name": "my_name" * // } * } * @@ -53493,58 +51000,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Featureonlinestores$Create, + getCacheConfig( + params: Params$Resource$Projects$Getcacheconfig, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Create, + getCacheConfig( + params?: Params$Resource$Projects$Getcacheconfig, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Featureonlinestores$Create, + ): Promise< + GaxiosResponseWithHTTP2 + >; + getCacheConfig( + params: Params$Resource$Projects$Getcacheconfig, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Featureonlinestores$Create, + getCacheConfig( + params: Params$Resource$Projects$Getcacheconfig, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Featureonlinestores$Create, - callback: BodyResponseCallback + getCacheConfig( + params: Params$Resource$Projects$Getcacheconfig, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + getCacheConfig( + callback: BodyResponseCallback ): void; - create( + getCacheConfig( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Create - | BodyResponseCallback + | Params$Resource$Projects$Getcacheconfig + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Create; + {}) as Params$Resource$Projects$Getcacheconfig; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Create; + params = {} as Params$Resource$Projects$Getcacheconfig; options = {}; } @@ -53557,32 +51067,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/featureOnlineStores').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not contain any FeatureViews. + * Updates a cache config. * @example * ```js * // Before running the sample: @@ -53611,11 +51120,18 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featureOnlineStores.delete({ - * // If set to true, any FeatureViews and Features for this FeatureOnlineStore will also be deleted. (Otherwise, the request will only work if the FeatureOnlineStore has no FeatureViews.) - * force: 'placeholder-value', - * // Required. The name of the FeatureOnlineStore to be deleted. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}` - * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore', + * const res = await aiplatform.projects.updateCacheConfig({ + * // Identifier. Name of the cache config. Format: - `projects/{project\}/cacheConfig`. + * name: 'projects/my-project/cacheConfig', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "disableCache": false, + * // "name": "my_name" + * // } + * }, * }); * console.log(res.data); * @@ -53641,36 +51157,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Delete, + updateCacheConfig( + params: Params$Resource$Projects$Updatecacheconfig, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Delete, + updateCacheConfig( + params?: Params$Resource$Projects$Updatecacheconfig, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Delete, + updateCacheConfig( + params: Params$Resource$Projects$Updatecacheconfig, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Delete, + updateCacheConfig( + params: Params$Resource$Projects$Updatecacheconfig, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Delete, + updateCacheConfig( + params: Params$Resource$Projects$Updatecacheconfig, callback: BodyResponseCallback ): void; - delete( + updateCacheConfig( callback: BodyResponseCallback ): void; - delete( + updateCacheConfig( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Delete + | Params$Resource$Projects$Updatecacheconfig | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -53686,13 +51202,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Delete; + {}) as Params$Resource$Projects$Updatecacheconfig; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Delete; + params = {} as Params$Resource$Projects$Updatecacheconfig; options = {}; } @@ -53706,7 +51221,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'PATCH', apiVersion: '', }, options @@ -53725,9 +51240,162 @@ export namespace aiplatform_v1 { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Getcacheconfig + extends StandardParameters { /** - * Gets details of a single FeatureOnlineStore. + * Required. Name of the cache config. Format: - `projects/{project\}/cacheConfig`. + */ + name?: string; + } + export interface Params$Resource$Projects$Updatecacheconfig + extends StandardParameters { + /** + * Identifier. Name of the cache config. Format: - `projects/{project\}/cacheConfig`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CacheConfig; + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + batchPredictionJobs: Resource$Projects$Locations$Batchpredictionjobs; + cachedContents: Resource$Projects$Locations$Cachedcontents; + customJobs: Resource$Projects$Locations$Customjobs; + dataLabelingJobs: Resource$Projects$Locations$Datalabelingjobs; + datasets: Resource$Projects$Locations$Datasets; + deploymentResourcePools: Resource$Projects$Locations$Deploymentresourcepools; + endpoints: Resource$Projects$Locations$Endpoints; + evaluationItems: Resource$Projects$Locations$Evaluationitems; + evaluationRuns: Resource$Projects$Locations$Evaluationruns; + evaluationSets: Resource$Projects$Locations$Evaluationsets; + featureGroups: Resource$Projects$Locations$Featuregroups; + featureOnlineStores: Resource$Projects$Locations$Featureonlinestores; + featurestores: Resource$Projects$Locations$Featurestores; + hyperparameterTuningJobs: Resource$Projects$Locations$Hyperparametertuningjobs; + indexEndpoints: Resource$Projects$Locations$Indexendpoints; + indexes: Resource$Projects$Locations$Indexes; + metadataStores: Resource$Projects$Locations$Metadatastores; + migratableResources: Resource$Projects$Locations$Migratableresources; + modelDeploymentMonitoringJobs: Resource$Projects$Locations$Modeldeploymentmonitoringjobs; + models: Resource$Projects$Locations$Models; + nasJobs: Resource$Projects$Locations$Nasjobs; + notebookExecutionJobs: Resource$Projects$Locations$Notebookexecutionjobs; + notebookRuntimes: Resource$Projects$Locations$Notebookruntimes; + notebookRuntimeTemplates: Resource$Projects$Locations$Notebookruntimetemplates; + operations: Resource$Projects$Locations$Operations; + persistentResources: Resource$Projects$Locations$Persistentresources; + pipelineJobs: Resource$Projects$Locations$Pipelinejobs; + publishers: Resource$Projects$Locations$Publishers; + ragCorpora: Resource$Projects$Locations$Ragcorpora; + ragEngineConfig: Resource$Projects$Locations$Ragengineconfig; + reasoningEngines: Resource$Projects$Locations$Reasoningengines; + schedules: Resource$Projects$Locations$Schedules; + specialistPools: Resource$Projects$Locations$Specialistpools; + studies: Resource$Projects$Locations$Studies; + tensorboards: Resource$Projects$Locations$Tensorboards; + trainingPipelines: Resource$Projects$Locations$Trainingpipelines; + tuningJobs: Resource$Projects$Locations$Tuningjobs; + constructor(context: APIRequestContext) { + this.context = context; + this.batchPredictionJobs = + new Resource$Projects$Locations$Batchpredictionjobs(this.context); + this.cachedContents = new Resource$Projects$Locations$Cachedcontents( + this.context + ); + this.customJobs = new Resource$Projects$Locations$Customjobs( + this.context + ); + this.dataLabelingJobs = new Resource$Projects$Locations$Datalabelingjobs( + this.context + ); + this.datasets = new Resource$Projects$Locations$Datasets(this.context); + this.deploymentResourcePools = + new Resource$Projects$Locations$Deploymentresourcepools(this.context); + this.endpoints = new Resource$Projects$Locations$Endpoints(this.context); + this.evaluationItems = new Resource$Projects$Locations$Evaluationitems( + this.context + ); + this.evaluationRuns = new Resource$Projects$Locations$Evaluationruns( + this.context + ); + this.evaluationSets = new Resource$Projects$Locations$Evaluationsets( + this.context + ); + this.featureGroups = new Resource$Projects$Locations$Featuregroups( + this.context + ); + this.featureOnlineStores = + new Resource$Projects$Locations$Featureonlinestores(this.context); + this.featurestores = new Resource$Projects$Locations$Featurestores( + this.context + ); + this.hyperparameterTuningJobs = + new Resource$Projects$Locations$Hyperparametertuningjobs(this.context); + this.indexEndpoints = new Resource$Projects$Locations$Indexendpoints( + this.context + ); + this.indexes = new Resource$Projects$Locations$Indexes(this.context); + this.metadataStores = new Resource$Projects$Locations$Metadatastores( + this.context + ); + this.migratableResources = + new Resource$Projects$Locations$Migratableresources(this.context); + this.modelDeploymentMonitoringJobs = + new Resource$Projects$Locations$Modeldeploymentmonitoringjobs( + this.context + ); + this.models = new Resource$Projects$Locations$Models(this.context); + this.nasJobs = new Resource$Projects$Locations$Nasjobs(this.context); + this.notebookExecutionJobs = + new Resource$Projects$Locations$Notebookexecutionjobs(this.context); + this.notebookRuntimes = new Resource$Projects$Locations$Notebookruntimes( + this.context + ); + this.notebookRuntimeTemplates = + new Resource$Projects$Locations$Notebookruntimetemplates(this.context); + this.operations = new Resource$Projects$Locations$Operations( + this.context + ); + this.persistentResources = + new Resource$Projects$Locations$Persistentresources(this.context); + this.pipelineJobs = new Resource$Projects$Locations$Pipelinejobs( + this.context + ); + this.publishers = new Resource$Projects$Locations$Publishers( + this.context + ); + this.ragCorpora = new Resource$Projects$Locations$Ragcorpora( + this.context + ); + this.ragEngineConfig = new Resource$Projects$Locations$Ragengineconfig( + this.context + ); + this.reasoningEngines = new Resource$Projects$Locations$Reasoningengines( + this.context + ); + this.schedules = new Resource$Projects$Locations$Schedules(this.context); + this.specialistPools = new Resource$Projects$Locations$Specialistpools( + this.context + ); + this.studies = new Resource$Projects$Locations$Studies(this.context); + this.tensorboards = new Resource$Projects$Locations$Tensorboards( + this.context + ); + this.trainingPipelines = + new Resource$Projects$Locations$Trainingpipelines(this.context); + this.tuningJobs = new Resource$Projects$Locations$Tuningjobs( + this.context + ); + } + + /** + * Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses. * @example * ```js * // Before running the sample: @@ -53756,26 +51424,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featureOnlineStores.get({ - * // Required. The name of the FeatureOnlineStore resource. - * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore', + * const res = await aiplatform.projects.locations.augmentPrompt({ + * // Required. The resource name of the Location from which to augment prompt. The users must have permission to make a call in the project. Format: `projects/{project\}/locations/{location\}`. + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "contents": [], + * // "model": {}, + * // "vertexRagStore": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "bigtable": {}, - * // "createTime": "my_createTime", - * // "dedicatedServingEndpoint": {}, - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "optimized": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "state": "my_state", - * // "updateTime": "my_updateTime" + * // "augmentedPrompt": [], + * // "facts": [] * // } * } * @@ -53791,62 +51459,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Get, + augmentPrompt( + params: Params$Resource$Projects$Locations$Augmentprompt, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Get, + augmentPrompt( + params?: Params$Resource$Projects$Locations$Augmentprompt, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Get, + augmentPrompt( + params: Params$Resource$Projects$Locations$Augmentprompt, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Get, + augmentPrompt( + params: Params$Resource$Projects$Locations$Augmentprompt, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Get, - callback: BodyResponseCallback + augmentPrompt( + params: Params$Resource$Projects$Locations$Augmentprompt, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + augmentPrompt( + callback: BodyResponseCallback ): void; - get( + augmentPrompt( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Augmentprompt + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Get; + {}) as Params$Resource$Projects$Locations$Augmentprompt; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Get; + params = {} as Params$Resource$Projects$Locations$Augmentprompt; options = {}; } @@ -53859,31 +51526,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+parent}:augmentPrompt').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Given an input text, it returns a score that evaluates the factuality of the text. It also extracts and returns claims from the text and provides supporting facts. * @example * ```js * // Before running the sample: @@ -53912,21 +51582,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureOnlineStores.getIamPolicy({ - * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - * 'options.requestedPolicyVersion': 'placeholder-value', - * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore', - * }); + * const res = await aiplatform.projects.locations.corroborateContent({ + * // Required. The resource name of the Location from which to corroborate text. The users must have permission to make a call in the project. Format: `projects/{project\}/locations/{location\}`. + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "content": {}, + * // "facts": [], + * // "parameters": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "claims": [], + * // "corroborationScore": {} * // } * } * @@ -53942,56 +51617,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy, + corroborateContent( + params: Params$Resource$Projects$Locations$Corroboratecontent, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy, + corroborateContent( + params?: Params$Resource$Projects$Locations$Corroboratecontent, options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy, + ): Promise< + GaxiosResponseWithHTTP2 + >; + corroborateContent( + params: Params$Resource$Projects$Locations$Corroboratecontent, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + corroborateContent( + params: Params$Resource$Projects$Locations$Corroboratecontent, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy, - callback: BodyResponseCallback + corroborateContent( + params: Params$Resource$Projects$Locations$Corroboratecontent, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + corroborateContent( + callback: BodyResponseCallback ): void; - getIamPolicy( + corroborateContent( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Corroboratecontent + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Corroboratecontent; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy; + params = {} as Params$Resource$Projects$Locations$Corroboratecontent; options = {}; } @@ -54004,7 +51684,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1/{+parent}:corroborateContent').replace( /([^:]\/)\/+/g, '$1' ), @@ -54014,22 +51694,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists FeatureOnlineStores in a given project and location. + * Deploys a model to a new endpoint. * @example * ```js * // Before running the sample: @@ -54058,24 +51740,31 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featureOnlineStores.list({ - * // Lists the FeatureOnlineStores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time \> "2020-01-01" OR update_time \> "2020-01-01"` FeatureOnlineStores created or updated after 2020-01-01. * `labels.env = "prod"` FeatureOnlineStores with label "env" set to "prod". - * filter: 'placeholder-value', - * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time` * `update_time` - * orderBy: 'placeholder-value', - * // The maximum number of FeatureOnlineStores to return. The service may return fewer than this value. If unspecified, at most 100 FeatureOnlineStores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. - * pageSize: 'placeholder-value', - * // A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureOnlineStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureOnlineStores must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list FeatureOnlineStores. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * const res = await aiplatform.projects.locations.deploy({ + * // Required. The resource name of the Location to deploy the model in. Format: `projects/{project\}/locations/{location\}` + * destination: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "deployConfig": {}, + * // "endpointConfig": {}, + * // "huggingFaceModelId": "my_huggingFaceModelId", + * // "modelConfig": {}, + * // "publisherModelName": "my_publisherModelName" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "featureOnlineStores": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -54091,62 +51780,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Featureonlinestores$List, + deploy( + params: Params$Resource$Projects$Locations$Deploy, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Featureonlinestores$List, + deploy( + params?: Params$Resource$Projects$Locations$Deploy, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Featureonlinestores$List, + ): Promise>; + deploy( + params: Params$Resource$Projects$Locations$Deploy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featureonlinestores$List, + deploy( + params: Params$Resource$Projects$Locations$Deploy, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featureonlinestores$List, - callback: BodyResponseCallback + deploy( + params: Params$Resource$Projects$Locations$Deploy, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + deploy( + callback: BodyResponseCallback ): void; - list( + deploy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Deploy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$List; + {}) as Params$Resource$Projects$Locations$Deploy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$List; + params = {} as Params$Resource$Projects$Locations$Deploy; options = {}; } @@ -54159,34 +51843,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/featureOnlineStores').replace( + url: (rootUrl + '/v1/{+destination}:deploy').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['destination'], + pathParams: ['destination'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates the parameters of a single FeatureOnlineStore. + * Evaluates a dataset based on a set of given metrics. * @example * ```js * // Before running the sample: @@ -54215,28 +51897,18 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featureOnlineStores.patch({ - * // Identifier. Name of the FeatureOnlineStore. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}` - * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore', - * // Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `bigtable` * `bigtable.auto_scaling` * `bigtable.enable_multi_region_replica` - * updateMask: 'placeholder-value', + * const res = await aiplatform.projects.locations.evaluateDataset({ + * // Required. The resource name of the Location to evaluate the dataset. Format: `projects/{project\}/locations/{location\}` + * location: 'projects/my-project/locations/my-location', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "bigtable": {}, - * // "createTime": "my_createTime", - * // "dedicatedServingEndpoint": {}, - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "optimized": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "state": "my_state", - * // "updateTime": "my_updateTime" + * // "autoraterConfig": {}, + * // "dataset": {}, + * // "metrics": [], + * // "outputConfig": {} * // } * }, * }); @@ -54264,36 +51936,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Featureonlinestores$Patch, + evaluateDataset( + params: Params$Resource$Projects$Locations$Evaluatedataset, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Patch, + evaluateDataset( + params?: Params$Resource$Projects$Locations$Evaluatedataset, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Featureonlinestores$Patch, + evaluateDataset( + params: Params$Resource$Projects$Locations$Evaluatedataset, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featureonlinestores$Patch, + evaluateDataset( + params: Params$Resource$Projects$Locations$Evaluatedataset, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featureonlinestores$Patch, + evaluateDataset( + params: Params$Resource$Projects$Locations$Evaluatedataset, callback: BodyResponseCallback ): void; - patch( + evaluateDataset( callback: BodyResponseCallback ): void; - patch( + evaluateDataset( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Patch + | Params$Resource$Projects$Locations$Evaluatedataset | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -54309,13 +51981,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Patch; + {}) as Params$Resource$Projects$Locations$Evaluatedataset; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Patch; + params = {} as Params$Resource$Projects$Locations$Evaluatedataset; options = {}; } @@ -54328,15 +51999,18 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+location}:evaluateDataset').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['location'], + pathParams: ['location'], context: this.context, }; if (callback) { @@ -54350,7 +52024,7 @@ export namespace aiplatform_v1 { } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Evaluates instances based on a given metric. * @example * ```js * // Before running the sample: @@ -54379,27 +52053,89 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureOnlineStores.setIamPolicy({ - * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore', + * const res = await aiplatform.projects.locations.evaluateInstances({ + * // Required. The resource name of the Location to evaluate the instances. Format: `projects/{project\}/locations/{location\}` + * location: 'projects/my-project/locations/my-location', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "policy": {} - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "autoraterConfig": {}, + * // "bleuInput": {}, + * // "coherenceInput": {}, + * // "cometInput": {}, + * // "exactMatchInput": {}, + * // "fluencyInput": {}, + * // "fulfillmentInput": {}, + * // "groundednessInput": {}, + * // "instance": {}, + * // "metrics": [], + * // "metricxInput": {}, + * // "pairwiseMetricInput": {}, + * // "pairwiseQuestionAnsweringQualityInput": {}, + * // "pairwiseSummarizationQualityInput": {}, + * // "pointwiseMetricInput": {}, + * // "questionAnsweringCorrectnessInput": {}, + * // "questionAnsweringHelpfulnessInput": {}, + * // "questionAnsweringQualityInput": {}, + * // "questionAnsweringRelevanceInput": {}, + * // "rougeInput": {}, + * // "rubricBasedInstructionFollowingInput": {}, + * // "safetyInput": {}, + * // "summarizationHelpfulnessInput": {}, + * // "summarizationQualityInput": {}, + * // "summarizationVerbosityInput": {}, + * // "toolCallValidInput": {}, + * // "toolNameMatchInput": {}, + * // "toolParameterKeyMatchInput": {}, + * // "toolParameterKvMatchInput": {}, + * // "trajectoryAnyOrderMatchInput": {}, + * // "trajectoryExactMatchInput": {}, + * // "trajectoryInOrderMatchInput": {}, + * // "trajectoryPrecisionInput": {}, + * // "trajectoryRecallInput": {}, + * // "trajectorySingleToolUseInput": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "bleuResults": {}, + * // "coherenceResult": {}, + * // "cometResult": {}, + * // "exactMatchResults": {}, + * // "fluencyResult": {}, + * // "fulfillmentResult": {}, + * // "groundednessResult": {}, + * // "metricResults": [], + * // "metricxResult": {}, + * // "pairwiseMetricResult": {}, + * // "pairwiseQuestionAnsweringQualityResult": {}, + * // "pairwiseSummarizationQualityResult": {}, + * // "pointwiseMetricResult": {}, + * // "questionAnsweringCorrectnessResult": {}, + * // "questionAnsweringHelpfulnessResult": {}, + * // "questionAnsweringQualityResult": {}, + * // "questionAnsweringRelevanceResult": {}, + * // "rougeResults": {}, + * // "rubricBasedInstructionFollowingResult": {}, + * // "safetyResult": {}, + * // "summarizationHelpfulnessResult": {}, + * // "summarizationQualityResult": {}, + * // "summarizationVerbosityResult": {}, + * // "toolCallValidResults": {}, + * // "toolNameMatchResults": {}, + * // "toolParameterKeyMatchResults": {}, + * // "toolParameterKvMatchResults": {}, + * // "trajectoryAnyOrderMatchResults": {}, + * // "trajectoryExactMatchResults": {}, + * // "trajectoryInOrderMatchResults": {}, + * // "trajectoryPrecisionResults": {}, + * // "trajectoryRecallResults": {}, + * // "trajectorySingleToolUseResults": {} * // } * } * @@ -54415,56 +52151,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy, + evaluateInstances( + params: Params$Resource$Projects$Locations$Evaluateinstances, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy, + evaluateInstances( + params?: Params$Resource$Projects$Locations$Evaluateinstances, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy, + ): Promise< + GaxiosResponseWithHTTP2 + >; + evaluateInstances( + params: Params$Resource$Projects$Locations$Evaluateinstances, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + evaluateInstances( + params: Params$Resource$Projects$Locations$Evaluateinstances, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy, - callback: BodyResponseCallback + evaluateInstances( + params: Params$Resource$Projects$Locations$Evaluateinstances, + callback: BodyResponseCallback ): void; - setIamPolicy( - callback: BodyResponseCallback + evaluateInstances( + callback: BodyResponseCallback ): void; - setIamPolicy( + evaluateInstances( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Evaluateinstances + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Evaluateinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy; + params = {} as Params$Resource$Projects$Locations$Evaluateinstances; options = {}; } @@ -54477,7 +52218,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1/{+location}:evaluateInstances').replace( /([^:]\/)\/+/g, '$1' ), @@ -54487,22 +52228,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['location'], + pathParams: ['location'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Generates rubrics for a given prompt. A rubric represents a single testable criterion for evaluation. One input prompt could have multiple rubrics This RPC allows users to get suggested rubrics based on provided prompt, which can then be reviewed and used for subsequent evaluations. * @example * ```js * // Before running the sample: @@ -54531,19 +52274,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureOnlineStores.testIamPermissions({ - * // The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). - * permissions: 'placeholder-value', - * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore', - * }); + * const res = await aiplatform.projects.locations.generateInstanceRubrics({ + * // Required. The resource name of the Location to generate rubrics from. Format: `projects/{project\}/locations/{location\}` + * location: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "agentConfig": {}, + * // "contents": [], + * // "predefinedRubricGenerationSpec": {}, + * // "rubricGenerationSpec": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "permissions": [] + * // "generatedRubrics": [] * // } * } * @@ -54559,62 +52309,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions, + generateInstanceRubrics( + params: Params$Resource$Projects$Locations$Generateinstancerubrics, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions, + generateInstanceRubrics( + params?: Params$Resource$Projects$Locations$Generateinstancerubrics, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions, + generateInstanceRubrics( + params: Params$Resource$Projects$Locations$Generateinstancerubrics, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions, + generateInstanceRubrics( + params: Params$Resource$Projects$Locations$Generateinstancerubrics, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions, - callback: BodyResponseCallback + generateInstanceRubrics( + params: Params$Resource$Projects$Locations$Generateinstancerubrics, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + generateInstanceRubrics( + callback: BodyResponseCallback ): void; - testIamPermissions( + generateInstanceRubrics( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Generateinstancerubrics + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Generateinstancerubrics; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions; + {} as Params$Resource$Projects$Locations$Generateinstancerubrics; options = {}; } @@ -54627,7 +52377,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + url: (rootUrl + '/v1/{+location}:generateInstanceRubrics').replace( /([^:]\/)\/+/g, '$1' ), @@ -54637,149 +52387,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['location'], + pathParams: ['location'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Featureonlinestores$Create - extends StandardParameters { - /** - * Required. The ID to use for this FeatureOnlineStore, which will become the final component of the FeatureOnlineStore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location. - */ - featureOnlineStoreId?: string; - /** - * Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1FeatureOnlineStore; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Delete - extends StandardParameters { - /** - * If set to true, any FeatureViews and Features for this FeatureOnlineStore will also be deleted. (Otherwise, the request will only work if the FeatureOnlineStore has no FeatureViews.) - */ - force?: boolean; - /** - * Required. The name of the FeatureOnlineStore to be deleted. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Get - extends StandardParameters { - /** - * Required. The name of the FeatureOnlineStore resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy - extends StandardParameters { - /** - * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$List - extends StandardParameters { - /** - * Lists the FeatureOnlineStores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time \> "2020-01-01" OR update_time \> "2020-01-01"` FeatureOnlineStores created or updated after 2020-01-01. * `labels.env = "prod"` FeatureOnlineStores with label "env" set to "prod". - */ - filter?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time` * `update_time` - */ - orderBy?: string; - /** - * The maximum number of FeatureOnlineStores to return. The service may return fewer than this value. If unspecified, at most 100 FeatureOnlineStores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. - */ - pageSize?: number; - /** - * A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureOnlineStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureOnlineStores must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The resource name of the Location to list FeatureOnlineStores. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Patch - extends StandardParameters { - /** - * Identifier. Name of the FeatureOnlineStore. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}` - */ - name?: string; - /** - * Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `bigtable` * `bigtable.auto_scaling` * `bigtable.enable_multi_region_replica` - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1FeatureOnlineStore; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions - extends StandardParameters { - /** - * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). - */ - permissions?: string[]; - /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - - export class Resource$Projects$Locations$Featureonlinestores$Featureviews { - context: APIRequestContext; - featureViewSyncs: Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs; - operations: Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.featureViewSyncs = - new Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs( - this.context - ); - this.operations = - new Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations( - this.context - ); - } /** - * Creates a new FeatureView in a given FeatureOnlineStore. + * Generates synthetic data based on the provided configuration. * @example * ```js * // Before running the sample: @@ -54808,50 +52433,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureOnlineStores.featureViews.create( - * { - * // Required. The ID to use for the FeatureView, which will become the final component of the FeatureView's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a FeatureOnlineStore. - * featureViewId: 'placeholder-value', - * // Required. The resource name of the FeatureOnlineStore to create FeatureViews. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}` - * parent: - * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore', - * // Immutable. If set to true, one on demand sync will be run immediately, regardless whether the FeatureView.sync_config is configured or not. - * runSyncImmediately: 'placeholder-value', + * const res = await aiplatform.projects.locations.generateSyntheticData({ + * // Required. The resource name of the Location to run the job. Format: `projects/{project\}/locations/{location\}` + * location: 'projects/my-project/locations/my-location', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "bigQuerySource": {}, - * // "bigtableMetadata": {}, - * // "createTime": "my_createTime", - * // "etag": "my_etag", - * // "featureRegistrySource": {}, - * // "indexConfig": {}, - * // "labels": {}, - * // "name": "my_name", - * // "optimizedConfig": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "serviceAccountEmail": "my_serviceAccountEmail", - * // "serviceAgentType": "my_serviceAgentType", - * // "syncConfig": {}, - * // "updateTime": "my_updateTime", - * // "vertexRagSource": {} - * // } - * }, - * }, - * ); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "count": 0, + * // "examples": [], + * // "outputFieldSpecs": [], + * // "taskDescription": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "syntheticExamples": [] * // } * } * @@ -54867,58 +52468,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, + generateSyntheticData( + params: Params$Resource$Projects$Locations$Generatesyntheticdata, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, + generateSyntheticData( + params?: Params$Resource$Projects$Locations$Generatesyntheticdata, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, + ): Promise< + GaxiosResponseWithHTTP2 + >; + generateSyntheticData( + params: Params$Resource$Projects$Locations$Generatesyntheticdata, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, + generateSyntheticData( + params: Params$Resource$Projects$Locations$Generatesyntheticdata, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, - callback: BodyResponseCallback + generateSyntheticData( + params: Params$Resource$Projects$Locations$Generatesyntheticdata, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + generateSyntheticData( + callback: BodyResponseCallback ): void; - create( + generateSyntheticData( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Generatesyntheticdata + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create; + {}) as Params$Resource$Projects$Locations$Generatesyntheticdata; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create; + params = {} as Params$Resource$Projects$Locations$Generatesyntheticdata; options = {}; } @@ -54931,7 +52535,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/featureViews').replace( + url: (rootUrl + '/v1/{+location}:generateSyntheticData').replace( /([^:]\/)\/+/g, '$1' ), @@ -54941,22 +52545,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['location'], + pathParams: ['location'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a single FeatureView. + * Gets information about a location. * @example * ```js * // Before running the sample: @@ -54985,22 +52591,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureOnlineStores.featureViews.delete( - * { - * // Required. The name of the FeatureView to be deleted. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` - * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', - * }, - * ); + * const res = await aiplatform.projects.locations.get({ + * // Resource name for the location. + * name: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, + * // "displayName": "my_displayName", + * // "labels": {}, + * // "locationId": "my_locationId", * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "name": "my_name" * // } * } * @@ -55016,58 +52619,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, + get( + params: Params$Resource$Projects$Locations$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, + get( + params?: Params$Resource$Projects$Locations$Get, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, + get( + params: Params$Resource$Projects$Locations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Get, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - delete( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete; + {}) as Params$Resource$Projects$Locations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete; + params = {} as Params$Resource$Projects$Locations$Get; options = {}; } @@ -55081,7 +52683,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -55092,17 +52694,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Bidirectional streaming RPC to directly write to feature values in a feature view. Requests may not have a one-to-one mapping to responses and responses may be returned out-of-order to reduce latency. + * Gets a RagEngineConfig. * @example * ```js * // Before running the sample: @@ -55131,28 +52733,16 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureOnlineStores.featureViews.directWrite( - * { - * // FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` - * featureView: - * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "dataKeyAndFeatureValues": [] - * // } - * }, - * }, - * ); + * const res = await aiplatform.projects.locations.getRagEngineConfig({ + * // Required. The name of the RagEngineConfig resource. Format: `projects/{project\}/locations/{location\}/ragEngineConfig` + * name: 'projects/my-project/locations/my-location/ragEngineConfig', + * }); * console.log(res.data); * * // Example response * // { - * // "status": {}, - * // "writeResponses": [] + * // "name": "my_name", + * // "ragManagedDbConfig": {} * // } * } * @@ -55168,62 +52758,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - directWrite( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite, + getRagEngineConfig( + params: Params$Resource$Projects$Locations$Getragengineconfig, options: StreamMethodOptions ): Promise>; - directWrite( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite, + getRagEngineConfig( + params?: Params$Resource$Projects$Locations$Getragengineconfig, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - directWrite( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite, + getRagEngineConfig( + params: Params$Resource$Projects$Locations$Getragengineconfig, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - directWrite( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite, + getRagEngineConfig( + params: Params$Resource$Projects$Locations$Getragengineconfig, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - directWrite( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite, - callback: BodyResponseCallback + getRagEngineConfig( + params: Params$Resource$Projects$Locations$Getragengineconfig, + callback: BodyResponseCallback ): void; - directWrite( - callback: BodyResponseCallback + getRagEngineConfig( + callback: BodyResponseCallback ): void; - directWrite( + getRagEngineConfig( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite - | BodyResponseCallback + | Params$Resource$Projects$Locations$Getragengineconfig + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite; + {}) as Params$Resource$Projects$Locations$Getragengineconfig; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite; + params = {} as Params$Resource$Projects$Locations$Getragengineconfig; options = {}; } @@ -55236,34 +52825,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+featureView}:directWrite').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['featureView'], - pathParams: ['featureView'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Fetch feature values under a FeatureView. + * Lists information about the supported locations for this service. * @example * ```js * // Before running the sample: @@ -55292,30 +52878,24 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureOnlineStores.featureViews.fetchFeatureValues( - * { - * // Required. FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` - * featureView: - * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "dataFormat": "my_dataFormat", - * // "dataKey": {} - * // } - * }, - * }, - * ); + * const res = await aiplatform.projects.locations.list({ + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * extraLocationTypes: 'placeholder-value', + * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). + * filter: 'placeholder-value', + * // The resource that owns the locations collection, if applicable. + * name: 'projects/my-project', + * // The maximum number of results to return. If not set, the service selects a default. + * pageSize: 'placeholder-value', + * // A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. + * pageToken: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "dataKey": {}, - * // "keyValues": {}, - * // "protoStruct": {} + * // "locations": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -55331,62 +52911,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - fetchFeatureValues( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, + list( + params: Params$Resource$Projects$Locations$List, options: StreamMethodOptions ): Promise>; - fetchFeatureValues( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, + list( + params?: Params$Resource$Projects$Locations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - fetchFeatureValues( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, + list( + params: Params$Resource$Projects$Locations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - fetchFeatureValues( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, + list( + params: Params$Resource$Projects$Locations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - fetchFeatureValues( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$List, + callback: BodyResponseCallback ): void; - fetchFeatureValues( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - fetchFeatureValues( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues - | BodyResponseCallback + | Params$Resource$Projects$Locations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues; + {}) as Params$Resource$Projects$Locations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues; + params = {} as Params$Resource$Projects$Locations$List; options = {}; } @@ -55399,34 +52978,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+featureView}:fetchFeatureValues').replace( + url: (rootUrl + '/v1/{+name}/locations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['featureView'], - pathParams: ['featureView'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * RPC to generate an access token for the given feature view. FeatureViews under the same FeatureOnlineStore share the same access token. + * Retrieves relevant contexts for a query. * @example * ```js * // Before running the sample: @@ -55455,26 +53034,24 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureOnlineStores.featureViews.generateFetchAccessToken( - * { - * // FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` - * featureView: - * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', + * const res = await aiplatform.projects.locations.retrieveContexts({ + * // Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project\}/locations/{location\}`. + * parent: 'projects/my-project/locations/my-location', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }, - * ); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "query": {}, + * // "vertexRagStore": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "accessToken": "my_accessToken", - * // "expireTime": "my_expireTime" + * // "contexts": {} * // } * } * @@ -55490,62 +53067,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - generateFetchAccessToken( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Generatefetchaccesstoken, + retrieveContexts( + params: Params$Resource$Projects$Locations$Retrievecontexts, options: StreamMethodOptions ): Promise>; - generateFetchAccessToken( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Generatefetchaccesstoken, + retrieveContexts( + params?: Params$Resource$Projects$Locations$Retrievecontexts, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - generateFetchAccessToken( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Generatefetchaccesstoken, + retrieveContexts( + params: Params$Resource$Projects$Locations$Retrievecontexts, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - generateFetchAccessToken( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Generatefetchaccesstoken, + retrieveContexts( + params: Params$Resource$Projects$Locations$Retrievecontexts, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - generateFetchAccessToken( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Generatefetchaccesstoken, - callback: BodyResponseCallback + retrieveContexts( + params: Params$Resource$Projects$Locations$Retrievecontexts, + callback: BodyResponseCallback ): void; - generateFetchAccessToken( - callback: BodyResponseCallback + retrieveContexts( + callback: BodyResponseCallback ): void; - generateFetchAccessToken( + retrieveContexts( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Generatefetchaccesstoken - | BodyResponseCallback + | Params$Resource$Projects$Locations$Retrievecontexts + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Generatefetchaccesstoken; + {}) as Params$Resource$Projects$Locations$Retrievecontexts; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Generatefetchaccesstoken; + params = {} as Params$Resource$Projects$Locations$Retrievecontexts; options = {}; } @@ -55558,33 +53134,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+featureView}:generateFetchAccessToken' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}:retrieveContexts').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['featureView'], - pathParams: ['featureView'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets details of a single FeatureView. + * Updates a RagEngineConfig. * @example * ```js * // Before running the sample: @@ -55613,31 +53190,28 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureOnlineStores.featureViews.get({ - * // Required. The name of the FeatureView resource. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` - * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', - * }); + * const res = await aiplatform.projects.locations.updateRagEngineConfig({ + * // Identifier. The name of the RagEngineConfig. Format: `projects/{project\}/locations/{location\}/ragEngineConfig` + * name: 'projects/my-project/locations/my-location/ragEngineConfig', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "name": "my_name", + * // "ragManagedDbConfig": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "bigQuerySource": {}, - * // "bigtableMetadata": {}, - * // "createTime": "my_createTime", - * // "etag": "my_etag", - * // "featureRegistrySource": {}, - * // "indexConfig": {}, - * // "labels": {}, + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "optimizedConfig": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "serviceAccountEmail": "my_serviceAccountEmail", - * // "serviceAgentType": "my_serviceAgentType", - * // "syncConfig": {}, - * // "updateTime": "my_updateTime", - * // "vertexRagSource": {} + * // "response": {} * // } * } * @@ -55653,62 +53227,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, + updateRagEngineConfig( + params: Params$Resource$Projects$Locations$Updateragengineconfig, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, + updateRagEngineConfig( + params?: Params$Resource$Projects$Locations$Updateragengineconfig, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, + ): Promise>; + updateRagEngineConfig( + params: Params$Resource$Projects$Locations$Updateragengineconfig, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, + updateRagEngineConfig( + params: Params$Resource$Projects$Locations$Updateragengineconfig, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, - callback: BodyResponseCallback + updateRagEngineConfig( + params: Params$Resource$Projects$Locations$Updateragengineconfig, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + updateRagEngineConfig( + callback: BodyResponseCallback ): void; - get( + updateRagEngineConfig( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Updateragengineconfig + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get; + {}) as Params$Resource$Projects$Locations$Updateragengineconfig; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get; + params = {} as Params$Resource$Projects$Locations$Updateragengineconfig; options = {}; } @@ -55722,7 +53291,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -55733,19 +53302,170 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Augmentprompt + extends StandardParameters { /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Required. The resource name of the Location from which to augment prompt. The users must have permission to make a call in the project. Format: `projects/{project\}/locations/{location\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1AugmentPromptRequest; + } + export interface Params$Resource$Projects$Locations$Corroboratecontent + extends StandardParameters { + /** + * Required. The resource name of the Location from which to corroborate text. The users must have permission to make a call in the project. Format: `projects/{project\}/locations/{location\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CorroborateContentRequest; + } + export interface Params$Resource$Projects$Locations$Deploy + extends StandardParameters { + /** + * Required. The resource name of the Location to deploy the model in. Format: `projects/{project\}/locations/{location\}` + */ + destination?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1DeployRequest; + } + export interface Params$Resource$Projects$Locations$Evaluatedataset + extends StandardParameters { + /** + * Required. The resource name of the Location to evaluate the dataset. Format: `projects/{project\}/locations/{location\}` + */ + location?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1EvaluateDatasetRequest; + } + export interface Params$Resource$Projects$Locations$Evaluateinstances + extends StandardParameters { + /** + * Required. The resource name of the Location to evaluate the instances. Format: `projects/{project\}/locations/{location\}` + */ + location?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1EvaluateInstancesRequest; + } + export interface Params$Resource$Projects$Locations$Generateinstancerubrics + extends StandardParameters { + /** + * Required. The resource name of the Location to generate rubrics from. Format: `projects/{project\}/locations/{location\}` + */ + location?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1GenerateInstanceRubricsRequest; + } + export interface Params$Resource$Projects$Locations$Generatesyntheticdata + extends StandardParameters { + /** + * Required. The resource name of the Location to run the job. Format: `projects/{project\}/locations/{location\}` + */ + location?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1GenerateSyntheticDataRequest; + } + export interface Params$Resource$Projects$Locations$Get + extends StandardParameters { + /** + * Resource name for the location. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Getragengineconfig + extends StandardParameters { + /** + * Required. The name of the RagEngineConfig resource. Format: `projects/{project\}/locations/{location\}/ragEngineConfig` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$List + extends StandardParameters { + /** + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + */ + extraLocationTypes?: string[]; + /** + * A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). + */ + filter?: string; + /** + * The resource that owns the locations collection, if applicable. + */ + name?: string; + /** + * The maximum number of results to return. If not set, the service selects a default. + */ + pageSize?: number; + /** + * A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. + */ + pageToken?: string; + } + export interface Params$Resource$Projects$Locations$Retrievecontexts + extends StandardParameters { + /** + * Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project\}/locations/{location\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1RetrieveContextsRequest; + } + export interface Params$Resource$Projects$Locations$Updateragengineconfig + extends StandardParameters { + /** + * Identifier. The name of the RagEngineConfig. Format: `projects/{project\}/locations/{location\}/ragEngineConfig` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1RagEngineConfig; + } + + export class Resource$Projects$Locations$Batchpredictionjobs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Cancels a BatchPredictionJob. Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetBatchPredictionJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its BatchPredictionJob.state is set to `CANCELLED`. Any files already outputted by the job are not deleted. * @example * ```js * // Before running the sample: @@ -55774,24 +53494,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureOnlineStores.featureViews.getIamPolicy( - * { - * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - * 'options.requestedPolicyVersion': 'placeholder-value', - * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', - * }, - * ); + * const res = await aiplatform.projects.locations.batchPredictionJobs.cancel({ + * // Required. The name of the BatchPredictionJob to cancel. Format: `projects/{project\}/locations/{location\}/batchPredictionJobs/{batch_prediction_job\}` + * name: 'projects/my-project/locations/my-location/batchPredictionJobs/my-batchPredictionJob', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); * console.log(res.data); * * // Example response - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } + * // {} * } * * main().catch(e => { @@ -55806,56 +53522,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy, + cancel( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy, + cancel( + params?: Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel, options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel, + callback: BodyResponseCallback ): void; - getIamPolicy( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy; + {} as Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel; options = {}; } @@ -55868,32 +53582,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists FeatureViews in a given FeatureOnlineStore. + * Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start. * @example * ```js * // Before running the sample: @@ -55922,26 +53633,79 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureOnlineStores.featureViews.list({ - * // Lists the FeatureViews that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> FeatureViews created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> FeatureViews having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any FeatureView which has a label with 'env' as the key. - * filter: 'placeholder-value', - * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `feature_view_id` * `create_time` * `update_time` - * orderBy: 'placeholder-value', - * // The maximum number of FeatureViews to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViews will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViews call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViews must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The resource name of the FeatureOnlineStore to list FeatureViews. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}` - * parent: - * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore', - * }); + * const res = await aiplatform.projects.locations.batchPredictionJobs.create({ + * // Required. The resource name of the Location to create the BatchPredictionJob in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "completionStats": {}, + * // "createTime": "my_createTime", + * // "dedicatedResources": {}, + * // "disableContainerLogging": false, + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "explanationSpec": {}, + * // "generateExplanation": false, + * // "inputConfig": {}, + * // "instanceConfig": {}, + * // "labels": {}, + * // "manualBatchTuningParameters": {}, + * // "model": "my_model", + * // "modelParameters": {}, + * // "modelVersionId": "my_modelVersionId", + * // "name": "my_name", + * // "outputConfig": {}, + * // "outputInfo": {}, + * // "partialFailures": [], + * // "resourcesConsumed": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "serviceAccount": "my_serviceAccount", + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "unmanagedContainerModel": {}, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "featureViews": [], - * // "nextPageToken": "my_nextPageToken" + * // "completionStats": {}, + * // "createTime": "my_createTime", + * // "dedicatedResources": {}, + * // "disableContainerLogging": false, + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "explanationSpec": {}, + * // "generateExplanation": false, + * // "inputConfig": {}, + * // "instanceConfig": {}, + * // "labels": {}, + * // "manualBatchTuningParameters": {}, + * // "model": "my_model", + * // "modelParameters": {}, + * // "modelVersionId": "my_modelVersionId", + * // "name": "my_name", + * // "outputConfig": {}, + * // "outputInfo": {}, + * // "partialFailures": [], + * // "resourcesConsumed": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "serviceAccount": "my_serviceAccount", + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "unmanagedContainerModel": {}, + * // "updateTime": "my_updateTime" * // } * } * @@ -55957,62 +53721,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, + create( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Create, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, + create( + params?: Params$Resource$Projects$Locations$Batchpredictionjobs$Create, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, + create( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, + create( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Create, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - list( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Batchpredictionjobs$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List; + {}) as Params$Resource$Projects$Locations$Batchpredictionjobs$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List; + {} as Params$Resource$Projects$Locations$Batchpredictionjobs$Create; options = {}; } @@ -56025,11 +53789,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/featureViews').replace( + url: (rootUrl + '/v1/{+parent}/batchPredictionJobs').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -56040,19 +53804,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates the parameters of a single FeatureView. + * Deletes a BatchPredictionJob. Can only be called on jobs that already finished. * @example * ```js * // Before running the sample: @@ -56081,36 +53845,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureOnlineStores.featureViews.patch({ - * // Identifier. Name of the FeatureView. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` - * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', - * // Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `service_agent_type` * `big_query_source` * `big_query_source.uri` * `big_query_source.entity_id_columns` * `feature_registry_source` * `feature_registry_source.feature_groups` * `sync_config` * `sync_config.cron` * `optimized_config.automatic_resources` - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "bigQuerySource": {}, - * // "bigtableMetadata": {}, - * // "createTime": "my_createTime", - * // "etag": "my_etag", - * // "featureRegistrySource": {}, - * // "indexConfig": {}, - * // "labels": {}, - * // "name": "my_name", - * // "optimizedConfig": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "serviceAccountEmail": "my_serviceAccountEmail", - * // "serviceAgentType": "my_serviceAgentType", - * // "syncConfig": {}, - * // "updateTime": "my_updateTime", - * // "vertexRagSource": {} - * // } - * }, - * }); + * const res = await aiplatform.projects.locations.batchPredictionJobs.delete({ + * // Required. The name of the BatchPredictionJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/batchPredictionJobs/{batch_prediction_job\}` + * name: 'projects/my-project/locations/my-location/batchPredictionJobs/my-batchPredictionJob', + * }); * console.log(res.data); * * // Example response @@ -56135,36 +53873,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, + delete( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Delete, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, + delete( + params?: Params$Resource$Projects$Locations$Batchpredictionjobs$Delete, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, + delete( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, + delete( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, + delete( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Delete, callback: BodyResponseCallback ): void; - patch( + delete( callback: BodyResponseCallback ): void; - patch( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch + | Params$Resource$Projects$Locations$Batchpredictionjobs$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -56180,13 +53918,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch; + {}) as Params$Resource$Projects$Locations$Batchpredictionjobs$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch; + {} as Params$Resource$Projects$Locations$Batchpredictionjobs$Delete; options = {}; } @@ -56200,7 +53938,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options @@ -56221,7 +53959,7 @@ export namespace aiplatform_v1 { } /** - * Search the nearest entities under a FeatureView. Search only works for indexable feature view; if a feature view isn't indexable, returns Invalid argument response. + * Gets a BatchPredictionJob * @example * ```js * // Before running the sample: @@ -56250,28 +53988,43 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureOnlineStores.featureViews.searchNearestEntities( - * { - * // Required. FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` - * featureView: - * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "query": {}, - * // "returnFullEntity": false - * // } - * }, - * }, - * ); + * const res = await aiplatform.projects.locations.batchPredictionJobs.get({ + * // Required. The name of the BatchPredictionJob resource. Format: `projects/{project\}/locations/{location\}/batchPredictionJobs/{batch_prediction_job\}` + * name: 'projects/my-project/locations/my-location/batchPredictionJobs/my-batchPredictionJob', + * }); * console.log(res.data); * * // Example response * // { - * // "nearestNeighbors": {} + * // "completionStats": {}, + * // "createTime": "my_createTime", + * // "dedicatedResources": {}, + * // "disableContainerLogging": false, + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "explanationSpec": {}, + * // "generateExplanation": false, + * // "inputConfig": {}, + * // "instanceConfig": {}, + * // "labels": {}, + * // "manualBatchTuningParameters": {}, + * // "model": "my_model", + * // "modelParameters": {}, + * // "modelVersionId": "my_modelVersionId", + * // "name": "my_name", + * // "outputConfig": {}, + * // "outputInfo": {}, + * // "partialFailures": [], + * // "resourcesConsumed": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "serviceAccount": "my_serviceAccount", + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "unmanagedContainerModel": {}, + * // "updateTime": "my_updateTime" * // } * } * @@ -56287,62 +54040,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - searchNearestEntities( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities, + get( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Get, options: StreamMethodOptions ): Promise>; - searchNearestEntities( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities, + get( + params?: Params$Resource$Projects$Locations$Batchpredictionjobs$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - searchNearestEntities( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities, + get( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - searchNearestEntities( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities, + get( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - searchNearestEntities( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - searchNearestEntities( - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Get, + callback: BodyResponseCallback ): void; - searchNearestEntities( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities - | BodyResponseCallback + | Params$Resource$Projects$Locations$Batchpredictionjobs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities; + {}) as Params$Resource$Projects$Locations$Batchpredictionjobs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities; + {} as Params$Resource$Projects$Locations$Batchpredictionjobs$Get; options = {}; } @@ -56355,34 +54108,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+featureView}:searchNearestEntities').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['featureView'], - pathParams: ['featureView'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Lists BatchPredictionJobs in a Location. * @example * ```js * // Before running the sample: @@ -56411,29 +54161,24 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureOnlineStores.featureViews.setIamPolicy( - * { - * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "policy": {} - * // } - * }, - * }, - * ); + * const res = await aiplatform.projects.locations.batchPredictionJobs.list({ + * // The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `model_display_name` supports `=`, `!=` comparisons. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` + * filter: 'placeholder-value', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. Typically obtained via ListBatchPredictionJobsResponse.next_page_token of the previous JobService.ListBatchPredictionJobs call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location to list the BatchPredictionJobs from. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "batchPredictionJobs": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -56449,56 +54194,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy, + list( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$List, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy, + list( + params?: Params$Resource$Projects$Locations$Batchpredictionjobs$List, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$List, + callback: BodyResponseCallback ): void; - setIamPolicy( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - setIamPolicy( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Batchpredictionjobs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Batchpredictionjobs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy; + {} as Params$Resource$Projects$Locations$Batchpredictionjobs$List; options = {}; } @@ -56511,32 +54262,103 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1/{+parent}/batchPredictionJobs').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + + export interface Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel + extends StandardParameters { + /** + * Required. The name of the BatchPredictionJob to cancel. Format: `projects/{project\}/locations/{location\}/batchPredictionJobs/{batch_prediction_job\}` + */ + name?: string; /** - * Triggers on-demand sync for the FeatureView. + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CancelBatchPredictionJobRequest; + } + export interface Params$Resource$Projects$Locations$Batchpredictionjobs$Create + extends StandardParameters { + /** + * Required. The resource name of the Location to create the BatchPredictionJob in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1BatchPredictionJob; + } + export interface Params$Resource$Projects$Locations$Batchpredictionjobs$Delete + extends StandardParameters { + /** + * Required. The name of the BatchPredictionJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/batchPredictionJobs/{batch_prediction_job\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Batchpredictionjobs$Get + extends StandardParameters { + /** + * Required. The name of the BatchPredictionJob resource. Format: `projects/{project\}/locations/{location\}/batchPredictionJobs/{batch_prediction_job\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Batchpredictionjobs$List + extends StandardParameters { + /** + * The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `model_display_name` supports `=`, `!=` comparisons. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` + */ + filter?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. Typically obtained via ListBatchPredictionJobsResponse.next_page_token of the previous JobService.ListBatchPredictionJobs call. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list the BatchPredictionJobs from. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + + export class Resource$Projects$Locations$Cachedcontents { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates cached content, this call will initialize the cached content in the data storage, and users need to pay for the cache data storage. * @example * ```js * // Before running the sample: @@ -56565,23 +54387,47 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureOnlineStores.featureViews.sync({ - * // Required. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` - * featureView: - * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', + * const res = await aiplatform.projects.locations.cachedContents.create({ + * // Required. The parent resource where the cached content will be created + * parent: 'projects/my-project/locations/my-location', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "contents": [], + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "expireTime": "my_expireTime", + * // "model": "my_model", + * // "name": "my_name", + * // "systemInstruction": {}, + * // "toolConfig": {}, + * // "tools": [], + * // "ttl": "my_ttl", + * // "updateTime": "my_updateTime", + * // "usageMetadata": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "featureViewSync": "my_featureViewSync" + * // "contents": [], + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "expireTime": "my_expireTime", + * // "model": "my_model", + * // "name": "my_name", + * // "systemInstruction": {}, + * // "toolConfig": {}, + * // "tools": [], + * // "ttl": "my_ttl", + * // "updateTime": "my_updateTime", + * // "usageMetadata": {} * // } * } * @@ -56597,62 +54443,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - sync( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, + create( + params: Params$Resource$Projects$Locations$Cachedcontents$Create, options: StreamMethodOptions ): Promise>; - sync( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, + create( + params?: Params$Resource$Projects$Locations$Cachedcontents$Create, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - sync( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, + create( + params: Params$Resource$Projects$Locations$Cachedcontents$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - sync( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, + create( + params: Params$Resource$Projects$Locations$Cachedcontents$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - sync( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Cachedcontents$Create, + callback: BodyResponseCallback ): void; - sync( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - sync( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync - | BodyResponseCallback + | Params$Resource$Projects$Locations$Cachedcontents$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync; + {}) as Params$Resource$Projects$Locations$Cachedcontents$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync; + params = {} as Params$Resource$Projects$Locations$Cachedcontents$Create; options = {}; } @@ -56665,7 +54510,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+featureView}:sync').replace( + url: (rootUrl + '/v1/{+parent}/cachedContents').replace( /([^:]\/)\/+/g, '$1' ), @@ -56675,24 +54520,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['featureView'], - pathParams: ['featureView'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Deletes cached content * @example * ```js * // Before running the sample: @@ -56721,22 +54566,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureOnlineStores.featureViews.testIamPermissions( - * { - * // The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). - * permissions: 'placeholder-value', - * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', - * }, - * ); + * const res = await aiplatform.projects.locations.cachedContents.delete({ + * // Required. The resource name referring to the cached content + * name: 'projects/my-project/locations/my-location/cachedContents/my-cachedContent', + * }); * console.log(res.data); * * // Example response - * // { - * // "permissions": [] - * // } + * // {} * } * * main().catch(e => { @@ -56751,62 +54588,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions, + delete( + params: Params$Resource$Projects$Locations$Cachedcontents$Delete, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions, + delete( + params?: Params$Resource$Projects$Locations$Cachedcontents$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Cachedcontents$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Cachedcontents$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Cachedcontents$Delete, + callback: BodyResponseCallback ): void; - testIamPermissions( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Cachedcontents$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Cachedcontents$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions; + params = {} as Params$Resource$Projects$Locations$Cachedcontents$Delete; options = {}; } @@ -56819,209 +54647,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create - extends StandardParameters { - /** - * Required. The ID to use for the FeatureView, which will become the final component of the FeatureView's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a FeatureOnlineStore. - */ - featureViewId?: string; - /** - * Required. The resource name of the FeatureOnlineStore to create FeatureViews. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}` - */ - parent?: string; - /** - * Immutable. If set to true, one on demand sync will be run immediately, regardless whether the FeatureView.sync_config is configured or not. - */ - runSyncImmediately?: boolean; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1FeatureView; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete - extends StandardParameters { - /** - * Required. The name of the FeatureView to be deleted. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite - extends StandardParameters { - /** - * FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` - */ - featureView?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1FeatureViewDirectWriteRequest; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues - extends StandardParameters { - /** - * Required. FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` - */ - featureView?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1FetchFeatureValuesRequest; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Generatefetchaccesstoken - extends StandardParameters { - /** - * FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` - */ - featureView?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1GenerateFetchAccessTokenRequest; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get - extends StandardParameters { - /** - * Required. The name of the FeatureView resource. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy - extends StandardParameters { - /** - * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List - extends StandardParameters { - /** - * Lists the FeatureViews that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> FeatureViews created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> FeatureViews having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any FeatureView which has a label with 'env' as the key. - */ - filter?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `feature_view_id` * `create_time` * `update_time` - */ - orderBy?: string; - /** - * The maximum number of FeatureViews to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViews will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViews call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViews must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The resource name of the FeatureOnlineStore to list FeatureViews. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch - extends StandardParameters { - /** - * Identifier. Name of the FeatureView. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` - */ - name?: string; - /** - * Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `service_agent_type` * `big_query_source` * `big_query_source.uri` * `big_query_source.entity_id_columns` * `feature_registry_source` * `feature_registry_source.feature_groups` * `sync_config` * `sync_config.cron` * `optimized_config.automatic_resources` - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1FeatureView; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities - extends StandardParameters { - /** - * Required. FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` - */ - featureView?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1SearchNearestEntitiesRequest; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync - extends StandardParameters { - /** - * Required. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` - */ - featureView?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1SyncFeatureViewRequest; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions - extends StandardParameters { - /** - * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). - */ - permissions?: string[]; - /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - - export class Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Gets details of a single FeatureViewSync. + * Gets cached content configurations * @example * ```js * // Before running the sample: @@ -57050,24 +54698,27 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.get( - * { - * // Required. The name of the FeatureViewSync resource. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}/featureViewSyncs/{feature_view_sync\}` - * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView/featureViewSyncs/my-featureViewSync', - * }, - * ); + * const res = await aiplatform.projects.locations.cachedContents.get({ + * // Required. The resource name referring to the cached content + * name: 'projects/my-project/locations/my-location/cachedContents/my-cachedContent', + * }); * console.log(res.data); * * // Example response * // { + * // "contents": [], * // "createTime": "my_createTime", - * // "finalStatus": {}, + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "expireTime": "my_expireTime", + * // "model": "my_model", * // "name": "my_name", - * // "runTime": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "syncSummary": {} + * // "systemInstruction": {}, + * // "toolConfig": {}, + * // "tools": [], + * // "ttl": "my_ttl", + * // "updateTime": "my_updateTime", + * // "usageMetadata": {} * // } * } * @@ -57084,61 +54735,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, + params: Params$Resource$Projects$Locations$Cachedcontents$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, + params?: Params$Resource$Projects$Locations$Cachedcontents$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, + params: Params$Resource$Projects$Locations$Cachedcontents$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, + params: Params$Resource$Projects$Locations$Cachedcontents$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Cachedcontents$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Cachedcontents$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get; + {}) as Params$Resource$Projects$Locations$Cachedcontents$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get; + params = {} as Params$Resource$Projects$Locations$Cachedcontents$Get; options = {}; } @@ -57163,19 +54813,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists FeatureViewSyncs in a given FeatureView. + * Lists cached contents in a project * @example * ```js * // Before running the sample: @@ -57204,27 +54854,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.list( - * { - * // Lists the FeatureViewSyncs that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. Examples: * `create_time \> \"2020-01-31T15:30:00.000000Z\"` --\> FeatureViewSyncs created after 2020-01-31T15:30:00.000000Z. - * filter: 'placeholder-value', - * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `create_time` - * orderBy: 'placeholder-value', - * // The maximum number of FeatureViewSyncs to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViewSyncs will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViewSyncs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViewSyncs must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The resource name of the FeatureView to list FeatureViewSyncs. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` - * parent: - * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', - * }, - * ); + * const res = await aiplatform.projects.locations.cachedContents.list({ + * // Optional. The maximum number of cached contents to return. The service may return fewer than this value. If unspecified, some default (under maximum) number of items will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // Optional. A page token, received from a previous `ListCachedContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCachedContents` must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The parent, which owns this collection of cached contents. + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { - * // "featureViewSyncs": [], + * // "cachedContents": [], * // "nextPageToken": "my_nextPageToken" * // } * } @@ -57242,61 +54884,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, + params: Params$Resource$Projects$Locations$Cachedcontents$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, + params?: Params$Resource$Projects$Locations$Cachedcontents$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, + params: Params$Resource$Projects$Locations$Cachedcontents$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, + params: Params$Resource$Projects$Locations$Cachedcontents$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Cachedcontents$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Cachedcontents$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List; + {}) as Params$Resource$Projects$Locations$Cachedcontents$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List; + params = {} as Params$Resource$Projects$Locations$Cachedcontents$List; options = {}; } @@ -57309,7 +54950,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/featureViewSyncs').replace( + url: (rootUrl + '/v1/{+parent}/cachedContents').replace( /([^:]\/)\/+/g, '$1' ), @@ -57324,57 +54965,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get - extends StandardParameters { - /** - * Required. The name of the FeatureViewSync resource. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}/featureViewSyncs/{feature_view_sync\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List - extends StandardParameters { - /** - * Lists the FeatureViewSyncs that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. Examples: * `create_time \> \"2020-01-31T15:30:00.000000Z\"` --\> FeatureViewSyncs created after 2020-01-31T15:30:00.000000Z. - */ - filter?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `create_time` - */ - orderBy?: string; - /** - * The maximum number of FeatureViewSyncs to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViewSyncs will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViewSyncs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViewSyncs must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The resource name of the FeatureView to list FeatureViewSyncs. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` - */ - parent?: string; - } - - export class Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Updates cached content configurations * @example * ```js * // Before running the sample: @@ -57403,17 +55006,50 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureOnlineStores.featureViews.operations.delete( - * { - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView/operations/my-operation', - * }, - * ); + * const res = await aiplatform.projects.locations.cachedContents.patch({ + * // Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project\}/locations/{location\}/cachedContents/{cached_content\} + * name: 'projects/my-project/locations/my-location/cachedContents/my-cachedContent', + * // Required. The list of fields to update. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "contents": [], + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "expireTime": "my_expireTime", + * // "model": "my_model", + * // "name": "my_name", + * // "systemInstruction": {}, + * // "toolConfig": {}, + * // "tools": [], + * // "ttl": "my_ttl", + * // "updateTime": "my_updateTime", + * // "usageMetadata": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "contents": [], + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "expireTime": "my_expireTime", + * // "model": "my_model", + * // "name": "my_name", + * // "systemInstruction": {}, + * // "toolConfig": {}, + * // "tools": [], + * // "ttl": "my_ttl", + * // "updateTime": "my_updateTime", + * // "usageMetadata": {} + * // } * } * * main().catch(e => { @@ -57428,54 +55064,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete, + patch( + params: Params$Resource$Projects$Locations$Cachedcontents$Patch, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete, + patch( + params?: Params$Resource$Projects$Locations$Cachedcontents$Patch, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + patch( + params: Params$Resource$Projects$Locations$Cachedcontents$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Cachedcontents$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Cachedcontents$Patch, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + patch( + callback: BodyResponseCallback + ): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Cachedcontents$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Cachedcontents$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete; + params = {} as Params$Resource$Projects$Locations$Cachedcontents$Patch; options = {}; } @@ -57489,7 +55132,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'PATCH', apiVersion: '', }, options @@ -57500,17 +55143,88 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Cachedcontents$Create + extends StandardParameters { /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Required. The parent resource where the cached content will be created + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CachedContent; + } + export interface Params$Resource$Projects$Locations$Cachedcontents$Delete + extends StandardParameters { + /** + * Required. The resource name referring to the cached content + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Cachedcontents$Get + extends StandardParameters { + /** + * Required. The resource name referring to the cached content + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Cachedcontents$List + extends StandardParameters { + /** + * Optional. The maximum number of cached contents to return. The service may return fewer than this value. If unspecified, some default (under maximum) number of items will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListCachedContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCachedContents` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent, which owns this collection of cached contents. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Cachedcontents$Patch + extends StandardParameters { + /** + * Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project\}/locations/{location\}/cachedContents/{cached_content\} + */ + name?: string; + /** + * Required. The list of fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CachedContent; + } + + export class Resource$Projects$Locations$Customjobs { + context: APIRequestContext; + operations: Resource$Projects$Locations$Customjobs$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Projects$Locations$Customjobs$Operations( + this.context + ); + } + + /** + * Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetCustomJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the CustomJob is not deleted; instead it becomes a job with a CustomJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and CustomJob.state is set to `CANCELLED`. * @example * ```js * // Before running the sample: @@ -57539,23 +55253,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureOnlineStores.featureViews.operations.get( - * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView/operations/my-operation', - * }, - * ); + * const res = await aiplatform.projects.locations.customJobs.cancel({ + * // Required. The name of the CustomJob to cancel. Format: `projects/{project\}/locations/{location\}/customJobs/{custom_job\}` + * name: 'projects/my-project/locations/my-location/customJobs/my-customJob', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -57570,58 +55281,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get, + cancel( + params: Params$Resource$Projects$Locations$Customjobs$Cancel, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get, + cancel( + params?: Params$Resource$Projects$Locations$Customjobs$Cancel, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Customjobs$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Customjobs$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Customjobs$Cancel, + callback: BodyResponseCallback ): void; - get( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Customjobs$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get; + {}) as Params$Resource$Projects$Locations$Customjobs$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get; + params = {} as Params$Resource$Projects$Locations$Customjobs$Cancel; options = {}; } @@ -57634,8 +55340,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -57646,17 +55352,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Creates a CustomJob. A created CustomJob right away will be attempted to be run. * @example * ```js * // Before running the sample: @@ -57685,28 +55391,49 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureOnlineStores.featureViews.operations.listWait( - * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView/operations/my-operation', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.projects.locations.customJobs.create({ + * // Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "jobSpec": {}, + * // "labels": {}, + * // "name": "my_name", + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "updateTime": "my_updateTime", + * // "webAccessUris": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "jobSpec": {}, + * // "labels": {}, + * // "name": "my_name", + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "updateTime": "my_updateTime", + * // "webAccessUris": {} * // } * } * @@ -57722,62 +55449,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listWait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait, + create( + params: Params$Resource$Projects$Locations$Customjobs$Create, options: StreamMethodOptions ): Promise>; - listWait( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait, + create( + params?: Params$Resource$Projects$Locations$Customjobs$Create, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - listWait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait, + create( + params: Params$Resource$Projects$Locations$Customjobs$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listWait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait, + create( + params: Params$Resource$Projects$Locations$Customjobs$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listWait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Customjobs$Create, + callback: BodyResponseCallback ): void; - listWait( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - listWait( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Customjobs$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait; + {}) as Params$Resource$Projects$Locations$Customjobs$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait; + params = {} as Params$Resource$Projects$Locations$Customjobs$Create; options = {}; } @@ -57790,31 +55516,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+parent}/customJobs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Deletes a CustomJob. * @example * ```js * // Before running the sample: @@ -57843,15 +55572,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureOnlineStores.featureViews.operations.wait( - * { - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.projects.locations.customJobs.delete({ + * // Required. The name of the CustomJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/customJobs/{custom_job\}` + * name: 'projects/my-project/locations/my-location/customJobs/my-customJob', + * }); * console.log(res.data); * * // Example response @@ -57876,36 +55600,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait, + delete( + params: Params$Resource$Projects$Locations$Customjobs$Delete, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait, + delete( + params?: Params$Resource$Projects$Locations$Customjobs$Delete, options?: MethodOptions ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait, + delete( + params: Params$Resource$Projects$Locations$Customjobs$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait, + delete( + params: Params$Resource$Projects$Locations$Customjobs$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait, + delete( + params: Params$Resource$Projects$Locations$Customjobs$Delete, callback: BodyResponseCallback ): void; - wait( + delete( callback: BodyResponseCallback ): void; - wait( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait + | Params$Resource$Projects$Locations$Customjobs$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -57921,13 +55645,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Customjobs$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait; + params = {} as Params$Resource$Projects$Locations$Customjobs$Delete; options = {}; } @@ -57940,8 +55663,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -57960,63 +55683,522 @@ export namespace aiplatform_v1 { return createAPIRequest(parameters); } } + + /** + * Gets a CustomJob. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.customJobs.get({ + * // Required. The name of the CustomJob resource. Format: `projects/{project\}/locations/{location\}/customJobs/{custom_job\}` + * name: 'projects/my-project/locations/my-location/customJobs/my-customJob', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "jobSpec": {}, + * // "labels": {}, + * // "name": "my_name", + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "updateTime": "my_updateTime", + * // "webAccessUris": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Customjobs$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Customjobs$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Customjobs$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Customjobs$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Customjobs$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Customjobs$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Customjobs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Customjobs$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists CustomJobs in a Location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.customJobs.list({ + * // The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` + * filter: 'placeholder-value', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. Typically obtained via ListCustomJobsResponse.next_page_token of the previous JobService.ListCustomJobs call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location to list the CustomJobs from. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "customJobs": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Customjobs$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Customjobs$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Customjobs$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Customjobs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Customjobs$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Customjobs$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Customjobs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Customjobs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/customJobs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete + export interface Params$Resource$Projects$Locations$Customjobs$Cancel extends StandardParameters { /** - * The name of the operation resource to be deleted. + * Required. The name of the CustomJob to cancel. Format: `projects/{project\}/locations/{location\}/customJobs/{custom_job\}` */ name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CancelCustomJobRequest; } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get + export interface Params$Resource$Projects$Locations$Customjobs$Create extends StandardParameters { /** - * The name of the operation resource. + * Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project\}/locations/{location\}` */ - name?: string; + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CustomJob; } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait + export interface Params$Resource$Projects$Locations$Customjobs$Delete extends StandardParameters { /** - * The standard list filter. + * Required. The name of the CustomJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/customJobs/{custom_job\}` */ - filter?: string; + name?: string; + } + export interface Params$Resource$Projects$Locations$Customjobs$Get + extends StandardParameters { /** - * The name of the operation's parent resource. + * Required. The name of the CustomJob resource. Format: `projects/{project\}/locations/{location\}/customJobs/{custom_job\}` */ name?: string; + } + export interface Params$Resource$Projects$Locations$Customjobs$List + extends StandardParameters { + /** + * The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` + */ + filter?: string; /** * The standard list page size. */ pageSize?: number; /** - * The standard list page token. + * The standard list page token. Typically obtained via ListCustomJobsResponse.next_page_token of the previous JobService.ListCustomJobs call. */ pageToken?: string; /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait - extends StandardParameters { - /** - * The name of the operation resource to wait on. + * Required. The resource name of the Location to list the CustomJobs from. Format: `projects/{project\}/locations/{location\}` */ - name?: string; + parent?: string; /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * Mask specifying which fields to read. */ - timeout?: string; + readMask?: string; } - export class Resource$Projects$Locations$Featureonlinestores$Operations { + export class Resource$Projects$Locations$Customjobs$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.customJobs.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/customJobs/my-customJob/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Customjobs$Operations$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Projects$Locations$Customjobs$Operations$Cancel, + options?: MethodOptions + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Customjobs$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Customjobs$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Customjobs$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Customjobs$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Customjobs$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Customjobs$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example @@ -58047,11 +56229,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureOnlineStores.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.customJobs.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/customJobs/my-customJob/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -58071,31 +56252,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete, + params: Params$Resource$Projects$Locations$Customjobs$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete, + params?: Params$Resource$Projects$Locations$Customjobs$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete, + params: Params$Resource$Projects$Locations$Customjobs$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete, + params: Params$Resource$Projects$Locations$Customjobs$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete, + params: Params$Resource$Projects$Locations$Customjobs$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete + | Params$Resource$Projects$Locations$Customjobs$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -58111,13 +56292,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Customjobs$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete; + {} as Params$Resource$Projects$Locations$Customjobs$Operations$Delete; options = {}; } @@ -58181,11 +56362,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureOnlineStores.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.customJobs.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/customJobs/my-customJob/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -58211,27 +56391,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get, + params: Params$Resource$Projects$Locations$Customjobs$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get, + params?: Params$Resource$Projects$Locations$Customjobs$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get, + params: Params$Resource$Projects$Locations$Customjobs$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get, + params: Params$Resource$Projects$Locations$Customjobs$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get, + params: Params$Resource$Projects$Locations$Customjobs$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -58239,7 +56419,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get + | Params$Resource$Projects$Locations$Customjobs$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -58255,13 +56435,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get; + {}) as Params$Resource$Projects$Locations$Customjobs$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get; + {} as Params$Resource$Projects$Locations$Customjobs$Operations$Get; options = {}; } @@ -58325,21 +56505,18 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureOnlineStores.operations.listWait( - * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/operations/my-operation', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.projects.locations.customJobs.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/customJobs/my-customJob', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -58362,38 +56539,38 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listWait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait, + list( + params: Params$Resource$Projects$Locations$Customjobs$Operations$List, options: StreamMethodOptions ): Promise>; - listWait( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait, + list( + params?: Params$Resource$Projects$Locations$Customjobs$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; - listWait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait, + list( + params: Params$Resource$Projects$Locations$Customjobs$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listWait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait, + list( + params: Params$Resource$Projects$Locations$Customjobs$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listWait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait, + list( + params: Params$Resource$Projects$Locations$Customjobs$Operations$List, callback: BodyResponseCallback ): void; - listWait( + list( callback: BodyResponseCallback ): void; - listWait( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait + | Params$Resource$Projects$Locations$Customjobs$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -58411,13 +56588,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait; + {}) as Params$Resource$Projects$Locations$Customjobs$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait; + {} as Params$Resource$Projects$Locations$Customjobs$Operations$List; options = {}; } @@ -58430,7 +56607,10 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -58483,13 +56663,12 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureOnlineStores.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); + * const res = await aiplatform.projects.locations.customJobs.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/customJobs/my-customJob/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -58515,27 +56694,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait, + params: Params$Resource$Projects$Locations$Customjobs$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait, + params?: Params$Resource$Projects$Locations$Customjobs$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait, + params: Params$Resource$Projects$Locations$Customjobs$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait, + params: Params$Resource$Projects$Locations$Customjobs$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait, + params: Params$Resource$Projects$Locations$Customjobs$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -58543,7 +56722,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait + | Params$Resource$Projects$Locations$Customjobs$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -58559,13 +56738,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Customjobs$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait; + {} as Params$Resource$Projects$Locations$Customjobs$Operations$Wait; options = {}; } @@ -58600,21 +56779,28 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete + export interface Params$Resource$Projects$Locations$Customjobs$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Customjobs$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get + export interface Params$Resource$Projects$Locations$Customjobs$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait + export interface Params$Resource$Projects$Locations$Customjobs$Operations$List extends StandardParameters { /** * The standard list filter. @@ -58637,7 +56823,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait + export interface Params$Resource$Projects$Locations$Customjobs$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -58649,20 +56835,19 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Featurestores { + export class Resource$Projects$Locations$Datalabelingjobs { context: APIRequestContext; - entityTypes: Resource$Projects$Locations$Featurestores$Entitytypes; - operations: Resource$Projects$Locations$Featurestores$Operations; + operations: Resource$Projects$Locations$Datalabelingjobs$Operations; constructor(context: APIRequestContext) { this.context = context; - this.entityTypes = - new Resource$Projects$Locations$Featurestores$Entitytypes(this.context); this.operations = - new Resource$Projects$Locations$Featurestores$Operations(this.context); + new Resource$Projects$Locations$Datalabelingjobs$Operations( + this.context + ); } /** - * Batch reads Feature values from a Featurestore. This API enables batch reading Feature values, where each read instance in the batch may read Feature values of entities from one or more EntityTypes. Point-in-time correctness is guaranteed for Feature values of each read instance as of each instance's read timestamp. + * Cancels a DataLabelingJob. Success of cancellation is not guaranteed. * @example * ```js * // Before running the sample: @@ -58691,35 +56876,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featurestores.batchReadFeatureValues({ - * // Required. The resource name of the Featurestore from which to query Feature values. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` - * featurestore: - * 'projects/my-project/locations/my-location/featurestores/my-featurestore', + * const res = await aiplatform.projects.locations.dataLabelingJobs.cancel({ + * // Required. The name of the DataLabelingJob. Format: `projects/{project\}/locations/{location\}/dataLabelingJobs/{data_labeling_job\}` + * name: 'projects/my-project/locations/my-location/dataLabelingJobs/my-dataLabelingJob', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "bigqueryReadInstances": {}, - * // "csvReadInstances": {}, - * // "destination": {}, - * // "entityTypeSpecs": [], - * // "passThroughFields": [], - * // "startTime": "my_startTime" - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -58734,58 +56904,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchReadFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues, + cancel( + params: Params$Resource$Projects$Locations$Datalabelingjobs$Cancel, options: StreamMethodOptions ): Promise>; - batchReadFeatureValues( - params?: Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues, + cancel( + params?: Params$Resource$Projects$Locations$Datalabelingjobs$Cancel, options?: MethodOptions - ): Promise>; - batchReadFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Datalabelingjobs$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchReadFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - batchReadFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Datalabelingjobs$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchReadFeatureValues( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Datalabelingjobs$Cancel, + callback: BodyResponseCallback ): void; - batchReadFeatureValues( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datalabelingjobs$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues; + {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues; + {} as Params$Resource$Projects$Locations$Datalabelingjobs$Cancel; options = {}; } @@ -58798,31 +56964,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+featurestore}:batchReadFeatureValues' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['featurestore'], - pathParams: ['featurestore'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates a new Featurestore in a given project and location. + * Creates a DataLabelingJob. * @example * ```js * // Before running the sample: @@ -58851,25 +57015,30 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featurestores.create({ - * // Required. The ID to use for this Featurestore, which will become the final component of the Featurestore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location. - * featurestoreId: 'placeholder-value', - * // Required. The resource name of the Location to create Featurestores. Format: `projects/{project\}/locations/{location\}` + * const res = await aiplatform.projects.locations.dataLabelingJobs.create({ + * // Required. The parent of the DataLabelingJob. Format: `projects/{project\}/locations/{location\}` * parent: 'projects/my-project/locations/my-location', * * // Request body metadata * requestBody: { * // request body parameters * // { + * // "activeLearningConfig": {}, + * // "annotationLabels": {}, * // "createTime": "my_createTime", + * // "currentSpend": {}, + * // "datasets": [], + * // "displayName": "my_displayName", * // "encryptionSpec": {}, - * // "etag": "my_etag", + * // "error": {}, + * // "inputs": {}, + * // "inputsSchemaUri": "my_inputsSchemaUri", + * // "instructionUri": "my_instructionUri", + * // "labelerCount": 0, + * // "labelingProgress": 0, * // "labels": {}, * // "name": "my_name", - * // "onlineServingConfig": {}, - * // "onlineStorageTtlDays": 0, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, + * // "specialistPools": [], * // "state": "my_state", * // "updateTime": "my_updateTime" * // } @@ -58879,11 +57048,24 @@ export namespace aiplatform_v1 { * * // Example response * // { - * // "done": false, + * // "activeLearningConfig": {}, + * // "annotationLabels": {}, + * // "createTime": "my_createTime", + * // "currentSpend": {}, + * // "datasets": [], + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, * // "error": {}, - * // "metadata": {}, + * // "inputs": {}, + * // "inputsSchemaUri": "my_inputsSchemaUri", + * // "instructionUri": "my_instructionUri", + * // "labelerCount": 0, + * // "labelingProgress": 0, + * // "labels": {}, * // "name": "my_name", - * // "response": {} + * // "specialistPools": [], + * // "state": "my_state", + * // "updateTime": "my_updateTime" * // } * } * @@ -58900,56 +57082,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Featurestores$Create, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Create, options: StreamMethodOptions ): Promise>; create( - params?: Params$Resource$Projects$Locations$Featurestores$Create, + params?: Params$Resource$Projects$Locations$Datalabelingjobs$Create, options?: MethodOptions - ): Promise>; + ): Promise< + GaxiosResponseWithHTTP2 + >; create( - params: Params$Resource$Projects$Locations$Featurestores$Create, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Featurestores$Create, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Featurestores$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datalabelingjobs$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datalabelingjobs$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Create; + {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Featurestores$Create; + params = + {} as Params$Resource$Projects$Locations$Datalabelingjobs$Create; options = {}; } @@ -58962,7 +57149,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/featurestores').replace( + url: (rootUrl + '/v1/{+parent}/dataLabelingJobs').replace( /([^:]\/)\/+/g, '$1' ), @@ -58977,17 +57164,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or `force` must be set to true for the request to succeed. + * Deletes a DataLabelingJob. * @example * ```js * // Before running the sample: @@ -59016,11 +57205,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featurestores.delete({ - * // If set to true, any EntityTypes and Features for this Featurestore will also be deleted. (Otherwise, the request will only work if the Featurestore has no EntityTypes.) - * force: 'placeholder-value', - * // Required. The name of the Featurestore to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore', + * const res = await aiplatform.projects.locations.dataLabelingJobs.delete({ + * // Required. The name of the DataLabelingJob to be deleted. Format: `projects/{project\}/locations/{location\}/dataLabelingJobs/{data_labeling_job\}` + * name: 'projects/my-project/locations/my-location/dataLabelingJobs/my-dataLabelingJob', * }); * console.log(res.data); * @@ -59047,27 +57234,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Featurestores$Delete, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Featurestores$Delete, + params?: Params$Resource$Projects$Locations$Datalabelingjobs$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Featurestores$Delete, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featurestores$Delete, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featurestores$Delete, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Delete, callback: BodyResponseCallback ): void; delete( @@ -59075,7 +57262,7 @@ export namespace aiplatform_v1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Delete + | Params$Resource$Projects$Locations$Datalabelingjobs$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -59091,12 +57278,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Delete; + {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Featurestores$Delete; + params = + {} as Params$Resource$Projects$Locations$Datalabelingjobs$Delete; options = {}; } @@ -59131,7 +57319,7 @@ export namespace aiplatform_v1 { } /** - * Gets details of a single Featurestore. + * Gets a DataLabelingJob. * @example * ```js * // Before running the sample: @@ -59160,23 +57348,30 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featurestores.get({ - * // Required. The name of the Featurestore resource. - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore', + * const res = await aiplatform.projects.locations.dataLabelingJobs.get({ + * // Required. The name of the DataLabelingJob. Format: `projects/{project\}/locations/{location\}/dataLabelingJobs/{data_labeling_job\}` + * name: 'projects/my-project/locations/my-location/dataLabelingJobs/my-dataLabelingJob', * }); * console.log(res.data); * * // Example response * // { + * // "activeLearningConfig": {}, + * // "annotationLabels": {}, * // "createTime": "my_createTime", + * // "currentSpend": {}, + * // "datasets": [], + * // "displayName": "my_displayName", * // "encryptionSpec": {}, - * // "etag": "my_etag", + * // "error": {}, + * // "inputs": {}, + * // "inputsSchemaUri": "my_inputsSchemaUri", + * // "instructionUri": "my_instructionUri", + * // "labelerCount": 0, + * // "labelingProgress": 0, * // "labels": {}, * // "name": "my_name", - * // "onlineServingConfig": {}, - * // "onlineStorageTtlDays": 0, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, + * // "specialistPools": [], * // "state": "my_state", * // "updateTime": "my_updateTime" * // } @@ -59195,60 +57390,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Featurestores$Get, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Featurestores$Get, + params?: Params$Resource$Projects$Locations$Datalabelingjobs$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; get( - params: Params$Resource$Projects$Locations$Featurestores$Get, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featurestores$Get, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featurestores$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datalabelingjobs$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datalabelingjobs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Get; + {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Featurestores$Get; + params = {} as Params$Resource$Projects$Locations$Datalabelingjobs$Get; options = {}; } @@ -59273,19 +57468,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Lists DataLabelingJobs in a Location. * @example * ```js * // Before running the sample: @@ -59314,20 +57509,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featurestores.getIamPolicy({ - * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - * 'options.requestedPolicyVersion': 'placeholder-value', - * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/featurestores/my-featurestore', + * const res = await aiplatform.projects.locations.dataLabelingJobs.list({ + * // The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` + * filter: 'placeholder-value', + * // A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. + * orderBy: 'placeholder-value', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // Required. The parent of the DataLabelingJob. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // Mask specifying which fields to read. FieldMask represents a set of symbolic field paths. For example, the mask can be `paths: "name"`. The "name" here is a field in DataLabelingJob. If this field is not set, all fields of the DataLabelingJob are returned. + * readMask: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "dataLabelingJobs": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -59343,56 +57544,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Getiampolicy, + list( + params: Params$Resource$Projects$Locations$Datalabelingjobs$List, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Featurestores$Getiampolicy, + list( + params?: Params$Resource$Projects$Locations$Datalabelingjobs$List, options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Getiampolicy, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Datalabelingjobs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datalabelingjobs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Getiampolicy, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datalabelingjobs$List, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - getIamPolicy( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datalabelingjobs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Datalabelingjobs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featurestores$Getiampolicy; + params = {} as Params$Resource$Projects$Locations$Datalabelingjobs$List; options = {}; } @@ -59405,32 +57611,107 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1/{+parent}/dataLabelingJobs').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Datalabelingjobs$Cancel + extends StandardParameters { /** - * Lists Featurestores in a given project and location. + * Required. The name of the DataLabelingJob. Format: `projects/{project\}/locations/{location\}/dataLabelingJobs/{data_labeling_job\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CancelDataLabelingJobRequest; + } + export interface Params$Resource$Projects$Locations$Datalabelingjobs$Create + extends StandardParameters { + /** + * Required. The parent of the DataLabelingJob. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1DataLabelingJob; + } + export interface Params$Resource$Projects$Locations$Datalabelingjobs$Delete + extends StandardParameters { + /** + * Required. The name of the DataLabelingJob to be deleted. Format: `projects/{project\}/locations/{location\}/dataLabelingJobs/{data_labeling_job\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datalabelingjobs$Get + extends StandardParameters { + /** + * Required. The name of the DataLabelingJob. Format: `projects/{project\}/locations/{location\}/dataLabelingJobs/{data_labeling_job\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datalabelingjobs$List + extends StandardParameters { + /** + * The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` + */ + filter?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. + */ + orderBy?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * Required. The parent of the DataLabelingJob. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. FieldMask represents a set of symbolic field paths. For example, the mask can be `paths: "name"`. The "name" here is a field in DataLabelingJob. If this field is not set, all fields of the DataLabelingJob are returned. + */ + readMask?: string; + } + + export class Resource$Projects$Locations$Datalabelingjobs$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -59459,27 +57740,15 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featurestores.list({ - * // Lists the featurestores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `online_serving_config.fixed_node_count`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. * `labels`: Supports key-value equality and key presence. Examples: * `create_time \> "2020-01-01" OR update_time \> "2020-01-01"` Featurestores created or updated after 2020-01-01. * `labels.env = "prod"` Featurestores with label "env" set to "prod". - * filter: 'placeholder-value', - * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time` * `update_time` * `online_serving_config.fixed_node_count` - * orderBy: 'placeholder-value', - * // The maximum number of Featurestores to return. The service may return fewer than this value. If unspecified, at most 100 Featurestores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. - * pageSize: 'placeholder-value', - * // A page token, received from a previous FeaturestoreService.ListFeaturestores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeaturestores must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list Featurestores. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.dataLabelingJobs.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/dataLabelingJobs/my-dataLabelingJob/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "featurestores": [], - * // "nextPageToken": "my_nextPageToken" - * // } + * // {} * } * * main().catch(e => { @@ -59494,61 +57763,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Featurestores$List, + cancel( + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Featurestores$List, + cancel( + params?: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Featurestores$List, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featurestores$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Featurestores$List, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel, + callback: BodyResponseCallback ): void; - list( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$List; + {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Featurestores$List; + params = + {} as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel; options = {}; } @@ -59561,34 +57823,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/featurestores').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates the parameters of a single Featurestore. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -59617,40 +57874,15 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featurestores.patch({ - * // Output only. Name of the Featurestore. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore', - * // Field mask is used to specify the fields to be overwritten in the Featurestore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `online_serving_config.fixed_node_count` * `online_serving_config.scaling` * `online_storage_ttl_days` - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "onlineServingConfig": {}, - * // "onlineStorageTtlDays": 0, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "state": "my_state", - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * const res = + * await aiplatform.projects.locations.dataLabelingJobs.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/dataLabelingJobs/my-dataLabelingJob/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -59665,57 +57897,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Featurestores$Patch, + delete( + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Featurestores$Patch, + delete( + params?: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Featurestores$Patch, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featurestores$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Featurestores$Patch, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete, + callback: BodyResponseCallback ): void; - patch( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Patch; + {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Featurestores$Patch; + params = + {} as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete; options = {}; } @@ -59729,7 +57958,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options @@ -59740,17 +57969,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Searches Features matching a query in a given project. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -59779,22 +58008,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featurestores.searchFeatures({ - * // Required. The resource name of the Location to search Features. Format: `projects/{project\}/locations/{location\}` - * location: 'projects/my-project/locations/my-location', - * // The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 100 Features will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. - * pageSize: 'placeholder-value', - * // A page token, received from a previous FeaturestoreService.SearchFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.SearchFeatures, except `page_size`, must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Query string that is a conjunction of field-restricted queries and/or field-restricted filters. Field-restricted queries and filters can be combined using `AND` to form a conjunction. A field query is in the form FIELD:QUERY. This implicitly checks if QUERY exists as a substring within Feature's FIELD. The QUERY and the FIELD are converted to a sequence of words (i.e. tokens) for comparison. This is done by: * Removing leading/trailing whitespace and tokenizing the search value. Characters that are not one of alphanumeric `[a-zA-Z0-9]`, underscore `_`, or asterisk `*` are treated as delimiters for tokens. `*` is treated as a wildcard that matches characters within a token. * Ignoring case. * Prepending an asterisk to the first and appending an asterisk to the last token in QUERY. A QUERY must be either a singular token or a phrase. A phrase is one or multiple words enclosed in double quotation marks ("). With phrases, the order of the words is important. Words in the phrase must be matching in order and consecutively. Supported FIELDs for field-restricted queries: * `feature_id` * `description` * `entity_type_id` Examples: * `feature_id: foo` --\> Matches a Feature with ID containing the substring `foo` (eg. `foo`, `foofeature`, `barfoo`). * `feature_id: foo*feature` --\> Matches a Feature with ID containing the substring `foo*feature` (eg. `foobarfeature`). * `feature_id: foo AND description: bar` --\> Matches a Feature with ID containing the substring `foo` and description containing the substring `bar`. Besides field queries, the following exact-match filters are supported. The exact-match filters do not support wildcards. Unlike field-restricted queries, exact-match filters are case-sensitive. * `feature_id`: Supports = comparisons. * `description`: Supports = comparisons. Multi-token filters should be enclosed in quotes. * `entity_type_id`: Supports = comparisons. * `value_type`: Supports = and != comparisons. * `labels`: Supports key-value equality as well as key presence. * `featurestore_id`: Supports = comparisons. Examples: * `description = "foo bar"` --\> Any Feature with description exactly equal to `foo bar` * `value_type = DOUBLE` --\> Features whose type is DOUBLE. * `labels.active = yes AND labels.env = prod` --\> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any Feature which has a label with `env` as the key. - * query: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.dataLabelingJobs.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/dataLabelingJobs/my-dataLabelingJob/operations/my-operation', + * }); * console.log(res.data); * * // Example response * // { - * // "features": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -59810,62 +58037,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - searchFeatures( - params: Params$Resource$Projects$Locations$Featurestores$Searchfeatures, + get( + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get, options: StreamMethodOptions ): Promise>; - searchFeatures( - params?: Params$Resource$Projects$Locations$Featurestores$Searchfeatures, + get( + params?: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - searchFeatures( - params: Params$Resource$Projects$Locations$Featurestores$Searchfeatures, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - searchFeatures( - params: Params$Resource$Projects$Locations$Featurestores$Searchfeatures, + get( + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - searchFeatures( - params: Params$Resource$Projects$Locations$Featurestores$Searchfeatures, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get, + callback: BodyResponseCallback ): void; - searchFeatures( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - searchFeatures( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Searchfeatures - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Searchfeatures; + {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Searchfeatures; + {} as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get; options = {}; } @@ -59878,33 +58101,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+location}/featurestores:searchFeatures' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['location'], - pathParams: ['location'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -59933,26 +58152,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featurestores.setIamPolicy({ - * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/featurestores/my-featurestore', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "policy": {} - * // } - * }, - * }); + * const res = + * await aiplatform.projects.locations.dataLabelingJobs.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/dataLabelingJobs/my-dataLabelingJob', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -59968,56 +58187,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Setiampolicy, + list( + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Featurestores$Setiampolicy, + list( + params?: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Setiampolicy, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Setiampolicy, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List, + callback: BodyResponseCallback ): void; - setIamPolicy( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - setIamPolicy( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Setiampolicy; + {} as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List; options = {}; } @@ -60030,32 +58255,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -60085,18 +58312,21 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featurestores.testIamPermissions({ - * // The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). - * permissions: 'placeholder-value', - * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/featurestores/my-featurestore', + * await aiplatform.projects.locations.dataLabelingJobs.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/dataLabelingJobs/my-dataLabelingJob/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "permissions": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -60112,62 +58342,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Featurestores$Testiampermissions, + wait( + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Featurestores$Testiampermissions, + wait( + params?: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featurestores$Testiampermissions, + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featurestores$Testiampermissions, + wait( + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featurestores$Testiampermissions, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - testIamPermissions( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Testiampermissions; + {} as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait; options = {}; } @@ -60180,194 +58406,110 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues - extends StandardParameters { - /** - * Required. The resource name of the Featurestore from which to query Feature values. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` - */ - featurestore?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1BatchReadFeatureValuesRequest; - } - export interface Params$Resource$Projects$Locations$Featurestores$Create - extends StandardParameters { - /** - * Required. The ID to use for this Featurestore, which will become the final component of the Featurestore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location. - */ - featurestoreId?: string; - /** - * Required. The resource name of the Location to create Featurestores. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Featurestore; - } - export interface Params$Resource$Projects$Locations$Featurestores$Delete + export interface Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel extends StandardParameters { /** - * If set to true, any EntityTypes and Features for this Featurestore will also be deleted. (Otherwise, the request will only work if the Featurestore has no EntityTypes.) - */ - force?: boolean; - /** - * Required. The name of the Featurestore to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` + * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Get + export interface Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete extends StandardParameters { /** - * Required. The name of the Featurestore resource. + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Getiampolicy + export interface Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get extends StandardParameters { /** - * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * The name of the operation resource. */ - resource?: string; + name?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$List + export interface Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List extends StandardParameters { /** - * Lists the featurestores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `online_serving_config.fixed_node_count`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. * `labels`: Supports key-value equality and key presence. Examples: * `create_time \> "2020-01-01" OR update_time \> "2020-01-01"` Featurestores created or updated after 2020-01-01. * `labels.env = "prod"` Featurestores with label "env" set to "prod". + * The standard list filter. */ filter?: string; /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time` * `update_time` * `online_serving_config.fixed_node_count` - */ - orderBy?: string; - /** - * The maximum number of Featurestores to return. The service may return fewer than this value. If unspecified, at most 100 Featurestores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. - */ - pageSize?: number; - /** - * A page token, received from a previous FeaturestoreService.ListFeaturestores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeaturestores must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The resource name of the Location to list Featurestores. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; - } - export interface Params$Resource$Projects$Locations$Featurestores$Patch - extends StandardParameters { - /** - * Output only. Name of the Featurestore. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` + * The name of the operation's parent resource. */ name?: string; /** - * Field mask is used to specify the fields to be overwritten in the Featurestore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `online_serving_config.fixed_node_count` * `online_serving_config.scaling` * `online_storage_ttl_days` - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Featurestore; - } - export interface Params$Resource$Projects$Locations$Featurestores$Searchfeatures - extends StandardParameters { - /** - * Required. The resource name of the Location to search Features. Format: `projects/{project\}/locations/{location\}` - */ - location?: string; - /** - * The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 100 Features will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. + * The standard list page size. */ pageSize?: number; /** - * A page token, received from a previous FeaturestoreService.SearchFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.SearchFeatures, except `page_size`, must match the call that provided the page token. + * The standard list page token. */ pageToken?: string; /** - * Query string that is a conjunction of field-restricted queries and/or field-restricted filters. Field-restricted queries and filters can be combined using `AND` to form a conjunction. A field query is in the form FIELD:QUERY. This implicitly checks if QUERY exists as a substring within Feature's FIELD. The QUERY and the FIELD are converted to a sequence of words (i.e. tokens) for comparison. This is done by: * Removing leading/trailing whitespace and tokenizing the search value. Characters that are not one of alphanumeric `[a-zA-Z0-9]`, underscore `_`, or asterisk `*` are treated as delimiters for tokens. `*` is treated as a wildcard that matches characters within a token. * Ignoring case. * Prepending an asterisk to the first and appending an asterisk to the last token in QUERY. A QUERY must be either a singular token or a phrase. A phrase is one or multiple words enclosed in double quotation marks ("). With phrases, the order of the words is important. Words in the phrase must be matching in order and consecutively. Supported FIELDs for field-restricted queries: * `feature_id` * `description` * `entity_type_id` Examples: * `feature_id: foo` --\> Matches a Feature with ID containing the substring `foo` (eg. `foo`, `foofeature`, `barfoo`). * `feature_id: foo*feature` --\> Matches a Feature with ID containing the substring `foo*feature` (eg. `foobarfeature`). * `feature_id: foo AND description: bar` --\> Matches a Feature with ID containing the substring `foo` and description containing the substring `bar`. Besides field queries, the following exact-match filters are supported. The exact-match filters do not support wildcards. Unlike field-restricted queries, exact-match filters are case-sensitive. * `feature_id`: Supports = comparisons. * `description`: Supports = comparisons. Multi-token filters should be enclosed in quotes. * `entity_type_id`: Supports = comparisons. * `value_type`: Supports = and != comparisons. * `labels`: Supports key-value equality as well as key presence. * `featurestore_id`: Supports = comparisons. Examples: * `description = "foo bar"` --\> Any Feature with description exactly equal to `foo bar` * `value_type = DOUBLE` --\> Features whose type is DOUBLE. * `labels.active = yes AND labels.env = prod` --\> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any Feature which has a label with `env` as the key. - */ - query?: string; - } - export interface Params$Resource$Projects$Locations$Featurestores$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Featurestores$Testiampermissions + export interface Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait extends StandardParameters { /** - * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * The name of the operation resource to wait on. */ - permissions?: string[]; + name?: string; /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - resource?: string; + timeout?: string; } - export class Resource$Projects$Locations$Featurestores$Entitytypes { + export class Resource$Projects$Locations$Datasets { context: APIRequestContext; - features: Resource$Projects$Locations$Featurestores$Entitytypes$Features; - operations: Resource$Projects$Locations$Featurestores$Entitytypes$Operations; + annotationSpecs: Resource$Projects$Locations$Datasets$Annotationspecs; + dataItems: Resource$Projects$Locations$Datasets$Dataitems; + datasetVersions: Resource$Projects$Locations$Datasets$Datasetversions; + operations: Resource$Projects$Locations$Datasets$Operations; + savedQueries: Resource$Projects$Locations$Datasets$Savedqueries; constructor(context: APIRequestContext) { this.context = context; - this.features = - new Resource$Projects$Locations$Featurestores$Entitytypes$Features( - this.context - ); - this.operations = - new Resource$Projects$Locations$Featurestores$Entitytypes$Operations( - this.context - ); + this.annotationSpecs = + new Resource$Projects$Locations$Datasets$Annotationspecs(this.context); + this.dataItems = new Resource$Projects$Locations$Datasets$Dataitems( + this.context + ); + this.datasetVersions = + new Resource$Projects$Locations$Datasets$Datasetversions(this.context); + this.operations = new Resource$Projects$Locations$Datasets$Operations( + this.context + ); + this.savedQueries = new Resource$Projects$Locations$Datasets$Savedqueries( + this.context + ); } /** - * Creates a new EntityType in a given Featurestore. + * Creates a Dataset. * @example * ```js * // Before running the sample: @@ -60396,31 +58538,33 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.create({ - * // Required. The ID to use for the EntityType, which will become the final component of the EntityType's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a featurestore. - * entityTypeId: 'placeholder-value', - * // Required. The resource name of the Featurestore to create EntityTypes. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` - * parent: - * 'projects/my-project/locations/my-location/featurestores/my-featurestore', + * const res = await aiplatform.projects.locations.datasets.create({ + * // Required. The resource name of the Location to create the Dataset in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "etag": "my_etag", - * // "labels": {}, - * // "monitoringConfig": {}, - * // "name": "my_name", - * // "offlineStorageTtlDays": 0, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "dataItemCount": "my_dataItemCount", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "metadata": {}, + * // "metadataArtifact": "my_metadataArtifact", + * // "metadataSchemaUri": "my_metadataSchemaUri", + * // "modelReference": "my_modelReference", + * // "name": "my_name", + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "savedQueries": [], + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response @@ -60446,27 +58590,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create, + params: Params$Resource$Projects$Locations$Datasets$Create, options: StreamMethodOptions ): Promise>; create( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create, + params?: Params$Resource$Projects$Locations$Datasets$Create, options?: MethodOptions ): Promise>; create( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create, + params: Params$Resource$Projects$Locations$Datasets$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create, + params: Params$Resource$Projects$Locations$Datasets$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create, + params: Params$Resource$Projects$Locations$Datasets$Create, callback: BodyResponseCallback ): void; create( @@ -60474,7 +58618,7 @@ export namespace aiplatform_v1 { ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create + | Params$Resource$Projects$Locations$Datasets$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -60490,13 +58634,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create; + {}) as Params$Resource$Projects$Locations$Datasets$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create; + params = {} as Params$Resource$Projects$Locations$Datasets$Create; options = {}; } @@ -60509,7 +58652,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/entityTypes').replace( + url: (rootUrl + '/v1/{+parent}/datasets').replace( /([^:]\/)\/+/g, '$1' ), @@ -60534,7 +58677,7 @@ export namespace aiplatform_v1 { } /** - * Deletes a single EntityType. The EntityType must not have any Features or `force` must be set to true for the request to succeed. + * Deletes a Dataset. * @example * ```js * // Before running the sample: @@ -60563,13 +58706,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.delete({ - * // If set to true, any Features for this EntityType will also be deleted. (Otherwise, the request will only work if the EntityType has no Features.) - * force: 'placeholder-value', - * // Required. The name of the EntityType to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', - * }); + * const res = await aiplatform.projects.locations.datasets.delete({ + * // Required. The resource name of the Dataset to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + * name: 'projects/my-project/locations/my-location/datasets/my-dataset', + * }); * console.log(res.data); * * // Example response @@ -60595,27 +58735,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete, + params: Params$Resource$Projects$Locations$Datasets$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete, + params?: Params$Resource$Projects$Locations$Datasets$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete, + params: Params$Resource$Projects$Locations$Datasets$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete, + params: Params$Resource$Projects$Locations$Datasets$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete, + params: Params$Resource$Projects$Locations$Datasets$Delete, callback: BodyResponseCallback ): void; delete( @@ -60623,7 +58763,7 @@ export namespace aiplatform_v1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete + | Params$Resource$Projects$Locations$Datasets$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -60639,13 +58779,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete; + {}) as Params$Resource$Projects$Locations$Datasets$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete; + params = {} as Params$Resource$Projects$Locations$Datasets$Delete; options = {}; } @@ -60680,7 +58819,7 @@ export namespace aiplatform_v1 { } /** - * Delete Feature values from Featurestore. The progress of the deletion is tracked by the returned operation. The deleted feature values are guaranteed to be invisible to subsequent read operations after the operation is marked as successfully done. If a delete feature values operation fails, the feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same delete request again and wait till the new operation returned is marked as successfully done. + * Exports data from a Dataset. * @example * ```js * // Before running the sample: @@ -60709,24 +58848,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.deleteFeatureValues( - * { - * // Required. The resource name of the EntityType grouping the Features for which values are being deleted from. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entityType\}` - * entityType: - * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', + * const res = await aiplatform.projects.locations.datasets.export({ + * // Required. The name of the Dataset resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + * name: 'projects/my-project/locations/my-location/datasets/my-dataset', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "selectEntity": {}, - * // "selectTimeRangeAndFeature": {} - * // } - * }, - * }, - * ); - * console.log(res.data); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "exportConfig": {} + * // } + * }, + * }); + * console.log(res.data); * * // Example response * // { @@ -60750,36 +58884,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - deleteFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues, + export( + params: Params$Resource$Projects$Locations$Datasets$Export, options: StreamMethodOptions ): Promise>; - deleteFeatureValues( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues, + export( + params?: Params$Resource$Projects$Locations$Datasets$Export, options?: MethodOptions ): Promise>; - deleteFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues, + export( + params: Params$Resource$Projects$Locations$Datasets$Export, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deleteFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues, + export( + params: Params$Resource$Projects$Locations$Datasets$Export, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deleteFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues, + export( + params: Params$Resource$Projects$Locations$Datasets$Export, callback: BodyResponseCallback ): void; - deleteFeatureValues( + export( callback: BodyResponseCallback ): void; - deleteFeatureValues( + export( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues + | Params$Resource$Projects$Locations$Datasets$Export | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -60795,13 +58929,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues; + {}) as Params$Resource$Projects$Locations$Datasets$Export; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues; + params = {} as Params$Resource$Projects$Locations$Datasets$Export; options = {}; } @@ -60814,18 +58947,15 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+entityType}:deleteFeatureValues').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:export').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['entityType'], - pathParams: ['entityType'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -60839,7 +58969,7 @@ export namespace aiplatform_v1 { } /** - * Exports Feature values from all the entities of a target EntityType. + * Gets a Dataset. * @example * ```js * // Before running the sample: @@ -60868,35 +58998,32 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.exportFeatureValues( - * { - * // Required. The resource name of the EntityType from which to export Feature values. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` - * entityType: - * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "destination": {}, - * // "featureSelector": {}, - * // "fullExport": {}, - * // "settings": [], - * // "snapshotExport": {} - * // } - * }, - * }, - * ); + * const res = await aiplatform.projects.locations.datasets.get({ + * // Required. The name of the Dataset resource. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, + * // "createTime": "my_createTime", + * // "dataItemCount": "my_dataItemCount", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, * // "metadata": {}, + * // "metadataArtifact": "my_metadataArtifact", + * // "metadataSchemaUri": "my_metadataSchemaUri", + * // "modelReference": "my_modelReference", * // "name": "my_name", - * // "response": {} + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "savedQueries": [], + * // "updateTime": "my_updateTime" * // } * } * @@ -60912,58 +59039,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - exportFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues, + get( + params: Params$Resource$Projects$Locations$Datasets$Get, options: StreamMethodOptions ): Promise>; - exportFeatureValues( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues, + get( + params?: Params$Resource$Projects$Locations$Datasets$Get, options?: MethodOptions - ): Promise>; - exportFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Datasets$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - exportFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues, + get( + params: Params$Resource$Projects$Locations$Datasets$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - exportFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datasets$Get, + callback: BodyResponseCallback ): void; - exportFeatureValues( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - exportFeatureValues( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues; + {}) as Params$Resource$Projects$Locations$Datasets$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues; + params = {} as Params$Resource$Projects$Locations$Datasets$Get; options = {}; } @@ -60976,32 +59102,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+entityType}:exportFeatureValues').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['entityType'], - pathParams: ['entityType'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets details of a single EntityType. + * Imports data into a Dataset. * @example * ```js * // Before running the sample: @@ -61030,26 +59155,27 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featurestores.entityTypes.get( - * { - * // Required. The name of the EntityType resource. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', + * const res = await aiplatform.projects.locations.datasets.import({ + * // Required. The name of the Dataset resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + * name: 'projects/my-project/locations/my-location/datasets/my-dataset', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "importConfigs": [] + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "etag": "my_etag", - * // "labels": {}, - * // "monitoringConfig": {}, + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "offlineStorageTtlDays": 0, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -61065,62 +59191,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get, + import( + params: Params$Resource$Projects$Locations$Datasets$Import, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get, + import( + params?: Params$Resource$Projects$Locations$Datasets$Import, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get, + ): Promise>; + import( + params: Params$Resource$Projects$Locations$Datasets$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get, + import( + params: Params$Resource$Projects$Locations$Datasets$Import, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get, - callback: BodyResponseCallback + import( + params: Params$Resource$Projects$Locations$Datasets$Import, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + import( + callback: BodyResponseCallback ): void; - get( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Import + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get; + {}) as Params$Resource$Projects$Locations$Datasets$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get; + params = {} as Params$Resource$Projects$Locations$Datasets$Import; options = {}; } @@ -61133,8 +59254,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:import').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -61145,19 +59266,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Lists Datasets in a Location. * @example * ```js * // Before running the sample: @@ -61186,21 +59305,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.getIamPolicy({ - * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - * 'options.requestedPolicyVersion': 'placeholder-value', - * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', - * }); + * const res = await aiplatform.projects.locations.datasets.list({ + * // An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `display_name`: supports = and != * `metadata_schema_uri`: supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. Some examples: * `displayName="myDisplayName"` * `labels.myKey="myValue"` + * filter: 'placeholder-value', + * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` + * orderBy: 'placeholder-value', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // Required. The name of the Dataset's parent resource. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "datasets": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -61216,56 +59340,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy, + list( + params: Params$Resource$Projects$Locations$Datasets$List, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy, + list( + params?: Params$Resource$Projects$Locations$Datasets$List, options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Datasets$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datasets$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datasets$List, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - getIamPolicy( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Datasets$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy; + params = {} as Params$Resource$Projects$Locations$Datasets$List; options = {}; } @@ -61278,32 +59407,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1/{+parent}/datasets').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Imports Feature values into the Featurestore from a source storage. The progress of the import is tracked by the returned operation. The imported features are guaranteed to be visible to subsequent read operations after the operation is marked as successfully done. If an import operation fails, the Feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same import request again and wait till the new operation returned is marked as successfully done. There are also scenarios where the caller can cause inconsistency. - Source data for import contains multiple distinct Feature values for the same entity ID and timestamp. - Source is modified during an import. This includes adding, updating, or removing source data and/or metadata. Examples of updating metadata include but are not limited to changing storage location, storage class, or retention policy. - Online serving cluster is under-provisioned. + * Updates a Dataset. * @example * ```js * // Before running the sample: @@ -61332,40 +59463,55 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.importFeatureValues( - * { - * // Required. The resource name of the EntityType grouping the Features for which values are being imported. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entityType\}` - * entityType: - * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', + * const res = await aiplatform.projects.locations.datasets.patch({ + * // Output only. Identifier. The resource name of the Dataset. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + * name: 'projects/my-project/locations/my-location/datasets/my-dataset', + * // Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` * `description` * `labels` + * updateMask: 'placeholder-value', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "avroSource": {}, - * // "bigquerySource": {}, - * // "csvSource": {}, - * // "disableIngestionAnalysis": false, - * // "disableOnlineServing": false, - * // "entityIdField": "my_entityIdField", - * // "featureSpecs": [], - * // "featureTime": "my_featureTime", - * // "featureTimeField": "my_featureTimeField", - * // "workerCount": 0 - * // } - * }, - * }, - * ); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "dataItemCount": "my_dataItemCount", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "metadata": {}, + * // "metadataArtifact": "my_metadataArtifact", + * // "metadataSchemaUri": "my_metadataSchemaUri", + * // "modelReference": "my_modelReference", + * // "name": "my_name", + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "savedQueries": [], + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, + * // "createTime": "my_createTime", + * // "dataItemCount": "my_dataItemCount", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, * // "metadata": {}, + * // "metadataArtifact": "my_metadataArtifact", + * // "metadataSchemaUri": "my_metadataSchemaUri", + * // "modelReference": "my_modelReference", * // "name": "my_name", - * // "response": {} + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "savedQueries": [], + * // "updateTime": "my_updateTime" * // } * } * @@ -61381,58 +59527,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - importFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues, + patch( + params: Params$Resource$Projects$Locations$Datasets$Patch, options: StreamMethodOptions ): Promise>; - importFeatureValues( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues, + patch( + params?: Params$Resource$Projects$Locations$Datasets$Patch, options?: MethodOptions - ): Promise>; - importFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues, + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Datasets$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - importFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues, + patch( + params: Params$Resource$Projects$Locations$Datasets$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - importFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datasets$Patch, + callback: BodyResponseCallback ): void; - importFeatureValues( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - importFeatureValues( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues; + {}) as Params$Resource$Projects$Locations$Datasets$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues; + params = {} as Params$Resource$Projects$Locations$Datasets$Patch; options = {}; } @@ -61445,32 +59590,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+entityType}:importFeatureValues').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['entityType'], - pathParams: ['entityType'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists EntityTypes in a given Featurestore. + * Searches DataItems in a Dataset. * @example * ```js * // Before running the sample: @@ -61499,27 +59643,41 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.list({ - * // Lists the EntityTypes that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> EntityTypes having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any EntityType which has a label with 'env' as the key. - * filter: 'placeholder-value', - * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `entity_type_id` * `create_time` * `update_time` - * orderBy: 'placeholder-value', - * // The maximum number of EntityTypes to return. The service may return fewer than this value. If unspecified, at most 1000 EntityTypes will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // A page token, received from a previous FeaturestoreService.ListEntityTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListEntityTypes must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Featurestore to list EntityTypes. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` - * parent: - * 'projects/my-project/locations/my-location/featurestores/my-featurestore', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', - * }); + * const res = await aiplatform.projects.locations.datasets.searchDataItems({ + * // An expression that specifies what Annotations will be returned per DataItem. Annotations satisfied either of the conditions will be returned. * `annotation_spec_id` - for = or !=. Must specify `saved_query_id=` - saved query id that annotations should belong to. + * annotationFilters: 'placeholder-value', + * // An expression for filtering the Annotations that will be returned per DataItem. * `annotation_spec_id` - for = or !=. + * annotationsFilter: 'placeholder-value', + * // If set, only up to this many of Annotations will be returned per DataItemView. The maximum value is 1000. If not set, the maximum value will be used. + * annotationsLimit: 'placeholder-value', + * // An expression for filtering the DataItem that will be returned. * `data_item_id` - for = or !=. * `labeled` - for = or !=. * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that have at least one annotation with annotation_spec_id = `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob. For example: * `data_item=1` * `has_annotation(5)` + * dataItemFilter: 'placeholder-value', + * // The resource name of a DataLabelingJob. Format: `projects/{project\}/locations/{location\}/dataLabelingJobs/{data_labeling_job\}` If this field is set, all of the search will be done in the context of this DataLabelingJob. + * dataLabelingJob: 'placeholder-value', + * // Required. The resource name of the Dataset from which to search DataItems. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + * dataset: 'projects/my-project/locations/my-location/datasets/my-dataset', + * // Mask specifying which fields of DataItemView to read. + * fieldMask: 'placeholder-value', + * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. + * orderBy: 'placeholder-value', + * // A comma-separated list of annotation fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Must also specify saved_query. + * 'orderByAnnotation.orderBy': 'placeholder-value', + * // Required. Saved query of the Annotation. Only Annotations belong to this saved query will be considered for ordering. + * 'orderByAnnotation.savedQuery': 'placeholder-value', + * // A comma-separated list of data item fields to order by, sorted in ascending order. Use "desc" after a field name for descending. + * orderByDataItem: 'placeholder-value', + * // Requested page size. Server may return fewer results than requested. Default and maximum page size is 100. + * pageSize: 'placeholder-value', + * // A token identifying a page of results for the server to return Typically obtained via SearchDataItemsResponse.next_page_token of the previous DatasetService.SearchDataItems call. + * pageToken: 'placeholder-value', + * // The resource name of a SavedQuery(annotation set in UI). Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/savedQueries/{saved_query\}` All of the search will be done in the context of this SavedQuery. + * savedQuery: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "entityTypes": [], + * // "dataItemViews": [], * // "nextPageToken": "my_nextPageToken" * // } * } @@ -61536,62 +59694,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$List, + searchDataItems( + params: Params$Resource$Projects$Locations$Datasets$Searchdataitems, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$List, + searchDataItems( + params?: Params$Resource$Projects$Locations$Datasets$Searchdataitems, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$List, + searchDataItems( + params: Params$Resource$Projects$Locations$Datasets$Searchdataitems, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$List, + searchDataItems( + params: Params$Resource$Projects$Locations$Datasets$Searchdataitems, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$List, - callback: BodyResponseCallback + searchDataItems( + params: Params$Resource$Projects$Locations$Datasets$Searchdataitems, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + searchDataItems( + callback: BodyResponseCallback ): void; - list( + searchDataItems( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Searchdataitems + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$List; + {}) as Params$Resource$Projects$Locations$Datasets$Searchdataitems; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$List; + {} as Params$Resource$Projects$Locations$Datasets$Searchdataitems; options = {}; } @@ -61604,7 +59762,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/entityTypes').replace( + url: (rootUrl + '/v1/{+dataset}:searchDataItems').replace( /([^:]\/)\/+/g, '$1' ), @@ -61614,24 +59772,193 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['dataset'], + pathParams: ['dataset'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + + export interface Params$Resource$Projects$Locations$Datasets$Create + extends StandardParameters { + /** + * Required. The resource name of the Location to create the Dataset in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; /** - * Updates the parameters of a single EntityType. + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Dataset; + } + export interface Params$Resource$Projects$Locations$Datasets$Delete + extends StandardParameters { + /** + * Required. The resource name of the Dataset to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Export + extends StandardParameters { + /** + * Required. The name of the Dataset resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ExportDataRequest; + } + export interface Params$Resource$Projects$Locations$Datasets$Get + extends StandardParameters { + /** + * Required. The name of the Dataset resource. + */ + name?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Import + extends StandardParameters { + /** + * Required. The name of the Dataset resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ImportDataRequest; + } + export interface Params$Resource$Projects$Locations$Datasets$List + extends StandardParameters { + /** + * An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `display_name`: supports = and != * `metadata_schema_uri`: supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. Some examples: * `displayName="myDisplayName"` * `labels.myKey="myValue"` + */ + filter?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` + */ + orderBy?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * Required. The name of the Dataset's parent resource. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Patch + extends StandardParameters { + /** + * Output only. Identifier. The resource name of the Dataset. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + */ + name?: string; + /** + * Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` * `description` * `labels` + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Dataset; + } + export interface Params$Resource$Projects$Locations$Datasets$Searchdataitems + extends StandardParameters { + /** + * An expression that specifies what Annotations will be returned per DataItem. Annotations satisfied either of the conditions will be returned. * `annotation_spec_id` - for = or !=. Must specify `saved_query_id=` - saved query id that annotations should belong to. + */ + annotationFilters?: string[]; + /** + * An expression for filtering the Annotations that will be returned per DataItem. * `annotation_spec_id` - for = or !=. + */ + annotationsFilter?: string; + /** + * If set, only up to this many of Annotations will be returned per DataItemView. The maximum value is 1000. If not set, the maximum value will be used. + */ + annotationsLimit?: number; + /** + * An expression for filtering the DataItem that will be returned. * `data_item_id` - for = or !=. * `labeled` - for = or !=. * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that have at least one annotation with annotation_spec_id = `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob. For example: * `data_item=1` * `has_annotation(5)` + */ + dataItemFilter?: string; + /** + * The resource name of a DataLabelingJob. Format: `projects/{project\}/locations/{location\}/dataLabelingJobs/{data_labeling_job\}` If this field is set, all of the search will be done in the context of this DataLabelingJob. + */ + dataLabelingJob?: string; + /** + * Required. The resource name of the Dataset from which to search DataItems. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + */ + dataset?: string; + /** + * Mask specifying which fields of DataItemView to read. + */ + fieldMask?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. + */ + orderBy?: string; + /** + * A comma-separated list of annotation fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Must also specify saved_query. + */ + 'orderByAnnotation.orderBy'?: string; + /** + * Required. Saved query of the Annotation. Only Annotations belong to this saved query will be considered for ordering. + */ + 'orderByAnnotation.savedQuery'?: string; + /** + * A comma-separated list of data item fields to order by, sorted in ascending order. Use "desc" after a field name for descending. + */ + orderByDataItem?: string; + /** + * Requested page size. Server may return fewer results than requested. Default and maximum page size is 100. + */ + pageSize?: number; + /** + * A token identifying a page of results for the server to return Typically obtained via SearchDataItemsResponse.next_page_token of the previous DatasetService.SearchDataItems call. + */ + pageToken?: string; + /** + * The resource name of a SavedQuery(annotation set in UI). Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/savedQueries/{saved_query\}` All of the search will be done in the context of this SavedQuery. + */ + savedQuery?: string; + } + + export class Resource$Projects$Locations$Datasets$Annotationspecs { + context: APIRequestContext; + operations: Resource$Projects$Locations$Datasets$Annotationspecs$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Datasets$Annotationspecs$Operations( + this.context + ); + } + + /** + * Gets an AnnotationSpec. * @example * ```js * // Before running the sample: @@ -61660,43 +59987,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.patch({ - * // Immutable. Name of the EntityType. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` The last part entity_type is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore. - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', - * // Field mask is used to specify the fields to be overwritten in the EntityType resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `monitoring_config.snapshot_analysis.disabled` * `monitoring_config.snapshot_analysis.monitoring_interval_days` * `monitoring_config.snapshot_analysis.staleness_days` * `monitoring_config.import_features_analysis.state` * `monitoring_config.import_features_analysis.anomaly_detection_baseline` * `monitoring_config.numerical_threshold_config.value` * `monitoring_config.categorical_threshold_config.value` * `offline_storage_ttl_days` - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "etag": "my_etag", - * // "labels": {}, - * // "monitoringConfig": {}, - * // "name": "my_name", - * // "offlineStorageTtlDays": 0, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * const res = await aiplatform.projects.locations.datasets.annotationSpecs.get({ + * // Required. The name of the AnnotationSpec resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/annotationSpecs/{annotation_spec\}` + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/annotationSpecs/my-annotationSpec', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { * // "createTime": "my_createTime", - * // "description": "my_description", + * // "displayName": "my_displayName", * // "etag": "my_etag", - * // "labels": {}, - * // "monitoringConfig": {}, * // "name": "my_name", - * // "offlineStorageTtlDays": 0, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, * // "updateTime": "my_updateTime" * // } * } @@ -61713,62 +60017,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch, + get( + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch, + get( + params?: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - patch( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch, + get( + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch, + get( + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch; + {}) as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch; + {} as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get; options = {}; } @@ -61782,7 +60086,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -61793,19 +60097,38 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get + extends StandardParameters { /** - * Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues. + * Required. The name of the AnnotationSpec resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/annotationSpecs/{annotation_spec\}` + */ + name?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + + export class Resource$Projects$Locations$Datasets$Annotationspecs$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -61835,29 +60158,16 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.readFeatureValues( + * await aiplatform.projects.locations.datasets.annotationSpecs.operations.cancel( * { - * // Required. The resource name of the EntityType for the entity being read. Value format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entityType\}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`. - * entityType: - * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "entityId": "my_entityId", - * // "featureSelector": {} - * // } - * }, + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/annotationSpecs/my-annotationSpec/operations/my-operation', * }, * ); * console.log(res.data); * * // Example response - * // { - * // "entityView": {}, - * // "header": {} - * // } + * // {} * } * * main().catch(e => { @@ -61872,62 +60182,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - readFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues, + cancel( + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel, options: StreamMethodOptions ): Promise>; - readFeatureValues( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues, + cancel( + params?: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - readFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - readFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - readFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - readFeatureValues( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel, + callback: BodyResponseCallback ): void; - readFeatureValues( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues; + {}) as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues; + {} as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel; options = {}; } @@ -61940,34 +60242,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+entityType}:readFeatureValues').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['entityType'], - pathParams: ['entityType'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -61997,27 +60294,16 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.setIamPolicy({ - * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "policy": {} - * // } + * await aiplatform.projects.locations.datasets.annotationSpecs.operations.delete( + * { + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/annotationSpecs/my-annotationSpec/operations/my-operation', * }, - * }); + * ); * console.log(res.data); * * // Example response - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } + * // {} * } * * main().catch(e => { @@ -62032,56 +60318,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy, + delete( + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy, + delete( + params?: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete, + callback: BodyResponseCallback ): void; - setIamPolicy( - callback: BodyResponseCallback - ): void; - setIamPolicy( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy; + {} as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete; options = {}; } @@ -62094,32 +60378,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -62149,28 +60430,21 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.streamingReadFeatureValues( + * await aiplatform.projects.locations.datasets.annotationSpecs.operations.get( * { - * // Required. The resource name of the entities' type. Value format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entityType\}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`. - * entityType: - * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "entityIds": [], - * // "featureSelector": {} - * // } - * }, + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/annotationSpecs/my-annotationSpec/operations/my-operation', * }, * ); * console.log(res.data); * * // Example response * // { - * // "entityView": {}, - * // "header": {} + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -62186,62 +60460,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - streamingReadFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues, + get( + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get, options: StreamMethodOptions ): Promise>; - streamingReadFeatureValues( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues, + get( + params?: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - streamingReadFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - streamingReadFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues, + get( + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - streamingReadFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get, + callback: BodyResponseCallback ): void; - streamingReadFeatureValues( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - streamingReadFeatureValues( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues; + {}) as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues; + {} as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get; options = {}; } @@ -62254,33 +60524,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+entityType}:streamingReadFeatureValues' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['entityType'], - pathParams: ['entityType'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -62310,20 +60576,27 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.testIamPermissions( + * await aiplatform.projects.locations.datasets.annotationSpecs.operations.list( * { - * // The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). - * permissions: 'placeholder-value', - * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/annotationSpecs/my-annotationSpec', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); * * // Example response * // { - * // "permissions": [] + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -62339,62 +60612,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions, + list( + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions, + list( + params?: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions, + list( + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions, + list( + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - testIamPermissions( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions; + {} as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List; options = {}; } @@ -62407,34 +60680,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Writes Feature values of one or more entities of an EntityType. The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -62464,25 +60737,24 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.writeFeatureValues( + * await aiplatform.projects.locations.datasets.annotationSpecs.operations.wait( * { - * // Required. The resource name of the EntityType for the entities being written. Value format: `projects/{project\}/locations/{location\}/featurestores/ {featurestore\}/entityTypes/{entityType\}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`. - * entityType: - * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "payloads": [] - * // } - * }, + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/annotationSpecs/my-annotationSpec/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }, * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -62497,62 +60769,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - writeFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues, + wait( + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait, options: StreamMethodOptions ): Promise>; - writeFeatureValues( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues, + wait( + params?: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - writeFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues, + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - writeFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues, + wait( + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - writeFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait, + callback: BodyResponseCallback ): void; - writeFeatureValues( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - writeFeatureValues( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues; + {}) as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues; + {} as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait; options = {}; } @@ -62565,230 +60833,102 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+entityType}:writeFeatureValues').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['entityType'], - pathParams: ['entityType'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create - extends StandardParameters { - /** - * Required. The ID to use for the EntityType, which will become the final component of the EntityType's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a featurestore. - */ - entityTypeId?: string; - /** - * Required. The resource name of the Featurestore to create EntityTypes. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1EntityType; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete + export interface Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel extends StandardParameters { /** - * If set to true, any Features for this EntityType will also be deleted. (Otherwise, the request will only work if the EntityType has no Features.) - */ - force?: boolean; - /** - * Required. The name of the EntityType to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` + * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues - extends StandardParameters { - /** - * Required. The resource name of the EntityType grouping the Features for which values are being deleted from. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entityType\}` - */ - entityType?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1DeleteFeatureValuesRequest; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues - extends StandardParameters { - /** - * Required. The resource name of the EntityType from which to export Feature values. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` - */ - entityType?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ExportFeatureValuesRequest; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get + export interface Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete extends StandardParameters { /** - * Required. The name of the EntityType resource. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy - extends StandardParameters { - /** - * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues + export interface Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get extends StandardParameters { /** - * Required. The resource name of the EntityType grouping the Features for which values are being imported. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entityType\}` - */ - entityType?: string; - - /** - * Request body metadata + * The name of the operation resource. */ - requestBody?: Schema$GoogleCloudAiplatformV1ImportFeatureValuesRequest; + name?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$List + export interface Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List extends StandardParameters { /** - * Lists the EntityTypes that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> EntityTypes having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any EntityType which has a label with 'env' as the key. + * The standard list filter. */ filter?: string; /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `entity_type_id` * `create_time` * `update_time` + * The name of the operation's parent resource. */ - orderBy?: string; + name?: string; /** - * The maximum number of EntityTypes to return. The service may return fewer than this value. If unspecified, at most 1000 EntityTypes will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. + * The standard list page size. */ pageSize?: number; /** - * A page token, received from a previous FeaturestoreService.ListEntityTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListEntityTypes must match the call that provided the page token. + * The standard list page token. */ pageToken?: string; /** - * Required. The resource name of the Featurestore to list EntityTypes. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - readMask?: string; + returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch + export interface Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait extends StandardParameters { /** - * Immutable. Name of the EntityType. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` The last part entity_type is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore. + * The name of the operation resource to wait on. */ name?: string; /** - * Field mask is used to specify the fields to be overwritten in the EntityType resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `monitoring_config.snapshot_analysis.disabled` * `monitoring_config.snapshot_analysis.monitoring_interval_days` * `monitoring_config.snapshot_analysis.staleness_days` * `monitoring_config.import_features_analysis.state` * `monitoring_config.import_features_analysis.anomaly_detection_baseline` * `monitoring_config.numerical_threshold_config.value` * `monitoring_config.categorical_threshold_config.value` * `offline_storage_ttl_days` - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1EntityType; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues - extends StandardParameters { - /** - * Required. The resource name of the EntityType for the entity being read. Value format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entityType\}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`. - */ - entityType?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ReadFeatureValuesRequest; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues - extends StandardParameters { - /** - * Required. The resource name of the entities' type. Value format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entityType\}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`. - */ - entityType?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions - extends StandardParameters { - /** - * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). - */ - permissions?: string[]; - /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues - extends StandardParameters { - /** - * Required. The resource name of the EntityType for the entities being written. Value format: `projects/{project\}/locations/{location\}/featurestores/ {featurestore\}/entityTypes/{entityType\}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`. - */ - entityType?: string; - - /** - * Request body metadata + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - requestBody?: Schema$GoogleCloudAiplatformV1WriteFeatureValuesRequest; + timeout?: string; } - export class Resource$Projects$Locations$Featurestores$Entitytypes$Features { + export class Resource$Projects$Locations$Datasets$Dataitems { context: APIRequestContext; - operations: Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations; + annotations: Resource$Projects$Locations$Datasets$Dataitems$Annotations; + operations: Resource$Projects$Locations$Datasets$Dataitems$Operations; constructor(context: APIRequestContext) { this.context = context; + this.annotations = + new Resource$Projects$Locations$Datasets$Dataitems$Annotations( + this.context + ); this.operations = - new Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations( + new Resource$Projects$Locations$Datasets$Dataitems$Operations( this.context ); } /** - * Creates a batch of Features in a given EntityType. + * Lists DataItems in a Dataset. * @example * ```js * // Before running the sample: @@ -62817,31 +60957,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.features.batchCreate( - * { - * // Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` - * parent: - * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "requests": [] - * // } - * }, - * }, - * ); + * const res = await aiplatform.projects.locations.datasets.dataItems.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. + * orderBy: 'placeholder-value', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Dataset to list DataItems from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "dataItems": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -62857,58 +60992,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchCreate( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate, + list( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$List, options: StreamMethodOptions ): Promise>; - batchCreate( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate, + list( + params?: Params$Resource$Projects$Locations$Datasets$Dataitems$List, options?: MethodOptions - ): Promise>; - batchCreate( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate, + list( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$List, + callback: BodyResponseCallback ): void; - batchCreate( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - batchCreate( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Dataitems$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate; + {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate; + {} as Params$Resource$Projects$Locations$Datasets$Dataitems$List; options = {}; } @@ -62921,11 +61060,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/features:batchCreate').replace( + url: (rootUrl + '/v1/{+parent}/dataItems').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -62936,17 +61075,59 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Datasets$Dataitems$List + extends StandardParameters { /** - * Creates a new Feature in a given EntityType. + * The standard list filter. + */ + filter?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. + */ + orderBy?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * Required. The resource name of the Dataset to list DataItems from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + + export class Resource$Projects$Locations$Datasets$Dataitems$Annotations { + context: APIRequestContext; + operations: Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations( + this.context + ); + } + + /** + * Lists Annotations belongs to a dataitem. * @example * ```js * // Before running the sample: @@ -62976,42 +61157,27 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.features.create( - * { - * // Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup. - * featureId: 'placeholder-value', - * // Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` - * parent: - * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "disableMonitoring": false, - * // "etag": "my_etag", - * // "labels": {}, - * // "monitoringStatsAnomalies": [], - * // "name": "my_name", - * // "pointOfContact": "my_pointOfContact", - * // "updateTime": "my_updateTime", - * // "valueType": "my_valueType", - * // "versionColumnName": "my_versionColumnName" - * // } - * }, - * }, - * ); + * await aiplatform.projects.locations.datasets.dataItems.annotations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. + * orderBy: 'placeholder-value', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // Required. The resource name of the DataItem to list Annotations from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/dataItems/{data_item\}` + * parent: + * 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "annotations": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -63027,58 +61193,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create, + list( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create, + list( + params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create, + list( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - create( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create; + {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create; + {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List; options = {}; } @@ -63091,11 +61261,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/features').replace( + url: (rootUrl + '/v1/{+parent}/annotations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -63106,17 +61276,54 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List + extends StandardParameters { /** - * Deletes a single Feature. + * The standard list filter. + */ + filter?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. + */ + orderBy?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * Required. The resource name of the DataItem to list Annotations from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/dataItems/{data_item\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + + export class Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -63146,22 +61353,16 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.features.delete( + * await aiplatform.projects.locations.datasets.dataItems.annotations.operations.cancel( * { - * // Required. The name of the Features to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/features/my-feature', + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem/annotations/my-annotation/operations/my-operation', * }, * ); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -63176,58 +61377,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete, + cancel( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete, + cancel( + params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel, + callback: BodyResponseCallback ): void; - delete( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete; + {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete; + {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel; options = {}; } @@ -63240,8 +61437,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -63252,17 +61449,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets details of a single Feature. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -63292,26 +61489,16 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.features.get({ - * // Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/features/my-feature', - * }); + * await aiplatform.projects.locations.datasets.dataItems.annotations.operations.delete( + * { + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem/annotations/my-annotation/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "disableMonitoring": false, - * // "etag": "my_etag", - * // "labels": {}, - * // "monitoringStatsAnomalies": [], - * // "name": "my_name", - * // "pointOfContact": "my_pointOfContact", - * // "updateTime": "my_updateTime", - * // "valueType": "my_valueType", - * // "versionColumnName": "my_versionColumnName" - * // } + * // {} * } * * main().catch(e => { @@ -63326,58 +61513,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get, + delete( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get, + delete( + params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete, + callback: BodyResponseCallback ): void; - get( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get; + {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get; + {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete; options = {}; } @@ -63391,7 +61574,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -63402,19 +61585,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists Features in a given EntityType. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -63444,31 +61625,21 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.features.list( + * await aiplatform.projects.locations.datasets.dataItems.annotations.operations.get( * { - * // Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --\> Features whose type is DOUBLE. * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any Feature which has a label with 'env' as the key. - * filter: 'placeholder-value', - * // Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats. - * latestStatsCount: 'placeholder-value', - * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time` - * orderBy: 'placeholder-value', - * // The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` - * parent: - * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem/annotations/my-annotation/operations/my-operation', * }, * ); * console.log(res.data); * * // Example response * // { - * // "features": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -63484,62 +61655,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List, + get( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List, + get( + params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List, + get( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List; + {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List; + {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get; options = {}; } @@ -63552,34 +61719,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/features').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates the parameters of a single Feature. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -63609,47 +61771,27 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.features.patch( + * await aiplatform.projects.locations.datasets.dataItems.annotations.operations.list( * { - * // Immutable. Name of the Feature. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type. - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/features/my-feature', - * // Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore) - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "disableMonitoring": false, - * // "etag": "my_etag", - * // "labels": {}, - * // "monitoringStatsAnomalies": [], - * // "name": "my_name", - * // "pointOfContact": "my_pointOfContact", - * // "updateTime": "my_updateTime", - * // "valueType": "my_valueType", - * // "versionColumnName": "my_versionColumnName" - * // } - * }, + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem/annotations/my-annotation', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "disableMonitoring": false, - * // "etag": "my_etag", - * // "labels": {}, - * // "monitoringStatsAnomalies": [], - * // "name": "my_name", - * // "pointOfContact": "my_pointOfContact", - * // "updateTime": "my_updateTime", - * // "valueType": "my_valueType", - * // "versionColumnName": "my_versionColumnName" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -63665,58 +61807,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch, + list( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch, + list( + params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch, + list( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - patch( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch; + {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch; + {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List; options = {}; } @@ -63729,8 +61875,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -63741,109 +61890,223 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate - extends StandardParameters { /** - * Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.datasets.dataItems.annotations.operations.wait( + * { + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem/annotations/my-annotation/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. */ - parent?: string; + wait( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait, + options: StreamMethodOptions + ): Promise>; + wait( + params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait, + options?: MethodOptions + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1BatchCreateFeaturesRequest; + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create - extends StandardParameters { - /** - * Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup. - */ - featureId?: string; - /** - * Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` - */ - parent?: string; + export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel + extends StandardParameters { /** - * Request body metadata + * The name of the operation resource to be cancelled. */ - requestBody?: Schema$GoogleCloudAiplatformV1Feature; + name?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete + export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete extends StandardParameters { /** - * Required. The name of the Features to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get + export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get extends StandardParameters { /** - * Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List + export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List extends StandardParameters { /** - * Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --\> Features whose type is DOUBLE. * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any Feature which has a label with 'env' as the key. + * The standard list filter. */ filter?: string; /** - * Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats. - */ - latestStatsCount?: number; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time` + * The name of the operation's parent resource. */ - orderBy?: string; + name?: string; /** - * The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. + * The standard list page size. */ pageSize?: number; /** - * A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token. + * The standard list page token. */ pageToken?: string; /** - * Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - readMask?: string; + returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch + export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait extends StandardParameters { /** - * Immutable. Name of the Feature. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type. + * The name of the operation resource to wait on. */ name?: string; /** - * Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore) - */ - updateMask?: string; - - /** - * Request body metadata + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - requestBody?: Schema$GoogleCloudAiplatformV1Feature; + timeout?: string; } - export class Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations { + export class Resource$Projects$Locations$Datasets$Dataitems$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -63880,12 +62143,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.features.operations.cancel( - * { - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/features/my-feature/operations/my-operation', - * }, - * ); + * await aiplatform.projects.locations.datasets.dataItems.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -63905,31 +62166,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel + | Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -63945,13 +62206,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel; options = {}; } @@ -64016,12 +62277,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.features.operations.delete( - * { - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/features/my-feature/operations/my-operation', - * }, - * ); + * await aiplatform.projects.locations.datasets.dataItems.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -64041,31 +62300,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete, + params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete + | Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -64081,13 +62340,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete; + {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete; options = {}; } @@ -64152,12 +62411,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.features.operations.get( - * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/features/my-feature/operations/my-operation', - * }, - * ); + * await aiplatform.projects.locations.datasets.dataItems.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -64183,27 +62440,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get, + params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -64211,7 +62468,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get + | Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -64227,13 +62484,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get; + {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get; + {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get; options = {}; } @@ -64298,20 +62555,18 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.features.operations.list( - * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/features/my-feature', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }, - * ); + * await aiplatform.projects.locations.datasets.dataItems.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -64335,29 +62590,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List, + params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List, callback: BodyResponseCallback ): void; list( @@ -64365,7 +62620,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List + | Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -64383,13 +62638,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List; + {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List; + {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List; options = {}; } @@ -64459,14 +62714,12 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.features.operations.wait( - * { - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/features/my-feature/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }, - * ); + * await aiplatform.projects.locations.datasets.dataItems.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -64492,27 +62745,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait, + params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -64520,7 +62773,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait + | Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -64536,13 +62789,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait; + {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait; options = {}; } @@ -64577,28 +62830,28 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel + export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete + export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get + export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List + export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List extends StandardParameters { /** * The standard list filter. @@ -64621,7 +62874,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait + export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -64633,14 +62886,14 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Featurestores$Entitytypes$Operations { + export class Resource$Projects$Locations$Datasets$Datasetversions { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Create a version from a Dataset. * @example * ```js * // Before running the sample: @@ -64670,16 +62923,37 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.operations.cancel( - * { - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/operations/my-operation', + * await aiplatform.projects.locations.datasets.datasetVersions.create({ + * // Required. The name of the Dataset resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bigQueryDatasetName": "my_bigQueryDatasetName", + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "metadata": {}, + * // "modelReference": "my_modelReference", + * // "name": "my_name", + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -64694,54 +62968,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel, + create( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Create, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel, + create( + params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$Create, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Create, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Datasetversions$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$Create; options = {}; } @@ -64754,29 +63032,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/datasetVersions').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Deletes a Dataset version. * @example * ```js * // Before running the sample: @@ -64806,16 +63087,20 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.operations.delete( - * { - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/operations/my-operation', - * }, - * ); + * await aiplatform.projects.locations.datasets.datasetVersions.delete({ + * // Required. The resource name of the Dataset version to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/datasetVersions/my-datasetVersion', + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -64831,53 +63116,57 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete, + params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete, options?: MethodOptions - ): Promise>; + ): Promise>; delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete; + {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete; options = {}; } @@ -64902,17 +63191,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Gets a Dataset version. * @example * ```js * // Before running the sample: @@ -64941,22 +63230,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.operations.get( - * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/operations/my-operation', - * }, - * ); + * const res = await aiplatform.projects.locations.datasets.datasetVersions.get({ + * // Required. The resource name of the Dataset version to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/datasetVersions/my-datasetVersion', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, + * // "bigQueryDatasetName": "my_bigQueryDatasetName", + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "etag": "my_etag", * // "metadata": {}, + * // "modelReference": "my_modelReference", * // "name": "my_name", - * // "response": {} + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" * // } * } * @@ -64973,57 +63266,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get, + params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$Get, options?: MethodOptions - ): Promise>; + ): Promise< + GaxiosResponseWithHTTP2 + >; get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Datasetversions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get; + {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get; + {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$Get; options = {}; } @@ -65048,17 +63345,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Lists DatasetVersions in a Dataset. * @example * ```js * // Before running the sample: @@ -65087,28 +63386,28 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.operations.list( - * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.projects.locations.datasets.datasetVersions.list( + * { + * // Optional. The standard list filter. + * filter: 'placeholder-value', + * // Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. + * orderBy: 'placeholder-value', + * // Optional. The standard list page size. + * pageSize: 'placeholder-value', + * // Optional. The standard list page token. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset', + * // Optional. Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "datasetVersions": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -65125,61 +63424,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List, + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List, + params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List, + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List, + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Datasetversions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List; + {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List; + {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$List; options = {}; } @@ -65192,7 +63491,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+parent}/datasetVersions').replace( /([^:]\/)\/+/g, '$1' ), @@ -65202,24 +63501,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Updates a DatasetVersion. * @example * ```js * // Before running the sample: @@ -65249,14 +63548,184 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.operations.wait( - * { - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', + * await aiplatform.projects.locations.datasets.datasetVersions.patch({ + * // Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/datasetVersions/my-datasetVersion', + * // Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bigQueryDatasetName": "my_bigQueryDatasetName", + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "metadata": {}, + * // "modelReference": "my_modelReference", + * // "name": "my_name", + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" + * // } * }, - * ); + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "bigQueryDatasetName": "my_bigQueryDatasetName", + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "metadata": {}, + * // "modelReference": "my_modelReference", + * // "name": "my_name", + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$Patch, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + patch( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Datasetversions$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Restores a dataset version. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.datasets.datasetVersions.restore({ + * // Required. The name of the DatasetVersion resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/datasetVersions/my-datasetVersion', + * }); * console.log(res.data); * * // Example response @@ -65281,36 +63750,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait, + restore( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait, + restore( + params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore, options?: MethodOptions ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait, + restore( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait, + restore( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait, + restore( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore, callback: BodyResponseCallback ): void; - wait( + restore( callback: BodyResponseCallback ): void; - wait( + restore( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait + | Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -65326,13 +63795,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait; + {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore; options = {}; } @@ -65345,8 +63814,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}:restore').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -65367,63 +63839,88 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel + export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$Create extends StandardParameters { /** - * The name of the operation resource to be cancelled. + * Required. The name of the Dataset resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` */ - name?: string; + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1DatasetVersion; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete + export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete extends StandardParameters { /** - * The name of the operation resource to be deleted. + * Required. The resource name of the Dataset version to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get + export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$Get extends StandardParameters { /** - * The name of the operation resource. + * Required. The resource name of the Dataset version to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` */ name?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List + export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$List extends StandardParameters { /** - * The standard list filter. + * Optional. The standard list filter. */ filter?: string; /** - * The name of the operation's parent resource. + * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. */ - name?: string; + orderBy?: string; /** - * The standard list page size. + * Optional. The standard list page size. */ pageSize?: number; /** - * The standard list page token. + * Optional. The standard list page token. */ pageToken?: string; /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` */ - returnPartialSuccess?: boolean; + parent?: string; + /** + * Optional. Mask specifying which fields to read. + */ + readMask?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait + export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$Patch extends StandardParameters { /** - * The name of the operation resource to wait on. + * Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` */ name?: string; /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` */ - timeout?: string; + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1DatasetVersion; + } + export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore + extends StandardParameters { + /** + * Required. The name of the DatasetVersion resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` + */ + name?: string; } - export class Resource$Projects$Locations$Featurestores$Operations { + export class Resource$Projects$Locations$Datasets$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -65459,11 +63956,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featurestores.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.datasets.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -65483,31 +63979,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datasets$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Featurestores$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Datasets$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datasets$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datasets$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datasets$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Operations$Cancel + | Params$Resource$Projects$Locations$Datasets$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -65523,13 +64019,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Datasets$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Datasets$Operations$Cancel; options = {}; } @@ -65593,11 +64089,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featurestores.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.datasets.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -65617,31 +64112,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Featurestores$Operations$Delete, + params?: Params$Resource$Projects$Locations$Datasets$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Operations$Delete + | Params$Resource$Projects$Locations$Datasets$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -65657,13 +64152,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Datasets$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Operations$Delete; + {} as Params$Resource$Projects$Locations$Datasets$Operations$Delete; options = {}; } @@ -65727,9 +64222,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featurestores.operations.get({ + * const res = await aiplatform.projects.locations.datasets.operations.get({ * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/operations/my-operation', + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/operations/my-operation', * }); * console.log(res.data); * @@ -65756,27 +64251,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Featurestores$Operations$Get, + params?: Params$Resource$Projects$Locations$Datasets$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -65784,7 +64279,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Operations$Get + | Params$Resource$Projects$Locations$Datasets$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -65800,13 +64295,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Operations$Get; + {}) as Params$Resource$Projects$Locations$Datasets$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Operations$Get; + {} as Params$Resource$Projects$Locations$Datasets$Operations$Get; options = {}; } @@ -65870,20 +64365,18 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featurestores.operations.list( - * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.projects.locations.datasets.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -65907,29 +64400,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Featurestores$Operations$List, + params: Params$Resource$Projects$Locations$Datasets$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Featurestores$Operations$List, + params?: Params$Resource$Projects$Locations$Datasets$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Featurestores$Operations$List, + params: Params$Resource$Projects$Locations$Datasets$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featurestores$Operations$List, + params: Params$Resource$Projects$Locations$Datasets$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featurestores$Operations$List, + params: Params$Resource$Projects$Locations$Datasets$Operations$List, callback: BodyResponseCallback ): void; list( @@ -65937,7 +64430,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Operations$List + | Params$Resource$Projects$Locations$Datasets$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -65955,13 +64448,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Operations$List; + {}) as Params$Resource$Projects$Locations$Datasets$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Operations$List; + {} as Params$Resource$Projects$Locations$Datasets$Operations$List; options = {}; } @@ -66030,14 +64523,12 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featurestores.operations.wait( - * { - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.projects.locations.datasets.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -66063,27 +64554,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Wait, + params: Params$Resource$Projects$Locations$Datasets$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Featurestores$Operations$Wait, + params?: Params$Resource$Projects$Locations$Datasets$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Wait, + params: Params$Resource$Projects$Locations$Datasets$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Wait, + params: Params$Resource$Projects$Locations$Datasets$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Wait, + params: Params$Resource$Projects$Locations$Datasets$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -66091,7 +64582,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Operations$Wait + | Params$Resource$Projects$Locations$Datasets$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -66107,13 +64598,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Datasets$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Operations$Wait; + {} as Params$Resource$Projects$Locations$Datasets$Operations$Wait; options = {}; } @@ -66148,28 +64639,28 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Featurestores$Operations$Cancel + export interface Params$Resource$Projects$Locations$Datasets$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Operations$Delete + export interface Params$Resource$Projects$Locations$Datasets$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Operations$Get + export interface Params$Resource$Projects$Locations$Datasets$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Operations$List + export interface Params$Resource$Projects$Locations$Datasets$Operations$List extends StandardParameters { /** * The standard list filter. @@ -66192,7 +64683,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Featurestores$Operations$Wait + export interface Params$Resource$Projects$Locations$Datasets$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -66204,159 +64695,19 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Hyperparametertuningjobs { + export class Resource$Projects$Locations$Datasets$Savedqueries { context: APIRequestContext; - operations: Resource$Projects$Locations$Hyperparametertuningjobs$Operations; + operations: Resource$Projects$Locations$Datasets$Savedqueries$Operations; constructor(context: APIRequestContext) { this.context = context; this.operations = - new Resource$Projects$Locations$Hyperparametertuningjobs$Operations( + new Resource$Projects$Locations$Datasets$Savedqueries$Operations( this.context ); } /** - * Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetHyperparameterTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a HyperparameterTuningJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and HyperparameterTuningJob.state is set to `CANCELLED`. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const aiplatform = google.aiplatform('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await aiplatform.projects.locations.hyperparameterTuningJobs.cancel({ - * // Required. The name of the HyperparameterTuningJob to cancel. Format: `projects/{project\}/locations/{location\}/hyperparameterTuningJobs/{hyperparameter_tuning_job\}` - * name: 'projects/my-project/locations/my-location/hyperparameterTuningJobs/my-hyperparameterTuningJob', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }); - * console.log(res.data); - * - * // Example response - * // {} - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - cancel( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel, - options: StreamMethodOptions - ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel, - options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - cancel( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - cancel( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel, - callback: BodyResponseCallback - ): void; - cancel(callback: BodyResponseCallback): void; - cancel( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Creates a HyperparameterTuningJob + * Deletes a SavedQuery. * @example * ```js * // Before running the sample: @@ -66385,202 +64736,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.hyperparameterTuningJobs.create({ - * // Required. The resource name of the Location to create the HyperparameterTuningJob in. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", - * // "error": {}, - * // "labels": {}, - * // "maxFailedTrialCount": 0, - * // "maxTrialCount": 0, - * // "name": "my_name", - * // "parallelTrialCount": 0, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "studySpec": {}, - * // "trialJobSpec": {}, - * // "trials": [], - * // "updateTime": "my_updateTime" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", - * // "error": {}, - * // "labels": {}, - * // "maxFailedTrialCount": 0, - * // "maxTrialCount": 0, - * // "name": "my_name", - * // "parallelTrialCount": 0, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "studySpec": {}, - * // "trialJobSpec": {}, - * // "trials": [], - * // "updateTime": "my_updateTime" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - create( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create, - options: StreamMethodOptions - ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - create( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create, - callback: BodyResponseCallback - ): void; - create( - callback: BodyResponseCallback - ): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/hyperparameterTuningJobs').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Deletes a HyperparameterTuningJob. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const aiplatform = google.aiplatform('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * const res = await aiplatform.projects.locations.datasets.savedQueries.delete({ + * // Required. The resource name of the SavedQuery to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/savedQueries/{saved_query\}` + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/savedQueries/my-savedQuerie', * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await aiplatform.projects.locations.hyperparameterTuningJobs.delete({ - * // Required. The name of the HyperparameterTuningJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/hyperparameterTuningJobs/{hyperparameter_tuning_job\}` - * name: 'projects/my-project/locations/my-location/hyperparameterTuningJobs/my-hyperparameterTuningJob', - * }); * console.log(res.data); * * // Example response @@ -66606,27 +64765,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete, + params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete, callback: BodyResponseCallback ): void; delete( @@ -66634,7 +64793,7 @@ export namespace aiplatform_v1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete + | Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -66650,13 +64809,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete; + {}) as Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete; + {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete; options = {}; } @@ -66691,7 +64850,7 @@ export namespace aiplatform_v1 { } /** - * Gets a HyperparameterTuningJob + * Lists SavedQueries in a Dataset. * @example * ```js * // Before running the sample: @@ -66720,188 +64879,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.hyperparameterTuningJobs.get({ - * // Required. The name of the HyperparameterTuningJob resource. Format: `projects/{project\}/locations/{location\}/hyperparameterTuningJobs/{hyperparameter_tuning_job\}` - * name: 'projects/my-project/locations/my-location/hyperparameterTuningJobs/my-hyperparameterTuningJob', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", - * // "error": {}, - * // "labels": {}, - * // "maxFailedTrialCount": 0, - * // "maxTrialCount": 0, - * // "name": "my_name", - * // "parallelTrialCount": 0, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "studySpec": {}, - * // "trialJobSpec": {}, - * // "trials": [], - * // "updateTime": "my_updateTime" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - get( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get, - callback: BodyResponseCallback - ): void; - get( - callback: BodyResponseCallback - ): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Lists HyperparameterTuningJobs in a Location. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const aiplatform = google.aiplatform('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * const res = await aiplatform.projects.locations.datasets.savedQueries.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. + * orderBy: 'placeholder-value', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Dataset to list SavedQueries from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await aiplatform.projects.locations.hyperparameterTuningJobs.list( - * { - * // The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` - * filter: 'placeholder-value', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. Typically obtained via ListHyperparameterTuningJobsResponse.next_page_token of the previous JobService.ListHyperparameterTuningJobs call. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list the HyperparameterTuningJobs from. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', - * }, - * ); * console.log(res.data); * * // Example response * // { - * // "hyperparameterTuningJobs": [], - * // "nextPageToken": "my_nextPageToken" + * // "nextPageToken": "my_nextPageToken", + * // "savedQueries": [] * // } * } * @@ -66918,61 +64915,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$List, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$List, + params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$List, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$List, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Hyperparametertuningjobs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Savedqueries$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$List; + {}) as Params$Resource$Projects$Locations$Datasets$Savedqueries$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$List; + {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$List; options = {}; } @@ -66985,7 +64982,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/hyperparameterTuningJobs').replace( + url: (rootUrl + '/v1/{+parent}/savedQueries').replace( /([^:]\/)\/+/g, '$1' ), @@ -67000,72 +64997,45 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel - extends StandardParameters { - /** - * Required. The name of the HyperparameterTuningJob to cancel. Format: `projects/{project\}/locations/{location\}/hyperparameterTuningJobs/{hyperparameter_tuning_job\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest; - } - export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create - extends StandardParameters { - /** - * Required. The resource name of the Location to create the HyperparameterTuningJob in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1HyperparameterTuningJob; - } - export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete + export interface Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete extends StandardParameters { /** - * Required. The name of the HyperparameterTuningJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/hyperparameterTuningJobs/{hyperparameter_tuning_job\}` + * Required. The resource name of the SavedQuery to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/savedQueries/{saved_query\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get + export interface Params$Resource$Projects$Locations$Datasets$Savedqueries$List extends StandardParameters { /** - * Required. The name of the HyperparameterTuningJob resource. Format: `projects/{project\}/locations/{location\}/hyperparameterTuningJobs/{hyperparameter_tuning_job\}` + * The standard list filter. */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$List - extends StandardParameters { + filter?: string; /** - * The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. */ - filter?: string; + orderBy?: string; /** * The standard list page size. */ pageSize?: number; /** - * The standard list page token. Typically obtained via ListHyperparameterTuningJobsResponse.next_page_token of the previous JobService.ListHyperparameterTuningJobs call. + * The standard list page token. */ pageToken?: string; /** - * Required. The resource name of the Location to list the HyperparameterTuningJobs from. Format: `projects/{project\}/locations/{location\}` + * Required. The resource name of the Dataset to list SavedQueries from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` */ parent?: string; /** @@ -67074,7 +65044,7 @@ export namespace aiplatform_v1 { readMask?: string; } - export class Resource$Projects$Locations$Hyperparametertuningjobs$Operations { + export class Resource$Projects$Locations$Datasets$Savedqueries$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -67111,10 +65081,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.hyperparameterTuningJobs.operations.cancel( + * await aiplatform.projects.locations.datasets.savedQueries.operations.cancel( * { * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/hyperparameterTuningJobs/my-hyperparameterTuningJob/operations/my-operation', + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/savedQueries/my-savedQuerie/operations/my-operation', * }, * ); * console.log(res.data); @@ -67136,31 +65106,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel + | Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -67176,13 +65146,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel; options = {}; } @@ -67247,10 +65217,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.hyperparameterTuningJobs.operations.delete( + * await aiplatform.projects.locations.datasets.savedQueries.operations.delete( * { * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/hyperparameterTuningJobs/my-hyperparameterTuningJob/operations/my-operation', + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/savedQueries/my-savedQuerie/operations/my-operation', * }, * ); * console.log(res.data); @@ -67272,31 +65242,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete, + params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete + | Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -67312,13 +65282,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete; + {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete; options = {}; } @@ -67383,12 +65353,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.hyperparameterTuningJobs.operations.get( - * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/hyperparameterTuningJobs/my-hyperparameterTuningJob/operations/my-operation', - * }, - * ); + * await aiplatform.projects.locations.datasets.savedQueries.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/savedQueries/my-savedQuerie/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -67414,27 +65382,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get, + params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -67442,7 +65410,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get + | Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -67458,13 +65426,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get; + {}) as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get; + {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get; options = {}; } @@ -67529,20 +65497,18 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.hyperparameterTuningJobs.operations.list( - * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/hyperparameterTuningJobs/my-hyperparameterTuningJob', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }, - * ); + * await aiplatform.projects.locations.datasets.savedQueries.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/savedQueries/my-savedQuerie', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -67566,29 +65532,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List, + params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List, callback: BodyResponseCallback ): void; list( @@ -67596,7 +65562,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List + | Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -67614,13 +65580,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List; + {}) as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List; + {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List; options = {}; } @@ -67690,14 +65656,12 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.hyperparameterTuningJobs.operations.wait( - * { - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/hyperparameterTuningJobs/my-hyperparameterTuningJob/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }, - * ); + * await aiplatform.projects.locations.datasets.savedQueries.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/savedQueries/my-savedQuerie/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -67723,27 +65687,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait, + params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait, + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -67751,7 +65715,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait + | Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -67767,13 +65731,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait; + {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait; options = {}; } @@ -67808,28 +65772,28 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel + export interface Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete + export interface Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get + export interface Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List + export interface Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List extends StandardParameters { /** * The standard list filter. @@ -67852,7 +65816,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait + export interface Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -67864,17 +65828,19 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Indexendpoints { + export class Resource$Projects$Locations$Deploymentresourcepools { context: APIRequestContext; - operations: Resource$Projects$Locations$Indexendpoints$Operations; + operations: Resource$Projects$Locations$Deploymentresourcepools$Operations; constructor(context: APIRequestContext) { this.context = context; this.operations = - new Resource$Projects$Locations$Indexendpoints$Operations(this.context); + new Resource$Projects$Locations$Deploymentresourcepools$Operations( + this.context + ); } /** - * Creates an IndexEndpoint. + * Create a DeploymentResourcePool. * @example * ```js * // Before running the sample: @@ -67903,33 +65869,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexEndpoints.create({ - * // Required. The resource name of the Location to create the IndexEndpoint in. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * const res = + * await aiplatform.projects.locations.deploymentResourcePools.create({ + * // Required. The parent location resource where this DeploymentResourcePool will be created. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "deployedIndexes": [], - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "enablePrivateServiceConnect": false, - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "network": "my_network", - * // "privateServiceConnectConfig": {}, - * // "publicEndpointDomainName": "my_publicEndpointDomainName", - * // "publicEndpointEnabled": false, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "deploymentResourcePool": {}, + * // "deploymentResourcePoolId": "my_deploymentResourcePoolId" + * // } + * }, + * }); * console.log(res.data); * * // Example response @@ -67955,27 +65908,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Indexendpoints$Create, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Create, options: StreamMethodOptions ): Promise>; create( - params?: Params$Resource$Projects$Locations$Indexendpoints$Create, + params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Create, options?: MethodOptions ): Promise>; create( - params: Params$Resource$Projects$Locations$Indexendpoints$Create, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Indexendpoints$Create, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Indexendpoints$Create, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Create, callback: BodyResponseCallback ): void; create( @@ -67983,7 +65936,7 @@ export namespace aiplatform_v1 { ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Create + | Params$Resource$Projects$Locations$Deploymentresourcepools$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -67999,12 +65952,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Create; + {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Indexendpoints$Create; + params = + {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Create; options = {}; } @@ -68017,7 +65971,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/indexEndpoints').replace( + url: (rootUrl + '/v1/{+parent}/deploymentResourcePools').replace( /([^:]\/)\/+/g, '$1' ), @@ -68042,7 +65996,7 @@ export namespace aiplatform_v1 { } /** - * Deletes an IndexEndpoint. + * Delete a DeploymentResourcePool. * @example * ```js * // Before running the sample: @@ -68071,10 +66025,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexEndpoints.delete({ - * // Required. The name of the IndexEndpoint resource to be deleted. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` - * name: 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint', - * }); + * const res = + * await aiplatform.projects.locations.deploymentResourcePools.delete({ + * // Required. The name of the DeploymentResourcePool to delete. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` + * name: 'projects/my-project/locations/my-location/deploymentResourcePools/my-deploymentResourcePool', + * }); * console.log(res.data); * * // Example response @@ -68100,27 +66055,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Indexendpoints$Delete, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Indexendpoints$Delete, + params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Indexendpoints$Delete, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Indexendpoints$Delete, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Indexendpoints$Delete, + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Delete, callback: BodyResponseCallback ): void; delete( @@ -68128,7 +66083,7 @@ export namespace aiplatform_v1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Delete + | Params$Resource$Projects$Locations$Deploymentresourcepools$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -68144,12 +66099,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Delete; + {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Indexendpoints$Delete; + params = + {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Delete; options = {}; } @@ -68184,7 +66140,7 @@ export namespace aiplatform_v1 { } /** - * Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. + * Get a DeploymentResourcePool. * @example * ```js * // Before running the sample: @@ -68213,28 +66169,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexEndpoints.deployIndex({ - * // Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` - * indexEndpoint: - * 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "deployedIndex": {} - * // } - * }, + * const res = await aiplatform.projects.locations.deploymentResourcePools.get({ + * // Required. The name of the DeploymentResourcePool to retrieve. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` + * name: 'projects/my-project/locations/my-location/deploymentResourcePools/my-deploymentResourcePool', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "createTime": "my_createTime", + * // "dedicatedResources": {}, + * // "disableContainerLogging": false, + * // "encryptionSpec": {}, * // "name": "my_name", - * // "response": {} + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "serviceAccount": "my_serviceAccount" * // } * } * @@ -68250,58 +66200,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - deployIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Deployindex, + get( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Get, options: StreamMethodOptions ): Promise>; - deployIndex( - params?: Params$Resource$Projects$Locations$Indexendpoints$Deployindex, + get( + params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Get, options?: MethodOptions - ): Promise>; - deployIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Deployindex, + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deployIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Deployindex, + get( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - deployIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Deployindex, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Get, + callback: BodyResponseCallback ): void; - deployIndex( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - deployIndex( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Deployindex - | BodyResponseCallback + | Params$Resource$Projects$Locations$Deploymentresourcepools$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Deployindex; + {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexendpoints$Deployindex; + {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Get; options = {}; } @@ -68314,32 +66268,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+indexEndpoint}:deployIndex').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['indexEndpoint'], - pathParams: ['indexEndpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Finds the nearest neighbors of each vector within the request. + * List DeploymentResourcePools in a location. * @example * ```js * // Before running the sample: @@ -68368,26 +66321,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexEndpoints.findNeighbors({ - * // Required. The name of the index endpoint. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` - * indexEndpoint: - * 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "deployedIndexId": "my_deployedIndexId", - * // "queries": [], - * // "returnFullDatapoint": false - * // } - * }, + * const res = await aiplatform.projects.locations.deploymentResourcePools.list({ + * // The maximum number of DeploymentResourcePools to return. The service may return fewer than this value. + * pageSize: 'placeholder-value', + * // A page token, received from a previous `ListDeploymentResourcePools` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDeploymentResourcePools` must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The parent Location which owns this collection of DeploymentResourcePools. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', * }); * console.log(res.data); * * // Example response * // { - * // "nearestNeighbors": [] + * // "deploymentResourcePools": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -68403,62 +66350,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - findNeighbors( - params: Params$Resource$Projects$Locations$Indexendpoints$Findneighbors, + list( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$List, options: StreamMethodOptions ): Promise>; - findNeighbors( - params?: Params$Resource$Projects$Locations$Indexendpoints$Findneighbors, + list( + params?: Params$Resource$Projects$Locations$Deploymentresourcepools$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - findNeighbors( - params: Params$Resource$Projects$Locations$Indexendpoints$Findneighbors, + list( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - findNeighbors( - params: Params$Resource$Projects$Locations$Indexendpoints$Findneighbors, + list( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - findNeighbors( - params: Params$Resource$Projects$Locations$Indexendpoints$Findneighbors, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$List, + callback: BodyResponseCallback ): void; - findNeighbors( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - findNeighbors( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Findneighbors - | BodyResponseCallback + | Params$Resource$Projects$Locations$Deploymentresourcepools$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Findneighbors; + {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexendpoints$Findneighbors; + {} as Params$Resource$Projects$Locations$Deploymentresourcepools$List; options = {}; } @@ -68471,34 +66418,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+indexEndpoint}:findNeighbors').replace( + url: (rootUrl + '/v1/{+parent}/deploymentResourcePools').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['indexEndpoint'], - pathParams: ['indexEndpoint'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets an IndexEndpoint. + * Update a DeploymentResourcePool. * @example * ```js * // Before running the sample: @@ -68527,30 +66474,38 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexEndpoints.get({ - * // Required. The name of the IndexEndpoint resource. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` - * name: 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint', - * }); + * const res = await aiplatform.projects.locations.deploymentResourcePools.patch( + * { + * // Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` + * name: 'projects/my-project/locations/my-location/deploymentResourcePools/my-deploymentResourcePool', + * // Required. The list of fields to update. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "dedicatedResources": {}, + * // "disableContainerLogging": false, + * // "encryptionSpec": {}, + * // "name": "my_name", + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "serviceAccount": "my_serviceAccount" + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "deployedIndexes": [], - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "enablePrivateServiceConnect": false, - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "network": "my_network", - * // "privateServiceConnectConfig": {}, - * // "publicEndpointDomainName": "my_publicEndpointDomainName", - * // "publicEndpointEnabled": false, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -68566,61 +66521,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Indexendpoints$Get, + patch( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Patch, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Indexendpoints$Get, + patch( + params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Patch, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Indexendpoints$Get, + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Indexendpoints$Get, + patch( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Indexendpoints$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Patch, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - get( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Deploymentresourcepools$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Get; + {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Indexendpoints$Get; + params = + {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Patch; options = {}; } @@ -68634,7 +66586,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -68645,19 +66597,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists IndexEndpoints in a Location. + * List DeployedModels that have been deployed on this DeploymentResourcePool. * @example * ```js * // Before running the sample: @@ -68686,24 +66636,27 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexEndpoints.list({ - * // Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `index_endpoint` supports = and !=. `index_endpoint` represents the IndexEndpoint ID, ie. the last segment of the IndexEndpoint's resourcename. * `display_name` supports =, != and regex() (uses [re2](https://github.com/google/re2/wiki/Syntax) syntax) * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* or labels:key - key existence A key including a space must be quoted. `labels."a key"`. Some examples: * `index_endpoint="1"` * `display_name="myDisplayName"` * `regex(display_name, "^A") -\> The display name starts with an A. * `labels.myKey="myValue"` - * filter: 'placeholder-value', - * // Optional. The standard list page size. - * pageSize: 'placeholder-value', - * // Optional. The standard list page token. Typically obtained via ListIndexEndpointsResponse.next_page_token of the previous IndexEndpointService.ListIndexEndpoints call. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location from which to list the IndexEndpoints. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * // Optional. Mask specifying which fields to read. - * readMask: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.deploymentResourcePools.queryDeployedModels( + * { + * // Required. The name of the target DeploymentResourcePool to query. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` + * deploymentResourcePool: + * 'projects/my-project/locations/my-location/deploymentResourcePools/my-deploymentResourcePool', + * // The maximum number of DeployedModels to return. The service may return fewer than this value. + * pageSize: 'placeholder-value', + * // A page token, received from a previous `QueryDeployedModels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryDeployedModels` must match the call that provided the page token. + * pageToken: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "indexEndpoints": [], - * // "nextPageToken": "my_nextPageToken" + * // "deployedModelRefs": [], + * // "deployedModels": [], + * // "nextPageToken": "my_nextPageToken", + * // "totalDeployedModelCount": 0, + * // "totalEndpointCount": 0 * // } * } * @@ -68719,61 +66672,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Indexendpoints$List, + queryDeployedModels( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Indexendpoints$List, + queryDeployedModels( + params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Indexendpoints$List, + queryDeployedModels( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Indexendpoints$List, + queryDeployedModels( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Indexendpoints$List, - callback: BodyResponseCallback + queryDeployedModels( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + queryDeployedModels( + callback: BodyResponseCallback ): void; - list( + queryDeployedModels( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$List; + {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Indexendpoints$List; + params = + {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels; options = {}; } @@ -68786,34 +66740,113 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/indexEndpoints').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1/{+deploymentResourcePool}:queryDeployedModels' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['deploymentResourcePool'], + pathParams: ['deploymentResourcePool'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + + export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Create + extends StandardParameters { + /** + * Required. The parent location resource where this DeploymentResourcePool will be created. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; /** - * Update an existing DeployedIndex under an IndexEndpoint. + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest; + } + export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Delete + extends StandardParameters { + /** + * Required. The name of the DeploymentResourcePool to delete. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Get + extends StandardParameters { + /** + * Required. The name of the DeploymentResourcePool to retrieve. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Deploymentresourcepools$List + extends StandardParameters { + /** + * The maximum number of DeploymentResourcePools to return. The service may return fewer than this value. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListDeploymentResourcePools` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDeploymentResourcePools` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent Location which owns this collection of DeploymentResourcePools. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Patch + extends StandardParameters { + /** + * Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` + */ + name?: string; + /** + * Required. The list of fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1DeploymentResourcePool; + } + export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels + extends StandardParameters { + /** + * Required. The name of the target DeploymentResourcePool to query. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` + */ + deploymentResourcePool?: string; + /** + * The maximum number of DeployedModels to return. The service may return fewer than this value. + */ + pageSize?: number; + /** + * A page token, received from a previous `QueryDeployedModels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryDeployedModels` must match the call that provided the page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Deploymentresourcepools$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -68843,43 +66876,16 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.indexEndpoints.mutateDeployedIndex({ - * // Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` - * indexEndpoint: - * 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "automaticResources": {}, - * // "createTime": "my_createTime", - * // "dedicatedResources": {}, - * // "deployedIndexAuthConfig": {}, - * // "deploymentGroup": "my_deploymentGroup", - * // "deploymentTier": "my_deploymentTier", - * // "displayName": "my_displayName", - * // "enableAccessLogging": false, - * // "enableDatapointUpsertLogging": false, - * // "id": "my_id", - * // "index": "my_index", - * // "indexSyncTime": "my_indexSyncTime", - * // "privateEndpoints": {}, - * // "pscAutomationConfigs": [], - * // "reservedIpRanges": [] - * // } + * await aiplatform.projects.locations.deploymentResourcePools.operations.cancel( + * { + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/deploymentResourcePools/my-deploymentResourcePool/operations/my-operation', * }, - * }); + * ); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -68894,58 +66900,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - mutateDeployedIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex, + cancel( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel, options: StreamMethodOptions ): Promise>; - mutateDeployedIndex( - params?: Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex, + cancel( + params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel, options?: MethodOptions - ): Promise>; - mutateDeployedIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - mutateDeployedIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - mutateDeployedIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - mutateDeployedIndex( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel, + callback: BodyResponseCallback ): void; - mutateDeployedIndex( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex - | BodyResponseCallback + | Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex; + {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex; + {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel; options = {}; } @@ -68958,32 +66960,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+indexEndpoint}:mutateDeployedIndex').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['indexEndpoint'], - pathParams: ['indexEndpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates an IndexEndpoint. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -69012,55 +67011,156 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexEndpoints.patch({ - * // Output only. The resource name of the IndexEndpoint. - * name: 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint', - * // Required. The update mask applies to the resource. See google.protobuf.FieldMask. - * updateMask: 'placeholder-value', + * const res = + * await aiplatform.projects.locations.deploymentResourcePools.operations.delete( + * { + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/deploymentResourcePools/my-deploymentResourcePool/operations/my-operation', + * }, + * ); + * console.log(res.data); * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "deployedIndexes": [], - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "enablePrivateServiceConnect": false, - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "network": "my_network", - * // "privateServiceConnectConfig": {}, - * // "publicEndpointDomainName": "my_publicEndpointDomainName", - * // "publicEndpointEnabled": false, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime" - * // } - * }, + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.deploymentResourcePools.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/deploymentResourcePools/my-deploymentResourcePool/operations/my-operation', + * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "deployedIndexes": [], - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "enablePrivateServiceConnect": false, - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "network": "my_network", - * // "privateServiceConnectConfig": {}, - * // "publicEndpointDomainName": "my_publicEndpointDomainName", - * // "publicEndpointEnabled": false, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -69076,61 +67176,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Indexendpoints$Patch, + get( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Indexendpoints$Patch, + get( + params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - patch( - params: Params$Resource$Projects$Locations$Indexendpoints$Patch, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Indexendpoints$Patch, + get( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Indexendpoints$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Patch; + {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Indexendpoints$Patch; + params = + {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get; options = {}; } @@ -69144,7 +67241,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -69155,19 +67252,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Reads the datapoints/vectors of the given IDs. A maximum of 1000 datapoints can be retrieved in a batch. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -69197,25 +67292,27 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.indexEndpoints.readIndexDatapoints({ - * // Required. The name of the index endpoint. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` - * indexEndpoint: - * 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "deployedIndexId": "my_deployedIndexId", - * // "ids": [] - * // } + * await aiplatform.projects.locations.deploymentResourcePools.operations.list( + * { + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/deploymentResourcePools/my-deploymentResourcePool', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, - * }); + * ); * console.log(res.data); * * // Example response * // { - * // "datapoints": [] + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -69231,62 +67328,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - readIndexDatapoints( - params: Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints, + list( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List, options: StreamMethodOptions ): Promise>; - readIndexDatapoints( - params?: Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints, + list( + params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - readIndexDatapoints( - params: Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints, + list( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - readIndexDatapoints( - params: Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints, + list( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - readIndexDatapoints( - params: Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List, + callback: BodyResponseCallback ): void; - readIndexDatapoints( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - readIndexDatapoints( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints - | BodyResponseCallback + | Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints; + {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints; + {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List; options = {}; } @@ -69299,34 +67396,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+indexEndpoint}:readIndexDatapoints').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['indexEndpoint'], - pathParams: ['indexEndpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -69355,19 +67452,15 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexEndpoints.undeployIndex({ - * // Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` - * indexEndpoint: - * 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "deployedIndexId": "my_deployedIndexId" - * // } - * }, - * }); + * const res = + * await aiplatform.projects.locations.deploymentResourcePools.operations.wait( + * { + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/deploymentResourcePools/my-deploymentResourcePool/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response @@ -69392,36 +67485,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - undeployIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Undeployindex, + wait( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait, options: StreamMethodOptions ): Promise>; - undeployIndex( - params?: Params$Resource$Projects$Locations$Indexendpoints$Undeployindex, + wait( + params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait, options?: MethodOptions ): Promise>; - undeployIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Undeployindex, + wait( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - undeployIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Undeployindex, + wait( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - undeployIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Undeployindex, + wait( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait, callback: BodyResponseCallback ): void; - undeployIndex( + wait( callback: BodyResponseCallback ): void; - undeployIndex( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Undeployindex + | Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -69437,13 +67530,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Undeployindex; + {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexendpoints$Undeployindex; + {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait; options = {}; } @@ -69456,18 +67549,15 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+indexEndpoint}:undeployIndex').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['indexEndpoint'], - pathParams: ['indexEndpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -69481,140 +67571,87 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Indexendpoints$Create + export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel extends StandardParameters { /** - * Required. The resource name of the Location to create the IndexEndpoint in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata + * The name of the operation resource to be cancelled. */ - requestBody?: Schema$GoogleCloudAiplatformV1IndexEndpoint; + name?: string; } - export interface Params$Resource$Projects$Locations$Indexendpoints$Delete + export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete extends StandardParameters { /** - * Required. The name of the IndexEndpoint resource to be deleted. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Indexendpoints$Deployindex + export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get extends StandardParameters { /** - * Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` - */ - indexEndpoint?: string; - - /** - * Request body metadata + * The name of the operation resource. */ - requestBody?: Schema$GoogleCloudAiplatformV1DeployIndexRequest; + name?: string; } - export interface Params$Resource$Projects$Locations$Indexendpoints$Findneighbors + export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List extends StandardParameters { /** - * Required. The name of the index endpoint. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` - */ - indexEndpoint?: string; - - /** - * Request body metadata + * The standard list filter. */ - requestBody?: Schema$GoogleCloudAiplatformV1FindNeighborsRequest; - } - export interface Params$Resource$Projects$Locations$Indexendpoints$Get - extends StandardParameters { + filter?: string; /** - * Required. The name of the IndexEndpoint resource. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + * The name of the operation's parent resource. */ name?: string; - } - export interface Params$Resource$Projects$Locations$Indexendpoints$List - extends StandardParameters { - /** - * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `index_endpoint` supports = and !=. `index_endpoint` represents the IndexEndpoint ID, ie. the last segment of the IndexEndpoint's resourcename. * `display_name` supports =, != and regex() (uses [re2](https://github.com/google/re2/wiki/Syntax) syntax) * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* or labels:key - key existence A key including a space must be quoted. `labels."a key"`. Some examples: * `index_endpoint="1"` * `display_name="myDisplayName"` * `regex(display_name, "^A") -\> The display name starts with an A. * `labels.myKey="myValue"` - */ - filter?: string; /** - * Optional. The standard list page size. + * The standard list page size. */ pageSize?: number; /** - * Optional. The standard list page token. Typically obtained via ListIndexEndpointsResponse.next_page_token of the previous IndexEndpointService.ListIndexEndpoints call. + * The standard list page token. */ pageToken?: string; /** - * Required. The resource name of the Location from which to list the IndexEndpoints. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - /** - * Optional. Mask specifying which fields to read. - */ - readMask?: string; - } - export interface Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex - extends StandardParameters { - /** - * Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` - */ - indexEndpoint?: string; - - /** - * Request body metadata + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - requestBody?: Schema$GoogleCloudAiplatformV1DeployedIndex; + returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Indexendpoints$Patch + export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait extends StandardParameters { /** - * Output only. The resource name of the IndexEndpoint. + * The name of the operation resource to wait on. */ name?: string; /** - * Required. The update mask applies to the resource. See google.protobuf.FieldMask. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1IndexEndpoint; - } - export interface Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints - extends StandardParameters { - /** - * Required. The name of the index endpoint. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` - */ - indexEndpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ReadIndexDatapointsRequest; - } - export interface Params$Resource$Projects$Locations$Indexendpoints$Undeployindex - extends StandardParameters { - /** - * Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` - */ - indexEndpoint?: string; - - /** - * Request body metadata + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - requestBody?: Schema$GoogleCloudAiplatformV1UndeployIndexRequest; + timeout?: string; } - export class Resource$Projects$Locations$Indexendpoints$Operations { + export class Resource$Projects$Locations$Endpoints { context: APIRequestContext; + chat: Resource$Projects$Locations$Endpoints$Chat; + deployedModels: Resource$Projects$Locations$Endpoints$Deployedmodels; + invoke: Resource$Projects$Locations$Endpoints$Invoke; + openapi: Resource$Projects$Locations$Endpoints$Openapi; + operations: Resource$Projects$Locations$Endpoints$Operations; constructor(context: APIRequestContext) { this.context = context; + this.chat = new Resource$Projects$Locations$Endpoints$Chat(this.context); + this.deployedModels = + new Resource$Projects$Locations$Endpoints$Deployedmodels(this.context); + this.invoke = new Resource$Projects$Locations$Endpoints$Invoke( + this.context + ); + this.openapi = new Resource$Projects$Locations$Endpoints$Openapi( + this.context + ); + this.operations = new Resource$Projects$Locations$Endpoints$Operations( + this.context + ); } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Return a list of tokens based on the input text. * @example * ```js * // Before running the sample: @@ -69643,15 +67680,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.indexEndpoints.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.endpoints.computeTokens({ + * // Required. The name of the Endpoint requested to get lists of tokens and token ids. + * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "contents": [], + * // "instances": [], + * // "model": "my_model" + * // } + * }, + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "tokensInfo": [] + * // } * } * * main().catch(e => { @@ -69666,54 +67714,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel, + computeTokens( + params: Params$Resource$Projects$Locations$Endpoints$Computetokens, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel, + computeTokens( + params?: Params$Resource$Projects$Locations$Endpoints$Computetokens, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel, + ): Promise< + GaxiosResponseWithHTTP2 + >; + computeTokens( + params: Params$Resource$Projects$Locations$Endpoints$Computetokens, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - cancel( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel, - callback: BodyResponseCallback + computeTokens( + params: Params$Resource$Projects$Locations$Endpoints$Computetokens, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + computeTokens( + params: Params$Resource$Projects$Locations$Endpoints$Computetokens, + callback: BodyResponseCallback + ): void; + computeTokens( + callback: BodyResponseCallback + ): void; + computeTokens( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpoints$Computetokens + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Endpoints$Computetokens; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Endpoints$Computetokens; options = {}; } @@ -69726,29 +67782,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+endpoint}:computeTokens').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Perform a token counting. * @example * ```js * // Before running the sample: @@ -69777,15 +67838,31 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.indexEndpoints.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.endpoints.countTokens({ + * // Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "contents": [], + * // "generationConfig": {}, + * // "instances": [], + * // "model": "my_model", + * // "systemInstruction": {}, + * // "tools": [] + * // } + * }, + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "promptTokensDetails": [], + * // "totalBillableCharacters": 0, + * // "totalTokens": 0 + * // } * } * * main().catch(e => { @@ -69800,54 +67877,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete, + countTokens( + params: Params$Resource$Projects$Locations$Endpoints$Counttokens, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete, + countTokens( + params?: Params$Resource$Projects$Locations$Endpoints$Counttokens, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + countTokens( + params: Params$Resource$Projects$Locations$Endpoints$Counttokens, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + countTokens( + params: Params$Resource$Projects$Locations$Endpoints$Counttokens, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete, - callback: BodyResponseCallback + countTokens( + params: Params$Resource$Projects$Locations$Endpoints$Counttokens, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + countTokens( + callback: BodyResponseCallback + ): void; + countTokens( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpoints$Counttokens + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Endpoints$Counttokens; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete; + params = {} as Params$Resource$Projects$Locations$Endpoints$Counttokens; options = {}; } @@ -69860,29 +67944,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+endpoint}:countTokens').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Creates an Endpoint. * @example * ```js * // Before running the sample: @@ -69911,12 +68000,41 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexEndpoints.operations.get( - * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint/operations/my-operation', + * const res = await aiplatform.projects.locations.endpoints.create({ + * // Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are `[0-9]` with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as `?endpoint_id=12345`. This is the fallback for fields that are not included in either the URI or the body. + * endpointId: 'placeholder-value', + * // Required. The resource name of the Location to create the Endpoint in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "clientConnectionConfig": {}, + * // "createTime": "my_createTime", + * // "dedicatedEndpointDns": "my_dedicatedEndpointDns", + * // "dedicatedEndpointEnabled": false, + * // "deployedModels": [], + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "enablePrivateServiceConnect": false, + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "gdcConfig": {}, + * // "genAiAdvancedFeaturesConfig": {}, + * // "labels": {}, + * // "modelDeploymentMonitoringJob": "my_modelDeploymentMonitoringJob", + * // "name": "my_name", + * // "network": "my_network", + * // "predictRequestResponseLoggingConfig": {}, + * // "privateServiceConnectConfig": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "trafficSplit": {}, + * // "updateTime": "my_updateTime" + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response @@ -69941,36 +68059,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Get, + create( + params: Params$Resource$Projects$Locations$Endpoints$Create, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Indexendpoints$Operations$Get, + create( + params?: Params$Resource$Projects$Locations$Endpoints$Create, options?: MethodOptions ): Promise>; - get( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Get, + create( + params: Params$Resource$Projects$Locations$Endpoints$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Get, + create( + params: Params$Resource$Projects$Locations$Endpoints$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Get, + create( + params: Params$Resource$Projects$Locations$Endpoints$Create, callback: BodyResponseCallback ): void; - get( + create( callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Operations$Get + | Params$Resource$Projects$Locations$Endpoints$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -69986,13 +68104,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Operations$Get; + {}) as Params$Resource$Projects$Locations$Endpoints$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Indexendpoints$Operations$Get; + params = {} as Params$Resource$Projects$Locations$Endpoints$Create; options = {}; } @@ -70005,15 +68122,18 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+parent}/endpoints').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -70027,7 +68147,7 @@ export namespace aiplatform_v1 { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Deletes an Endpoint. * @example * ```js * // Before running the sample: @@ -70056,26 +68176,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.indexEndpoints.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * const res = await aiplatform.projects.locations.endpoints.delete({ + * // Required. The name of the Endpoint resource to be deleted. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -70091,62 +68204,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$List, + delete( + params: Params$Resource$Projects$Locations$Endpoints$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Indexendpoints$Operations$List, + delete( + params?: Params$Resource$Projects$Locations$Endpoints$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$List, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Endpoints$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$List, + delete( + params: Params$Resource$Projects$Locations$Endpoints$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Endpoints$Delete, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - list( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpoints$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Operations$List; + {}) as Params$Resource$Projects$Locations$Endpoints$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Indexendpoints$Operations$List; + params = {} as Params$Resource$Projects$Locations$Endpoints$Delete; options = {}; } @@ -70159,11 +68267,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -70174,19 +68279,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Deploys a Model into this Endpoint, creating a DeployedModel within it. * @example * ```js * // Before running the sample: @@ -70215,13 +68318,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.indexEndpoints.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); + * const res = await aiplatform.projects.locations.endpoints.deployModel({ + * // Required. The name of the Endpoint resource into which to deploy a Model. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "deployedModel": {}, + * // "trafficSplit": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response @@ -70246,36 +68355,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait, + deployModel( + params: Params$Resource$Projects$Locations$Endpoints$Deploymodel, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait, + deployModel( + params?: Params$Resource$Projects$Locations$Endpoints$Deploymodel, options?: MethodOptions ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait, + deployModel( + params: Params$Resource$Projects$Locations$Endpoints$Deploymodel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait, + deployModel( + params: Params$Resource$Projects$Locations$Endpoints$Deploymodel, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait, + deployModel( + params: Params$Resource$Projects$Locations$Endpoints$Deploymodel, callback: BodyResponseCallback ): void; - wait( + deployModel( callback: BodyResponseCallback ): void; - wait( + deployModel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait + | Params$Resource$Projects$Locations$Endpoints$Deploymodel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -70291,13 +68400,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Endpoints$Deploymodel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait; + params = {} as Params$Resource$Projects$Locations$Endpoints$Deploymodel; options = {}; } @@ -70310,15 +68418,18 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+endpoint}:deployModel').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { @@ -70330,76 +68441,9 @@ export namespace aiplatform_v1 { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel - extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete - extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Indexendpoints$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Indexendpoints$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait - extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Indexes { - context: APIRequestContext; - operations: Resource$Projects$Locations$Indexes$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = new Resource$Projects$Locations$Indexes$Operations( - this.context - ); - } /** - * Creates an Index. + * Perform an unary online prediction request to a gRPC model server for Vertex first-party products and frameworks. * @example * ```js * // Before running the sample: @@ -70420,7 +68464,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -70428,29 +68475,16 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexes.create({ - * // Required. The resource name of the Location to create the Index in. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * const res = await aiplatform.projects.locations.endpoints.directPredict({ + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "createTime": "my_createTime", - * // "deployedIndexes": [], - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "indexStats": {}, - * // "indexUpdateMethod": "my_indexUpdateMethod", - * // "labels": {}, - * // "metadata": {}, - * // "metadataSchemaUri": "my_metadataSchemaUri", - * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime" + * // "inputs": [], + * // "parameters": {} * // } * }, * }); @@ -70458,11 +68492,8 @@ export namespace aiplatform_v1 { * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "outputs": [], + * // "parameters": {} * // } * } * @@ -70478,57 +68509,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Indexes$Create, + directPredict( + params: Params$Resource$Projects$Locations$Endpoints$Directpredict, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Indexes$Create, + directPredict( + params?: Params$Resource$Projects$Locations$Endpoints$Directpredict, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Indexes$Create, + ): Promise< + GaxiosResponseWithHTTP2 + >; + directPredict( + params: Params$Resource$Projects$Locations$Endpoints$Directpredict, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Indexes$Create, + directPredict( + params: Params$Resource$Projects$Locations$Endpoints$Directpredict, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Indexes$Create, - callback: BodyResponseCallback + directPredict( + params: Params$Resource$Projects$Locations$Endpoints$Directpredict, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + directPredict( + callback: BodyResponseCallback ): void; - create( + directPredict( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpoints$Directpredict + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$Create; + {}) as Params$Resource$Projects$Locations$Endpoints$Directpredict; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Indexes$Create; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Directpredict; options = {}; } @@ -70541,7 +68577,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/indexes').replace( + url: (rootUrl + '/v1/{+endpoint}:directPredict').replace( /([^:]\/)\/+/g, '$1' ), @@ -70551,22 +68587,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes an Index. An Index can only be deleted when all its DeployedIndexes had been undeployed. + * Perform an unary online prediction request to a gRPC model server for custom containers. * @example * ```js * // Before running the sample: @@ -70587,7 +68625,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -70595,19 +68636,24 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexes.delete({ - * // Required. The name of the Index resource to be deleted. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` - * name: 'projects/my-project/locations/my-location/indexes/my-indexe', + * const res = await aiplatform.projects.locations.endpoints.directRawPredict({ + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "input": "my_input", + * // "methodName": "my_methodName" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "output": "my_output" * // } * } * @@ -70623,57 +68669,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Indexes$Delete, + directRawPredict( + params: Params$Resource$Projects$Locations$Endpoints$Directrawpredict, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Indexes$Delete, + directRawPredict( + params?: Params$Resource$Projects$Locations$Endpoints$Directrawpredict, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Indexes$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + directRawPredict( + params: Params$Resource$Projects$Locations$Endpoints$Directrawpredict, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Indexes$Delete, + directRawPredict( + params: Params$Resource$Projects$Locations$Endpoints$Directrawpredict, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Indexes$Delete, - callback: BodyResponseCallback + directRawPredict( + params: Params$Resource$Projects$Locations$Endpoints$Directrawpredict, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + directRawPredict( + callback: BodyResponseCallback ): void; - delete( + directRawPredict( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpoints$Directrawpredict + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$Delete; + {}) as Params$Resource$Projects$Locations$Endpoints$Directrawpredict; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Indexes$Delete; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Directrawpredict; options = {}; } @@ -70686,29 +68737,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+endpoint}:directRawPredict').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets an Index. + * Perform an online explanation. If deployed_model_id is specified, the corresponding DeployModel must have explanation_spec populated. If deployed_model_id is not specified, all DeployedModels must have explanation_spec populated. * @example * ```js * // Before running the sample: @@ -70729,7 +68785,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -70737,29 +68796,28 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexes.get({ - * // Required. The name of the Index resource. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` - * name: 'projects/my-project/locations/my-location/indexes/my-indexe', + * const res = await aiplatform.projects.locations.endpoints.explain({ + * // Required. The name of the Endpoint requested to serve the explanation. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "deployedModelId": "my_deployedModelId", + * // "explanationSpecOverride": {}, + * // "instances": [], + * // "parameters": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "deployedIndexes": [], - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "indexStats": {}, - * // "indexUpdateMethod": "my_indexUpdateMethod", - * // "labels": {}, - * // "metadata": {}, - * // "metadataSchemaUri": "my_metadataSchemaUri", - * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime" + * // "deployedModelId": "my_deployedModelId", + * // "explanations": [], + * // "predictions": [] * // } * } * @@ -70775,57 +68833,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Indexes$Get, + explain( + params: Params$Resource$Projects$Locations$Endpoints$Explain, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Indexes$Get, + explain( + params?: Params$Resource$Projects$Locations$Endpoints$Explain, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Indexes$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + explain( + params: Params$Resource$Projects$Locations$Endpoints$Explain, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Indexes$Get, + explain( + params: Params$Resource$Projects$Locations$Endpoints$Explain, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Indexes$Get, - callback: BodyResponseCallback + explain( + params: Params$Resource$Projects$Locations$Endpoints$Explain, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + explain( + callback: BodyResponseCallback ): void; - get( + explain( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpoints$Explain + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$Get; + {}) as Params$Resource$Projects$Locations$Endpoints$Explain; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Indexes$Get; + params = {} as Params$Resource$Projects$Locations$Endpoints$Explain; options = {}; } @@ -70838,31 +68900,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+endpoint}:explain').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists Indexes in a Location. + * Fetch an asynchronous online prediction operation. * @example * ```js * // Before running the sample: @@ -70883,7 +68948,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -70891,24 +68959,29 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexes.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. Typically obtained via ListIndexesResponse.next_page_token of the previous IndexService.ListIndexes call. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location from which to list the Indexes. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.endpoints.fetchPredictOperation({ + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` + * endpoint: + * 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "operationName": "my_operationName" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "indexes": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -70924,61 +68997,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Indexes$List, + fetchPredictOperation( + params: Params$Resource$Projects$Locations$Endpoints$Fetchpredictoperation, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Indexes$List, + fetchPredictOperation( + params?: Params$Resource$Projects$Locations$Endpoints$Fetchpredictoperation, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Indexes$List, + ): Promise>; + fetchPredictOperation( + params: Params$Resource$Projects$Locations$Endpoints$Fetchpredictoperation, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Indexes$List, + fetchPredictOperation( + params: Params$Resource$Projects$Locations$Endpoints$Fetchpredictoperation, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Indexes$List, - callback: BodyResponseCallback + fetchPredictOperation( + params: Params$Resource$Projects$Locations$Endpoints$Fetchpredictoperation, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + fetchPredictOperation( + callback: BodyResponseCallback ): void; - list( + fetchPredictOperation( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpoints$Fetchpredictoperation + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$List; + {}) as Params$Resource$Projects$Locations$Endpoints$Fetchpredictoperation; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Indexes$List; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Fetchpredictoperation; options = {}; } @@ -70991,34 +69061,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/indexes').replace( + url: (rootUrl + '/v1/{+endpoint}:fetchPredictOperation').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates an Index. + * Generate content with multimodal inputs. * @example * ```js * // Before running the sample: @@ -71039,7 +69107,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -71047,31 +69118,23 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexes.patch({ - * // Output only. The resource name of the Index. - * name: 'projects/my-project/locations/my-location/indexes/my-indexe', - * // The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. - * updateMask: 'placeholder-value', + * const res = await aiplatform.projects.locations.endpoints.generateContent({ + * // Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * model: 'projects/my-project/locations/my-location/endpoints/my-endpoint', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "createTime": "my_createTime", - * // "deployedIndexes": [], - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "indexStats": {}, - * // "indexUpdateMethod": "my_indexUpdateMethod", + * // "cachedContent": "my_cachedContent", + * // "contents": [], + * // "generationConfig": {}, * // "labels": {}, - * // "metadata": {}, - * // "metadataSchemaUri": "my_metadataSchemaUri", - * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime" + * // "modelArmorConfig": {}, + * // "safetySettings": [], + * // "systemInstruction": {}, + * // "toolConfig": {}, + * // "tools": [] * // } * }, * }); @@ -71079,11 +69142,12 @@ export namespace aiplatform_v1 { * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "candidates": [], + * // "createTime": "my_createTime", + * // "modelVersion": "my_modelVersion", + * // "promptFeedback": {}, + * // "responseId": "my_responseId", + * // "usageMetadata": {} * // } * } * @@ -71099,57 +69163,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Indexes$Patch, + generateContent( + params: Params$Resource$Projects$Locations$Endpoints$Generatecontent, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Indexes$Patch, + generateContent( + params?: Params$Resource$Projects$Locations$Endpoints$Generatecontent, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Indexes$Patch, + ): Promise< + GaxiosResponseWithHTTP2 + >; + generateContent( + params: Params$Resource$Projects$Locations$Endpoints$Generatecontent, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Indexes$Patch, + generateContent( + params: Params$Resource$Projects$Locations$Endpoints$Generatecontent, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Indexes$Patch, - callback: BodyResponseCallback + generateContent( + params: Params$Resource$Projects$Locations$Endpoints$Generatecontent, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + generateContent( + callback: BodyResponseCallback ): void; - patch( + generateContent( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpoints$Generatecontent + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$Patch; + {}) as Params$Resource$Projects$Locations$Endpoints$Generatecontent; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Indexes$Patch; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Generatecontent; options = {}; } @@ -71162,29 +69231,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+model}:generateContent').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['model'], + pathParams: ['model'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Remove Datapoints from an Index. + * Gets an Endpoint. * @example * ```js * // Before running the sample: @@ -71213,92 +69287,102 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexes.removeDatapoints({ - * // Required. The name of the Index resource to be updated. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` - * index: 'projects/my-project/locations/my-location/indexes/my-indexe', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "datapointIds": [] - * // } - * }, + * const res = await aiplatform.projects.locations.endpoints.get({ + * // Required. The name of the Endpoint resource. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint', * }); * console.log(res.data); * * // Example response - * // {} - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - removeDatapoints( - params: Params$Resource$Projects$Locations$Indexes$Removedatapoints, + * // { + * // "clientConnectionConfig": {}, + * // "createTime": "my_createTime", + * // "dedicatedEndpointDns": "my_dedicatedEndpointDns", + * // "dedicatedEndpointEnabled": false, + * // "deployedModels": [], + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "enablePrivateServiceConnect": false, + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "gdcConfig": {}, + * // "genAiAdvancedFeaturesConfig": {}, + * // "labels": {}, + * // "modelDeploymentMonitoringJob": "my_modelDeploymentMonitoringJob", + * // "name": "my_name", + * // "network": "my_network", + * // "predictRequestResponseLoggingConfig": {}, + * // "privateServiceConnectConfig": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "trafficSplit": {}, + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Endpoints$Get, options: StreamMethodOptions ): Promise>; - removeDatapoints( - params?: Params$Resource$Projects$Locations$Indexes$Removedatapoints, + get( + params?: Params$Resource$Projects$Locations$Endpoints$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - removeDatapoints( - params: Params$Resource$Projects$Locations$Indexes$Removedatapoints, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Endpoints$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - removeDatapoints( - params: Params$Resource$Projects$Locations$Indexes$Removedatapoints, + get( + params: Params$Resource$Projects$Locations$Endpoints$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - removeDatapoints( - params: Params$Resource$Projects$Locations$Indexes$Removedatapoints, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Endpoints$Get, + callback: BodyResponseCallback ): void; - removeDatapoints( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - removeDatapoints( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Removedatapoints - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpoints$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$Removedatapoints; + {}) as Params$Resource$Projects$Locations$Endpoints$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Indexes$Removedatapoints; + params = {} as Params$Resource$Projects$Locations$Endpoints$Get; options = {}; } @@ -71311,34 +69395,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+index}:removeDatapoints').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['index'], - pathParams: ['index'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Add/update Datapoints into an Index. + * Lists Endpoints in a Location. * @example * ```js * // Before running the sample: @@ -71367,23 +69448,29 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexes.upsertDatapoints({ - * // Required. The name of the Index resource to be updated. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` - * index: 'projects/my-project/locations/my-location/indexes/my-indexe', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "datapoints": [], - * // "updateMask": "my_updateMask" - * // } - * }, + * const res = await aiplatform.projects.locations.endpoints.list({ + * // Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports `=` and `!=`. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * `display_name` supports `=` and `!=`. * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:*` or `labels:key` - key existence * A key including a space must be quoted. `labels."a key"`. * `base_model_name` only supports `=`. Some examples: * `endpoint=1` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `baseModelName="text-bison"` + * filter: 'placeholder-value', + * // Optional. Configures the Google Distributed Cloud (GDC) environment for online prediction. Only set this field when the Endpoint is to be deployed in a GDC environment. + * gdcZone: 'placeholder-value', + * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. + * orderBy: 'placeholder-value', + * // Optional. The standard list page size. + * pageSize: 'placeholder-value', + * // Optional. The standard list page token. Typically obtained via ListEndpointsResponse.next_page_token of the previous EndpointService.ListEndpoints call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location from which to list the Endpoints. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // Optional. Mask specifying which fields to read. + * readMask: 'placeholder-value', * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "endpoints": [], + * // "nextPageToken": "my_nextPageToken" + * // } * } * * main().catch(e => { @@ -71398,62 +69485,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - upsertDatapoints( - params: Params$Resource$Projects$Locations$Indexes$Upsertdatapoints, + list( + params: Params$Resource$Projects$Locations$Endpoints$List, options: StreamMethodOptions ): Promise>; - upsertDatapoints( - params?: Params$Resource$Projects$Locations$Indexes$Upsertdatapoints, + list( + params?: Params$Resource$Projects$Locations$Endpoints$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - upsertDatapoints( - params: Params$Resource$Projects$Locations$Indexes$Upsertdatapoints, + list( + params: Params$Resource$Projects$Locations$Endpoints$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - upsertDatapoints( - params: Params$Resource$Projects$Locations$Indexes$Upsertdatapoints, + list( + params: Params$Resource$Projects$Locations$Endpoints$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - upsertDatapoints( - params: Params$Resource$Projects$Locations$Indexes$Upsertdatapoints, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Endpoints$List, + callback: BodyResponseCallback ): void; - upsertDatapoints( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - upsertDatapoints( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Upsertdatapoints - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpoints$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$Upsertdatapoints; + {}) as Params$Resource$Projects$Locations$Endpoints$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Indexes$Upsertdatapoints; + params = {} as Params$Resource$Projects$Locations$Endpoints$List; options = {}; } @@ -71466,131 +69552,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+index}:upsertDatapoints').replace( + url: (rootUrl + '/v1/{+parent}/endpoints').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['index'], - pathParams: ['index'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Indexes$Create - extends StandardParameters { - /** - * Required. The resource name of the Location to create the Index in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Index; - } - export interface Params$Resource$Projects$Locations$Indexes$Delete - extends StandardParameters { - /** - * Required. The name of the Index resource to be deleted. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Indexes$Get - extends StandardParameters { - /** - * Required. The name of the Index resource. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Indexes$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. Typically obtained via ListIndexesResponse.next_page_token of the previous IndexService.ListIndexes call. - */ - pageToken?: string; - /** - * Required. The resource name of the Location from which to list the Indexes. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; - } - export interface Params$Resource$Projects$Locations$Indexes$Patch - extends StandardParameters { - /** - * Output only. The resource name of the Index. - */ - name?: string; - /** - * The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Index; - } - export interface Params$Resource$Projects$Locations$Indexes$Removedatapoints - extends StandardParameters { - /** - * Required. The name of the Index resource to be updated. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` - */ - index?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1RemoveDatapointsRequest; - } - export interface Params$Resource$Projects$Locations$Indexes$Upsertdatapoints - extends StandardParameters { - /** - * Required. The name of the Index resource to be updated. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` - */ - index?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1UpsertDatapointsRequest; - } - - export class Resource$Projects$Locations$Indexes$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Updates an existing deployed model. Updatable fields include `min_replica_count`, `max_replica_count`, `required_replica_count`, `autoscaling_metric_specs`, `disable_container_logging` (v1 only), and `enable_container_logging` (v1beta1 only). * @example * ```js * // Before running the sample: @@ -71619,14 +69608,32 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexes.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/indexes/my-indexe/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.endpoints.mutateDeployedModel( + * { + * // Required. The name of the Endpoint resource into which to mutate a DeployedModel. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: + * 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "deployedModel": {}, + * // "updateMask": "my_updateMask" + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -71641,54 +69648,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Indexes$Operations$Cancel, + mutateDeployedModel( + params: Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Indexes$Operations$Cancel, + mutateDeployedModel( + params?: Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Indexes$Operations$Cancel, + ): Promise>; + mutateDeployedModel( + params: Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Indexes$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + mutateDeployedModel( + params: Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Indexes$Operations$Cancel, - callback: BodyResponseCallback + mutateDeployedModel( + params: Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + mutateDeployedModel( + callback: BodyResponseCallback + ): void; + mutateDeployedModel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexes$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel; options = {}; } @@ -71701,29 +69712,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+endpoint}:mutateDeployedModel').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Updates an Endpoint. * @example * ```js * // Before running the sample: @@ -71752,14 +69766,68 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexes.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/indexes/my-indexe/operations/my-operation', + * const res = await aiplatform.projects.locations.endpoints.patch({ + * // Output only. The resource name of the Endpoint. + * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * // Required. The update mask applies to the resource. See google.protobuf.FieldMask. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "clientConnectionConfig": {}, + * // "createTime": "my_createTime", + * // "dedicatedEndpointDns": "my_dedicatedEndpointDns", + * // "dedicatedEndpointEnabled": false, + * // "deployedModels": [], + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "enablePrivateServiceConnect": false, + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "gdcConfig": {}, + * // "genAiAdvancedFeaturesConfig": {}, + * // "labels": {}, + * // "modelDeploymentMonitoringJob": "my_modelDeploymentMonitoringJob", + * // "name": "my_name", + * // "network": "my_network", + * // "predictRequestResponseLoggingConfig": {}, + * // "privateServiceConnectConfig": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "trafficSplit": {}, + * // "updateTime": "my_updateTime" + * // } + * }, * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "clientConnectionConfig": {}, + * // "createTime": "my_createTime", + * // "dedicatedEndpointDns": "my_dedicatedEndpointDns", + * // "dedicatedEndpointEnabled": false, + * // "deployedModels": [], + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "enablePrivateServiceConnect": false, + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "gdcConfig": {}, + * // "genAiAdvancedFeaturesConfig": {}, + * // "labels": {}, + * // "modelDeploymentMonitoringJob": "my_modelDeploymentMonitoringJob", + * // "name": "my_name", + * // "network": "my_network", + * // "predictRequestResponseLoggingConfig": {}, + * // "privateServiceConnectConfig": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "trafficSplit": {}, + * // "updateTime": "my_updateTime" + * // } * } * * main().catch(e => { @@ -71774,54 +69842,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Indexes$Operations$Delete, + patch( + params: Params$Resource$Projects$Locations$Endpoints$Patch, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Indexes$Operations$Delete, + patch( + params?: Params$Resource$Projects$Locations$Endpoints$Patch, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Indexes$Operations$Delete, + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Endpoints$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Indexes$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Endpoints$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Indexes$Operations$Delete, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Endpoints$Patch, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + patch( + callback: BodyResponseCallback + ): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpoints$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Endpoints$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Indexes$Operations$Delete; + params = {} as Params$Resource$Projects$Locations$Endpoints$Patch; options = {}; } @@ -71835,7 +69906,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'PATCH', apiVersion: '', }, options @@ -71846,17 +69917,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Perform an online prediction. * @example * ```js * // Before running the sample: @@ -71877,7 +69950,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -71885,19 +69961,30 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexes.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/indexes/my-indexe/operations/my-operation', + * const res = await aiplatform.projects.locations.endpoints.predict({ + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "instances": [], + * // "labels": {}, + * // "parameters": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, + * // "deployedModelId": "my_deployedModelId", * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "model": "my_model", + * // "modelDisplayName": "my_modelDisplayName", + * // "modelVersionId": "my_modelVersionId", + * // "predictions": [] * // } * } * @@ -71913,58 +70000,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Indexes$Operations$Get, + predict( + params: Params$Resource$Projects$Locations$Endpoints$Predict, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Indexes$Operations$Get, + predict( + params?: Params$Resource$Projects$Locations$Endpoints$Predict, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Indexes$Operations$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + predict( + params: Params$Resource$Projects$Locations$Endpoints$Predict, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Indexes$Operations$Get, + predict( + params: Params$Resource$Projects$Locations$Endpoints$Predict, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Indexes$Operations$Get, - callback: BodyResponseCallback + predict( + params: Params$Resource$Projects$Locations$Endpoints$Predict, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + predict( + callback: BodyResponseCallback ): void; - get( + predict( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpoints$Predict + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$Operations$Get; + {}) as Params$Resource$Projects$Locations$Endpoints$Predict; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Indexes$Operations$Get; + params = {} as Params$Resource$Projects$Locations$Endpoints$Predict; options = {}; } @@ -71977,29 +70067,33 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+endpoint}:predict').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -72020,7 +70114,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -72028,25 +70125,28 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexes.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/indexes/my-indexe', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', + * const res = await aiplatform.projects.locations.endpoints.predictLongRunning({ + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` + * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "instances": [], + * // "parameters": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -72062,62 +70162,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Indexes$Operations$List, + predictLongRunning( + params: Params$Resource$Projects$Locations$Endpoints$Predictlongrunning, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Indexes$Operations$List, + predictLongRunning( + params?: Params$Resource$Projects$Locations$Endpoints$Predictlongrunning, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Indexes$Operations$List, + ): Promise>; + predictLongRunning( + params: Params$Resource$Projects$Locations$Endpoints$Predictlongrunning, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Indexes$Operations$List, + predictLongRunning( + params: Params$Resource$Projects$Locations$Endpoints$Predictlongrunning, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Indexes$Operations$List, - callback: BodyResponseCallback + predictLongRunning( + params: Params$Resource$Projects$Locations$Endpoints$Predictlongrunning, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + predictLongRunning( + callback: BodyResponseCallback ): void; - list( + predictLongRunning( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpoints$Predictlongrunning + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$Operations$List; + {}) as Params$Resource$Projects$Locations$Endpoints$Predictlongrunning; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexes$Operations$List; + {} as Params$Resource$Projects$Locations$Endpoints$Predictlongrunning; options = {}; } @@ -72130,34 +70226,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+endpoint}:predictLongRunning').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's DeployedModel that served this prediction. * @example * ```js * // Before running the sample: @@ -72178,7 +70272,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -72186,21 +70283,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexes.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/indexes/my-indexe/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', + * const res = await aiplatform.projects.locations.endpoints.rawPredict({ + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "httpBody": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] * // } * } * @@ -72216,58 +70317,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Indexes$Operations$Wait, + rawPredict( + params: Params$Resource$Projects$Locations$Endpoints$Rawpredict, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Indexes$Operations$Wait, + rawPredict( + params?: Params$Resource$Projects$Locations$Endpoints$Rawpredict, options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Indexes$Operations$Wait, + ): Promise>; + rawPredict( + params: Params$Resource$Projects$Locations$Endpoints$Rawpredict, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Indexes$Operations$Wait, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - wait( - params: Params$Resource$Projects$Locations$Indexes$Operations$Wait, - callback: BodyResponseCallback + rawPredict( + params: Params$Resource$Projects$Locations$Endpoints$Rawpredict, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + rawPredict( + params: Params$Resource$Projects$Locations$Endpoints$Rawpredict, + callback: BodyResponseCallback ): void; - wait( + rawPredict(callback: BodyResponseCallback): void; + rawPredict( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpoints$Rawpredict + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Endpoints$Rawpredict; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Indexes$Operations$Wait; + params = {} as Params$Resource$Projects$Locations$Endpoints$Rawpredict; options = {}; } @@ -72280,111 +70376,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+endpoint}:rawPredict').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Indexes$Operations$Cancel - extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Indexes$Operations$Delete - extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Indexes$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Indexes$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Locations$Indexes$Operations$Wait - extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Metadatastores { - context: APIRequestContext; - artifacts: Resource$Projects$Locations$Metadatastores$Artifacts; - contexts: Resource$Projects$Locations$Metadatastores$Contexts; - executions: Resource$Projects$Locations$Metadatastores$Executions; - metadataSchemas: Resource$Projects$Locations$Metadatastores$Metadataschemas; - operations: Resource$Projects$Locations$Metadatastores$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.artifacts = new Resource$Projects$Locations$Metadatastores$Artifacts( - this.context - ); - this.contexts = new Resource$Projects$Locations$Metadatastores$Contexts( - this.context - ); - this.executions = - new Resource$Projects$Locations$Metadatastores$Executions(this.context); - this.metadataSchemas = - new Resource$Projects$Locations$Metadatastores$Metadataschemas( - this.context - ); - this.operations = - new Resource$Projects$Locations$Metadatastores$Operations(this.context); - } /** - * Initializes a MetadataStore, including allocation of resources. + * Perform a server-side streaming online prediction request for Vertex LLM streaming. * @example * ```js * // Before running the sample: @@ -72405,7 +70422,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -72413,35 +70433,27 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.metadataStores.create({ - * // The {metadatastore\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all MetadataStores in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataStore.) - * metadataStoreId: 'placeholder-value', - * // Required. The resource name of the Location where the MetadataStore should be created. Format: `projects/{project\}/locations/{location\}/` - * parent: 'projects/my-project/locations/my-location', + * const res = + * await aiplatform.projects.locations.endpoints.serverStreamingPredict({ + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: + * 'projects/my-project/locations/my-location/endpoints/my-endpoint', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "dataplexConfig": {}, - * // "description": "my_description", - * // "encryptionSpec": {}, - * // "name": "my_name", - * // "state": {}, - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "inputs": [], + * // "parameters": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "outputs": [], + * // "parameters": {} * // } * } * @@ -72457,57 +70469,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Metadatastores$Create, + serverStreamingPredict( + params: Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Metadatastores$Create, + serverStreamingPredict( + params?: Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Metadatastores$Create, + ): Promise< + GaxiosResponseWithHTTP2 + >; + serverStreamingPredict( + params: Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Metadatastores$Create, + serverStreamingPredict( + params: Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Metadatastores$Create, - callback: BodyResponseCallback + serverStreamingPredict( + params: Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + serverStreamingPredict( + callback: BodyResponseCallback ): void; - create( + serverStreamingPredict( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Create; + {}) as Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Metadatastores$Create; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict; options = {}; } @@ -72520,7 +70537,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/metadataStores').replace( + url: (rootUrl + '/v1/{+endpoint}:serverStreamingPredict').replace( /([^:]\/)\/+/g, '$1' ), @@ -72530,22 +70547,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts). + * Generate content with multimodal inputs with streaming support. * @example * ```js * // Before running the sample: @@ -72566,7 +70585,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -72574,13 +70596,39005 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.metadataStores.delete({ - * // Deprecated: Field is no longer supported. - * force: 'placeholder-value', - * // Required. The resource name of the MetadataStore to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', - * }); - * console.log(res.data); + * const res = + * await aiplatform.projects.locations.endpoints.streamGenerateContent({ + * // Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * model: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "cachedContent": "my_cachedContent", + * // "contents": [], + * // "generationConfig": {}, + * // "labels": {}, + * // "modelArmorConfig": {}, + * // "safetySettings": [], + * // "systemInstruction": {}, + * // "toolConfig": {}, + * // "tools": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "candidates": [], + * // "createTime": "my_createTime", + * // "modelVersion": "my_modelVersion", + * // "promptFeedback": {}, + * // "responseId": "my_responseId", + * // "usageMetadata": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + streamGenerateContent( + params: Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent, + options: StreamMethodOptions + ): Promise>; + streamGenerateContent( + params?: Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + streamGenerateContent( + params: Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + streamGenerateContent( + params: Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + streamGenerateContent( + params: Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent, + callback: BodyResponseCallback + ): void; + streamGenerateContent( + callback: BodyResponseCallback + ): void; + streamGenerateContent( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+model}:streamGenerateContent').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['model'], + pathParams: ['model'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Perform a streaming online prediction with an arbitrary HTTP payload. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.endpoints.streamRawPredict({ + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "httpBody": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + streamRawPredict( + params: Params$Resource$Projects$Locations$Endpoints$Streamrawpredict, + options: StreamMethodOptions + ): Promise>; + streamRawPredict( + params?: Params$Resource$Projects$Locations$Endpoints$Streamrawpredict, + options?: MethodOptions + ): Promise>; + streamRawPredict( + params: Params$Resource$Projects$Locations$Endpoints$Streamrawpredict, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + streamRawPredict( + params: Params$Resource$Projects$Locations$Endpoints$Streamrawpredict, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + streamRawPredict( + params: Params$Resource$Projects$Locations$Endpoints$Streamrawpredict, + callback: BodyResponseCallback + ): void; + streamRawPredict( + callback: BodyResponseCallback + ): void; + streamRawPredict( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Streamrawpredict + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Streamrawpredict; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Streamrawpredict; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+endpoint}:streamRawPredict').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint'], + pathParams: ['endpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.endpoints.undeployModel({ + * // Required. The name of the Endpoint resource from which to undeploy a Model. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "deployedModelId": "my_deployedModelId", + * // "trafficSplit": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + undeployModel( + params: Params$Resource$Projects$Locations$Endpoints$Undeploymodel, + options: StreamMethodOptions + ): Promise>; + undeployModel( + params?: Params$Resource$Projects$Locations$Endpoints$Undeploymodel, + options?: MethodOptions + ): Promise>; + undeployModel( + params: Params$Resource$Projects$Locations$Endpoints$Undeploymodel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + undeployModel( + params: Params$Resource$Projects$Locations$Endpoints$Undeploymodel, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + undeployModel( + params: Params$Resource$Projects$Locations$Endpoints$Undeploymodel, + callback: BodyResponseCallback + ): void; + undeployModel( + callback: BodyResponseCallback + ): void; + undeployModel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Undeploymodel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Undeploymodel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Undeploymodel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+endpoint}:undeployModel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint'], + pathParams: ['endpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an Endpoint with a long running operation. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.endpoints.update({ + * // Output only. The resource name of the Endpoint. + * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "endpoint": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + update( + params: Params$Resource$Projects$Locations$Endpoints$Update, + options: StreamMethodOptions + ): Promise>; + update( + params?: Params$Resource$Projects$Locations$Endpoints$Update, + options?: MethodOptions + ): Promise>; + update( + params: Params$Resource$Projects$Locations$Endpoints$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Projects$Locations$Endpoints$Update, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Projects$Locations$Endpoints$Update, + callback: BodyResponseCallback + ): void; + update( + callback: BodyResponseCallback + ): void; + update( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Endpoints$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:update').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Endpoints$Computetokens + extends StandardParameters { + /** + * Required. The name of the Endpoint requested to get lists of tokens and token ids. + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ComputeTokensRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Counttokens + extends StandardParameters { + /** + * Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CountTokensRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Create + extends StandardParameters { + /** + * Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are `[0-9]` with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as `?endpoint_id=12345`. This is the fallback for fields that are not included in either the URI or the body. + */ + endpointId?: string; + /** + * Required. The resource name of the Location to create the Endpoint in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Endpoint; + } + export interface Params$Resource$Projects$Locations$Endpoints$Delete + extends StandardParameters { + /** + * Required. The name of the Endpoint resource to be deleted. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Endpoints$Deploymodel + extends StandardParameters { + /** + * Required. The name of the Endpoint resource into which to deploy a Model. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1DeployModelRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Directpredict + extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1DirectPredictRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Directrawpredict + extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1DirectRawPredictRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Explain + extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the explanation. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ExplainRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Fetchpredictoperation + extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1FetchPredictOperationRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Generatecontent + extends StandardParameters { + /** + * Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + model?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1GenerateContentRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Get + extends StandardParameters { + /** + * Required. The name of the Endpoint resource. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Endpoints$List + extends StandardParameters { + /** + * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports `=` and `!=`. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * `display_name` supports `=` and `!=`. * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:*` or `labels:key` - key existence * A key including a space must be quoted. `labels."a key"`. * `base_model_name` only supports `=`. Some examples: * `endpoint=1` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `baseModelName="text-bison"` + */ + filter?: string; + /** + * Optional. Configures the Google Distributed Cloud (GDC) environment for online prediction. Only set this field when the Endpoint is to be deployed in a GDC environment. + */ + gdcZone?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. + */ + orderBy?: string; + /** + * Optional. The standard list page size. + */ + pageSize?: number; + /** + * Optional. The standard list page token. Typically obtained via ListEndpointsResponse.next_page_token of the previous EndpointService.ListEndpoints call. + */ + pageToken?: string; + /** + * Required. The resource name of the Location from which to list the Endpoints. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Optional. Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel + extends StandardParameters { + /** + * Required. The name of the Endpoint resource into which to mutate a DeployedModel. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1MutateDeployedModelRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Patch + extends StandardParameters { + /** + * Output only. The resource name of the Endpoint. + */ + name?: string; + /** + * Required. The update mask applies to the resource. See google.protobuf.FieldMask. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Endpoint; + } + export interface Params$Resource$Projects$Locations$Endpoints$Predict + extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1PredictRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Predictlongrunning + extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1PredictLongRunningRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Rawpredict + extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1RawPredictRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict + extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1StreamingPredictRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent + extends StandardParameters { + /** + * Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + model?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1GenerateContentRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Streamrawpredict + extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1StreamRawPredictRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Undeploymodel + extends StandardParameters { + /** + * Required. The name of the Endpoint resource from which to undeploy a Model. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1UndeployModelRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Update + extends StandardParameters { + /** + * Output only. The resource name of the Endpoint. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1UpdateEndpointLongRunningRequest; + } + + export class Resource$Projects$Locations$Endpoints$Chat { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Exposes an OpenAI-compatible endpoint for chat completions. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.endpoints.chat.completions({ + * // Required. The name of the endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + completions( + params: Params$Resource$Projects$Locations$Endpoints$Chat$Completions, + options: StreamMethodOptions + ): Promise>; + completions( + params?: Params$Resource$Projects$Locations$Endpoints$Chat$Completions, + options?: MethodOptions + ): Promise>; + completions( + params: Params$Resource$Projects$Locations$Endpoints$Chat$Completions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + completions( + params: Params$Resource$Projects$Locations$Endpoints$Chat$Completions, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + completions( + params: Params$Resource$Projects$Locations$Endpoints$Chat$Completions, + callback: BodyResponseCallback + ): void; + completions(callback: BodyResponseCallback): void; + completions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Chat$Completions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Chat$Completions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Chat$Completions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+endpoint}/chat/completions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint'], + pathParams: ['endpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Endpoints$Chat$Completions + extends StandardParameters { + /** + * Required. The name of the endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleApiHttpBody; + } + + export class Resource$Projects$Locations$Endpoints$Deployedmodels { + context: APIRequestContext; + invoke: Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke; + constructor(context: APIRequestContext) { + this.context = context; + this.invoke = + new Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke( + this.context + ); + } + } + + export class Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.endpoints.deployedModels.invoke.invoke({ + * // ID of the DeployedModel that serves the invoke request. + * deployedModelId: 'placeholder-value', + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: + * 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * + * invokeId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "deployedModelId": "my_deployedModelId", + * // "httpBody": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + invoke( + params: Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke, + options: StreamMethodOptions + ): Promise>; + invoke( + params?: Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke, + options?: MethodOptions + ): Promise>; + invoke( + params: Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + invoke( + params: Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + invoke( + params: Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke, + callback: BodyResponseCallback + ): void; + invoke(callback: BodyResponseCallback): void; + invoke( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/{+endpoint}/deployedModels/{deployedModelId}/invoke/{+invokeId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint', 'deployedModelId', 'invokeId'], + pathParams: ['deployedModelId', 'endpoint', 'invokeId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke + extends StandardParameters { + /** + * ID of the DeployedModel that serves the invoke request. + */ + deployedModelId?: string; + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + /** + * + */ + invokeId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1InvokeRequest; + } + + export class Resource$Projects$Locations$Endpoints$Invoke { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.endpoints.invoke.invoke({ + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * + * invokeId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "deployedModelId": "my_deployedModelId", + * // "httpBody": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + invoke( + params: Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke, + options: StreamMethodOptions + ): Promise>; + invoke( + params?: Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke, + options?: MethodOptions + ): Promise>; + invoke( + params: Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + invoke( + params: Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + invoke( + params: Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke, + callback: BodyResponseCallback + ): void; + invoke(callback: BodyResponseCallback): void; + invoke( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+endpoint}/invoke/{+invokeId}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint', 'invokeId'], + pathParams: ['endpoint', 'invokeId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke + extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + /** + * + */ + invokeId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1InvokeRequest; + } + + export class Resource$Projects$Locations$Endpoints$Openapi { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.endpoints.openapi.embeddings({ + * // ID of the DeployedModel that serves the invoke request. + * deployedModelId: 'placeholder-value', + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: 'projects/my-project/locations/my-location/endpoints/openapi', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + embeddings( + params: Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings, + options: StreamMethodOptions + ): Promise>; + embeddings( + params?: Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings, + options?: MethodOptions + ): Promise>; + embeddings( + params: Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + embeddings( + params: Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + embeddings( + params: Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings, + callback: BodyResponseCallback + ): void; + embeddings(callback: BodyResponseCallback): void; + embeddings( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+endpoint}/embeddings').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint'], + pathParams: ['endpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings + extends StandardParameters { + /** + * ID of the DeployedModel that serves the invoke request. + */ + deployedModelId?: string; + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleApiHttpBody; + } + + export class Resource$Projects$Locations$Endpoints$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.endpoints.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Projects$Locations$Endpoints$Operations$Cancel, + options?: MethodOptions + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.endpoints.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Endpoints$Operations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.endpoints.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Endpoints$Operations$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.endpoints.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Endpoints$Operations$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Endpoints$Operations$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Endpoints$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Endpoints$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Endpoints$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.endpoints.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + wait( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Wait, + options: StreamMethodOptions + ): Promise>; + wait( + params?: Params$Resource$Projects$Locations$Endpoints$Operations$Wait, + options?: MethodOptions + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Operations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Endpoints$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Endpoints$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Endpoints$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Endpoints$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Endpoints$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Evaluationitems { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates an Evaluation Item. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.evaluationItems.create({ + * // Required. The resource name of the Location to create the Evaluation Item in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "error": {}, + * // "evaluationItemType": "my_evaluationItemType", + * // "evaluationRequest": {}, + * // "evaluationResponse": {}, + * // "gcsUri": "my_gcsUri", + * // "labels": {}, + * // "metadata": {}, + * // "name": "my_name" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "error": {}, + * // "evaluationItemType": "my_evaluationItemType", + * // "evaluationRequest": {}, + * // "evaluationResponse": {}, + * // "gcsUri": "my_gcsUri", + * // "labels": {}, + * // "metadata": {}, + * // "name": "my_name" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Evaluationitems$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Evaluationitems$Create, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Evaluationitems$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Evaluationitems$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Evaluationitems$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationitems$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationitems$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Evaluationitems$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/evaluationItems').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Deletes an Evaluation Item. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.evaluationItems.delete({ + * // Required. The name of the EvaluationItem resource to be deleted. Format: `projects/{project\}/locations/{location\}/evaluationItems/{evaluation_item\}` + * name: 'projects/my-project/locations/my-location/evaluationItems/my-evaluationItem', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Evaluationitems$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Evaluationitems$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Evaluationitems$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Evaluationitems$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Evaluationitems$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationitems$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationitems$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Evaluationitems$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets an Evaluation Item. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.evaluationItems.get({ + * // Required. The name of the EvaluationItem resource. Format: `projects/{project\}/locations/{location\}/evaluationItems/{evaluation_item\}` + * name: 'projects/my-project/locations/my-location/evaluationItems/my-evaluationItem', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "error": {}, + * // "evaluationItemType": "my_evaluationItemType", + * // "evaluationRequest": {}, + * // "evaluationResponse": {}, + * // "gcsUri": "my_gcsUri", + * // "labels": {}, + * // "metadata": {}, + * // "name": "my_name" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Evaluationitems$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Evaluationitems$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Evaluationitems$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Evaluationitems$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Evaluationitems$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationitems$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationitems$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Evaluationitems$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists Evaluation Items. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.evaluationItems.list({ + * // Optional. Filter expression that matches a subset of the EvaluationItems to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160). + * filter: 'placeholder-value', + * // Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. + * orderBy: 'placeholder-value', + * // Optional. The maximum number of Evaluation Items to return. + * pageSize: 'placeholder-value', + * // Optional. A page token, received from a previous `ListEvaluationItems` call. Provide this to retrieve the subsequent page. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location from which to list the Evaluation Items. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "evaluationItems": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Evaluationitems$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Evaluationitems$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Evaluationitems$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Evaluationitems$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Evaluationitems$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationitems$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationitems$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Evaluationitems$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/evaluationItems').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Evaluationitems$Create + extends StandardParameters { + /** + * Required. The resource name of the Location to create the Evaluation Item in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1EvaluationItem; + } + export interface Params$Resource$Projects$Locations$Evaluationitems$Delete + extends StandardParameters { + /** + * Required. The name of the EvaluationItem resource to be deleted. Format: `projects/{project\}/locations/{location\}/evaluationItems/{evaluation_item\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Evaluationitems$Get + extends StandardParameters { + /** + * Required. The name of the EvaluationItem resource. Format: `projects/{project\}/locations/{location\}/evaluationItems/{evaluation_item\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Evaluationitems$List + extends StandardParameters { + /** + * Optional. Filter expression that matches a subset of the EvaluationItems to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160). + */ + filter?: string; + /** + * Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. + */ + orderBy?: string; + /** + * Optional. The maximum number of Evaluation Items to return. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListEvaluationItems` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The resource name of the Location from which to list the Evaluation Items. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + + export class Resource$Projects$Locations$Evaluationruns { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Cancels an Evaluation Run. Attempts to cancel a running Evaluation Run asynchronously. Status of run can be checked via GetEvaluationRun. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.evaluationRuns.cancel({ + * // Required. The name of the EvaluationRun resource to be cancelled. Format: `projects/{project\}/locations/{location\}/evaluationRuns/{evaluation_run\}` + * name: 'projects/my-project/locations/my-location/evaluationRuns/my-evaluationRun', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Evaluationruns$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Projects$Locations$Evaluationruns$Cancel, + options?: MethodOptions + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Evaluationruns$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Evaluationruns$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Evaluationruns$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationruns$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationruns$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Evaluationruns$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates an Evaluation Run. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.evaluationRuns.create({ + * // Required. The resource name of the Location to create the Evaluation Run in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "completionTime": "my_completionTime", + * // "createTime": "my_createTime", + * // "dataSource": {}, + * // "displayName": "my_displayName", + * // "error": {}, + * // "evaluationConfig": {}, + * // "evaluationResults": {}, + * // "evaluationSetSnapshot": "my_evaluationSetSnapshot", + * // "inferenceConfigs": {}, + * // "labels": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "state": "my_state" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "completionTime": "my_completionTime", + * // "createTime": "my_createTime", + * // "dataSource": {}, + * // "displayName": "my_displayName", + * // "error": {}, + * // "evaluationConfig": {}, + * // "evaluationResults": {}, + * // "evaluationSetSnapshot": "my_evaluationSetSnapshot", + * // "inferenceConfigs": {}, + * // "labels": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "state": "my_state" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Evaluationruns$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Evaluationruns$Create, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Evaluationruns$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Evaluationruns$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Evaluationruns$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationruns$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationruns$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Evaluationruns$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/evaluationRuns').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Deletes an Evaluation Run. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.evaluationRuns.delete({ + * // Required. The name of the EvaluationRun resource to be deleted. Format: `projects/{project\}/locations/{location\}/evaluationRuns/{evaluation_run\}` + * name: 'projects/my-project/locations/my-location/evaluationRuns/my-evaluationRun', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Evaluationruns$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Evaluationruns$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Evaluationruns$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Evaluationruns$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Evaluationruns$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationruns$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationruns$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Evaluationruns$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets an Evaluation Run. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.evaluationRuns.get({ + * // Required. The name of the EvaluationRun resource. Format: `projects/{project\}/locations/{location\}/evaluationRuns/{evaluation_run\}` + * name: 'projects/my-project/locations/my-location/evaluationRuns/my-evaluationRun', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "completionTime": "my_completionTime", + * // "createTime": "my_createTime", + * // "dataSource": {}, + * // "displayName": "my_displayName", + * // "error": {}, + * // "evaluationConfig": {}, + * // "evaluationResults": {}, + * // "evaluationSetSnapshot": "my_evaluationSetSnapshot", + * // "inferenceConfigs": {}, + * // "labels": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "state": "my_state" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Evaluationruns$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Evaluationruns$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Evaluationruns$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Evaluationruns$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Evaluationruns$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationruns$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationruns$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Evaluationruns$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists Evaluation Runs. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.evaluationRuns.list({ + * // Optional. Filter expression that matches a subset of the EvaluationRuns to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160). + * filter: 'placeholder-value', + * // Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. + * orderBy: 'placeholder-value', + * // Optional. The maximum number of Evaluation Runs to return. + * pageSize: 'placeholder-value', + * // Optional. A page token, received from a previous `ListEvaluationRuns` call. Provide this to retrieve the subsequent page. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location from which to list the Evaluation Runs. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "evaluationRuns": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Evaluationruns$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Evaluationruns$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Evaluationruns$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Evaluationruns$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Evaluationruns$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationruns$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationruns$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Evaluationruns$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/evaluationRuns').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Evaluationruns$Cancel + extends StandardParameters { + /** + * Required. The name of the EvaluationRun resource to be cancelled. Format: `projects/{project\}/locations/{location\}/evaluationRuns/{evaluation_run\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CancelEvaluationRunRequest; + } + export interface Params$Resource$Projects$Locations$Evaluationruns$Create + extends StandardParameters { + /** + * Required. The resource name of the Location to create the Evaluation Run in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1EvaluationRun; + } + export interface Params$Resource$Projects$Locations$Evaluationruns$Delete + extends StandardParameters { + /** + * Required. The name of the EvaluationRun resource to be deleted. Format: `projects/{project\}/locations/{location\}/evaluationRuns/{evaluation_run\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Evaluationruns$Get + extends StandardParameters { + /** + * Required. The name of the EvaluationRun resource. Format: `projects/{project\}/locations/{location\}/evaluationRuns/{evaluation_run\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Evaluationruns$List + extends StandardParameters { + /** + * Optional. Filter expression that matches a subset of the EvaluationRuns to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160). + */ + filter?: string; + /** + * Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. + */ + orderBy?: string; + /** + * Optional. The maximum number of Evaluation Runs to return. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListEvaluationRuns` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The resource name of the Location from which to list the Evaluation Runs. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + + export class Resource$Projects$Locations$Evaluationsets { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates an Evaluation Set. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.evaluationSets.create({ + * // Required. The resource name of the Location to create the Evaluation Set in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "evaluationItems": [], + * // "metadata": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "evaluationItems": [], + * // "metadata": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Evaluationsets$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Evaluationsets$Create, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Evaluationsets$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Evaluationsets$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Evaluationsets$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationsets$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationsets$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Evaluationsets$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/evaluationSets').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Deletes an Evaluation Set. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.evaluationSets.delete({ + * // Required. The name of the EvaluationSet resource to be deleted. Format: `projects/{project\}/locations/{location\}/evaluationSets/{evaluation_set\}` + * name: 'projects/my-project/locations/my-location/evaluationSets/my-evaluationSet', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Evaluationsets$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Evaluationsets$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Evaluationsets$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Evaluationsets$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Evaluationsets$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationsets$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationsets$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Evaluationsets$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets an Evaluation Set. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.evaluationSets.get({ + * // Required. The name of the EvaluationSet resource. Format: `projects/{project\}/locations/{location\}/evaluationSets/{evaluation_set\}` + * name: 'projects/my-project/locations/my-location/evaluationSets/my-evaluationSet', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "evaluationItems": [], + * // "metadata": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Evaluationsets$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Evaluationsets$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Evaluationsets$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Evaluationsets$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Evaluationsets$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationsets$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationsets$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Evaluationsets$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists Evaluation Sets. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.evaluationSets.list({ + * // Optional. Filter expression that matches a subset of the EvaluationSets to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160). + * filter: 'placeholder-value', + * // Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. + * orderBy: 'placeholder-value', + * // Optional. The maximum number of Evaluation Sets to return. + * pageSize: 'placeholder-value', + * // Optional. A page token, received from a previous `ListEvaluationSets` call. Provide this to retrieve the subsequent page. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location from which to list the Evaluation Sets. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "evaluationSets": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Evaluationsets$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Evaluationsets$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Evaluationsets$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Evaluationsets$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Evaluationsets$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationsets$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationsets$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Evaluationsets$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/evaluationSets').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates an Evaluation Set. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.evaluationSets.patch({ + * // Identifier. The resource name of the EvaluationSet. Format: `projects/{project\}/locations/{location\}/evaluationSets/{evaluation_set\}` + * name: 'projects/my-project/locations/my-location/evaluationSets/my-evaluationSet', + * // Optional. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "evaluationItems": [], + * // "metadata": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "evaluationItems": [], + * // "metadata": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Evaluationsets$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Evaluationsets$Patch, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + patch( + params: Params$Resource$Projects$Locations$Evaluationsets$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Evaluationsets$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Evaluationsets$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationsets$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationsets$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Evaluationsets$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Evaluationsets$Create + extends StandardParameters { + /** + * Required. The resource name of the Location to create the Evaluation Set in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1EvaluationSet; + } + export interface Params$Resource$Projects$Locations$Evaluationsets$Delete + extends StandardParameters { + /** + * Required. The name of the EvaluationSet resource to be deleted. Format: `projects/{project\}/locations/{location\}/evaluationSets/{evaluation_set\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Evaluationsets$Get + extends StandardParameters { + /** + * Required. The name of the EvaluationSet resource. Format: `projects/{project\}/locations/{location\}/evaluationSets/{evaluation_set\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Evaluationsets$List + extends StandardParameters { + /** + * Optional. Filter expression that matches a subset of the EvaluationSets to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160). + */ + filter?: string; + /** + * Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. + */ + orderBy?: string; + /** + * Optional. The maximum number of Evaluation Sets to return. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListEvaluationSets` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The resource name of the Location from which to list the Evaluation Sets. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Evaluationsets$Patch + extends StandardParameters { + /** + * Identifier. The resource name of the EvaluationSet. Format: `projects/{project\}/locations/{location\}/evaluationSets/{evaluation_set\}` + */ + name?: string; + /** + * Optional. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1EvaluationSet; + } + + export class Resource$Projects$Locations$Featuregroups { + context: APIRequestContext; + features: Resource$Projects$Locations$Featuregroups$Features; + operations: Resource$Projects$Locations$Featuregroups$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.features = new Resource$Projects$Locations$Featuregroups$Features( + this.context + ); + this.operations = + new Resource$Projects$Locations$Featuregroups$Operations(this.context); + } + + /** + * Creates a new FeatureGroup in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.featureGroups.create({ + * // Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location. + * featureGroupId: 'placeholder-value', + * // Required. The resource name of the Location to create FeatureGroups. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bigQuery": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "serviceAccountEmail": "my_serviceAccountEmail", + * // "serviceAgentType": "my_serviceAgentType", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Featuregroups$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Featuregroups$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Featuregroups$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Featuregroups$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Featuregroups$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Featuregroups$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/featureGroups').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single FeatureGroup. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.featureGroups.delete({ + * // If set to true, any Features under this FeatureGroup will also be deleted. (Otherwise, the request will only work if the FeatureGroup has no Features.) + * force: 'placeholder-value', + * // Required. The name of the FeatureGroup to be deleted. Format: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Featuregroups$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Featuregroups$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a single FeatureGroup. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.featureGroups.get({ + * // Required. The name of the FeatureGroup resource. + * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "bigQuery": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "serviceAccountEmail": "my_serviceAccountEmail", + * // "serviceAgentType": "my_serviceAgentType", + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Featuregroups$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Featuregroups$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Featuregroups$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featuregroups$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featuregroups$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Featuregroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.featureGroups.getIamPolicy({ + * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + * 'options.requestedPolicyVersion': 'placeholder-value', + * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/featureGroups/my-featureGroup', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Projects$Locations$Featuregroups$Getiampolicy, + options: StreamMethodOptions + ): Promise>; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Featuregroups$Getiampolicy, + options?: MethodOptions + ): Promise>; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featuregroups$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featuregroups$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featuregroups$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy( + callback: BodyResponseCallback + ): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists FeatureGroups in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.featureGroups.list({ + * // Lists the FeatureGroups that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time \> "2020-01-01" OR update_time \> "2020-01-01"` FeatureGroups created or updated after 2020-01-01. * `labels.env = "prod"` FeatureGroups with label "env" set to "prod". + * filter: 'placeholder-value', + * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time` * `update_time` + * orderBy: 'placeholder-value', + * // The maximum number of FeatureGroups to return. The service may return fewer than this value. If unspecified, at most 100 FeatureGroups will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. + * pageSize: 'placeholder-value', + * // A page token, received from a previous FeatureRegistryService.ListFeatureGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureGroups must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location to list FeatureGroups. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "featureGroups": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Featuregroups$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Featuregroups$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Featuregroups$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featuregroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featuregroups$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Featuregroups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/featureGroups').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates the parameters of a single FeatureGroup. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.featureGroups.patch({ + * // Identifier. Name of the FeatureGroup. Format: `projects/{project\}/locations/{location\}/featureGroups/{featureGroup\}` + * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup', + * // Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` * `service_agent_type` + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bigQuery": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "serviceAccountEmail": "my_serviceAccountEmail", + * // "serviceAgentType": "my_serviceAgentType", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Featuregroups$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Featuregroups$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Featuregroups$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Featuregroups$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Featuregroups$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Featuregroups$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.featureGroups.setIamPolicy({ + * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/featureGroups/my-featureGroup', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "policy": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Locations$Featuregroups$Setiampolicy, + options: StreamMethodOptions + ): Promise>; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Featuregroups$Setiampolicy, + options?: MethodOptions + ): Promise>; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featuregroups$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featuregroups$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featuregroups$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy( + callback: BodyResponseCallback + ): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featureGroups.testIamPermissions({ + * // The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * permissions: 'placeholder-value', + * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/featureGroups/my-featureGroup', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "permissions": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + testIamPermissions( + params: Params$Resource$Projects$Locations$Featuregroups$Testiampermissions, + options: StreamMethodOptions + ): Promise>; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Featuregroups$Testiampermissions, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featuregroups$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featuregroups$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featuregroups$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Featuregroups$Create + extends StandardParameters { + /** + * Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location. + */ + featureGroupId?: string; + /** + * Required. The resource name of the Location to create FeatureGroups. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1FeatureGroup; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Delete + extends StandardParameters { + /** + * If set to true, any Features under this FeatureGroup will also be deleted. (Otherwise, the request will only work if the FeatureGroup has no Features.) + */ + force?: boolean; + /** + * Required. The name of the FeatureGroup to be deleted. Format: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Get + extends StandardParameters { + /** + * Required. The name of the FeatureGroup resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$List + extends StandardParameters { + /** + * Lists the FeatureGroups that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time \> "2020-01-01" OR update_time \> "2020-01-01"` FeatureGroups created or updated after 2020-01-01. * `labels.env = "prod"` FeatureGroups with label "env" set to "prod". + */ + filter?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time` * `update_time` + */ + orderBy?: string; + /** + * The maximum number of FeatureGroups to return. The service may return fewer than this value. If unspecified, at most 100 FeatureGroups will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. + */ + pageSize?: number; + /** + * A page token, received from a previous FeatureRegistryService.ListFeatureGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureGroups must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list FeatureGroups. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Patch + extends StandardParameters { + /** + * Identifier. Name of the FeatureGroup. Format: `projects/{project\}/locations/{location\}/featureGroups/{featureGroup\}` + */ + name?: string; + /** + * Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` * `service_agent_type` + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1FeatureGroup; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Testiampermissions + extends StandardParameters { + /** + * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + */ + permissions?: string[]; + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + + export class Resource$Projects$Locations$Featuregroups$Features { + context: APIRequestContext; + operations: Resource$Projects$Locations$Featuregroups$Features$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Featuregroups$Features$Operations( + this.context + ); + } + + /** + * Creates a batch of Features in a given FeatureGroup. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featureGroups.features.batchCreate({ + * // Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + * parent: + * 'projects/my-project/locations/my-location/featureGroups/my-featureGroup', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "requests": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + batchCreate( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate, + options: StreamMethodOptions + ): Promise>; + batchCreate( + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate, + options?: MethodOptions + ): Promise>; + batchCreate( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchCreate( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchCreate( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate, + callback: BodyResponseCallback + ): void; + batchCreate( + callback: BodyResponseCallback + ): void; + batchCreate( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/features:batchCreate').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a new Feature in a given FeatureGroup. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.featureGroups.features.create( + * { + * // Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup. + * featureId: 'placeholder-value', + * // Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + * parent: + * 'projects/my-project/locations/my-location/featureGroups/my-featureGroup', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "disableMonitoring": false, + * // "etag": "my_etag", + * // "labels": {}, + * // "monitoringStatsAnomalies": [], + * // "name": "my_name", + * // "pointOfContact": "my_pointOfContact", + * // "updateTime": "my_updateTime", + * // "valueType": "my_valueType", + * // "versionColumnName": "my_versionColumnName" + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Features$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/features').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single Feature. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.featureGroups.features.delete( + * { + * // Required. The name of the Features to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` + * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/features/my-feature', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Features$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a single Feature. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.featureGroups.features.get({ + * // Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/features/my-feature', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "disableMonitoring": false, + * // "etag": "my_etag", + * // "labels": {}, + * // "monitoringStatsAnomalies": [], + * // "name": "my_name", + * // "pointOfContact": "my_pointOfContact", + * // "updateTime": "my_updateTime", + * // "valueType": "my_valueType", + * // "versionColumnName": "my_versionColumnName" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Features$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists Features in a given FeatureGroup. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.featureGroups.features.list({ + * // Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --\> Features whose type is DOUBLE. * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any Feature which has a label with 'env' as the key. + * filter: 'placeholder-value', + * // Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats. + * latestStatsCount: 'placeholder-value', + * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time` + * orderBy: 'placeholder-value', + * // The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + * parent: + * 'projects/my-project/locations/my-location/featureGroups/my-featureGroup', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "features": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Featuregroups$Features$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Featuregroups$Features$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Featuregroups$Features$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featuregroups$Features$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featuregroups$Features$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Features$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Features$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/features').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates the parameters of a single Feature. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.featureGroups.features.patch({ + * // Immutable. Name of the Feature. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type. + * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/features/my-feature', + * // Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore) + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "disableMonitoring": false, + * // "etag": "my_etag", + * // "labels": {}, + * // "monitoringStatsAnomalies": [], + * // "name": "my_name", + * // "pointOfContact": "my_pointOfContact", + * // "updateTime": "my_updateTime", + * // "valueType": "my_valueType", + * // "versionColumnName": "my_versionColumnName" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Features$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate + extends StandardParameters { + /** + * Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1BatchCreateFeaturesRequest; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Features$Create + extends StandardParameters { + /** + * Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup. + */ + featureId?: string; + /** + * Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Feature; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Features$Delete + extends StandardParameters { + /** + * Required. The name of the Features to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Features$Get + extends StandardParameters { + /** + * Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Features$List + extends StandardParameters { + /** + * Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --\> Features whose type is DOUBLE. * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any Feature which has a label with 'env' as the key. + */ + filter?: string; + /** + * Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats. + */ + latestStatsCount?: number; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time` + */ + orderBy?: string; + /** + * The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Features$Patch + extends StandardParameters { + /** + * Immutable. Name of the Feature. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type. + */ + name?: string; + /** + * Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore) + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Feature; + } + + export class Resource$Projects$Locations$Featuregroups$Features$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featureGroups.features.operations.delete( + * { + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/features/my-feature/operations/my-operation', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featureGroups.features.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/features/my-feature/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featureGroups.features.operations.listWait( + * { + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/features/my-feature/operations/my-operation', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + listWait( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait, + options: StreamMethodOptions + ): Promise>; + listWait( + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + listWait( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listWait( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listWait( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait, + callback: BodyResponseCallback + ): void; + listWait( + callback: BodyResponseCallback + ): void; + listWait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featureGroups.features.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/features/my-feature/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + wait( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, + options: StreamMethodOptions + ): Promise>; + wait( + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, + options?: MethodOptions + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Featuregroups$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featureGroups.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.featureGroups.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featureGroups.operations.listWait({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/operations/my-operation', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + listWait( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait, + options: StreamMethodOptions + ): Promise>; + listWait( + params?: Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + listWait( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listWait( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listWait( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait, + callback: BodyResponseCallback + ): void; + listWait( + callback: BodyResponseCallback + ): void; + listWait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.featureGroups.operations.wait( + * { + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + wait( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, + options: StreamMethodOptions + ): Promise>; + wait( + params?: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, + options?: MethodOptions + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Operations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Featuregroups$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Featureonlinestores { + context: APIRequestContext; + featureViews: Resource$Projects$Locations$Featureonlinestores$Featureviews; + operations: Resource$Projects$Locations$Featureonlinestores$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.featureViews = + new Resource$Projects$Locations$Featureonlinestores$Featureviews( + this.context + ); + this.operations = + new Resource$Projects$Locations$Featureonlinestores$Operations( + this.context + ); + } + + /** + * Creates a new FeatureOnlineStore in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.featureOnlineStores.create({ + * // Required. The ID to use for this FeatureOnlineStore, which will become the final component of the FeatureOnlineStore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location. + * featureOnlineStoreId: 'placeholder-value', + * // Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bigtable": {}, + * // "createTime": "my_createTime", + * // "dedicatedServingEndpoint": {}, + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "optimized": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Featureonlinestores$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Featureonlinestores$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Featureonlinestores$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Featureonlinestores$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/featureOnlineStores').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not contain any FeatureViews. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.featureOnlineStores.delete({ + * // If set to true, any FeatureViews and Features for this FeatureOnlineStore will also be deleted. (Otherwise, the request will only work if the FeatureOnlineStore has no FeatureViews.) + * force: 'placeholder-value', + * // Required. The name of the FeatureOnlineStore to be deleted. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}` + * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a single FeatureOnlineStore. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.featureOnlineStores.get({ + * // Required. The name of the FeatureOnlineStore resource. + * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "bigtable": {}, + * // "createTime": "my_createTime", + * // "dedicatedServingEndpoint": {}, + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "optimized": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featureOnlineStores.getIamPolicy({ + * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + * 'options.requestedPolicyVersion': 'placeholder-value', + * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy, + options: StreamMethodOptions + ): Promise>; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy, + options?: MethodOptions + ): Promise>; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy( + callback: BodyResponseCallback + ): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists FeatureOnlineStores in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.featureOnlineStores.list({ + * // Lists the FeatureOnlineStores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time \> "2020-01-01" OR update_time \> "2020-01-01"` FeatureOnlineStores created or updated after 2020-01-01. * `labels.env = "prod"` FeatureOnlineStores with label "env" set to "prod". + * filter: 'placeholder-value', + * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time` * `update_time` + * orderBy: 'placeholder-value', + * // The maximum number of FeatureOnlineStores to return. The service may return fewer than this value. If unspecified, at most 100 FeatureOnlineStores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. + * pageSize: 'placeholder-value', + * // A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureOnlineStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureOnlineStores must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location to list FeatureOnlineStores. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "featureOnlineStores": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Featureonlinestores$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/featureOnlineStores').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates the parameters of a single FeatureOnlineStore. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.featureOnlineStores.patch({ + * // Identifier. Name of the FeatureOnlineStore. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}` + * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore', + * // Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `bigtable` * `bigtable.auto_scaling` * `bigtable.enable_multi_region_replica` + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bigtable": {}, + * // "createTime": "my_createTime", + * // "dedicatedServingEndpoint": {}, + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "optimized": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Featureonlinestores$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Featureonlinestores$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Featureonlinestores$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Featureonlinestores$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featureOnlineStores.setIamPolicy({ + * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "policy": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy, + options: StreamMethodOptions + ): Promise>; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy, + options?: MethodOptions + ): Promise>; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy( + callback: BodyResponseCallback + ): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featureOnlineStores.testIamPermissions({ + * // The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * permissions: 'placeholder-value', + * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "permissions": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + testIamPermissions( + params: Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions, + options: StreamMethodOptions + ): Promise>; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Featureonlinestores$Create + extends StandardParameters { + /** + * Required. The ID to use for this FeatureOnlineStore, which will become the final component of the FeatureOnlineStore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location. + */ + featureOnlineStoreId?: string; + /** + * Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1FeatureOnlineStore; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Delete + extends StandardParameters { + /** + * If set to true, any FeatureViews and Features for this FeatureOnlineStore will also be deleted. (Otherwise, the request will only work if the FeatureOnlineStore has no FeatureViews.) + */ + force?: boolean; + /** + * Required. The name of the FeatureOnlineStore to be deleted. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Get + extends StandardParameters { + /** + * Required. The name of the FeatureOnlineStore resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$List + extends StandardParameters { + /** + * Lists the FeatureOnlineStores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time \> "2020-01-01" OR update_time \> "2020-01-01"` FeatureOnlineStores created or updated after 2020-01-01. * `labels.env = "prod"` FeatureOnlineStores with label "env" set to "prod". + */ + filter?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time` * `update_time` + */ + orderBy?: string; + /** + * The maximum number of FeatureOnlineStores to return. The service may return fewer than this value. If unspecified, at most 100 FeatureOnlineStores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. + */ + pageSize?: number; + /** + * A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureOnlineStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureOnlineStores must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list FeatureOnlineStores. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Patch + extends StandardParameters { + /** + * Identifier. Name of the FeatureOnlineStore. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}` + */ + name?: string; + /** + * Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `bigtable` * `bigtable.auto_scaling` * `bigtable.enable_multi_region_replica` + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1FeatureOnlineStore; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions + extends StandardParameters { + /** + * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + */ + permissions?: string[]; + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + + export class Resource$Projects$Locations$Featureonlinestores$Featureviews { + context: APIRequestContext; + featureViewSyncs: Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs; + operations: Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.featureViewSyncs = + new Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs( + this.context + ); + this.operations = + new Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations( + this.context + ); + } + + /** + * Creates a new FeatureView in a given FeatureOnlineStore. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featureOnlineStores.featureViews.create( + * { + * // Required. The ID to use for the FeatureView, which will become the final component of the FeatureView's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a FeatureOnlineStore. + * featureViewId: 'placeholder-value', + * // Required. The resource name of the FeatureOnlineStore to create FeatureViews. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}` + * parent: + * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore', + * // Immutable. If set to true, one on demand sync will be run immediately, regardless whether the FeatureView.sync_config is configured or not. + * runSyncImmediately: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bigQuerySource": {}, + * // "bigtableMetadata": {}, + * // "createTime": "my_createTime", + * // "etag": "my_etag", + * // "featureRegistrySource": {}, + * // "indexConfig": {}, + * // "labels": {}, + * // "name": "my_name", + * // "optimizedConfig": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "serviceAccountEmail": "my_serviceAccountEmail", + * // "serviceAgentType": "my_serviceAgentType", + * // "syncConfig": {}, + * // "updateTime": "my_updateTime", + * // "vertexRagSource": {} + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/featureViews').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single FeatureView. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featureOnlineStores.featureViews.delete( + * { + * // Required. The name of the FeatureView to be deleted. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` + * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Bidirectional streaming RPC to directly write to feature values in a feature view. Requests may not have a one-to-one mapping to responses and responses may be returned out-of-order to reduce latency. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featureOnlineStores.featureViews.directWrite( + * { + * // FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` + * featureView: + * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "dataKeyAndFeatureValues": [] + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "status": {}, + * // "writeResponses": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + directWrite( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite, + options: StreamMethodOptions + ): Promise>; + directWrite( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + directWrite( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + directWrite( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + directWrite( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite, + callback: BodyResponseCallback + ): void; + directWrite( + callback: BodyResponseCallback + ): void; + directWrite( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+featureView}:directWrite').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['featureView'], + pathParams: ['featureView'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Fetch feature values under a FeatureView. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featureOnlineStores.featureViews.fetchFeatureValues( + * { + * // Required. FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` + * featureView: + * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "dataFormat": "my_dataFormat", + * // "dataKey": {} + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "dataKey": {}, + * // "keyValues": {}, + * // "protoStruct": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + fetchFeatureValues( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, + options: StreamMethodOptions + ): Promise>; + fetchFeatureValues( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + fetchFeatureValues( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchFeatureValues( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchFeatureValues( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, + callback: BodyResponseCallback + ): void; + fetchFeatureValues( + callback: BodyResponseCallback + ): void; + fetchFeatureValues( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+featureView}:fetchFeatureValues').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['featureView'], + pathParams: ['featureView'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * RPC to generate an access token for the given feature view. FeatureViews under the same FeatureOnlineStore share the same access token. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featureOnlineStores.featureViews.generateFetchAccessToken( + * { + * // FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` + * featureView: + * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "accessToken": "my_accessToken", + * // "expireTime": "my_expireTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + generateFetchAccessToken( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Generatefetchaccesstoken, + options: StreamMethodOptions + ): Promise>; + generateFetchAccessToken( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Generatefetchaccesstoken, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + generateFetchAccessToken( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Generatefetchaccesstoken, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateFetchAccessToken( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Generatefetchaccesstoken, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateFetchAccessToken( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Generatefetchaccesstoken, + callback: BodyResponseCallback + ): void; + generateFetchAccessToken( + callback: BodyResponseCallback + ): void; + generateFetchAccessToken( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Generatefetchaccesstoken + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Generatefetchaccesstoken; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Generatefetchaccesstoken; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+featureView}:generateFetchAccessToken' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['featureView'], + pathParams: ['featureView'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets details of a single FeatureView. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featureOnlineStores.featureViews.get({ + * // Required. The name of the FeatureView resource. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` + * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "bigQuerySource": {}, + * // "bigtableMetadata": {}, + * // "createTime": "my_createTime", + * // "etag": "my_etag", + * // "featureRegistrySource": {}, + * // "indexConfig": {}, + * // "labels": {}, + * // "name": "my_name", + * // "optimizedConfig": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "serviceAccountEmail": "my_serviceAccountEmail", + * // "serviceAgentType": "my_serviceAgentType", + * // "syncConfig": {}, + * // "updateTime": "my_updateTime", + * // "vertexRagSource": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featureOnlineStores.featureViews.getIamPolicy( + * { + * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + * 'options.requestedPolicyVersion': 'placeholder-value', + * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy, + options: StreamMethodOptions + ): Promise>; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy, + options?: MethodOptions + ): Promise>; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy( + callback: BodyResponseCallback + ): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists FeatureViews in a given FeatureOnlineStore. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featureOnlineStores.featureViews.list({ + * // Lists the FeatureViews that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> FeatureViews created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> FeatureViews having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any FeatureView which has a label with 'env' as the key. + * filter: 'placeholder-value', + * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `feature_view_id` * `create_time` * `update_time` + * orderBy: 'placeholder-value', + * // The maximum number of FeatureViews to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViews will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViews call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViews must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The resource name of the FeatureOnlineStore to list FeatureViews. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}` + * parent: + * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "featureViews": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/featureViews').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates the parameters of a single FeatureView. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featureOnlineStores.featureViews.patch({ + * // Identifier. Name of the FeatureView. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` + * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', + * // Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `service_agent_type` * `big_query_source` * `big_query_source.uri` * `big_query_source.entity_id_columns` * `feature_registry_source` * `feature_registry_source.feature_groups` * `sync_config` * `sync_config.cron` * `optimized_config.automatic_resources` + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bigQuerySource": {}, + * // "bigtableMetadata": {}, + * // "createTime": "my_createTime", + * // "etag": "my_etag", + * // "featureRegistrySource": {}, + * // "indexConfig": {}, + * // "labels": {}, + * // "name": "my_name", + * // "optimizedConfig": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "serviceAccountEmail": "my_serviceAccountEmail", + * // "serviceAgentType": "my_serviceAgentType", + * // "syncConfig": {}, + * // "updateTime": "my_updateTime", + * // "vertexRagSource": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Search the nearest entities under a FeatureView. Search only works for indexable feature view; if a feature view isn't indexable, returns Invalid argument response. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featureOnlineStores.featureViews.searchNearestEntities( + * { + * // Required. FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` + * featureView: + * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "query": {}, + * // "returnFullEntity": false + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "nearestNeighbors": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + searchNearestEntities( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities, + options: StreamMethodOptions + ): Promise>; + searchNearestEntities( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + searchNearestEntities( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchNearestEntities( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchNearestEntities( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities, + callback: BodyResponseCallback + ): void; + searchNearestEntities( + callback: BodyResponseCallback + ): void; + searchNearestEntities( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+featureView}:searchNearestEntities').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['featureView'], + pathParams: ['featureView'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featureOnlineStores.featureViews.setIamPolicy( + * { + * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "policy": {} + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy, + options: StreamMethodOptions + ): Promise>; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy, + options?: MethodOptions + ): Promise>; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy( + callback: BodyResponseCallback + ): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Triggers on-demand sync for the FeatureView. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featureOnlineStores.featureViews.sync({ + * // Required. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` + * featureView: + * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "featureViewSync": "my_featureViewSync" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + sync( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, + options: StreamMethodOptions + ): Promise>; + sync( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + sync( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + sync( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + sync( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, + callback: BodyResponseCallback + ): void; + sync( + callback: BodyResponseCallback + ): void; + sync( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+featureView}:sync').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['featureView'], + pathParams: ['featureView'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featureOnlineStores.featureViews.testIamPermissions( + * { + * // The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * permissions: 'placeholder-value', + * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "permissions": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + testIamPermissions( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions, + options: StreamMethodOptions + ): Promise>; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create + extends StandardParameters { + /** + * Required. The ID to use for the FeatureView, which will become the final component of the FeatureView's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a FeatureOnlineStore. + */ + featureViewId?: string; + /** + * Required. The resource name of the FeatureOnlineStore to create FeatureViews. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}` + */ + parent?: string; + /** + * Immutable. If set to true, one on demand sync will be run immediately, regardless whether the FeatureView.sync_config is configured or not. + */ + runSyncImmediately?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1FeatureView; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete + extends StandardParameters { + /** + * Required. The name of the FeatureView to be deleted. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite + extends StandardParameters { + /** + * FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` + */ + featureView?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1FeatureViewDirectWriteRequest; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues + extends StandardParameters { + /** + * Required. FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` + */ + featureView?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1FetchFeatureValuesRequest; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Generatefetchaccesstoken + extends StandardParameters { + /** + * FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` + */ + featureView?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1GenerateFetchAccessTokenRequest; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get + extends StandardParameters { + /** + * Required. The name of the FeatureView resource. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List + extends StandardParameters { + /** + * Lists the FeatureViews that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> FeatureViews created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> FeatureViews having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any FeatureView which has a label with 'env' as the key. + */ + filter?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `feature_view_id` * `create_time` * `update_time` + */ + orderBy?: string; + /** + * The maximum number of FeatureViews to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViews will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViews call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViews must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the FeatureOnlineStore to list FeatureViews. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch + extends StandardParameters { + /** + * Identifier. Name of the FeatureView. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` + */ + name?: string; + /** + * Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `service_agent_type` * `big_query_source` * `big_query_source.uri` * `big_query_source.entity_id_columns` * `feature_registry_source` * `feature_registry_source.feature_groups` * `sync_config` * `sync_config.cron` * `optimized_config.automatic_resources` + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1FeatureView; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities + extends StandardParameters { + /** + * Required. FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` + */ + featureView?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1SearchNearestEntitiesRequest; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync + extends StandardParameters { + /** + * Required. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` + */ + featureView?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1SyncFeatureViewRequest; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions + extends StandardParameters { + /** + * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + */ + permissions?: string[]; + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + + export class Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets details of a single FeatureViewSync. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.get( + * { + * // Required. The name of the FeatureViewSync resource. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}/featureViewSyncs/{feature_view_sync\}` + * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView/featureViewSyncs/my-featureViewSync', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "finalStatus": {}, + * // "name": "my_name", + * // "runTime": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "syncSummary": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists FeatureViewSyncs in a given FeatureView. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.list( + * { + * // Lists the FeatureViewSyncs that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. Examples: * `create_time \> \"2020-01-31T15:30:00.000000Z\"` --\> FeatureViewSyncs created after 2020-01-31T15:30:00.000000Z. + * filter: 'placeholder-value', + * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `create_time` + * orderBy: 'placeholder-value', + * // The maximum number of FeatureViewSyncs to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViewSyncs will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViewSyncs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViewSyncs must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The resource name of the FeatureView to list FeatureViewSyncs. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` + * parent: + * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "featureViewSyncs": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/featureViewSyncs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get + extends StandardParameters { + /** + * Required. The name of the FeatureViewSync resource. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}/featureViewSyncs/{feature_view_sync\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List + extends StandardParameters { + /** + * Lists the FeatureViewSyncs that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. Examples: * `create_time \> \"2020-01-31T15:30:00.000000Z\"` --\> FeatureViewSyncs created after 2020-01-31T15:30:00.000000Z. + */ + filter?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `create_time` + */ + orderBy?: string; + /** + * The maximum number of FeatureViewSyncs to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViewSyncs will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViewSyncs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViewSyncs must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the FeatureView to list FeatureViewSyncs. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` + */ + parent?: string; + } + + export class Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featureOnlineStores.featureViews.operations.delete( + * { + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView/operations/my-operation', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featureOnlineStores.featureViews.operations.get( + * { + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView/operations/my-operation', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featureOnlineStores.featureViews.operations.listWait( + * { + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView/operations/my-operation', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + listWait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait, + options: StreamMethodOptions + ): Promise>; + listWait( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + listWait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listWait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listWait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait, + callback: BodyResponseCallback + ): void; + listWait( + callback: BodyResponseCallback + ): void; + listWait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featureOnlineStores.featureViews.operations.wait( + * { + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + wait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait, + options: StreamMethodOptions + ): Promise>; + wait( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait, + options?: MethodOptions + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Featureonlinestores$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featureOnlineStores.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featureOnlineStores.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featureOnlineStores.operations.listWait( + * { + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/operations/my-operation', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + listWait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait, + options: StreamMethodOptions + ): Promise>; + listWait( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + listWait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listWait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listWait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait, + callback: BodyResponseCallback + ): void; + listWait( + callback: BodyResponseCallback + ): void; + listWait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featureOnlineStores.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + wait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait, + options: StreamMethodOptions + ): Promise>; + wait( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait, + options?: MethodOptions + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Featurestores { + context: APIRequestContext; + entityTypes: Resource$Projects$Locations$Featurestores$Entitytypes; + operations: Resource$Projects$Locations$Featurestores$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.entityTypes = + new Resource$Projects$Locations$Featurestores$Entitytypes(this.context); + this.operations = + new Resource$Projects$Locations$Featurestores$Operations(this.context); + } + + /** + * Batch reads Feature values from a Featurestore. This API enables batch reading Feature values, where each read instance in the batch may read Feature values of entities from one or more EntityTypes. Point-in-time correctness is guaranteed for Feature values of each read instance as of each instance's read timestamp. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featurestores.batchReadFeatureValues({ + * // Required. The resource name of the Featurestore from which to query Feature values. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` + * featurestore: + * 'projects/my-project/locations/my-location/featurestores/my-featurestore', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bigqueryReadInstances": {}, + * // "csvReadInstances": {}, + * // "destination": {}, + * // "entityTypeSpecs": [], + * // "passThroughFields": [], + * // "startTime": "my_startTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + batchReadFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues, + options: StreamMethodOptions + ): Promise>; + batchReadFeatureValues( + params?: Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues, + options?: MethodOptions + ): Promise>; + batchReadFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchReadFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchReadFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues, + callback: BodyResponseCallback + ): void; + batchReadFeatureValues( + callback: BodyResponseCallback + ): void; + batchReadFeatureValues( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+featurestore}:batchReadFeatureValues' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['featurestore'], + pathParams: ['featurestore'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a new Featurestore in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.featurestores.create({ + * // Required. The ID to use for this Featurestore, which will become the final component of the Featurestore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location. + * featurestoreId: 'placeholder-value', + * // Required. The resource name of the Location to create Featurestores. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "onlineServingConfig": {}, + * // "onlineStorageTtlDays": 0, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Featurestores$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Featurestores$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Featurestores$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Featurestores$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Featurestores$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Featurestores$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/featurestores').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or `force` must be set to true for the request to succeed. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.featurestores.delete({ + * // If set to true, any EntityTypes and Features for this Featurestore will also be deleted. (Otherwise, the request will only work if the Featurestore has no EntityTypes.) + * force: 'placeholder-value', + * // Required. The name of the Featurestore to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Featurestores$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Featurestores$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Featurestores$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featurestores$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featurestores$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Featurestores$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a single Featurestore. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.featurestores.get({ + * // Required. The name of the Featurestore resource. + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "onlineServingConfig": {}, + * // "onlineStorageTtlDays": 0, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Featurestores$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Featurestores$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Featurestores$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featurestores$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featurestores$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Featurestores$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.featurestores.getIamPolicy({ + * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + * 'options.requestedPolicyVersion': 'placeholder-value', + * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/featurestores/my-featurestore', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Getiampolicy, + options: StreamMethodOptions + ): Promise>; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Featurestores$Getiampolicy, + options?: MethodOptions + ): Promise>; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy( + callback: BodyResponseCallback + ): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists Featurestores in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.featurestores.list({ + * // Lists the featurestores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `online_serving_config.fixed_node_count`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. * `labels`: Supports key-value equality and key presence. Examples: * `create_time \> "2020-01-01" OR update_time \> "2020-01-01"` Featurestores created or updated after 2020-01-01. * `labels.env = "prod"` Featurestores with label "env" set to "prod". + * filter: 'placeholder-value', + * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time` * `update_time` * `online_serving_config.fixed_node_count` + * orderBy: 'placeholder-value', + * // The maximum number of Featurestores to return. The service may return fewer than this value. If unspecified, at most 100 Featurestores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. + * pageSize: 'placeholder-value', + * // A page token, received from a previous FeaturestoreService.ListFeaturestores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeaturestores must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location to list Featurestores. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "featurestores": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Featurestores$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Featurestores$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Featurestores$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featurestores$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featurestores$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Featurestores$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/featurestores').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates the parameters of a single Featurestore. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.featurestores.patch({ + * // Output only. Name of the Featurestore. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore', + * // Field mask is used to specify the fields to be overwritten in the Featurestore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `online_serving_config.fixed_node_count` * `online_serving_config.scaling` * `online_storage_ttl_days` + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "onlineServingConfig": {}, + * // "onlineStorageTtlDays": 0, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Featurestores$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Featurestores$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Featurestores$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Featurestores$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Featurestores$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Featurestores$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Searches Features matching a query in a given project. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.featurestores.searchFeatures({ + * // Required. The resource name of the Location to search Features. Format: `projects/{project\}/locations/{location\}` + * location: 'projects/my-project/locations/my-location', + * // The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 100 Features will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. + * pageSize: 'placeholder-value', + * // A page token, received from a previous FeaturestoreService.SearchFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.SearchFeatures, except `page_size`, must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Query string that is a conjunction of field-restricted queries and/or field-restricted filters. Field-restricted queries and filters can be combined using `AND` to form a conjunction. A field query is in the form FIELD:QUERY. This implicitly checks if QUERY exists as a substring within Feature's FIELD. The QUERY and the FIELD are converted to a sequence of words (i.e. tokens) for comparison. This is done by: * Removing leading/trailing whitespace and tokenizing the search value. Characters that are not one of alphanumeric `[a-zA-Z0-9]`, underscore `_`, or asterisk `*` are treated as delimiters for tokens. `*` is treated as a wildcard that matches characters within a token. * Ignoring case. * Prepending an asterisk to the first and appending an asterisk to the last token in QUERY. A QUERY must be either a singular token or a phrase. A phrase is one or multiple words enclosed in double quotation marks ("). With phrases, the order of the words is important. Words in the phrase must be matching in order and consecutively. Supported FIELDs for field-restricted queries: * `feature_id` * `description` * `entity_type_id` Examples: * `feature_id: foo` --\> Matches a Feature with ID containing the substring `foo` (eg. `foo`, `foofeature`, `barfoo`). * `feature_id: foo*feature` --\> Matches a Feature with ID containing the substring `foo*feature` (eg. `foobarfeature`). * `feature_id: foo AND description: bar` --\> Matches a Feature with ID containing the substring `foo` and description containing the substring `bar`. Besides field queries, the following exact-match filters are supported. The exact-match filters do not support wildcards. Unlike field-restricted queries, exact-match filters are case-sensitive. * `feature_id`: Supports = comparisons. * `description`: Supports = comparisons. Multi-token filters should be enclosed in quotes. * `entity_type_id`: Supports = comparisons. * `value_type`: Supports = and != comparisons. * `labels`: Supports key-value equality as well as key presence. * `featurestore_id`: Supports = comparisons. Examples: * `description = "foo bar"` --\> Any Feature with description exactly equal to `foo bar` * `value_type = DOUBLE` --\> Features whose type is DOUBLE. * `labels.active = yes AND labels.env = prod` --\> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any Feature which has a label with `env` as the key. + * query: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "features": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + searchFeatures( + params: Params$Resource$Projects$Locations$Featurestores$Searchfeatures, + options: StreamMethodOptions + ): Promise>; + searchFeatures( + params?: Params$Resource$Projects$Locations$Featurestores$Searchfeatures, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + searchFeatures( + params: Params$Resource$Projects$Locations$Featurestores$Searchfeatures, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchFeatures( + params: Params$Resource$Projects$Locations$Featurestores$Searchfeatures, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchFeatures( + params: Params$Resource$Projects$Locations$Featurestores$Searchfeatures, + callback: BodyResponseCallback + ): void; + searchFeatures( + callback: BodyResponseCallback + ): void; + searchFeatures( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Searchfeatures + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Searchfeatures; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Searchfeatures; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+location}/featurestores:searchFeatures' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['location'], + pathParams: ['location'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.featurestores.setIamPolicy({ + * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/featurestores/my-featurestore', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "policy": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Setiampolicy, + options: StreamMethodOptions + ): Promise>; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Featurestores$Setiampolicy, + options?: MethodOptions + ): Promise>; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy( + callback: BodyResponseCallback + ): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featurestores.testIamPermissions({ + * // The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * permissions: 'placeholder-value', + * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/featurestores/my-featurestore', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "permissions": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + testIamPermissions( + params: Params$Resource$Projects$Locations$Featurestores$Testiampermissions, + options: StreamMethodOptions + ): Promise>; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Featurestores$Testiampermissions, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featurestores$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featurestores$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featurestores$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues + extends StandardParameters { + /** + * Required. The resource name of the Featurestore from which to query Feature values. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` + */ + featurestore?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1BatchReadFeatureValuesRequest; + } + export interface Params$Resource$Projects$Locations$Featurestores$Create + extends StandardParameters { + /** + * Required. The ID to use for this Featurestore, which will become the final component of the Featurestore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location. + */ + featurestoreId?: string; + /** + * Required. The resource name of the Location to create Featurestores. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Featurestore; + } + export interface Params$Resource$Projects$Locations$Featurestores$Delete + extends StandardParameters { + /** + * If set to true, any EntityTypes and Features for this Featurestore will also be deleted. (Otherwise, the request will only work if the Featurestore has no EntityTypes.) + */ + force?: boolean; + /** + * Required. The name of the Featurestore to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Get + extends StandardParameters { + /** + * Required. The name of the Featurestore resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$List + extends StandardParameters { + /** + * Lists the featurestores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `online_serving_config.fixed_node_count`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. * `labels`: Supports key-value equality and key presence. Examples: * `create_time \> "2020-01-01" OR update_time \> "2020-01-01"` Featurestores created or updated after 2020-01-01. * `labels.env = "prod"` Featurestores with label "env" set to "prod". + */ + filter?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time` * `update_time` * `online_serving_config.fixed_node_count` + */ + orderBy?: string; + /** + * The maximum number of Featurestores to return. The service may return fewer than this value. If unspecified, at most 100 Featurestores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. + */ + pageSize?: number; + /** + * A page token, received from a previous FeaturestoreService.ListFeaturestores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeaturestores must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list Featurestores. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Patch + extends StandardParameters { + /** + * Output only. Name of the Featurestore. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` + */ + name?: string; + /** + * Field mask is used to specify the fields to be overwritten in the Featurestore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `online_serving_config.fixed_node_count` * `online_serving_config.scaling` * `online_storage_ttl_days` + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Featurestore; + } + export interface Params$Resource$Projects$Locations$Featurestores$Searchfeatures + extends StandardParameters { + /** + * Required. The resource name of the Location to search Features. Format: `projects/{project\}/locations/{location\}` + */ + location?: string; + /** + * The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 100 Features will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. + */ + pageSize?: number; + /** + * A page token, received from a previous FeaturestoreService.SearchFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.SearchFeatures, except `page_size`, must match the call that provided the page token. + */ + pageToken?: string; + /** + * Query string that is a conjunction of field-restricted queries and/or field-restricted filters. Field-restricted queries and filters can be combined using `AND` to form a conjunction. A field query is in the form FIELD:QUERY. This implicitly checks if QUERY exists as a substring within Feature's FIELD. The QUERY and the FIELD are converted to a sequence of words (i.e. tokens) for comparison. This is done by: * Removing leading/trailing whitespace and tokenizing the search value. Characters that are not one of alphanumeric `[a-zA-Z0-9]`, underscore `_`, or asterisk `*` are treated as delimiters for tokens. `*` is treated as a wildcard that matches characters within a token. * Ignoring case. * Prepending an asterisk to the first and appending an asterisk to the last token in QUERY. A QUERY must be either a singular token or a phrase. A phrase is one or multiple words enclosed in double quotation marks ("). With phrases, the order of the words is important. Words in the phrase must be matching in order and consecutively. Supported FIELDs for field-restricted queries: * `feature_id` * `description` * `entity_type_id` Examples: * `feature_id: foo` --\> Matches a Feature with ID containing the substring `foo` (eg. `foo`, `foofeature`, `barfoo`). * `feature_id: foo*feature` --\> Matches a Feature with ID containing the substring `foo*feature` (eg. `foobarfeature`). * `feature_id: foo AND description: bar` --\> Matches a Feature with ID containing the substring `foo` and description containing the substring `bar`. Besides field queries, the following exact-match filters are supported. The exact-match filters do not support wildcards. Unlike field-restricted queries, exact-match filters are case-sensitive. * `feature_id`: Supports = comparisons. * `description`: Supports = comparisons. Multi-token filters should be enclosed in quotes. * `entity_type_id`: Supports = comparisons. * `value_type`: Supports = and != comparisons. * `labels`: Supports key-value equality as well as key presence. * `featurestore_id`: Supports = comparisons. Examples: * `description = "foo bar"` --\> Any Feature with description exactly equal to `foo bar` * `value_type = DOUBLE` --\> Features whose type is DOUBLE. * `labels.active = yes AND labels.env = prod` --\> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any Feature which has a label with `env` as the key. + */ + query?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Featurestores$Testiampermissions + extends StandardParameters { + /** + * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + */ + permissions?: string[]; + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + + export class Resource$Projects$Locations$Featurestores$Entitytypes { + context: APIRequestContext; + features: Resource$Projects$Locations$Featurestores$Entitytypes$Features; + operations: Resource$Projects$Locations$Featurestores$Entitytypes$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.features = + new Resource$Projects$Locations$Featurestores$Entitytypes$Features( + this.context + ); + this.operations = + new Resource$Projects$Locations$Featurestores$Entitytypes$Operations( + this.context + ); + } + + /** + * Creates a new EntityType in a given Featurestore. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.create({ + * // Required. The ID to use for the EntityType, which will become the final component of the EntityType's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a featurestore. + * entityTypeId: 'placeholder-value', + * // Required. The resource name of the Featurestore to create EntityTypes. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` + * parent: + * 'projects/my-project/locations/my-location/featurestores/my-featurestore', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "etag": "my_etag", + * // "labels": {}, + * // "monitoringConfig": {}, + * // "name": "my_name", + * // "offlineStorageTtlDays": 0, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/entityTypes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single EntityType. The EntityType must not have any Features or `force` must be set to true for the request to succeed. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.delete({ + * // If set to true, any Features for this EntityType will also be deleted. (Otherwise, the request will only work if the EntityType has no Features.) + * force: 'placeholder-value', + * // Required. The name of the EntityType to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Delete Feature values from Featurestore. The progress of the deletion is tracked by the returned operation. The deleted feature values are guaranteed to be invisible to subsequent read operations after the operation is marked as successfully done. If a delete feature values operation fails, the feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same delete request again and wait till the new operation returned is marked as successfully done. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.deleteFeatureValues( + * { + * // Required. The resource name of the EntityType grouping the Features for which values are being deleted from. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entityType\}` + * entityType: + * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "selectEntity": {}, + * // "selectTimeRangeAndFeature": {} + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + deleteFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues, + options: StreamMethodOptions + ): Promise>; + deleteFeatureValues( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues, + options?: MethodOptions + ): Promise>; + deleteFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deleteFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deleteFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues, + callback: BodyResponseCallback + ): void; + deleteFeatureValues( + callback: BodyResponseCallback + ): void; + deleteFeatureValues( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+entityType}:deleteFeatureValues').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['entityType'], + pathParams: ['entityType'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Exports Feature values from all the entities of a target EntityType. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.exportFeatureValues( + * { + * // Required. The resource name of the EntityType from which to export Feature values. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` + * entityType: + * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "destination": {}, + * // "featureSelector": {}, + * // "fullExport": {}, + * // "settings": [], + * // "snapshotExport": {} + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + exportFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues, + options: StreamMethodOptions + ): Promise>; + exportFeatureValues( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues, + options?: MethodOptions + ): Promise>; + exportFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + exportFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + exportFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues, + callback: BodyResponseCallback + ): void; + exportFeatureValues( + callback: BodyResponseCallback + ): void; + exportFeatureValues( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+entityType}:exportFeatureValues').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['entityType'], + pathParams: ['entityType'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a single EntityType. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.featurestores.entityTypes.get( + * { + * // Required. The name of the EntityType resource. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "etag": "my_etag", + * // "labels": {}, + * // "monitoringConfig": {}, + * // "name": "my_name", + * // "offlineStorageTtlDays": 0, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.getIamPolicy({ + * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + * 'options.requestedPolicyVersion': 'placeholder-value', + * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy, + options: StreamMethodOptions + ): Promise>; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy, + options?: MethodOptions + ): Promise>; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy( + callback: BodyResponseCallback + ): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Imports Feature values into the Featurestore from a source storage. The progress of the import is tracked by the returned operation. The imported features are guaranteed to be visible to subsequent read operations after the operation is marked as successfully done. If an import operation fails, the Feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same import request again and wait till the new operation returned is marked as successfully done. There are also scenarios where the caller can cause inconsistency. - Source data for import contains multiple distinct Feature values for the same entity ID and timestamp. - Source is modified during an import. This includes adding, updating, or removing source data and/or metadata. Examples of updating metadata include but are not limited to changing storage location, storage class, or retention policy. - Online serving cluster is under-provisioned. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.importFeatureValues( + * { + * // Required. The resource name of the EntityType grouping the Features for which values are being imported. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entityType\}` + * entityType: + * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "avroSource": {}, + * // "bigquerySource": {}, + * // "csvSource": {}, + * // "disableIngestionAnalysis": false, + * // "disableOnlineServing": false, + * // "entityIdField": "my_entityIdField", + * // "featureSpecs": [], + * // "featureTime": "my_featureTime", + * // "featureTimeField": "my_featureTimeField", + * // "workerCount": 0 + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + importFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues, + options: StreamMethodOptions + ): Promise>; + importFeatureValues( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues, + options?: MethodOptions + ): Promise>; + importFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + importFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + importFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues, + callback: BodyResponseCallback + ): void; + importFeatureValues( + callback: BodyResponseCallback + ): void; + importFeatureValues( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+entityType}:importFeatureValues').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['entityType'], + pathParams: ['entityType'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists EntityTypes in a given Featurestore. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.list({ + * // Lists the EntityTypes that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> EntityTypes having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any EntityType which has a label with 'env' as the key. + * filter: 'placeholder-value', + * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `entity_type_id` * `create_time` * `update_time` + * orderBy: 'placeholder-value', + * // The maximum number of EntityTypes to return. The service may return fewer than this value. If unspecified, at most 1000 EntityTypes will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // A page token, received from a previous FeaturestoreService.ListEntityTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListEntityTypes must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Featurestore to list EntityTypes. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` + * parent: + * 'projects/my-project/locations/my-location/featurestores/my-featurestore', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "entityTypes": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/entityTypes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates the parameters of a single EntityType. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.patch({ + * // Immutable. Name of the EntityType. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` The last part entity_type is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore. + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', + * // Field mask is used to specify the fields to be overwritten in the EntityType resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `monitoring_config.snapshot_analysis.disabled` * `monitoring_config.snapshot_analysis.monitoring_interval_days` * `monitoring_config.snapshot_analysis.staleness_days` * `monitoring_config.import_features_analysis.state` * `monitoring_config.import_features_analysis.anomaly_detection_baseline` * `monitoring_config.numerical_threshold_config.value` * `monitoring_config.categorical_threshold_config.value` * `offline_storage_ttl_days` + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "etag": "my_etag", + * // "labels": {}, + * // "monitoringConfig": {}, + * // "name": "my_name", + * // "offlineStorageTtlDays": 0, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "etag": "my_etag", + * // "labels": {}, + * // "monitoringConfig": {}, + * // "name": "my_name", + * // "offlineStorageTtlDays": 0, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + patch( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.readFeatureValues( + * { + * // Required. The resource name of the EntityType for the entity being read. Value format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entityType\}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`. + * entityType: + * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "entityId": "my_entityId", + * // "featureSelector": {} + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "entityView": {}, + * // "header": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + readFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues, + options: StreamMethodOptions + ): Promise>; + readFeatureValues( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + readFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + readFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + readFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues, + callback: BodyResponseCallback + ): void; + readFeatureValues( + callback: BodyResponseCallback + ): void; + readFeatureValues( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+entityType}:readFeatureValues').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['entityType'], + pathParams: ['entityType'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.setIamPolicy({ + * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "policy": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy, + options: StreamMethodOptions + ): Promise>; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy, + options?: MethodOptions + ): Promise>; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy( + callback: BodyResponseCallback + ): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.streamingReadFeatureValues( + * { + * // Required. The resource name of the entities' type. Value format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entityType\}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`. + * entityType: + * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "entityIds": [], + * // "featureSelector": {} + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "entityView": {}, + * // "header": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + streamingReadFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues, + options: StreamMethodOptions + ): Promise>; + streamingReadFeatureValues( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + streamingReadFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + streamingReadFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + streamingReadFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues, + callback: BodyResponseCallback + ): void; + streamingReadFeatureValues( + callback: BodyResponseCallback + ): void; + streamingReadFeatureValues( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+entityType}:streamingReadFeatureValues' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['entityType'], + pathParams: ['entityType'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.testIamPermissions( + * { + * // The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * permissions: 'placeholder-value', + * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "permissions": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + testIamPermissions( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions, + options: StreamMethodOptions + ): Promise>; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Writes Feature values of one or more entities of an EntityType. The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.writeFeatureValues( + * { + * // Required. The resource name of the EntityType for the entities being written. Value format: `projects/{project\}/locations/{location\}/featurestores/ {featurestore\}/entityTypes/{entityType\}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`. + * entityType: + * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "payloads": [] + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + writeFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues, + options: StreamMethodOptions + ): Promise>; + writeFeatureValues( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + writeFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + writeFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + writeFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues, + callback: BodyResponseCallback + ): void; + writeFeatureValues( + callback: BodyResponseCallback + ): void; + writeFeatureValues( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+entityType}:writeFeatureValues').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['entityType'], + pathParams: ['entityType'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create + extends StandardParameters { + /** + * Required. The ID to use for the EntityType, which will become the final component of the EntityType's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a featurestore. + */ + entityTypeId?: string; + /** + * Required. The resource name of the Featurestore to create EntityTypes. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1EntityType; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete + extends StandardParameters { + /** + * If set to true, any Features for this EntityType will also be deleted. (Otherwise, the request will only work if the EntityType has no Features.) + */ + force?: boolean; + /** + * Required. The name of the EntityType to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues + extends StandardParameters { + /** + * Required. The resource name of the EntityType grouping the Features for which values are being deleted from. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entityType\}` + */ + entityType?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1DeleteFeatureValuesRequest; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues + extends StandardParameters { + /** + * Required. The resource name of the EntityType from which to export Feature values. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` + */ + entityType?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ExportFeatureValuesRequest; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get + extends StandardParameters { + /** + * Required. The name of the EntityType resource. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues + extends StandardParameters { + /** + * Required. The resource name of the EntityType grouping the Features for which values are being imported. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entityType\}` + */ + entityType?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ImportFeatureValuesRequest; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$List + extends StandardParameters { + /** + * Lists the EntityTypes that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> EntityTypes having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any EntityType which has a label with 'env' as the key. + */ + filter?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `entity_type_id` * `create_time` * `update_time` + */ + orderBy?: string; + /** + * The maximum number of EntityTypes to return. The service may return fewer than this value. If unspecified, at most 1000 EntityTypes will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous FeaturestoreService.ListEntityTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListEntityTypes must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the Featurestore to list EntityTypes. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch + extends StandardParameters { + /** + * Immutable. Name of the EntityType. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` The last part entity_type is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore. + */ + name?: string; + /** + * Field mask is used to specify the fields to be overwritten in the EntityType resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `monitoring_config.snapshot_analysis.disabled` * `monitoring_config.snapshot_analysis.monitoring_interval_days` * `monitoring_config.snapshot_analysis.staleness_days` * `monitoring_config.import_features_analysis.state` * `monitoring_config.import_features_analysis.anomaly_detection_baseline` * `monitoring_config.numerical_threshold_config.value` * `monitoring_config.categorical_threshold_config.value` * `offline_storage_ttl_days` + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1EntityType; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues + extends StandardParameters { + /** + * Required. The resource name of the EntityType for the entity being read. Value format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entityType\}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`. + */ + entityType?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ReadFeatureValuesRequest; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues + extends StandardParameters { + /** + * Required. The resource name of the entities' type. Value format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entityType\}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`. + */ + entityType?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions + extends StandardParameters { + /** + * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + */ + permissions?: string[]; + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues + extends StandardParameters { + /** + * Required. The resource name of the EntityType for the entities being written. Value format: `projects/{project\}/locations/{location\}/featurestores/ {featurestore\}/entityTypes/{entityType\}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`. + */ + entityType?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1WriteFeatureValuesRequest; + } + + export class Resource$Projects$Locations$Featurestores$Entitytypes$Features { + context: APIRequestContext; + operations: Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations( + this.context + ); + } + + /** + * Creates a batch of Features in a given EntityType. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.features.batchCreate( + * { + * // Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + * parent: + * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "requests": [] + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + batchCreate( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate, + options: StreamMethodOptions + ): Promise>; + batchCreate( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate, + options?: MethodOptions + ): Promise>; + batchCreate( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchCreate( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchCreate( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate, + callback: BodyResponseCallback + ): void; + batchCreate( + callback: BodyResponseCallback + ): void; + batchCreate( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/features:batchCreate').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a new Feature in a given EntityType. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.features.create( + * { + * // Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup. + * featureId: 'placeholder-value', + * // Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + * parent: + * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "disableMonitoring": false, + * // "etag": "my_etag", + * // "labels": {}, + * // "monitoringStatsAnomalies": [], + * // "name": "my_name", + * // "pointOfContact": "my_pointOfContact", + * // "updateTime": "my_updateTime", + * // "valueType": "my_valueType", + * // "versionColumnName": "my_versionColumnName" + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/features').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single Feature. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.features.delete( + * { + * // Required. The name of the Features to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/features/my-feature', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a single Feature. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.features.get({ + * // Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/features/my-feature', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "disableMonitoring": false, + * // "etag": "my_etag", + * // "labels": {}, + * // "monitoringStatsAnomalies": [], + * // "name": "my_name", + * // "pointOfContact": "my_pointOfContact", + * // "updateTime": "my_updateTime", + * // "valueType": "my_valueType", + * // "versionColumnName": "my_versionColumnName" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists Features in a given EntityType. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.features.list( + * { + * // Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --\> Features whose type is DOUBLE. * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any Feature which has a label with 'env' as the key. + * filter: 'placeholder-value', + * // Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats. + * latestStatsCount: 'placeholder-value', + * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time` + * orderBy: 'placeholder-value', + * // The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + * parent: + * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "features": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/features').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates the parameters of a single Feature. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.features.patch( + * { + * // Immutable. Name of the Feature. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type. + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/features/my-feature', + * // Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore) + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "disableMonitoring": false, + * // "etag": "my_etag", + * // "labels": {}, + * // "monitoringStatsAnomalies": [], + * // "name": "my_name", + * // "pointOfContact": "my_pointOfContact", + * // "updateTime": "my_updateTime", + * // "valueType": "my_valueType", + * // "versionColumnName": "my_versionColumnName" + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "disableMonitoring": false, + * // "etag": "my_etag", + * // "labels": {}, + * // "monitoringStatsAnomalies": [], + * // "name": "my_name", + * // "pointOfContact": "my_pointOfContact", + * // "updateTime": "my_updateTime", + * // "valueType": "my_valueType", + * // "versionColumnName": "my_versionColumnName" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate + extends StandardParameters { + /** + * Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1BatchCreateFeaturesRequest; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create + extends StandardParameters { + /** + * Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup. + */ + featureId?: string; + /** + * Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Feature; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete + extends StandardParameters { + /** + * Required. The name of the Features to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get + extends StandardParameters { + /** + * Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List + extends StandardParameters { + /** + * Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --\> Features whose type is DOUBLE. * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any Feature which has a label with 'env' as the key. + */ + filter?: string; + /** + * Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats. + */ + latestStatsCount?: number; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time` + */ + orderBy?: string; + /** + * The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch + extends StandardParameters { + /** + * Immutable. Name of the Feature. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type. + */ + name?: string; + /** + * Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore) + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Feature; + } + + export class Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.features.operations.cancel( + * { + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/features/my-feature/operations/my-operation', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel, + options?: MethodOptions + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.features.operations.delete( + * { + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/features/my-feature/operations/my-operation', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.features.operations.get( + * { + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/features/my-feature/operations/my-operation', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.features.operations.list( + * { + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/features/my-feature', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.features.operations.wait( + * { + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/features/my-feature/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + wait( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait, + options: StreamMethodOptions + ): Promise>; + wait( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait, + options?: MethodOptions + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Featurestores$Entitytypes$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.operations.cancel( + * { + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/operations/my-operation', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel, + options?: MethodOptions + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.operations.delete( + * { + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/operations/my-operation', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.operations.get( + * { + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/operations/my-operation', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.operations.list( + * { + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.operations.wait( + * { + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + wait( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait, + options: StreamMethodOptions + ): Promise>; + wait( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait, + options?: MethodOptions + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Featurestores$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featurestores.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Projects$Locations$Featurestores$Operations$Cancel, + options?: MethodOptions + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.featurestores.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Featurestores$Operations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.featurestores.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Featurestores$Operations$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.featurestores.operations.list( + * { + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Featurestores$Operations$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Featurestores$Operations$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Featurestores$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featurestores$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featurestores$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.featurestores.operations.wait( + * { + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + wait( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Wait, + options: StreamMethodOptions + ): Promise>; + wait( + params?: Params$Resource$Projects$Locations$Featurestores$Operations$Wait, + options?: MethodOptions + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featurestores$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featurestores$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Operations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Featurestores$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Featurestores$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Hyperparametertuningjobs { + context: APIRequestContext; + operations: Resource$Projects$Locations$Hyperparametertuningjobs$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Hyperparametertuningjobs$Operations( + this.context + ); + } + + /** + * Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetHyperparameterTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a HyperparameterTuningJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and HyperparameterTuningJob.state is set to `CANCELLED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.hyperparameterTuningJobs.cancel({ + * // Required. The name of the HyperparameterTuningJob to cancel. Format: `projects/{project\}/locations/{location\}/hyperparameterTuningJobs/{hyperparameter_tuning_job\}` + * name: 'projects/my-project/locations/my-location/hyperparameterTuningJobs/my-hyperparameterTuningJob', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel, + options?: MethodOptions + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a HyperparameterTuningJob + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.hyperparameterTuningJobs.create({ + * // Required. The resource name of the Location to create the HyperparameterTuningJob in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "labels": {}, + * // "maxFailedTrialCount": 0, + * // "maxTrialCount": 0, + * // "name": "my_name", + * // "parallelTrialCount": 0, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "studySpec": {}, + * // "trialJobSpec": {}, + * // "trials": [], + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "labels": {}, + * // "maxFailedTrialCount": 0, + * // "maxTrialCount": 0, + * // "name": "my_name", + * // "parallelTrialCount": 0, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "studySpec": {}, + * // "trialJobSpec": {}, + * // "trials": [], + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/hyperparameterTuningJobs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Deletes a HyperparameterTuningJob. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.hyperparameterTuningJobs.delete({ + * // Required. The name of the HyperparameterTuningJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/hyperparameterTuningJobs/{hyperparameter_tuning_job\}` + * name: 'projects/my-project/locations/my-location/hyperparameterTuningJobs/my-hyperparameterTuningJob', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a HyperparameterTuningJob + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.hyperparameterTuningJobs.get({ + * // Required. The name of the HyperparameterTuningJob resource. Format: `projects/{project\}/locations/{location\}/hyperparameterTuningJobs/{hyperparameter_tuning_job\}` + * name: 'projects/my-project/locations/my-location/hyperparameterTuningJobs/my-hyperparameterTuningJob', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "labels": {}, + * // "maxFailedTrialCount": 0, + * // "maxTrialCount": 0, + * // "name": "my_name", + * // "parallelTrialCount": 0, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "studySpec": {}, + * // "trialJobSpec": {}, + * // "trials": [], + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists HyperparameterTuningJobs in a Location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.hyperparameterTuningJobs.list( + * { + * // The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` + * filter: 'placeholder-value', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. Typically obtained via ListHyperparameterTuningJobsResponse.next_page_token of the previous JobService.ListHyperparameterTuningJobs call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location to list the HyperparameterTuningJobs from. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "hyperparameterTuningJobs": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Hyperparametertuningjobs$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/hyperparameterTuningJobs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel + extends StandardParameters { + /** + * Required. The name of the HyperparameterTuningJob to cancel. Format: `projects/{project\}/locations/{location\}/hyperparameterTuningJobs/{hyperparameter_tuning_job\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest; + } + export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create + extends StandardParameters { + /** + * Required. The resource name of the Location to create the HyperparameterTuningJob in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1HyperparameterTuningJob; + } + export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete + extends StandardParameters { + /** + * Required. The name of the HyperparameterTuningJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/hyperparameterTuningJobs/{hyperparameter_tuning_job\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get + extends StandardParameters { + /** + * Required. The name of the HyperparameterTuningJob resource. Format: `projects/{project\}/locations/{location\}/hyperparameterTuningJobs/{hyperparameter_tuning_job\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$List + extends StandardParameters { + /** + * The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` + */ + filter?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. Typically obtained via ListHyperparameterTuningJobsResponse.next_page_token of the previous JobService.ListHyperparameterTuningJobs call. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list the HyperparameterTuningJobs from. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + + export class Resource$Projects$Locations$Hyperparametertuningjobs$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.hyperparameterTuningJobs.operations.cancel( + * { + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/hyperparameterTuningJobs/my-hyperparameterTuningJob/operations/my-operation', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel, + options?: MethodOptions + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.hyperparameterTuningJobs.operations.delete( + * { + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/hyperparameterTuningJobs/my-hyperparameterTuningJob/operations/my-operation', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.hyperparameterTuningJobs.operations.get( + * { + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/hyperparameterTuningJobs/my-hyperparameterTuningJob/operations/my-operation', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.hyperparameterTuningJobs.operations.list( + * { + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/hyperparameterTuningJobs/my-hyperparameterTuningJob', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.hyperparameterTuningJobs.operations.wait( + * { + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/hyperparameterTuningJobs/my-hyperparameterTuningJob/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + wait( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait, + options: StreamMethodOptions + ): Promise>; + wait( + params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait, + options?: MethodOptions + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Indexendpoints { + context: APIRequestContext; + operations: Resource$Projects$Locations$Indexendpoints$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Indexendpoints$Operations(this.context); + } + + /** + * Creates an IndexEndpoint. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.indexEndpoints.create({ + * // Required. The resource name of the Location to create the IndexEndpoint in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "deployedIndexes": [], + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "enablePrivateServiceConnect": false, + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "network": "my_network", + * // "privateServiceConnectConfig": {}, + * // "publicEndpointDomainName": "my_publicEndpointDomainName", + * // "publicEndpointEnabled": false, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Indexendpoints$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Indexendpoints$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Indexendpoints$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Indexendpoints$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Indexendpoints$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Indexendpoints$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Indexendpoints$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Indexendpoints$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/indexEndpoints').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes an IndexEndpoint. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.indexEndpoints.delete({ + * // Required. The name of the IndexEndpoint resource to be deleted. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + * name: 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Indexendpoints$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Indexendpoints$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Indexendpoints$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Indexendpoints$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Indexendpoints$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Indexendpoints$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Indexendpoints$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Indexendpoints$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.indexEndpoints.deployIndex({ + * // Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + * indexEndpoint: + * 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "deployedIndex": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + deployIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Deployindex, + options: StreamMethodOptions + ): Promise>; + deployIndex( + params?: Params$Resource$Projects$Locations$Indexendpoints$Deployindex, + options?: MethodOptions + ): Promise>; + deployIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Deployindex, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deployIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Deployindex, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deployIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Deployindex, + callback: BodyResponseCallback + ): void; + deployIndex( + callback: BodyResponseCallback + ): void; + deployIndex( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Indexendpoints$Deployindex + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Indexendpoints$Deployindex; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Indexendpoints$Deployindex; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+indexEndpoint}:deployIndex').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['indexEndpoint'], + pathParams: ['indexEndpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Finds the nearest neighbors of each vector within the request. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.indexEndpoints.findNeighbors({ + * // Required. The name of the index endpoint. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + * indexEndpoint: + * 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "deployedIndexId": "my_deployedIndexId", + * // "queries": [], + * // "returnFullDatapoint": false + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "nearestNeighbors": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + findNeighbors( + params: Params$Resource$Projects$Locations$Indexendpoints$Findneighbors, + options: StreamMethodOptions + ): Promise>; + findNeighbors( + params?: Params$Resource$Projects$Locations$Indexendpoints$Findneighbors, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + findNeighbors( + params: Params$Resource$Projects$Locations$Indexendpoints$Findneighbors, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + findNeighbors( + params: Params$Resource$Projects$Locations$Indexendpoints$Findneighbors, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + findNeighbors( + params: Params$Resource$Projects$Locations$Indexendpoints$Findneighbors, + callback: BodyResponseCallback + ): void; + findNeighbors( + callback: BodyResponseCallback + ): void; + findNeighbors( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Indexendpoints$Findneighbors + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Indexendpoints$Findneighbors; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Indexendpoints$Findneighbors; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+indexEndpoint}:findNeighbors').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['indexEndpoint'], + pathParams: ['indexEndpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets an IndexEndpoint. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.indexEndpoints.get({ + * // Required. The name of the IndexEndpoint resource. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + * name: 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "deployedIndexes": [], + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "enablePrivateServiceConnect": false, + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "network": "my_network", + * // "privateServiceConnectConfig": {}, + * // "publicEndpointDomainName": "my_publicEndpointDomainName", + * // "publicEndpointEnabled": false, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Indexendpoints$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Indexendpoints$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Indexendpoints$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Indexendpoints$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Indexendpoints$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Indexendpoints$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Indexendpoints$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Indexendpoints$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists IndexEndpoints in a Location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.indexEndpoints.list({ + * // Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `index_endpoint` supports = and !=. `index_endpoint` represents the IndexEndpoint ID, ie. the last segment of the IndexEndpoint's resourcename. * `display_name` supports =, != and regex() (uses [re2](https://github.com/google/re2/wiki/Syntax) syntax) * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* or labels:key - key existence A key including a space must be quoted. `labels."a key"`. Some examples: * `index_endpoint="1"` * `display_name="myDisplayName"` * `regex(display_name, "^A") -\> The display name starts with an A. * `labels.myKey="myValue"` + * filter: 'placeholder-value', + * // Optional. The standard list page size. + * pageSize: 'placeholder-value', + * // Optional. The standard list page token. Typically obtained via ListIndexEndpointsResponse.next_page_token of the previous IndexEndpointService.ListIndexEndpoints call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location from which to list the IndexEndpoints. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // Optional. Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "indexEndpoints": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Indexendpoints$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Indexendpoints$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Indexendpoints$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Indexendpoints$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Indexendpoints$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Indexendpoints$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Indexendpoints$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Indexendpoints$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/indexEndpoints').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Update an existing DeployedIndex under an IndexEndpoint. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.indexEndpoints.mutateDeployedIndex({ + * // Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + * indexEndpoint: + * 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "automaticResources": {}, + * // "createTime": "my_createTime", + * // "dedicatedResources": {}, + * // "deployedIndexAuthConfig": {}, + * // "deploymentGroup": "my_deploymentGroup", + * // "deploymentTier": "my_deploymentTier", + * // "displayName": "my_displayName", + * // "enableAccessLogging": false, + * // "enableDatapointUpsertLogging": false, + * // "id": "my_id", + * // "index": "my_index", + * // "indexSyncTime": "my_indexSyncTime", + * // "privateEndpoints": {}, + * // "pscAutomationConfigs": [], + * // "reservedIpRanges": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + mutateDeployedIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex, + options: StreamMethodOptions + ): Promise>; + mutateDeployedIndex( + params?: Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex, + options?: MethodOptions + ): Promise>; + mutateDeployedIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + mutateDeployedIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + mutateDeployedIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex, + callback: BodyResponseCallback + ): void; + mutateDeployedIndex( + callback: BodyResponseCallback + ): void; + mutateDeployedIndex( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+indexEndpoint}:mutateDeployedIndex').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['indexEndpoint'], + pathParams: ['indexEndpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an IndexEndpoint. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.indexEndpoints.patch({ + * // Output only. The resource name of the IndexEndpoint. + * name: 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint', + * // Required. The update mask applies to the resource. See google.protobuf.FieldMask. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "deployedIndexes": [], + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "enablePrivateServiceConnect": false, + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "network": "my_network", + * // "privateServiceConnectConfig": {}, + * // "publicEndpointDomainName": "my_publicEndpointDomainName", + * // "publicEndpointEnabled": false, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "deployedIndexes": [], + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "enablePrivateServiceConnect": false, + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "network": "my_network", + * // "privateServiceConnectConfig": {}, + * // "publicEndpointDomainName": "my_publicEndpointDomainName", + * // "publicEndpointEnabled": false, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Indexendpoints$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Indexendpoints$Patch, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + patch( + params: Params$Resource$Projects$Locations$Indexendpoints$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Indexendpoints$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Indexendpoints$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Indexendpoints$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Indexendpoints$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Indexendpoints$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Reads the datapoints/vectors of the given IDs. A maximum of 1000 datapoints can be retrieved in a batch. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.indexEndpoints.readIndexDatapoints({ + * // Required. The name of the index endpoint. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + * indexEndpoint: + * 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "deployedIndexId": "my_deployedIndexId", + * // "ids": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "datapoints": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + readIndexDatapoints( + params: Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints, + options: StreamMethodOptions + ): Promise>; + readIndexDatapoints( + params?: Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + readIndexDatapoints( + params: Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + readIndexDatapoints( + params: Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + readIndexDatapoints( + params: Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints, + callback: BodyResponseCallback + ): void; + readIndexDatapoints( + callback: BodyResponseCallback + ): void; + readIndexDatapoints( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+indexEndpoint}:readIndexDatapoints').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['indexEndpoint'], + pathParams: ['indexEndpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.indexEndpoints.undeployIndex({ + * // Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + * indexEndpoint: + * 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "deployedIndexId": "my_deployedIndexId" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + undeployIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Undeployindex, + options: StreamMethodOptions + ): Promise>; + undeployIndex( + params?: Params$Resource$Projects$Locations$Indexendpoints$Undeployindex, + options?: MethodOptions + ): Promise>; + undeployIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Undeployindex, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + undeployIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Undeployindex, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + undeployIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Undeployindex, + callback: BodyResponseCallback + ): void; + undeployIndex( + callback: BodyResponseCallback + ): void; + undeployIndex( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Indexendpoints$Undeployindex + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Indexendpoints$Undeployindex; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Indexendpoints$Undeployindex; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+indexEndpoint}:undeployIndex').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['indexEndpoint'], + pathParams: ['indexEndpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Indexendpoints$Create + extends StandardParameters { + /** + * Required. The resource name of the Location to create the IndexEndpoint in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1IndexEndpoint; + } + export interface Params$Resource$Projects$Locations$Indexendpoints$Delete + extends StandardParameters { + /** + * Required. The name of the IndexEndpoint resource to be deleted. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Indexendpoints$Deployindex + extends StandardParameters { + /** + * Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + */ + indexEndpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1DeployIndexRequest; + } + export interface Params$Resource$Projects$Locations$Indexendpoints$Findneighbors + extends StandardParameters { + /** + * Required. The name of the index endpoint. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + */ + indexEndpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1FindNeighborsRequest; + } + export interface Params$Resource$Projects$Locations$Indexendpoints$Get + extends StandardParameters { + /** + * Required. The name of the IndexEndpoint resource. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Indexendpoints$List + extends StandardParameters { + /** + * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `index_endpoint` supports = and !=. `index_endpoint` represents the IndexEndpoint ID, ie. the last segment of the IndexEndpoint's resourcename. * `display_name` supports =, != and regex() (uses [re2](https://github.com/google/re2/wiki/Syntax) syntax) * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* or labels:key - key existence A key including a space must be quoted. `labels."a key"`. Some examples: * `index_endpoint="1"` * `display_name="myDisplayName"` * `regex(display_name, "^A") -\> The display name starts with an A. * `labels.myKey="myValue"` + */ + filter?: string; + /** + * Optional. The standard list page size. + */ + pageSize?: number; + /** + * Optional. The standard list page token. Typically obtained via ListIndexEndpointsResponse.next_page_token of the previous IndexEndpointService.ListIndexEndpoints call. + */ + pageToken?: string; + /** + * Required. The resource name of the Location from which to list the IndexEndpoints. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Optional. Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex + extends StandardParameters { + /** + * Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + */ + indexEndpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1DeployedIndex; + } + export interface Params$Resource$Projects$Locations$Indexendpoints$Patch + extends StandardParameters { + /** + * Output only. The resource name of the IndexEndpoint. + */ + name?: string; + /** + * Required. The update mask applies to the resource. See google.protobuf.FieldMask. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1IndexEndpoint; + } + export interface Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints + extends StandardParameters { + /** + * Required. The name of the index endpoint. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + */ + indexEndpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ReadIndexDatapointsRequest; + } + export interface Params$Resource$Projects$Locations$Indexendpoints$Undeployindex + extends StandardParameters { + /** + * Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + */ + indexEndpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1UndeployIndexRequest; + } + + export class Resource$Projects$Locations$Indexendpoints$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.indexEndpoints.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel, + options?: MethodOptions + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.indexEndpoints.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.indexEndpoints.operations.get( + * { + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint/operations/my-operation', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Indexendpoints$Operations$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Indexendpoints$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Indexendpoints$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Indexendpoints$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.indexEndpoints.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Indexendpoints$Operations$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Indexendpoints$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Indexendpoints$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Indexendpoints$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.indexEndpoints.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + wait( + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait, + options: StreamMethodOptions + ): Promise>; + wait( + params?: Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait, + options?: MethodOptions + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Indexendpoints$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Indexendpoints$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Indexes { + context: APIRequestContext; + operations: Resource$Projects$Locations$Indexes$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Projects$Locations$Indexes$Operations( + this.context + ); + } + + /** + * Creates an Index. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.indexes.create({ + * // Required. The resource name of the Location to create the Index in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "deployedIndexes": [], + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "indexStats": {}, + * // "indexUpdateMethod": "my_indexUpdateMethod", + * // "labels": {}, + * // "metadata": {}, + * // "metadataSchemaUri": "my_metadataSchemaUri", + * // "name": "my_name", + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Indexes$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Indexes$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Indexes$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Indexes$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Indexes$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Indexes$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Indexes$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Indexes$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/indexes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes an Index. An Index can only be deleted when all its DeployedIndexes had been undeployed. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.indexes.delete({ + * // Required. The name of the Index resource to be deleted. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` + * name: 'projects/my-project/locations/my-location/indexes/my-indexe', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Indexes$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Indexes$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Indexes$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Indexes$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Indexes$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Indexes$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Indexes$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Indexes$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets an Index. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.indexes.get({ + * // Required. The name of the Index resource. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` + * name: 'projects/my-project/locations/my-location/indexes/my-indexe', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "deployedIndexes": [], + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "indexStats": {}, + * // "indexUpdateMethod": "my_indexUpdateMethod", + * // "labels": {}, + * // "metadata": {}, + * // "metadataSchemaUri": "my_metadataSchemaUri", + * // "name": "my_name", + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Indexes$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Indexes$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Indexes$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Indexes$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Indexes$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Indexes$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Indexes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Indexes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists Indexes in a Location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.indexes.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. Typically obtained via ListIndexesResponse.next_page_token of the previous IndexService.ListIndexes call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location from which to list the Indexes. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "indexes": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Indexes$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Indexes$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Indexes$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Indexes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Indexes$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Indexes$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Indexes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Indexes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/indexes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates an Index. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.indexes.patch({ + * // Output only. The resource name of the Index. + * name: 'projects/my-project/locations/my-location/indexes/my-indexe', + * // The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "deployedIndexes": [], + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "indexStats": {}, + * // "indexUpdateMethod": "my_indexUpdateMethod", + * // "labels": {}, + * // "metadata": {}, + * // "metadataSchemaUri": "my_metadataSchemaUri", + * // "name": "my_name", + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Indexes$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Indexes$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Indexes$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Indexes$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Indexes$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Indexes$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Indexes$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Indexes$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Remove Datapoints from an Index. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.indexes.removeDatapoints({ + * // Required. The name of the Index resource to be updated. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` + * index: 'projects/my-project/locations/my-location/indexes/my-indexe', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "datapointIds": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + removeDatapoints( + params: Params$Resource$Projects$Locations$Indexes$Removedatapoints, + options: StreamMethodOptions + ): Promise>; + removeDatapoints( + params?: Params$Resource$Projects$Locations$Indexes$Removedatapoints, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + removeDatapoints( + params: Params$Resource$Projects$Locations$Indexes$Removedatapoints, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeDatapoints( + params: Params$Resource$Projects$Locations$Indexes$Removedatapoints, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeDatapoints( + params: Params$Resource$Projects$Locations$Indexes$Removedatapoints, + callback: BodyResponseCallback + ): void; + removeDatapoints( + callback: BodyResponseCallback + ): void; + removeDatapoints( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Indexes$Removedatapoints + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Indexes$Removedatapoints; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Indexes$Removedatapoints; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+index}:removeDatapoints').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['index'], + pathParams: ['index'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Add/update Datapoints into an Index. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.indexes.upsertDatapoints({ + * // Required. The name of the Index resource to be updated. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` + * index: 'projects/my-project/locations/my-location/indexes/my-indexe', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "datapoints": [], + * // "updateMask": "my_updateMask" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + upsertDatapoints( + params: Params$Resource$Projects$Locations$Indexes$Upsertdatapoints, + options: StreamMethodOptions + ): Promise>; + upsertDatapoints( + params?: Params$Resource$Projects$Locations$Indexes$Upsertdatapoints, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + upsertDatapoints( + params: Params$Resource$Projects$Locations$Indexes$Upsertdatapoints, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + upsertDatapoints( + params: Params$Resource$Projects$Locations$Indexes$Upsertdatapoints, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + upsertDatapoints( + params: Params$Resource$Projects$Locations$Indexes$Upsertdatapoints, + callback: BodyResponseCallback + ): void; + upsertDatapoints( + callback: BodyResponseCallback + ): void; + upsertDatapoints( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Indexes$Upsertdatapoints + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Indexes$Upsertdatapoints; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Indexes$Upsertdatapoints; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+index}:upsertDatapoints').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['index'], + pathParams: ['index'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Indexes$Create + extends StandardParameters { + /** + * Required. The resource name of the Location to create the Index in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Index; + } + export interface Params$Resource$Projects$Locations$Indexes$Delete + extends StandardParameters { + /** + * Required. The name of the Index resource to be deleted. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Indexes$Get + extends StandardParameters { + /** + * Required. The name of the Index resource. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Indexes$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. Typically obtained via ListIndexesResponse.next_page_token of the previous IndexService.ListIndexes call. + */ + pageToken?: string; + /** + * Required. The resource name of the Location from which to list the Indexes. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Indexes$Patch + extends StandardParameters { + /** + * Output only. The resource name of the Index. + */ + name?: string; + /** + * The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Index; + } + export interface Params$Resource$Projects$Locations$Indexes$Removedatapoints + extends StandardParameters { + /** + * Required. The name of the Index resource to be updated. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` + */ + index?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1RemoveDatapointsRequest; + } + export interface Params$Resource$Projects$Locations$Indexes$Upsertdatapoints + extends StandardParameters { + /** + * Required. The name of the Index resource to be updated. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` + */ + index?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1UpsertDatapointsRequest; + } + + export class Resource$Projects$Locations$Indexes$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.indexes.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/indexes/my-indexe/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Indexes$Operations$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Projects$Locations$Indexes$Operations$Cancel, + options?: MethodOptions + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Indexes$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Indexes$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Indexes$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Indexes$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Indexes$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Indexes$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.indexes.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/indexes/my-indexe/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Indexes$Operations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Indexes$Operations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Indexes$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Indexes$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Indexes$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Indexes$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Indexes$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Indexes$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.indexes.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/indexes/my-indexe/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Indexes$Operations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Indexes$Operations$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Indexes$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Indexes$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Indexes$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Indexes$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Indexes$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Indexes$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.indexes.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/indexes/my-indexe', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Indexes$Operations$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Indexes$Operations$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Indexes$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Indexes$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Indexes$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Indexes$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Indexes$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Indexes$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.indexes.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/indexes/my-indexe/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + wait( + params: Params$Resource$Projects$Locations$Indexes$Operations$Wait, + options: StreamMethodOptions + ): Promise>; + wait( + params?: Params$Resource$Projects$Locations$Indexes$Operations$Wait, + options?: MethodOptions + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Indexes$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Indexes$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Indexes$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Indexes$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Indexes$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Indexes$Operations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Indexes$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Indexes$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Indexes$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Indexes$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Indexes$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Metadatastores { + context: APIRequestContext; + artifacts: Resource$Projects$Locations$Metadatastores$Artifacts; + contexts: Resource$Projects$Locations$Metadatastores$Contexts; + executions: Resource$Projects$Locations$Metadatastores$Executions; + metadataSchemas: Resource$Projects$Locations$Metadatastores$Metadataschemas; + operations: Resource$Projects$Locations$Metadatastores$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.artifacts = new Resource$Projects$Locations$Metadatastores$Artifacts( + this.context + ); + this.contexts = new Resource$Projects$Locations$Metadatastores$Contexts( + this.context + ); + this.executions = + new Resource$Projects$Locations$Metadatastores$Executions(this.context); + this.metadataSchemas = + new Resource$Projects$Locations$Metadatastores$Metadataschemas( + this.context + ); + this.operations = + new Resource$Projects$Locations$Metadatastores$Operations(this.context); + } + + /** + * Initializes a MetadataStore, including allocation of resources. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.metadataStores.create({ + * // The {metadatastore\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all MetadataStores in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataStore.) + * metadataStoreId: 'placeholder-value', + * // Required. The resource name of the Location where the MetadataStore should be created. Format: `projects/{project\}/locations/{location\}/` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "dataplexConfig": {}, + * // "description": "my_description", + * // "encryptionSpec": {}, + * // "name": "my_name", + * // "state": {}, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Metadatastores$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Metadatastores$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Metadatastores$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Metadatastores$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Metadatastores$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Metadatastores$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/metadataStores').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts). + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.metadataStores.delete({ + * // Deprecated: Field is no longer supported. + * force: 'placeholder-value', + * // Required. The resource name of the MetadataStore to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Metadatastores$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Metadatastores$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a specific MetadataStore. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.metadataStores.get({ + * // Required. The resource name of the MetadataStore to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "dataplexConfig": {}, + * // "description": "my_description", + * // "encryptionSpec": {}, + * // "name": "my_name", + * // "state": {}, + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Metadatastores$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Metadatastores$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Metadatastores$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists MetadataStores for a Location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.metadataStores.list({ + * // The maximum number of Metadata Stores to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. + * pageSize: 'placeholder-value', + * // A page token, received from a previous MetadataService.ListMetadataStores call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) + * pageToken: 'placeholder-value', + * // Required. The Location whose MetadataStores should be listed. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "metadataStores": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Metadatastores$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Metadatastores$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Metadatastores$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Metadatastores$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Metadatastores$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Metadatastores$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/metadataStores').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Metadatastores$Create + extends StandardParameters { + /** + * The {metadatastore\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all MetadataStores in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataStore.) + */ + metadataStoreId?: string; + /** + * Required. The resource name of the Location where the MetadataStore should be created. Format: `projects/{project\}/locations/{location\}/` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1MetadataStore; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Delete + extends StandardParameters { + /** + * Deprecated: Field is no longer supported. + */ + force?: boolean; + /** + * Required. The resource name of the MetadataStore to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Get + extends StandardParameters { + /** + * Required. The resource name of the MetadataStore to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$List + extends StandardParameters { + /** + * The maximum number of Metadata Stores to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. + */ + pageSize?: number; + /** + * A page token, received from a previous MetadataService.ListMetadataStores call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) + */ + pageToken?: string; + /** + * Required. The Location whose MetadataStores should be listed. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + + export class Resource$Projects$Locations$Metadatastores$Artifacts { + context: APIRequestContext; + operations: Resource$Projects$Locations$Metadatastores$Artifacts$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Metadatastores$Artifacts$Operations( + this.context + ); + } + + /** + * Creates an Artifact associated with a MetadataStore. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.metadataStores.artifacts.create({ + * // The {artifact\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` If not provided, the Artifact's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Artifacts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Artifact.) + * artifactId: 'placeholder-value', + * // Required. The resource name of the MetadataStore where the Artifact should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * parent: + * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "schemaTitle": "my_schemaTitle", + * // "schemaVersion": "my_schemaVersion", + * // "state": "my_state", + * // "updateTime": "my_updateTime", + * // "uri": "my_uri" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "schemaTitle": "my_schemaTitle", + * // "schemaVersion": "my_schemaVersion", + * // "state": "my_state", + * // "updateTime": "my_updateTime", + * // "uri": "my_uri" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/artifacts').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Deletes an Artifact. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.metadataStores.artifacts.delete({ + * // Optional. The etag of the Artifact to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION. + * etag: 'placeholder-value', + * // Required. The resource name of the Artifact to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/artifacts/my-artifact', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a specific Artifact. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.metadataStores.artifacts.get({ + * // Required. The resource name of the Artifact to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/artifacts/my-artifact', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "schemaTitle": "my_schemaTitle", + * // "schemaVersion": "my_schemaVersion", + * // "state": "my_state", + * // "updateTime": "my_updateTime", + * // "uri": "my_uri" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists Artifacts in the MetadataStore. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.metadataStores.artifacts.list( + * { + * // Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = "test"`. Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` * **Context based filtering**: To filter Artifacts based on the contexts to which they belong, use the function operator with the full resource name `in_context()`. For example: `in_context("projects//locations//metadataStores//contexts/")` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. + * filter: 'placeholder-value', + * // How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details. + * orderBy: 'placeholder-value', + * // The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. + * pageSize: 'placeholder-value', + * // A page token, received from a previous MetadataService.ListArtifacts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) + * pageToken: 'placeholder-value', + * // Required. The MetadataStore whose Artifacts should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * parent: + * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "artifacts": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/artifacts').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates a stored Artifact. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.metadataStores.artifacts.patch({ + * // If set to true, and the Artifact is not found, a new Artifact is created. + * allowMissing: 'placeholder-value', + * // Output only. The resource name of the Artifact. + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/artifacts/my-artifact', + * // Optional. A FieldMask indicating which fields should be updated. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "schemaTitle": "my_schemaTitle", + * // "schemaVersion": "my_schemaVersion", + * // "state": "my_state", + * // "updateTime": "my_updateTime", + * // "uri": "my_uri" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "schemaTitle": "my_schemaTitle", + * // "schemaVersion": "my_schemaVersion", + * // "state": "my_state", + * // "updateTime": "my_updateTime", + * // "uri": "my_uri" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Purges Artifacts. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.metadataStores.artifacts.purge({ + * // Required. The metadata store to purge Artifacts from. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * parent: + * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "filter": "my_filter", + * // "force": false + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + purge( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge, + options: StreamMethodOptions + ): Promise>; + purge( + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge, + options?: MethodOptions + ): Promise>; + purge( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + purge( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + purge( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge, + callback: BodyResponseCallback + ): void; + purge( + callback: BodyResponseCallback + ): void; + purge( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/artifacts:purge').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.metadataStores.artifacts.queryArtifactLineageSubgraph( + * { + * // Required. The resource name of the Artifact whose Lineage needs to be retrieved as a LineageSubgraph. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000. + * artifact: + * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/artifacts/my-artifact', + * // Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the Lineage Subgraph. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = "test"` Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. + * filter: 'placeholder-value', + * // Specifies the size of the lineage graph in terms of number of hops from the specified artifact. Negative Value: INVALID_ARGUMENT error is returned 0: Only input artifact is returned. No value: Transitive closure is performed to return the complete graph. + * maxHops: 'placeholder-value', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "artifacts": [], + * // "events": [], + * // "executions": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + queryArtifactLineageSubgraph( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph, + options: StreamMethodOptions + ): Promise>; + queryArtifactLineageSubgraph( + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + queryArtifactLineageSubgraph( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + queryArtifactLineageSubgraph( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + queryArtifactLineageSubgraph( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph, + callback: BodyResponseCallback + ): void; + queryArtifactLineageSubgraph( + callback: BodyResponseCallback + ): void; + queryArtifactLineageSubgraph( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+artifact}:queryArtifactLineageSubgraph' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['artifact'], + pathParams: ['artifact'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create + extends StandardParameters { + /** + * The {artifact\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` If not provided, the Artifact's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Artifacts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Artifact.) + */ + artifactId?: string; + /** + * Required. The resource name of the MetadataStore where the Artifact should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Artifact; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete + extends StandardParameters { + /** + * Optional. The etag of the Artifact to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION. + */ + etag?: string; + /** + * Required. The resource name of the Artifact to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get + extends StandardParameters { + /** + * Required. The resource name of the Artifact to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$List + extends StandardParameters { + /** + * Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = "test"`. Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` * **Context based filtering**: To filter Artifacts based on the contexts to which they belong, use the function operator with the full resource name `in_context()`. For example: `in_context("projects//locations//metadataStores//contexts/")` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. + */ + filter?: string; + /** + * How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details. + */ + orderBy?: string; + /** + * The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. + */ + pageSize?: number; + /** + * A page token, received from a previous MetadataService.ListArtifacts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) + */ + pageToken?: string; + /** + * Required. The MetadataStore whose Artifacts should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch + extends StandardParameters { + /** + * If set to true, and the Artifact is not found, a new Artifact is created. + */ + allowMissing?: boolean; + /** + * Output only. The resource name of the Artifact. + */ + name?: string; + /** + * Optional. A FieldMask indicating which fields should be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Artifact; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge + extends StandardParameters { + /** + * Required. The metadata store to purge Artifacts from. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1PurgeArtifactsRequest; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph + extends StandardParameters { + /** + * Required. The resource name of the Artifact whose Lineage needs to be retrieved as a LineageSubgraph. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000. + */ + artifact?: string; + /** + * Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the Lineage Subgraph. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = "test"` Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. + */ + filter?: string; + /** + * Specifies the size of the lineage graph in terms of number of hops from the specified artifact. Negative Value: INVALID_ARGUMENT error is returned 0: Only input artifact is returned. No value: Transitive closure is performed to return the complete graph. + */ + maxHops?: number; + } + + export class Resource$Projects$Locations$Metadatastores$Artifacts$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.metadataStores.artifacts.operations.cancel( + * { + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/artifacts/my-artifact/operations/my-operation', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel, + options?: MethodOptions + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.metadataStores.artifacts.operations.delete( + * { + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/artifacts/my-artifact/operations/my-operation', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.metadataStores.artifacts.operations.get( + * { + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/artifacts/my-artifact/operations/my-operation', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.metadataStores.artifacts.operations.list( + * { + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/artifacts/my-artifact', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.metadataStores.artifacts.operations.wait( + * { + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/artifacts/my-artifact/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait, + options: StreamMethodOptions + ): Promise>; + wait( + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait, + options?: MethodOptions + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Metadatastores$Contexts { + context: APIRequestContext; + operations: Resource$Projects$Locations$Metadatastores$Contexts$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Metadatastores$Contexts$Operations( + this.context + ); + } + + /** + * Adds a set of Artifacts and Executions to a Context. If any of the Artifacts or Executions have already been added to a Context, they are simply skipped. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.metadataStores.contexts.addContextArtifactsAndExecutions( + * { + * // Required. The resource name of the Context that the Artifacts and Executions belong to. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` + * context: + * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "artifacts": [], + * // "executions": [] + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + addContextArtifactsAndExecutions( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions, + options: StreamMethodOptions + ): Promise>; + addContextArtifactsAndExecutions( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + addContextArtifactsAndExecutions( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addContextArtifactsAndExecutions( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addContextArtifactsAndExecutions( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions, + callback: BodyResponseCallback + ): void; + addContextArtifactsAndExecutions( + callback: BodyResponseCallback + ): void; + addContextArtifactsAndExecutions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+context}:addContextArtifactsAndExecutions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['context'], + pathParams: ['context'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Adds a set of Contexts as children to a parent Context. If any of the child Contexts have already been added to the parent Context, they are simply skipped. If this call would create a cycle or cause any Context to have more than 10 parents, the request will fail with an INVALID_ARGUMENT error. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.metadataStores.contexts.addContextChildren( + * { + * // Required. The resource name of the parent Context. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` + * context: + * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "childContexts": [] + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + addContextChildren( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren, + options: StreamMethodOptions + ): Promise>; + addContextChildren( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + addContextChildren( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addContextChildren( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addContextChildren( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren, + callback: BodyResponseCallback + ): void; + addContextChildren( + callback: BodyResponseCallback + ): void; + addContextChildren( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+context}:addContextChildren').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['context'], + pathParams: ['context'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Creates a Context associated with a MetadataStore. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.metadataStores.contexts.create({ + * // The {context\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}`. If not provided, the Context's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Contexts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Context.) + * contextId: 'placeholder-value', + * // Required. The resource name of the MetadataStore where the Context should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * parent: + * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "parentContexts": [], + * // "schemaTitle": "my_schemaTitle", + * // "schemaVersion": "my_schemaVersion", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "parentContexts": [], + * // "schemaTitle": "my_schemaTitle", + * // "schemaVersion": "my_schemaVersion", + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/contexts').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Deletes a stored Context. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.metadataStores.contexts.delete({ + * // Optional. The etag of the Context to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION. + * etag: 'placeholder-value', + * // The force deletion semantics is still undefined. Users should not use this field. + * force: 'placeholder-value', + * // Required. The resource name of the Context to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a specific Context. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.metadataStores.contexts.get({ + * // Required. The resource name of the Context to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "parentContexts": [], + * // "schemaTitle": "my_schemaTitle", + * // "schemaVersion": "my_schemaVersion", + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists Contexts on the MetadataStore. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.metadataStores.contexts.list({ + * // Filter specifying the boolean condition for the Contexts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = "test"`. Supported fields include: `name`, `display_name`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0`. In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` * **Parent Child filtering**: To filter Contexts based on parent-child relationship use the HAS operator as follows: ``` parent_contexts: "projects//locations//metadataStores//contexts/" child_contexts: "projects//locations//metadataStores//contexts/" ``` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. + * filter: 'placeholder-value', + * // How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details. + * orderBy: 'placeholder-value', + * // The maximum number of Contexts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. + * pageSize: 'placeholder-value', + * // A page token, received from a previous MetadataService.ListContexts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) + * pageToken: 'placeholder-value', + * // Required. The MetadataStore whose Contexts should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * parent: + * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "contexts": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Contexts$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/contexts').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates a stored Context. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.metadataStores.contexts.patch( + * { + * // If set to true, and the Context is not found, a new Context is created. + * allowMissing: 'placeholder-value', + * // Immutable. The resource name of the Context. + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context', + * // Optional. A FieldMask indicating which fields should be updated. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "parentContexts": [], + * // "schemaTitle": "my_schemaTitle", + * // "schemaVersion": "my_schemaVersion", + * // "updateTime": "my_updateTime" + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "parentContexts": [], + * // "schemaTitle": "my_schemaTitle", + * // "schemaVersion": "my_schemaVersion", + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Purges Contexts. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.metadataStores.contexts.purge( + * { + * // Required. The metadata store to purge Contexts from. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * parent: + * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "filter": "my_filter", + * // "force": false + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + purge( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge, + options: StreamMethodOptions + ): Promise>; + purge( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge, + options?: MethodOptions + ): Promise>; + purge( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + purge( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + purge( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge, + callback: BodyResponseCallback + ): void; + purge( + callback: BodyResponseCallback + ): void; + purge( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/contexts:purge').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.metadataStores.contexts.queryContextLineageSubgraph( + * { + * // Required. The resource name of the Context whose Artifacts and Executions should be retrieved as a LineageSubgraph. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000. + * context: + * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "artifacts": [], + * // "events": [], + * // "executions": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + queryContextLineageSubgraph( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph, + options: StreamMethodOptions + ): Promise>; + queryContextLineageSubgraph( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + queryContextLineageSubgraph( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + queryContextLineageSubgraph( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + queryContextLineageSubgraph( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph, + callback: BodyResponseCallback + ): void; + queryContextLineageSubgraph( + callback: BodyResponseCallback + ): void; + queryContextLineageSubgraph( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+context}:queryContextLineageSubgraph' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['context'], + pathParams: ['context'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Remove a set of children contexts from a parent Context. If any of the child Contexts were NOT added to the parent Context, they are simply skipped. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.metadataStores.contexts.removeContextChildren( + * { + * // Required. The resource name of the parent Context. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` + * context: + * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "childContexts": [] + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + removeContextChildren( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren, + options: StreamMethodOptions + ): Promise>; + removeContextChildren( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + removeContextChildren( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeContextChildren( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeContextChildren( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren, + callback: BodyResponseCallback + ): void; + removeContextChildren( + callback: BodyResponseCallback + ): void; + removeContextChildren( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+context}:removeContextChildren').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['context'], + pathParams: ['context'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions + extends StandardParameters { + /** + * Required. The resource name of the Context that the Artifacts and Executions belong to. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` + */ + context?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren + extends StandardParameters { + /** + * Required. The resource name of the parent Context. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` + */ + context?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1AddContextChildrenRequest; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Create + extends StandardParameters { + /** + * The {context\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}`. If not provided, the Context's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Contexts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Context.) + */ + contextId?: string; + /** + * Required. The resource name of the MetadataStore where the Context should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Context; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete + extends StandardParameters { + /** + * Optional. The etag of the Context to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION. + */ + etag?: string; + /** + * The force deletion semantics is still undefined. Users should not use this field. + */ + force?: boolean; + /** + * Required. The resource name of the Context to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Get + extends StandardParameters { + /** + * Required. The resource name of the Context to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$List + extends StandardParameters { + /** + * Filter specifying the boolean condition for the Contexts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = "test"`. Supported fields include: `name`, `display_name`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0`. In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` * **Parent Child filtering**: To filter Contexts based on parent-child relationship use the HAS operator as follows: ``` parent_contexts: "projects//locations//metadataStores//contexts/" child_contexts: "projects//locations//metadataStores//contexts/" ``` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. + */ + filter?: string; + /** + * How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details. + */ + orderBy?: string; + /** + * The maximum number of Contexts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. + */ + pageSize?: number; + /** + * A page token, received from a previous MetadataService.ListContexts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) + */ + pageToken?: string; + /** + * Required. The MetadataStore whose Contexts should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch + extends StandardParameters { + /** + * If set to true, and the Context is not found, a new Context is created. + */ + allowMissing?: boolean; + /** + * Immutable. The resource name of the Context. + */ + name?: string; + /** + * Optional. A FieldMask indicating which fields should be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Context; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge + extends StandardParameters { + /** + * Required. The metadata store to purge Contexts from. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1PurgeContextsRequest; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph + extends StandardParameters { + /** + * Required. The resource name of the Context whose Artifacts and Executions should be retrieved as a LineageSubgraph. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000. + */ + context?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren + extends StandardParameters { + /** + * Required. The resource name of the parent Context. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` + */ + context?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1RemoveContextChildrenRequest; + } + + export class Resource$Projects$Locations$Metadatastores$Contexts$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.metadataStores.contexts.operations.cancel( + * { + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context/operations/my-operation', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel, + options?: MethodOptions + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.metadataStores.contexts.operations.delete( + * { + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context/operations/my-operation', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.metadataStores.contexts.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.metadataStores.contexts.operations.list( + * { + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.metadataStores.contexts.operations.wait( + * { + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait, + options: StreamMethodOptions + ): Promise>; + wait( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait, + options?: MethodOptions + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Metadatastores$Executions { + context: APIRequestContext; + operations: Resource$Projects$Locations$Metadatastores$Executions$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Metadatastores$Executions$Operations( + this.context + ); + } + + /** + * Adds Events to the specified Execution. An Event indicates whether an Artifact was used as an input or output for an Execution. If an Event already exists between the Execution and the Artifact, the Event is skipped. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.metadataStores.executions.addExecutionEvents( + * { + * // Required. The resource name of the Execution that the Events connect Artifacts with. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` + * execution: + * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/executions/my-execution', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "events": [] + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + addExecutionEvents( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents, + options: StreamMethodOptions + ): Promise>; + addExecutionEvents( + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + addExecutionEvents( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addExecutionEvents( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addExecutionEvents( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents, + callback: BodyResponseCallback + ): void; + addExecutionEvents( + callback: BodyResponseCallback + ): void; + addExecutionEvents( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+execution}:addExecutionEvents').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['execution'], + pathParams: ['execution'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Creates an Execution associated with a MetadataStore. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.metadataStores.executions.create({ + * // The {execution\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` If not provided, the Execution's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Executions in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Execution.) + * executionId: 'placeholder-value', + * // Required. The resource name of the MetadataStore where the Execution should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * parent: + * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "schemaTitle": "my_schemaTitle", + * // "schemaVersion": "my_schemaVersion", + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "schemaTitle": "my_schemaTitle", + * // "schemaVersion": "my_schemaVersion", + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Create, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Executions$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/executions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Deletes an Execution. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.metadataStores.executions.delete({ + * // Optional. The etag of the Execution to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION. + * etag: 'placeholder-value', + * // Required. The resource name of the Execution to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/executions/my-execution', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Executions$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a specific Execution. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.metadataStores.executions.get( + * { + * // Required. The resource name of the Execution to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/executions/my-execution', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "schemaTitle": "my_schemaTitle", + * // "schemaVersion": "my_schemaVersion", + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Executions$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists Executions in the MetadataStore. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.metadataStores.executions.list({ + * // Filter specifying the boolean condition for the Executions to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = "test"`. Supported fields include: `name`, `display_name`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..` For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` * **Context based filtering**: To filter Executions based on the contexts to which they belong use the function operator with the full resource name: `in_context()`. For example: `in_context("projects//locations//metadataStores//contexts/")` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. + * filter: 'placeholder-value', + * // How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details. + * orderBy: 'placeholder-value', + * // The maximum number of Executions to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. + * pageSize: 'placeholder-value', + * // A page token, received from a previous MetadataService.ListExecutions call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with an INVALID_ARGUMENT error.) + * pageToken: 'placeholder-value', + * // Required. The MetadataStore whose Executions should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * parent: + * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "executions": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Executions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/executions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates a stored Execution. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.metadataStores.executions.patch({ + * // If set to true, and the Execution is not found, a new Execution is created. + * allowMissing: 'placeholder-value', + * // Output only. The resource name of the Execution. + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/executions/my-execution', + * // Optional. A FieldMask indicating which fields should be updated. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "schemaTitle": "my_schemaTitle", + * // "schemaVersion": "my_schemaVersion", + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "schemaTitle": "my_schemaTitle", + * // "schemaVersion": "my_schemaVersion", + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Patch, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + patch( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Executions$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Purges Executions. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.metadataStores.executions.purge({ + * // Required. The metadata store to purge Executions from. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * parent: + * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "filter": "my_filter", + * // "force": false + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + purge( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Purge, + options: StreamMethodOptions + ): Promise>; + purge( + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Purge, + options?: MethodOptions + ): Promise>; + purge( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Purge, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + purge( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Purge, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + purge( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Purge, + callback: BodyResponseCallback + ): void; + purge( + callback: BodyResponseCallback + ): void; + purge( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Executions$Purge + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Purge; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Purge; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/executions:purge').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.metadataStores.executions.queryExecutionInputsAndOutputs( + * { + * // Required. The resource name of the Execution whose input and output Artifacts should be retrieved as a LineageSubgraph. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` + * execution: + * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/executions/my-execution', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "artifacts": [], + * // "events": [], + * // "executions": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + queryExecutionInputsAndOutputs( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs, + options: StreamMethodOptions + ): Promise>; + queryExecutionInputsAndOutputs( + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + queryExecutionInputsAndOutputs( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + queryExecutionInputsAndOutputs( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + queryExecutionInputsAndOutputs( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs, + callback: BodyResponseCallback + ): void; + queryExecutionInputsAndOutputs( + callback: BodyResponseCallback + ): void; + queryExecutionInputsAndOutputs( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+execution}:queryExecutionInputsAndOutputs' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['execution'], + pathParams: ['execution'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents + extends StandardParameters { + /** + * Required. The resource name of the Execution that the Events connect Artifacts with. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` + */ + execution?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1AddExecutionEventsRequest; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Create + extends StandardParameters { + /** + * The {execution\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` If not provided, the Execution's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Executions in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Execution.) + */ + executionId?: string; + /** + * Required. The resource name of the MetadataStore where the Execution should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Execution; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Delete + extends StandardParameters { + /** + * Optional. The etag of the Execution to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION. + */ + etag?: string; + /** + * Required. The resource name of the Execution to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Get + extends StandardParameters { + /** + * Required. The resource name of the Execution to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$List + extends StandardParameters { + /** + * Filter specifying the boolean condition for the Executions to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = "test"`. Supported fields include: `name`, `display_name`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..` For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` * **Context based filtering**: To filter Executions based on the contexts to which they belong use the function operator with the full resource name: `in_context()`. For example: `in_context("projects//locations//metadataStores//contexts/")` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. + */ + filter?: string; + /** + * How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details. + */ + orderBy?: string; + /** + * The maximum number of Executions to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. + */ + pageSize?: number; + /** + * A page token, received from a previous MetadataService.ListExecutions call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with an INVALID_ARGUMENT error.) + */ + pageToken?: string; + /** + * Required. The MetadataStore whose Executions should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Patch + extends StandardParameters { + /** + * If set to true, and the Execution is not found, a new Execution is created. + */ + allowMissing?: boolean; + /** + * Output only. The resource name of the Execution. + */ + name?: string; + /** + * Optional. A FieldMask indicating which fields should be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Execution; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Purge + extends StandardParameters { + /** + * Required. The metadata store to purge Executions from. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1PurgeExecutionsRequest; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs + extends StandardParameters { + /** + * Required. The resource name of the Execution whose input and output Artifacts should be retrieved as a LineageSubgraph. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` + */ + execution?: string; + } + + export class Resource$Projects$Locations$Metadatastores$Executions$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.metadataStores.executions.operations.cancel( + * { + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/executions/my-execution/operations/my-operation', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel, + options?: MethodOptions + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.metadataStores.executions.operations.delete( + * { + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/executions/my-execution/operations/my-operation', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.metadataStores.executions.operations.get( + * { + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/executions/my-execution/operations/my-operation', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.metadataStores.executions.operations.list( + * { + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/executions/my-execution', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.metadataStores.executions.operations.wait( + * { + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/executions/my-execution/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait, + options: StreamMethodOptions + ): Promise>; + wait( + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait, + options?: MethodOptions + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Metadatastores$Metadataschemas { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a MetadataSchema. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.metadataStores.metadataSchemas.create({ + * // The {metadata_schema\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/metadataSchemas/{metadataschema\}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all MetadataSchemas in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataSchema.) + * metadataSchemaId: 'placeholder-value', + * // Required. The resource name of the MetadataStore where the MetadataSchema should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * parent: + * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "name": "my_name", + * // "schema": "my_schema", + * // "schemaType": "my_schemaType", + * // "schemaVersion": "my_schemaVersion" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "name": "my_name", + * // "schema": "my_schema", + * // "schemaType": "my_schemaType", + * // "schemaVersion": "my_schemaVersion" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/metadataSchemas').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Retrieves a specific MetadataSchema. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.metadataStores.metadataSchemas.get({ + * // Required. The resource name of the MetadataSchema to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/metadataSchemas/{metadataschema\}` + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/metadataSchemas/my-metadataSchema', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "name": "my_name", + * // "schema": "my_schema", + * // "schemaType": "my_schemaType", + * // "schemaVersion": "my_schemaVersion" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists MetadataSchemas. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.metadataStores.metadataSchemas.list({ + * // A query to filter available MetadataSchemas for matching results. + * filter: 'placeholder-value', + * // The maximum number of MetadataSchemas to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. + * pageSize: 'placeholder-value', + * // A page token, received from a previous MetadataService.ListMetadataSchemas call. Provide this to retrieve the next page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) + * pageToken: 'placeholder-value', + * // Required. The MetadataStore whose MetadataSchemas should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * parent: + * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "metadataSchemas": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/metadataSchemas').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create + extends StandardParameters { + /** + * The {metadata_schema\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/metadataSchemas/{metadataschema\}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all MetadataSchemas in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataSchema.) + */ + metadataSchemaId?: string; + /** + * Required. The resource name of the MetadataStore where the MetadataSchema should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1MetadataSchema; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get + extends StandardParameters { + /** + * Required. The resource name of the MetadataSchema to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/metadataSchemas/{metadataschema\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List + extends StandardParameters { + /** + * A query to filter available MetadataSchemas for matching results. + */ + filter?: string; + /** + * The maximum number of MetadataSchemas to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. + */ + pageSize?: number; + /** + * A page token, received from a previous MetadataService.ListMetadataSchemas call. Provide this to retrieve the next page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) + */ + pageToken?: string; + /** + * Required. The MetadataStore whose MetadataSchemas should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + */ + parent?: string; + } + + export class Resource$Projects$Locations$Metadatastores$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.metadataStores.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel, + options?: MethodOptions + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.metadataStores.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Metadatastores$Operations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.metadataStores.operations.get( + * { + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/operations/my-operation', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Metadatastores$Operations$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.metadataStores.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Metadatastores$Operations$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.metadataStores.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Wait, + options: StreamMethodOptions + ): Promise>; + wait( + params?: Params$Resource$Projects$Locations$Metadatastores$Operations$Wait, + options?: MethodOptions + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Operations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Migratableresources { + context: APIRequestContext; + operations: Resource$Projects$Locations$Migratableresources$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Migratableresources$Operations( + this.context + ); + } + + /** + * Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.migratableResources.batchMigrate({ + * // Required. The location of the migrated resource will live in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "migrateResourceRequests": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + batchMigrate( + params: Params$Resource$Projects$Locations$Migratableresources$Batchmigrate, + options: StreamMethodOptions + ): Promise>; + batchMigrate( + params?: Params$Resource$Projects$Locations$Migratableresources$Batchmigrate, + options?: MethodOptions + ): Promise>; + batchMigrate( + params: Params$Resource$Projects$Locations$Migratableresources$Batchmigrate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchMigrate( + params: Params$Resource$Projects$Locations$Migratableresources$Batchmigrate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchMigrate( + params: Params$Resource$Projects$Locations$Migratableresources$Batchmigrate, + callback: BodyResponseCallback + ): void; + batchMigrate( + callback: BodyResponseCallback + ): void; + batchMigrate( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Migratableresources$Batchmigrate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Migratableresources$Batchmigrate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Migratableresources$Batchmigrate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+parent}/migratableResources:batchMigrate' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.migratableResources.search({ + * // Required. The location that the migratable resources should be searched from. It's the Vertex AI location that the resources can be migrated to, not the resources' original location. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "filter": "my_filter", + * // "pageSize": 0, + * // "pageToken": "my_pageToken" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "migratableResources": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + search( + params: Params$Resource$Projects$Locations$Migratableresources$Search, + options: StreamMethodOptions + ): Promise>; + search( + params?: Params$Resource$Projects$Locations$Migratableresources$Search, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + search( + params: Params$Resource$Projects$Locations$Migratableresources$Search, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + search( + params: Params$Resource$Projects$Locations$Migratableresources$Search, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + search( + params: Params$Resource$Projects$Locations$Migratableresources$Search, + callback: BodyResponseCallback + ): void; + search( + callback: BodyResponseCallback + ): void; + search( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Migratableresources$Search + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Migratableresources$Search; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Migratableresources$Search; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/migratableResources:search').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Migratableresources$Batchmigrate + extends StandardParameters { + /** + * Required. The location of the migrated resource will live in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1BatchMigrateResourcesRequest; + } + export interface Params$Resource$Projects$Locations$Migratableresources$Search + extends StandardParameters { + /** + * Required. The location that the migratable resources should be searched from. It's the Vertex AI location that the resources can be migrated to, not the resources' original location. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1SearchMigratableResourcesRequest; + } + + export class Resource$Projects$Locations$Migratableresources$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.migratableResources.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/migratableResources/my-migratableResource/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel, + options?: MethodOptions + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.migratableResources.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/migratableResources/my-migratableResource/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Migratableresources$Operations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Migratableresources$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Migratableresources$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Migratableresources$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.migratableResources.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/migratableResources/my-migratableResource/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Migratableresources$Operations$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Migratableresources$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Migratableresources$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Migratableresources$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.migratableResources.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/migratableResources/my-migratableResource', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Migratableresources$Operations$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Migratableresources$Operations$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Migratableresources$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Migratableresources$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Migratableresources$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Migratableresources$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Migratableresources$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Migratableresources$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.migratableResources.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/migratableResources/my-migratableResource/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + wait( + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Wait, + options: StreamMethodOptions + ): Promise>; + wait( + params?: Params$Resource$Projects$Locations$Migratableresources$Operations$Wait, + options?: MethodOptions + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Migratableresources$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Migratableresources$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Migratableresources$Operations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Migratableresources$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Migratableresources$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Migratableresources$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Migratableresources$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Modeldeploymentmonitoringjobs { + context: APIRequestContext; + operations: Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations( + this.context + ); + } + + /** + * Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.create({ + * // Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "analysisInstanceSchemaUri": "my_analysisInstanceSchemaUri", + * // "bigqueryTables": [], + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "enableMonitoringPipelineLogs": false, + * // "encryptionSpec": {}, + * // "endpoint": "my_endpoint", + * // "error": {}, + * // "labels": {}, + * // "latestMonitoringPipelineMetadata": {}, + * // "logTtl": "my_logTtl", + * // "loggingSamplingStrategy": {}, + * // "modelDeploymentMonitoringObjectiveConfigs": [], + * // "modelDeploymentMonitoringScheduleConfig": {}, + * // "modelMonitoringAlertConfig": {}, + * // "name": "my_name", + * // "nextScheduleTime": "my_nextScheduleTime", + * // "predictInstanceSchemaUri": "my_predictInstanceSchemaUri", + * // "samplePredictInstance": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "scheduleState": "my_scheduleState", + * // "state": "my_state", + * // "statsAnomaliesBaseDirectory": {}, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "analysisInstanceSchemaUri": "my_analysisInstanceSchemaUri", + * // "bigqueryTables": [], + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "enableMonitoringPipelineLogs": false, + * // "encryptionSpec": {}, + * // "endpoint": "my_endpoint", + * // "error": {}, + * // "labels": {}, + * // "latestMonitoringPipelineMetadata": {}, + * // "logTtl": "my_logTtl", + * // "loggingSamplingStrategy": {}, + * // "modelDeploymentMonitoringObjectiveConfigs": [], + * // "modelDeploymentMonitoringScheduleConfig": {}, + * // "modelMonitoringAlertConfig": {}, + * // "name": "my_name", + * // "nextScheduleTime": "my_nextScheduleTime", + * // "predictInstanceSchemaUri": "my_predictInstanceSchemaUri", + * // "samplePredictInstance": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "scheduleState": "my_scheduleState", + * // "state": "my_state", + * // "statsAnomaliesBaseDirectory": {}, + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+parent}/modelDeploymentMonitoringJobs' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Deletes a ModelDeploymentMonitoringJob. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.delete({ + * // Required. The resource name of the model monitoring job to delete. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` + * name: 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a ModelDeploymentMonitoringJob. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.get({ + * // Required. The resource name of the ModelDeploymentMonitoringJob. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` + * name: 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "analysisInstanceSchemaUri": "my_analysisInstanceSchemaUri", + * // "bigqueryTables": [], + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "enableMonitoringPipelineLogs": false, + * // "encryptionSpec": {}, + * // "endpoint": "my_endpoint", + * // "error": {}, + * // "labels": {}, + * // "latestMonitoringPipelineMetadata": {}, + * // "logTtl": "my_logTtl", + * // "loggingSamplingStrategy": {}, + * // "modelDeploymentMonitoringObjectiveConfigs": [], + * // "modelDeploymentMonitoringScheduleConfig": {}, + * // "modelMonitoringAlertConfig": {}, + * // "name": "my_name", + * // "nextScheduleTime": "my_nextScheduleTime", + * // "predictInstanceSchemaUri": "my_predictInstanceSchemaUri", + * // "samplePredictInstance": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "scheduleState": "my_scheduleState", + * // "state": "my_state", + * // "statsAnomaliesBaseDirectory": {}, + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists ModelDeploymentMonitoringJobs in a Location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.list({ + * // The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` + * filter: 'placeholder-value', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // Mask specifying which fields to read + * readMask: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "modelDeploymentMonitoringJobs": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+parent}/modelDeploymentMonitoringJobs' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates a ModelDeploymentMonitoringJob. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.patch({ + * // Output only. Resource name of a ModelDeploymentMonitoringJob. + * name: 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob', + * // Required. The update mask is used to specify the fields to be overwritten in the ModelDeploymentMonitoringJob resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. For the objective config, the user can either provide the update mask for model_deployment_monitoring_objective_configs or any combination of its nested fields, such as: model_deployment_monitoring_objective_configs.objective_config.training_dataset. Updatable fields: * `display_name` * `model_deployment_monitoring_schedule_config` * `model_monitoring_alert_config` * `logging_sampling_strategy` * `labels` * `log_ttl` * `enable_monitoring_pipeline_logs` . and * `model_deployment_monitoring_objective_configs` . or * `model_deployment_monitoring_objective_configs.objective_config.training_dataset` * `model_deployment_monitoring_objective_configs.objective_config.training_prediction_skew_detection_config` * `model_deployment_monitoring_objective_configs.objective_config.prediction_drift_detection_config` + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "analysisInstanceSchemaUri": "my_analysisInstanceSchemaUri", + * // "bigqueryTables": [], + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "enableMonitoringPipelineLogs": false, + * // "encryptionSpec": {}, + * // "endpoint": "my_endpoint", + * // "error": {}, + * // "labels": {}, + * // "latestMonitoringPipelineMetadata": {}, + * // "logTtl": "my_logTtl", + * // "loggingSamplingStrategy": {}, + * // "modelDeploymentMonitoringObjectiveConfigs": [], + * // "modelDeploymentMonitoringScheduleConfig": {}, + * // "modelMonitoringAlertConfig": {}, + * // "name": "my_name", + * // "nextScheduleTime": "my_nextScheduleTime", + * // "predictInstanceSchemaUri": "my_predictInstanceSchemaUri", + * // "samplePredictInstance": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "scheduleState": "my_scheduleState", + * // "state": "my_state", + * // "statsAnomaliesBaseDirectory": {}, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Pauses a ModelDeploymentMonitoringJob. If the job is running, the server makes a best effort to cancel the job. Will mark ModelDeploymentMonitoringJob.state to 'PAUSED'. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.pause({ + * // Required. The resource name of the ModelDeploymentMonitoringJob to pause. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` + * name: 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + pause( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause, + options: StreamMethodOptions + ): Promise>; + pause( + params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause, + options?: MethodOptions + ): Promise>; + pause( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + pause( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + pause( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause, + callback: BodyResponseCallback + ): void; + pause(callback: BodyResponseCallback): void; + pause( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:pause').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.resume({ + * // Required. The resource name of the ModelDeploymentMonitoringJob to resume. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` + * name: 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + resume( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume, + options: StreamMethodOptions + ): Promise>; + resume( + params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume, + options?: MethodOptions + ): Promise>; + resume( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + resume( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + resume( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume, + callback: BodyResponseCallback + ): void; + resume(callback: BodyResponseCallback): void; + resume( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:resume').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Searches Model Monitoring Statistics generated within a given time window. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.searchModelDeploymentMonitoringStatsAnomalies( + * { + * // Required. ModelDeploymentMonitoring Job resource name. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` + * modelDeploymentMonitoringJob: + * 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "deployedModelId": "my_deployedModelId", + * // "endTime": "my_endTime", + * // "featureDisplayName": "my_featureDisplayName", + * // "objectives": [], + * // "pageSize": 0, + * // "pageToken": "my_pageToken", + * // "startTime": "my_startTime" + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "monitoringStats": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + searchModelDeploymentMonitoringStatsAnomalies( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies, + options: StreamMethodOptions + ): Promise>; + searchModelDeploymentMonitoringStatsAnomalies( + params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + searchModelDeploymentMonitoringStatsAnomalies( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchModelDeploymentMonitoringStatsAnomalies( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchModelDeploymentMonitoringStatsAnomalies( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies, + callback: BodyResponseCallback + ): void; + searchModelDeploymentMonitoringStatsAnomalies( + callback: BodyResponseCallback + ): void; + searchModelDeploymentMonitoringStatsAnomalies( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/{+modelDeploymentMonitoringJob}:searchModelDeploymentMonitoringStatsAnomalies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['modelDeploymentMonitoringJob'], + pathParams: ['modelDeploymentMonitoringJob'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create + extends StandardParameters { + /** + * Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ModelDeploymentMonitoringJob; + } + export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete + extends StandardParameters { + /** + * Required. The resource name of the model monitoring job to delete. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get + extends StandardParameters { + /** + * Required. The resource name of the ModelDeploymentMonitoringJob. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List + extends StandardParameters { + /** + * The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` + */ + filter?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Mask specifying which fields to read + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch + extends StandardParameters { + /** + * Output only. Resource name of a ModelDeploymentMonitoringJob. + */ + name?: string; + /** + * Required. The update mask is used to specify the fields to be overwritten in the ModelDeploymentMonitoringJob resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. For the objective config, the user can either provide the update mask for model_deployment_monitoring_objective_configs or any combination of its nested fields, such as: model_deployment_monitoring_objective_configs.objective_config.training_dataset. Updatable fields: * `display_name` * `model_deployment_monitoring_schedule_config` * `model_monitoring_alert_config` * `logging_sampling_strategy` * `labels` * `log_ttl` * `enable_monitoring_pipeline_logs` . and * `model_deployment_monitoring_objective_configs` . or * `model_deployment_monitoring_objective_configs.objective_config.training_dataset` * `model_deployment_monitoring_objective_configs.objective_config.training_prediction_skew_detection_config` * `model_deployment_monitoring_objective_configs.objective_config.prediction_drift_detection_config` + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ModelDeploymentMonitoringJob; + } + export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause + extends StandardParameters { + /** + * Required. The resource name of the ModelDeploymentMonitoringJob to pause. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest; + } + export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume + extends StandardParameters { + /** + * Required. The resource name of the ModelDeploymentMonitoringJob to resume. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest; + } + export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies + extends StandardParameters { + /** + * Required. ModelDeploymentMonitoring Job resource name. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` + */ + modelDeploymentMonitoringJob?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest; + } + + export class Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.cancel( + * { + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob/operations/my-operation', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel, + options?: MethodOptions + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.delete( + * { + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob/operations/my-operation', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.get( + * { + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob/operations/my-operation', + * }, + * ); + * console.log(res.data); * * // Example response * // { @@ -72604,36 +109618,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Delete, + get( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Metadatastores$Delete, + get( + params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Delete, + get( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Delete, + get( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Delete, + get( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get, callback: BodyResponseCallback ): void; - delete( + get( callback: BodyResponseCallback ): void; - delete( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Delete + | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -72649,12 +109663,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Delete; + {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Metadatastores$Delete; + params = + {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get; options = {}; } @@ -72668,7 +109683,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -72689,7 +109704,7 @@ export namespace aiplatform_v1 { } /** - * Retrieves a specific MetadataStore. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -72718,21 +109733,28 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.metadataStores.get({ - * // Required. The resource name of the MetadataStore to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', - * }); + * const res = + * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.list( + * { + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "dataplexConfig": {}, - * // "description": "my_description", - * // "encryptionSpec": {}, - * // "name": "my_name", - * // "state": {}, - * // "updateTime": "my_updateTime" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -72748,61 +109770,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Metadatastores$Get, + list( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Metadatastores$Get, + list( + params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Get, + list( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Get, + list( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Get; + {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Metadatastores$Get; + params = + {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List; options = {}; } @@ -72815,7 +109838,10 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -72827,19 +109853,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists MetadataStores for a Location. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -72867,21 +109893,25 @@ export namespace aiplatform_v1 { * const authClient = await auth.getClient(); * google.options({auth: authClient}); * - * // Do the magic - * const res = await aiplatform.projects.locations.metadataStores.list({ - * // The maximum number of Metadata Stores to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. - * pageSize: 'placeholder-value', - * // A page token, received from a previous MetadataService.ListMetadataStores call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) - * pageToken: 'placeholder-value', - * // Required. The Location whose MetadataStores should be listed. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * }); + * // Do the magic + * const res = + * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.wait( + * { + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "metadataStores": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -72897,61 +109927,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Metadatastores$List, + wait( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Metadatastores$List, + wait( + params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Metadatastores$List, + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Metadatastores$List, + wait( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Metadatastores$List, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - list( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$List; + {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Metadatastores$List; + params = + {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait; options = {}; } @@ -72964,96 +109991,100 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/metadataStores').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Metadatastores$Create + export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel extends StandardParameters { /** - * The {metadatastore\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all MetadataStores in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataStore.) - */ - metadataStoreId?: string; - /** - * Required. The resource name of the Location where the MetadataStore should be created. Format: `projects/{project\}/locations/{location\}/` - */ - parent?: string; - - /** - * Request body metadata + * The name of the operation resource to be cancelled. */ - requestBody?: Schema$GoogleCloudAiplatformV1MetadataStore; + name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Delete + export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete extends StandardParameters { /** - * Deprecated: Field is no longer supported. - */ - force?: boolean; - /** - * Required. The resource name of the MetadataStore to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Get + export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get extends StandardParameters { /** - * Required. The resource name of the MetadataStore to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$List + export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List extends StandardParameters { /** - * The maximum number of Metadata Stores to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. */ pageSize?: number; /** - * A page token, received from a previous MetadataService.ListMetadataStores call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) + * The standard list page token. */ pageToken?: string; /** - * Required. The Location whose MetadataStores should be listed. Format: `projects/{project\}/locations/{location\}` + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - parent?: string; + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; } - export class Resource$Projects$Locations$Metadatastores$Artifacts { + export class Resource$Projects$Locations$Models { context: APIRequestContext; - operations: Resource$Projects$Locations$Metadatastores$Artifacts$Operations; + evaluations: Resource$Projects$Locations$Models$Evaluations; + operations: Resource$Projects$Locations$Models$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = - new Resource$Projects$Locations$Metadatastores$Artifacts$Operations( - this.context - ); + this.evaluations = new Resource$Projects$Locations$Models$Evaluations( + this.context + ); + this.operations = new Resource$Projects$Locations$Models$Operations( + this.context + ); } /** - * Creates an Artifact associated with a MetadataStore. + * Copies an already existing Vertex AI Model into the specified Location. The source Model must exist in the same Project. When copying custom Models, the users themselves are responsible for Model.metadata content to be region-agnostic, as well as making sure that any resources (e.g. files) it depends on remain accessible. * @example * ```js * // Before running the sample: @@ -73082,49 +110113,30 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.artifacts.create({ - * // The {artifact\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` If not provided, the Artifact's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Artifacts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Artifact.) - * artifactId: 'placeholder-value', - * // Required. The resource name of the MetadataStore where the Artifact should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - * parent: - * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', + * const res = await aiplatform.projects.locations.models.copy({ + * // Required. The resource name of the Location into which to copy the Model. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "schemaTitle": "my_schemaTitle", - * // "schemaVersion": "my_schemaVersion", - * // "state": "my_state", - * // "updateTime": "my_updateTime", - * // "uri": "my_uri" - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "encryptionSpec": {}, + * // "modelId": "my_modelId", + * // "parentModel": "my_parentModel", + * // "sourceModel": "my_sourceModel" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, + * // "done": false, + * // "error": {}, * // "metadata": {}, * // "name": "my_name", - * // "schemaTitle": "my_schemaTitle", - * // "schemaVersion": "my_schemaVersion", - * // "state": "my_state", - * // "updateTime": "my_updateTime", - * // "uri": "my_uri" + * // "response": {} * // } * } * @@ -73140,58 +110152,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create, + copy( + params: Params$Resource$Projects$Locations$Models$Copy, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create, + copy( + params?: Params$Resource$Projects$Locations$Models$Copy, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create, + ): Promise>; + copy( + params: Params$Resource$Projects$Locations$Models$Copy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create, + copy( + params: Params$Resource$Projects$Locations$Models$Copy, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create, - callback: BodyResponseCallback + copy( + params: Params$Resource$Projects$Locations$Models$Copy, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + copy( + callback: BodyResponseCallback ): void; - create( + copy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Copy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create; + {}) as Params$Resource$Projects$Locations$Models$Copy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create; + params = {} as Params$Resource$Projects$Locations$Models$Copy; options = {}; } @@ -73204,7 +110215,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/artifacts').replace( + url: (rootUrl + '/v1/{+parent}/models:copy').replace( /([^:]\/)\/+/g, '$1' ), @@ -73219,19 +110230,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes an Artifact. + * Deletes a Model. A model cannot be deleted if any Endpoint resource has a DeployedModel based on the model in its deployed_models field. * @example * ```js * // Before running the sample: @@ -73260,13 +110269,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.artifacts.delete({ - * // Optional. The etag of the Artifact to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION. - * etag: 'placeholder-value', - * // Required. The resource name of the Artifact to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/artifacts/my-artifact', - * }); + * const res = await aiplatform.projects.locations.models.delete({ + * // Required. The name of the Model resource to be deleted. Format: `projects/{project\}/locations/{location\}/models/{model\}` + * name: 'projects/my-project/locations/my-location/models/my-model', + * }); * console.log(res.data); * * // Example response @@ -73292,27 +110298,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete, + params: Params$Resource$Projects$Locations$Models$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete, + params?: Params$Resource$Projects$Locations$Models$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete, + params: Params$Resource$Projects$Locations$Models$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete, + params: Params$Resource$Projects$Locations$Models$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete, + params: Params$Resource$Projects$Locations$Models$Delete, callback: BodyResponseCallback ): void; delete( @@ -73320,7 +110326,7 @@ export namespace aiplatform_v1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete + | Params$Resource$Projects$Locations$Models$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -73336,13 +110342,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete; + {}) as Params$Resource$Projects$Locations$Models$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete; + params = {} as Params$Resource$Projects$Locations$Models$Delete; options = {}; } @@ -73377,7 +110382,7 @@ export namespace aiplatform_v1 { } /** - * Retrieves a specific Artifact. + * Deletes a Model version. Model version can only be deleted if there are no DeployedModels created from it. Deleting the only version in the Model is not allowed. Use DeleteModel for deleting the Model instead. * @example * ```js * // Before running the sample: @@ -73406,26 +110411,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.metadataStores.artifacts.get({ - * // Required. The resource name of the Artifact to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/artifacts/my-artifact', + * const res = await aiplatform.projects.locations.models.deleteVersion({ + * // Required. The name of the model version to be deleted, with a version ID explicitly included. Example: `projects/{project\}/locations/{location\}/models/{model\}@1234` + * name: 'projects/my-project/locations/my-location/models/my-model', * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, + * // "done": false, + * // "error": {}, * // "metadata": {}, * // "name": "my_name", - * // "schemaTitle": "my_schemaTitle", - * // "schemaVersion": "my_schemaVersion", - * // "state": "my_state", - * // "updateTime": "my_updateTime", - * // "uri": "my_uri" + * // "response": {} * // } * } * @@ -73441,58 +110439,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get, + deleteVersion( + params: Params$Resource$Projects$Locations$Models$Deleteversion, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get, + deleteVersion( + params?: Params$Resource$Projects$Locations$Models$Deleteversion, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get, + ): Promise>; + deleteVersion( + params: Params$Resource$Projects$Locations$Models$Deleteversion, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get, + deleteVersion( + params: Params$Resource$Projects$Locations$Models$Deleteversion, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get, - callback: BodyResponseCallback + deleteVersion( + params: Params$Resource$Projects$Locations$Models$Deleteversion, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + deleteVersion( + callback: BodyResponseCallback ): void; - get( + deleteVersion( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Deleteversion + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get; + {}) as Params$Resource$Projects$Locations$Models$Deleteversion; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get; + params = {} as Params$Resource$Projects$Locations$Models$Deleteversion; options = {}; } @@ -73505,8 +110502,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:deleteVersion').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'DELETE', apiVersion: '', }, options @@ -73517,19 +110517,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists Artifacts in the MetadataStore. + * Exports a trained, exportable Model to a location specified by the user. A Model is considered to be exportable if it has at least one supported export format. * @example * ```js * // Before running the sample: @@ -73558,27 +110556,27 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.metadataStores.artifacts.list( - * { - * // Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = "test"`. Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` * **Context based filtering**: To filter Artifacts based on the contexts to which they belong, use the function operator with the full resource name `in_context()`. For example: `in_context("projects//locations//metadataStores//contexts/")` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. - * filter: 'placeholder-value', - * // How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details. - * orderBy: 'placeholder-value', - * // The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. - * pageSize: 'placeholder-value', - * // A page token, received from a previous MetadataService.ListArtifacts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) - * pageToken: 'placeholder-value', - * // Required. The MetadataStore whose Artifacts should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - * parent: - * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', + * const res = await aiplatform.projects.locations.models.export({ + * // Required. The resource name of the Model to export. The resource name may contain version id or version alias to specify the version, if no version is specified, the default version will be exported. + * name: 'projects/my-project/locations/my-location/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "outputConfig": {} + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response * // { - * // "artifacts": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -73594,62 +110592,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$List, + export( + params: Params$Resource$Projects$Locations$Models$Export, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$List, + export( + params?: Params$Resource$Projects$Locations$Models$Export, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$List, + ): Promise>; + export( + params: Params$Resource$Projects$Locations$Models$Export, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$List, + export( + params: Params$Resource$Projects$Locations$Models$Export, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$List, - callback: BodyResponseCallback + export( + params: Params$Resource$Projects$Locations$Models$Export, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + export( + callback: BodyResponseCallback ): void; - list( + export( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Export + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$List; + {}) as Params$Resource$Projects$Locations$Models$Export; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$List; + params = {} as Params$Resource$Projects$Locations$Models$Export; options = {}; } @@ -73662,34 +110655,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/artifacts').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:export').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a stored Artifact. + * Gets a Model. * @example * ```js * // Before running the sample: @@ -73718,50 +110706,49 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.artifacts.patch({ - * // If set to true, and the Artifact is not found, a new Artifact is created. - * allowMissing: 'placeholder-value', - * // Output only. The resource name of the Artifact. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/artifacts/my-artifact', - * // Optional. A FieldMask indicating which fields should be updated. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "schemaTitle": "my_schemaTitle", - * // "schemaVersion": "my_schemaVersion", - * // "state": "my_state", - * // "updateTime": "my_updateTime", - * // "uri": "my_uri" - * // } - * }, - * }); + * const res = await aiplatform.projects.locations.models.get({ + * // Required. The name of the Model resource. Format: `projects/{project\}/locations/{location\}/models/{model\}` In order to retrieve a specific version of the model, also provide the version ID or version alias. Example: `projects/{project\}/locations/{location\}/models/{model\}@2` or `projects/{project\}/locations/{location\}/models/{model\}@golden` If no version ID or alias is specified, the "default" version will be returned. The "default" version alias is created for the first version of the model, and can be moved to other versions later on. There will be exactly one default version. + * name: 'projects/my-project/locations/my-location/models/my-model', + * }); * console.log(res.data); * * // Example response * // { + * // "artifactUri": "my_artifactUri", + * // "baseModelSource": {}, + * // "checkpoints": [], + * // "containerSpec": {}, * // "createTime": "my_createTime", + * // "dataStats": {}, + * // "defaultCheckpointId": "my_defaultCheckpointId", + * // "deployedModels": [], * // "description": "my_description", * // "displayName": "my_displayName", + * // "encryptionSpec": {}, * // "etag": "my_etag", + * // "explanationSpec": {}, * // "labels": {}, * // "metadata": {}, + * // "metadataArtifact": "my_metadataArtifact", + * // "metadataSchemaUri": "my_metadataSchemaUri", + * // "modelSourceInfo": {}, * // "name": "my_name", - * // "schemaTitle": "my_schemaTitle", - * // "schemaVersion": "my_schemaVersion", - * // "state": "my_state", + * // "originalModelInfo": {}, + * // "pipelineJob": "my_pipelineJob", + * // "predictSchemata": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "supportedDeploymentResourcesTypes": [], + * // "supportedExportFormats": [], + * // "supportedInputStorageFormats": [], + * // "supportedOutputStorageFormats": [], + * // "trainingPipeline": "my_trainingPipeline", * // "updateTime": "my_updateTime", - * // "uri": "my_uri" + * // "versionAliases": [], + * // "versionCreateTime": "my_versionCreateTime", + * // "versionDescription": "my_versionDescription", + * // "versionId": "my_versionId", + * // "versionUpdateTime": "my_versionUpdateTime" * // } * } * @@ -73777,58 +110764,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch, + get( + params: Params$Resource$Projects$Locations$Models$Get, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch, + get( + params?: Params$Resource$Projects$Locations$Models$Get, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Models$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch, + get( + params: Params$Resource$Projects$Locations$Models$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Models$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch; + {}) as Params$Resource$Projects$Locations$Models$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch; + params = {} as Params$Resource$Projects$Locations$Models$Get; options = {}; } @@ -73842,7 +110828,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -73853,19 +110839,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Purges Artifacts. + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @example * ```js * // Before running the sample: @@ -73894,30 +110880,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.artifacts.purge({ - * // Required. The metadata store to purge Artifacts from. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - * parent: - * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "filter": "my_filter", - * // "force": false - * // } - * }, - * }); + * const res = await aiplatform.projects.locations.models.getIamPolicy({ + * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + * 'options.requestedPolicyVersion': 'placeholder-value', + * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: 'projects/my-project/locations/my-location/models/my-model', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -73933,58 +110908,55 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge, + getIamPolicy( + params: Params$Resource$Projects$Locations$Models$Getiampolicy, options: StreamMethodOptions ): Promise>; - purge( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge, + getIamPolicy( + params?: Params$Resource$Projects$Locations$Models$Getiampolicy, options?: MethodOptions - ): Promise>; - purge( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge, + ): Promise>; + getIamPolicy( + params: Params$Resource$Projects$Locations$Models$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Models$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Models$Getiampolicy, + callback: BodyResponseCallback ): void; - purge( - callback: BodyResponseCallback + getIamPolicy( + callback: BodyResponseCallback ): void; - purge( + getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Getiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge; + {}) as Params$Resource$Projects$Locations$Models$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge; + params = {} as Params$Resource$Projects$Locations$Models$Getiampolicy; options = {}; } @@ -73997,7 +110969,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/artifacts:purge').replace( + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), @@ -74007,22 +110979,22 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph. + * Lists Models in a Location. * @example * ```js * // Before running the sample: @@ -74051,25 +111023,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.artifacts.queryArtifactLineageSubgraph( - * { - * // Required. The resource name of the Artifact whose Lineage needs to be retrieved as a LineageSubgraph. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000. - * artifact: - * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/artifacts/my-artifact', - * // Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the Lineage Subgraph. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = "test"` Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. - * filter: 'placeholder-value', - * // Specifies the size of the lineage graph in terms of number of hops from the specified artifact. Negative Value: INVALID_ARGUMENT error is returned 0: Only input artifact is returned. No value: Transitive closure is performed to return the complete graph. - * maxHops: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.projects.locations.models.list({ + * // An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `model` supports = and !=. `model` represents the Model ID, i.e. the last segment of the Model's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. * `base_model_name` only supports = Some examples: * `model=1234` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `baseModelName="text-bison"` + * filter: 'placeholder-value', + * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. + * orderBy: 'placeholder-value', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. Typically obtained via ListModelsResponse.next_page_token of the previous ModelService.ListModels call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location to list the Models from. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "artifacts": [], - * // "events": [], - * // "executions": [] + * // "models": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -74085,62 +111058,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - queryArtifactLineageSubgraph( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph, + list( + params: Params$Resource$Projects$Locations$Models$List, options: StreamMethodOptions ): Promise>; - queryArtifactLineageSubgraph( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph, + list( + params?: Params$Resource$Projects$Locations$Models$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - queryArtifactLineageSubgraph( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph, + list( + params: Params$Resource$Projects$Locations$Models$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - queryArtifactLineageSubgraph( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph, + list( + params: Params$Resource$Projects$Locations$Models$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - queryArtifactLineageSubgraph( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Models$List, + callback: BodyResponseCallback ): void; - queryArtifactLineageSubgraph( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - queryArtifactLineageSubgraph( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph; + {}) as Params$Resource$Projects$Locations$Models$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph; + params = {} as Params$Resource$Projects$Locations$Models$List; options = {}; } @@ -74153,145 +111125,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+artifact}:queryArtifactLineageSubgraph' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/models').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['artifact'], - pathParams: ['artifact'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create - extends StandardParameters { - /** - * The {artifact\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` If not provided, the Artifact's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Artifacts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Artifact.) - */ - artifactId?: string; - /** - * Required. The resource name of the MetadataStore where the Artifact should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Artifact; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete - extends StandardParameters { - /** - * Optional. The etag of the Artifact to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION. - */ - etag?: string; - /** - * Required. The resource name of the Artifact to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get - extends StandardParameters { - /** - * Required. The resource name of the Artifact to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$List - extends StandardParameters { - /** - * Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = "test"`. Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` * **Context based filtering**: To filter Artifacts based on the contexts to which they belong, use the function operator with the full resource name `in_context()`. For example: `in_context("projects//locations//metadataStores//contexts/")` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. - */ - filter?: string; - /** - * How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details. - */ - orderBy?: string; - /** - * The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. - */ - pageSize?: number; - /** - * A page token, received from a previous MetadataService.ListArtifacts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) - */ - pageToken?: string; - /** - * Required. The MetadataStore whose Artifacts should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch - extends StandardParameters { - /** - * If set to true, and the Artifact is not found, a new Artifact is created. - */ - allowMissing?: boolean; - /** - * Output only. The resource name of the Artifact. - */ - name?: string; - /** - * Optional. A FieldMask indicating which fields should be updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Artifact; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge - extends StandardParameters { - /** - * Required. The metadata store to purge Artifacts from. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1PurgeArtifactsRequest; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph - extends StandardParameters { - /** - * Required. The resource name of the Artifact whose Lineage needs to be retrieved as a LineageSubgraph. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000. - */ - artifact?: string; - /** - * Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the Lineage Subgraph. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = "test"` Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. - */ - filter?: string; - /** - * Specifies the size of the lineage graph in terms of number of hops from the specified artifact. Negative Value: INVALID_ARGUMENT error is returned 0: Only input artifact is returned. No value: Transitive closure is performed to return the complete graph. - */ - maxHops?: number; - } - - export class Resource$Projects$Locations$Metadatastores$Artifacts$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Lists checkpoints of the specified model version. * @example * ```js * // Before running the sample: @@ -74320,17 +111181,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.artifacts.operations.cancel( - * { - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/artifacts/my-artifact/operations/my-operation', - * }, - * ); + * const res = await aiplatform.projects.locations.models.listCheckpoints({ + * // Required. The name of the model version to list checkpoints for. `projects/{project\}/locations/{location\}/models/{model\}@{version\}` Example: `projects/{project\}/locations/{location\}/models/{model\}@2` or `projects/{project\}/locations/{location\}/models/{model\}@golden` If no version ID or alias is specified, the latest version will be used. + * name: 'projects/my-project/locations/my-location/models/my-model', + * // Optional. The standard list page size. + * pageSize: 'placeholder-value', + * // Optional. The standard list page token. Typically obtained via next_page_token of the previous ListModelVersionCheckpoints call. + * pageToken: 'placeholder-value', + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "checkpoints": [], + * // "nextPageToken": "my_nextPageToken" + * // } * } * * main().catch(e => { @@ -74345,54 +111210,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel, + listCheckpoints( + params: Params$Resource$Projects$Locations$Models$Listcheckpoints, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel, + listCheckpoints( + params?: Params$Resource$Projects$Locations$Models$Listcheckpoints, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel, + ): Promise< + GaxiosResponseWithHTTP2 + >; + listCheckpoints( + params: Params$Resource$Projects$Locations$Models$Listcheckpoints, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + listCheckpoints( + params: Params$Resource$Projects$Locations$Models$Listcheckpoints, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel, - callback: BodyResponseCallback + listCheckpoints( + params: Params$Resource$Projects$Locations$Models$Listcheckpoints, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + listCheckpoints( + callback: BodyResponseCallback + ): void; + listCheckpoints( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Listcheckpoints + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Models$Listcheckpoints; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Models$Listcheckpoints; options = {}; } @@ -74405,8 +111278,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}:listCheckpoints').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -74417,17 +111293,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Lists versions of the specified model. * @example * ```js * // Before running the sample: @@ -74456,17 +111334,27 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.artifacts.operations.delete( - * { - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/artifacts/my-artifact/operations/my-operation', - * }, - * ); + * const res = await aiplatform.projects.locations.models.listVersions({ + * // An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. Some examples: * `labels.myKey="myValue"` + * filter: 'placeholder-value', + * // Required. The name of the model to list versions for. + * name: 'projects/my-project/locations/my-location/models/my-model', + * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `update_time asc, create_time desc`. + * orderBy: 'placeholder-value', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. Typically obtained via next_page_token of the previous ListModelVersions call. + * pageToken: 'placeholder-value', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "models": [], + * // "nextPageToken": "my_nextPageToken" + * // } * } * * main().catch(e => { @@ -74481,54 +111369,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete, + listVersions( + params: Params$Resource$Projects$Locations$Models$Listversions, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete, + listVersions( + params?: Params$Resource$Projects$Locations$Models$Listversions, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + listVersions( + params: Params$Resource$Projects$Locations$Models$Listversions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + listVersions( + params: Params$Resource$Projects$Locations$Models$Listversions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete, - callback: BodyResponseCallback + listVersions( + params: Params$Resource$Projects$Locations$Models$Listversions, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + listVersions( + callback: BodyResponseCallback + ): void; + listVersions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Listversions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Models$Listversions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete; + params = {} as Params$Resource$Projects$Locations$Models$Listversions; options = {}; } @@ -74541,8 +111436,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}:listVersions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -74553,17 +111451,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Merges a set of aliases for a Model version. * @example * ```js * // Before running the sample: @@ -74592,22 +111492,57 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.artifacts.operations.get( - * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/artifacts/my-artifact/operations/my-operation', - * }, - * ); + * const res = await aiplatform.projects.locations.models.mergeVersionAliases({ + * // Required. The name of the model version to merge aliases, with a version ID explicitly included. Example: `projects/{project\}/locations/{location\}/models/{model\}@1234` + * name: 'projects/my-project/locations/my-location/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "versionAliases": [] + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, + * // "artifactUri": "my_artifactUri", + * // "baseModelSource": {}, + * // "checkpoints": [], + * // "containerSpec": {}, + * // "createTime": "my_createTime", + * // "dataStats": {}, + * // "defaultCheckpointId": "my_defaultCheckpointId", + * // "deployedModels": [], + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "explanationSpec": {}, + * // "labels": {}, * // "metadata": {}, + * // "metadataArtifact": "my_metadataArtifact", + * // "metadataSchemaUri": "my_metadataSchemaUri", + * // "modelSourceInfo": {}, * // "name": "my_name", - * // "response": {} + * // "originalModelInfo": {}, + * // "pipelineJob": "my_pipelineJob", + * // "predictSchemata": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "supportedDeploymentResourcesTypes": [], + * // "supportedExportFormats": [], + * // "supportedInputStorageFormats": [], + * // "supportedOutputStorageFormats": [], + * // "trainingPipeline": "my_trainingPipeline", + * // "updateTime": "my_updateTime", + * // "versionAliases": [], + * // "versionCreateTime": "my_versionCreateTime", + * // "versionDescription": "my_versionDescription", + * // "versionId": "my_versionId", + * // "versionUpdateTime": "my_versionUpdateTime" * // } * } * @@ -74623,58 +111558,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get, + mergeVersionAliases( + params: Params$Resource$Projects$Locations$Models$Mergeversionaliases, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get, + mergeVersionAliases( + params?: Params$Resource$Projects$Locations$Models$Mergeversionaliases, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get, + ): Promise>; + mergeVersionAliases( + params: Params$Resource$Projects$Locations$Models$Mergeversionaliases, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get, + mergeVersionAliases( + params: Params$Resource$Projects$Locations$Models$Mergeversionaliases, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get, - callback: BodyResponseCallback + mergeVersionAliases( + params: Params$Resource$Projects$Locations$Models$Mergeversionaliases, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + mergeVersionAliases( + callback: BodyResponseCallback ): void; - get( + mergeVersionAliases( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Mergeversionaliases + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get; + {}) as Params$Resource$Projects$Locations$Models$Mergeversionaliases; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get; + {} as Params$Resource$Projects$Locations$Models$Mergeversionaliases; options = {}; } @@ -74687,8 +111622,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:mergeVersionAliases').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -74699,17 +111637,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Updates a Model. * @example * ```js * // Before running the sample: @@ -74738,28 +111678,93 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.artifacts.operations.list( - * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/artifacts/my-artifact', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.projects.locations.models.patch({ + * // The resource name of the Model. + * name: 'projects/my-project/locations/my-location/models/my-model', + * // Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "artifactUri": "my_artifactUri", + * // "baseModelSource": {}, + * // "checkpoints": [], + * // "containerSpec": {}, + * // "createTime": "my_createTime", + * // "dataStats": {}, + * // "defaultCheckpointId": "my_defaultCheckpointId", + * // "deployedModels": [], + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "explanationSpec": {}, + * // "labels": {}, + * // "metadata": {}, + * // "metadataArtifact": "my_metadataArtifact", + * // "metadataSchemaUri": "my_metadataSchemaUri", + * // "modelSourceInfo": {}, + * // "name": "my_name", + * // "originalModelInfo": {}, + * // "pipelineJob": "my_pipelineJob", + * // "predictSchemata": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "supportedDeploymentResourcesTypes": [], + * // "supportedExportFormats": [], + * // "supportedInputStorageFormats": [], + * // "supportedOutputStorageFormats": [], + * // "trainingPipeline": "my_trainingPipeline", + * // "updateTime": "my_updateTime", + * // "versionAliases": [], + * // "versionCreateTime": "my_versionCreateTime", + * // "versionDescription": "my_versionDescription", + * // "versionId": "my_versionId", + * // "versionUpdateTime": "my_versionUpdateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "artifactUri": "my_artifactUri", + * // "baseModelSource": {}, + * // "checkpoints": [], + * // "containerSpec": {}, + * // "createTime": "my_createTime", + * // "dataStats": {}, + * // "defaultCheckpointId": "my_defaultCheckpointId", + * // "deployedModels": [], + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "explanationSpec": {}, + * // "labels": {}, + * // "metadata": {}, + * // "metadataArtifact": "my_metadataArtifact", + * // "metadataSchemaUri": "my_metadataSchemaUri", + * // "modelSourceInfo": {}, + * // "name": "my_name", + * // "originalModelInfo": {}, + * // "pipelineJob": "my_pipelineJob", + * // "predictSchemata": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "supportedDeploymentResourcesTypes": [], + * // "supportedExportFormats": [], + * // "supportedInputStorageFormats": [], + * // "supportedOutputStorageFormats": [], + * // "trainingPipeline": "my_trainingPipeline", + * // "updateTime": "my_updateTime", + * // "versionAliases": [], + * // "versionCreateTime": "my_versionCreateTime", + * // "versionDescription": "my_versionDescription", + * // "versionId": "my_versionId", + * // "versionUpdateTime": "my_versionUpdateTime" * // } * } * @@ -74775,62 +111780,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List, + patch( + params: Params$Resource$Projects$Locations$Models$Patch, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List, + patch( + params?: Params$Resource$Projects$Locations$Models$Patch, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List, + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Models$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List, + patch( + params: Params$Resource$Projects$Locations$Models$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Models$Patch, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - list( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List; + {}) as Params$Resource$Projects$Locations$Models$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List; + params = {} as Params$Resource$Projects$Locations$Models$Patch; options = {}; } @@ -74843,11 +111843,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -74858,19 +111855,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @example * ```js * // Before running the sample: @@ -74899,24 +111896,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.artifacts.operations.wait( - * { - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/artifacts/my-artifact/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.projects.locations.models.setIamPolicy({ + * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: 'projects/my-project/locations/my-location/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "policy": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -74932,58 +111930,55 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait, + setIamPolicy( + params: Params$Resource$Projects$Locations$Models$Setiampolicy, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait, + setIamPolicy( + params?: Params$Resource$Projects$Locations$Models$Setiampolicy, options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait, + ): Promise>; + setIamPolicy( + params: Params$Resource$Projects$Locations$Models$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Models$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Models$Setiampolicy, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + setIamPolicy( + callback: BodyResponseCallback ): void; - wait( + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Models$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait; + params = {} as Params$Resource$Projects$Locations$Models$Setiampolicy; options = {}; } @@ -74996,97 +111991,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel - extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete - extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait - extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Metadatastores$Contexts { - context: APIRequestContext; - operations: Resource$Projects$Locations$Metadatastores$Contexts$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Metadatastores$Contexts$Operations( - this.context - ); - } /** - * Adds a set of Artifacts and Executions to a Context. If any of the Artifacts or Executions have already been added to a Context, they are simply skipped. + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @example * ```js * // Before running the sample: @@ -75115,27 +112045,18 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.contexts.addContextArtifactsAndExecutions( - * { - * // Required. The resource name of the Context that the Artifacts and Executions belong to. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` - * context: - * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "artifacts": [], - * // "executions": [] - * // } - * }, - * }, - * ); + * const res = await aiplatform.projects.locations.models.testIamPermissions({ + * // The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * permissions: 'placeholder-value', + * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: 'projects/my-project/locations/my-location/models/my-model', + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "permissions": [] + * // } * } * * main().catch(e => { @@ -75150,62 +112071,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - addContextArtifactsAndExecutions( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions, + testIamPermissions( + params: Params$Resource$Projects$Locations$Models$Testiampermissions, options: StreamMethodOptions ): Promise>; - addContextArtifactsAndExecutions( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions, + testIamPermissions( + params?: Params$Resource$Projects$Locations$Models$Testiampermissions, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - addContextArtifactsAndExecutions( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions, + testIamPermissions( + params: Params$Resource$Projects$Locations$Models$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addContextArtifactsAndExecutions( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions, + testIamPermissions( + params: Params$Resource$Projects$Locations$Models$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - addContextArtifactsAndExecutions( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Models$Testiampermissions, + callback: BodyResponseCallback ): void; - addContextArtifactsAndExecutions( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - addContextArtifactsAndExecutions( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions; + {}) as Params$Resource$Projects$Locations$Models$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions; + {} as Params$Resource$Projects$Locations$Models$Testiampermissions; options = {}; } @@ -75218,33 +112139,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+context}:addContextArtifactsAndExecutions' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['context'], - pathParams: ['context'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Adds a set of Contexts as children to a parent Context. If any of the child Contexts have already been added to the parent Context, they are simply skipped. If this call would create a cycle or cause any Context to have more than 10 parents, the request will fail with an INVALID_ARGUMENT error. + * Incrementally update the dataset used for an examples model. * @example * ```js * // Before running the sample: @@ -75274,25 +112196,28 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.metadataStores.contexts.addContextChildren( - * { - * // Required. The resource name of the parent Context. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` - * context: - * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context', + * await aiplatform.projects.locations.models.updateExplanationDataset({ + * // Required. The resource name of the Model to update. Format: `projects/{project\}/locations/{location\}/models/{model\}` + * model: 'projects/my-project/locations/my-location/models/my-model', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "childContexts": [] - * // } - * }, + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "examples": {} + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -75307,62 +112232,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - addContextChildren( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren, + updateExplanationDataset( + params: Params$Resource$Projects$Locations$Models$Updateexplanationdataset, options: StreamMethodOptions ): Promise>; - addContextChildren( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren, + updateExplanationDataset( + params?: Params$Resource$Projects$Locations$Models$Updateexplanationdataset, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - addContextChildren( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren, + ): Promise>; + updateExplanationDataset( + params: Params$Resource$Projects$Locations$Models$Updateexplanationdataset, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addContextChildren( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren, + updateExplanationDataset( + params: Params$Resource$Projects$Locations$Models$Updateexplanationdataset, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - addContextChildren( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren, - callback: BodyResponseCallback + updateExplanationDataset( + params: Params$Resource$Projects$Locations$Models$Updateexplanationdataset, + callback: BodyResponseCallback ): void; - addContextChildren( - callback: BodyResponseCallback + updateExplanationDataset( + callback: BodyResponseCallback ): void; - addContextChildren( + updateExplanationDataset( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Updateexplanationdataset + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren; + {}) as Params$Resource$Projects$Locations$Models$Updateexplanationdataset; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren; + {} as Params$Resource$Projects$Locations$Models$Updateexplanationdataset; options = {}; } @@ -75375,7 +112296,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+context}:addContextChildren').replace( + url: (rootUrl + '/v1/{+model}:updateExplanationDataset').replace( /([^:]\/)\/+/g, '$1' ), @@ -75385,24 +112306,22 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['context'], - pathParams: ['context'], + requiredParams: ['model'], + pathParams: ['model'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Creates a Context associated with a MetadataStore. + * Uploads a Model artifact into Vertex AI. * @example * ```js * // Before running the sample: @@ -75431,47 +112350,30 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.contexts.create({ - * // The {context\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}`. If not provided, the Context's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Contexts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Context.) - * contextId: 'placeholder-value', - * // Required. The resource name of the MetadataStore where the Context should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - * parent: - * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', + * const res = await aiplatform.projects.locations.models.upload({ + * // Required. The resource name of the Location into which to upload the Model. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "parentContexts": [], - * // "schemaTitle": "my_schemaTitle", - * // "schemaVersion": "my_schemaVersion", - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "model": {}, + * // "modelId": "my_modelId", + * // "parentModel": "my_parentModel", + * // "serviceAccount": "my_serviceAccount" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, + * // "done": false, + * // "error": {}, * // "metadata": {}, * // "name": "my_name", - * // "parentContexts": [], - * // "schemaTitle": "my_schemaTitle", - * // "schemaVersion": "my_schemaVersion", - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -75487,98 +112389,312 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Create, + upload( + params: Params$Resource$Projects$Locations$Models$Upload, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Create, + upload( + params?: Params$Resource$Projects$Locations$Models$Upload, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Create, + ): Promise>; + upload( + params: Params$Resource$Projects$Locations$Models$Upload, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Create, + upload( + params: Params$Resource$Projects$Locations$Models$Upload, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Create, - callback: BodyResponseCallback + upload( + params: Params$Resource$Projects$Locations$Models$Upload, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + upload( + callback: BodyResponseCallback ): void; - create( + upload( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Upload + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Create; + {}) as Params$Resource$Projects$Locations$Models$Upload; let options = (optionsOrCallback || {}) as MethodOptions; - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Create; - options = {}; - } + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Models$Upload; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/models:upload').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Models$Copy + extends StandardParameters { + /** + * Required. The resource name of the Location into which to copy the Model. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CopyModelRequest; + } + export interface Params$Resource$Projects$Locations$Models$Delete + extends StandardParameters { + /** + * Required. The name of the Model resource to be deleted. Format: `projects/{project\}/locations/{location\}/models/{model\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Models$Deleteversion + extends StandardParameters { + /** + * Required. The name of the model version to be deleted, with a version ID explicitly included. Example: `projects/{project\}/locations/{location\}/models/{model\}@1234` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Models$Export + extends StandardParameters { + /** + * Required. The resource name of the Model to export. The resource name may contain version id or version alias to specify the version, if no version is specified, the default version will be exported. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ExportModelRequest; + } + export interface Params$Resource$Projects$Locations$Models$Get + extends StandardParameters { + /** + * Required. The name of the Model resource. Format: `projects/{project\}/locations/{location\}/models/{model\}` In order to retrieve a specific version of the model, also provide the version ID or version alias. Example: `projects/{project\}/locations/{location\}/models/{model\}@2` or `projects/{project\}/locations/{location\}/models/{model\}@golden` If no version ID or alias is specified, the "default" version will be returned. The "default" version alias is created for the first version of the model, and can be moved to other versions later on. There will be exactly one default version. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Models$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Models$List + extends StandardParameters { + /** + * An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `model` supports = and !=. `model` represents the Model ID, i.e. the last segment of the Model's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. * `base_model_name` only supports = Some examples: * `model=1234` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `baseModelName="text-bison"` + */ + filter?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. + */ + orderBy?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. Typically obtained via ListModelsResponse.next_page_token of the previous ModelService.ListModels call. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list the Models from. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Models$Listcheckpoints + extends StandardParameters { + /** + * Required. The name of the model version to list checkpoints for. `projects/{project\}/locations/{location\}/models/{model\}@{version\}` Example: `projects/{project\}/locations/{location\}/models/{model\}@2` or `projects/{project\}/locations/{location\}/models/{model\}@golden` If no version ID or alias is specified, the latest version will be used. + */ + name?: string; + /** + * Optional. The standard list page size. + */ + pageSize?: number; + /** + * Optional. The standard list page token. Typically obtained via next_page_token of the previous ListModelVersionCheckpoints call. + */ + pageToken?: string; + } + export interface Params$Resource$Projects$Locations$Models$Listversions + extends StandardParameters { + /** + * An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. Some examples: * `labels.myKey="myValue"` + */ + filter?: string; + /** + * Required. The name of the model to list versions for. + */ + name?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `update_time asc, create_time desc`. + */ + orderBy?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. Typically obtained via next_page_token of the previous ListModelVersions call. + */ + pageToken?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Models$Mergeversionaliases + extends StandardParameters { + /** + * Required. The name of the model version to merge aliases, with a version ID explicitly included. Example: `projects/{project\}/locations/{location\}/models/{model\}@1234` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1MergeVersionAliasesRequest; + } + export interface Params$Resource$Projects$Locations$Models$Patch + extends StandardParameters { + /** + * The resource name of the Model. + */ + name?: string; + /** + * Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Model; + } + export interface Params$Resource$Projects$Locations$Models$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Models$Testiampermissions + extends StandardParameters { + /** + * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + */ + permissions?: string[]; + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Models$Updateexplanationdataset + extends StandardParameters { + /** + * Required. The resource name of the Model to update. Format: `projects/{project\}/locations/{location\}/models/{model\}` + */ + model?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1UpdateExplanationDatasetRequest; + } + export interface Params$Resource$Projects$Locations$Models$Upload + extends StandardParameters { + /** + * Required. The resource name of the Location into which to upload the Model. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1UploadModelRequest; + } - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/contexts').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters + export class Resource$Projects$Locations$Models$Evaluations { + context: APIRequestContext; + operations: Resource$Projects$Locations$Models$Evaluations$Operations; + slices: Resource$Projects$Locations$Models$Evaluations$Slices; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Models$Evaluations$Operations( + this.context ); - } + this.slices = new Resource$Projects$Locations$Models$Evaluations$Slices( + this.context + ); } /** - * Deletes a stored Context. + * Gets a ModelEvaluation. * @example * ```js * // Before running the sample: @@ -75607,24 +112723,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.contexts.delete({ - * // Optional. The etag of the Context to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION. - * etag: 'placeholder-value', - * // The force deletion semantics is still undefined. Users should not use this field. - * force: 'placeholder-value', - * // Required. The resource name of the Context to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context', - * }); + * const res = await aiplatform.projects.locations.models.evaluations.get({ + * // Required. The name of the ModelEvaluation resource. Format: `projects/{project\}/locations/{location\}/models/{model\}/evaluations/{evaluation\}` + * name: 'projects/my-project/locations/my-location/models/my-model/evaluations/my-evaluation', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, + * // "annotationSchemaUri": "my_annotationSchemaUri", + * // "createTime": "my_createTime", + * // "dataItemSchemaUri": "my_dataItemSchemaUri", + * // "displayName": "my_displayName", + * // "explanationSpecs": [], * // "metadata": {}, + * // "metrics": {}, + * // "metricsSchemaUri": "my_metricsSchemaUri", + * // "modelExplanation": {}, * // "name": "my_name", - * // "response": {} + * // "sliceDimensions": [] * // } * } * @@ -75640,58 +112757,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete, + get( + params: Params$Resource$Projects$Locations$Models$Evaluations$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete, + get( + params?: Params$Resource$Projects$Locations$Models$Evaluations$Get, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Models$Evaluations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete, + get( + params: Params$Resource$Projects$Locations$Models$Evaluations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Models$Evaluations$Get, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - delete( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Evaluations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete; + {}) as Params$Resource$Projects$Locations$Models$Evaluations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete; + {} as Params$Resource$Projects$Locations$Models$Evaluations$Get; options = {}; } @@ -75705,7 +112826,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -75716,17 +112837,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Retrieves a specific Context. + * Imports an externally generated ModelEvaluation. * @example * ```js * // Before running the sample: @@ -75755,25 +112878,33 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.metadataStores.contexts.get({ - * // Required. The resource name of the Context to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context', + * const res = await aiplatform.projects.locations.models.evaluations.import({ + * // Required. The name of the parent model resource. Format: `projects/{project\}/locations/{location\}/models/{model\}` + * parent: 'projects/my-project/locations/my-location/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "modelEvaluation": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { + * // "annotationSchemaUri": "my_annotationSchemaUri", * // "createTime": "my_createTime", - * // "description": "my_description", + * // "dataItemSchemaUri": "my_dataItemSchemaUri", * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, + * // "explanationSpecs": [], * // "metadata": {}, + * // "metrics": {}, + * // "metricsSchemaUri": "my_metricsSchemaUri", + * // "modelExplanation": {}, * // "name": "my_name", - * // "parentContexts": [], - * // "schemaTitle": "my_schemaTitle", - * // "schemaVersion": "my_schemaVersion", - * // "updateTime": "my_updateTime" + * // "sliceDimensions": [] * // } * } * @@ -75789,58 +112920,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Get, + import( + params: Params$Resource$Projects$Locations$Models$Evaluations$Import, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Get, + import( + params?: Params$Resource$Projects$Locations$Models$Evaluations$Import, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + import( + params: Params$Resource$Projects$Locations$Models$Evaluations$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Get, + import( + params: Params$Resource$Projects$Locations$Models$Evaluations$Import, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Get, - callback: BodyResponseCallback + import( + params: Params$Resource$Projects$Locations$Models$Evaluations$Import, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + import( + callback: BodyResponseCallback ): void; - get( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Evaluations$Import + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Get; + {}) as Params$Resource$Projects$Locations$Models$Evaluations$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Get; + {} as Params$Resource$Projects$Locations$Models$Evaluations$Import; options = {}; } @@ -75853,31 +112988,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+parent}/evaluations:import').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists Contexts on the MetadataStore. + * Lists ModelEvaluations in a Model. * @example * ```js * // Before running the sample: @@ -75906,24 +113044,23 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.metadataStores.contexts.list({ - * // Filter specifying the boolean condition for the Contexts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = "test"`. Supported fields include: `name`, `display_name`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0`. In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` * **Parent Child filtering**: To filter Contexts based on parent-child relationship use the HAS operator as follows: ``` parent_contexts: "projects//locations//metadataStores//contexts/" child_contexts: "projects//locations//metadataStores//contexts/" ``` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. + * const res = await aiplatform.projects.locations.models.evaluations.list({ + * // The standard list filter. * filter: 'placeholder-value', - * // How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details. - * orderBy: 'placeholder-value', - * // The maximum number of Contexts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. + * // The standard list page size. * pageSize: 'placeholder-value', - * // A page token, received from a previous MetadataService.ListContexts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) + * // The standard list page token. Typically obtained via ListModelEvaluationsResponse.next_page_token of the previous ModelService.ListModelEvaluations call. * pageToken: 'placeholder-value', - * // Required. The MetadataStore whose Contexts should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - * parent: - * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', + * // Required. The resource name of the Model to list the ModelEvaluations from. Format: `projects/{project\}/locations/{location\}/models/{model\}` + * parent: 'projects/my-project/locations/my-location/models/my-model', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "contexts": [], + * // "modelEvaluations": [], * // "nextPageToken": "my_nextPageToken" * // } * } @@ -75941,61 +113078,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$List, + params: Params$Resource$Projects$Locations$Models$Evaluations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$List, + params?: Params$Resource$Projects$Locations$Models$Evaluations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$List, + params: Params$Resource$Projects$Locations$Models$Evaluations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$List, + params: Params$Resource$Projects$Locations$Models$Evaluations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Models$Evaluations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Evaluations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$List; + {}) as Params$Resource$Projects$Locations$Models$Evaluations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$List; + {} as Params$Resource$Projects$Locations$Models$Evaluations$List; options = {}; } @@ -76008,7 +113145,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/contexts').replace( + url: (rootUrl + '/v1/{+parent}/evaluations').replace( /([^:]\/)\/+/g, '$1' ), @@ -76023,19 +113160,69 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Models$Evaluations$Get + extends StandardParameters { /** - * Updates a stored Context. + * Required. The name of the ModelEvaluation resource. Format: `projects/{project\}/locations/{location\}/models/{model\}/evaluations/{evaluation\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Models$Evaluations$Import + extends StandardParameters { + /** + * Required. The name of the parent model resource. Format: `projects/{project\}/locations/{location\}/models/{model\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ImportModelEvaluationRequest; + } + export interface Params$Resource$Projects$Locations$Models$Evaluations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. Typically obtained via ListModelEvaluationsResponse.next_page_token of the previous ModelService.ListModelEvaluations call. + */ + pageToken?: string; + /** + * Required. The resource name of the Model to list the ModelEvaluations from. Format: `projects/{project\}/locations/{location\}/models/{model\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + + export class Resource$Projects$Locations$Models$Evaluations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -76064,50 +113251,15 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.metadataStores.contexts.patch( - * { - * // If set to true, and the Context is not found, a new Context is created. - * allowMissing: 'placeholder-value', - * // Immutable. The resource name of the Context. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context', - * // Optional. A FieldMask indicating which fields should be updated. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "parentContexts": [], - * // "schemaTitle": "my_schemaTitle", - * // "schemaVersion": "my_schemaVersion", - * // "updateTime": "my_updateTime" - * // } - * }, - * }, - * ); + * const res = + * await aiplatform.projects.locations.models.evaluations.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/models/my-model/evaluations/my-evaluation/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "parentContexts": [], - * // "schemaTitle": "my_schemaTitle", - * // "schemaVersion": "my_schemaVersion", - * // "updateTime": "my_updateTime" - * // } + * // {} * } * * main().catch(e => { @@ -76122,58 +113274,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch, + cancel( + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch, + cancel( + params?: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel, + callback: BodyResponseCallback ): void; - patch( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch; + {}) as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch; + {} as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel; options = {}; } @@ -76186,8 +113334,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -76198,19 +113346,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Purges Contexts. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -76239,32 +113385,15 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.metadataStores.contexts.purge( - * { - * // Required. The metadata store to purge Contexts from. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - * parent: - * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "filter": "my_filter", - * // "force": false - * // } - * }, - * }, - * ); + * const res = + * await aiplatform.projects.locations.models.evaluations.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/models/my-model/evaluations/my-evaluation/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -76279,58 +113408,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge, + delete( + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete, options: StreamMethodOptions ): Promise>; - purge( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge, + delete( + params?: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete, options?: MethodOptions - ): Promise>; - purge( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - purge( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purge( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete, + callback: BodyResponseCallback ): void; - purge( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge; + {}) as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge; + {} as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete; options = {}; } @@ -76343,32 +113468,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/contexts:purge').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -76398,20 +113520,19 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.metadataStores.contexts.queryContextLineageSubgraph( - * { - * // Required. The resource name of the Context whose Artifacts and Executions should be retrieved as a LineageSubgraph. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000. - * context: - * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context', - * }, - * ); + * await aiplatform.projects.locations.models.evaluations.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/models/my-model/evaluations/my-evaluation/operations/my-operation', + * }); * console.log(res.data); * * // Example response * // { - * // "artifacts": [], - * // "events": [], - * // "executions": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -76427,62 +113548,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - queryContextLineageSubgraph( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph, + get( + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get, options: StreamMethodOptions ): Promise>; - queryContextLineageSubgraph( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph, + get( + params?: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - queryContextLineageSubgraph( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - queryContextLineageSubgraph( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph, + get( + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - queryContextLineageSubgraph( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get, + callback: BodyResponseCallback ): void; - queryContextLineageSubgraph( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - queryContextLineageSubgraph( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph; + {}) as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph; + {} as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get; options = {}; } @@ -76495,33 +113612,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+context}:queryContextLineageSubgraph' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['context'], - pathParams: ['context'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Remove a set of children contexts from a parent Context. If any of the child Contexts were NOT added to the parent Context, they are simply skipped. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -76551,25 +113664,26 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.metadataStores.contexts.removeContextChildren( - * { - * // Required. The resource name of the parent Context. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` - * context: - * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "childContexts": [] - * // } - * }, - * }, - * ); + * await aiplatform.projects.locations.models.evaluations.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/models/my-model/evaluations/my-evaluation', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] + * // } * } * * main().catch(e => { @@ -76584,62 +113698,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - removeContextChildren( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren, + list( + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$List, options: StreamMethodOptions ): Promise>; - removeContextChildren( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren, + list( + params?: Params$Resource$Projects$Locations$Models$Evaluations$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - removeContextChildren( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren, + list( + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - removeContextChildren( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren, + list( + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - removeContextChildren( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$List, + callback: BodyResponseCallback ): void; - removeContextChildren( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - removeContextChildren( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Evaluations$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren; + {}) as Params$Resource$Projects$Locations$Models$Evaluations$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren; + {} as Params$Resource$Projects$Locations$Models$Evaluations$Operations$List; options = {}; } @@ -76652,293 +113766,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+context}:removeContextChildren').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['context'], - pathParams: ['context'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions - extends StandardParameters { - /** - * Required. The resource name of the Context that the Artifacts and Executions belong to. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` - */ - context?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren - extends StandardParameters { - /** - * Required. The resource name of the parent Context. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` - */ - context?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1AddContextChildrenRequest; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Create - extends StandardParameters { - /** - * The {context\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}`. If not provided, the Context's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Contexts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Context.) - */ - contextId?: string; - /** - * Required. The resource name of the MetadataStore where the Context should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Context; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete - extends StandardParameters { - /** - * Optional. The etag of the Context to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION. - */ - etag?: string; - /** - * The force deletion semantics is still undefined. Users should not use this field. - */ - force?: boolean; - /** - * Required. The resource name of the Context to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Get - extends StandardParameters { - /** - * Required. The resource name of the Context to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$List - extends StandardParameters { - /** - * Filter specifying the boolean condition for the Contexts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = "test"`. Supported fields include: `name`, `display_name`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0`. In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` * **Parent Child filtering**: To filter Contexts based on parent-child relationship use the HAS operator as follows: ``` parent_contexts: "projects//locations//metadataStores//contexts/" child_contexts: "projects//locations//metadataStores//contexts/" ``` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. - */ - filter?: string; - /** - * How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details. - */ - orderBy?: string; - /** - * The maximum number of Contexts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. - */ - pageSize?: number; - /** - * A page token, received from a previous MetadataService.ListContexts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) - */ - pageToken?: string; - /** - * Required. The MetadataStore whose Contexts should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch - extends StandardParameters { - /** - * If set to true, and the Context is not found, a new Context is created. - */ - allowMissing?: boolean; - /** - * Immutable. The resource name of the Context. - */ - name?: string; - /** - * Optional. A FieldMask indicating which fields should be updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Context; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge - extends StandardParameters { - /** - * Required. The metadata store to purge Contexts from. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1PurgeContextsRequest; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph - extends StandardParameters { - /** - * Required. The resource name of the Context whose Artifacts and Executions should be retrieved as a LineageSubgraph. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000. - */ - context?: string; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren - extends StandardParameters { - /** - * Required. The resource name of the parent Context. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` - */ - context?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1RemoveContextChildrenRequest; - } - - export class Resource$Projects$Locations$Metadatastores$Contexts$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const aiplatform = google.aiplatform('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.contexts.operations.cancel( - * { - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context/operations/my-operation', - * }, - * ); - * console.log(res.data); - * - * // Example response - * // {} - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel, - options: StreamMethodOptions - ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel, - options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel, - callback: BodyResponseCallback - ): void; - cancel(callback: BodyResponseCallback): void; - cancel( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -76949,17 +113781,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -76989,16 +113823,22 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.metadataStores.contexts.operations.delete( - * { - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context/operations/my-operation', - * }, - * ); + * await aiplatform.projects.locations.models.evaluations.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/models/my-model/evaluations/my-evaluation/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -77013,54 +113853,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete, + wait( + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete, + wait( + params?: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete, + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + wait( + callback: BodyResponseCallback + ): void; + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete; + {} as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait; options = {}; } @@ -77073,8 +113917,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -77085,17 +113929,80 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel + extends StandardParameters { /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Models$Evaluations$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Models$Evaluations$Slices { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Imports a list of externally generated EvaluatedAnnotations. * @example * ```js * // Before running the sample: @@ -77125,19 +114032,24 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.metadataStores.contexts.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context/operations/my-operation', + * await aiplatform.projects.locations.models.evaluations.slices.batchImport({ + * // Required. The name of the parent ModelEvaluationSlice resource. Format: `projects/{project\}/locations/{location\}/models/{model\}/evaluations/{evaluation\}/slices/{slice\}` + * parent: + * 'projects/my-project/locations/my-location/models/my-model/evaluations/my-evaluation/slices/my-slice', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "evaluatedAnnotations": [] + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "importedEvaluatedAnnotationsCount": 0 * // } * } * @@ -77153,58 +114065,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get, + batchImport( + params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get, + batchImport( + params?: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + batchImport( + params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get, + batchImport( + params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get, - callback: BodyResponseCallback + batchImport( + params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + batchImport( + callback: BodyResponseCallback ): void; - get( + batchImport( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get; + {}) as Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get; + {} as Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport; options = {}; } @@ -77217,29 +114133,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+parent}:batchImport').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Gets a ModelEvaluationSlice. * @example * ```js * // Before running the sample: @@ -77268,28 +114189,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.contexts.operations.list( - * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.projects.locations.models.evaluations.slices.get( + * { + * // Required. The name of the ModelEvaluationSlice resource. Format: `projects/{project\}/locations/{location\}/models/{model\}/evaluations/{evaluation\}/slices/{slice\}` + * name: 'projects/my-project/locations/my-location/models/my-model/evaluations/my-evaluation/slices/my-slice', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "createTime": "my_createTime", + * // "metrics": {}, + * // "metricsSchemaUri": "my_metricsSchemaUri", + * // "modelExplanation": {}, + * // "name": "my_name", + * // "slice": {} * // } * } * @@ -77305,62 +114220,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List, + get( + params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List, + get( + params?: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List, + get( + params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List, + get( + params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List; + {}) as Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List; + {} as Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get; options = {}; } @@ -77373,10 +114288,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -77388,19 +114300,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Lists ModelEvaluationSlices in a ModelEvaluation. * @example * ```js * // Before running the sample: @@ -77430,23 +114342,25 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.metadataStores.contexts.operations.wait( - * { - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }, - * ); + * await aiplatform.projects.locations.models.evaluations.slices.list({ + * // The standard list filter. * `slice.dimension` - for =. + * filter: 'placeholder-value', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. Typically obtained via ListModelEvaluationSlicesResponse.next_page_token of the previous ModelService.ListModelEvaluationSlices call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the ModelEvaluation to list the ModelEvaluationSlices from. Format: `projects/{project\}/locations/{location\}/models/{model\}/evaluations/{evaluation\}` + * parent: + * 'projects/my-project/locations/my-location/models/my-model/evaluations/my-evaluation', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "modelEvaluationSlices": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -77462,58 +114376,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait, + list( + params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$List, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait, + list( + params?: Params$Resource$Projects$Locations$Models$Evaluations$Slices$List, options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait, + list( + params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$List, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - wait( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Evaluations$Slices$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Models$Evaluations$Slices$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait; + {} as Params$Resource$Projects$Locations$Models$Evaluations$Slices$List; options = {}; } @@ -77526,97 +114444,84 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+parent}/slices').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel + export interface Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport extends StandardParameters { /** - * The name of the operation resource to be cancelled. + * Required. The name of the parent ModelEvaluationSlice resource. Format: `projects/{project\}/locations/{location\}/models/{model\}/evaluations/{evaluation\}/slices/{slice\}` */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete - extends StandardParameters { + parent?: string; + /** - * The name of the operation resource to be deleted. + * Request body metadata */ - name?: string; + requestBody?: Schema$GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest; } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get + export interface Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get extends StandardParameters { /** - * The name of the operation resource. + * Required. The name of the ModelEvaluationSlice resource. Format: `projects/{project\}/locations/{location\}/models/{model\}/evaluations/{evaluation\}/slices/{slice\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List + export interface Params$Resource$Projects$Locations$Models$Evaluations$Slices$List extends StandardParameters { /** - * The standard list filter. + * The standard list filter. * `slice.dimension` - for =. */ filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; /** * The standard list page size. */ pageSize?: number; /** - * The standard list page token. + * The standard list page token. Typically obtained via ListModelEvaluationSlicesResponse.next_page_token of the previous ModelService.ListModelEvaluationSlices call. */ pageToken?: string; /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait - extends StandardParameters { - /** - * The name of the operation resource to wait on. + * Required. The resource name of the ModelEvaluation to list the ModelEvaluationSlices from. Format: `projects/{project\}/locations/{location\}/models/{model\}/evaluations/{evaluation\}` */ - name?: string; + parent?: string; /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * Mask specifying which fields to read. */ - timeout?: string; + readMask?: string; } - export class Resource$Projects$Locations$Metadatastores$Executions { + export class Resource$Projects$Locations$Models$Operations { context: APIRequestContext; - operations: Resource$Projects$Locations$Metadatastores$Executions$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = - new Resource$Projects$Locations$Metadatastores$Executions$Operations( - this.context - ); } /** - * Adds Events to the specified Execution. An Event indicates whether an Artifact was used as an input or output for an Execution. If an Event already exists between the Execution and the Artifact, the Event is skipped. + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -77645,22 +114550,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.executions.addExecutionEvents( - * { - * // Required. The resource name of the Execution that the Events connect Artifacts with. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` - * execution: - * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/executions/my-execution', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "events": [] - * // } - * }, - * }, - * ); + * const res = await aiplatform.projects.locations.models.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/models/my-model/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -77679,62 +114572,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - addExecutionEvents( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents, + cancel( + params: Params$Resource$Projects$Locations$Models$Operations$Cancel, options: StreamMethodOptions ): Promise>; - addExecutionEvents( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents, + cancel( + params?: Params$Resource$Projects$Locations$Models$Operations$Cancel, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - addExecutionEvents( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Models$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addExecutionEvents( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - addExecutionEvents( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Models$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - addExecutionEvents( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Models$Operations$Cancel, + callback: BodyResponseCallback ): void; - addExecutionEvents( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents; + {}) as Params$Resource$Projects$Locations$Models$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents; + {} as Params$Resource$Projects$Locations$Models$Operations$Cancel; options = {}; } @@ -77747,34 +114632,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+execution}:addExecutionEvents').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['execution'], - pathParams: ['execution'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Creates an Execution associated with a MetadataStore. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -77803,48 +114683,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.executions.create({ - * // The {execution\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` If not provided, the Execution's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Executions in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Execution.) - * executionId: 'placeholder-value', - * // Required. The resource name of the MetadataStore where the Execution should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - * parent: - * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "schemaTitle": "my_schemaTitle", - * // "schemaVersion": "my_schemaVersion", - * // "state": "my_state", - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * const res = await aiplatform.projects.locations.models.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/models/my-model/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "schemaTitle": "my_schemaTitle", - * // "schemaVersion": "my_schemaVersion", - * // "state": "my_state", - * // "updateTime": "my_updateTime" - * // } + * // {} * } * * main().catch(e => { @@ -77859,62 +114705,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Create, + delete( + params: Params$Resource$Projects$Locations$Models$Operations$Delete, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Create, + delete( + params?: Params$Resource$Projects$Locations$Models$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - create( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Create, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Models$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Create, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Models$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Models$Operations$Delete, + callback: BodyResponseCallback ): void; - create( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Create; + {}) as Params$Resource$Projects$Locations$Models$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Create; + {} as Params$Resource$Projects$Locations$Models$Operations$Delete; options = {}; } @@ -77927,34 +114765,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/executions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes an Execution. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -77983,13 +114816,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.executions.delete({ - * // Optional. The etag of the Execution to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION. - * etag: 'placeholder-value', - * // Required. The resource name of the Execution to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/executions/my-execution', - * }); + * const res = await aiplatform.projects.locations.models.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/models/my-model/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -78014,36 +114844,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Delete, + get( + params: Params$Resource$Projects$Locations$Models$Operations$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Delete, + get( + params?: Params$Resource$Projects$Locations$Models$Operations$Get, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Delete, + get( + params: Params$Resource$Projects$Locations$Models$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Delete, + get( + params: Params$Resource$Projects$Locations$Models$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Delete, + get( + params: Params$Resource$Projects$Locations$Models$Operations$Get, callback: BodyResponseCallback ): void; - delete( + get( callback: BodyResponseCallback ): void; - delete( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Delete + | Params$Resource$Projects$Locations$Models$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -78059,13 +114889,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Delete; + {}) as Params$Resource$Projects$Locations$Models$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Delete; + params = {} as Params$Resource$Projects$Locations$Models$Operations$Get; options = {}; } @@ -78079,7 +114908,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -78100,7 +114929,7 @@ export namespace aiplatform_v1 { } /** - * Retrieves a specific Execution. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -78129,27 +114958,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.metadataStores.executions.get( - * { - * // Required. The resource name of the Execution to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/executions/my-execution', - * }, - * ); + * const res = await aiplatform.projects.locations.models.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/models/my-model', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "schemaTitle": "my_schemaTitle", - * // "schemaVersion": "my_schemaVersion", - * // "state": "my_state", - * // "updateTime": "my_updateTime" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -78165,62 +114992,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Get, + list( + params: Params$Resource$Projects$Locations$Models$Operations$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Get, + list( + params?: Params$Resource$Projects$Locations$Models$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Get, + list( + params: Params$Resource$Projects$Locations$Models$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Get, + list( + params: Params$Resource$Projects$Locations$Models$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Models$Operations$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Get; + {}) as Params$Resource$Projects$Locations$Models$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Get; + {} as Params$Resource$Projects$Locations$Models$Operations$List; options = {}; } @@ -78233,7 +115060,10 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -78245,19 +115075,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists Executions in the MetadataStore. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -78286,26 +115116,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.executions.list({ - * // Filter specifying the boolean condition for the Executions to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = "test"`. Supported fields include: `name`, `display_name`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..` For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` * **Context based filtering**: To filter Executions based on the contexts to which they belong use the function operator with the full resource name: `in_context()`. For example: `in_context("projects//locations//metadataStores//contexts/")` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. - * filter: 'placeholder-value', - * // How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details. - * orderBy: 'placeholder-value', - * // The maximum number of Executions to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. - * pageSize: 'placeholder-value', - * // A page token, received from a previous MetadataService.ListExecutions call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with an INVALID_ARGUMENT error.) - * pageToken: 'placeholder-value', - * // Required. The MetadataStore whose Executions should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - * parent: - * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', - * }); + * const res = await aiplatform.projects.locations.models.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/models/my-model/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "executions": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -78321,62 +115146,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$List, + wait( + params: Params$Resource$Projects$Locations$Models$Operations$Wait, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$List, + wait( + params?: Params$Resource$Projects$Locations$Models$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$List, + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Models$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$List, + wait( + params: Params$Resource$Projects$Locations$Models$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$List, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Models$Operations$Wait, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - list( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$List; + {}) as Params$Resource$Projects$Locations$Models$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$List; + {} as Params$Resource$Projects$Locations$Models$Operations$Wait; options = {}; } @@ -78389,34 +115210,95 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/executions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Models$Operations$Cancel + extends StandardParameters { /** - * Updates a stored Execution. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Models$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Models$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Models$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Models$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Nasjobs { + context: APIRequestContext; + nasTrialDetails: Resource$Projects$Locations$Nasjobs$Nastrialdetails; + constructor(context: APIRequestContext) { + this.context = context; + this.nasTrialDetails = + new Resource$Projects$Locations$Nasjobs$Nastrialdetails(this.context); + } + + /** + * Cancels a NasJob. Starts asynchronous cancellation on the NasJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetNasJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the NasJob is not deleted; instead it becomes a job with a NasJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and NasJob.state is set to `CANCELLED`. * @example * ```js * // Before running the sample: @@ -78439,55 +115321,26 @@ export namespace aiplatform_v1 { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.executions.patch({ - * // If set to true, and the Execution is not found, a new Execution is created. - * allowMissing: 'placeholder-value', - * // Output only. The resource name of the Execution. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/executions/my-execution', - * // Optional. A FieldMask indicating which fields should be updated. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "schemaTitle": "my_schemaTitle", - * // "schemaVersion": "my_schemaVersion", - * // "state": "my_state", - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.nasJobs.cancel({ + * // Required. The name of the NasJob to cancel. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` + * name: 'projects/my-project/locations/my-location/nasJobs/my-nasJob', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); * console.log(res.data); * * // Example response - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "schemaTitle": "my_schemaTitle", - * // "schemaVersion": "my_schemaVersion", - * // "state": "my_state", - * // "updateTime": "my_updateTime" - * // } + * // {} * } * * main().catch(e => { @@ -78502,62 +115355,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Patch, + cancel( + params: Params$Resource$Projects$Locations$Nasjobs$Cancel, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Patch, + cancel( + params?: Params$Resource$Projects$Locations$Nasjobs$Cancel, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - patch( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Patch, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Nasjobs$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Patch, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Nasjobs$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Nasjobs$Cancel, + callback: BodyResponseCallback ): void; - patch( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Nasjobs$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Patch; + {}) as Params$Resource$Projects$Locations$Nasjobs$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Patch; + params = {} as Params$Resource$Projects$Locations$Nasjobs$Cancel; options = {}; } @@ -78570,8 +115414,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -78582,19 +115426,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Purges Executions. + * Creates a NasJob * @example * ```js * // Before running the sample: @@ -78623,30 +115465,51 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.executions.purge({ - * // Required. The metadata store to purge Executions from. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - * parent: - * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', + * const res = await aiplatform.projects.locations.nasJobs.create({ + * // Required. The resource name of the Location to create the NasJob in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "filter": "my_filter", - * // "force": false - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "enableRestrictedImageTraining": false, + * // "encryptionSpec": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "labels": {}, + * // "name": "my_name", + * // "nasJobOutput": {}, + * // "nasJobSpec": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "enableRestrictedImageTraining": false, + * // "encryptionSpec": {}, + * // "endTime": "my_endTime", * // "error": {}, - * // "metadata": {}, + * // "labels": {}, * // "name": "my_name", - * // "response": {} + * // "nasJobOutput": {}, + * // "nasJobSpec": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "updateTime": "my_updateTime" * // } * } * @@ -78662,58 +115525,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Purge, + create( + params: Params$Resource$Projects$Locations$Nasjobs$Create, options: StreamMethodOptions ): Promise>; - purge( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Purge, + create( + params?: Params$Resource$Projects$Locations$Nasjobs$Create, options?: MethodOptions - ): Promise>; - purge( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Purge, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Nasjobs$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Purge, + create( + params: Params$Resource$Projects$Locations$Nasjobs$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Purge, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Nasjobs$Create, + callback: BodyResponseCallback ): void; - purge( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - purge( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Purge - | BodyResponseCallback + | Params$Resource$Projects$Locations$Nasjobs$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Purge; + {}) as Params$Resource$Projects$Locations$Nasjobs$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Purge; + params = {} as Params$Resource$Projects$Locations$Nasjobs$Create; options = {}; } @@ -78726,7 +115588,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/executions:purge').replace( + url: (rootUrl + '/v1/{+parent}/nasJobs').replace( /([^:]\/)\/+/g, '$1' ), @@ -78741,17 +115603,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events. + * Deletes a NasJob. * @example * ```js * // Before running the sample: @@ -78780,21 +115644,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.executions.queryExecutionInputsAndOutputs( - * { - * // Required. The resource name of the Execution whose input and output Artifacts should be retrieved as a LineageSubgraph. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` - * execution: - * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/executions/my-execution', - * }, - * ); + * const res = await aiplatform.projects.locations.nasJobs.delete({ + * // Required. The name of the NasJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` + * name: 'projects/my-project/locations/my-location/nasJobs/my-nasJob', + * }); * console.log(res.data); * * // Example response * // { - * // "artifacts": [], - * // "events": [], - * // "executions": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -78810,62 +115672,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - queryExecutionInputsAndOutputs( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs, + delete( + params: Params$Resource$Projects$Locations$Nasjobs$Delete, options: StreamMethodOptions ): Promise>; - queryExecutionInputsAndOutputs( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs, + delete( + params?: Params$Resource$Projects$Locations$Nasjobs$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - queryExecutionInputsAndOutputs( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Nasjobs$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - queryExecutionInputsAndOutputs( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs, + delete( + params: Params$Resource$Projects$Locations$Nasjobs$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - queryExecutionInputsAndOutputs( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Nasjobs$Delete, + callback: BodyResponseCallback ): void; - queryExecutionInputsAndOutputs( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - queryExecutionInputsAndOutputs( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs - | BodyResponseCallback + | Params$Resource$Projects$Locations$Nasjobs$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs; + {}) as Params$Resource$Projects$Locations$Nasjobs$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs; + params = {} as Params$Resource$Projects$Locations$Nasjobs$Delete; options = {}; } @@ -78878,149 +115735,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+execution}:queryExecutionInputsAndOutputs' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['execution'], - pathParams: ['execution'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents - extends StandardParameters { - /** - * Required. The resource name of the Execution that the Events connect Artifacts with. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` - */ - execution?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1AddExecutionEventsRequest; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Create - extends StandardParameters { - /** - * The {execution\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` If not provided, the Execution's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Executions in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Execution.) - */ - executionId?: string; - /** - * Required. The resource name of the MetadataStore where the Execution should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Execution; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Delete - extends StandardParameters { - /** - * Optional. The etag of the Execution to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION. - */ - etag?: string; - /** - * Required. The resource name of the Execution to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Get - extends StandardParameters { - /** - * Required. The resource name of the Execution to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$List - extends StandardParameters { - /** - * Filter specifying the boolean condition for the Executions to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = "test"`. Supported fields include: `name`, `display_name`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..` For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` * **Context based filtering**: To filter Executions based on the contexts to which they belong use the function operator with the full resource name: `in_context()`. For example: `in_context("projects//locations//metadataStores//contexts/")` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. - */ - filter?: string; - /** - * How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details. - */ - orderBy?: string; - /** - * The maximum number of Executions to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. - */ - pageSize?: number; - /** - * A page token, received from a previous MetadataService.ListExecutions call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with an INVALID_ARGUMENT error.) - */ - pageToken?: string; - /** - * Required. The MetadataStore whose Executions should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Patch - extends StandardParameters { - /** - * If set to true, and the Execution is not found, a new Execution is created. - */ - allowMissing?: boolean; - /** - * Output only. The resource name of the Execution. - */ - name?: string; - /** - * Optional. A FieldMask indicating which fields should be updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Execution; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Purge - extends StandardParameters { - /** - * Required. The metadata store to purge Executions from. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1PurgeExecutionsRequest; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs - extends StandardParameters { - /** - * Required. The resource name of the Execution whose input and output Artifacts should be retrieved as a LineageSubgraph. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` - */ - execution?: string; - } - - export class Resource$Projects$Locations$Metadatastores$Executions$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Gets a NasJob * @example * ```js * // Before running the sample: @@ -79041,7 +115778,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -79049,17 +115789,30 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.executions.operations.cancel( - * { - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/executions/my-execution/operations/my-operation', - * }, - * ); + * const res = await aiplatform.projects.locations.nasJobs.get({ + * // Required. The name of the NasJob resource. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` + * name: 'projects/my-project/locations/my-location/nasJobs/my-nasJob', + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "enableRestrictedImageTraining": false, + * // "encryptionSpec": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "labels": {}, + * // "name": "my_name", + * // "nasJobOutput": {}, + * // "nasJobSpec": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } * } * * main().catch(e => { @@ -79074,54 +115827,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel, + get( + params: Params$Resource$Projects$Locations$Nasjobs$Get, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel, + get( + params?: Params$Resource$Projects$Locations$Nasjobs$Get, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Nasjobs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Nasjobs$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Nasjobs$Get, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Nasjobs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Nasjobs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel; + params = {} as Params$Resource$Projects$Locations$Nasjobs$Get; options = {}; } @@ -79134,8 +115890,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -79146,17 +115902,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Lists NasJobs in a Location. * @example * ```js * // Before running the sample: @@ -79185,17 +115943,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.executions.operations.delete( - * { - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/executions/my-execution/operations/my-operation', - * }, - * ); + * const res = await aiplatform.projects.locations.nasJobs.list({ + * // The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` + * filter: 'placeholder-value', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. Typically obtained via ListNasJobsResponse.next_page_token of the previous JobService.ListNasJobs call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location to list the NasJobs from. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "nasJobs": [], + * // "nextPageToken": "my_nextPageToken" + * // } * } * * main().catch(e => { @@ -79210,54 +115976,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete, + list( + params: Params$Resource$Projects$Locations$Nasjobs$List, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete, + list( + params?: Params$Resource$Projects$Locations$Nasjobs$List, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Nasjobs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Nasjobs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Nasjobs$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Nasjobs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Nasjobs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete; + params = {} as Params$Resource$Projects$Locations$Nasjobs$List; options = {}; } @@ -79270,29 +116043,103 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/nasJobs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Nasjobs$Cancel + extends StandardParameters { /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Required. The name of the NasJob to cancel. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CancelNasJobRequest; + } + export interface Params$Resource$Projects$Locations$Nasjobs$Create + extends StandardParameters { + /** + * Required. The resource name of the Location to create the NasJob in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1NasJob; + } + export interface Params$Resource$Projects$Locations$Nasjobs$Delete + extends StandardParameters { + /** + * Required. The name of the NasJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Nasjobs$Get + extends StandardParameters { + /** + * Required. The name of the NasJob resource. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Nasjobs$List + extends StandardParameters { + /** + * The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` + */ + filter?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. Typically obtained via ListNasJobsResponse.next_page_token of the previous JobService.ListNasJobs call. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list the NasJobs from. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + + export class Resource$Projects$Locations$Nasjobs$Nastrialdetails { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a NasTrialDetail. * @example * ```js * // Before running the sample: @@ -79321,22 +116168,18 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.executions.operations.get( - * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/executions/my-execution/operations/my-operation', - * }, - * ); + * const res = await aiplatform.projects.locations.nasJobs.nasTrialDetails.get({ + * // Required. The name of the NasTrialDetail resource. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}/nasTrialDetails/{nas_trial_detail\}` + * name: 'projects/my-project/locations/my-location/nasJobs/my-nasJob/nasTrialDetails/my-nasTrialDetail', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, * // "name": "my_name", - * // "response": {} + * // "parameters": "my_parameters", + * // "searchTrial": {}, + * // "trainTrial": {} * // } * } * @@ -79353,57 +116196,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get, + params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get, + params?: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get, options?: MethodOptions - ): Promise>; + ): Promise< + GaxiosResponseWithHTTP2 + >; get( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get, + params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get, + params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get; + {}) as Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get; + {} as Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get; options = {}; } @@ -79428,17 +116275,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * List top NasTrialDetails of a NasJob. * @example * ```js * // Before running the sample: @@ -79467,28 +116316,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.executions.operations.list( - * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/executions/my-execution', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.projects.locations.nasJobs.nasTrialDetails.list({ + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. Typically obtained via ListNasTrialDetailsResponse.next_page_token of the previous JobService.ListNasTrialDetails call. + * pageToken: 'placeholder-value', + * // Required. The name of the NasJob resource. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` + * parent: 'projects/my-project/locations/my-location/nasJobs/my-nasJob', + * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "nasTrialDetails": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -79505,61 +116346,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List, + params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List, + params?: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List, + params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List, + params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List; + {}) as Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List; + {} as Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List; options = {}; } @@ -79572,7 +116413,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+parent}/nasTrialDetails').replace( /([^:]\/)\/+/g, '$1' ), @@ -79582,24 +116423,59 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get + extends StandardParameters { /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Required. The name of the NasTrialDetail resource. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}/nasTrialDetails/{nas_trial_detail\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List + extends StandardParameters { + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. Typically obtained via ListNasTrialDetailsResponse.next_page_token of the previous JobService.ListNasTrialDetails call. + */ + pageToken?: string; + /** + * Required. The name of the NasJob resource. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` + */ + parent?: string; + } + + export class Resource$Projects$Locations$Notebookexecutionjobs { + context: APIRequestContext; + operations: Resource$Projects$Locations$Notebookexecutionjobs$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Notebookexecutionjobs$Operations( + this.context + ); + } + + /** + * Creates a NotebookExecutionJob. * @example * ```js * // Before running the sample: @@ -79628,15 +116504,39 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.executions.operations.wait( - * { - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/executions/my-execution/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.projects.locations.notebookExecutionJobs.create({ + * // Optional. User specified ID for the NotebookExecutionJob. + * notebookExecutionJobId: 'placeholder-value', + * // Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "customEnvironmentSpec": {}, + * // "dataformRepositorySource": {}, + * // "directNotebookSource": {}, + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "executionTimeout": "my_executionTimeout", + * // "executionUser": "my_executionUser", + * // "gcsNotebookSource": {}, + * // "gcsOutputUri": "my_gcsOutputUri", + * // "jobState": "my_jobState", + * // "kernelName": "my_kernelName", + * // "labels": {}, + * // "name": "my_name", + * // "notebookRuntimeTemplateResourceName": "my_notebookRuntimeTemplateResourceName", + * // "scheduleResourceName": "my_scheduleResourceName", + * // "serviceAccount": "my_serviceAccount", + * // "status": {}, + * // "updateTime": "my_updateTime", + * // "workbenchRuntime": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response @@ -79661,36 +116561,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait, + create( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Create, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait, + create( + params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Create, options?: MethodOptions ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait, + create( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait, + create( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait, + create( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Create, callback: BodyResponseCallback ): void; - wait( + create( callback: BodyResponseCallback ): void; - wait( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait + | Params$Resource$Projects$Locations$Notebookexecutionjobs$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -79701,116 +116601,56 @@ export namespace aiplatform_v1 { callback?: | BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel - extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete - extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait - extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Create; + let options = (optionsOrCallback || {}) as MethodOptions; - export class Resource$Projects$Locations$Metadatastores$Metadataschemas { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/notebookExecutionJobs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } } /** - * Creates a MetadataSchema. + * Deletes a NotebookExecutionJob. * @example * ```js * // Before running the sample: @@ -79839,37 +116679,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.metadataSchemas.create({ - * // The {metadata_schema\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/metadataSchemas/{metadataschema\}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all MetadataSchemas in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataSchema.) - * metadataSchemaId: 'placeholder-value', - * // Required. The resource name of the MetadataStore where the MetadataSchema should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - * parent: - * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "name": "my_name", - * // "schema": "my_schema", - * // "schemaType": "my_schemaType", - * // "schemaVersion": "my_schemaVersion" - * // } - * }, - * }); + * const res = await aiplatform.projects.locations.notebookExecutionJobs.delete({ + * // Required. The name of the NotebookExecutionJob resource to be deleted. + * name: 'projects/my-project/locations/my-location/notebookExecutionJobs/my-notebookExecutionJob', + * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "description": "my_description", + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "schema": "my_schema", - * // "schemaType": "my_schemaType", - * // "schemaVersion": "my_schemaVersion" + * // "response": {} * // } * } * @@ -79885,62 +116707,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create, + delete( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create, + delete( + params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - create( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create, + delete( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - create( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create; + {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create; + {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete; options = {}; } @@ -79953,34 +116771,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/metadataSchemas').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Retrieves a specific MetadataSchema. + * Gets a NotebookExecutionJob. * @example * ```js * // Before running the sample: @@ -80009,21 +116822,36 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.metadataSchemas.get({ - * // Required. The resource name of the MetadataSchema to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/metadataSchemas/{metadataschema\}` - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/metadataSchemas/my-metadataSchema', - * }); + * const res = await aiplatform.projects.locations.notebookExecutionJobs.get({ + * // Required. The name of the NotebookExecutionJob resource. + * name: 'projects/my-project/locations/my-location/notebookExecutionJobs/my-notebookExecutionJob', + * // Optional. The NotebookExecutionJob view. Defaults to BASIC. + * view: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { * // "createTime": "my_createTime", - * // "description": "my_description", + * // "customEnvironmentSpec": {}, + * // "dataformRepositorySource": {}, + * // "directNotebookSource": {}, + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "executionTimeout": "my_executionTimeout", + * // "executionUser": "my_executionUser", + * // "gcsNotebookSource": {}, + * // "gcsOutputUri": "my_gcsOutputUri", + * // "jobState": "my_jobState", + * // "kernelName": "my_kernelName", + * // "labels": {}, * // "name": "my_name", - * // "schema": "my_schema", - * // "schemaType": "my_schemaType", - * // "schemaVersion": "my_schemaVersion" + * // "notebookRuntimeTemplateResourceName": "my_notebookRuntimeTemplateResourceName", + * // "scheduleResourceName": "my_scheduleResourceName", + * // "serviceAccount": "my_serviceAccount", + * // "status": {}, + * // "updateTime": "my_updateTime", + * // "workbenchRuntime": {} * // } * } * @@ -80040,61 +116868,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get, + params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; get( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookexecutionjobs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get; + {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get; + {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Get; options = {}; } @@ -80119,19 +116947,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists MetadataSchemas. + * Lists NotebookExecutionJobs in a Location. * @example * ```js * // Before running the sample: @@ -80160,24 +116988,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.metadataSchemas.list({ - * // A query to filter available MetadataSchemas for matching results. - * filter: 'placeholder-value', - * // The maximum number of MetadataSchemas to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. - * pageSize: 'placeholder-value', - * // A page token, received from a previous MetadataService.ListMetadataSchemas call. Provide this to retrieve the next page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) - * pageToken: 'placeholder-value', - * // Required. The MetadataStore whose MetadataSchemas should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - * parent: - * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', - * }); + * const res = await aiplatform.projects.locations.notebookExecutionJobs.list({ + * // Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookExecutionJob` supports = and !=. `notebookExecutionJob` represents the NotebookExecutionJob ID. * `displayName` supports = and != and regex. * `schedule` supports = and != and regex. Some examples: * `notebookExecutionJob="123"` * `notebookExecutionJob="my-execution-job"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` + * filter: 'placeholder-value', + * // Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. + * orderBy: 'placeholder-value', + * // Optional. The standard list page size. + * pageSize: 'placeholder-value', + * // Optional. The standard list page token. Typically obtained via ListNotebookExecutionJobsResponse.next_page_token of the previous NotebookService.ListNotebookExecutionJobs call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location from which to list the NotebookExecutionJobs. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // Optional. The NotebookExecutionJob view. Defaults to BASIC. + * view: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "metadataSchemas": [], - * // "nextPageToken": "my_nextPageToken" + * // "nextPageToken": "my_nextPageToken", + * // "notebookExecutionJobs": [] * // } * } * @@ -80194,61 +117024,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List, + params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookexecutionjobs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List; + {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List; + {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$List; options = {}; } @@ -80261,7 +117091,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/metadataSchemas').replace( + url: (rootUrl + '/v1/{+parent}/notebookExecutionJobs').replace( /([^:]\/)\/+/g, '$1' ), @@ -80276,62 +117106,81 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create + export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Create extends StandardParameters { /** - * The {metadata_schema\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/metadataSchemas/{metadataschema\}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all MetadataSchemas in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataSchema.) + * Optional. User specified ID for the NotebookExecutionJob. */ - metadataSchemaId?: string; + notebookExecutionJobId?: string; /** - * Required. The resource name of the MetadataStore where the MetadataSchema should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project\}/locations/{location\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1MetadataSchema; + requestBody?: Schema$GoogleCloudAiplatformV1NotebookExecutionJob; } - export interface Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get + export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete extends StandardParameters { /** - * Required. The resource name of the MetadataSchema to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/metadataSchemas/{metadataschema\}` + * Required. The name of the NotebookExecutionJob resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List + export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Get extends StandardParameters { /** - * A query to filter available MetadataSchemas for matching results. + * Required. The name of the NotebookExecutionJob resource. + */ + name?: string; + /** + * Optional. The NotebookExecutionJob view. Defaults to BASIC. + */ + view?: string; + } + export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$List + extends StandardParameters { + /** + * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookExecutionJob` supports = and !=. `notebookExecutionJob` represents the NotebookExecutionJob ID. * `displayName` supports = and != and regex. * `schedule` supports = and != and regex. Some examples: * `notebookExecutionJob="123"` * `notebookExecutionJob="my-execution-job"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` */ filter?: string; /** - * The maximum number of MetadataSchemas to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. + * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. + */ + orderBy?: string; + /** + * Optional. The standard list page size. */ pageSize?: number; /** - * A page token, received from a previous MetadataService.ListMetadataSchemas call. Provide this to retrieve the next page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) + * Optional. The standard list page token. Typically obtained via ListNotebookExecutionJobsResponse.next_page_token of the previous NotebookService.ListNotebookExecutionJobs call. */ pageToken?: string; /** - * Required. The MetadataStore whose MetadataSchemas should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * Required. The resource name of the Location from which to list the NotebookExecutionJobs. Format: `projects/{project\}/locations/{location\}` */ parent?: string; + /** + * Optional. The NotebookExecutionJob view. Defaults to BASIC. + */ + view?: string; } - export class Resource$Projects$Locations$Metadatastores$Operations { + export class Resource$Projects$Locations$Notebookexecutionjobs$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -80368,10 +117217,12 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.metadataStores.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/operations/my-operation', - * }); + * await aiplatform.projects.locations.notebookExecutionJobs.operations.cancel( + * { + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/notebookExecutionJobs/my-notebookExecutionJob/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response @@ -80391,31 +117242,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel + | Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -80431,13 +117282,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel; options = {}; } @@ -80502,10 +117353,12 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.metadataStores.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/operations/my-operation', - * }); + * await aiplatform.projects.locations.notebookExecutionJobs.operations.delete( + * { + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/notebookExecutionJobs/my-notebookExecutionJob/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response @@ -80525,31 +117378,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Delete, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Metadatastores$Operations$Delete, + params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Delete, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Delete, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Delete, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Operations$Delete + | Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -80565,13 +117418,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Operations$Delete; + {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete; options = {}; } @@ -80635,12 +117488,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.metadataStores.operations.get( - * { + * const res = + * await aiplatform.projects.locations.notebookExecutionJobs.operations.get({ * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/operations/my-operation', - * }, - * ); + * name: 'projects/my-project/locations/my-location/notebookExecutionJobs/my-notebookExecutionJob/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -80666,27 +117518,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Get, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Metadatastores$Operations$Get, + params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Get, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Get, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Get, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -80694,7 +117546,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Operations$Get + | Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -80710,13 +117562,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Operations$Get; + {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Operations$Get; + {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get; options = {}; } @@ -80781,11 +117633,11 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.metadataStores.operations.list({ + * await aiplatform.projects.locations.notebookExecutionJobs.operations.list({ * // The standard list filter. * filter: 'placeholder-value', * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', + * name: 'projects/my-project/locations/my-location/notebookExecutionJobs/my-notebookExecutionJob', * // The standard list page size. * pageSize: 'placeholder-value', * // The standard list page token. @@ -80816,29 +117668,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$List, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Metadatastores$Operations$List, + params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$List, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$List, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$List, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List, callback: BodyResponseCallback ): void; list( @@ -80846,7 +117698,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Operations$List + | Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -80864,13 +117716,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Operations$List; + {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Operations$List; + {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List; options = {}; } @@ -80940,9 +117792,9 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.metadataStores.operations.wait({ + * await aiplatform.projects.locations.notebookExecutionJobs.operations.wait({ * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/operations/my-operation', + * name: 'projects/my-project/locations/my-location/notebookExecutionJobs/my-notebookExecutionJob/operations/my-operation', * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. * timeout: 'placeholder-value', * }); @@ -80971,27 +117823,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Wait, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Metadatastores$Operations$Wait, + params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Wait, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Wait, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Wait, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -80999,7 +117851,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Operations$Wait + | Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -81015,13 +117867,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Operations$Wait; + {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait; options = {}; } @@ -81056,28 +117908,28 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel + export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Operations$Delete + export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Operations$Get + export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Operations$List + export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List extends StandardParameters { /** * The standard list filter. @@ -81100,7 +117952,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Metadatastores$Operations$Wait + export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -81112,19 +117964,19 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Migratableresources { + export class Resource$Projects$Locations$Notebookruntimes { context: APIRequestContext; - operations: Resource$Projects$Locations$Migratableresources$Operations; + operations: Resource$Projects$Locations$Notebookruntimes$Operations; constructor(context: APIRequestContext) { this.context = context; this.operations = - new Resource$Projects$Locations$Migratableresources$Operations( + new Resource$Projects$Locations$Notebookruntimes$Operations( this.context ); } /** - * Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI. + * Assigns a NotebookRuntime to a user for a particular Notebook file. This method will either returns an existing assignment or generates a new one. * @example * ```js * // Before running the sample: @@ -81153,19 +118005,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.migratableResources.batchMigrate({ - * // Required. The location of the migrated resource will live in. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * const res = await aiplatform.projects.locations.notebookRuntimes.assign({ + * // Required. The resource name of the Location to get the NotebookRuntime assignment. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "migrateResourceRequests": [] - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "notebookRuntime": {}, + * // "notebookRuntimeId": "my_notebookRuntimeId", + * // "notebookRuntimeTemplate": "my_notebookRuntimeTemplate" + * // } + * }, + * }); * console.log(res.data); * * // Example response @@ -81190,36 +118043,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchMigrate( - params: Params$Resource$Projects$Locations$Migratableresources$Batchmigrate, + assign( + params: Params$Resource$Projects$Locations$Notebookruntimes$Assign, options: StreamMethodOptions ): Promise>; - batchMigrate( - params?: Params$Resource$Projects$Locations$Migratableresources$Batchmigrate, + assign( + params?: Params$Resource$Projects$Locations$Notebookruntimes$Assign, options?: MethodOptions ): Promise>; - batchMigrate( - params: Params$Resource$Projects$Locations$Migratableresources$Batchmigrate, + assign( + params: Params$Resource$Projects$Locations$Notebookruntimes$Assign, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchMigrate( - params: Params$Resource$Projects$Locations$Migratableresources$Batchmigrate, + assign( + params: Params$Resource$Projects$Locations$Notebookruntimes$Assign, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchMigrate( - params: Params$Resource$Projects$Locations$Migratableresources$Batchmigrate, + assign( + params: Params$Resource$Projects$Locations$Notebookruntimes$Assign, callback: BodyResponseCallback ): void; - batchMigrate( + assign( callback: BodyResponseCallback ): void; - batchMigrate( + assign( paramsOrCallback?: - | Params$Resource$Projects$Locations$Migratableresources$Batchmigrate + | Params$Resource$Projects$Locations$Notebookruntimes$Assign | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -81235,13 +118088,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Migratableresources$Batchmigrate; + {}) as Params$Resource$Projects$Locations$Notebookruntimes$Assign; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Migratableresources$Batchmigrate; + {} as Params$Resource$Projects$Locations$Notebookruntimes$Assign; options = {}; } @@ -81254,9 +118107,10 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+parent}/migratableResources:batchMigrate' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/notebookRuntimes:assign').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, @@ -81278,7 +118132,7 @@ export namespace aiplatform_v1 { } /** - * Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given location. + * Deletes a NotebookRuntime. * @example * ```js * // Before running the sample: @@ -81307,26 +118161,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.migratableResources.search({ - * // Required. The location that the migratable resources should be searched from. It's the Vertex AI location that the resources can be migrated to, not the resources' original location. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "filter": "my_filter", - * // "pageSize": 0, - * // "pageToken": "my_pageToken" - * // } - * }, + * const res = await aiplatform.projects.locations.notebookRuntimes.delete({ + * // Required. The name of the NotebookRuntime resource to be deleted. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. + * name: 'projects/my-project/locations/my-location/notebookRuntimes/my-notebookRuntime', * }); * console.log(res.data); * * // Example response * // { - * // "migratableResources": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -81342,367 +118189,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - search( - params: Params$Resource$Projects$Locations$Migratableresources$Search, - options: StreamMethodOptions - ): Promise>; - search( - params?: Params$Resource$Projects$Locations$Migratableresources$Search, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - search( - params: Params$Resource$Projects$Locations$Migratableresources$Search, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - search( - params: Params$Resource$Projects$Locations$Migratableresources$Search, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - search( - params: Params$Resource$Projects$Locations$Migratableresources$Search, - callback: BodyResponseCallback - ): void; - search( - callback: BodyResponseCallback - ): void; - search( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Migratableresources$Search - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Migratableresources$Search; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Migratableresources$Search; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/migratableResources:search').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Migratableresources$Batchmigrate - extends StandardParameters { - /** - * Required. The location of the migrated resource will live in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1BatchMigrateResourcesRequest; - } - export interface Params$Resource$Projects$Locations$Migratableresources$Search - extends StandardParameters { - /** - * Required. The location that the migratable resources should be searched from. It's the Vertex AI location that the resources can be migrated to, not the resources' original location. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1SearchMigratableResourcesRequest; - } - - export class Resource$Projects$Locations$Migratableresources$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const aiplatform = google.aiplatform('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await aiplatform.projects.locations.migratableResources.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/migratableResources/my-migratableResource/operations/my-operation', - * }); - * console.log(res.data); - * - * // Example response - * // {} - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - cancel( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel, - options: StreamMethodOptions - ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel, - options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - cancel( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - cancel( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel, - callback: BodyResponseCallback - ): void; - cancel(callback: BodyResponseCallback): void; - cancel( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const aiplatform = google.aiplatform('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await aiplatform.projects.locations.migratableResources.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/migratableResources/my-migratableResource/operations/my-operation', - * }); - * console.log(res.data); - * - * // Example response - * // {} - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ delete( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Delete, + params: Params$Resource$Projects$Locations$Notebookruntimes$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Migratableresources$Operations$Delete, + params?: Params$Resource$Projects$Locations$Notebookruntimes$Delete, options?: MethodOptions - ): Promise>; + ): Promise>; delete( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Delete, + params: Params$Resource$Projects$Locations$Notebookruntimes$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Notebookruntimes$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Notebookruntimes$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Migratableresources$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimes$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Migratableresources$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Notebookruntimes$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Migratableresources$Operations$Delete; + {} as Params$Resource$Projects$Locations$Notebookruntimes$Delete; options = {}; } @@ -81727,17 +118265,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Gets a NotebookRuntime. * @example * ```js * // Before running the sample: @@ -81766,20 +118304,42 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.migratableResources.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/migratableResources/my-migratableResource/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.notebookRuntimes.get({ + * // Required. The name of the NotebookRuntime resource. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. + * name: 'projects/my-project/locations/my-location/notebookRuntimes/my-notebookRuntime', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "createTime": "my_createTime", + * // "dataPersistentDiskSpec": {}, + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "eucConfig": {}, + * // "expirationTime": "my_expirationTime", + * // "healthState": "my_healthState", + * // "idleShutdownConfig": {}, + * // "isUpgradable": false, + * // "labels": {}, + * // "machineSpec": {}, * // "name": "my_name", - * // "response": {} + * // "networkSpec": {}, + * // "networkTags": [], + * // "notebookRuntimeTemplateRef": {}, + * // "notebookRuntimeType": "my_notebookRuntimeType", + * // "proxyUri": "my_proxyUri", + * // "reservationAffinity": {}, + * // "runtimeState": "my_runtimeState", + * // "runtimeUser": "my_runtimeUser", + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "serviceAccount": "my_serviceAccount", + * // "shieldedVmConfig": {}, + * // "softwareConfig": {}, + * // "updateTime": "my_updateTime", + * // "version": "my_version" * // } * } * @@ -81796,57 +118356,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Get, + params: Params$Resource$Projects$Locations$Notebookruntimes$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Migratableresources$Operations$Get, + params?: Params$Resource$Projects$Locations$Notebookruntimes$Get, options?: MethodOptions - ): Promise>; + ): Promise< + GaxiosResponseWithHTTP2 + >; get( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Get, + params: Params$Resource$Projects$Locations$Notebookruntimes$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Get, + params: Params$Resource$Projects$Locations$Notebookruntimes$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Notebookruntimes$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Migratableresources$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimes$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Migratableresources$Operations$Get; + {}) as Params$Resource$Projects$Locations$Notebookruntimes$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Migratableresources$Operations$Get; + params = {} as Params$Resource$Projects$Locations$Notebookruntimes$Get; options = {}; } @@ -81871,17 +118434,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Lists NotebookRuntimes in a Location. * @example * ```js * // Before running the sample: @@ -81909,27 +118474,27 @@ export namespace aiplatform_v1 { * const authClient = await auth.getClient(); * google.options({auth: authClient}); * - * // Do the magic - * const res = - * await aiplatform.projects.locations.migratableResources.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/migratableResources/my-migratableResource', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * // Do the magic + * const res = await aiplatform.projects.locations.notebookRuntimes.list({ + * // Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED, ERROR, INVALID]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntime="notebookRuntime123"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` * `notebookRuntimeTemplate="notebookRuntimeTemplate321"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser="test@google.com"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4` + * filter: 'placeholder-value', + * // Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. + * orderBy: 'placeholder-value', + * // Optional. The standard list page size. + * pageSize: 'placeholder-value', + * // Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimes call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location from which to list the NotebookRuntimes. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // Optional. Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "notebookRuntimes": [] * // } * } * @@ -81946,61 +118511,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$List, + params: Params$Resource$Projects$Locations$Notebookruntimes$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Migratableresources$Operations$List, + params?: Params$Resource$Projects$Locations$Notebookruntimes$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$List, + params: Params$Resource$Projects$Locations$Notebookruntimes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$List, + params: Params$Resource$Projects$Locations$Notebookruntimes$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Notebookruntimes$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Migratableresources$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimes$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Migratableresources$Operations$List; + {}) as Params$Resource$Projects$Locations$Notebookruntimes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Migratableresources$Operations$List; + params = {} as Params$Resource$Projects$Locations$Notebookruntimes$List; options = {}; } @@ -82013,7 +118577,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+parent}/notebookRuntimes').replace( /([^:]\/)\/+/g, '$1' ), @@ -82023,24 +118587,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Starts a NotebookRuntime. * @example * ```js * // Before running the sample: @@ -82069,13 +118633,16 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.migratableResources.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/migratableResources/my-migratableResource/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); + * const res = await aiplatform.projects.locations.notebookRuntimes.start({ + * // Required. The name of the NotebookRuntime resource to be started. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. + * name: 'projects/my-project/locations/my-location/notebookRuntimes/my-notebookRuntime', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); * console.log(res.data); * * // Example response @@ -82100,36 +118667,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Wait, + start( + params: Params$Resource$Projects$Locations$Notebookruntimes$Start, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Migratableresources$Operations$Wait, + start( + params?: Params$Resource$Projects$Locations$Notebookruntimes$Start, options?: MethodOptions ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Wait, + start( + params: Params$Resource$Projects$Locations$Notebookruntimes$Start, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Wait, + start( + params: Params$Resource$Projects$Locations$Notebookruntimes$Start, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Wait, + start( + params: Params$Resource$Projects$Locations$Notebookruntimes$Start, callback: BodyResponseCallback ): void; - wait( + start( callback: BodyResponseCallback ): void; - wait( + start( paramsOrCallback?: - | Params$Resource$Projects$Locations$Migratableresources$Operations$Wait + | Params$Resource$Projects$Locations$Notebookruntimes$Start | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -82145,13 +118712,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Migratableresources$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Notebookruntimes$Start; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Migratableresources$Operations$Wait; + {} as Params$Resource$Projects$Locations$Notebookruntimes$Start; options = {}; } @@ -82164,7 +118731,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:start').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -82184,77 +118751,9 @@ export namespace aiplatform_v1 { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel - extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Migratableresources$Operations$Delete - extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Migratableresources$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Migratableresources$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Locations$Migratableresources$Operations$Wait - extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Modeldeploymentmonitoringjobs { - context: APIRequestContext; - operations: Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations( - this.context - ); - } /** - * Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval. + * Stops a NotebookRuntime. * @example * ```js * // Before running the sample: @@ -82283,72 +118782,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.create({ - * // Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * const res = await aiplatform.projects.locations.notebookRuntimes.stop({ + * // Required. The name of the NotebookRuntime resource to be stopped. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. + * name: 'projects/my-project/locations/my-location/notebookRuntimes/my-notebookRuntime', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "analysisInstanceSchemaUri": "my_analysisInstanceSchemaUri", - * // "bigqueryTables": [], - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "enableMonitoringPipelineLogs": false, - * // "encryptionSpec": {}, - * // "endpoint": "my_endpoint", - * // "error": {}, - * // "labels": {}, - * // "latestMonitoringPipelineMetadata": {}, - * // "logTtl": "my_logTtl", - * // "loggingSamplingStrategy": {}, - * // "modelDeploymentMonitoringObjectiveConfigs": [], - * // "modelDeploymentMonitoringScheduleConfig": {}, - * // "modelMonitoringAlertConfig": {}, - * // "name": "my_name", - * // "nextScheduleTime": "my_nextScheduleTime", - * // "predictInstanceSchemaUri": "my_predictInstanceSchemaUri", - * // "samplePredictInstance": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "scheduleState": "my_scheduleState", - * // "state": "my_state", - * // "statsAnomaliesBaseDirectory": {}, - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "analysisInstanceSchemaUri": "my_analysisInstanceSchemaUri", - * // "bigqueryTables": [], - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "enableMonitoringPipelineLogs": false, - * // "encryptionSpec": {}, - * // "endpoint": "my_endpoint", + * // "done": false, * // "error": {}, - * // "labels": {}, - * // "latestMonitoringPipelineMetadata": {}, - * // "logTtl": "my_logTtl", - * // "loggingSamplingStrategy": {}, - * // "modelDeploymentMonitoringObjectiveConfigs": [], - * // "modelDeploymentMonitoringScheduleConfig": {}, - * // "modelMonitoringAlertConfig": {}, + * // "metadata": {}, * // "name": "my_name", - * // "nextScheduleTime": "my_nextScheduleTime", - * // "predictInstanceSchemaUri": "my_predictInstanceSchemaUri", - * // "samplePredictInstance": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "scheduleState": "my_scheduleState", - * // "state": "my_state", - * // "statsAnomaliesBaseDirectory": {}, - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -82364,62 +118816,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create, + stop( + params: Params$Resource$Projects$Locations$Notebookruntimes$Stop, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create, + stop( + params?: Params$Resource$Projects$Locations$Notebookruntimes$Stop, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - create( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create, + ): Promise>; + stop( + params: Params$Resource$Projects$Locations$Notebookruntimes$Stop, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create, + stop( + params: Params$Resource$Projects$Locations$Notebookruntimes$Stop, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create, - callback: BodyResponseCallback + stop( + params: Params$Resource$Projects$Locations$Notebookruntimes$Stop, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + stop( + callback: BodyResponseCallback ): void; - create( + stop( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimes$Stop + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create; + {}) as Params$Resource$Projects$Locations$Notebookruntimes$Stop; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create; + params = {} as Params$Resource$Projects$Locations$Notebookruntimes$Stop; options = {}; } @@ -82432,33 +118879,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+parent}/modelDeploymentMonitoringJobs' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:stop').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes a ModelDeploymentMonitoringJob. + * Upgrades a NotebookRuntime. * @example * ```js * // Before running the sample: @@ -82487,11 +118930,16 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.delete({ - * // Required. The resource name of the model monitoring job to delete. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` - * name: 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob', - * }); + * const res = await aiplatform.projects.locations.notebookRuntimes.upgrade({ + * // Required. The name of the NotebookRuntime resource to be upgrade. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. + * name: 'projects/my-project/locations/my-location/notebookRuntimes/my-notebookRuntime', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); * console.log(res.data); * * // Example response @@ -82516,36 +118964,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete, + upgrade( + params: Params$Resource$Projects$Locations$Notebookruntimes$Upgrade, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete, + upgrade( + params?: Params$Resource$Projects$Locations$Notebookruntimes$Upgrade, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete, + upgrade( + params: Params$Resource$Projects$Locations$Notebookruntimes$Upgrade, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete, + upgrade( + params: Params$Resource$Projects$Locations$Notebookruntimes$Upgrade, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete, + upgrade( + params: Params$Resource$Projects$Locations$Notebookruntimes$Upgrade, callback: BodyResponseCallback ): void; - delete( + upgrade( callback: BodyResponseCallback ): void; - delete( + upgrade( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete + | Params$Resource$Projects$Locations$Notebookruntimes$Upgrade | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -82561,13 +119009,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete; + {}) as Params$Resource$Projects$Locations$Notebookruntimes$Upgrade; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete; + {} as Params$Resource$Projects$Locations$Notebookruntimes$Upgrade; options = {}; } @@ -82580,8 +119028,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}:upgrade').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -82600,9 +119051,106 @@ export namespace aiplatform_v1 { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Notebookruntimes$Assign + extends StandardParameters { /** - * Gets a ModelDeploymentMonitoringJob. + * Required. The resource name of the Location to get the NotebookRuntime assignment. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1AssignNotebookRuntimeRequest; + } + export interface Params$Resource$Projects$Locations$Notebookruntimes$Delete + extends StandardParameters { + /** + * Required. The name of the NotebookRuntime resource to be deleted. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Notebookruntimes$Get + extends StandardParameters { + /** + * Required. The name of the NotebookRuntime resource. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Notebookruntimes$List + extends StandardParameters { + /** + * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED, ERROR, INVALID]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntime="notebookRuntime123"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` * `notebookRuntimeTemplate="notebookRuntimeTemplate321"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser="test@google.com"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4` + */ + filter?: string; + /** + * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. + */ + orderBy?: string; + /** + * Optional. The standard list page size. + */ + pageSize?: number; + /** + * Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimes call. + */ + pageToken?: string; + /** + * Required. The resource name of the Location from which to list the NotebookRuntimes. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Optional. Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Notebookruntimes$Start + extends StandardParameters { + /** + * Required. The name of the NotebookRuntime resource to be started. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1StartNotebookRuntimeRequest; + } + export interface Params$Resource$Projects$Locations$Notebookruntimes$Stop + extends StandardParameters { + /** + * Required. The name of the NotebookRuntime resource to be stopped. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1StopNotebookRuntimeRequest; + } + export interface Params$Resource$Projects$Locations$Notebookruntimes$Upgrade + extends StandardParameters { + /** + * Required. The name of the NotebookRuntime resource to be upgrade. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest; + } + + export class Resource$Projects$Locations$Notebookruntimes$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -82632,40 +119180,14 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.get({ - * // Required. The resource name of the ModelDeploymentMonitoringJob. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` - * name: 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob', + * await aiplatform.projects.locations.notebookRuntimes.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/notebookRuntimes/my-notebookRuntime/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "analysisInstanceSchemaUri": "my_analysisInstanceSchemaUri", - * // "bigqueryTables": [], - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "enableMonitoringPipelineLogs": false, - * // "encryptionSpec": {}, - * // "endpoint": "my_endpoint", - * // "error": {}, - * // "labels": {}, - * // "latestMonitoringPipelineMetadata": {}, - * // "logTtl": "my_logTtl", - * // "loggingSamplingStrategy": {}, - * // "modelDeploymentMonitoringObjectiveConfigs": [], - * // "modelDeploymentMonitoringScheduleConfig": {}, - * // "modelMonitoringAlertConfig": {}, - * // "name": "my_name", - * // "nextScheduleTime": "my_nextScheduleTime", - * // "predictInstanceSchemaUri": "my_predictInstanceSchemaUri", - * // "samplePredictInstance": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "scheduleState": "my_scheduleState", - * // "state": "my_state", - * // "statsAnomaliesBaseDirectory": {}, - * // "updateTime": "my_updateTime" - * // } + * // {} * } * * main().catch(e => { @@ -82680,62 +119202,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get, + cancel( + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get, + cancel( + params?: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel, + callback: BodyResponseCallback ): void; - get( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get; + {}) as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get; + {} as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel; options = {}; } @@ -82748,8 +119262,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -82760,19 +119274,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists ModelDeploymentMonitoringJobs in a Location. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -82802,25 +119314,14 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.list({ - * // The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` - * filter: 'placeholder-value', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * // Mask specifying which fields to read - * readMask: 'placeholder-value', + * await aiplatform.projects.locations.notebookRuntimes.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/notebookRuntimes/my-notebookRuntime/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "modelDeploymentMonitoringJobs": [], - * // "nextPageToken": "my_nextPageToken" - * // } + * // {} * } * * main().catch(e => { @@ -82835,62 +119336,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List, + delete( + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List, + delete( + params?: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List; + {}) as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List; + {} as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete; options = {}; } @@ -82903,33 +119396,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+parent}/modelDeploymentMonitoringJobs' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a ModelDeploymentMonitoringJob. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -82959,43 +119448,9 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.patch({ - * // Output only. Resource name of a ModelDeploymentMonitoringJob. - * name: 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob', - * // Required. The update mask is used to specify the fields to be overwritten in the ModelDeploymentMonitoringJob resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. For the objective config, the user can either provide the update mask for model_deployment_monitoring_objective_configs or any combination of its nested fields, such as: model_deployment_monitoring_objective_configs.objective_config.training_dataset. Updatable fields: * `display_name` * `model_deployment_monitoring_schedule_config` * `model_monitoring_alert_config` * `logging_sampling_strategy` * `labels` * `log_ttl` * `enable_monitoring_pipeline_logs` . and * `model_deployment_monitoring_objective_configs` . or * `model_deployment_monitoring_objective_configs.objective_config.training_dataset` * `model_deployment_monitoring_objective_configs.objective_config.training_prediction_skew_detection_config` * `model_deployment_monitoring_objective_configs.objective_config.prediction_drift_detection_config` - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "analysisInstanceSchemaUri": "my_analysisInstanceSchemaUri", - * // "bigqueryTables": [], - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "enableMonitoringPipelineLogs": false, - * // "encryptionSpec": {}, - * // "endpoint": "my_endpoint", - * // "error": {}, - * // "labels": {}, - * // "latestMonitoringPipelineMetadata": {}, - * // "logTtl": "my_logTtl", - * // "loggingSamplingStrategy": {}, - * // "modelDeploymentMonitoringObjectiveConfigs": [], - * // "modelDeploymentMonitoringScheduleConfig": {}, - * // "modelMonitoringAlertConfig": {}, - * // "name": "my_name", - * // "nextScheduleTime": "my_nextScheduleTime", - * // "predictInstanceSchemaUri": "my_predictInstanceSchemaUri", - * // "samplePredictInstance": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "scheduleState": "my_scheduleState", - * // "state": "my_state", - * // "statsAnomaliesBaseDirectory": {}, - * // "updateTime": "my_updateTime" - * // } - * }, + * await aiplatform.projects.locations.notebookRuntimes.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/notebookRuntimes/my-notebookRuntime/operations/my-operation', * }); * console.log(res.data); * @@ -83021,36 +119476,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch, + get( + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch, + get( + params?: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch, + get( + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch, + get( + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch, + get( + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get, callback: BodyResponseCallback ): void; - patch( + get( callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch + | Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -83066,13 +119521,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch; + {}) as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch; + {} as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get; options = {}; } @@ -83086,7 +119541,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -83107,7 +119562,7 @@ export namespace aiplatform_v1 { } /** - * Pauses a ModelDeploymentMonitoringJob. If the job is running, the server makes a best effort to cancel the job. Will mark ModelDeploymentMonitoringJob.state to 'PAUSED'. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -83137,20 +119592,26 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.pause({ - * // Required. The resource name of the ModelDeploymentMonitoringJob to pause. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` - * name: 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, + * await aiplatform.projects.locations.notebookRuntimes.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/notebookRuntimes/my-notebookRuntime', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] + * // } * } * * main().catch(e => { @@ -83165,54 +119626,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - pause( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause, + list( + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$List, options: StreamMethodOptions ): Promise>; - pause( - params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause, + list( + params?: Params$Resource$Projects$Locations$Notebookruntimes$Operations$List, options?: MethodOptions - ): Promise>; - pause( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - pause( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - pause( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$List, + callback: BodyResponseCallback ): void; - pause(callback: BodyResponseCallback): void; - pause( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimes$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause; + {}) as Params$Resource$Projects$Locations$Notebookruntimes$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause; + {} as Params$Resource$Projects$Locations$Notebookruntimes$Operations$List; options = {}; } @@ -83225,8 +119694,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:pause').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -83237,17 +119709,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -83277,20 +119751,22 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.resume({ - * // Required. The resource name of the ModelDeploymentMonitoringJob to resume. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` - * name: 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, + * await aiplatform.projects.locations.notebookRuntimes.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/notebookRuntimes/my-notebookRuntime/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -83305,54 +119781,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - resume( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume, + wait( + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait, options: StreamMethodOptions ): Promise>; - resume( - params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume, + wait( + params?: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait, options?: MethodOptions - ): Promise>; - resume( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume, + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - resume( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - resume( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait, + callback: BodyResponseCallback ): void; - resume(callback: BodyResponseCallback): void; - resume( + wait( + callback: BodyResponseCallback + ): void; + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume; + {}) as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume; + {} as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait; options = {}; } @@ -83365,7 +119845,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:resume').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -83377,17 +119857,85 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel + extends StandardParameters { /** - * Searches Model Monitoring Statistics generated within a given time window. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Notebookruntimes$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Notebookruntimetemplates { + context: APIRequestContext; + operations: Resource$Projects$Locations$Notebookruntimetemplates$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Notebookruntimetemplates$Operations( + this.context + ); + } + + /** + * Creates a NotebookRuntimeTemplate. * @example * ```js * // Before running the sample: @@ -83417,33 +119965,48 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.searchModelDeploymentMonitoringStatsAnomalies( - * { - * // Required. ModelDeploymentMonitoring Job resource name. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` - * modelDeploymentMonitoringJob: - * 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob', + * await aiplatform.projects.locations.notebookRuntimeTemplates.create({ + * // Optional. User specified ID for the notebook runtime template. + * notebookRuntimeTemplateId: 'placeholder-value', + * // Required. The resource name of the Location to create the NotebookRuntimeTemplate. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "deployedModelId": "my_deployedModelId", - * // "endTime": "my_endTime", - * // "featureDisplayName": "my_featureDisplayName", - * // "objectives": [], - * // "pageSize": 0, - * // "pageToken": "my_pageToken", - * // "startTime": "my_startTime" - * // } - * }, + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "dataPersistentDiskSpec": {}, + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "eucConfig": {}, + * // "idleShutdownConfig": {}, + * // "isDefault": false, + * // "labels": {}, + * // "machineSpec": {}, + * // "name": "my_name", + * // "networkSpec": {}, + * // "networkTags": [], + * // "notebookRuntimeType": "my_notebookRuntimeType", + * // "reservationAffinity": {}, + * // "serviceAccount": "my_serviceAccount", + * // "shieldedVmConfig": {}, + * // "softwareConfig": {}, + * // "updateTime": "my_updateTime" + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response * // { - * // "monitoringStats": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -83459,62 +120022,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - searchModelDeploymentMonitoringStatsAnomalies( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies, + create( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Create, options: StreamMethodOptions ): Promise>; - searchModelDeploymentMonitoringStatsAnomalies( - params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies, + create( + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Create, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - searchModelDeploymentMonitoringStatsAnomalies( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - searchModelDeploymentMonitoringStatsAnomalies( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies, + create( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - searchModelDeploymentMonitoringStatsAnomalies( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Create, + callback: BodyResponseCallback ): void; - searchModelDeploymentMonitoringStatsAnomalies( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - searchModelDeploymentMonitoringStatsAnomalies( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimetemplates$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies; + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies; + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Create; options = {}; } @@ -83527,143 +120086,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + - '/v1/{+modelDeploymentMonitoringJob}:searchModelDeploymentMonitoringStatsAnomalies' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/notebookRuntimeTemplates').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['modelDeploymentMonitoringJob'], - pathParams: ['modelDeploymentMonitoringJob'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create - extends StandardParameters { - /** - * Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ModelDeploymentMonitoringJob; - } - export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete - extends StandardParameters { - /** - * Required. The resource name of the model monitoring job to delete. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get - extends StandardParameters { - /** - * Required. The resource name of the ModelDeploymentMonitoringJob. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List - extends StandardParameters { - /** - * The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` - */ - filter?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - /** - * Mask specifying which fields to read - */ - readMask?: string; - } - export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch - extends StandardParameters { - /** - * Output only. Resource name of a ModelDeploymentMonitoringJob. - */ - name?: string; - /** - * Required. The update mask is used to specify the fields to be overwritten in the ModelDeploymentMonitoringJob resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. For the objective config, the user can either provide the update mask for model_deployment_monitoring_objective_configs or any combination of its nested fields, such as: model_deployment_monitoring_objective_configs.objective_config.training_dataset. Updatable fields: * `display_name` * `model_deployment_monitoring_schedule_config` * `model_monitoring_alert_config` * `logging_sampling_strategy` * `labels` * `log_ttl` * `enable_monitoring_pipeline_logs` . and * `model_deployment_monitoring_objective_configs` . or * `model_deployment_monitoring_objective_configs.objective_config.training_dataset` * `model_deployment_monitoring_objective_configs.objective_config.training_prediction_skew_detection_config` * `model_deployment_monitoring_objective_configs.objective_config.prediction_drift_detection_config` - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ModelDeploymentMonitoringJob; - } - export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause - extends StandardParameters { - /** - * Required. The resource name of the ModelDeploymentMonitoringJob to pause. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest; - } - export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume - extends StandardParameters { - /** - * Required. The resource name of the ModelDeploymentMonitoringJob to resume. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest; - } - export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies - extends StandardParameters { - /** - * Required. ModelDeploymentMonitoring Job resource name. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` - */ - modelDeploymentMonitoringJob?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest; - } - - export class Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Deletes a NotebookRuntimeTemplate. * @example * ```js * // Before running the sample: @@ -83693,16 +120141,20 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.cancel( - * { - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob/operations/my-operation', - * }, - * ); + * await aiplatform.projects.locations.notebookRuntimeTemplates.delete({ + * // Required. The name of the NotebookRuntimeTemplate resource to be deleted. Format: `projects/{project\}/locations/{location\}/notebookRuntimeTemplates/{notebook_runtime_template\}` + * name: 'projects/my-project/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate', + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -83717,54 +120169,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel, + delete( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel, + delete( + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + delete( + callback: BodyResponseCallback + ): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete; options = {}; } @@ -83777,8 +120233,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -83789,17 +120245,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Gets a NotebookRuntimeTemplate. * @example * ```js * // Before running the sample: @@ -83828,17 +120284,35 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.delete( - * { - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob/operations/my-operation', - * }, - * ); + * const res = await aiplatform.projects.locations.notebookRuntimeTemplates.get({ + * // Required. The name of the NotebookRuntimeTemplate resource. Format: `projects/{project\}/locations/{location\}/notebookRuntimeTemplates/{notebook_runtime_template\}` + * name: 'projects/my-project/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate', + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "createTime": "my_createTime", + * // "dataPersistentDiskSpec": {}, + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "eucConfig": {}, + * // "idleShutdownConfig": {}, + * // "isDefault": false, + * // "labels": {}, + * // "machineSpec": {}, + * // "name": "my_name", + * // "networkSpec": {}, + * // "networkTags": [], + * // "notebookRuntimeType": "my_notebookRuntimeType", + * // "reservationAffinity": {}, + * // "serviceAccount": "my_serviceAccount", + * // "shieldedVmConfig": {}, + * // "softwareConfig": {}, + * // "updateTime": "my_updateTime" + * // } * } * * main().catch(e => { @@ -83853,54 +120327,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete, + get( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete, + get( + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Get, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Get, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimetemplates$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete; + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Get; options = {}; } @@ -83914,7 +120396,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -83925,17 +120407,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @example * ```js * // Before running the sample: @@ -83965,21 +120449,20 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.get( - * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob/operations/my-operation', - * }, - * ); + * await aiplatform.projects.locations.notebookRuntimeTemplates.getIamPolicy({ + * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + * 'options.requestedPolicyVersion': 'placeholder-value', + * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -83995,58 +120478,56 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get, + getIamPolicy( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get, + getIamPolicy( + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get, + ): Promise>; + getIamPolicy( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + getIamPolicy( + callback: BodyResponseCallback ): void; - get( + getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get; + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get; + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy; options = {}; } @@ -84059,29 +120540,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Lists NotebookRuntimeTemplates in a Location. * @example * ```js * // Before running the sample: @@ -84110,28 +120594,28 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.list( - * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.projects.locations.notebookRuntimeTemplates.list( + * { + * // Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntimeTemplate=notebookRuntimeTemplate123` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4` + * filter: 'placeholder-value', + * // Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. + * orderBy: 'placeholder-value', + * // Optional. The standard list page size. + * pageSize: 'placeholder-value', + * // Optional. The standard list page token. Typically obtained via ListNotebookRuntimeTemplatesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimeTemplates call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location from which to list the NotebookRuntimeTemplates. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // Optional. Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "notebookRuntimeTemplates": [] * // } * } * @@ -84148,61 +120632,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List, + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimetemplates$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List; + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List; + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$List; options = {}; } @@ -84215,7 +120699,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+parent}/notebookRuntimeTemplates').replace( /([^:]\/)\/+/g, '$1' ), @@ -84225,24 +120709,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Updates a NotebookRuntimeTemplate. * @example * ```js * // Before running the sample: @@ -84272,23 +120756,63 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.wait( - * { - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', + * await aiplatform.projects.locations.notebookRuntimeTemplates.patch({ + * // The resource name of the NotebookRuntimeTemplate. + * name: 'projects/my-project/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate', + * // Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Input format: `{paths: "${updated_filed\}"\}` Updatable fields: * `encryption_spec.kms_key_name` + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "dataPersistentDiskSpec": {}, + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "eucConfig": {}, + * // "idleShutdownConfig": {}, + * // "isDefault": false, + * // "labels": {}, + * // "machineSpec": {}, + * // "name": "my_name", + * // "networkSpec": {}, + * // "networkTags": [], + * // "notebookRuntimeType": "my_notebookRuntimeType", + * // "reservationAffinity": {}, + * // "serviceAccount": "my_serviceAccount", + * // "shieldedVmConfig": {}, + * // "softwareConfig": {}, + * // "updateTime": "my_updateTime" + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "createTime": "my_createTime", + * // "dataPersistentDiskSpec": {}, + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "eucConfig": {}, + * // "idleShutdownConfig": {}, + * // "isDefault": false, + * // "labels": {}, + * // "machineSpec": {}, * // "name": "my_name", - * // "response": {} + * // "networkSpec": {}, + * // "networkTags": [], + * // "notebookRuntimeType": "my_notebookRuntimeType", + * // "reservationAffinity": {}, + * // "serviceAccount": "my_serviceAccount", + * // "shieldedVmConfig": {}, + * // "softwareConfig": {}, + * // "updateTime": "my_updateTime" * // } * } * @@ -84304,58 +120828,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait, + patch( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait, + patch( + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch, options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait, + ): Promise< + GaxiosResponseWithHTTP2 + >; + patch( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait, + patch( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - wait( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait; + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch; options = {}; } @@ -84368,8 +120896,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -84380,88 +120908,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel - extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete - extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait - extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Models { - context: APIRequestContext; - evaluations: Resource$Projects$Locations$Models$Evaluations; - operations: Resource$Projects$Locations$Models$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.evaluations = new Resource$Projects$Locations$Models$Evaluations( - this.context - ); - this.operations = new Resource$Projects$Locations$Models$Operations( - this.context - ); - } /** - * Copies an already existing Vertex AI Model into the specified Location. The source Model must exist in the same Project. When copying custom Models, the users themselves are responsible for Model.metadata content to be region-agnostic, as well as making sure that any resources (e.g. files) it depends on remain accessible. + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @example * ```js * // Before running the sample: @@ -84490,30 +120949,27 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.copy({ - * // Required. The resource name of the Location into which to copy the Model. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * const res = + * await aiplatform.projects.locations.notebookRuntimeTemplates.setIamPolicy({ + * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "encryptionSpec": {}, - * // "modelId": "my_modelId", - * // "parentModel": "my_parentModel", - * // "sourceModel": "my_sourceModel" - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "policy": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -84529,57 +120985,56 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - copy( - params: Params$Resource$Projects$Locations$Models$Copy, + setIamPolicy( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy, options: StreamMethodOptions ): Promise>; - copy( - params?: Params$Resource$Projects$Locations$Models$Copy, + setIamPolicy( + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy, options?: MethodOptions - ): Promise>; - copy( - params: Params$Resource$Projects$Locations$Models$Copy, + ): Promise>; + setIamPolicy( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - copy( - params: Params$Resource$Projects$Locations$Models$Copy, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - copy( - params: Params$Resource$Projects$Locations$Models$Copy, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy, + callback: BodyResponseCallback ): void; - copy( - callback: BodyResponseCallback + setIamPolicy( + callback: BodyResponseCallback ): void; - copy( + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Copy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Copy; + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Models$Copy; + params = + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy; options = {}; } @@ -84592,7 +121047,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/models:copy').replace( + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), @@ -84602,22 +121057,22 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a Model. A model cannot be deleted if any Endpoint resource has a DeployedModel based on the model in its deployed_models field. + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @example * ```js * // Before running the sample: @@ -84646,19 +121101,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.delete({ - * // Required. The name of the Model resource to be deleted. Format: `projects/{project\}/locations/{location\}/models/{model\}` - * name: 'projects/my-project/locations/my-location/models/my-model', - * }); + * const res = + * await aiplatform.projects.locations.notebookRuntimeTemplates.testIamPermissions( + * { + * // The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * permissions: 'placeholder-value', + * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "permissions": [] * // } * } * @@ -84674,92 +121131,217 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Models$Delete, + testIamPermissions( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Models$Delete, + testIamPermissions( + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Models$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + testIamPermissions( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Models$Delete, + testIamPermissions( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Models$Delete, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - delete( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Delete; + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Models$Delete; - options = {}; - } + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Create + extends StandardParameters { + /** + * Optional. User specified ID for the notebook runtime template. + */ + notebookRuntimeTemplateId?: string; + /** + * Required. The resource name of the Location to create the NotebookRuntimeTemplate. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1NotebookRuntimeTemplate; + } + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete + extends StandardParameters { + /** + * Required. The name of the NotebookRuntimeTemplate resource to be deleted. Format: `projects/{project\}/locations/{location\}/notebookRuntimeTemplates/{notebook_runtime_template\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Get + extends StandardParameters { + /** + * Required. The name of the NotebookRuntimeTemplate resource. Format: `projects/{project\}/locations/{location\}/notebookRuntimeTemplates/{notebook_runtime_template\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$List + extends StandardParameters { + /** + * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntimeTemplate=notebookRuntimeTemplate123` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4` + */ + filter?: string; + /** + * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. + */ + orderBy?: string; + /** + * Optional. The standard list page size. + */ + pageSize?: number; + /** + * Optional. The standard list page token. Typically obtained via ListNotebookRuntimeTemplatesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimeTemplates call. + */ + pageToken?: string; + /** + * Required. The resource name of the Location from which to list the NotebookRuntimeTemplates. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Optional. Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch + extends StandardParameters { + /** + * The resource name of the NotebookRuntimeTemplate. + */ + name?: string; + /** + * Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Input format: `{paths: "${updated_filed\}"\}` Updatable fields: * `encryption_spec.kms_key_name` + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1NotebookRuntimeTemplate; + } + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions + extends StandardParameters { + /** + * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + */ + permissions?: string[]; + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } + export class Resource$Projects$Locations$Notebookruntimetemplates$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Deletes a Model version. Model version can only be deleted if there are no DeployedModels created from it. Deleting the only version in the Model is not allowed. Use DeleteModel for deleting the Model instead. + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -84788,20 +121370,17 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.deleteVersion({ - * // Required. The name of the model version to be deleted, with a version ID explicitly included. Example: `projects/{project\}/locations/{location\}/models/{model\}@1234` - * name: 'projects/my-project/locations/my-location/models/my-model', - * }); + * const res = + * await aiplatform.projects.locations.notebookRuntimeTemplates.operations.cancel( + * { + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -84816,57 +121395,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - deleteVersion( - params: Params$Resource$Projects$Locations$Models$Deleteversion, + cancel( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel, options: StreamMethodOptions ): Promise>; - deleteVersion( - params?: Params$Resource$Projects$Locations$Models$Deleteversion, + cancel( + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel, options?: MethodOptions - ): Promise>; - deleteVersion( - params: Params$Resource$Projects$Locations$Models$Deleteversion, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deleteVersion( - params: Params$Resource$Projects$Locations$Models$Deleteversion, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - deleteVersion( - params: Params$Resource$Projects$Locations$Models$Deleteversion, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - deleteVersion( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel, + callback: BodyResponseCallback ): void; - deleteVersion( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Deleteversion - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Deleteversion; + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Models$Deleteversion; + params = + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel; options = {}; } @@ -84879,11 +121455,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:deleteVersion').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -84894,17 +121467,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Exports a trained, exportable Model to a location specified by the user. A Model is considered to be exportable if it has at least one supported export format. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -84933,28 +121506,17 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.export({ - * // Required. The resource name of the Model to export. The resource name may contain version id or version alias to specify the version, if no version is specified, the default version will be exported. - * name: 'projects/my-project/locations/my-location/models/my-model', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "outputConfig": {} - * // } - * }, - * }); + * const res = + * await aiplatform.projects.locations.notebookRuntimeTemplates.operations.delete( + * { + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -84969,57 +121531,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - export( - params: Params$Resource$Projects$Locations$Models$Export, + delete( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete, options: StreamMethodOptions ): Promise>; - export( - params?: Params$Resource$Projects$Locations$Models$Export, + delete( + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete, options?: MethodOptions - ): Promise>; - export( - params: Params$Resource$Projects$Locations$Models$Export, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - export( - params: Params$Resource$Projects$Locations$Models$Export, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - export( - params: Params$Resource$Projects$Locations$Models$Export, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - export( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete, + callback: BodyResponseCallback ): void; - export( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Export - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Export; + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Models$Export; + params = + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete; options = {}; } @@ -85032,8 +121591,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:export').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -85044,17 +121603,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a Model. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -85083,49 +121642,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.get({ - * // Required. The name of the Model resource. Format: `projects/{project\}/locations/{location\}/models/{model\}` In order to retrieve a specific version of the model, also provide the version ID or version alias. Example: `projects/{project\}/locations/{location\}/models/{model\}@2` or `projects/{project\}/locations/{location\}/models/{model\}@golden` If no version ID or alias is specified, the "default" version will be returned. The "default" version alias is created for the first version of the model, and can be moved to other versions later on. There will be exactly one default version. - * name: 'projects/my-project/locations/my-location/models/my-model', - * }); + * const res = + * await aiplatform.projects.locations.notebookRuntimeTemplates.operations.get( + * { + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "artifactUri": "my_artifactUri", - * // "baseModelSource": {}, - * // "checkpoints": [], - * // "containerSpec": {}, - * // "createTime": "my_createTime", - * // "dataStats": {}, - * // "defaultCheckpointId": "my_defaultCheckpointId", - * // "deployedModels": [], - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "explanationSpec": {}, - * // "labels": {}, + * // "done": false, + * // "error": {}, * // "metadata": {}, - * // "metadataArtifact": "my_metadataArtifact", - * // "metadataSchemaUri": "my_metadataSchemaUri", - * // "modelSourceInfo": {}, * // "name": "my_name", - * // "originalModelInfo": {}, - * // "pipelineJob": "my_pipelineJob", - * // "predictSchemata": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "supportedDeploymentResourcesTypes": [], - * // "supportedExportFormats": [], - * // "supportedInputStorageFormats": [], - * // "supportedOutputStorageFormats": [], - * // "trainingPipeline": "my_trainingPipeline", - * // "updateTime": "my_updateTime", - * // "versionAliases": [], - * // "versionCreateTime": "my_versionCreateTime", - * // "versionDescription": "my_versionDescription", - * // "versionId": "my_versionId", - * // "versionUpdateTime": "my_versionUpdateTime" + * // "response": {} * // } * } * @@ -85142,56 +121674,57 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Models$Get, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Models$Get, + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get, options?: MethodOptions - ): Promise>; + ): Promise>; get( - params: Params$Resource$Projects$Locations$Models$Get, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Models$Get, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Models$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Get; + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Models$Get; + params = + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get; options = {}; } @@ -85216,19 +121749,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -85257,19 +121788,28 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.getIamPolicy({ - * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - * 'options.requestedPolicyVersion': 'placeholder-value', - * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: 'projects/my-project/locations/my-location/models/my-model', - * }); + * const res = + * await aiplatform.projects.locations.notebookRuntimeTemplates.operations.list( + * { + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -85285,55 +121825,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Models$Getiampolicy, + list( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Models$Getiampolicy, + list( + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List, options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Projects$Locations$Models$Getiampolicy, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Models$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Models$Getiampolicy, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - getIamPolicy( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Models$Getiampolicy; + params = + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List; options = {}; } @@ -85346,32 +121893,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists Models in a Location. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -85400,26 +121949,24 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.list({ - * // An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `model` supports = and !=. `model` represents the Model ID, i.e. the last segment of the Model's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. * `base_model_name` only supports = Some examples: * `model=1234` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `baseModelName="text-bison"` - * filter: 'placeholder-value', - * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. - * orderBy: 'placeholder-value', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. Typically obtained via ListModelsResponse.next_page_token of the previous ModelService.ListModels call. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list the Models from. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.notebookRuntimeTemplates.operations.wait( + * { + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "models": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -85435,61 +121982,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Models$List, + wait( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Models$List, + wait( + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Models$List, + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Models$List, + wait( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Models$List, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - list( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$List; + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Models$List; + params = + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait; options = {}; } @@ -85502,34 +122046,92 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/models').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel + extends StandardParameters { /** - * Lists checkpoints of the specified model version. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -85558,21 +122160,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.listCheckpoints({ - * // Required. The name of the model version to list checkpoints for. `projects/{project\}/locations/{location\}/models/{model\}@{version\}` Example: `projects/{project\}/locations/{location\}/models/{model\}@2` or `projects/{project\}/locations/{location\}/models/{model\}@golden` If no version ID or alias is specified, the latest version will be used. - * name: 'projects/my-project/locations/my-location/models/my-model', - * // Optional. The standard list page size. - * pageSize: 'placeholder-value', - * // Optional. The standard list page token. Typically obtained via next_page_token of the previous ListModelVersionCheckpoints call. - * pageToken: 'placeholder-value', + * const res = await aiplatform.projects.locations.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "checkpoints": [], - * // "nextPageToken": "my_nextPageToken" - * // } + * // {} * } * * main().catch(e => { @@ -85587,62 +122182,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listCheckpoints( - params: Params$Resource$Projects$Locations$Models$Listcheckpoints, + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, options: StreamMethodOptions ): Promise>; - listCheckpoints( - params?: Params$Resource$Projects$Locations$Models$Listcheckpoints, + cancel( + params?: Params$Resource$Projects$Locations$Operations$Cancel, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - listCheckpoints( - params: Params$Resource$Projects$Locations$Models$Listcheckpoints, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listCheckpoints( - params: Params$Resource$Projects$Locations$Models$Listcheckpoints, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - listCheckpoints( - params: Params$Resource$Projects$Locations$Models$Listcheckpoints, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listCheckpoints( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + callback: BodyResponseCallback ): void; - listCheckpoints( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Listcheckpoints - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Listcheckpoints; + {}) as Params$Resource$Projects$Locations$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Models$Listcheckpoints; + params = {} as Params$Resource$Projects$Locations$Operations$Cancel; options = {}; } @@ -85655,11 +122241,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:listCheckpoints').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -85670,19 +122253,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists versions of the specified model. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -85711,27 +122292,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.listVersions({ - * // An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. Some examples: * `labels.myKey="myValue"` - * filter: 'placeholder-value', - * // Required. The name of the model to list versions for. - * name: 'projects/my-project/locations/my-location/models/my-model', - * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `update_time asc, create_time desc`. - * orderBy: 'placeholder-value', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. Typically obtained via next_page_token of the previous ListModelVersions call. - * pageToken: 'placeholder-value', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', + * const res = await aiplatform.projects.locations.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "models": [], - * // "nextPageToken": "my_nextPageToken" - * // } + * // {} * } * * main().catch(e => { @@ -85746,61 +122314,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listVersions( - params: Params$Resource$Projects$Locations$Models$Listversions, + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, options: StreamMethodOptions ): Promise>; - listVersions( - params?: Params$Resource$Projects$Locations$Models$Listversions, + delete( + params?: Params$Resource$Projects$Locations$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - listVersions( - params: Params$Resource$Projects$Locations$Models$Listversions, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listVersions( - params: Params$Resource$Projects$Locations$Models$Listversions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - listVersions( - params: Params$Resource$Projects$Locations$Models$Listversions, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listVersions( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + callback: BodyResponseCallback ): void; - listVersions( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Listversions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Listversions; + {}) as Params$Resource$Projects$Locations$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Models$Listversions; + params = {} as Params$Resource$Projects$Locations$Operations$Delete; options = {}; } @@ -85813,11 +122373,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:listVersions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -85828,19 +122385,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Merges a set of aliases for a Model version. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -85869,57 +122424,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.mergeVersionAliases({ - * // Required. The name of the model version to merge aliases, with a version ID explicitly included. Example: `projects/{project\}/locations/{location\}/models/{model\}@1234` - * name: 'projects/my-project/locations/my-location/models/my-model', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "versionAliases": [] - * // } - * }, + * const res = await aiplatform.projects.locations.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/operations/my-operation', * }); * console.log(res.data); * * // Example response * // { - * // "artifactUri": "my_artifactUri", - * // "baseModelSource": {}, - * // "checkpoints": [], - * // "containerSpec": {}, - * // "createTime": "my_createTime", - * // "dataStats": {}, - * // "defaultCheckpointId": "my_defaultCheckpointId", - * // "deployedModels": [], - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "explanationSpec": {}, - * // "labels": {}, + * // "done": false, + * // "error": {}, * // "metadata": {}, - * // "metadataArtifact": "my_metadataArtifact", - * // "metadataSchemaUri": "my_metadataSchemaUri", - * // "modelSourceInfo": {}, * // "name": "my_name", - * // "originalModelInfo": {}, - * // "pipelineJob": "my_pipelineJob", - * // "predictSchemata": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "supportedDeploymentResourcesTypes": [], - * // "supportedExportFormats": [], - * // "supportedInputStorageFormats": [], - * // "supportedOutputStorageFormats": [], - * // "trainingPipeline": "my_trainingPipeline", - * // "updateTime": "my_updateTime", - * // "versionAliases": [], - * // "versionCreateTime": "my_versionCreateTime", - * // "versionDescription": "my_versionDescription", - * // "versionId": "my_versionId", - * // "versionUpdateTime": "my_versionUpdateTime" + * // "response": {} * // } * } * @@ -85935,58 +122452,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - mergeVersionAliases( - params: Params$Resource$Projects$Locations$Models$Mergeversionaliases, + get( + params: Params$Resource$Projects$Locations$Operations$Get, options: StreamMethodOptions ): Promise>; - mergeVersionAliases( - params?: Params$Resource$Projects$Locations$Models$Mergeversionaliases, + get( + params?: Params$Resource$Projects$Locations$Operations$Get, options?: MethodOptions - ): Promise>; - mergeVersionAliases( - params: Params$Resource$Projects$Locations$Models$Mergeversionaliases, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - mergeVersionAliases( - params: Params$Resource$Projects$Locations$Models$Mergeversionaliases, + get( + params: Params$Resource$Projects$Locations$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - mergeVersionAliases( - params: Params$Resource$Projects$Locations$Models$Mergeversionaliases, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Operations$Get, + callback: BodyResponseCallback ): void; - mergeVersionAliases( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - mergeVersionAliases( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Mergeversionaliases - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Mergeversionaliases; + {}) as Params$Resource$Projects$Locations$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Models$Mergeversionaliases; + params = {} as Params$Resource$Projects$Locations$Operations$Get; options = {}; } @@ -85999,11 +122515,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:mergeVersionAliases').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -86014,19 +122527,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a Model. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -86055,93 +122566,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.patch({ - * // The resource name of the Model. - * name: 'projects/my-project/locations/my-location/models/my-model', - * // Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "artifactUri": "my_artifactUri", - * // "baseModelSource": {}, - * // "checkpoints": [], - * // "containerSpec": {}, - * // "createTime": "my_createTime", - * // "dataStats": {}, - * // "defaultCheckpointId": "my_defaultCheckpointId", - * // "deployedModels": [], - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "explanationSpec": {}, - * // "labels": {}, - * // "metadata": {}, - * // "metadataArtifact": "my_metadataArtifact", - * // "metadataSchemaUri": "my_metadataSchemaUri", - * // "modelSourceInfo": {}, - * // "name": "my_name", - * // "originalModelInfo": {}, - * // "pipelineJob": "my_pipelineJob", - * // "predictSchemata": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "supportedDeploymentResourcesTypes": [], - * // "supportedExportFormats": [], - * // "supportedInputStorageFormats": [], - * // "supportedOutputStorageFormats": [], - * // "trainingPipeline": "my_trainingPipeline", - * // "updateTime": "my_updateTime", - * // "versionAliases": [], - * // "versionCreateTime": "my_versionCreateTime", - * // "versionDescription": "my_versionDescription", - * // "versionId": "my_versionId", - * // "versionUpdateTime": "my_versionUpdateTime" - * // } - * }, + * const res = await aiplatform.projects.locations.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "artifactUri": "my_artifactUri", - * // "baseModelSource": {}, - * // "checkpoints": [], - * // "containerSpec": {}, - * // "createTime": "my_createTime", - * // "dataStats": {}, - * // "defaultCheckpointId": "my_defaultCheckpointId", - * // "deployedModels": [], - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "explanationSpec": {}, - * // "labels": {}, - * // "metadata": {}, - * // "metadataArtifact": "my_metadataArtifact", - * // "metadataSchemaUri": "my_metadataSchemaUri", - * // "modelSourceInfo": {}, - * // "name": "my_name", - * // "originalModelInfo": {}, - * // "pipelineJob": "my_pipelineJob", - * // "predictSchemata": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "supportedDeploymentResourcesTypes": [], - * // "supportedExportFormats": [], - * // "supportedInputStorageFormats": [], - * // "supportedOutputStorageFormats": [], - * // "trainingPipeline": "my_trainingPipeline", - * // "updateTime": "my_updateTime", - * // "versionAliases": [], - * // "versionCreateTime": "my_versionCreateTime", - * // "versionDescription": "my_versionDescription", - * // "versionId": "my_versionId", - * // "versionUpdateTime": "my_versionUpdateTime" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -86157,57 +122600,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Models$Patch, + list( + params: Params$Resource$Projects$Locations$Operations$List, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Models$Patch, + list( + params?: Params$Resource$Projects$Locations$Operations$List, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Models$Patch, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Models$Patch, + list( + params: Params$Resource$Projects$Locations$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Models$Patch, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Operations$List, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - patch( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Patch; + {}) as Params$Resource$Projects$Locations$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Models$Patch; + params = {} as Params$Resource$Projects$Locations$Operations$List; options = {}; } @@ -86220,8 +122667,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -86232,19 +122682,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -86273,25 +122723,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.setIamPolicy({ - * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: 'projects/my-project/locations/my-location/models/my-model', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "policy": {} - * // } - * }, + * const res = await aiplatform.projects.locations.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -86307,55 +122753,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Models$Setiampolicy, + wait( + params: Params$Resource$Projects$Locations$Operations$Wait, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Models$Setiampolicy, + wait( + params?: Params$Resource$Projects$Locations$Operations$Wait, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Projects$Locations$Models$Setiampolicy, + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Models$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Models$Setiampolicy, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Operations$Wait, + callback: BodyResponseCallback ): void; - setIamPolicy( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - setIamPolicy( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Models$Setiampolicy; + params = {} as Params$Resource$Projects$Locations$Operations$Wait; options = {}; } @@ -86368,32 +122816,97 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Operations$Cancel + extends StandardParameters { /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Persistentresources { + context: APIRequestContext; + operations: Resource$Projects$Locations$Persistentresources$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Persistentresources$Operations( + this.context + ); + } + + /** + * Creates a PersistentResource. * @example * ```js * // Before running the sample: @@ -86422,17 +122935,45 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.testIamPermissions({ - * // The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). - * permissions: 'placeholder-value', - * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: 'projects/my-project/locations/my-location/models/my-model', + * const res = await aiplatform.projects.locations.persistentResources.create({ + * // Required. The resource name of the Location to create the PersistentResource in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // Required. The ID to use for the PersistentResource, which become the final component of the PersistentResource's resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$/`. + * persistentResourceId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "error": {}, + * // "labels": {}, + * // "name": "my_name", + * // "network": "my_network", + * // "pscInterfaceConfig": {}, + * // "reservedIpRanges": [], + * // "resourcePools": [], + * // "resourceRuntime": {}, + * // "resourceRuntimeSpec": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "permissions": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -86448,62 +122989,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Models$Testiampermissions, + create( + params: Params$Resource$Projects$Locations$Persistentresources$Create, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Models$Testiampermissions, + create( + params?: Params$Resource$Projects$Locations$Persistentresources$Create, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - testIamPermissions( - params: Params$Resource$Projects$Locations$Models$Testiampermissions, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Persistentresources$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Models$Testiampermissions, + create( + params: Params$Resource$Projects$Locations$Persistentresources$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Models$Testiampermissions, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Persistentresources$Create, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - testIamPermissions( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Persistentresources$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Persistentresources$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Models$Testiampermissions; + {} as Params$Resource$Projects$Locations$Persistentresources$Create; options = {}; } @@ -86516,7 +123053,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + url: (rootUrl + '/v1/{+parent}/persistentResources').replace( /([^:]\/)\/+/g, '$1' ), @@ -86526,24 +123063,22 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Incrementally update the dataset used for an examples model. + * Deletes a PersistentResource. * @example * ```js * // Before running the sample: @@ -86572,19 +123107,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.models.updateExplanationDataset({ - * // Required. The resource name of the Model to update. Format: `projects/{project\}/locations/{location\}/models/{model\}` - * model: 'projects/my-project/locations/my-location/models/my-model', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "examples": {} - * // } - * }, - * }); + * const res = await aiplatform.projects.locations.persistentResources.delete({ + * // Required. The name of the PersistentResource to be deleted. Format: `projects/{project\}/locations/{location\}/persistentResources/{persistent_resource\}` + * name: 'projects/my-project/locations/my-location/persistentResources/my-persistentResource', + * }); * console.log(res.data); * * // Example response @@ -86609,36 +123135,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - updateExplanationDataset( - params: Params$Resource$Projects$Locations$Models$Updateexplanationdataset, + delete( + params: Params$Resource$Projects$Locations$Persistentresources$Delete, options: StreamMethodOptions ): Promise>; - updateExplanationDataset( - params?: Params$Resource$Projects$Locations$Models$Updateexplanationdataset, + delete( + params?: Params$Resource$Projects$Locations$Persistentresources$Delete, options?: MethodOptions ): Promise>; - updateExplanationDataset( - params: Params$Resource$Projects$Locations$Models$Updateexplanationdataset, + delete( + params: Params$Resource$Projects$Locations$Persistentresources$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateExplanationDataset( - params: Params$Resource$Projects$Locations$Models$Updateexplanationdataset, + delete( + params: Params$Resource$Projects$Locations$Persistentresources$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateExplanationDataset( - params: Params$Resource$Projects$Locations$Models$Updateexplanationdataset, + delete( + params: Params$Resource$Projects$Locations$Persistentresources$Delete, callback: BodyResponseCallback ): void; - updateExplanationDataset( + delete( callback: BodyResponseCallback ): void; - updateExplanationDataset( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Updateexplanationdataset + | Params$Resource$Projects$Locations$Persistentresources$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -86654,13 +123180,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Updateexplanationdataset; + {}) as Params$Resource$Projects$Locations$Persistentresources$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Models$Updateexplanationdataset; + {} as Params$Resource$Projects$Locations$Persistentresources$Delete; options = {}; } @@ -86673,18 +123199,15 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+model}:updateExplanationDataset').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['model'], - pathParams: ['model'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -86698,7 +123221,7 @@ export namespace aiplatform_v1 { } /** - * Uploads a Model artifact into Vertex AI. + * Gets a PersistentResource. * @example * ```js * // Before running the sample: @@ -86727,30 +123250,31 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.upload({ - * // Required. The resource name of the Location into which to upload the Model. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "model": {}, - * // "modelId": "my_modelId", - * // "parentModel": "my_parentModel", - * // "serviceAccount": "my_serviceAccount" - * // } - * }, + * const res = await aiplatform.projects.locations.persistentResources.get({ + * // Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number\}/locations/{location_id\}/persistentResources/{persistent_resource_id\}` + * name: 'projects/my-project/locations/my-location/persistentResources/my-persistentResource', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, * // "error": {}, - * // "metadata": {}, + * // "labels": {}, * // "name": "my_name", - * // "response": {} + * // "network": "my_network", + * // "pscInterfaceConfig": {}, + * // "reservedIpRanges": [], + * // "resourcePools": [], + * // "resourceRuntime": {}, + * // "resourceRuntimeSpec": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "updateTime": "my_updateTime" * // } * } * @@ -86766,57 +123290,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - upload( - params: Params$Resource$Projects$Locations$Models$Upload, + get( + params: Params$Resource$Projects$Locations$Persistentresources$Get, options: StreamMethodOptions ): Promise>; - upload( - params?: Params$Resource$Projects$Locations$Models$Upload, + get( + params?: Params$Resource$Projects$Locations$Persistentresources$Get, options?: MethodOptions - ): Promise>; - upload( - params: Params$Resource$Projects$Locations$Models$Upload, + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Persistentresources$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - upload( - params: Params$Resource$Projects$Locations$Models$Upload, + get( + params: Params$Resource$Projects$Locations$Persistentresources$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - upload( - params: Params$Resource$Projects$Locations$Models$Upload, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Persistentresources$Get, + callback: BodyResponseCallback ): void; - upload( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - upload( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Upload - | BodyResponseCallback + | Params$Resource$Projects$Locations$Persistentresources$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Upload; + {}) as Params$Resource$Projects$Locations$Persistentresources$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Models$Upload; + params = + {} as Params$Resource$Projects$Locations$Persistentresources$Get; options = {}; } @@ -86829,249 +123358,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/models:upload').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Models$Copy - extends StandardParameters { - /** - * Required. The resource name of the Location into which to copy the Model. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1CopyModelRequest; - } - export interface Params$Resource$Projects$Locations$Models$Delete - extends StandardParameters { - /** - * Required. The name of the Model resource to be deleted. Format: `projects/{project\}/locations/{location\}/models/{model\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Models$Deleteversion - extends StandardParameters { - /** - * Required. The name of the model version to be deleted, with a version ID explicitly included. Example: `projects/{project\}/locations/{location\}/models/{model\}@1234` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Models$Export - extends StandardParameters { - /** - * Required. The resource name of the Model to export. The resource name may contain version id or version alias to specify the version, if no version is specified, the default version will be exported. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ExportModelRequest; - } - export interface Params$Resource$Projects$Locations$Models$Get - extends StandardParameters { - /** - * Required. The name of the Model resource. Format: `projects/{project\}/locations/{location\}/models/{model\}` In order to retrieve a specific version of the model, also provide the version ID or version alias. Example: `projects/{project\}/locations/{location\}/models/{model\}@2` or `projects/{project\}/locations/{location\}/models/{model\}@golden` If no version ID or alias is specified, the "default" version will be returned. The "default" version alias is created for the first version of the model, and can be moved to other versions later on. There will be exactly one default version. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Models$Getiampolicy - extends StandardParameters { - /** - * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Models$List - extends StandardParameters { - /** - * An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `model` supports = and !=. `model` represents the Model ID, i.e. the last segment of the Model's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. * `base_model_name` only supports = Some examples: * `model=1234` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `baseModelName="text-bison"` - */ - filter?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. - */ - orderBy?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. Typically obtained via ListModelsResponse.next_page_token of the previous ModelService.ListModels call. - */ - pageToken?: string; - /** - * Required. The resource name of the Location to list the Models from. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; - } - export interface Params$Resource$Projects$Locations$Models$Listcheckpoints - extends StandardParameters { - /** - * Required. The name of the model version to list checkpoints for. `projects/{project\}/locations/{location\}/models/{model\}@{version\}` Example: `projects/{project\}/locations/{location\}/models/{model\}@2` or `projects/{project\}/locations/{location\}/models/{model\}@golden` If no version ID or alias is specified, the latest version will be used. - */ - name?: string; - /** - * Optional. The standard list page size. - */ - pageSize?: number; - /** - * Optional. The standard list page token. Typically obtained via next_page_token of the previous ListModelVersionCheckpoints call. - */ - pageToken?: string; - } - export interface Params$Resource$Projects$Locations$Models$Listversions - extends StandardParameters { - /** - * An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. Some examples: * `labels.myKey="myValue"` - */ - filter?: string; - /** - * Required. The name of the model to list versions for. - */ - name?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `update_time asc, create_time desc`. - */ - orderBy?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. Typically obtained via next_page_token of the previous ListModelVersions call. - */ - pageToken?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; - } - export interface Params$Resource$Projects$Locations$Models$Mergeversionaliases - extends StandardParameters { - /** - * Required. The name of the model version to merge aliases, with a version ID explicitly included. Example: `projects/{project\}/locations/{location\}/models/{model\}@1234` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1MergeVersionAliasesRequest; - } - export interface Params$Resource$Projects$Locations$Models$Patch - extends StandardParameters { - /** - * The resource name of the Model. - */ - name?: string; - /** - * Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Model; - } - export interface Params$Resource$Projects$Locations$Models$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Models$Testiampermissions - extends StandardParameters { - /** - * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). - */ - permissions?: string[]; - /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Models$Updateexplanationdataset - extends StandardParameters { - /** - * Required. The resource name of the Model to update. Format: `projects/{project\}/locations/{location\}/models/{model\}` - */ - model?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1UpdateExplanationDatasetRequest; - } - export interface Params$Resource$Projects$Locations$Models$Upload - extends StandardParameters { - /** - * Required. The resource name of the Location into which to upload the Model. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1UploadModelRequest; - } - - export class Resource$Projects$Locations$Models$Evaluations { - context: APIRequestContext; - operations: Resource$Projects$Locations$Models$Evaluations$Operations; - slices: Resource$Projects$Locations$Models$Evaluations$Slices; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Models$Evaluations$Operations( - this.context + return createAPIRequest( + parameters ); - this.slices = new Resource$Projects$Locations$Models$Evaluations$Slices( - this.context - ); + } } /** - * Gets a ModelEvaluation. + * Lists PersistentResources in a Location. * @example * ```js * // Before running the sample: @@ -87100,25 +123411,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.evaluations.get({ - * // Required. The name of the ModelEvaluation resource. Format: `projects/{project\}/locations/{location\}/models/{model\}/evaluations/{evaluation\}` - * name: 'projects/my-project/locations/my-location/models/my-model/evaluations/my-evaluation', + * const res = await aiplatform.projects.locations.persistentResources.list({ + * // Optional. The standard list page size. + * pageSize: 'placeholder-value', + * // Optional. The standard list page token. Typically obtained via ListPersistentResourcesResponse.next_page_token of the previous PersistentResourceService.ListPersistentResource call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location to list the PersistentResources from. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', * }); * console.log(res.data); * * // Example response * // { - * // "annotationSchemaUri": "my_annotationSchemaUri", - * // "createTime": "my_createTime", - * // "dataItemSchemaUri": "my_dataItemSchemaUri", - * // "displayName": "my_displayName", - * // "explanationSpecs": [], - * // "metadata": {}, - * // "metrics": {}, - * // "metricsSchemaUri": "my_metricsSchemaUri", - * // "modelExplanation": {}, - * // "name": "my_name", - * // "sliceDimensions": [] + * // "nextPageToken": "my_nextPageToken", + * // "persistentResources": [] * // } * } * @@ -87134,62 +123440,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Models$Evaluations$Get, + list( + params: Params$Resource$Projects$Locations$Persistentresources$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Models$Evaluations$Get, + list( + params?: Params$Resource$Projects$Locations$Persistentresources$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Models$Evaluations$Get, + list( + params: Params$Resource$Projects$Locations$Persistentresources$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Models$Evaluations$Get, + list( + params: Params$Resource$Projects$Locations$Persistentresources$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Models$Evaluations$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Persistentresources$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Evaluations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Persistentresources$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Evaluations$Get; + {}) as Params$Resource$Projects$Locations$Persistentresources$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Models$Evaluations$Get; + {} as Params$Resource$Projects$Locations$Persistentresources$List; options = {}; } @@ -87202,31 +123508,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/persistentResources').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Imports an externally generated ModelEvaluation. + * Updates a PersistentResource. * @example * ```js * // Before running the sample: @@ -87255,15 +123564,33 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.evaluations.import({ - * // Required. The name of the parent model resource. Format: `projects/{project\}/locations/{location\}/models/{model\}` - * parent: 'projects/my-project/locations/my-location/models/my-model', + * const res = await aiplatform.projects.locations.persistentResources.patch({ + * // Immutable. Resource name of a PersistentResource. + * name: 'projects/my-project/locations/my-location/persistentResources/my-persistentResource', + * // Required. Specify the fields to be overwritten in the PersistentResource by the update method. + * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "modelEvaluation": {} + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "error": {}, + * // "labels": {}, + * // "name": "my_name", + * // "network": "my_network", + * // "pscInterfaceConfig": {}, + * // "reservedIpRanges": [], + * // "resourcePools": [], + * // "resourceRuntime": {}, + * // "resourceRuntimeSpec": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "updateTime": "my_updateTime" * // } * }, * }); @@ -87271,17 +123598,11 @@ export namespace aiplatform_v1 { * * // Example response * // { - * // "annotationSchemaUri": "my_annotationSchemaUri", - * // "createTime": "my_createTime", - * // "dataItemSchemaUri": "my_dataItemSchemaUri", - * // "displayName": "my_displayName", - * // "explanationSpecs": [], + * // "done": false, + * // "error": {}, * // "metadata": {}, - * // "metrics": {}, - * // "metricsSchemaUri": "my_metricsSchemaUri", - * // "modelExplanation": {}, * // "name": "my_name", - * // "sliceDimensions": [] + * // "response": {} * // } * } * @@ -87297,62 +123618,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Models$Evaluations$Import, + patch( + params: Params$Resource$Projects$Locations$Persistentresources$Patch, options: StreamMethodOptions ): Promise>; - import( - params?: Params$Resource$Projects$Locations$Models$Evaluations$Import, + patch( + params?: Params$Resource$Projects$Locations$Persistentresources$Patch, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - import( - params: Params$Resource$Projects$Locations$Models$Evaluations$Import, + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Persistentresources$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Models$Evaluations$Import, + patch( + params: Params$Resource$Projects$Locations$Persistentresources$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Models$Evaluations$Import, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Persistentresources$Patch, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - import( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Evaluations$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Persistentresources$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Evaluations$Import; + {}) as Params$Resource$Projects$Locations$Persistentresources$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Models$Evaluations$Import; + {} as Params$Resource$Projects$Locations$Persistentresources$Patch; options = {}; } @@ -87365,34 +123682,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/evaluations:import').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists ModelEvaluations in a Model. + * Reboots a PersistentResource. * @example * ```js * // Before running the sample: @@ -87421,24 +123733,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.evaluations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. Typically obtained via ListModelEvaluationsResponse.next_page_token of the previous ModelService.ListModelEvaluations call. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Model to list the ModelEvaluations from. Format: `projects/{project\}/locations/{location\}/models/{model\}` - * parent: 'projects/my-project/locations/my-location/models/my-model', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', + * const res = await aiplatform.projects.locations.persistentResources.reboot({ + * // Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number\}/locations/{location_id\}/persistentResources/{persistent_resource_id\}` + * name: 'projects/my-project/locations/my-location/persistentResources/my-persistentResource', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, * }); * console.log(res.data); * * // Example response * // { - * // "modelEvaluations": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -87454,62 +123767,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Models$Evaluations$List, + reboot( + params: Params$Resource$Projects$Locations$Persistentresources$Reboot, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Models$Evaluations$List, + reboot( + params?: Params$Resource$Projects$Locations$Persistentresources$Reboot, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Models$Evaluations$List, + ): Promise>; + reboot( + params: Params$Resource$Projects$Locations$Persistentresources$Reboot, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Models$Evaluations$List, + reboot( + params: Params$Resource$Projects$Locations$Persistentresources$Reboot, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Models$Evaluations$List, - callback: BodyResponseCallback + reboot( + params: Params$Resource$Projects$Locations$Persistentresources$Reboot, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + reboot( + callback: BodyResponseCallback ): void; - list( + reboot( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Evaluations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Persistentresources$Reboot + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Evaluations$List; + {}) as Params$Resource$Projects$Locations$Persistentresources$Reboot; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Models$Evaluations$List; + {} as Params$Resource$Projects$Locations$Persistentresources$Reboot; options = {}; } @@ -87522,77 +123831,103 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/evaluations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:reboot').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Models$Evaluations$Get + export interface Params$Resource$Projects$Locations$Persistentresources$Create extends StandardParameters { /** - * Required. The name of the ModelEvaluation resource. Format: `projects/{project\}/locations/{location\}/models/{model\}/evaluations/{evaluation\}` + * Required. The resource name of the Location to create the PersistentResource in. Format: `projects/{project\}/locations/{location\}` */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Models$Evaluations$Import - extends StandardParameters { + parent?: string; /** - * Required. The name of the parent model resource. Format: `projects/{project\}/locations/{location\}/models/{model\}` + * Required. The ID to use for the PersistentResource, which become the final component of the PersistentResource's resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$/`. */ - parent?: string; + persistentResourceId?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1ImportModelEvaluationRequest; + requestBody?: Schema$GoogleCloudAiplatformV1PersistentResource; } - export interface Params$Resource$Projects$Locations$Models$Evaluations$List + export interface Params$Resource$Projects$Locations$Persistentresources$Delete extends StandardParameters { /** - * The standard list filter. + * Required. The name of the PersistentResource to be deleted. Format: `projects/{project\}/locations/{location\}/persistentResources/{persistent_resource\}` */ - filter?: string; + name?: string; + } + export interface Params$Resource$Projects$Locations$Persistentresources$Get + extends StandardParameters { /** - * The standard list page size. + * Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number\}/locations/{location_id\}/persistentResources/{persistent_resource_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Persistentresources$List + extends StandardParameters { + /** + * Optional. The standard list page size. */ pageSize?: number; /** - * The standard list page token. Typically obtained via ListModelEvaluationsResponse.next_page_token of the previous ModelService.ListModelEvaluations call. + * Optional. The standard list page token. Typically obtained via ListPersistentResourcesResponse.next_page_token of the previous PersistentResourceService.ListPersistentResource call. */ pageToken?: string; /** - * Required. The resource name of the Model to list the ModelEvaluations from. Format: `projects/{project\}/locations/{location\}/models/{model\}` + * Required. The resource name of the Location to list the PersistentResources from. Format: `projects/{project\}/locations/{location\}` */ parent?: string; + } + export interface Params$Resource$Projects$Locations$Persistentresources$Patch + extends StandardParameters { /** - * Mask specifying which fields to read. + * Immutable. Resource name of a PersistentResource. */ - readMask?: string; + name?: string; + /** + * Required. Specify the fields to be overwritten in the PersistentResource by the update method. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1PersistentResource; + } + export interface Params$Resource$Projects$Locations$Persistentresources$Reboot + extends StandardParameters { + /** + * Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number\}/locations/{location_id\}/persistentResources/{persistent_resource_id\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1RebootPersistentResourceRequest; } - export class Resource$Projects$Locations$Models$Evaluations$Operations { + export class Resource$Projects$Locations$Persistentresources$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -87629,9 +123964,9 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.models.evaluations.operations.cancel({ + * await aiplatform.projects.locations.persistentResources.operations.cancel({ * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/models/my-model/evaluations/my-evaluation/operations/my-operation', + * name: 'projects/my-project/locations/my-location/persistentResources/my-persistentResource/operations/my-operation', * }); * console.log(res.data); * @@ -87652,31 +123987,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel + | Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -87692,13 +124027,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel; options = {}; } @@ -87763,9 +124098,9 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.models.evaluations.operations.delete({ + * await aiplatform.projects.locations.persistentResources.operations.delete({ * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/models/my-model/evaluations/my-evaluation/operations/my-operation', + * name: 'projects/my-project/locations/my-location/persistentResources/my-persistentResource/operations/my-operation', * }); * console.log(res.data); * @@ -87786,31 +124121,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete, + params?: Params$Resource$Projects$Locations$Persistentresources$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete + | Params$Resource$Projects$Locations$Persistentresources$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -87826,13 +124161,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Persistentresources$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete; + {} as Params$Resource$Projects$Locations$Persistentresources$Operations$Delete; options = {}; } @@ -87897,9 +124232,9 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.models.evaluations.operations.get({ + * await aiplatform.projects.locations.persistentResources.operations.get({ * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/models/my-model/evaluations/my-evaluation/operations/my-operation', + * name: 'projects/my-project/locations/my-location/persistentResources/my-persistentResource/operations/my-operation', * }); * console.log(res.data); * @@ -87926,27 +124261,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get, + params?: Params$Resource$Projects$Locations$Persistentresources$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -87954,7 +124289,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get + | Params$Resource$Projects$Locations$Persistentresources$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -87970,13 +124305,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get; + {}) as Params$Resource$Projects$Locations$Persistentresources$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get; + {} as Params$Resource$Projects$Locations$Persistentresources$Operations$Get; options = {}; } @@ -88041,11 +124376,11 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.models.evaluations.operations.list({ + * await aiplatform.projects.locations.persistentResources.operations.list({ * // The standard list filter. * filter: 'placeholder-value', * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/models/my-model/evaluations/my-evaluation', + * name: 'projects/my-project/locations/my-location/persistentResources/my-persistentResource', * // The standard list page size. * pageSize: 'placeholder-value', * // The standard list page token. @@ -88076,29 +124411,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$List, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Models$Evaluations$Operations$List, + params?: Params$Resource$Projects$Locations$Persistentresources$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$List, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$List, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$List, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$List, callback: BodyResponseCallback ): void; list( @@ -88106,7 +124441,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Evaluations$Operations$List + | Params$Resource$Projects$Locations$Persistentresources$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -88124,13 +124459,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Evaluations$Operations$List; + {}) as Params$Resource$Projects$Locations$Persistentresources$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Models$Evaluations$Operations$List; + {} as Params$Resource$Projects$Locations$Persistentresources$Operations$List; options = {}; } @@ -88200,9 +124535,9 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.models.evaluations.operations.wait({ + * await aiplatform.projects.locations.persistentResources.operations.wait({ * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/models/my-model/evaluations/my-evaluation/operations/my-operation', + * name: 'projects/my-project/locations/my-location/persistentResources/my-persistentResource/operations/my-operation', * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. * timeout: 'placeholder-value', * }); @@ -88231,27 +124566,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait, + params?: Params$Resource$Projects$Locations$Persistentresources$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -88259,7 +124594,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait + | Params$Resource$Projects$Locations$Persistentresources$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -88275,13 +124610,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Persistentresources$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait; + {} as Params$Resource$Projects$Locations$Persistentresources$Operations$Wait; options = {}; } @@ -88316,28 +124651,28 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel + export interface Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete + export interface Params$Resource$Projects$Locations$Persistentresources$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get + export interface Params$Resource$Projects$Locations$Persistentresources$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Models$Evaluations$Operations$List + export interface Params$Resource$Projects$Locations$Persistentresources$Operations$List extends StandardParameters { /** * The standard list filter. @@ -88360,7 +124695,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait + export interface Params$Resource$Projects$Locations$Persistentresources$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -88371,173 +124706,19 @@ export namespace aiplatform_v1 { */ timeout?: string; } - - export class Resource$Projects$Locations$Models$Evaluations$Slices { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Imports a list of externally generated EvaluatedAnnotations. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const aiplatform = google.aiplatform('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await aiplatform.projects.locations.models.evaluations.slices.batchImport({ - * // Required. The name of the parent ModelEvaluationSlice resource. Format: `projects/{project\}/locations/{location\}/models/{model\}/evaluations/{evaluation\}/slices/{slice\}` - * parent: - * 'projects/my-project/locations/my-location/models/my-model/evaluations/my-evaluation/slices/my-slice', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "evaluatedAnnotations": [] - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "importedEvaluatedAnnotationsCount": 0 - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - batchImport( - params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport, - options: StreamMethodOptions - ): Promise>; - batchImport( - params?: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - batchImport( - params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - batchImport( - params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - batchImport( - params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport, - callback: BodyResponseCallback - ): void; - batchImport( - callback: BodyResponseCallback - ): void; - batchImport( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}:batchImport').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } + + export class Resource$Projects$Locations$Pipelinejobs { + context: APIRequestContext; + operations: Resource$Projects$Locations$Pipelinejobs$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Projects$Locations$Pipelinejobs$Operations( + this.context + ); } /** - * Gets a ModelEvaluationSlice. + * Batch cancel PipelineJobs. Firstly the server will check if all the jobs are in non-terminal states, and skip the jobs that are already terminated. If the operation failed, none of the pipeline jobs are cancelled. The server will poll the states of all the pipeline jobs periodically to check the cancellation status. This operation will return an LRO. * @example * ```js * // Before running the sample: @@ -88566,22 +124747,27 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.evaluations.slices.get( - * { - * // Required. The name of the ModelEvaluationSlice resource. Format: `projects/{project\}/locations/{location\}/models/{model\}/evaluations/{evaluation\}/slices/{slice\}` - * name: 'projects/my-project/locations/my-location/models/my-model/evaluations/my-evaluation/slices/my-slice', + * const res = await aiplatform.projects.locations.pipelineJobs.batchCancel({ + * // Required. The name of the PipelineJobs' parent resource. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "names": [] + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "metrics": {}, - * // "metricsSchemaUri": "my_metricsSchemaUri", - * // "modelExplanation": {}, + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "slice": {} + * // "response": {} * // } * } * @@ -88597,62 +124783,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get, + batchCancel( + params: Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get, + batchCancel( + params?: Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get, + ): Promise>; + batchCancel( + params: Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get, + batchCancel( + params: Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get, - callback: BodyResponseCallback + batchCancel( + params: Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + batchCancel( + callback: BodyResponseCallback ): void; - get( + batchCancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get; + {}) as Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get; + {} as Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel; options = {}; } @@ -88665,31 +124847,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+parent}/pipelineJobs:batchCancel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists ModelEvaluationSlices in a ModelEvaluation. + * Batch deletes PipelineJobs The Operation is atomic. If it fails, none of the PipelineJobs are deleted. If it succeeds, all of the PipelineJobs are deleted. * @example * ```js * // Before running the sample: @@ -88718,26 +124901,27 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.models.evaluations.slices.list({ - * // The standard list filter. * `slice.dimension` - for =. - * filter: 'placeholder-value', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. Typically obtained via ListModelEvaluationSlicesResponse.next_page_token of the previous ModelService.ListModelEvaluationSlices call. - * pageToken: 'placeholder-value', - * // Required. The resource name of the ModelEvaluation to list the ModelEvaluationSlices from. Format: `projects/{project\}/locations/{location\}/models/{model\}/evaluations/{evaluation\}` - * parent: - * 'projects/my-project/locations/my-location/models/my-model/evaluations/my-evaluation', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', - * }); + * const res = await aiplatform.projects.locations.pipelineJobs.batchDelete({ + * // Required. The name of the PipelineJobs' parent resource. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "names": [] + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "modelEvaluationSlices": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -88753,62 +124937,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$List, + batchDelete( + params: Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Models$Evaluations$Slices$List, + batchDelete( + params?: Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$List, + ): Promise>; + batchDelete( + params: Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$List, + batchDelete( + params: Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$List, - callback: BodyResponseCallback + batchDelete( + params: Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + batchDelete( + callback: BodyResponseCallback ): void; - list( + batchDelete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Evaluations$Slices$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Evaluations$Slices$List; + {}) as Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Models$Evaluations$Slices$List; + {} as Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete; options = {}; } @@ -88821,11 +125001,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/slices').replace( + url: (rootUrl + '/v1/{+parent}/pipelineJobs:batchDelete').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -88836,69 +125016,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport - extends StandardParameters { - /** - * Required. The name of the parent ModelEvaluationSlice resource. Format: `projects/{project\}/locations/{location\}/models/{model\}/evaluations/{evaluation\}/slices/{slice\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest; - } - export interface Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get - extends StandardParameters { - /** - * Required. The name of the ModelEvaluationSlice resource. Format: `projects/{project\}/locations/{location\}/models/{model\}/evaluations/{evaluation\}/slices/{slice\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Models$Evaluations$Slices$List - extends StandardParameters { - /** - * The standard list filter. * `slice.dimension` - for =. - */ - filter?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. Typically obtained via ListModelEvaluationSlicesResponse.next_page_token of the previous ModelService.ListModelEvaluationSlices call. - */ - pageToken?: string; - /** - * Required. The resource name of the ModelEvaluation to list the ModelEvaluationSlices from. Format: `projects/{project\}/locations/{location\}/models/{model\}/evaluations/{evaluation\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; - } - - export class Resource$Projects$Locations$Models$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetPipelineJob or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it becomes a pipeline with a PipelineJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and PipelineJob.state is set to `CANCELLED`. * @example * ```js * // Before running the sample: @@ -88927,9 +125055,15 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/models/my-model/operations/my-operation', + * const res = await aiplatform.projects.locations.pipelineJobs.cancel({ + * // Required. The name of the PipelineJob to cancel. Format: `projects/{project\}/locations/{location\}/pipelineJobs/{pipeline_job\}` + * name: 'projects/my-project/locations/my-location/pipelineJobs/my-pipelineJob', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, * }); * console.log(res.data); * @@ -88950,31 +125084,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Models$Operations$Cancel, + params: Params$Resource$Projects$Locations$Pipelinejobs$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Models$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Pipelinejobs$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Models$Operations$Cancel, + params: Params$Resource$Projects$Locations$Pipelinejobs$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Models$Operations$Cancel, + params: Params$Resource$Projects$Locations$Pipelinejobs$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Models$Operations$Cancel, + params: Params$Resource$Projects$Locations$Pipelinejobs$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Operations$Cancel + | Params$Resource$Projects$Locations$Pipelinejobs$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -88990,13 +125124,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Pipelinejobs$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Models$Operations$Cancel; + params = {} as Params$Resource$Projects$Locations$Pipelinejobs$Cancel; options = {}; } @@ -89031,7 +125164,7 @@ export namespace aiplatform_v1 { } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Creates a PipelineJob. A PipelineJob will run immediately when created. * @example * ```js * // Before running the sample: @@ -89060,14 +125193,66 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/models/my-model/operations/my-operation', + * const res = await aiplatform.projects.locations.pipelineJobs.create({ + * // Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/a-z-/`. + * pipelineJobId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "jobDetail": {}, + * // "labels": {}, + * // "name": "my_name", + * // "network": "my_network", + * // "pipelineSpec": {}, + * // "preflightValidations": false, + * // "pscInterfaceConfig": {}, + * // "reservedIpRanges": [], + * // "runtimeConfig": {}, + * // "scheduleName": "my_scheduleName", + * // "serviceAccount": "my_serviceAccount", + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "templateMetadata": {}, + * // "templateUri": "my_templateUri", + * // "updateTime": "my_updateTime" + * // } + * }, * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "jobDetail": {}, + * // "labels": {}, + * // "name": "my_name", + * // "network": "my_network", + * // "pipelineSpec": {}, + * // "preflightValidations": false, + * // "pscInterfaceConfig": {}, + * // "reservedIpRanges": [], + * // "runtimeConfig": {}, + * // "scheduleName": "my_scheduleName", + * // "serviceAccount": "my_serviceAccount", + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "templateMetadata": {}, + * // "templateUri": "my_templateUri", + * // "updateTime": "my_updateTime" + * // } * } * * main().catch(e => { @@ -89082,54 +125267,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Models$Operations$Delete, + create( + params: Params$Resource$Projects$Locations$Pipelinejobs$Create, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Models$Operations$Delete, + create( + params?: Params$Resource$Projects$Locations$Pipelinejobs$Create, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Models$Operations$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Pipelinejobs$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Models$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Pipelinejobs$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Models$Operations$Delete, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Pipelinejobs$Create, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Pipelinejobs$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Pipelinejobs$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Models$Operations$Delete; + params = {} as Params$Resource$Projects$Locations$Pipelinejobs$Create; options = {}; } @@ -89142,29 +125334,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/pipelineJobs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Deletes a PipelineJob. * @example * ```js * // Before running the sample: @@ -89193,9 +125390,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/models/my-model/operations/my-operation', + * const res = await aiplatform.projects.locations.pipelineJobs.delete({ + * // Required. The name of the PipelineJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/pipelineJobs/{pipeline_job\}` + * name: 'projects/my-project/locations/my-location/pipelineJobs/my-pipelineJob', * }); * console.log(res.data); * @@ -89221,36 +125418,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Models$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Pipelinejobs$Delete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Models$Operations$Get, + delete( + params?: Params$Resource$Projects$Locations$Pipelinejobs$Delete, options?: MethodOptions ): Promise>; - get( - params: Params$Resource$Projects$Locations$Models$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Pipelinejobs$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Models$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Pipelinejobs$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Models$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Pipelinejobs$Delete, callback: BodyResponseCallback ): void; - get( + delete( callback: BodyResponseCallback ): void; - get( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Operations$Get + | Params$Resource$Projects$Locations$Pipelinejobs$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -89266,12 +125463,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Operations$Get; + {}) as Params$Resource$Projects$Locations$Pipelinejobs$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Models$Operations$Get; + params = {} as Params$Resource$Projects$Locations$Pipelinejobs$Delete; options = {}; } @@ -89285,7 +125482,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -89306,7 +125503,7 @@ export namespace aiplatform_v1 { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Gets a PipelineJob. * @example * ```js * // Before running the sample: @@ -89335,25 +125532,35 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/models/my-model', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', + * const res = await aiplatform.projects.locations.pipelineJobs.get({ + * // Required. The name of the PipelineJob resource. Format: `projects/{project\}/locations/{location\}/pipelineJobs/{pipeline_job\}` + * name: 'projects/my-project/locations/my-location/pipelineJobs/my-pipelineJob', * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "jobDetail": {}, + * // "labels": {}, + * // "name": "my_name", + * // "network": "my_network", + * // "pipelineSpec": {}, + * // "preflightValidations": false, + * // "pscInterfaceConfig": {}, + * // "reservedIpRanges": [], + * // "runtimeConfig": {}, + * // "scheduleName": "my_scheduleName", + * // "serviceAccount": "my_serviceAccount", + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "templateMetadata": {}, + * // "templateUri": "my_templateUri", + * // "updateTime": "my_updateTime" * // } * } * @@ -89369,62 +125576,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Models$Operations$List, + get( + params: Params$Resource$Projects$Locations$Pipelinejobs$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Models$Operations$List, + get( + params?: Params$Resource$Projects$Locations$Pipelinejobs$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Models$Operations$List, + get( + params: Params$Resource$Projects$Locations$Pipelinejobs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Models$Operations$List, + get( + params: Params$Resource$Projects$Locations$Pipelinejobs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Models$Operations$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Pipelinejobs$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Pipelinejobs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Operations$List; + {}) as Params$Resource$Projects$Locations$Pipelinejobs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Models$Operations$List; + params = {} as Params$Resource$Projects$Locations$Pipelinejobs$Get; options = {}; } @@ -89437,10 +125643,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -89452,19 +125655,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Lists PipelineJobs in a Location. * @example * ```js * // Before running the sample: @@ -89493,21 +125696,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/models/my-model/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', + * const res = await aiplatform.projects.locations.pipelineJobs.list({ + * // Lists the PipelineJobs that match the filter expression. The following fields are supported: * `pipeline_name`: Supports `=` and `!=` comparisons. * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `pipeline_job_user_id`: Supports `=`, `!=` comparisons, and `:` wildcard. for example, can check if pipeline's display_name contains *step* by doing display_name:\"*step*\" * `state`: Supports `=` and `!=` comparisons. * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. * `template_uri`: Supports `=`, `!=` comparisons, and `:` wildcard. * `template_metadata.version`: Supports `=`, `!=` comparisons, and `:` wildcard. Filter expressions can be combined together using logical operators (`AND` & `OR`). For example: `pipeline_name="test" AND create_time\>"2020-05-18T13:30:00Z"`. The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `create_time\>"2021-05-18T00:00:00Z" OR update_time\>"2020-05-18T00:00:00Z"` PipelineJobs created or updated after 2020-05-18 00:00:00 UTC. * `labels.env = "prod"` PipelineJobs with label "env" set to "prod". + * filter: 'placeholder-value', + * // A comma-separated list of fields to order by. The default sort order is in ascending order. Use "desc" after a field name for descending. You can have multiple order_by fields provided e.g. "create_time desc, end_time", "end_time, start_time, update_time" For example, using "create_time desc, end_time" will order results by create time in descending order, and if there are multiple jobs having the same create time, order them by the end time in ascending order. if order_by is not specified, it will order by default order is create time in descending order. Supported fields: * `create_time` * `update_time` * `end_time` * `start_time` + * orderBy: 'placeholder-value', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. Typically obtained via ListPipelineJobsResponse.next_page_token of the previous PipelineService.ListPipelineJobs call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location to list the PipelineJobs from. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "pipelineJobs": [] * // } * } * @@ -89523,58 +125731,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Models$Operations$Wait, + list( + params: Params$Resource$Projects$Locations$Pipelinejobs$List, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Models$Operations$Wait, + list( + params?: Params$Resource$Projects$Locations$Pipelinejobs$List, options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Models$Operations$Wait, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Pipelinejobs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Models$Operations$Wait, + list( + params: Params$Resource$Projects$Locations$Pipelinejobs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Models$Operations$Wait, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Pipelinejobs$List, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - wait( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Pipelinejobs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Pipelinejobs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Models$Operations$Wait; + params = {} as Params$Resource$Projects$Locations$Pipelinejobs$List; options = {}; } @@ -89587,95 +125798,135 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+parent}/pipelineJobs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Models$Operations$Cancel + export interface Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel extends StandardParameters { /** - * The name of the operation resource to be cancelled. + * Required. The name of the PipelineJobs' parent resource. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest; + } + export interface Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete + extends StandardParameters { + /** + * Required. The name of the PipelineJobs' parent resource. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest; + } + export interface Params$Resource$Projects$Locations$Pipelinejobs$Cancel + extends StandardParameters { + /** + * Required. The name of the PipelineJob to cancel. Format: `projects/{project\}/locations/{location\}/pipelineJobs/{pipeline_job\}` */ name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CancelPipelineJobRequest; } - export interface Params$Resource$Projects$Locations$Models$Operations$Delete + export interface Params$Resource$Projects$Locations$Pipelinejobs$Create extends StandardParameters { /** - * The name of the operation resource to be deleted. + * Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/a-z-/`. + */ + pipelineJobId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1PipelineJob; + } + export interface Params$Resource$Projects$Locations$Pipelinejobs$Delete + extends StandardParameters { + /** + * Required. The name of the PipelineJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/pipelineJobs/{pipeline_job\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Models$Operations$Get + export interface Params$Resource$Projects$Locations$Pipelinejobs$Get extends StandardParameters { /** - * The name of the operation resource. + * Required. The name of the PipelineJob resource. Format: `projects/{project\}/locations/{location\}/pipelineJobs/{pipeline_job\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Models$Operations$List + export interface Params$Resource$Projects$Locations$Pipelinejobs$List extends StandardParameters { /** - * The standard list filter. + * Lists the PipelineJobs that match the filter expression. The following fields are supported: * `pipeline_name`: Supports `=` and `!=` comparisons. * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `pipeline_job_user_id`: Supports `=`, `!=` comparisons, and `:` wildcard. for example, can check if pipeline's display_name contains *step* by doing display_name:\"*step*\" * `state`: Supports `=` and `!=` comparisons. * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. * `template_uri`: Supports `=`, `!=` comparisons, and `:` wildcard. * `template_metadata.version`: Supports `=`, `!=` comparisons, and `:` wildcard. Filter expressions can be combined together using logical operators (`AND` & `OR`). For example: `pipeline_name="test" AND create_time\>"2020-05-18T13:30:00Z"`. The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `create_time\>"2021-05-18T00:00:00Z" OR update_time\>"2020-05-18T00:00:00Z"` PipelineJobs created or updated after 2020-05-18 00:00:00 UTC. * `labels.env = "prod"` PipelineJobs with label "env" set to "prod". */ filter?: string; /** - * The name of the operation's parent resource. + * A comma-separated list of fields to order by. The default sort order is in ascending order. Use "desc" after a field name for descending. You can have multiple order_by fields provided e.g. "create_time desc, end_time", "end_time, start_time, update_time" For example, using "create_time desc, end_time" will order results by create time in descending order, and if there are multiple jobs having the same create time, order them by the end time in ascending order. if order_by is not specified, it will order by default order is create time in descending order. Supported fields: * `create_time` * `update_time` * `end_time` * `start_time` */ - name?: string; + orderBy?: string; /** * The standard list page size. */ pageSize?: number; /** - * The standard list page token. + * The standard list page token. Typically obtained via ListPipelineJobsResponse.next_page_token of the previous PipelineService.ListPipelineJobs call. */ pageToken?: string; /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Locations$Models$Operations$Wait - extends StandardParameters { - /** - * The name of the operation resource to wait on. + * Required. The resource name of the Location to list the PipelineJobs from. Format: `projects/{project\}/locations/{location\}` */ - name?: string; + parent?: string; /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * Mask specifying which fields to read. */ - timeout?: string; + readMask?: string; } - export class Resource$Projects$Locations$Nasjobs { + export class Resource$Projects$Locations$Pipelinejobs$Operations { context: APIRequestContext; - nasTrialDetails: Resource$Projects$Locations$Nasjobs$Nastrialdetails; constructor(context: APIRequestContext) { this.context = context; - this.nasTrialDetails = - new Resource$Projects$Locations$Nasjobs$Nastrialdetails(this.context); } /** - * Cancels a NasJob. Starts asynchronous cancellation on the NasJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetNasJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the NasJob is not deleted; instead it becomes a job with a NasJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and NasJob.state is set to `CANCELLED`. + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -89704,16 +125955,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.nasJobs.cancel({ - * // Required. The name of the NasJob to cancel. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` - * name: 'projects/my-project/locations/my-location/nasJobs/my-nasJob', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }); + * const res = + * await aiplatform.projects.locations.pipelineJobs.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/pipelineJobs/my-pipelineJob/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -89733,31 +125979,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Nasjobs$Cancel, + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Nasjobs$Cancel, + params?: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Nasjobs$Cancel, + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Nasjobs$Cancel, + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Nasjobs$Cancel, + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Nasjobs$Cancel + | Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -89773,12 +126019,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Nasjobs$Cancel; + {}) as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Nasjobs$Cancel; + params = + {} as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel; options = {}; } @@ -89813,7 +126060,7 @@ export namespace aiplatform_v1 { } /** - * Creates a NasJob + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -89842,52 +126089,15 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.nasJobs.create({ - * // Required. The resource name of the Location to create the NasJob in. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "enableRestrictedImageTraining": false, - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", - * // "error": {}, - * // "labels": {}, - * // "name": "my_name", - * // "nasJobOutput": {}, - * // "nasJobSpec": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * const res = + * await aiplatform.projects.locations.pipelineJobs.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/pipelineJobs/my-pipelineJob/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "enableRestrictedImageTraining": false, - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", - * // "error": {}, - * // "labels": {}, - * // "name": "my_name", - * // "nasJobOutput": {}, - * // "nasJobSpec": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "updateTime": "my_updateTime" - * // } + * // {} * } * * main().catch(e => { @@ -89902,57 +126112,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Nasjobs$Create, + delete( + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Nasjobs$Create, + delete( + params?: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Nasjobs$Create, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Nasjobs$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Nasjobs$Create, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete, + callback: BodyResponseCallback ): void; - create( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Nasjobs$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Nasjobs$Create; + {}) as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Nasjobs$Create; + params = + {} as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete; options = {}; } @@ -89965,34 +126172,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/nasJobs').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes a NasJob. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -90021,9 +126223,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.nasJobs.delete({ - * // Required. The name of the NasJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` - * name: 'projects/my-project/locations/my-location/nasJobs/my-nasJob', + * const res = await aiplatform.projects.locations.pipelineJobs.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/pipelineJobs/my-pipelineJob/operations/my-operation', * }); * console.log(res.data); * @@ -90049,36 +126251,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Nasjobs$Delete, + get( + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Nasjobs$Delete, + get( + params?: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Nasjobs$Delete, + get( + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Nasjobs$Delete, + get( + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Nasjobs$Delete, + get( + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get, callback: BodyResponseCallback ): void; - delete( + get( callback: BodyResponseCallback ): void; - delete( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Nasjobs$Delete + | Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -90094,12 +126296,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Nasjobs$Delete; + {}) as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Nasjobs$Delete; + params = + {} as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get; options = {}; } @@ -90113,7 +126316,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -90134,7 +126337,7 @@ export namespace aiplatform_v1 { } /** - * Gets a NasJob + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -90155,10 +126358,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -90166,29 +126366,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.nasJobs.get({ - * // Required. The name of the NasJob resource. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` - * name: 'projects/my-project/locations/my-location/nasJobs/my-nasJob', + * const res = await aiplatform.projects.locations.pipelineJobs.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/pipelineJobs/my-pipelineJob', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "enableRestrictedImageTraining": false, - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", - * // "error": {}, - * // "labels": {}, - * // "name": "my_name", - * // "nasJobOutput": {}, - * // "nasJobSpec": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "updateTime": "my_updateTime" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -90204,57 +126400,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Nasjobs$Get, + list( + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Nasjobs$Get, + list( + params?: Params$Resource$Projects$Locations$Pipelinejobs$Operations$List, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Nasjobs$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Nasjobs$Get, + list( + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Nasjobs$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Nasjobs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Pipelinejobs$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Nasjobs$Get; + {}) as Params$Resource$Projects$Locations$Pipelinejobs$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Nasjobs$Get; + params = + {} as Params$Resource$Projects$Locations$Pipelinejobs$Operations$List; options = {}; } @@ -90267,7 +126468,10 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -90279,19 +126483,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists NasJobs in a Location. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -90320,24 +126524,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.nasJobs.list({ - * // The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` - * filter: 'placeholder-value', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. Typically obtained via ListNasJobsResponse.next_page_token of the previous JobService.ListNasJobs call. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list the NasJobs from. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', + * const res = await aiplatform.projects.locations.pipelineJobs.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/pipelineJobs/my-pipelineJob/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "nasJobs": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -90353,61 +126554,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Nasjobs$List, + wait( + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Nasjobs$List, + wait( + params?: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Nasjobs$List, + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Nasjobs$List, + wait( + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Nasjobs$List, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - list( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Nasjobs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Nasjobs$List; + {}) as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Nasjobs$List; + params = + {} as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait; options = {}; } @@ -90420,103 +126618,103 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/nasJobs').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Nasjobs$Cancel + export interface Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel extends StandardParameters { /** - * Required. The name of the NasJob to cancel. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` + * The name of the operation resource to be cancelled. */ name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1CancelNasJobRequest; - } - export interface Params$Resource$Projects$Locations$Nasjobs$Create - extends StandardParameters { - /** - * Required. The resource name of the Location to create the NasJob in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1NasJob; } - export interface Params$Resource$Projects$Locations$Nasjobs$Delete + export interface Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete extends StandardParameters { /** - * Required. The name of the NasJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Nasjobs$Get + export interface Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get extends StandardParameters { /** - * Required. The name of the NasJob resource. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Nasjobs$List + export interface Params$Resource$Projects$Locations$Pipelinejobs$Operations$List extends StandardParameters { /** - * The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` + * The standard list filter. */ filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; /** * The standard list page size. */ pageSize?: number; /** - * The standard list page token. Typically obtained via ListNasJobsResponse.next_page_token of the previous JobService.ListNasJobs call. + * The standard list page token. */ pageToken?: string; /** - * Required. The resource name of the Location to list the NasJobs from. Format: `projects/{project\}/locations/{location\}` + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - parent?: string; + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait + extends StandardParameters { /** - * Mask specifying which fields to read. + * The name of the operation resource to wait on. */ - readMask?: string; + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; } - export class Resource$Projects$Locations$Nasjobs$Nastrialdetails { + export class Resource$Projects$Locations$Publishers { + context: APIRequestContext; + models: Resource$Projects$Locations$Publishers$Models; + constructor(context: APIRequestContext) { + this.context = context; + this.models = new Resource$Projects$Locations$Publishers$Models( + this.context + ); + } + } + + export class Resource$Projects$Locations$Publishers$Models { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Gets a NasTrialDetail. + * Return a list of tokens based on the input text. * @example * ```js * // Before running the sample: @@ -90545,18 +126743,27 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.nasJobs.nasTrialDetails.get({ - * // Required. The name of the NasTrialDetail resource. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}/nasTrialDetails/{nas_trial_detail\}` - * name: 'projects/my-project/locations/my-location/nasJobs/my-nasJob/nasTrialDetails/my-nasTrialDetail', - * }); + * const res = + * await aiplatform.projects.locations.publishers.models.computeTokens({ + * // Required. The name of the Endpoint requested to get lists of tokens and token ids. + * endpoint: + * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "contents": [], + * // "instances": [], + * // "model": "my_model" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "name": "my_name", - * // "parameters": "my_parameters", - * // "searchTrial": {}, - * // "trainTrial": {} + * // "tokensInfo": [] * // } * } * @@ -90572,62 +126779,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get, + computeTokens( + params: Params$Resource$Projects$Locations$Publishers$Models$Computetokens, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get, + computeTokens( + params?: Params$Resource$Projects$Locations$Publishers$Models$Computetokens, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get, + computeTokens( + params: Params$Resource$Projects$Locations$Publishers$Models$Computetokens, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get, + computeTokens( + params: Params$Resource$Projects$Locations$Publishers$Models$Computetokens, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get, - callback: BodyResponseCallback + computeTokens( + params: Params$Resource$Projects$Locations$Publishers$Models$Computetokens, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + computeTokens( + callback: BodyResponseCallback ): void; - get( + computeTokens( paramsOrCallback?: - | Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Publishers$Models$Computetokens + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get; + {}) as Params$Resource$Projects$Locations$Publishers$Models$Computetokens; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get; + {} as Params$Resource$Projects$Locations$Publishers$Models$Computetokens; options = {}; } @@ -90640,31 +126847,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+endpoint}:computeTokens').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * List top NasTrialDetails of a NasJob. + * Perform a token counting. * @example * ```js * // Before running the sample: @@ -90693,20 +126903,33 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.nasJobs.nasTrialDetails.list({ - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. Typically obtained via ListNasTrialDetailsResponse.next_page_token of the previous JobService.ListNasTrialDetails call. - * pageToken: 'placeholder-value', - * // Required. The name of the NasJob resource. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` - * parent: 'projects/my-project/locations/my-location/nasJobs/my-nasJob', - * }); + * const res = await aiplatform.projects.locations.publishers.models.countTokens( + * { + * // Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: + * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "contents": [], + * // "generationConfig": {}, + * // "instances": [], + * // "model": "my_model", + * // "systemInstruction": {}, + * // "tools": [] + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "nasTrialDetails": [], - * // "nextPageToken": "my_nextPageToken" + * // "promptTokensDetails": [], + * // "totalBillableCharacters": 0, + * // "totalTokens": 0 * // } * } * @@ -90722,62 +126945,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List, + countTokens( + params: Params$Resource$Projects$Locations$Publishers$Models$Counttokens, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List, + countTokens( + params?: Params$Resource$Projects$Locations$Publishers$Models$Counttokens, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List, + countTokens( + params: Params$Resource$Projects$Locations$Publishers$Models$Counttokens, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List, + countTokens( + params: Params$Resource$Projects$Locations$Publishers$Models$Counttokens, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List, - callback: BodyResponseCallback + countTokens( + params: Params$Resource$Projects$Locations$Publishers$Models$Counttokens, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + countTokens( + callback: BodyResponseCallback ): void; - list( + countTokens( paramsOrCallback?: - | Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Publishers$Models$Counttokens + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List; + {}) as Params$Resource$Projects$Locations$Publishers$Models$Counttokens; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List; + {} as Params$Resource$Projects$Locations$Publishers$Models$Counttokens; options = {}; } @@ -90790,69 +127013,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/nasTrialDetails').replace( + url: (rootUrl + '/v1/{+endpoint}:countTokens').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get - extends StandardParameters { - /** - * Required. The name of the NasTrialDetail resource. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}/nasTrialDetails/{nas_trial_detail\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List - extends StandardParameters { - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. Typically obtained via ListNasTrialDetailsResponse.next_page_token of the previous JobService.ListNasTrialDetails call. - */ - pageToken?: string; - /** - * Required. The name of the NasJob resource. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` - */ - parent?: string; - } - - export class Resource$Projects$Locations$Notebookexecutionjobs { - context: APIRequestContext; - operations: Resource$Projects$Locations$Notebookexecutionjobs$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Notebookexecutionjobs$Operations( - this.context - ); - } /** - * Creates a NotebookExecutionJob. + * Embed content with multimodal inputs. * @example * ```js * // Before running the sample: @@ -90873,7 +127061,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -90881,48 +127072,31 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.notebookExecutionJobs.create({ - * // Optional. User specified ID for the NotebookExecutionJob. - * notebookExecutionJobId: 'placeholder-value', - * // Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * const res = + * await aiplatform.projects.locations.publishers.models.embedContent({ + * // Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/publishers/x/models/x` + * model: + * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "customEnvironmentSpec": {}, - * // "dataformRepositorySource": {}, - * // "directNotebookSource": {}, - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "executionTimeout": "my_executionTimeout", - * // "executionUser": "my_executionUser", - * // "gcsNotebookSource": {}, - * // "gcsOutputUri": "my_gcsOutputUri", - * // "jobState": "my_jobState", - * // "kernelName": "my_kernelName", - * // "labels": {}, - * // "name": "my_name", - * // "notebookRuntimeTemplateResourceName": "my_notebookRuntimeTemplateResourceName", - * // "scheduleResourceName": "my_scheduleResourceName", - * // "serviceAccount": "my_serviceAccount", - * // "status": {}, - * // "updateTime": "my_updateTime", - * // "workbenchRuntime": {} - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "autoTruncate": false, + * // "content": {}, + * // "outputDimensionality": 0, + * // "taskType": "my_taskType", + * // "title": "my_title" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "embedding": {}, + * // "truncated": false, + * // "usageMetadata": {} * // } * } * @@ -90938,58 +127112,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Create, + embedContent( + params: Params$Resource$Projects$Locations$Publishers$Models$Embedcontent, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Create, + embedContent( + params?: Params$Resource$Projects$Locations$Publishers$Models$Embedcontent, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Create, + ): Promise< + GaxiosResponseWithHTTP2 + >; + embedContent( + params: Params$Resource$Projects$Locations$Publishers$Models$Embedcontent, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Create, + embedContent( + params: Params$Resource$Projects$Locations$Publishers$Models$Embedcontent, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Create, - callback: BodyResponseCallback + embedContent( + params: Params$Resource$Projects$Locations$Publishers$Models$Embedcontent, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + embedContent( + callback: BodyResponseCallback ): void; - create( + embedContent( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookexecutionjobs$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Publishers$Models$Embedcontent + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Create; + {}) as Params$Resource$Projects$Locations$Publishers$Models$Embedcontent; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Create; + {} as Params$Resource$Projects$Locations$Publishers$Models$Embedcontent; options = {}; } @@ -91002,7 +127180,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/notebookExecutionJobs').replace( + url: (rootUrl + '/v1/{+model}:embedContent').replace( /([^:]\/)\/+/g, '$1' ), @@ -91012,22 +127190,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['model'], + pathParams: ['model'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a NotebookExecutionJob. + * Fetch an asynchronous online prediction operation. * @example * ```js * // Before running the sample: @@ -91048,7 +127228,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -91056,10 +127239,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.notebookExecutionJobs.delete({ - * // Required. The name of the NotebookExecutionJob resource to be deleted. - * name: 'projects/my-project/locations/my-location/notebookExecutionJobs/my-notebookExecutionJob', - * }); + * const res = + * await aiplatform.projects.locations.publishers.models.fetchPredictOperation( + * { + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` + * endpoint: + * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "operationName": "my_operationName" + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response @@ -91084,36 +127279,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete, + fetchPredictOperation( + params: Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete, + fetchPredictOperation( + params?: Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete, + fetchPredictOperation( + params: Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete, + fetchPredictOperation( + params: Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete, + fetchPredictOperation( + params: Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation, callback: BodyResponseCallback ): void; - delete( + fetchPredictOperation( callback: BodyResponseCallback ): void; - delete( + fetchPredictOperation( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete + | Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -91129,13 +127324,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete; + {}) as Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete; + {} as Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation; options = {}; } @@ -91148,15 +127343,18 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+endpoint}:fetchPredictOperation').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { @@ -91170,7 +127368,7 @@ export namespace aiplatform_v1 { } /** - * Gets a NotebookExecutionJob. + * Generate content with multimodal inputs. * @example * ```js * // Before running the sample: @@ -91191,7 +127389,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -91199,36 +127400,38 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.notebookExecutionJobs.get({ - * // Required. The name of the NotebookExecutionJob resource. - * name: 'projects/my-project/locations/my-location/notebookExecutionJobs/my-notebookExecutionJob', - * // Optional. The NotebookExecutionJob view. Defaults to BASIC. - * view: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.publishers.models.generateContent({ + * // Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * model: + * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "cachedContent": "my_cachedContent", + * // "contents": [], + * // "generationConfig": {}, + * // "labels": {}, + * // "modelArmorConfig": {}, + * // "safetySettings": [], + * // "systemInstruction": {}, + * // "toolConfig": {}, + * // "tools": [] + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { + * // "candidates": [], * // "createTime": "my_createTime", - * // "customEnvironmentSpec": {}, - * // "dataformRepositorySource": {}, - * // "directNotebookSource": {}, - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "executionTimeout": "my_executionTimeout", - * // "executionUser": "my_executionUser", - * // "gcsNotebookSource": {}, - * // "gcsOutputUri": "my_gcsOutputUri", - * // "jobState": "my_jobState", - * // "kernelName": "my_kernelName", - * // "labels": {}, - * // "name": "my_name", - * // "notebookRuntimeTemplateResourceName": "my_notebookRuntimeTemplateResourceName", - * // "scheduleResourceName": "my_scheduleResourceName", - * // "serviceAccount": "my_serviceAccount", - * // "status": {}, - * // "updateTime": "my_updateTime", - * // "workbenchRuntime": {} + * // "modelVersion": "my_modelVersion", + * // "promptFeedback": {}, + * // "responseId": "my_responseId", + * // "usageMetadata": {} * // } * } * @@ -91244,62 +127447,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Get, + generateContent( + params: Params$Resource$Projects$Locations$Publishers$Models$Generatecontent, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Get, + generateContent( + params?: Params$Resource$Projects$Locations$Publishers$Models$Generatecontent, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Get, + generateContent( + params: Params$Resource$Projects$Locations$Publishers$Models$Generatecontent, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Get, + generateContent( + params: Params$Resource$Projects$Locations$Publishers$Models$Generatecontent, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Get, - callback: BodyResponseCallback + generateContent( + params: Params$Resource$Projects$Locations$Publishers$Models$Generatecontent, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + generateContent( + callback: BodyResponseCallback ): void; - get( + generateContent( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookexecutionjobs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Publishers$Models$Generatecontent + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Get; + {}) as Params$Resource$Projects$Locations$Publishers$Models$Generatecontent; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Get; + {} as Params$Resource$Projects$Locations$Publishers$Models$Generatecontent; options = {}; } @@ -91312,31 +127515,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+model}:generateContent').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['model'], + pathParams: ['model'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists NotebookExecutionJobs in a Location. + * Perform an online prediction. * @example * ```js * // Before running the sample: @@ -91357,7 +127563,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -91365,26 +127574,31 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.notebookExecutionJobs.list({ - * // Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookExecutionJob` supports = and !=. `notebookExecutionJob` represents the NotebookExecutionJob ID. * `displayName` supports = and != and regex. * `schedule` supports = and != and regex. Some examples: * `notebookExecutionJob="123"` * `notebookExecutionJob="my-execution-job"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` - * filter: 'placeholder-value', - * // Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. - * orderBy: 'placeholder-value', - * // Optional. The standard list page size. - * pageSize: 'placeholder-value', - * // Optional. The standard list page token. Typically obtained via ListNotebookExecutionJobsResponse.next_page_token of the previous NotebookService.ListNotebookExecutionJobs call. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location from which to list the NotebookExecutionJobs. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * // Optional. The NotebookExecutionJob view. Defaults to BASIC. - * view: 'placeholder-value', + * const res = await aiplatform.projects.locations.publishers.models.predict({ + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: + * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "instances": [], + * // "labels": {}, + * // "parameters": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "notebookExecutionJobs": [] + * // "deployedModelId": "my_deployedModelId", + * // "metadata": {}, + * // "model": "my_model", + * // "modelDisplayName": "my_modelDisplayName", + * // "modelVersionId": "my_modelVersionId", + * // "predictions": [] * // } * } * @@ -91400,62 +127614,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$List, + predict( + params: Params$Resource$Projects$Locations$Publishers$Models$Predict, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$List, + predict( + params?: Params$Resource$Projects$Locations$Publishers$Models$Predict, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$List, + predict( + params: Params$Resource$Projects$Locations$Publishers$Models$Predict, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$List, + predict( + params: Params$Resource$Projects$Locations$Publishers$Models$Predict, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$List, - callback: BodyResponseCallback + predict( + params: Params$Resource$Projects$Locations$Publishers$Models$Predict, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + predict( + callback: BodyResponseCallback ): void; - list( + predict( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookexecutionjobs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Publishers$Models$Predict + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$List; + {}) as Params$Resource$Projects$Locations$Publishers$Models$Predict; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$List; + {} as Params$Resource$Projects$Locations$Publishers$Models$Predict; options = {}; } @@ -91468,103 +127682,33 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/notebookExecutionJobs').replace( + url: (rootUrl + '/v1/{+endpoint}:predict').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Create - extends StandardParameters { - /** - * Optional. User specified ID for the NotebookExecutionJob. - */ - notebookExecutionJobId?: string; - /** - * Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1NotebookExecutionJob; - } - export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete - extends StandardParameters { - /** - * Required. The name of the NotebookExecutionJob resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Get - extends StandardParameters { - /** - * Required. The name of the NotebookExecutionJob resource. - */ - name?: string; - /** - * Optional. The NotebookExecutionJob view. Defaults to BASIC. - */ - view?: string; - } - export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$List - extends StandardParameters { - /** - * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookExecutionJob` supports = and !=. `notebookExecutionJob` represents the NotebookExecutionJob ID. * `displayName` supports = and != and regex. * `schedule` supports = and != and regex. Some examples: * `notebookExecutionJob="123"` * `notebookExecutionJob="my-execution-job"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` - */ - filter?: string; - /** - * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. - */ - orderBy?: string; - /** - * Optional. The standard list page size. - */ - pageSize?: number; - /** - * Optional. The standard list page token. Typically obtained via ListNotebookExecutionJobsResponse.next_page_token of the previous NotebookService.ListNotebookExecutionJobs call. - */ - pageToken?: string; - /** - * Required. The resource name of the Location from which to list the NotebookExecutionJobs. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - /** - * Optional. The NotebookExecutionJob view. Defaults to BASIC. - */ - view?: string; - } - - export class Resource$Projects$Locations$Notebookexecutionjobs$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -91585,7 +127729,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -91594,16 +127741,30 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.notebookExecutionJobs.operations.cancel( - * { - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/notebookExecutionJobs/my-notebookExecutionJob/operations/my-operation', + * await aiplatform.projects.locations.publishers.models.predictLongRunning({ + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` + * endpoint: + * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "instances": [], + * // "parameters": {} + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -91618,54 +127779,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel, + predictLongRunning( + params: Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel, + predictLongRunning( + params?: Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel, + ): Promise>; + predictLongRunning( + params: Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + predictLongRunning( + params: Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel, - callback: BodyResponseCallback + predictLongRunning( + params: Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + predictLongRunning( + callback: BodyResponseCallback + ): void; + predictLongRunning( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning; options = {}; } @@ -91678,29 +127843,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+endpoint}:predictLongRunning').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's DeployedModel that served this prediction. * @example * ```js * // Before running the sample: @@ -91721,7 +127889,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -91729,17 +127900,27 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.notebookExecutionJobs.operations.delete( - * { - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/notebookExecutionJobs/my-notebookExecutionJob/operations/my-operation', - * }, - * ); + * const res = await aiplatform.projects.locations.publishers.models.rawPredict({ + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: + * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "httpBody": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] + * // } * } * * main().catch(e => { @@ -91754,54 +127935,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete, + rawPredict( + params: Params$Resource$Projects$Locations$Publishers$Models$Rawpredict, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete, + rawPredict( + params?: Params$Resource$Projects$Locations$Publishers$Models$Rawpredict, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete, + ): Promise>; + rawPredict( + params: Params$Resource$Projects$Locations$Publishers$Models$Rawpredict, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + rawPredict( + params: Params$Resource$Projects$Locations$Publishers$Models$Rawpredict, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete, - callback: BodyResponseCallback + rawPredict( + params: Params$Resource$Projects$Locations$Publishers$Models$Rawpredict, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + rawPredict(callback: BodyResponseCallback): void; + rawPredict( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Publishers$Models$Rawpredict + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Publishers$Models$Rawpredict; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete; + {} as Params$Resource$Projects$Locations$Publishers$Models$Rawpredict; options = {}; } @@ -91814,29 +127995,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+endpoint}:rawPredict').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Perform a server-side streaming online prediction request for Vertex LLM streaming. * @example * ```js * // Before running the sample: @@ -91857,7 +128041,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -91866,19 +128053,28 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.notebookExecutionJobs.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/notebookExecutionJobs/my-notebookExecutionJob/operations/my-operation', - * }); + * await aiplatform.projects.locations.publishers.models.serverStreamingPredict( + * { + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: + * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "inputs": [], + * // "parameters": {} + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "outputs": [], + * // "parameters": {} * // } * } * @@ -91894,58 +128090,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get, + serverStreamingPredict( + params: Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get, + serverStreamingPredict( + params?: Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + serverStreamingPredict( + params: Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get, + serverStreamingPredict( + params: Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get, - callback: BodyResponseCallback + serverStreamingPredict( + params: Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + serverStreamingPredict( + callback: BodyResponseCallback ): void; - get( + serverStreamingPredict( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get; + {}) as Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get; + {} as Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict; options = {}; } @@ -91958,29 +128158,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+endpoint}:serverStreamingPredict').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Generate content with multimodal inputs with streaming support. * @example * ```js * // Before running the sample: @@ -92001,7 +128206,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -92010,25 +128218,39 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.notebookExecutionJobs.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/notebookExecutionJobs/my-notebookExecutionJob', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * await aiplatform.projects.locations.publishers.models.streamGenerateContent( + * { + * // Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * model: + * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "cachedContent": "my_cachedContent", + * // "contents": [], + * // "generationConfig": {}, + * // "labels": {}, + * // "modelArmorConfig": {}, + * // "safetySettings": [], + * // "systemInstruction": {}, + * // "toolConfig": {}, + * // "tools": [] + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "candidates": [], + * // "createTime": "my_createTime", + * // "modelVersion": "my_modelVersion", + * // "promptFeedback": {}, + * // "responseId": "my_responseId", + * // "usageMetadata": {} * // } * } * @@ -92044,62 +128266,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List, + streamGenerateContent( + params: Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List, + streamGenerateContent( + params?: Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List, + streamGenerateContent( + params: Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List, + streamGenerateContent( + params: Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List, - callback: BodyResponseCallback + streamGenerateContent( + params: Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + streamGenerateContent( + callback: BodyResponseCallback ): void; - list( + streamGenerateContent( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List; + {}) as Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List; + {} as Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent; options = {}; } @@ -92112,34 +128334,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+model}:streamGenerateContent').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['model'], + pathParams: ['model'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Perform a streaming online prediction with an arbitrary HTTP payload. * @example * ```js * // Before running the sample: @@ -92160,7 +128382,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -92169,21 +128394,26 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.notebookExecutionJobs.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/notebookExecutionJobs/my-notebookExecutionJob/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', + * await aiplatform.projects.locations.publishers.models.streamRawPredict({ + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: + * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "httpBody": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] * // } * } * @@ -92199,58 +128429,56 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait, + streamRawPredict( + params: Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait, + streamRawPredict( + params?: Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict, options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait, + ): Promise>; + streamRawPredict( + params: Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + streamRawPredict( + params: Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait, - callback: BodyResponseCallback + streamRawPredict( + params: Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + streamRawPredict( + callback: BodyResponseCallback ): void; - wait( + streamRawPredict( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait; + {} as Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict; options = {}; } @@ -92263,97 +128491,180 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+endpoint}:streamRawPredict').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel + export interface Params$Resource$Projects$Locations$Publishers$Models$Computetokens extends StandardParameters { /** - * The name of the operation resource to be cancelled. + * Required. The name of the Endpoint requested to get lists of tokens and token ids. */ - name?: string; + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ComputeTokensRequest; } - export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete + export interface Params$Resource$Projects$Locations$Publishers$Models$Counttokens extends StandardParameters { /** - * The name of the operation resource to be deleted. + * Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` */ - name?: string; + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CountTokensRequest; } - export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get + export interface Params$Resource$Projects$Locations$Publishers$Models$Embedcontent extends StandardParameters { /** - * The name of the operation resource. + * Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/publishers/x/models/x` */ - name?: string; + model?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1EmbedContentRequest; } - export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List + export interface Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation extends StandardParameters { /** - * The standard list filter. + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` */ - filter?: string; + endpoint?: string; + /** - * The name of the operation's parent resource. + * Request body metadata */ - name?: string; + requestBody?: Schema$GoogleCloudAiplatformV1FetchPredictOperationRequest; + } + export interface Params$Resource$Projects$Locations$Publishers$Models$Generatecontent + extends StandardParameters { /** - * The standard list page size. + * Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` */ - pageSize?: number; + model?: string; + /** - * The standard list page token. + * Request body metadata */ - pageToken?: string; + requestBody?: Schema$GoogleCloudAiplatformV1GenerateContentRequest; + } + export interface Params$Resource$Projects$Locations$Publishers$Models$Predict + extends StandardParameters { /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` */ - returnPartialSuccess?: boolean; + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1PredictRequest; } - export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait + export interface Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning extends StandardParameters { /** - * The name of the operation resource to wait on. + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` */ - name?: string; + endpoint?: string; + /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * Request body metadata */ - timeout?: string; + requestBody?: Schema$GoogleCloudAiplatformV1PredictLongRunningRequest; + } + export interface Params$Resource$Projects$Locations$Publishers$Models$Rawpredict + extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1RawPredictRequest; } + export interface Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict + extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; - export class Resource$Projects$Locations$Notebookruntimes { + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1StreamingPredictRequest; + } + export interface Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent + extends StandardParameters { + /** + * Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + model?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1GenerateContentRequest; + } + export interface Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict + extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1StreamRawPredictRequest; + } + + export class Resource$Projects$Locations$Ragcorpora { context: APIRequestContext; - operations: Resource$Projects$Locations$Notebookruntimes$Operations; + operations: Resource$Projects$Locations$Ragcorpora$Operations; + ragFiles: Resource$Projects$Locations$Ragcorpora$Ragfiles; constructor(context: APIRequestContext) { this.context = context; - this.operations = - new Resource$Projects$Locations$Notebookruntimes$Operations( - this.context - ); + this.operations = new Resource$Projects$Locations$Ragcorpora$Operations( + this.context + ); + this.ragFiles = new Resource$Projects$Locations$Ragcorpora$Ragfiles( + this.context + ); } /** - * Assigns a NotebookRuntime to a user for a particular Notebook file. This method will either returns an existing assignment or generates a new one. + * Creates a RagCorpus. * @example * ```js * // Before running the sample: @@ -92382,17 +128693,23 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.notebookRuntimes.assign({ - * // Required. The resource name of the Location to get the NotebookRuntime assignment. Format: `projects/{project\}/locations/{location\}` + * const res = await aiplatform.projects.locations.ragCorpora.create({ + * // Required. The resource name of the Location to create the RagCorpus in. Format: `projects/{project\}/locations/{location\}` * parent: 'projects/my-project/locations/my-location', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "notebookRuntime": {}, - * // "notebookRuntimeId": "my_notebookRuntimeId", - * // "notebookRuntimeTemplate": "my_notebookRuntimeTemplate" + * // "corpusStatus": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime", + * // "vectorDbConfig": {}, + * // "vertexAiSearchConfig": {} * // } * }, * }); @@ -92420,36 +128737,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - assign( - params: Params$Resource$Projects$Locations$Notebookruntimes$Assign, + create( + params: Params$Resource$Projects$Locations$Ragcorpora$Create, options: StreamMethodOptions ): Promise>; - assign( - params?: Params$Resource$Projects$Locations$Notebookruntimes$Assign, + create( + params?: Params$Resource$Projects$Locations$Ragcorpora$Create, options?: MethodOptions ): Promise>; - assign( - params: Params$Resource$Projects$Locations$Notebookruntimes$Assign, + create( + params: Params$Resource$Projects$Locations$Ragcorpora$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - assign( - params: Params$Resource$Projects$Locations$Notebookruntimes$Assign, + create( + params: Params$Resource$Projects$Locations$Ragcorpora$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - assign( - params: Params$Resource$Projects$Locations$Notebookruntimes$Assign, + create( + params: Params$Resource$Projects$Locations$Ragcorpora$Create, callback: BodyResponseCallback ): void; - assign( + create( callback: BodyResponseCallback ): void; - assign( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimes$Assign + | Params$Resource$Projects$Locations$Ragcorpora$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -92465,13 +128782,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimes$Assign; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Notebookruntimes$Assign; + params = {} as Params$Resource$Projects$Locations$Ragcorpora$Create; options = {}; } @@ -92484,7 +128800,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/notebookRuntimes:assign').replace( + url: (rootUrl + '/v1/{+parent}/ragCorpora').replace( /([^:]\/)\/+/g, '$1' ), @@ -92509,7 +128825,7 @@ export namespace aiplatform_v1 { } /** - * Deletes a NotebookRuntime. + * Deletes a RagCorpus. * @example * ```js * // Before running the sample: @@ -92538,9 +128854,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.notebookRuntimes.delete({ - * // Required. The name of the NotebookRuntime resource to be deleted. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. - * name: 'projects/my-project/locations/my-location/notebookRuntimes/my-notebookRuntime', + * const res = await aiplatform.projects.locations.ragCorpora.delete({ + * // Optional. If set to true, any RagFiles in this RagCorpus will also be deleted. Otherwise, the request will only work if the RagCorpus has no RagFiles. + * force: 'placeholder-value', + * // Required. The name of the RagCorpus resource to be deleted. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` + * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+', * }); * console.log(res.data); * @@ -92567,27 +128885,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Notebookruntimes$Delete, + params: Params$Resource$Projects$Locations$Ragcorpora$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Notebookruntimes$Delete, + params?: Params$Resource$Projects$Locations$Ragcorpora$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Notebookruntimes$Delete, + params: Params$Resource$Projects$Locations$Ragcorpora$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Notebookruntimes$Delete, + params: Params$Resource$Projects$Locations$Ragcorpora$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Notebookruntimes$Delete, + params: Params$Resource$Projects$Locations$Ragcorpora$Delete, callback: BodyResponseCallback ): void; delete( @@ -92595,7 +128913,7 @@ export namespace aiplatform_v1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimes$Delete + | Params$Resource$Projects$Locations$Ragcorpora$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -92611,13 +128929,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimes$Delete; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Notebookruntimes$Delete; + params = {} as Params$Resource$Projects$Locations$Ragcorpora$Delete; options = {}; } @@ -92652,7 +128969,7 @@ export namespace aiplatform_v1 { } /** - * Gets a NotebookRuntime. + * Gets a RagCorpus. * @example * ```js * // Before running the sample: @@ -92681,42 +128998,23 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.notebookRuntimes.get({ - * // Required. The name of the NotebookRuntime resource. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. - * name: 'projects/my-project/locations/my-location/notebookRuntimes/my-notebookRuntime', + * const res = await aiplatform.projects.locations.ragCorpora.get({ + * // Required. The name of the RagCorpus resource. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` + * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+', * }); * console.log(res.data); * * // Example response * // { + * // "corpusStatus": {}, * // "createTime": "my_createTime", - * // "dataPersistentDiskSpec": {}, * // "description": "my_description", * // "displayName": "my_displayName", * // "encryptionSpec": {}, - * // "eucConfig": {}, - * // "expirationTime": "my_expirationTime", - * // "healthState": "my_healthState", - * // "idleShutdownConfig": {}, - * // "isUpgradable": false, - * // "labels": {}, - * // "machineSpec": {}, * // "name": "my_name", - * // "networkSpec": {}, - * // "networkTags": [], - * // "notebookRuntimeTemplateRef": {}, - * // "notebookRuntimeType": "my_notebookRuntimeType", - * // "proxyUri": "my_proxyUri", - * // "reservationAffinity": {}, - * // "runtimeState": "my_runtimeState", - * // "runtimeUser": "my_runtimeUser", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "serviceAccount": "my_serviceAccount", - * // "shieldedVmConfig": {}, - * // "softwareConfig": {}, * // "updateTime": "my_updateTime", - * // "version": "my_version" + * // "vectorDbConfig": {}, + * // "vertexAiSearchConfig": {} * // } * } * @@ -92733,60 +129031,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Notebookruntimes$Get, + params: Params$Resource$Projects$Locations$Ragcorpora$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Notebookruntimes$Get, + params?: Params$Resource$Projects$Locations$Ragcorpora$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; get( - params: Params$Resource$Projects$Locations$Notebookruntimes$Get, + params: Params$Resource$Projects$Locations$Ragcorpora$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Notebookruntimes$Get, + params: Params$Resource$Projects$Locations$Ragcorpora$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Notebookruntimes$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Ragcorpora$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimes$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Ragcorpora$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimes$Get; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Notebookruntimes$Get; + params = {} as Params$Resource$Projects$Locations$Ragcorpora$Get; options = {}; } @@ -92811,19 +129109,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists NotebookRuntimes in a Location. + * Lists RagCorpora in a Location. * @example * ```js * // Before running the sample: @@ -92852,26 +129150,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.notebookRuntimes.list({ - * // Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED, ERROR, INVALID]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntime="notebookRuntime123"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` * `notebookRuntimeTemplate="notebookRuntimeTemplate321"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser="test@google.com"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4` - * filter: 'placeholder-value', - * // Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. - * orderBy: 'placeholder-value', + * const res = await aiplatform.projects.locations.ragCorpora.list({ * // Optional. The standard list page size. * pageSize: 'placeholder-value', - * // Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimes call. + * // Optional. The standard list page token. Typically obtained via ListRagCorporaResponse.next_page_token of the previous VertexRagDataService.ListRagCorpora call. * pageToken: 'placeholder-value', - * // Required. The resource name of the Location from which to list the NotebookRuntimes. Format: `projects/{project\}/locations/{location\}` + * // Required. The resource name of the Location from which to list the RagCorpora. Format: `projects/{project\}/locations/{location\}` * parent: 'projects/my-project/locations/my-location', - * // Optional. Mask specifying which fields to read. - * readMask: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "notebookRuntimes": [] + * // "ragCorpora": [] * // } * } * @@ -92888,60 +129180,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Notebookruntimes$List, + params: Params$Resource$Projects$Locations$Ragcorpora$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Notebookruntimes$List, + params?: Params$Resource$Projects$Locations$Ragcorpora$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Notebookruntimes$List, + params: Params$Resource$Projects$Locations$Ragcorpora$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Notebookruntimes$List, + params: Params$Resource$Projects$Locations$Ragcorpora$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Notebookruntimes$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Ragcorpora$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimes$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Ragcorpora$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimes$List; + {}) as Params$Resource$Projects$Locations$Ragcorpora$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Notebookruntimes$List; + params = {} as Params$Resource$Projects$Locations$Ragcorpora$List; options = {}; } @@ -92954,7 +129246,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/notebookRuntimes').replace( + url: (rootUrl + '/v1/{+parent}/ragCorpora').replace( /([^:]\/)\/+/g, '$1' ), @@ -92969,316 +129261,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Starts a NotebookRuntime. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const aiplatform = google.aiplatform('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await aiplatform.projects.locations.notebookRuntimes.start({ - * // Required. The name of the NotebookRuntime resource to be started. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. - * name: 'projects/my-project/locations/my-location/notebookRuntimes/my-notebookRuntime', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - start( - params: Params$Resource$Projects$Locations$Notebookruntimes$Start, - options: StreamMethodOptions - ): Promise>; - start( - params?: Params$Resource$Projects$Locations$Notebookruntimes$Start, - options?: MethodOptions - ): Promise>; - start( - params: Params$Resource$Projects$Locations$Notebookruntimes$Start, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - start( - params: Params$Resource$Projects$Locations$Notebookruntimes$Start, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - start( - params: Params$Resource$Projects$Locations$Notebookruntimes$Start, - callback: BodyResponseCallback - ): void; - start( - callback: BodyResponseCallback - ): void; - start( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimes$Start - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimes$Start; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Notebookruntimes$Start; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:start').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Stops a NotebookRuntime. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const aiplatform = google.aiplatform('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await aiplatform.projects.locations.notebookRuntimes.stop({ - * // Required. The name of the NotebookRuntime resource to be stopped. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. - * name: 'projects/my-project/locations/my-location/notebookRuntimes/my-notebookRuntime', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - stop( - params: Params$Resource$Projects$Locations$Notebookruntimes$Stop, - options: StreamMethodOptions - ): Promise>; - stop( - params?: Params$Resource$Projects$Locations$Notebookruntimes$Stop, - options?: MethodOptions - ): Promise>; - stop( - params: Params$Resource$Projects$Locations$Notebookruntimes$Stop, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - stop( - params: Params$Resource$Projects$Locations$Notebookruntimes$Stop, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - stop( - params: Params$Resource$Projects$Locations$Notebookruntimes$Stop, - callback: BodyResponseCallback - ): void; - stop( - callback: BodyResponseCallback - ): void; - stop( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimes$Stop - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimes$Stop; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Notebookruntimes$Stop; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:stop').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Upgrades a NotebookRuntime. + * Updates a RagCorpus. * @example * ```js * // Before running the sample: @@ -93307,14 +129302,24 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.notebookRuntimes.upgrade({ - * // Required. The name of the NotebookRuntime resource to be upgrade. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. - * name: 'projects/my-project/locations/my-location/notebookRuntimes/my-notebookRuntime', + * const res = await aiplatform.projects.locations.ragCorpora.patch({ + * // Output only. The resource name of the RagCorpus. + * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+', * * // Request body metadata * requestBody: { * // request body parameters - * // {} + * // { + * // "corpusStatus": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime", + * // "vectorDbConfig": {}, + * // "vertexAiSearchConfig": {} + * // } * }, * }); * console.log(res.data); @@ -93341,36 +129346,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - upgrade( - params: Params$Resource$Projects$Locations$Notebookruntimes$Upgrade, + patch( + params: Params$Resource$Projects$Locations$Ragcorpora$Patch, options: StreamMethodOptions ): Promise>; - upgrade( - params?: Params$Resource$Projects$Locations$Notebookruntimes$Upgrade, + patch( + params?: Params$Resource$Projects$Locations$Ragcorpora$Patch, options?: MethodOptions ): Promise>; - upgrade( - params: Params$Resource$Projects$Locations$Notebookruntimes$Upgrade, + patch( + params: Params$Resource$Projects$Locations$Ragcorpora$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - upgrade( - params: Params$Resource$Projects$Locations$Notebookruntimes$Upgrade, + patch( + params: Params$Resource$Projects$Locations$Ragcorpora$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - upgrade( - params: Params$Resource$Projects$Locations$Notebookruntimes$Upgrade, + patch( + params: Params$Resource$Projects$Locations$Ragcorpora$Patch, callback: BodyResponseCallback ): void; - upgrade( + patch( callback: BodyResponseCallback ): void; - upgrade( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimes$Upgrade + | Params$Resource$Projects$Locations$Ragcorpora$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -93386,13 +129391,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimes$Upgrade; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Notebookruntimes$Upgrade; + params = {} as Params$Resource$Projects$Locations$Ragcorpora$Patch; options = {}; } @@ -93405,11 +129409,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:upgrade').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -93430,97 +129431,65 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Notebookruntimes$Assign + export interface Params$Resource$Projects$Locations$Ragcorpora$Create extends StandardParameters { /** - * Required. The resource name of the Location to get the NotebookRuntime assignment. Format: `projects/{project\}/locations/{location\}` + * Required. The resource name of the Location to create the RagCorpus in. Format: `projects/{project\}/locations/{location\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1AssignNotebookRuntimeRequest; + requestBody?: Schema$GoogleCloudAiplatformV1RagCorpus; } - export interface Params$Resource$Projects$Locations$Notebookruntimes$Delete + export interface Params$Resource$Projects$Locations$Ragcorpora$Delete extends StandardParameters { /** - * Required. The name of the NotebookRuntime resource to be deleted. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. + * Optional. If set to true, any RagFiles in this RagCorpus will also be deleted. Otherwise, the request will only work if the RagCorpus has no RagFiles. + */ + force?: boolean; + /** + * Required. The name of the RagCorpus resource to be deleted. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Notebookruntimes$Get + export interface Params$Resource$Projects$Locations$Ragcorpora$Get extends StandardParameters { /** - * Required. The name of the NotebookRuntime resource. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. + * Required. The name of the RagCorpus resource. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Notebookruntimes$List + export interface Params$Resource$Projects$Locations$Ragcorpora$List extends StandardParameters { - /** - * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED, ERROR, INVALID]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntime="notebookRuntime123"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` * `notebookRuntimeTemplate="notebookRuntimeTemplate321"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser="test@google.com"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4` - */ - filter?: string; - /** - * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. - */ - orderBy?: string; /** * Optional. The standard list page size. */ pageSize?: number; /** - * Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimes call. + * Optional. The standard list page token. Typically obtained via ListRagCorporaResponse.next_page_token of the previous VertexRagDataService.ListRagCorpora call. */ pageToken?: string; /** - * Required. The resource name of the Location from which to list the NotebookRuntimes. Format: `projects/{project\}/locations/{location\}` + * Required. The resource name of the Location from which to list the RagCorpora. Format: `projects/{project\}/locations/{location\}` */ parent?: string; - /** - * Optional. Mask specifying which fields to read. - */ - readMask?: string; - } - export interface Params$Resource$Projects$Locations$Notebookruntimes$Start - extends StandardParameters { - /** - * Required. The name of the NotebookRuntime resource to be started. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1StartNotebookRuntimeRequest; - } - export interface Params$Resource$Projects$Locations$Notebookruntimes$Stop - extends StandardParameters { - /** - * Required. The name of the NotebookRuntime resource to be stopped. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1StopNotebookRuntimeRequest; } - export interface Params$Resource$Projects$Locations$Notebookruntimes$Upgrade + export interface Params$Resource$Projects$Locations$Ragcorpora$Patch extends StandardParameters { /** - * Required. The name of the NotebookRuntime resource to be upgrade. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. + * Output only. The resource name of the RagCorpus. */ name?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest; + requestBody?: Schema$GoogleCloudAiplatformV1RagCorpus; } - export class Resource$Projects$Locations$Notebookruntimes$Operations { + export class Resource$Projects$Locations$Ragcorpora$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -93556,11 +129525,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.notebookRuntimes.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/notebookRuntimes/my-notebookRuntime/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.ragCorpora.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -93580,31 +129548,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel, + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel, + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel, + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel, + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel + | Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -93620,13 +129588,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel; options = {}; } @@ -93690,11 +129658,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.notebookRuntimes.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/notebookRuntimes/my-notebookRuntime/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.ragCorpora.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -93714,31 +129681,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete, + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete, + params?: Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete, + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete, + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete, + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete + | Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -93754,13 +129721,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete; + {} as Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete; options = {}; } @@ -93824,11 +129791,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.notebookRuntimes.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/notebookRuntimes/my-notebookRuntime/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.ragCorpora.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -93854,27 +129820,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get, + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get, + params?: Params$Resource$Projects$Locations$Ragcorpora$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get, + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get, + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get, + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -93882,7 +129848,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get + | Params$Resource$Projects$Locations$Ragcorpora$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -93898,13 +129864,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get; + {} as Params$Resource$Projects$Locations$Ragcorpora$Operations$Get; options = {}; } @@ -93968,19 +129934,18 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.notebookRuntimes.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/notebookRuntimes/my-notebookRuntime', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * const res = await aiplatform.projects.locations.ragCorpora.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -94004,29 +129969,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$List, + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Notebookruntimes$Operations$List, + params?: Params$Resource$Projects$Locations$Ragcorpora$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$List, + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$List, + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$List, + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$List, callback: BodyResponseCallback ): void; list( @@ -94034,7 +129999,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimes$Operations$List + | Params$Resource$Projects$Locations$Ragcorpora$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -94052,13 +130017,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimes$Operations$List; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimes$Operations$List; + {} as Params$Resource$Projects$Locations$Ragcorpora$Operations$List; options = {}; } @@ -94127,13 +130092,12 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.notebookRuntimes.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/notebookRuntimes/my-notebookRuntime/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); + * const res = await aiplatform.projects.locations.ragCorpora.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -94159,27 +130123,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait, + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait, + params?: Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait, + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait, + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait, + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -94187,7 +130151,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait + | Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -94203,13 +130167,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait; + {} as Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait; options = {}; } @@ -94244,28 +130208,28 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel + export interface Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete + export interface Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get + export interface Params$Resource$Projects$Locations$Ragcorpora$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Notebookruntimes$Operations$List + export interface Params$Resource$Projects$Locations$Ragcorpora$Operations$List extends StandardParameters { /** * The standard list filter. @@ -94288,7 +130252,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait + export interface Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -94300,19 +130264,19 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Notebookruntimetemplates { + export class Resource$Projects$Locations$Ragcorpora$Ragfiles { context: APIRequestContext; - operations: Resource$Projects$Locations$Notebookruntimetemplates$Operations; + operations: Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations; constructor(context: APIRequestContext) { this.context = context; this.operations = - new Resource$Projects$Locations$Notebookruntimetemplates$Operations( + new Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations( this.context ); } /** - * Creates a NotebookRuntimeTemplate. + * Deletes a RagFile. * @example * ```js * // Before running the sample: @@ -94341,40 +130305,12 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.notebookRuntimeTemplates.create({ - * // Optional. User specified ID for the notebook runtime template. - * notebookRuntimeTemplateId: 'placeholder-value', - * // Required. The resource name of the Location to create the NotebookRuntimeTemplate. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "dataPersistentDiskSpec": {}, - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "eucConfig": {}, - * // "idleShutdownConfig": {}, - * // "isDefault": false, - * // "labels": {}, - * // "machineSpec": {}, - * // "name": "my_name", - * // "networkSpec": {}, - * // "networkTags": [], - * // "notebookRuntimeType": "my_notebookRuntimeType", - * // "reservationAffinity": {}, - * // "serviceAccount": "my_serviceAccount", - * // "shieldedVmConfig": {}, - * // "softwareConfig": {}, - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * const res = await aiplatform.projects.locations.ragCorpora.ragFiles.delete({ + * // Optional. If set to true, any errors generated by external vector database during the deletion will be ignored. The default value is false. + * forceDelete: 'placeholder-value', + * // Required. The name of the RagFile resource to be deleted. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}/ragFiles/{rag_file\}` + * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/ragFiles/my-ragFile', + * }); * console.log(res.data); * * // Example response @@ -94399,36 +130335,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Create, + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Create, + delete( + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete, options?: MethodOptions ): Promise>; - create( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Create, + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Create, + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Create, + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete, callback: BodyResponseCallback ): void; - create( + delete( callback: BodyResponseCallback ): void; - create( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$Create + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -94444,13 +130380,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Create; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Create; + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete; options = {}; } @@ -94463,18 +130399,15 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/notebookRuntimeTemplates').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -94488,7 +130421,7 @@ export namespace aiplatform_v1 { } /** - * Deletes a NotebookRuntimeTemplate. + * Gets a RagFile. * @example * ```js * // Before running the sample: @@ -94517,11 +130450,171 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.notebookRuntimeTemplates.delete({ - * // Required. The name of the NotebookRuntimeTemplate resource to be deleted. Format: `projects/{project\}/locations/{location\}/notebookRuntimeTemplates/{notebook_runtime_template\}` - * name: 'projects/my-project/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate', - * }); + * const res = await aiplatform.projects.locations.ragCorpora.ragFiles.get({ + * // Required. The name of the RagFile resource. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}/ragFiles/{rag_file\}` + * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/ragFiles/my-ragFile', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "directUploadSource": {}, + * // "displayName": "my_displayName", + * // "fileStatus": {}, + * // "gcsSource": {}, + * // "googleDriveSource": {}, + * // "jiraSource": {}, + * // "name": "my_name", + * // "sharePointSources": {}, + * // "slackSource": {}, + * // "updateTime": "my_updateTime", + * // "userMetadata": "my_userMetadata" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Import files from Google Cloud Storage or Google Drive into a RagCorpus. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.ragCorpora.ragFiles.import({ + * // Required. The name of the RagCorpus resource into which to import files. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` + * parent: 'projects/my-project/locations/my-location/ragCorpora/[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "importRagFilesConfig": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response @@ -94546,36 +130639,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete, + import( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete, + import( + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete, + import( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete, + import( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete, + import( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, callback: BodyResponseCallback ): void; - delete( + import( callback: BodyResponseCallback ): void; - delete( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -94591,13 +130684,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete; + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import; options = {}; } @@ -94610,15 +130703,18 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/ragFiles:import').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -94632,7 +130728,7 @@ export namespace aiplatform_v1 { } /** - * Gets a NotebookRuntimeTemplate. + * Lists RagFiles in a RagCorpus. * @example * ```js * // Before running the sample: @@ -94661,34 +130757,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.notebookRuntimeTemplates.get({ - * // Required. The name of the NotebookRuntimeTemplate resource. Format: `projects/{project\}/locations/{location\}/notebookRuntimeTemplates/{notebook_runtime_template\}` - * name: 'projects/my-project/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate', + * const res = await aiplatform.projects.locations.ragCorpora.ragFiles.list({ + * // Optional. The standard list page size. + * pageSize: 'placeholder-value', + * // Optional. The standard list page token. Typically obtained via ListRagFilesResponse.next_page_token of the previous VertexRagDataService.ListRagFiles call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the RagCorpus from which to list the RagFiles. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` + * parent: 'projects/my-project/locations/my-location/ragCorpora/[^/]+', * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "dataPersistentDiskSpec": {}, - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "eucConfig": {}, - * // "idleShutdownConfig": {}, - * // "isDefault": false, - * // "labels": {}, - * // "machineSpec": {}, - * // "name": "my_name", - * // "networkSpec": {}, - * // "networkTags": [], - * // "notebookRuntimeType": "my_notebookRuntimeType", - * // "reservationAffinity": {}, - * // "serviceAccount": "my_serviceAccount", - * // "shieldedVmConfig": {}, - * // "softwareConfig": {}, - * // "updateTime": "my_updateTime" + * // "nextPageToken": "my_nextPageToken", + * // "ragFiles": [] * // } * } * @@ -94704,62 +130786,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Get, + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Get, + list( + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Get, + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Get, + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Get; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Get; + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List; options = {}; } @@ -94772,31 +130854,87 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/ragFiles').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete + extends StandardParameters { /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Optional. If set to true, any errors generated by external vector database during the deletion will be ignored. The default value is false. + */ + forceDelete?: boolean; + /** + * Required. The name of the RagFile resource to be deleted. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}/ragFiles/{rag_file\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get + extends StandardParameters { + /** + * Required. The name of the RagFile resource. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}/ragFiles/{rag_file\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import + extends StandardParameters { + /** + * Required. The name of the RagCorpus resource into which to import files. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ImportRagFilesRequest; + } + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List + extends StandardParameters { + /** + * Optional. The standard list page size. + */ + pageSize?: number; + /** + * Optional. The standard list page token. Typically obtained via ListRagFilesResponse.next_page_token of the previous VertexRagDataService.ListRagFiles call. + */ + pageToken?: string; + /** + * Required. The resource name of the RagCorpus from which to list the RagFiles. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` + */ + parent?: string; + } + + export class Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -94826,21 +130964,14 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.notebookRuntimeTemplates.getIamPolicy({ - * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - * 'options.requestedPolicyVersion': 'placeholder-value', - * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate', + * await aiplatform.projects.locations.ragCorpora.ragFiles.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/ragFiles/my-ragFile/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } + * // {} * } * * main().catch(e => { @@ -94855,56 +130986,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy, + cancel( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy, + cancel( + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, + callback: BodyResponseCallback ): void; - getIamPolicy( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy; + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel; options = {}; } @@ -94917,32 +131046,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists NotebookRuntimeTemplates in a Location. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -94971,29 +131097,15 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.notebookRuntimeTemplates.list( - * { - * // Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntimeTemplate=notebookRuntimeTemplate123` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4` - * filter: 'placeholder-value', - * // Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. - * orderBy: 'placeholder-value', - * // Optional. The standard list page size. - * pageSize: 'placeholder-value', - * // Optional. The standard list page token. Typically obtained via ListNotebookRuntimeTemplatesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimeTemplates call. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location from which to list the NotebookRuntimeTemplates. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * // Optional. Mask specifying which fields to read. - * readMask: 'placeholder-value', - * }, - * ); + * const res = + * await aiplatform.projects.locations.ragCorpora.ragFiles.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/ragFiles/my-ragFile/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "nextPageToken": "my_nextPageToken", - * // "notebookRuntimeTemplates": [] - * // } + * // {} * } * * main().catch(e => { @@ -95008,62 +131120,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$List, + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$List, + delete( + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$List, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$List; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$List; + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete; options = {}; } @@ -95076,34 +131180,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/notebookRuntimeTemplates').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a NotebookRuntimeTemplate. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -95133,63 +131232,19 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.notebookRuntimeTemplates.patch({ - * // The resource name of the NotebookRuntimeTemplate. - * name: 'projects/my-project/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate', - * // Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Input format: `{paths: "${updated_filed\}"\}` Updatable fields: * `encryption_spec.kms_key_name` - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "dataPersistentDiskSpec": {}, - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "eucConfig": {}, - * // "idleShutdownConfig": {}, - * // "isDefault": false, - * // "labels": {}, - * // "machineSpec": {}, - * // "name": "my_name", - * // "networkSpec": {}, - * // "networkTags": [], - * // "notebookRuntimeType": "my_notebookRuntimeType", - * // "reservationAffinity": {}, - * // "serviceAccount": "my_serviceAccount", - * // "shieldedVmConfig": {}, - * // "softwareConfig": {}, - * // "updateTime": "my_updateTime" - * // } - * }, + * await aiplatform.projects.locations.ragCorpora.ragFiles.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/ragFiles/my-ragFile/operations/my-operation', * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "dataPersistentDiskSpec": {}, - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "eucConfig": {}, - * // "idleShutdownConfig": {}, - * // "isDefault": false, - * // "labels": {}, - * // "machineSpec": {}, + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "networkSpec": {}, - * // "networkTags": [], - * // "notebookRuntimeType": "my_notebookRuntimeType", - * // "reservationAffinity": {}, - * // "serviceAccount": "my_serviceAccount", - * // "shieldedVmConfig": {}, - * // "softwareConfig": {}, - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -95205,62 +131260,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch, + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch, + get( + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - patch( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch, + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch; + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get; options = {}; } @@ -95274,7 +131325,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -95285,19 +131336,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -95327,26 +131376,25 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.notebookRuntimeTemplates.setIamPolicy({ - * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "policy": {} - * // } - * }, + * await aiplatform.projects.locations.ragCorpora.ragFiles.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/ragFiles/my-ragFile', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -95362,56 +131410,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy, + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy, + list( + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, + callback: BodyResponseCallback ): void; - setIamPolicy( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy; + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List; options = {}; } @@ -95424,32 +131478,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -95479,20 +131535,21 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.notebookRuntimeTemplates.testIamPermissions( - * { - * // The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). - * permissions: 'placeholder-value', - * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate', - * }, - * ); + * await aiplatform.projects.locations.ragCorpora.ragFiles.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/ragFiles/my-ragFile/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "permissions": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -95508,62 +131565,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions, + wait( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions, + wait( + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - testIamPermissions( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions, + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions, + wait( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - testIamPermissions( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions; + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait; options = {}; } @@ -95576,142 +131629,97 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Create - extends StandardParameters { - /** - * Optional. User specified ID for the notebook runtime template. - */ - notebookRuntimeTemplateId?: string; - /** - * Required. The resource name of the Location to create the NotebookRuntimeTemplate. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1NotebookRuntimeTemplate; - } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel extends StandardParameters { /** - * Required. The name of the NotebookRuntimeTemplate resource to be deleted. Format: `projects/{project\}/locations/{location\}/notebookRuntimeTemplates/{notebook_runtime_template\}` + * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Get + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete extends StandardParameters { /** - * Required. The name of the NotebookRuntimeTemplate resource. Format: `projects/{project\}/locations/{location\}/notebookRuntimeTemplates/{notebook_runtime_template\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get extends StandardParameters { /** - * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * The name of the operation resource. */ - resource?: string; + name?: string; } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$List + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List extends StandardParameters { /** - * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntimeTemplate=notebookRuntimeTemplate123` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4` + * The standard list filter. */ filter?: string; /** - * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. + * The name of the operation's parent resource. */ - orderBy?: string; + name?: string; /** - * Optional. The standard list page size. + * The standard list page size. */ pageSize?: number; /** - * Optional. The standard list page token. Typically obtained via ListNotebookRuntimeTemplatesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimeTemplates call. + * The standard list page token. */ pageToken?: string; /** - * Required. The resource name of the Location from which to list the NotebookRuntimeTemplates. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - /** - * Optional. Mask specifying which fields to read. + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - readMask?: string; + returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait extends StandardParameters { /** - * The resource name of the NotebookRuntimeTemplate. + * The name of the operation resource to wait on. */ name?: string; /** - * Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Input format: `{paths: "${updated_filed\}"\}` Updatable fields: * `encryption_spec.kms_key_name` - */ - updateMask?: string; - - /** - * Request body metadata + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - requestBody?: Schema$GoogleCloudAiplatformV1NotebookRuntimeTemplate; + timeout?: string; } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions - extends StandardParameters { - /** - * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). - */ - permissions?: string[]; - /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; + export class Resource$Projects$Locations$Ragengineconfig { + context: APIRequestContext; + operations: Resource$Projects$Locations$Ragengineconfig$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Ragengineconfig$Operations( + this.context + ); + } } - export class Resource$Projects$Locations$Notebookruntimetemplates$Operations { + export class Resource$Projects$Locations$Ragengineconfig$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -95748,12 +131756,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.notebookRuntimeTemplates.operations.cancel( - * { - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate/operations/my-operation', - * }, - * ); + * await aiplatform.projects.locations.ragEngineConfig.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/ragEngineConfig/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -95773,31 +131779,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel + | Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -95813,13 +131819,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel; options = {}; } @@ -95884,12 +131890,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.notebookRuntimeTemplates.operations.delete( - * { - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate/operations/my-operation', - * }, - * ); + * await aiplatform.projects.locations.ragEngineConfig.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/ragEngineConfig/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -95909,31 +131913,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete, + params?: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete + | Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -95949,13 +131953,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete; + {} as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete; options = {}; } @@ -96020,12 +132024,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.notebookRuntimeTemplates.operations.get( - * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate/operations/my-operation', - * }, - * ); + * await aiplatform.projects.locations.ragEngineConfig.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/ragEngineConfig/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -96051,27 +132053,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get, + params?: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -96079,7 +132081,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get + | Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -96095,13 +132097,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get; + {}) as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get; + {} as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get; options = {}; } @@ -96166,20 +132168,18 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.notebookRuntimeTemplates.operations.list( - * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }, - * ); + * await aiplatform.projects.locations.ragEngineConfig.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/ragEngineConfig', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -96203,29 +132203,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List, + params?: Params$Resource$Projects$Locations$Ragengineconfig$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$List, callback: BodyResponseCallback ): void; list( @@ -96233,7 +132233,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List + | Params$Resource$Projects$Locations$Ragengineconfig$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -96251,13 +132251,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List; + {}) as Params$Resource$Projects$Locations$Ragengineconfig$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List; + {} as Params$Resource$Projects$Locations$Ragengineconfig$Operations$List; options = {}; } @@ -96327,14 +132327,12 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.notebookRuntimeTemplates.operations.wait( - * { - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }, - * ); + * await aiplatform.projects.locations.ragEngineConfig.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/ragEngineConfig/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -96360,27 +132358,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait, + params?: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -96388,7 +132386,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait + | Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -96404,13 +132402,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait; + {} as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait; options = {}; } @@ -96445,28 +132443,28 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel + export interface Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete + export interface Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get + export interface Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List + export interface Params$Resource$Projects$Locations$Ragengineconfig$Operations$List extends StandardParameters { /** * The standard list filter. @@ -96489,7 +132487,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait + export interface Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -96501,14 +132499,19 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Operations { + export class Resource$Projects$Locations$Reasoningengines { context: APIRequestContext; + operations: Resource$Projects$Locations$Reasoningengines$Operations; constructor(context: APIRequestContext) { this.context = context; + this.operations = + new Resource$Projects$Locations$Reasoningengines$Operations( + this.context + ); } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Creates a reasoning engine. * @example * ```js * // Before running the sample: @@ -96537,14 +132540,36 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/operations/my-operation', + * const res = await aiplatform.projects.locations.reasoningEngines.create({ + * // Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "spec": {}, + * // "updateTime": "my_updateTime" + * // } + * }, * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -96559,53 +132584,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, + create( + params: Params$Resource$Projects$Locations$Reasoningengines$Create, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Operations$Cancel, + create( + params?: Params$Resource$Projects$Locations$Reasoningengines$Create, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Reasoningengines$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Reasoningengines$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Reasoningengines$Create, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Cancel; + params = + {} as Params$Resource$Projects$Locations$Reasoningengines$Create; options = {}; } @@ -96618,29 +132648,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/reasoningEngines').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Deletes a reasoning engine. * @example * ```js * // Before running the sample: @@ -96669,14 +132702,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/operations/my-operation', + * const res = await aiplatform.projects.locations.reasoningEngines.delete({ + * // Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources. + * force: 'placeholder-value', + * // Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -96692,52 +132733,57 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Operations$Delete, + params: Params$Resource$Projects$Locations$Reasoningengines$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Operations$Delete, + params?: Params$Resource$Projects$Locations$Reasoningengines$Delete, options?: MethodOptions - ): Promise>; + ): Promise>; delete( - params: Params$Resource$Projects$Locations$Operations$Delete, + params: Params$Resource$Projects$Locations$Reasoningengines$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Reasoningengines$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Operations$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Reasoningengines$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Delete; + params = + {} as Params$Resource$Projects$Locations$Reasoningengines$Delete; options = {}; } @@ -96762,17 +132808,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Gets a reasoning engine. * @example * ```js * // Before running the sample: @@ -96801,19 +132847,23 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/operations/my-operation', + * const res = await aiplatform.projects.locations.reasoningEngines.get({ + * // Required. The name of the ReasoningEngine resource. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, * // "name": "my_name", - * // "response": {} + * // "spec": {}, + * // "updateTime": "my_updateTime" * // } * } * @@ -96830,56 +132880,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Operations$Get, + params: Params$Resource$Projects$Locations$Reasoningengines$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Operations$Get, + params?: Params$Resource$Projects$Locations$Reasoningengines$Get, options?: MethodOptions - ): Promise>; + ): Promise< + GaxiosResponseWithHTTP2 + >; get( - params: Params$Resource$Projects$Locations$Operations$Get, + params: Params$Resource$Projects$Locations$Reasoningengines$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Operations$Get, + params: Params$Resource$Projects$Locations$Reasoningengines$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Operations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Reasoningengines$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Get; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Get; + params = {} as Params$Resource$Projects$Locations$Reasoningengines$Get; options = {}; } @@ -96904,17 +132958,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Lists reasoning engines in a location. * @example * ```js * // Before running the sample: @@ -96943,25 +132999,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.operations.list({ - * // The standard list filter. + * const res = await aiplatform.projects.locations.reasoningEngines.list({ + * // Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location', - * // The standard list page size. + * // Optional. The standard list page size. * pageSize: 'placeholder-value', - * // The standard list page token. + * // Optional. The standard list page token. * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', + * // Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "reasoningEngines": [] * // } * } * @@ -96978,60 +133031,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Operations$List, + params: Params$Resource$Projects$Locations$Reasoningengines$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Operations$List, + params?: Params$Resource$Projects$Locations$Reasoningengines$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Operations$List, + params: Params$Resource$Projects$Locations$Reasoningengines$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Operations$List, + params: Params$Resource$Projects$Locations$Reasoningengines$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Reasoningengines$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$List; + {}) as Params$Resource$Projects$Locations$Reasoningengines$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$List; + params = {} as Params$Resource$Projects$Locations$Reasoningengines$List; options = {}; } @@ -97044,7 +133097,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+parent}/reasoningEngines').replace( /([^:]\/)\/+/g, '$1' ), @@ -97054,24 +133107,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Updates a reasoning engine. * @example * ```js * // Before running the sample: @@ -97100,11 +133153,27 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', + * const res = await aiplatform.projects.locations.reasoningEngines.patch({ + * // Identifier. The resource name of the ReasoningEngine. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', + * // Optional. Mask specifying which fields to update. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "spec": {}, + * // "updateTime": "my_updateTime" + * // } + * }, * }); * console.log(res.data); * @@ -97130,57 +133199,358 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Operations$Wait, + patch( + params: Params$Resource$Projects$Locations$Reasoningengines$Patch, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Operations$Wait, + patch( + params?: Params$Resource$Projects$Locations$Reasoningengines$Patch, options?: MethodOptions ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Operations$Wait, + patch( + params: Params$Resource$Projects$Locations$Reasoningengines$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Operations$Wait, + patch( + params: Params$Resource$Projects$Locations$Reasoningengines$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Operations$Wait, + patch( + params: Params$Resource$Projects$Locations$Reasoningengines$Patch, + callback: BodyResponseCallback + ): void; + patch( callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Reasoningengines$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Reasoningengines$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Reasoningengines$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Queries using a reasoning engine. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.reasoningEngines.query({ + * // Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "classMethod": "my_classMethod", + * // "input": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "output": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + query( + params: Params$Resource$Projects$Locations$Reasoningengines$Query, + options: StreamMethodOptions + ): Promise>; + query( + params?: Params$Resource$Projects$Locations$Reasoningengines$Query, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + query( + params: Params$Resource$Projects$Locations$Reasoningengines$Query, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + query( + params: Params$Resource$Projects$Locations$Reasoningengines$Query, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + query( + params: Params$Resource$Projects$Locations$Reasoningengines$Query, + callback: BodyResponseCallback + ): void; + query( + callback: BodyResponseCallback + ): void; + query( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Reasoningengines$Query + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Reasoningengines$Query; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Reasoningengines$Query; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:query').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Streams queries using a reasoning engine. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.reasoningEngines.streamQuery({ + * // Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "classMethod": "my_classMethod", + * // "input": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + streamQuery( + params: Params$Resource$Projects$Locations$Reasoningengines$Streamquery, + options: StreamMethodOptions + ): Promise>; + streamQuery( + params?: Params$Resource$Projects$Locations$Reasoningengines$Streamquery, + options?: MethodOptions + ): Promise>; + streamQuery( + params: Params$Resource$Projects$Locations$Reasoningengines$Streamquery, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + streamQuery( + params: Params$Resource$Projects$Locations$Reasoningengines$Streamquery, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + streamQuery( + params: Params$Resource$Projects$Locations$Reasoningengines$Streamquery, + callback: BodyResponseCallback ): void; - wait( + streamQuery(callback: BodyResponseCallback): void; + streamQuery( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Streamquery + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Streamquery; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Wait; + params = + {} as Params$Resource$Projects$Locations$Reasoningengines$Streamquery; options = {}; } @@ -97193,7 +133563,10 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:streamQuery').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, @@ -97205,85 +133578,114 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Operations$Cancel + export interface Params$Resource$Projects$Locations$Reasoningengines$Create extends StandardParameters { /** - * The name of the operation resource to be cancelled. + * Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project\}/locations/{location\}` */ - name?: string; + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ReasoningEngine; } - export interface Params$Resource$Projects$Locations$Operations$Delete + export interface Params$Resource$Projects$Locations$Reasoningengines$Delete extends StandardParameters { /** - * The name of the operation resource to be deleted. + * Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources. + */ + force?: boolean; + /** + * Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Operations$Get + export interface Params$Resource$Projects$Locations$Reasoningengines$Get extends StandardParameters { /** - * The name of the operation resource. + * Required. The name of the ReasoningEngine resource. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Operations$List + export interface Params$Resource$Projects$Locations$Reasoningengines$List extends StandardParameters { /** - * The standard list filter. + * Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). */ filter?: string; /** - * The name of the operation's parent resource. + * Optional. The standard list page size. + */ + pageSize?: number; + /** + * Optional. The standard list page token. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Patch + extends StandardParameters { + /** + * Identifier. The resource name of the ReasoningEngine. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` */ name?: string; /** - * The standard list page size. + * Optional. Mask specifying which fields to update. */ - pageSize?: number; + updateMask?: string; + /** - * The standard list page token. + * Request body metadata */ - pageToken?: string; + requestBody?: Schema$GoogleCloudAiplatformV1ReasoningEngine; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Query + extends StandardParameters { /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` */ - returnPartialSuccess?: boolean; + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1QueryReasoningEngineRequest; } - export interface Params$Resource$Projects$Locations$Operations$Wait + export interface Params$Resource$Projects$Locations$Reasoningengines$Streamquery extends StandardParameters { /** - * The name of the operation resource to wait on. + * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` */ name?: string; + /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * Request body metadata */ - timeout?: string; + requestBody?: Schema$GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest; } - export class Resource$Projects$Locations$Persistentresources { + export class Resource$Projects$Locations$Reasoningengines$Operations { context: APIRequestContext; - operations: Resource$Projects$Locations$Persistentresources$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = - new Resource$Projects$Locations$Persistentresources$Operations( - this.context - ); } /** - * Creates a PersistentResource. + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -97312,46 +133714,15 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.persistentResources.create({ - * // Required. The resource name of the Location to create the PersistentResource in. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * // Required. The ID to use for the PersistentResource, which become the final component of the PersistentResource's resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$/`. - * persistentResourceId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "error": {}, - * // "labels": {}, - * // "name": "my_name", - * // "network": "my_network", - * // "pscInterfaceConfig": {}, - * // "reservedIpRanges": [], - * // "resourcePools": [], - * // "resourceRuntime": {}, - * // "resourceRuntimeSpec": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * const res = + * await aiplatform.projects.locations.reasoningEngines.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -97366,58 +133737,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Persistentresources$Create, + cancel( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Persistentresources$Create, + cancel( + params?: Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Persistentresources$Create, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Persistentresources$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Persistentresources$Create, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel, + callback: BodyResponseCallback ): void; - create( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Persistentresources$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Persistentresources$Create; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Persistentresources$Create; + {} as Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel; options = {}; } @@ -97430,32 +133797,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/persistentResources').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a PersistentResource. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -97484,20 +133848,15 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.persistentResources.delete({ - * // Required. The name of the PersistentResource to be deleted. Format: `projects/{project\}/locations/{location\}/persistentResources/{persistent_resource\}` - * name: 'projects/my-project/locations/my-location/persistentResources/my-persistentResource', - * }); + * const res = + * await aiplatform.projects.locations.reasoningEngines.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -97513,57 +133872,53 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Persistentresources$Delete, + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Persistentresources$Delete, + params?: Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete, options?: MethodOptions - ): Promise>; + ): Promise>; delete( - params: Params$Resource$Projects$Locations$Persistentresources$Delete, + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Persistentresources$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Persistentresources$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete, + callback: BodyResponseCallback ): void; + delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Persistentresources$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Persistentresources$Delete; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Persistentresources$Delete; + {} as Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete; options = {}; } @@ -97588,17 +133943,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a PersistentResource. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -97627,31 +133982,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.persistentResources.get({ - * // Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number\}/locations/{location_id\}/persistentResources/{persistent_resource_id\}` - * name: 'projects/my-project/locations/my-location/persistentResources/my-persistentResource', - * }); + * const res = + * await aiplatform.projects.locations.reasoningEngines.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/operations/my-operation', + * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, + * // "done": false, * // "error": {}, - * // "labels": {}, + * // "metadata": {}, * // "name": "my_name", - * // "network": "my_network", - * // "pscInterfaceConfig": {}, - * // "reservedIpRanges": [], - * // "resourcePools": [], - * // "resourceRuntime": {}, - * // "resourceRuntimeSpec": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -97668,61 +134012,57 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Persistentresources$Get, + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Persistentresources$Get, + params?: Params$Resource$Projects$Locations$Reasoningengines$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; + ): Promise>; get( - params: Params$Resource$Projects$Locations$Persistentresources$Get, + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Persistentresources$Get, + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Persistentresources$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Persistentresources$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Persistentresources$Get; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Persistentresources$Get; + {} as Params$Resource$Projects$Locations$Reasoningengines$Operations$Get; options = {}; } @@ -97747,19 +134087,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists PersistentResources in a Location. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -97788,20 +134126,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.persistentResources.list({ - * // Optional. The standard list page size. - * pageSize: 'placeholder-value', - * // Optional. The standard list page token. Typically obtained via ListPersistentResourcesResponse.next_page_token of the previous PersistentResourceService.ListPersistentResource call. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list the PersistentResources from. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * }); + * const res = + * await aiplatform.projects.locations.reasoningEngines.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "persistentResources": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -97818,61 +134162,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Persistentresources$List, + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Persistentresources$List, + params?: Params$Resource$Projects$Locations$Reasoningengines$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Persistentresources$List, + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Persistentresources$List, + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Persistentresources$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Persistentresources$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Persistentresources$List; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Persistentresources$List; + {} as Params$Resource$Projects$Locations$Reasoningengines$Operations$List; options = {}; } @@ -97885,7 +134229,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/persistentResources').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -97895,193 +134239,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Updates a PersistentResource. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const aiplatform = google.aiplatform('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await aiplatform.projects.locations.persistentResources.patch({ - * // Immutable. Resource name of a PersistentResource. - * name: 'projects/my-project/locations/my-location/persistentResources/my-persistentResource', - * // Required. Specify the fields to be overwritten in the PersistentResource by the update method. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "error": {}, - * // "labels": {}, - * // "name": "my_name", - * // "network": "my_network", - * // "pscInterfaceConfig": {}, - * // "reservedIpRanges": [], - * // "resourcePools": [], - * // "resourceRuntime": {}, - * // "resourceRuntimeSpec": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "updateTime": "my_updateTime" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - patch( - params: Params$Resource$Projects$Locations$Persistentresources$Patch, - options: StreamMethodOptions - ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Persistentresources$Patch, - options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Persistentresources$Patch, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Persistentresources$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Persistentresources$Patch, - callback: BodyResponseCallback - ): void; - patch( - callback: BodyResponseCallback - ): void; - patch( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Persistentresources$Patch - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Persistentresources$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Persistentresources$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - apiVersion: '', - }, - options - ), - params, requiredParams: ['name'], pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Reboots a PersistentResource. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -98110,16 +134285,13 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.persistentResources.reboot({ - * // Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number\}/locations/{location_id\}/persistentResources/{persistent_resource_id\}` - * name: 'projects/my-project/locations/my-location/persistentResources/my-persistentResource', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }); + * const res = + * await aiplatform.projects.locations.reasoningEngines.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -98144,36 +134316,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - reboot( - params: Params$Resource$Projects$Locations$Persistentresources$Reboot, + wait( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait, options: StreamMethodOptions ): Promise>; - reboot( - params?: Params$Resource$Projects$Locations$Persistentresources$Reboot, + wait( + params?: Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait, options?: MethodOptions ): Promise>; - reboot( - params: Params$Resource$Projects$Locations$Persistentresources$Reboot, + wait( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - reboot( - params: Params$Resource$Projects$Locations$Persistentresources$Reboot, + wait( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - reboot( - params: Params$Resource$Projects$Locations$Persistentresources$Reboot, + wait( + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait, callback: BodyResponseCallback ): void; - reboot( + wait( callback: BodyResponseCallback ): void; - reboot( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Persistentresources$Reboot + | Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -98189,13 +134361,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Persistentresources$Reboot; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Persistentresources$Reboot; + {} as Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait; options = {}; } @@ -98208,7 +134380,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:reboot').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -98230,88 +134402,74 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Persistentresources$Create + export interface Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel extends StandardParameters { /** - * Required. The resource name of the Location to create the PersistentResource in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - /** - * Required. The ID to use for the PersistentResource, which become the final component of the PersistentResource's resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$/`. - */ - persistentResourceId?: string; - - /** - * Request body metadata + * The name of the operation resource to be cancelled. */ - requestBody?: Schema$GoogleCloudAiplatformV1PersistentResource; + name?: string; } - export interface Params$Resource$Projects$Locations$Persistentresources$Delete + export interface Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete extends StandardParameters { /** - * Required. The name of the PersistentResource to be deleted. Format: `projects/{project\}/locations/{location\}/persistentResources/{persistent_resource\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Persistentresources$Get + export interface Params$Resource$Projects$Locations$Reasoningengines$Operations$Get extends StandardParameters { /** - * Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number\}/locations/{location_id\}/persistentResources/{persistent_resource_id\}` + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Persistentresources$List + export interface Params$Resource$Projects$Locations$Reasoningengines$Operations$List extends StandardParameters { /** - * Optional. The standard list page size. - */ - pageSize?: number; - /** - * Optional. The standard list page token. Typically obtained via ListPersistentResourcesResponse.next_page_token of the previous PersistentResourceService.ListPersistentResource call. + * The standard list filter. */ - pageToken?: string; + filter?: string; /** - * Required. The resource name of the Location to list the PersistentResources from. Format: `projects/{project\}/locations/{location\}` + * The name of the operation's parent resource. */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Persistentresources$Patch - extends StandardParameters { + name?: string; /** - * Immutable. Resource name of a PersistentResource. + * The standard list page size. */ - name?: string; + pageSize?: number; /** - * Required. Specify the fields to be overwritten in the PersistentResource by the update method. + * The standard list page token. */ - updateMask?: string; - + pageToken?: string; /** - * Request body metadata + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - requestBody?: Schema$GoogleCloudAiplatformV1PersistentResource; + returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Persistentresources$Reboot + export interface Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait extends StandardParameters { /** - * Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number\}/locations/{location_id\}/persistentResources/{persistent_resource_id\}` + * The name of the operation resource to wait on. */ name?: string; - /** - * Request body metadata + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - requestBody?: Schema$GoogleCloudAiplatformV1RebootPersistentResourceRequest; + timeout?: string; } - export class Resource$Projects$Locations$Persistentresources$Operations { + export class Resource$Projects$Locations$Schedules { context: APIRequestContext; + operations: Resource$Projects$Locations$Schedules$Operations; constructor(context: APIRequestContext) { this.context = context; + this.operations = new Resource$Projects$Locations$Schedules$Operations( + this.context + ); } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Creates a Schedule. * @example * ```js * // Before running the sample: @@ -98340,15 +134498,60 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.persistentResources.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/persistentResources/my-persistentResource/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.schedules.create({ + * // Required. The resource name of the Location to create the Schedule in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "allowQueueing": false, + * // "catchUp": false, + * // "createNotebookExecutionJobRequest": {}, + * // "createPipelineJobRequest": {}, + * // "createTime": "my_createTime", + * // "cron": "my_cron", + * // "displayName": "my_displayName", + * // "endTime": "my_endTime", + * // "lastPauseTime": "my_lastPauseTime", + * // "lastResumeTime": "my_lastResumeTime", + * // "lastScheduledRunResponse": {}, + * // "maxConcurrentRunCount": "my_maxConcurrentRunCount", + * // "maxRunCount": "my_maxRunCount", + * // "name": "my_name", + * // "nextRunTime": "my_nextRunTime", + * // "startTime": "my_startTime", + * // "startedRunCount": "my_startedRunCount", + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "allowQueueing": false, + * // "catchUp": false, + * // "createNotebookExecutionJobRequest": {}, + * // "createPipelineJobRequest": {}, + * // "createTime": "my_createTime", + * // "cron": "my_cron", + * // "displayName": "my_displayName", + * // "endTime": "my_endTime", + * // "lastPauseTime": "my_lastPauseTime", + * // "lastResumeTime": "my_lastResumeTime", + * // "lastScheduledRunResponse": {}, + * // "maxConcurrentRunCount": "my_maxConcurrentRunCount", + * // "maxRunCount": "my_maxRunCount", + * // "name": "my_name", + * // "nextRunTime": "my_nextRunTime", + * // "startTime": "my_startTime", + * // "startedRunCount": "my_startedRunCount", + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } * } * * main().catch(e => { @@ -98363,54 +134566,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel, + create( + params: Params$Resource$Projects$Locations$Schedules$Create, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel, + create( + params?: Params$Resource$Projects$Locations$Schedules$Create, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Schedules$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Schedules$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Schedules$Create, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Schedules$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Schedules$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel; + params = {} as Params$Resource$Projects$Locations$Schedules$Create; options = {}; } @@ -98423,29 +134629,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/schedules').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Deletes a Schedule. * @example * ```js * // Before running the sample: @@ -98474,15 +134685,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.persistentResources.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/persistentResources/my-persistentResource/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.schedules.delete({ + * // Required. The name of the Schedule resource to be deleted. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` + * name: 'projects/my-project/locations/my-location/schedules/my-schedule', + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -98498,53 +134714,56 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Delete, + params: Params$Resource$Projects$Locations$Schedules$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Persistentresources$Operations$Delete, + params?: Params$Resource$Projects$Locations$Schedules$Delete, options?: MethodOptions - ): Promise>; + ): Promise>; delete( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Delete, + params: Params$Resource$Projects$Locations$Schedules$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Schedules$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Schedules$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Persistentresources$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Schedules$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Persistentresources$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Schedules$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Persistentresources$Operations$Delete; + params = {} as Params$Resource$Projects$Locations$Schedules$Delete; options = {}; } @@ -98569,17 +134788,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Gets a Schedule. * @example * ```js * // Before running the sample: @@ -98608,20 +134827,33 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.persistentResources.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/persistentResources/my-persistentResource/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.schedules.get({ + * // Required. The name of the Schedule resource. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` + * name: 'projects/my-project/locations/my-location/schedules/my-schedule', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "allowQueueing": false, + * // "catchUp": false, + * // "createNotebookExecutionJobRequest": {}, + * // "createPipelineJobRequest": {}, + * // "createTime": "my_createTime", + * // "cron": "my_cron", + * // "displayName": "my_displayName", + * // "endTime": "my_endTime", + * // "lastPauseTime": "my_lastPauseTime", + * // "lastResumeTime": "my_lastResumeTime", + * // "lastScheduledRunResponse": {}, + * // "maxConcurrentRunCount": "my_maxConcurrentRunCount", + * // "maxRunCount": "my_maxRunCount", * // "name": "my_name", - * // "response": {} + * // "nextRunTime": "my_nextRunTime", + * // "startTime": "my_startTime", + * // "startedRunCount": "my_startedRunCount", + * // "state": "my_state", + * // "updateTime": "my_updateTime" * // } * } * @@ -98638,57 +134870,56 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Get, + params: Params$Resource$Projects$Locations$Schedules$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Persistentresources$Operations$Get, + params?: Params$Resource$Projects$Locations$Schedules$Get, options?: MethodOptions - ): Promise>; + ): Promise>; get( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Get, + params: Params$Resource$Projects$Locations$Schedules$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Get, + params: Params$Resource$Projects$Locations$Schedules$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Schedules$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Persistentresources$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Schedules$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Persistentresources$Operations$Get; + {}) as Params$Resource$Projects$Locations$Schedules$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Persistentresources$Operations$Get; + params = {} as Params$Resource$Projects$Locations$Schedules$Get; options = {}; } @@ -98713,17 +134944,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Lists Schedules in a Location. * @example * ```js * // Before running the sample: @@ -98752,26 +134985,24 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.persistentResources.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/persistentResources/my-persistentResource', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * const res = await aiplatform.projects.locations.schedules.list({ + * // Lists the Schedules that match the filter expression. The following fields are supported: * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `state`: Supports `=` and `!=` comparisons. * `request`: Supports existence of the check. (e.g. `create_pipeline_job_request:*` --\> Schedule has create_pipeline_job_request). * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `start_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, `\>=` comparisons and `:*` existence check. Values must be in RFC 3339 format. * `next_run_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. Filter expressions can be combined together using logical operators (`NOT`, `AND` & `OR`). The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `state="ACTIVE" AND display_name:"my_schedule_*"` * `NOT display_name="my_schedule"` * `create_time\>"2021-05-18T00:00:00Z"` * `end_time\>"2021-05-18T00:00:00Z" OR NOT end_time:*` * `create_pipeline_job_request:*` + * filter: 'placeholder-value', + * // A comma-separated list of fields to order by. The default sort order is in ascending order. Use "desc" after a field name for descending. You can have multiple order_by fields provided. For example, using "create_time desc, end_time" will order results by create time in descending order, and if there are multiple schedules having the same create time, order them by the end time in ascending order. If order_by is not specified, it will order by default with create_time in descending order. Supported fields: * `create_time` * `start_time` * `end_time` * `next_run_time` + * orderBy: 'placeholder-value', + * // The standard list page size. Default to 100 if not specified. + * pageSize: 'placeholder-value', + * // The standard list page token. Typically obtained via ListSchedulesResponse.next_page_token of the previous ScheduleService.ListSchedules call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location to list the Schedules from. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "schedules": [] * // } * } * @@ -98788,61 +135019,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$List, + params: Params$Resource$Projects$Locations$Schedules$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Persistentresources$Operations$List, + params?: Params$Resource$Projects$Locations$Schedules$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$List, + params: Params$Resource$Projects$Locations$Schedules$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$List, + params: Params$Resource$Projects$Locations$Schedules$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$List, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Schedules$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Persistentresources$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Schedules$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Persistentresources$Operations$List; + {}) as Params$Resource$Projects$Locations$Schedules$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Persistentresources$Operations$List; + params = {} as Params$Resource$Projects$Locations$Schedules$List; options = {}; } @@ -98855,7 +135085,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+parent}/schedules').replace( /([^:]\/)\/+/g, '$1' ), @@ -98865,24 +135095,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Updates an active or paused Schedule. When the Schedule is updated, new runs will be scheduled starting from the updated next execution time after the update time based on the time_specification in the updated Schedule. All unstarted runs before the update time will be skipped while already created runs will NOT be paused or canceled. * @example * ```js * // Before running the sample: @@ -98911,22 +135141,61 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.persistentResources.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/persistentResources/my-persistentResource/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); + * const res = await aiplatform.projects.locations.schedules.patch({ + * // Immutable. The resource name of the Schedule. + * name: 'projects/my-project/locations/my-location/schedules/my-schedule', + * // Required. The update mask applies to the resource. See google.protobuf.FieldMask. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "allowQueueing": false, + * // "catchUp": false, + * // "createNotebookExecutionJobRequest": {}, + * // "createPipelineJobRequest": {}, + * // "createTime": "my_createTime", + * // "cron": "my_cron", + * // "displayName": "my_displayName", + * // "endTime": "my_endTime", + * // "lastPauseTime": "my_lastPauseTime", + * // "lastResumeTime": "my_lastResumeTime", + * // "lastScheduledRunResponse": {}, + * // "maxConcurrentRunCount": "my_maxConcurrentRunCount", + * // "maxRunCount": "my_maxRunCount", + * // "name": "my_name", + * // "nextRunTime": "my_nextRunTime", + * // "startTime": "my_startTime", + * // "startedRunCount": "my_startedRunCount", + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "allowQueueing": false, + * // "catchUp": false, + * // "createNotebookExecutionJobRequest": {}, + * // "createPipelineJobRequest": {}, + * // "createTime": "my_createTime", + * // "cron": "my_cron", + * // "displayName": "my_displayName", + * // "endTime": "my_endTime", + * // "lastPauseTime": "my_lastPauseTime", + * // "lastResumeTime": "my_lastResumeTime", + * // "lastScheduledRunResponse": {}, + * // "maxConcurrentRunCount": "my_maxConcurrentRunCount", + * // "maxRunCount": "my_maxRunCount", * // "name": "my_name", - * // "response": {} + * // "nextRunTime": "my_nextRunTime", + * // "startTime": "my_startTime", + * // "startedRunCount": "my_startedRunCount", + * // "state": "my_state", + * // "updateTime": "my_updateTime" * // } * } * @@ -98942,58 +135211,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Wait, + patch( + params: Params$Resource$Projects$Locations$Schedules$Patch, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Persistentresources$Operations$Wait, + patch( + params?: Params$Resource$Projects$Locations$Schedules$Patch, options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Wait, + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Schedules$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Wait, + patch( + params: Params$Resource$Projects$Locations$Schedules$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Wait, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Schedules$Patch, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - wait( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Persistentresources$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Schedules$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Persistentresources$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Schedules$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Persistentresources$Operations$Wait; + params = {} as Params$Resource$Projects$Locations$Schedules$Patch; options = {}; } @@ -99006,8 +135274,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -99018,84 +135286,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel - extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Persistentresources$Operations$Delete - extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Persistentresources$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Persistentresources$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Locations$Persistentresources$Operations$Wait - extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Pipelinejobs { - context: APIRequestContext; - operations: Resource$Projects$Locations$Pipelinejobs$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = new Resource$Projects$Locations$Pipelinejobs$Operations( - this.context - ); - } /** - * Batch cancel PipelineJobs. Firstly the server will check if all the jobs are in non-terminal states, and skip the jobs that are already terminated. If the operation failed, none of the pipeline jobs are cancelled. The server will poll the states of all the pipeline jobs periodically to check the cancellation status. This operation will return an LRO. + * Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled. * @example * ```js * // Before running the sample: @@ -99124,28 +135327,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.pipelineJobs.batchCancel({ - * // Required. The name of the PipelineJobs' parent resource. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * const res = await aiplatform.projects.locations.schedules.pause({ + * // Required. The name of the Schedule resource to be paused. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` + * name: 'projects/my-project/locations/my-location/schedules/my-schedule', * * // Request body metadata * requestBody: { * // request body parameters - * // { - * // "names": [] - * // } + * // {} * }, * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -99160,58 +135355,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchCancel( - params: Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel, + pause( + params: Params$Resource$Projects$Locations$Schedules$Pause, options: StreamMethodOptions ): Promise>; - batchCancel( - params?: Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel, + pause( + params?: Params$Resource$Projects$Locations$Schedules$Pause, options?: MethodOptions - ): Promise>; - batchCancel( - params: Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel, + ): Promise>; + pause( + params: Params$Resource$Projects$Locations$Schedules$Pause, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchCancel( - params: Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - batchCancel( - params: Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel, - callback: BodyResponseCallback + pause( + params: Params$Resource$Projects$Locations$Schedules$Pause, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchCancel( - callback: BodyResponseCallback + pause( + params: Params$Resource$Projects$Locations$Schedules$Pause, + callback: BodyResponseCallback ): void; - batchCancel( + pause(callback: BodyResponseCallback): void; + pause( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Schedules$Pause + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel; + {}) as Params$Resource$Projects$Locations$Schedules$Pause; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel; + params = {} as Params$Resource$Projects$Locations$Schedules$Pause; options = {}; } @@ -99224,32 +135414,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/pipelineJobs:batchCancel').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:pause').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Batch deletes PipelineJobs The Operation is atomic. If it fails, none of the PipelineJobs are deleted. If it succeeds, all of the PipelineJobs are deleted. + * Resumes a paused Schedule to start scheduling new runs. Will mark Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed. When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If Schedule.catch_up is set up true, all missed runs will be scheduled for backfill first. * @example * ```js * // Before running the sample: @@ -99278,28 +135465,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.pipelineJobs.batchDelete({ - * // Required. The name of the PipelineJobs' parent resource. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * const res = await aiplatform.projects.locations.schedules.resume({ + * // Required. The name of the Schedule resource to be resumed. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` + * name: 'projects/my-project/locations/my-location/schedules/my-schedule', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "names": [] + * // "catchUp": false * // } * }, * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -99314,58 +135495,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchDelete( - params: Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete, + resume( + params: Params$Resource$Projects$Locations$Schedules$Resume, options: StreamMethodOptions ): Promise>; - batchDelete( - params?: Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete, + resume( + params?: Params$Resource$Projects$Locations$Schedules$Resume, options?: MethodOptions - ): Promise>; - batchDelete( - params: Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete, + ): Promise>; + resume( + params: Params$Resource$Projects$Locations$Schedules$Resume, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchDelete( - params: Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - batchDelete( - params: Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete, - callback: BodyResponseCallback + resume( + params: Params$Resource$Projects$Locations$Schedules$Resume, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchDelete( - callback: BodyResponseCallback + resume( + params: Params$Resource$Projects$Locations$Schedules$Resume, + callback: BodyResponseCallback ): void; - batchDelete( + resume(callback: BodyResponseCallback): void; + resume( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Schedules$Resume + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete; + {}) as Params$Resource$Projects$Locations$Schedules$Resume; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete; + params = {} as Params$Resource$Projects$Locations$Schedules$Resume; options = {}; } @@ -99378,32 +135554,126 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/pipelineJobs:batchDelete').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:resume').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Schedules$Create + extends StandardParameters { /** - * Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetPipelineJob or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it becomes a pipeline with a PipelineJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and PipelineJob.state is set to `CANCELLED`. + * Required. The resource name of the Location to create the Schedule in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Schedule; + } + export interface Params$Resource$Projects$Locations$Schedules$Delete + extends StandardParameters { + /** + * Required. The name of the Schedule resource to be deleted. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Schedules$Get + extends StandardParameters { + /** + * Required. The name of the Schedule resource. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Schedules$List + extends StandardParameters { + /** + * Lists the Schedules that match the filter expression. The following fields are supported: * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `state`: Supports `=` and `!=` comparisons. * `request`: Supports existence of the check. (e.g. `create_pipeline_job_request:*` --\> Schedule has create_pipeline_job_request). * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `start_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, `\>=` comparisons and `:*` existence check. Values must be in RFC 3339 format. * `next_run_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. Filter expressions can be combined together using logical operators (`NOT`, `AND` & `OR`). The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `state="ACTIVE" AND display_name:"my_schedule_*"` * `NOT display_name="my_schedule"` * `create_time\>"2021-05-18T00:00:00Z"` * `end_time\>"2021-05-18T00:00:00Z" OR NOT end_time:*` * `create_pipeline_job_request:*` + */ + filter?: string; + /** + * A comma-separated list of fields to order by. The default sort order is in ascending order. Use "desc" after a field name for descending. You can have multiple order_by fields provided. For example, using "create_time desc, end_time" will order results by create time in descending order, and if there are multiple schedules having the same create time, order them by the end time in ascending order. If order_by is not specified, it will order by default with create_time in descending order. Supported fields: * `create_time` * `start_time` * `end_time` * `next_run_time` + */ + orderBy?: string; + /** + * The standard list page size. Default to 100 if not specified. + */ + pageSize?: number; + /** + * The standard list page token. Typically obtained via ListSchedulesResponse.next_page_token of the previous ScheduleService.ListSchedules call. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list the Schedules from. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Schedules$Patch + extends StandardParameters { + /** + * Immutable. The resource name of the Schedule. + */ + name?: string; + /** + * Required. The update mask applies to the resource. See google.protobuf.FieldMask. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Schedule; + } + export interface Params$Resource$Projects$Locations$Schedules$Pause + extends StandardParameters { + /** + * Required. The name of the Schedule resource to be paused. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1PauseScheduleRequest; + } + export interface Params$Resource$Projects$Locations$Schedules$Resume + extends StandardParameters { + /** + * Required. The name of the Schedule resource to be resumed. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ResumeScheduleRequest; + } + + export class Resource$Projects$Locations$Schedules$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -99432,15 +135702,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.pipelineJobs.cancel({ - * // Required. The name of the PipelineJob to cancel. Format: `projects/{project\}/locations/{location\}/pipelineJobs/{pipeline_job\}` - * name: 'projects/my-project/locations/my-location/pipelineJobs/my-pipelineJob', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, + * const res = await aiplatform.projects.locations.schedules.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/schedules/my-schedule/operations/my-operation', * }); * console.log(res.data); * @@ -99461,31 +135725,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Pipelinejobs$Cancel, + params: Params$Resource$Projects$Locations$Schedules$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Pipelinejobs$Cancel, + params?: Params$Resource$Projects$Locations$Schedules$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Pipelinejobs$Cancel, + params: Params$Resource$Projects$Locations$Schedules$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Pipelinejobs$Cancel, + params: Params$Resource$Projects$Locations$Schedules$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Pipelinejobs$Cancel, + params: Params$Resource$Projects$Locations$Schedules$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pipelinejobs$Cancel + | Params$Resource$Projects$Locations$Schedules$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -99501,12 +135765,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pipelinejobs$Cancel; + {}) as Params$Resource$Projects$Locations$Schedules$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Pipelinejobs$Cancel; + params = + {} as Params$Resource$Projects$Locations$Schedules$Operations$Cancel; options = {}; } @@ -99541,7 +135806,7 @@ export namespace aiplatform_v1 { } /** - * Creates a PipelineJob. A PipelineJob will run immediately when created. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -99570,66 +135835,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.pipelineJobs.create({ - * // Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * // The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/a-z-/`. - * pipelineJobId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", - * // "error": {}, - * // "jobDetail": {}, - * // "labels": {}, - * // "name": "my_name", - * // "network": "my_network", - * // "pipelineSpec": {}, - * // "preflightValidations": false, - * // "pscInterfaceConfig": {}, - * // "reservedIpRanges": [], - * // "runtimeConfig": {}, - * // "scheduleName": "my_scheduleName", - * // "serviceAccount": "my_serviceAccount", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "templateMetadata": {}, - * // "templateUri": "my_templateUri", - * // "updateTime": "my_updateTime" - * // } - * }, + * const res = await aiplatform.projects.locations.schedules.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/schedules/my-schedule/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", - * // "error": {}, - * // "jobDetail": {}, - * // "labels": {}, - * // "name": "my_name", - * // "network": "my_network", - * // "pipelineSpec": {}, - * // "preflightValidations": false, - * // "pscInterfaceConfig": {}, - * // "reservedIpRanges": [], - * // "runtimeConfig": {}, - * // "scheduleName": "my_scheduleName", - * // "serviceAccount": "my_serviceAccount", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "templateMetadata": {}, - * // "templateUri": "my_templateUri", - * // "updateTime": "my_updateTime" - * // } + * // {} * } * * main().catch(e => { @@ -99644,61 +135857,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Pipelinejobs$Create, + delete( + params: Params$Resource$Projects$Locations$Schedules$Operations$Delete, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Pipelinejobs$Create, + delete( + params?: Params$Resource$Projects$Locations$Schedules$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - create( - params: Params$Resource$Projects$Locations$Pipelinejobs$Create, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Schedules$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Pipelinejobs$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Pipelinejobs$Create, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Schedules$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Schedules$Operations$Delete, + callback: BodyResponseCallback ): void; - create( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pipelinejobs$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Schedules$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pipelinejobs$Create; + {}) as Params$Resource$Projects$Locations$Schedules$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Pipelinejobs$Create; + params = + {} as Params$Resource$Projects$Locations$Schedules$Operations$Delete; options = {}; } @@ -99711,34 +135917,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/pipelineJobs').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes a PipelineJob. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -99767,9 +135968,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.pipelineJobs.delete({ - * // Required. The name of the PipelineJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/pipelineJobs/{pipeline_job\}` - * name: 'projects/my-project/locations/my-location/pipelineJobs/my-pipelineJob', + * const res = await aiplatform.projects.locations.schedules.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/schedules/my-schedule/operations/my-operation', * }); * console.log(res.data); * @@ -99795,36 +135996,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Pipelinejobs$Delete, + get( + params: Params$Resource$Projects$Locations$Schedules$Operations$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Pipelinejobs$Delete, + get( + params?: Params$Resource$Projects$Locations$Schedules$Operations$Get, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Pipelinejobs$Delete, + get( + params: Params$Resource$Projects$Locations$Schedules$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Pipelinejobs$Delete, + get( + params: Params$Resource$Projects$Locations$Schedules$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Pipelinejobs$Delete, + get( + params: Params$Resource$Projects$Locations$Schedules$Operations$Get, callback: BodyResponseCallback ): void; - delete( + get( callback: BodyResponseCallback ): void; - delete( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pipelinejobs$Delete + | Params$Resource$Projects$Locations$Schedules$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -99840,12 +136041,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pipelinejobs$Delete; + {}) as Params$Resource$Projects$Locations$Schedules$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Pipelinejobs$Delete; + params = + {} as Params$Resource$Projects$Locations$Schedules$Operations$Get; options = {}; } @@ -99859,7 +136061,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -99880,7 +136082,7 @@ export namespace aiplatform_v1 { } /** - * Gets a PipelineJob. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -99909,35 +136111,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.pipelineJobs.get({ - * // Required. The name of the PipelineJob resource. Format: `projects/{project\}/locations/{location\}/pipelineJobs/{pipeline_job\}` - * name: 'projects/my-project/locations/my-location/pipelineJobs/my-pipelineJob', + * const res = await aiplatform.projects.locations.schedules.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/schedules/my-schedule', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", - * // "error": {}, - * // "jobDetail": {}, - * // "labels": {}, - * // "name": "my_name", - * // "network": "my_network", - * // "pipelineSpec": {}, - * // "preflightValidations": false, - * // "pscInterfaceConfig": {}, - * // "reservedIpRanges": [], - * // "runtimeConfig": {}, - * // "scheduleName": "my_scheduleName", - * // "serviceAccount": "my_serviceAccount", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "templateMetadata": {}, - * // "templateUri": "my_templateUri", - * // "updateTime": "my_updateTime" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -99953,61 +136145,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Pipelinejobs$Get, + list( + params: Params$Resource$Projects$Locations$Schedules$Operations$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Pipelinejobs$Get, + list( + params?: Params$Resource$Projects$Locations$Schedules$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Pipelinejobs$Get, + list( + params: Params$Resource$Projects$Locations$Schedules$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Pipelinejobs$Get, + list( + params: Params$Resource$Projects$Locations$Schedules$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Pipelinejobs$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Schedules$Operations$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pipelinejobs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Schedules$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pipelinejobs$Get; + {}) as Params$Resource$Projects$Locations$Schedules$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Pipelinejobs$Get; + params = + {} as Params$Resource$Projects$Locations$Schedules$Operations$List; options = {}; } @@ -100020,7 +136213,10 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -100032,19 +136228,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists PipelineJobs in a Location. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -100073,26 +136269,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.pipelineJobs.list({ - * // Lists the PipelineJobs that match the filter expression. The following fields are supported: * `pipeline_name`: Supports `=` and `!=` comparisons. * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `pipeline_job_user_id`: Supports `=`, `!=` comparisons, and `:` wildcard. for example, can check if pipeline's display_name contains *step* by doing display_name:\"*step*\" * `state`: Supports `=` and `!=` comparisons. * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. * `template_uri`: Supports `=`, `!=` comparisons, and `:` wildcard. * `template_metadata.version`: Supports `=`, `!=` comparisons, and `:` wildcard. Filter expressions can be combined together using logical operators (`AND` & `OR`). For example: `pipeline_name="test" AND create_time\>"2020-05-18T13:30:00Z"`. The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `create_time\>"2021-05-18T00:00:00Z" OR update_time\>"2020-05-18T00:00:00Z"` PipelineJobs created or updated after 2020-05-18 00:00:00 UTC. * `labels.env = "prod"` PipelineJobs with label "env" set to "prod". - * filter: 'placeholder-value', - * // A comma-separated list of fields to order by. The default sort order is in ascending order. Use "desc" after a field name for descending. You can have multiple order_by fields provided e.g. "create_time desc, end_time", "end_time, start_time, update_time" For example, using "create_time desc, end_time" will order results by create time in descending order, and if there are multiple jobs having the same create time, order them by the end time in ascending order. if order_by is not specified, it will order by default order is create time in descending order. Supported fields: * `create_time` * `update_time` * `end_time` * `start_time` - * orderBy: 'placeholder-value', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. Typically obtained via ListPipelineJobsResponse.next_page_token of the previous PipelineService.ListPipelineJobs call. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list the PipelineJobs from. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', + * const res = await aiplatform.projects.locations.schedules.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/schedules/my-schedule/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "pipelineJobs": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -100108,61 +136299,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Pipelinejobs$List, + wait( + params: Params$Resource$Projects$Locations$Schedules$Operations$Wait, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Pipelinejobs$List, + wait( + params?: Params$Resource$Projects$Locations$Schedules$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Pipelinejobs$List, + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Schedules$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Pipelinejobs$List, + wait( + params: Params$Resource$Projects$Locations$Schedules$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Pipelinejobs$List, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Schedules$Operations$Wait, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - list( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pipelinejobs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Schedules$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pipelinejobs$List; + {}) as Params$Resource$Projects$Locations$Schedules$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Pipelinejobs$List; + params = + {} as Params$Resource$Projects$Locations$Schedules$Operations$Wait; options = {}; } @@ -100175,135 +136363,97 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/pipelineJobs').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel - extends StandardParameters { - /** - * Required. The name of the PipelineJobs' parent resource. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest; - } - export interface Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete - extends StandardParameters { - /** - * Required. The name of the PipelineJobs' parent resource. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest; - } - export interface Params$Resource$Projects$Locations$Pipelinejobs$Cancel + export interface Params$Resource$Projects$Locations$Schedules$Operations$Cancel extends StandardParameters { /** - * Required. The name of the PipelineJob to cancel. Format: `projects/{project\}/locations/{location\}/pipelineJobs/{pipeline_job\}` + * The name of the operation resource to be cancelled. */ name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1CancelPipelineJobRequest; - } - export interface Params$Resource$Projects$Locations$Pipelinejobs$Create - extends StandardParameters { - /** - * Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - /** - * The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/a-z-/`. - */ - pipelineJobId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1PipelineJob; } - export interface Params$Resource$Projects$Locations$Pipelinejobs$Delete + export interface Params$Resource$Projects$Locations$Schedules$Operations$Delete extends StandardParameters { /** - * Required. The name of the PipelineJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/pipelineJobs/{pipeline_job\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Pipelinejobs$Get + export interface Params$Resource$Projects$Locations$Schedules$Operations$Get extends StandardParameters { /** - * Required. The name of the PipelineJob resource. Format: `projects/{project\}/locations/{location\}/pipelineJobs/{pipeline_job\}` + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Pipelinejobs$List + export interface Params$Resource$Projects$Locations$Schedules$Operations$List extends StandardParameters { /** - * Lists the PipelineJobs that match the filter expression. The following fields are supported: * `pipeline_name`: Supports `=` and `!=` comparisons. * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `pipeline_job_user_id`: Supports `=`, `!=` comparisons, and `:` wildcard. for example, can check if pipeline's display_name contains *step* by doing display_name:\"*step*\" * `state`: Supports `=` and `!=` comparisons. * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. * `template_uri`: Supports `=`, `!=` comparisons, and `:` wildcard. * `template_metadata.version`: Supports `=`, `!=` comparisons, and `:` wildcard. Filter expressions can be combined together using logical operators (`AND` & `OR`). For example: `pipeline_name="test" AND create_time\>"2020-05-18T13:30:00Z"`. The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `create_time\>"2021-05-18T00:00:00Z" OR update_time\>"2020-05-18T00:00:00Z"` PipelineJobs created or updated after 2020-05-18 00:00:00 UTC. * `labels.env = "prod"` PipelineJobs with label "env" set to "prod". + * The standard list filter. */ filter?: string; /** - * A comma-separated list of fields to order by. The default sort order is in ascending order. Use "desc" after a field name for descending. You can have multiple order_by fields provided e.g. "create_time desc, end_time", "end_time, start_time, update_time" For example, using "create_time desc, end_time" will order results by create time in descending order, and if there are multiple jobs having the same create time, order them by the end time in ascending order. if order_by is not specified, it will order by default order is create time in descending order. Supported fields: * `create_time` * `update_time` * `end_time` * `start_time` + * The name of the operation's parent resource. */ - orderBy?: string; + name?: string; /** * The standard list page size. */ pageSize?: number; /** - * The standard list page token. Typically obtained via ListPipelineJobsResponse.next_page_token of the previous PipelineService.ListPipelineJobs call. + * The standard list page token. */ pageToken?: string; /** - * Required. The resource name of the Location to list the PipelineJobs from. Format: `projects/{project\}/locations/{location\}` + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - parent?: string; + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Schedules$Operations$Wait + extends StandardParameters { /** - * Mask specifying which fields to read. + * The name of the operation resource to wait on. */ - readMask?: string; + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; } - export class Resource$Projects$Locations$Pipelinejobs$Operations { + export class Resource$Projects$Locations$Specialistpools { context: APIRequestContext; + operations: Resource$Projects$Locations$Specialistpools$Operations; constructor(context: APIRequestContext) { this.context = context; + this.operations = + new Resource$Projects$Locations$Specialistpools$Operations( + this.context + ); } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Creates a SpecialistPool. * @example * ```js * // Before running the sample: @@ -100332,15 +136482,33 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.pipelineJobs.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/pipelineJobs/my-pipelineJob/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.specialistPools.create({ + * // Required. The parent Project name for the new SpecialistPool. The form is `projects/{project\}/locations/{location\}`. + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "displayName": "my_displayName", + * // "name": "my_name", + * // "pendingDataLabelingJobs": [], + * // "specialistManagerEmails": [], + * // "specialistManagersCount": 0, + * // "specialistWorkerEmails": [] + * // } + * }, + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -100355,54 +136523,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel, + create( + params: Params$Resource$Projects$Locations$Specialistpools$Create, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel, + create( + params?: Params$Resource$Projects$Locations$Specialistpools$Create, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Specialistpools$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Specialistpools$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Specialistpools$Create, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel, - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Specialistpools$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Specialistpools$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Specialistpools$Create; options = {}; } @@ -100415,29 +136587,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/specialistPools').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Deletes a SpecialistPool as well as all Specialists in the pool. * @example * ```js * // Before running the sample: @@ -100466,15 +136641,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.pipelineJobs.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/pipelineJobs/my-pipelineJob/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.specialistPools.delete({ + * // If set to true, any specialist managers in this SpecialistPool will also be deleted. (Otherwise, the request will only work if the SpecialistPool has no specialist managers.) + * force: 'placeholder-value', + * // Required. The resource name of the SpecialistPool to delete. Format: `projects/{project\}/locations/{location\}/specialistPools/{specialist_pool\}` + * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool', + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -100490,53 +136672,57 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Specialistpools$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete, + params?: Params$Resource$Projects$Locations$Specialistpools$Delete, options?: MethodOptions - ): Promise>; + ): Promise>; delete( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Specialistpools$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Specialistpools$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Specialistpools$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Specialistpools$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Specialistpools$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete; + {} as Params$Resource$Projects$Locations$Specialistpools$Delete; options = {}; } @@ -100561,17 +136747,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Gets a SpecialistPool. * @example * ```js * // Before running the sample: @@ -100600,19 +136786,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.pipelineJobs.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/pipelineJobs/my-pipelineJob/operations/my-operation', + * const res = await aiplatform.projects.locations.specialistPools.get({ + * // Required. The name of the SpecialistPool resource. The form is `projects/{project\}/locations/{location\}/specialistPools/{specialist_pool\}`. + * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "displayName": "my_displayName", * // "name": "my_name", - * // "response": {} + * // "pendingDataLabelingJobs": [], + * // "specialistManagerEmails": [], + * // "specialistManagersCount": 0, + * // "specialistWorkerEmails": [] * // } * } * @@ -100629,57 +136816,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get, + params: Params$Resource$Projects$Locations$Specialistpools$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get, + params?: Params$Resource$Projects$Locations$Specialistpools$Get, options?: MethodOptions - ): Promise>; + ): Promise< + GaxiosResponseWithHTTP2 + >; get( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get, + params: Params$Resource$Projects$Locations$Specialistpools$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get, + params: Params$Resource$Projects$Locations$Specialistpools$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Specialistpools$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Specialistpools$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get; + {}) as Params$Resource$Projects$Locations$Specialistpools$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get; + params = {} as Params$Resource$Projects$Locations$Specialistpools$Get; options = {}; } @@ -100704,17 +136894,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Lists SpecialistPools in a Location. * @example * ```js * // Before running the sample: @@ -100743,25 +136935,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.pipelineJobs.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/pipelineJobs/my-pipelineJob', + * const res = await aiplatform.projects.locations.specialistPools.list({ * // The standard list page size. * pageSize: 'placeholder-value', - * // The standard list page token. + * // The standard list page token. Typically obtained by ListSpecialistPoolsResponse.next_page_token of the previous SpecialistPoolService.ListSpecialistPools call. Return first page if empty. * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', + * // Required. The name of the SpecialistPool's parent resource. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // Mask specifying which fields to read. FieldMask represents a set of + * readMask: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "specialistPools": [] * // } * } * @@ -100778,61 +136967,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$List, + params: Params$Resource$Projects$Locations$Specialistpools$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Pipelinejobs$Operations$List, + params?: Params$Resource$Projects$Locations$Specialistpools$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$List, + params: Params$Resource$Projects$Locations$Specialistpools$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$List, + params: Params$Resource$Projects$Locations$Specialistpools$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Specialistpools$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pipelinejobs$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Specialistpools$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pipelinejobs$Operations$List; + {}) as Params$Resource$Projects$Locations$Specialistpools$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Pipelinejobs$Operations$List; + params = {} as Params$Resource$Projects$Locations$Specialistpools$List; options = {}; } @@ -100845,7 +137033,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+parent}/specialistPools').replace( /([^:]\/)\/+/g, '$1' ), @@ -100855,24 +137043,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Updates a SpecialistPool. * @example * ```js * // Before running the sample: @@ -100901,11 +137089,24 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.pipelineJobs.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/pipelineJobs/my-pipelineJob/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', + * const res = await aiplatform.projects.locations.specialistPools.patch({ + * // Required. The resource name of the SpecialistPool. + * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool', + * // Required. The update mask applies to the resource. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "displayName": "my_displayName", + * // "name": "my_name", + * // "pendingDataLabelingJobs": [], + * // "specialistManagerEmails": [], + * // "specialistManagersCount": 0, + * // "specialistWorkerEmails": [] + * // } + * }, * }); * console.log(res.data); * @@ -100931,36 +137132,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait, + patch( + params: Params$Resource$Projects$Locations$Specialistpools$Patch, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait, + patch( + params?: Params$Resource$Projects$Locations$Specialistpools$Patch, options?: MethodOptions ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait, + patch( + params: Params$Resource$Projects$Locations$Specialistpools$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait, + patch( + params: Params$Resource$Projects$Locations$Specialistpools$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait, + patch( + params: Params$Resource$Projects$Locations$Specialistpools$Patch, callback: BodyResponseCallback ): void; - wait( + patch( callback: BodyResponseCallback ): void; - wait( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait + | Params$Resource$Projects$Locations$Specialistpools$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -100976,13 +137177,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Specialistpools$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait; + params = {} as Params$Resource$Projects$Locations$Specialistpools$Patch; options = {}; } @@ -100995,8 +137195,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -101017,81 +137217,80 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel + export interface Params$Resource$Projects$Locations$Specialistpools$Create extends StandardParameters { /** - * The name of the operation resource to be cancelled. + * Required. The parent Project name for the new SpecialistPool. The form is `projects/{project\}/locations/{location\}`. */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete - extends StandardParameters { + parent?: string; + /** - * The name of the operation resource to be deleted. + * Request body metadata */ - name?: string; + requestBody?: Schema$GoogleCloudAiplatformV1SpecialistPool; } - export interface Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get + export interface Params$Resource$Projects$Locations$Specialistpools$Delete extends StandardParameters { /** - * The name of the operation resource. + * If set to true, any specialist managers in this SpecialistPool will also be deleted. (Otherwise, the request will only work if the SpecialistPool has no specialist managers.) + */ + force?: boolean; + /** + * Required. The resource name of the SpecialistPool to delete. Format: `projects/{project\}/locations/{location\}/specialistPools/{specialist_pool\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Pipelinejobs$Operations$List + export interface Params$Resource$Projects$Locations$Specialistpools$Get extends StandardParameters { /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. + * Required. The name of the SpecialistPool resource. The form is `projects/{project\}/locations/{location\}/specialistPools/{specialist_pool\}`. */ name?: string; + } + export interface Params$Resource$Projects$Locations$Specialistpools$List + extends StandardParameters { /** * The standard list page size. */ pageSize?: number; /** - * The standard list page token. + * The standard list page token. Typically obtained by ListSpecialistPoolsResponse.next_page_token of the previous SpecialistPoolService.ListSpecialistPools call. Return first page if empty. */ pageToken?: string; /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * Required. The name of the SpecialistPool's parent resource. Format: `projects/{project\}/locations/{location\}` */ - returnPartialSuccess?: boolean; + parent?: string; + /** + * Mask specifying which fields to read. FieldMask represents a set of + */ + readMask?: string; } - export interface Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait + export interface Params$Resource$Projects$Locations$Specialistpools$Patch extends StandardParameters { /** - * The name of the operation resource to wait on. + * Required. The resource name of the SpecialistPool. */ name?: string; /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * Required. The update mask applies to the resource. */ - timeout?: string; - } + updateMask?: string; - export class Resource$Projects$Locations$Publishers { - context: APIRequestContext; - models: Resource$Projects$Locations$Publishers$Models; - constructor(context: APIRequestContext) { - this.context = context; - this.models = new Resource$Projects$Locations$Publishers$Models( - this.context - ); - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1SpecialistPool; } - export class Resource$Projects$Locations$Publishers$Models { + export class Resource$Projects$Locations$Specialistpools$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Return a list of tokens based on the input text. + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -101121,27 +137320,14 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.publishers.models.computeTokens({ - * // Required. The name of the Endpoint requested to get lists of tokens and token ids. - * endpoint: - * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "contents": [], - * // "instances": [], - * // "model": "my_model" - * // } - * }, + * await aiplatform.projects.locations.specialistPools.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "tokensInfo": [] - * // } + * // {} * } * * main().catch(e => { @@ -101156,62 +137342,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - computeTokens( - params: Params$Resource$Projects$Locations$Publishers$Models$Computetokens, + cancel( + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel, options: StreamMethodOptions ): Promise>; - computeTokens( - params?: Params$Resource$Projects$Locations$Publishers$Models$Computetokens, + cancel( + params?: Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - computeTokens( - params: Params$Resource$Projects$Locations$Publishers$Models$Computetokens, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - computeTokens( - params: Params$Resource$Projects$Locations$Publishers$Models$Computetokens, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - computeTokens( - params: Params$Resource$Projects$Locations$Publishers$Models$Computetokens, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - computeTokens( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel, + callback: BodyResponseCallback ): void; - computeTokens( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Publishers$Models$Computetokens - | BodyResponseCallback + | Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Publishers$Models$Computetokens; + {}) as Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Publishers$Models$Computetokens; + {} as Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel; options = {}; } @@ -101224,34 +137402,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:computeTokens').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Perform a token counting. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -101280,34 +137453,15 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.publishers.models.countTokens( - * { - * // Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: - * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "contents": [], - * // "generationConfig": {}, - * // "instances": [], - * // "model": "my_model", - * // "systemInstruction": {}, - * // "tools": [] - * // } - * }, - * }, - * ); + * const res = + * await aiplatform.projects.locations.specialistPools.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "promptTokensDetails": [], - * // "totalBillableCharacters": 0, - * // "totalTokens": 0 - * // } + * // {} * } * * main().catch(e => { @@ -101322,62 +137476,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - countTokens( - params: Params$Resource$Projects$Locations$Publishers$Models$Counttokens, + delete( + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Delete, options: StreamMethodOptions ): Promise>; - countTokens( - params?: Params$Resource$Projects$Locations$Publishers$Models$Counttokens, + delete( + params?: Params$Resource$Projects$Locations$Specialistpools$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - countTokens( - params: Params$Resource$Projects$Locations$Publishers$Models$Counttokens, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - countTokens( - params: Params$Resource$Projects$Locations$Publishers$Models$Counttokens, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - countTokens( - params: Params$Resource$Projects$Locations$Publishers$Models$Counttokens, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - countTokens( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Delete, + callback: BodyResponseCallback ): void; - countTokens( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Publishers$Models$Counttokens - | BodyResponseCallback + | Params$Resource$Projects$Locations$Specialistpools$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Publishers$Models$Counttokens; + {}) as Params$Resource$Projects$Locations$Specialistpools$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Publishers$Models$Counttokens; + {} as Params$Resource$Projects$Locations$Specialistpools$Operations$Delete; options = {}; } @@ -101390,34 +137536,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:countTokens').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Fetch an asynchronous online prediction operation. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -101438,10 +137579,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -101450,21 +137588,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.publishers.models.fetchPredictOperation( - * { - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` - * endpoint: - * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "operationName": "my_operationName" - * // } - * }, - * }, - * ); + * await aiplatform.projects.locations.specialistPools.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -101489,36 +137616,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - fetchPredictOperation( - params: Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation, + get( + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Get, options: StreamMethodOptions ): Promise>; - fetchPredictOperation( - params?: Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation, + get( + params?: Params$Resource$Projects$Locations$Specialistpools$Operations$Get, options?: MethodOptions ): Promise>; - fetchPredictOperation( - params: Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation, + get( + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - fetchPredictOperation( - params: Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation, + get( + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - fetchPredictOperation( - params: Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation, + get( + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Get, callback: BodyResponseCallback ): void; - fetchPredictOperation( + get( callback: BodyResponseCallback ): void; - fetchPredictOperation( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation + | Params$Resource$Projects$Locations$Specialistpools$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -101534,13 +137661,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation; + {}) as Params$Resource$Projects$Locations$Specialistpools$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation; + {} as Params$Resource$Projects$Locations$Specialistpools$Operations$Get; options = {}; } @@ -101553,18 +137680,15 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:fetchPredictOperation').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -101578,7 +137702,7 @@ export namespace aiplatform_v1 { } /** - * Generate content with multimodal inputs. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -101599,10 +137723,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -101611,37 +137732,25 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.publishers.models.generateContent({ - * // Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * model: - * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "cachedContent": "my_cachedContent", - * // "contents": [], - * // "generationConfig": {}, - * // "labels": {}, - * // "modelArmorConfig": {}, - * // "safetySettings": [], - * // "systemInstruction": {}, - * // "toolConfig": {}, - * // "tools": [] - * // } - * }, + * await aiplatform.projects.locations.specialistPools.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "candidates": [], - * // "createTime": "my_createTime", - * // "modelVersion": "my_modelVersion", - * // "promptFeedback": {}, - * // "responseId": "my_responseId", - * // "usageMetadata": {} + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -101657,62 +137766,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - generateContent( - params: Params$Resource$Projects$Locations$Publishers$Models$Generatecontent, + list( + params: Params$Resource$Projects$Locations$Specialistpools$Operations$List, options: StreamMethodOptions ): Promise>; - generateContent( - params?: Params$Resource$Projects$Locations$Publishers$Models$Generatecontent, + list( + params?: Params$Resource$Projects$Locations$Specialistpools$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - generateContent( - params: Params$Resource$Projects$Locations$Publishers$Models$Generatecontent, + list( + params: Params$Resource$Projects$Locations$Specialistpools$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - generateContent( - params: Params$Resource$Projects$Locations$Publishers$Models$Generatecontent, + list( + params: Params$Resource$Projects$Locations$Specialistpools$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - generateContent( - params: Params$Resource$Projects$Locations$Publishers$Models$Generatecontent, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Specialistpools$Operations$List, + callback: BodyResponseCallback ): void; - generateContent( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - generateContent( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Publishers$Models$Generatecontent - | BodyResponseCallback + | Params$Resource$Projects$Locations$Specialistpools$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Publishers$Models$Generatecontent; + {}) as Params$Resource$Projects$Locations$Specialistpools$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Publishers$Models$Generatecontent; + {} as Params$Resource$Projects$Locations$Specialistpools$Operations$List; options = {}; } @@ -101725,34 +137834,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+model}:generateContent').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['model'], - pathParams: ['model'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Perform an online prediction. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -101773,10 +137882,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -101784,30 +137890,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.publishers.models.predict({ - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: - * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "instances": [], - * // "parameters": {} - * // } - * }, - * }); + * const res = + * await aiplatform.projects.locations.specialistPools.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "deployedModelId": "my_deployedModelId", + * // "done": false, + * // "error": {}, * // "metadata": {}, - * // "model": "my_model", - * // "modelDisplayName": "my_modelDisplayName", - * // "modelVersionId": "my_modelVersionId", - * // "predictions": [] + * // "name": "my_name", + * // "response": {} * // } * } * @@ -101823,62 +137921,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - predict( - params: Params$Resource$Projects$Locations$Publishers$Models$Predict, + wait( + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Wait, options: StreamMethodOptions ): Promise>; - predict( - params?: Params$Resource$Projects$Locations$Publishers$Models$Predict, + wait( + params?: Params$Resource$Projects$Locations$Specialistpools$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - predict( - params: Params$Resource$Projects$Locations$Publishers$Models$Predict, + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - predict( - params: Params$Resource$Projects$Locations$Publishers$Models$Predict, + wait( + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - predict( - params: Params$Resource$Projects$Locations$Publishers$Models$Predict, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Wait, + callback: BodyResponseCallback ): void; - predict( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - predict( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Publishers$Models$Predict - | BodyResponseCallback + | Params$Resource$Projects$Locations$Specialistpools$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Publishers$Models$Predict; + {}) as Params$Resource$Projects$Locations$Specialistpools$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Publishers$Models$Predict; + {} as Params$Resource$Projects$Locations$Specialistpools$Operations$Wait; options = {}; } @@ -101891,33 +137985,100 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:predict').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + + export interface Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Specialistpools$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Specialistpools$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Specialistpools$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Specialistpools$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Studies { + context: APIRequestContext; + operations: Resource$Projects$Locations$Studies$Operations; + trials: Resource$Projects$Locations$Studies$Trials; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Projects$Locations$Studies$Operations( + this.context + ); + this.trials = new Resource$Projects$Locations$Studies$Trials( + this.context + ); + } /** + * Creates a Study. A resource name will be generated after creation of the Study. * @example * ```js * // Before running the sample: @@ -101938,10 +138099,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -101949,30 +138107,33 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.publishers.models.predictLongRunning({ - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` - * endpoint: - * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', + * const res = await aiplatform.projects.locations.studies.create({ + * // Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "instances": [], - * // "parameters": {} - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "inactiveReason": "my_inactiveReason", + * // "name": "my_name", + * // "state": "my_state", + * // "studySpec": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "inactiveReason": "my_inactiveReason", * // "name": "my_name", - * // "response": {} + * // "state": "my_state", + * // "studySpec": {} * // } * } * @@ -101988,58 +138149,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - predictLongRunning( - params: Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning, + create( + params: Params$Resource$Projects$Locations$Studies$Create, options: StreamMethodOptions ): Promise>; - predictLongRunning( - params?: Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning, + create( + params?: Params$Resource$Projects$Locations$Studies$Create, options?: MethodOptions - ): Promise>; - predictLongRunning( - params: Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Studies$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - predictLongRunning( - params: Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning, + create( + params: Params$Resource$Projects$Locations$Studies$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - predictLongRunning( - params: Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Studies$Create, + callback: BodyResponseCallback ): void; - predictLongRunning( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - predictLongRunning( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning; + {}) as Params$Resource$Projects$Locations$Studies$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning; + params = {} as Params$Resource$Projects$Locations$Studies$Create; options = {}; } @@ -102052,7 +138212,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:predictLongRunning').replace( + url: (rootUrl + '/v1/{+parent}/studies').replace( /([^:]\/)\/+/g, '$1' ), @@ -102062,22 +138222,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's DeployedModel that served this prediction. + * Deletes a Study. * @example * ```js * // Before running the sample: @@ -102098,38 +138260,22 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await aiplatform.projects.locations.publishers.models.rawPredict({ - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: - * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', + * google.options({auth: authClient}); * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "httpBody": {} - * // } - * }, + * // Do the magic + * const res = await aiplatform.projects.locations.studies.delete({ + * // Required. The name of the Study resource to be deleted. Format: `projects/{project\}/locations/{location\}/studies/{study\}` + * name: 'projects/my-project/locations/my-location/studies/my-studie', * }); * console.log(res.data); * * // Example response - * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] - * // } + * // {} * } * * main().catch(e => { @@ -102144,54 +138290,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - rawPredict( - params: Params$Resource$Projects$Locations$Publishers$Models$Rawpredict, + delete( + params: Params$Resource$Projects$Locations$Studies$Delete, options: StreamMethodOptions ): Promise>; - rawPredict( - params?: Params$Resource$Projects$Locations$Publishers$Models$Rawpredict, + delete( + params?: Params$Resource$Projects$Locations$Studies$Delete, options?: MethodOptions - ): Promise>; - rawPredict( - params: Params$Resource$Projects$Locations$Publishers$Models$Rawpredict, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Studies$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - rawPredict( - params: Params$Resource$Projects$Locations$Publishers$Models$Rawpredict, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Studies$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - rawPredict( - params: Params$Resource$Projects$Locations$Publishers$Models$Rawpredict, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Studies$Delete, + callback: BodyResponseCallback ): void; - rawPredict(callback: BodyResponseCallback): void; - rawPredict( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Publishers$Models$Rawpredict - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Publishers$Models$Rawpredict; + {}) as Params$Resource$Projects$Locations$Studies$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Publishers$Models$Rawpredict; + params = {} as Params$Resource$Projects$Locations$Studies$Delete; options = {}; } @@ -102204,32 +138349,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:rawPredict').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Perform a server-side streaming online prediction request for Vertex LLM streaming. + * Gets a Study by name. * @example * ```js * // Before running the sample: @@ -102250,10 +138392,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -102261,29 +138400,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.publishers.models.serverStreamingPredict( - * { - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: - * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "inputs": [], - * // "parameters": {} - * // } - * }, - * }, - * ); + * const res = await aiplatform.projects.locations.studies.get({ + * // Required. The name of the Study resource. Format: `projects/{project\}/locations/{location\}/studies/{study\}` + * name: 'projects/my-project/locations/my-location/studies/my-studie', + * }); * console.log(res.data); * * // Example response * // { - * // "outputs": [], - * // "parameters": {} + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "inactiveReason": "my_inactiveReason", + * // "name": "my_name", + * // "state": "my_state", + * // "studySpec": {} * // } * } * @@ -102299,62 +138429,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - serverStreamingPredict( - params: Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict, + get( + params: Params$Resource$Projects$Locations$Studies$Get, options: StreamMethodOptions ): Promise>; - serverStreamingPredict( - params?: Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict, + get( + params?: Params$Resource$Projects$Locations$Studies$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - serverStreamingPredict( - params: Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Studies$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - serverStreamingPredict( - params: Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict, + get( + params: Params$Resource$Projects$Locations$Studies$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - serverStreamingPredict( - params: Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Studies$Get, + callback: BodyResponseCallback ): void; - serverStreamingPredict( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - serverStreamingPredict( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict; + {}) as Params$Resource$Projects$Locations$Studies$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict; + params = {} as Params$Resource$Projects$Locations$Studies$Get; options = {}; } @@ -102367,34 +138492,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:serverStreamingPredict').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Generate content with multimodal inputs with streaming support. + * Lists all the studies in a region for an associated project. * @example * ```js * // Before running the sample: @@ -102415,10 +138537,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -102426,40 +138545,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.publishers.models.streamGenerateContent( - * { - * // Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * model: - * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "cachedContent": "my_cachedContent", - * // "contents": [], - * // "generationConfig": {}, - * // "labels": {}, - * // "modelArmorConfig": {}, - * // "safetySettings": [], - * // "systemInstruction": {}, - * // "toolConfig": {}, - * // "tools": [] - * // } - * }, - * }, - * ); + * const res = await aiplatform.projects.locations.studies.list({ + * // Optional. The maximum number of studies to return per "page" of results. If unspecified, service will pick an appropriate default. + * pageSize: 'placeholder-value', + * // Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location to list the Study from. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { - * // "candidates": [], - * // "createTime": "my_createTime", - * // "modelVersion": "my_modelVersion", - * // "promptFeedback": {}, - * // "responseId": "my_responseId", - * // "usageMetadata": {} + * // "nextPageToken": "my_nextPageToken", + * // "studies": [] * // } * } * @@ -102475,62 +138574,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - streamGenerateContent( - params: Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent, + list( + params: Params$Resource$Projects$Locations$Studies$List, options: StreamMethodOptions ): Promise>; - streamGenerateContent( - params?: Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent, + list( + params?: Params$Resource$Projects$Locations$Studies$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - streamGenerateContent( - params: Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent, + list( + params: Params$Resource$Projects$Locations$Studies$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - streamGenerateContent( - params: Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent, + list( + params: Params$Resource$Projects$Locations$Studies$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - streamGenerateContent( - params: Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Studies$List, + callback: BodyResponseCallback ): void; - streamGenerateContent( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - streamGenerateContent( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent; + {}) as Params$Resource$Projects$Locations$Studies$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent; + params = {} as Params$Resource$Projects$Locations$Studies$List; options = {}; } @@ -102543,34 +138641,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+model}:streamGenerateContent').replace( + url: (rootUrl + '/v1/{+parent}/studies').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['model'], - pathParams: ['model'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Perform a streaming online prediction with an arbitrary HTTP payload. + * Looks a study up using the user-defined display_name field instead of the fully qualified resource name. * @example * ```js * // Before running the sample: @@ -102591,10 +138689,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -102602,27 +138697,28 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.publishers.models.streamRawPredict({ - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: - * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', + * const res = await aiplatform.projects.locations.studies.lookup({ + * // Required. The resource name of the Location to get the Study from. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "httpBody": {} - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "displayName": "my_displayName" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "inactiveReason": "my_inactiveReason", + * // "name": "my_name", + * // "state": "my_state", + * // "studySpec": {} * // } * } * @@ -102638,56 +138734,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - streamRawPredict( - params: Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict, + lookup( + params: Params$Resource$Projects$Locations$Studies$Lookup, options: StreamMethodOptions ): Promise>; - streamRawPredict( - params?: Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict, + lookup( + params?: Params$Resource$Projects$Locations$Studies$Lookup, options?: MethodOptions - ): Promise>; - streamRawPredict( - params: Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict, + ): Promise>; + lookup( + params: Params$Resource$Projects$Locations$Studies$Lookup, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - streamRawPredict( - params: Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + lookup( + params: Params$Resource$Projects$Locations$Studies$Lookup, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - streamRawPredict( - params: Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict, - callback: BodyResponseCallback + lookup( + params: Params$Resource$Projects$Locations$Studies$Lookup, + callback: BodyResponseCallback ): void; - streamRawPredict( - callback: BodyResponseCallback + lookup( + callback: BodyResponseCallback ): void; - streamRawPredict( + lookup( paramsOrCallback?: - | Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Lookup + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict; + {}) as Params$Resource$Projects$Locations$Studies$Lookup; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict; + params = {} as Params$Resource$Projects$Locations$Studies$Lookup; options = {}; } @@ -102700,7 +138797,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:streamRawPredict').replace( + url: (rootUrl + '/v1/{+parent}/studies:lookup').replace( /([^:]\/)\/+/g, '$1' ), @@ -102710,158 +138807,85 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Publishers$Models$Computetokens - extends StandardParameters { - /** - * Required. The name of the Endpoint requested to get lists of tokens and token ids. - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ComputeTokensRequest; - } - export interface Params$Resource$Projects$Locations$Publishers$Models$Counttokens - extends StandardParameters { - /** - * Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1CountTokensRequest; - } - export interface Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation - extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1FetchPredictOperationRequest; - } - export interface Params$Resource$Projects$Locations$Publishers$Models$Generatecontent - extends StandardParameters { - /** - * Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - model?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1GenerateContentRequest; - } - export interface Params$Resource$Projects$Locations$Publishers$Models$Predict + export interface Params$Resource$Projects$Locations$Studies$Create extends StandardParameters { /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project\}/locations/{location\}` */ - endpoint?: string; + parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1PredictRequest; + requestBody?: Schema$GoogleCloudAiplatformV1Study; } - export interface Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning + export interface Params$Resource$Projects$Locations$Studies$Delete extends StandardParameters { /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` - */ - endpoint?: string; - - /** - * Request body metadata + * Required. The name of the Study resource to be deleted. Format: `projects/{project\}/locations/{location\}/studies/{study\}` */ - requestBody?: Schema$GoogleCloudAiplatformV1PredictLongRunningRequest; + name?: string; } - export interface Params$Resource$Projects$Locations$Publishers$Models$Rawpredict + export interface Params$Resource$Projects$Locations$Studies$Get extends StandardParameters { /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata + * Required. The name of the Study resource. Format: `projects/{project\}/locations/{location\}/studies/{study\}` */ - requestBody?: Schema$GoogleCloudAiplatformV1RawPredictRequest; + name?: string; } - export interface Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict + export interface Params$Resource$Projects$Locations$Studies$List extends StandardParameters { /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata + * Optional. The maximum number of studies to return per "page" of results. If unspecified, service will pick an appropriate default. */ - requestBody?: Schema$GoogleCloudAiplatformV1StreamingPredictRequest; - } - export interface Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent - extends StandardParameters { + pageSize?: number; /** - * Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages. */ - model?: string; - + pageToken?: string; /** - * Request body metadata + * Required. The resource name of the Location to list the Study from. Format: `projects/{project\}/locations/{location\}` */ - requestBody?: Schema$GoogleCloudAiplatformV1GenerateContentRequest; + parent?: string; } - export interface Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict + export interface Params$Resource$Projects$Locations$Studies$Lookup extends StandardParameters { /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * Required. The resource name of the Location to get the Study from. Format: `projects/{project\}/locations/{location\}` */ - endpoint?: string; + parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1StreamRawPredictRequest; + requestBody?: Schema$GoogleCloudAiplatformV1LookupStudyRequest; } - export class Resource$Projects$Locations$Ragcorpora { + export class Resource$Projects$Locations$Studies$Operations { context: APIRequestContext; - operations: Resource$Projects$Locations$Ragcorpora$Operations; - ragFiles: Resource$Projects$Locations$Ragcorpora$Ragfiles; constructor(context: APIRequestContext) { this.context = context; - this.operations = new Resource$Projects$Locations$Ragcorpora$Operations( - this.context - ); - this.ragFiles = new Resource$Projects$Locations$Ragcorpora$Ragfiles( - this.context - ); } /** - * Creates a RagCorpus. + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -102890,36 +138914,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.ragCorpora.create({ - * // Required. The resource name of the Location to create the RagCorpus in. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "corpusStatus": {}, - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "name": "my_name", - * // "updateTime": "my_updateTime", - * // "vectorDbConfig": {}, - * // "vertexAiSearchConfig": {} - * // } - * }, + * const res = await aiplatform.projects.locations.studies.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/studies/my-studie/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -102934,57 +138936,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Ragcorpora$Create, + cancel( + params: Params$Resource$Projects$Locations$Studies$Operations$Cancel, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Ragcorpora$Create, + cancel( + params?: Params$Resource$Projects$Locations$Studies$Operations$Cancel, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Ragcorpora$Create, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Studies$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Ragcorpora$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Ragcorpora$Create, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Studies$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Studies$Operations$Cancel, + callback: BodyResponseCallback ): void; - create( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Create; + {}) as Params$Resource$Projects$Locations$Studies$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Ragcorpora$Create; + params = + {} as Params$Resource$Projects$Locations$Studies$Operations$Cancel; options = {}; } @@ -102997,32 +138996,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/ragCorpora').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a RagCorpus. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -103051,22 +139047,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.ragCorpora.delete({ - * // Optional. If set to true, any RagFiles in this RagCorpus will also be deleted. Otherwise, the request will only work if the RagCorpus has no RagFiles. - * force: 'placeholder-value', - * // Required. The name of the RagCorpus resource to be deleted. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` - * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+', + * const res = await aiplatform.projects.locations.studies.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/studies/my-studie/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -103082,56 +139070,53 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Delete, + params: Params$Resource$Projects$Locations$Studies$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Ragcorpora$Delete, + params?: Params$Resource$Projects$Locations$Studies$Operations$Delete, options?: MethodOptions - ): Promise>; + ): Promise>; delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Delete, + params: Params$Resource$Projects$Locations$Studies$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Studies$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Studies$Operations$Delete, + callback: BodyResponseCallback ): void; + delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Delete; + {}) as Params$Resource$Projects$Locations$Studies$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Ragcorpora$Delete; + params = + {} as Params$Resource$Projects$Locations$Studies$Operations$Delete; options = {}; } @@ -103156,17 +139141,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a RagCorpus. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -103195,23 +139180,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.ragCorpora.get({ - * // Required. The name of the RagCorpus resource. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` - * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+', + * const res = await aiplatform.projects.locations.studies.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/studies/my-studie/operations/my-operation', * }); * console.log(res.data); * * // Example response * // { - * // "corpusStatus": {}, - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "updateTime": "my_updateTime", - * // "vectorDbConfig": {}, - * // "vertexAiSearchConfig": {} + * // "response": {} * // } * } * @@ -103228,60 +139209,57 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Ragcorpora$Get, + params: Params$Resource$Projects$Locations$Studies$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Ragcorpora$Get, + params?: Params$Resource$Projects$Locations$Studies$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; + ): Promise>; get( - params: Params$Resource$Projects$Locations$Ragcorpora$Get, + params: Params$Resource$Projects$Locations$Studies$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Ragcorpora$Get, + params: Params$Resource$Projects$Locations$Studies$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Ragcorpora$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Studies$Operations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Get; + {}) as Params$Resource$Projects$Locations$Studies$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Ragcorpora$Get; + params = + {} as Params$Resource$Projects$Locations$Studies$Operations$Get; options = {}; } @@ -103306,19 +139284,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists RagCorpora in a Location. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -103347,20 +139323,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.ragCorpora.list({ - * // Optional. The standard list page size. + * const res = await aiplatform.projects.locations.studies.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/studies/my-studie', + * // The standard list page size. * pageSize: 'placeholder-value', - * // Optional. The standard list page token. Typically obtained via ListRagCorporaResponse.next_page_token of the previous VertexRagDataService.ListRagCorpora call. + * // The standard list page token. * pageToken: 'placeholder-value', - * // Required. The resource name of the Location from which to list the RagCorpora. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "ragCorpora": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -103377,60 +139358,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Ragcorpora$List, + params: Params$Resource$Projects$Locations$Studies$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Ragcorpora$List, + params?: Params$Resource$Projects$Locations$Studies$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Ragcorpora$List, + params: Params$Resource$Projects$Locations$Studies$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Ragcorpora$List, + params: Params$Resource$Projects$Locations$Studies$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Ragcorpora$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Studies$Operations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$List; + {}) as Params$Resource$Projects$Locations$Studies$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Ragcorpora$List; + params = + {} as Params$Resource$Projects$Locations$Studies$Operations$List; options = {}; } @@ -103443,7 +139425,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/ragCorpora').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -103453,24 +139435,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a RagCorpus. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -103499,35 +139481,247 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.ragCorpora.patch({ - * // Output only. The resource name of the RagCorpus. - * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+', + * const res = await aiplatform.projects.locations.studies.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/studies/my-studie/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); + * console.log(res.data); * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "corpusStatus": {}, - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "name": "my_name", - * // "updateTime": "my_updateTime", - * // "vectorDbConfig": {}, - * // "vertexAiSearchConfig": {} - * // } - * }, + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + wait( + params: Params$Resource$Projects$Locations$Studies$Operations$Wait, + options: StreamMethodOptions + ): Promise>; + wait( + params?: Params$Resource$Projects$Locations$Studies$Operations$Wait, + options?: MethodOptions + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Studies$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Studies$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Studies$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Studies$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Studies$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Studies$Operations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Studies$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Studies$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Studies$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Studies$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Studies$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Studies$Trials { + context: APIRequestContext; + operations: Resource$Projects$Locations$Studies$Trials$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Studies$Trials$Operations(this.context); + } + + /** + * Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.studies.trials.addTrialMeasurement({ + * // Required. The name of the trial to add measurement. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + * trialName: + * 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "measurement": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "clientId": "my_clientId", + * // "customJob": "my_customJob", + * // "endTime": "my_endTime", + * // "finalMeasurement": {}, + * // "id": "my_id", + * // "infeasibleReason": "my_infeasibleReason", + * // "measurements": [], * // "name": "my_name", - * // "response": {} + * // "parameters": [], + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "webAccessUris": {} * // } * } * @@ -103543,57 +139737,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Ragcorpora$Patch, + addTrialMeasurement( + params: Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Ragcorpora$Patch, + addTrialMeasurement( + params?: Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Ragcorpora$Patch, + ): Promise>; + addTrialMeasurement( + params: Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Ragcorpora$Patch, + addTrialMeasurement( + params: Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Ragcorpora$Patch, - callback: BodyResponseCallback + addTrialMeasurement( + params: Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + addTrialMeasurement( + callback: BodyResponseCallback ): void; - patch( + addTrialMeasurement( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Patch; + {}) as Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Ragcorpora$Patch; + params = + {} as Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement; options = {}; } @@ -103606,94 +139801,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+trialName}:addTrialMeasurement').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['trialName'], + pathParams: ['trialName'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Projects$Locations$Ragcorpora$Create - extends StandardParameters { - /** - * Required. The resource name of the Location to create the RagCorpus in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1RagCorpus; - } - export interface Params$Resource$Projects$Locations$Ragcorpora$Delete - extends StandardParameters { - /** - * Optional. If set to true, any RagFiles in this RagCorpus will also be deleted. Otherwise, the request will only work if the RagCorpus has no RagFiles. - */ - force?: boolean; - /** - * Required. The name of the RagCorpus resource to be deleted. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Ragcorpora$Get - extends StandardParameters { - /** - * Required. The name of the RagCorpus resource. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Ragcorpora$List - extends StandardParameters { - /** - * Optional. The standard list page size. - */ - pageSize?: number; - /** - * Optional. The standard list page token. Typically obtained via ListRagCorporaResponse.next_page_token of the previous VertexRagDataService.ListRagCorpora call. - */ - pageToken?: string; - /** - * Required. The resource name of the Location from which to list the RagCorpora. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Ragcorpora$Patch - extends StandardParameters { - /** - * Output only. The resource name of the RagCorpus. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1RagCorpus; - } - - export class Resource$Projects$Locations$Ragcorpora$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse. * @example * ```js * // Before running the sample: @@ -103722,14 +139857,30 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.ragCorpora.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/operations/my-operation', - * }); + * const res = + * await aiplatform.projects.locations.studies.trials.checkTrialEarlyStoppingState( + * { + * // Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + * trialName: + * 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }, + * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -103744,54 +139895,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel, + checkTrialEarlyStoppingState( + params: Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel, + checkTrialEarlyStoppingState( + params?: Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel, + ): Promise>; + checkTrialEarlyStoppingState( + params: Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + checkTrialEarlyStoppingState( + params: Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel, - callback: BodyResponseCallback + checkTrialEarlyStoppingState( + params: Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + checkTrialEarlyStoppingState( + callback: BodyResponseCallback + ): void; + checkTrialEarlyStoppingState( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate; options = {}; } @@ -103804,29 +139959,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: ( + rootUrl + '/v1/{+trialName}:checkTrialEarlyStoppingState' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['trialName'], + pathParams: ['trialName'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Marks a Trial as complete. * @example * ```js * // Before running the sample: @@ -103855,14 +140012,37 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.ragCorpora.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/operations/my-operation', + * const res = await aiplatform.projects.locations.studies.trials.complete({ + * // Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "finalMeasurement": {}, + * // "infeasibleReason": "my_infeasibleReason", + * // "trialInfeasible": false + * // } + * }, * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "clientId": "my_clientId", + * // "customJob": "my_customJob", + * // "endTime": "my_endTime", + * // "finalMeasurement": {}, + * // "id": "my_id", + * // "infeasibleReason": "my_infeasibleReason", + * // "measurements": [], + * // "name": "my_name", + * // "parameters": [], + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "webAccessUris": {} + * // } * } * * main().catch(e => { @@ -103877,54 +140057,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete, + complete( + params: Params$Resource$Projects$Locations$Studies$Trials$Complete, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete, + complete( + params?: Params$Resource$Projects$Locations$Studies$Trials$Complete, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete, + ): Promise>; + complete( + params: Params$Resource$Projects$Locations$Studies$Trials$Complete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + complete( + params: Params$Resource$Projects$Locations$Studies$Trials$Complete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete, - callback: BodyResponseCallback + complete( + params: Params$Resource$Projects$Locations$Studies$Trials$Complete, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + complete( + callback: BodyResponseCallback + ): void; + complete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Trials$Complete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Studies$Trials$Complete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete; + {} as Params$Resource$Projects$Locations$Studies$Trials$Complete; options = {}; } @@ -103937,8 +140121,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}:complete').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -103949,17 +140136,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Adds a user provided Trial to a Study. * @example * ```js * // Before running the sample: @@ -103988,19 +140177,45 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.ragCorpora.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/operations/my-operation', + * const res = await aiplatform.projects.locations.studies.trials.create({ + * // Required. The resource name of the Study to create the Trial in. Format: `projects/{project\}/locations/{location\}/studies/{study\}` + * parent: 'projects/my-project/locations/my-location/studies/my-studie', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "clientId": "my_clientId", + * // "customJob": "my_customJob", + * // "endTime": "my_endTime", + * // "finalMeasurement": {}, + * // "id": "my_id", + * // "infeasibleReason": "my_infeasibleReason", + * // "measurements": [], + * // "name": "my_name", + * // "parameters": [], + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "webAccessUris": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "clientId": "my_clientId", + * // "customJob": "my_customJob", + * // "endTime": "my_endTime", + * // "finalMeasurement": {}, + * // "id": "my_id", + * // "infeasibleReason": "my_infeasibleReason", + * // "measurements": [], * // "name": "my_name", - * // "response": {} + * // "parameters": [], + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "webAccessUris": {} * // } * } * @@ -104016,58 +140231,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Get, + create( + params: Params$Resource$Projects$Locations$Studies$Trials$Create, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Ragcorpora$Operations$Get, + create( + params?: Params$Resource$Projects$Locations$Studies$Trials$Create, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Get, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Studies$Trials$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Get, + create( + params: Params$Resource$Projects$Locations$Studies$Trials$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Studies$Trials$Create, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Trials$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Operations$Get; + {}) as Params$Resource$Projects$Locations$Studies$Trials$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Operations$Get; + params = {} as Params$Resource$Projects$Locations$Studies$Trials$Create; options = {}; } @@ -104080,29 +140294,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+parent}/trials').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Deletes a Trial. * @example * ```js * // Before running the sample: @@ -104131,26 +140350,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.ragCorpora.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', + * const res = await aiplatform.projects.locations.studies.trials.delete({ + * // Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', * }); * console.log(res.data); * * // Example response - * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] - * // } + * // {} * } * * main().catch(e => { @@ -104165,62 +140372,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$List, + delete( + params: Params$Resource$Projects$Locations$Studies$Trials$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Ragcorpora$Operations$List, + delete( + params?: Params$Resource$Projects$Locations$Studies$Trials$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$List, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Studies$Trials$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Studies$Trials$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Studies$Trials$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Trials$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Operations$List; + {}) as Params$Resource$Projects$Locations$Studies$Trials$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Operations$List; + params = {} as Params$Resource$Projects$Locations$Studies$Trials$Delete; options = {}; } @@ -104233,11 +140431,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -104248,19 +140443,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Gets a Trial. * @example * ```js * // Before running the sample: @@ -104289,21 +140482,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.ragCorpora.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', + * const res = await aiplatform.projects.locations.studies.trials.get({ + * // Required. The name of the Trial resource. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "clientId": "my_clientId", + * // "customJob": "my_customJob", + * // "endTime": "my_endTime", + * // "finalMeasurement": {}, + * // "id": "my_id", + * // "infeasibleReason": "my_infeasibleReason", + * // "measurements": [], * // "name": "my_name", - * // "response": {} + * // "parameters": [], + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "webAccessUris": {} * // } * } * @@ -104319,58 +140517,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait, + get( + params: Params$Resource$Projects$Locations$Studies$Trials$Get, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait, + get( + params?: Params$Resource$Projects$Locations$Studies$Trials$Get, options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Studies$Trials$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait, + get( + params: Params$Resource$Projects$Locations$Studies$Trials$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Studies$Trials$Get, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - wait( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Trials$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Studies$Trials$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait; + params = {} as Params$Resource$Projects$Locations$Studies$Trials$Get; options = {}; } @@ -104383,8 +140580,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -104395,85 +140592,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel - extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete - extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Ragcorpora$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Ragcorpora$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait - extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Ragcorpora$Ragfiles { - context: APIRequestContext; - operations: Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations( - this.context + return createAPIRequest( + parameters ); + } } /** - * Deletes a RagFile. + * Lists the Trials associated with a Study. * @example * ```js * // Before running the sample: @@ -104502,21 +140633,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.ragCorpora.ragFiles.delete({ - * // Optional. If set to true, any errors generated by external vector database during the deletion will be ignored. The default value is false. - * forceDelete: 'placeholder-value', - * // Required. The name of the RagFile resource to be deleted. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}/ragFiles/{rag_file\}` - * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/ragFiles/my-ragFile', + * const res = await aiplatform.projects.locations.studies.trials.list({ + * // Optional. The number of Trials to retrieve per "page" of results. If unspecified, the service will pick an appropriate default. + * pageSize: 'placeholder-value', + * // Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Study to list the Trial from. Format: `projects/{project\}/locations/{location\}/studies/{study\}` + * parent: 'projects/my-project/locations/my-location/studies/my-studie', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "trials": [] * // } * } * @@ -104532,58 +140662,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete, + list( + params: Params$Resource$Projects$Locations$Studies$Trials$List, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete, + list( + params?: Params$Resource$Projects$Locations$Studies$Trials$List, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Studies$Trials$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete, + list( + params: Params$Resource$Projects$Locations$Studies$Trials$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Studies$Trials$List, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - delete( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Trials$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete; + {}) as Params$Resource$Projects$Locations$Studies$Trials$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete; + params = {} as Params$Resource$Projects$Locations$Studies$Trials$List; options = {}; } @@ -104596,29 +140729,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/trials').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a RagFile. + * Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency * @example * ```js * // Before running the sample: @@ -104647,27 +140785,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.ragCorpora.ragFiles.get({ - * // Required. The name of the RagFile resource. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}/ragFiles/{rag_file\}` - * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/ragFiles/my-ragFile', - * }); + * const res = + * await aiplatform.projects.locations.studies.trials.listOptimalTrials({ + * // Required. The name of the Study that the optimal Trial belongs to. + * parent: 'projects/my-project/locations/my-location/studies/my-studie', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "directUploadSource": {}, - * // "displayName": "my_displayName", - * // "fileStatus": {}, - * // "gcsSource": {}, - * // "googleDriveSource": {}, - * // "jiraSource": {}, - * // "name": "my_name", - * // "sharePointSources": {}, - * // "slackSource": {}, - * // "updateTime": "my_updateTime", - * // "userMetadata": "my_userMetadata" + * // "optimalTrials": [] * // } * } * @@ -104683,58 +140816,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, + listOptimalTrials( + params: Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, + listOptimalTrials( + params?: Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + listOptimalTrials( + params: Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, + listOptimalTrials( + params: Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, - callback: BodyResponseCallback + listOptimalTrials( + params: Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + listOptimalTrials( + callback: BodyResponseCallback ): void; - get( + listOptimalTrials( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get; + {}) as Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get; + {} as Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials; options = {}; } @@ -104747,31 +140884,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+parent}/trials:listOptimalTrials').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Import files from Google Cloud Storage or Google Drive into a RagCorpus. + * Stops a Trial. * @example * ```js * // Before running the sample: @@ -104800,27 +140940,32 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.ragCorpora.ragFiles.import({ - * // Required. The name of the RagCorpus resource into which to import files. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` - * parent: 'projects/my-project/locations/my-location/ragCorpora/[^/]+', + * const res = await aiplatform.projects.locations.studies.trials.stop({ + * // Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', * * // Request body metadata * requestBody: { * // request body parameters - * // { - * // "importRagFilesConfig": {} - * // } + * // {} * }, * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "clientId": "my_clientId", + * // "customJob": "my_customJob", + * // "endTime": "my_endTime", + * // "finalMeasurement": {}, + * // "id": "my_id", + * // "infeasibleReason": "my_infeasibleReason", + * // "measurements": [], * // "name": "my_name", - * // "response": {} + * // "parameters": [], + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "webAccessUris": {} * // } * } * @@ -104836,58 +140981,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, + stop( + params: Params$Resource$Projects$Locations$Studies$Trials$Stop, options: StreamMethodOptions ): Promise>; - import( - params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, + stop( + params?: Params$Resource$Projects$Locations$Studies$Trials$Stop, options?: MethodOptions - ): Promise>; - import( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, + ): Promise>; + stop( + params: Params$Resource$Projects$Locations$Studies$Trials$Stop, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, + stop( + params: Params$Resource$Projects$Locations$Studies$Trials$Stop, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, - callback: BodyResponseCallback + stop( + params: Params$Resource$Projects$Locations$Studies$Trials$Stop, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + stop( + callback: BodyResponseCallback ): void; - import( + stop( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Trials$Stop + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import; + {}) as Params$Resource$Projects$Locations$Studies$Trials$Stop; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import; + params = {} as Params$Resource$Projects$Locations$Studies$Trials$Stop; options = {}; } @@ -104900,32 +141044,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/ragFiles:import').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:stop').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists RagFiles in a RagCorpus. + * Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier. Returns a long-running operation associated with the generation of Trial suggestions. When this long-running operation succeeds, it will contain a SuggestTrialsResponse. * @example * ```js * // Before running the sample: @@ -104954,20 +141097,29 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.ragCorpora.ragFiles.list({ - * // Optional. The standard list page size. - * pageSize: 'placeholder-value', - * // Optional. The standard list page token. Typically obtained via ListRagFilesResponse.next_page_token of the previous VertexRagDataService.ListRagFiles call. - * pageToken: 'placeholder-value', - * // Required. The resource name of the RagCorpus from which to list the RagFiles. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` - * parent: 'projects/my-project/locations/my-location/ragCorpora/[^/]+', + * const res = await aiplatform.projects.locations.studies.trials.suggest({ + * // Required. The project and location that the Study belongs to. Format: `projects/{project\}/locations/{location\}/studies/{study\}` + * parent: 'projects/my-project/locations/my-location/studies/my-studie', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "clientId": "my_clientId", + * // "contexts": [], + * // "suggestionCount": 0 + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "ragFiles": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -104983,62 +141135,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List, + suggest( + params: Params$Resource$Projects$Locations$Studies$Trials$Suggest, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List, + suggest( + params?: Params$Resource$Projects$Locations$Studies$Trials$Suggest, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List, + ): Promise>; + suggest( + params: Params$Resource$Projects$Locations$Studies$Trials$Suggest, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List, + suggest( + params: Params$Resource$Projects$Locations$Studies$Trials$Suggest, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List, - callback: BodyResponseCallback + suggest( + params: Params$Resource$Projects$Locations$Studies$Trials$Suggest, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + suggest( + callback: BodyResponseCallback ): void; - list( + suggest( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Trials$Suggest + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List; + {}) as Params$Resource$Projects$Locations$Studies$Trials$Suggest; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List; + {} as Params$Resource$Projects$Locations$Studies$Trials$Suggest; options = {}; } @@ -105051,11 +141199,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/ragFiles').replace( + url: (rootUrl + '/v1/{+parent}/trials:suggest').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -105066,65 +141214,131 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete + export interface Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement extends StandardParameters { /** - * Optional. If set to true, any errors generated by external vector database during the deletion will be ignored. The default value is false. + * Required. The name of the trial to add measurement. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` */ - forceDelete?: boolean; + trialName?: string; + /** - * Required. The name of the RagFile resource to be deleted. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}/ragFiles/{rag_file\}` + * Request body metadata */ - name?: string; + requestBody?: Schema$GoogleCloudAiplatformV1AddTrialMeasurementRequest; } - export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get + export interface Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate extends StandardParameters { /** - * Required. The name of the RagFile resource. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}/ragFiles/{rag_file\}` + * Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + */ + trialName?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest; + } + export interface Params$Resource$Projects$Locations$Studies$Trials$Complete + extends StandardParameters { + /** + * Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` */ name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CompleteTrialRequest; } - export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import + export interface Params$Resource$Projects$Locations$Studies$Trials$Create extends StandardParameters { /** - * Required. The name of the RagCorpus resource into which to import files. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` + * Required. The resource name of the Study to create the Trial in. Format: `projects/{project\}/locations/{location\}/studies/{study\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1ImportRagFilesRequest; + requestBody?: Schema$GoogleCloudAiplatformV1Trial; } - export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List + export interface Params$Resource$Projects$Locations$Studies$Trials$Delete extends StandardParameters { /** - * Optional. The standard list page size. + * Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Studies$Trials$Get + extends StandardParameters { + /** + * Required. The name of the Trial resource. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Studies$Trials$List + extends StandardParameters { + /** + * Optional. The number of Trials to retrieve per "page" of results. If unspecified, the service will pick an appropriate default. */ pageSize?: number; /** - * Optional. The standard list page token. Typically obtained via ListRagFilesResponse.next_page_token of the previous VertexRagDataService.ListRagFiles call. + * Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages. */ pageToken?: string; /** - * Required. The resource name of the RagCorpus from which to list the RagFiles. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` + * Required. The resource name of the Study to list the Trial from. Format: `projects/{project\}/locations/{location\}/studies/{study\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials + extends StandardParameters { + /** + * Required. The name of the Study that the optimal Trial belongs to. */ parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ListOptimalTrialsRequest; } + export interface Params$Resource$Projects$Locations$Studies$Trials$Stop + extends StandardParameters { + /** + * Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + */ + name?: string; - export class Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations { + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1StopTrialRequest; + } + export interface Params$Resource$Projects$Locations$Studies$Trials$Suggest + extends StandardParameters { + /** + * Required. The project and location that the Study belongs to. Format: `projects/{project\}/locations/{location\}/studies/{study\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1SuggestTrialsRequest; + } + + export class Resource$Projects$Locations$Studies$Trials$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -105161,9 +141375,9 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.ragCorpora.ragFiles.operations.cancel({ + * await aiplatform.projects.locations.studies.trials.operations.cancel({ * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/ragFiles/my-ragFile/operations/my-operation', + * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial/operations/my-operation', * }); * console.log(res.data); * @@ -105184,31 +141398,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel + | Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -105224,13 +141438,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel; options = {}; } @@ -105295,9 +141509,9 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.ragCorpora.ragFiles.operations.delete({ + * await aiplatform.projects.locations.studies.trials.operations.delete({ * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/ragFiles/my-ragFile/operations/my-operation', + * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial/operations/my-operation', * }); * console.log(res.data); * @@ -105318,31 +141532,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, + params?: Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete + | Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -105358,13 +141572,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete; + {} as Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete; options = {}; } @@ -105428,11 +141642,12 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.ragCorpora.ragFiles.operations.get({ + * const res = await aiplatform.projects.locations.studies.trials.operations.get( + * { * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/ragFiles/my-ragFile/operations/my-operation', - * }); + * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response @@ -105458,27 +141673,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, + params?: Params$Resource$Projects$Locations$Studies$Trials$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -105486,7 +141701,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get + | Params$Resource$Projects$Locations$Studies$Trials$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -105502,13 +141717,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get; + {}) as Params$Resource$Projects$Locations$Studies$Trials$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get; + {} as Params$Resource$Projects$Locations$Studies$Trials$Operations$Get; options = {}; } @@ -105573,11 +141788,11 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.ragCorpora.ragFiles.operations.list({ + * await aiplatform.projects.locations.studies.trials.operations.list({ * // The standard list filter. * filter: 'placeholder-value', * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/ragFiles/my-ragFile', + * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', * // The standard list page size. * pageSize: 'placeholder-value', * // The standard list page token. @@ -105608,29 +141823,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, + params?: Params$Resource$Projects$Locations$Studies$Trials$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$List, callback: BodyResponseCallback ): void; list( @@ -105638,7 +141853,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List + | Params$Resource$Projects$Locations$Studies$Trials$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -105656,13 +141871,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List; + {}) as Params$Resource$Projects$Locations$Studies$Trials$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List; + {} as Params$Resource$Projects$Locations$Studies$Trials$Operations$List; options = {}; } @@ -105732,9 +141947,9 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.ragCorpora.ragFiles.operations.wait({ + * await aiplatform.projects.locations.studies.trials.operations.wait({ * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/ragFiles/my-ragFile/operations/my-operation', + * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial/operations/my-operation', * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. * timeout: 'placeholder-value', * }); @@ -105763,27 +141978,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, + params?: Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -105791,7 +142006,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait + | Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -105807,13 +142022,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait; + {} as Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait; options = {}; } @@ -105848,28 +142063,28 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel + export interface Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete + export interface Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get + export interface Params$Resource$Projects$Locations$Studies$Trials$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List + export interface Params$Resource$Projects$Locations$Studies$Trials$Operations$List extends StandardParameters { /** * The standard list filter. @@ -105892,7 +142107,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait + export interface Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -105904,26 +142119,172 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Ragengineconfig { + export class Resource$Projects$Locations$Tensorboards { context: APIRequestContext; - operations: Resource$Projects$Locations$Ragengineconfig$Operations; + experiments: Resource$Projects$Locations$Tensorboards$Experiments; + operations: Resource$Projects$Locations$Tensorboards$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = - new Resource$Projects$Locations$Ragengineconfig$Operations( - this.context - ); + this.experiments = + new Resource$Projects$Locations$Tensorboards$Experiments(this.context); + this.operations = new Resource$Projects$Locations$Tensorboards$Operations( + this.context + ); } - } - export class Resource$Projects$Locations$Ragengineconfig$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + /** + * Reads multiple TensorboardTimeSeries' data. The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.tensorboards.batchRead({ + * // Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}`. The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard. + * tensorboard: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', + * // Required. The resource names of the TensorboardTimeSeries to read data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` + * timeSeries: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "timeSeriesData": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + batchRead( + params: Params$Resource$Projects$Locations$Tensorboards$Batchread, + options: StreamMethodOptions + ): Promise>; + batchRead( + params?: Params$Resource$Projects$Locations$Tensorboards$Batchread, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + batchRead( + params: Params$Resource$Projects$Locations$Tensorboards$Batchread, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchRead( + params: Params$Resource$Projects$Locations$Tensorboards$Batchread, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchRead( + params: Params$Resource$Projects$Locations$Tensorboards$Batchread, + callback: BodyResponseCallback + ): void; + batchRead( + callback: BodyResponseCallback + ): void; + batchRead( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Tensorboards$Batchread + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Tensorboards$Batchread; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Tensorboards$Batchread; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+tensorboard}:batchRead').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['tensorboard'], + pathParams: ['tensorboard'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Creates a Tensorboard. * @example * ```js * // Before running the sample: @@ -105952,15 +142313,40 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.ragEngineConfig.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/ragEngineConfig/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.tensorboards.create({ + * // Required. The resource name of the Location to create the Tensorboard in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "blobStoragePathPrefix": "my_blobStoragePathPrefix", + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "isDefault": false, + * // "labels": {}, + * // "name": "my_name", + * // "runCount": 0, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -105975,54 +142361,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel, + create( + params: Params$Resource$Projects$Locations$Tensorboards$Create, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel, + create( + params?: Params$Resource$Projects$Locations$Tensorboards$Create, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Tensorboards$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Tensorboards$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Tensorboards$Create, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Tensorboards$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel; + params = {} as Params$Resource$Projects$Locations$Tensorboards$Create; options = {}; } @@ -106035,29 +142424,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/tensorboards').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Deletes a Tensorboard. * @example * ```js * // Before running the sample: @@ -106086,15 +142478,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.ragEngineConfig.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/ragEngineConfig/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.tensorboards.delete({ + * // Required. The name of the Tensorboard to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -106110,53 +142507,56 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete, + params: Params$Resource$Projects$Locations$Tensorboards$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete, + params?: Params$Resource$Projects$Locations$Tensorboards$Delete, options?: MethodOptions - ): Promise>; + ): Promise>; delete( - params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete, + params: Params$Resource$Projects$Locations$Tensorboards$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Tensorboards$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Tensorboards$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Tensorboards$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete; + params = {} as Params$Resource$Projects$Locations$Tensorboards$Delete; options = {}; } @@ -106181,17 +142581,337 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Gets a Tensorboard. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.tensorboards.get({ + * // Required. The name of the Tensorboard resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "blobStoragePathPrefix": "my_blobStoragePathPrefix", + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "isDefault": false, + * // "labels": {}, + * // "name": "my_name", + * // "runCount": 0, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Tensorboards$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Tensorboards$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Tensorboards$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Tensorboards$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Tensorboards$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Tensorboards$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Tensorboards$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Tensorboards$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists Tensorboards in a Location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.projects.locations.tensorboards.list({ + * // Lists the Tensorboards that match the filter expression. + * filter: 'placeholder-value', + * // Field to use to sort the list. + * orderBy: 'placeholder-value', + * // The maximum number of Tensorboards to return. The service may return fewer than this value. If unspecified, at most 100 Tensorboards are returned. The maximum value is 100; values above 100 are coerced to 100. + * pageSize: 'placeholder-value', + * // A page token, received from a previous TensorboardService.ListTensorboards call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboards must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location to list Tensorboards. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "tensorboards": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Tensorboards$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Tensorboards$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Tensorboards$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Tensorboards$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Tensorboards$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Tensorboards$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Tensorboards$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Tensorboards$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/tensorboards').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates a Tensorboard. * @example * ```js * // Before running the sample: @@ -106220,11 +142940,32 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.ragEngineConfig.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/ragEngineConfig/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.tensorboards.patch({ + * // Output only. Name of the Tensorboard. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', + * // Required. Field mask is used to specify the fields to be overwritten in the Tensorboard resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "blobStoragePathPrefix": "my_blobStoragePathPrefix", + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "isDefault": false, + * // "labels": {}, + * // "name": "my_name", + * // "runCount": 0, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response @@ -106249,36 +142990,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get, + patch( + params: Params$Resource$Projects$Locations$Tensorboards$Patch, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get, + patch( + params?: Params$Resource$Projects$Locations$Tensorboards$Patch, options?: MethodOptions ): Promise>; - get( - params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get, + patch( + params: Params$Resource$Projects$Locations$Tensorboards$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get, + patch( + params: Params$Resource$Projects$Locations$Tensorboards$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get, + patch( + params: Params$Resource$Projects$Locations$Tensorboards$Patch, callback: BodyResponseCallback ): void; - get( + patch( callback: BodyResponseCallback ): void; - get( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get + | Params$Resource$Projects$Locations$Tensorboards$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -106294,13 +143035,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get; + {}) as Params$Resource$Projects$Locations$Tensorboards$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get; + params = {} as Params$Resource$Projects$Locations$Tensorboards$Patch; options = {}; } @@ -106314,7 +143054,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -106335,7 +143075,7 @@ export namespace aiplatform_v1 { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Returns the storage size for a given TensorBoard instance. * @example * ```js * // Before running the sample: @@ -106364,26 +143104,16 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.ragEngineConfig.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/ragEngineConfig', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * const res = await aiplatform.projects.locations.tensorboards.readSize({ + * // Required. The name of the Tensorboard resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` + * tensorboard: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', + * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "storageSizeByte": "my_storageSizeByte" * // } * } * @@ -106399,62 +143129,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$List, + readSize( + params: Params$Resource$Projects$Locations$Tensorboards$Readsize, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Ragengineconfig$Operations$List, + readSize( + params?: Params$Resource$Projects$Locations$Tensorboards$Readsize, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$List, + readSize( + params: Params$Resource$Projects$Locations$Tensorboards$Readsize, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$List, + readSize( + params: Params$Resource$Projects$Locations$Tensorboards$Readsize, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$List, - callback: BodyResponseCallback + readSize( + params: Params$Resource$Projects$Locations$Tensorboards$Readsize, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + readSize( + callback: BodyResponseCallback ): void; - list( + readSize( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragengineconfig$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Readsize + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragengineconfig$Operations$List; + {}) as Params$Resource$Projects$Locations$Tensorboards$Readsize; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Ragengineconfig$Operations$List; + params = {} as Params$Resource$Projects$Locations$Tensorboards$Readsize; options = {}; } @@ -106467,7 +143196,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+tensorboard}:readSize').replace( /([^:]\/)\/+/g, '$1' ), @@ -106477,24 +143206,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['tensorboard'], + pathParams: ['tensorboard'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Returns a list of monthly active users for a given TensorBoard instance. * @example * ```js * // Before running the sample: @@ -106523,22 +143252,16 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.ragEngineConfig.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/ragEngineConfig/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); + * const res = await aiplatform.projects.locations.tensorboards.readUsage({ + * // Required. The name of the Tensorboard resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` + * tensorboard: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "monthlyUsageData": {} * // } * } * @@ -106554,58 +143277,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait, + readUsage( + params: Params$Resource$Projects$Locations$Tensorboards$Readusage, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait, + readUsage( + params?: Params$Resource$Projects$Locations$Tensorboards$Readusage, options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait, + ): Promise< + GaxiosResponseWithHTTP2 + >; + readUsage( + params: Params$Resource$Projects$Locations$Tensorboards$Readusage, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait, + readUsage( + params: Params$Resource$Projects$Locations$Tensorboards$Readusage, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait, - callback: BodyResponseCallback + readUsage( + params: Params$Resource$Projects$Locations$Tensorboards$Readusage, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + readUsage( + callback: BodyResponseCallback ): void; - wait( + readUsage( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Readusage + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Tensorboards$Readusage; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait; + {} as Params$Resource$Projects$Locations$Tensorboards$Readusage; options = {}; } @@ -106618,97 +143345,145 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+tensorboard}:readUsage').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['tensorboard'], + pathParams: ['tensorboard'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel + export interface Params$Resource$Projects$Locations$Tensorboards$Batchread extends StandardParameters { /** - * The name of the operation resource to be cancelled. + * Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}`. The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard. */ - name?: string; + tensorboard?: string; + /** + * Required. The resource names of the TensorboardTimeSeries to read data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` + */ + timeSeries?: string[]; } - export interface Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete + export interface Params$Resource$Projects$Locations$Tensorboards$Create extends StandardParameters { /** - * The name of the operation resource to be deleted. + * Required. The resource name of the Location to create the Tensorboard in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Tensorboard; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Delete + extends StandardParameters { + /** + * Required. The name of the Tensorboard to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get + export interface Params$Resource$Projects$Locations$Tensorboards$Get extends StandardParameters { /** - * The name of the operation resource. + * Required. The name of the Tensorboard resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Ragengineconfig$Operations$List + export interface Params$Resource$Projects$Locations$Tensorboards$List extends StandardParameters { /** - * The standard list filter. + * Lists the Tensorboards that match the filter expression. */ filter?: string; /** - * The name of the operation's parent resource. + * Field to use to sort the list. */ - name?: string; + orderBy?: string; /** - * The standard list page size. + * The maximum number of Tensorboards to return. The service may return fewer than this value. If unspecified, at most 100 Tensorboards are returned. The maximum value is 100; values above 100 are coerced to 100. */ pageSize?: number; /** - * The standard list page token. + * A page token, received from a previous TensorboardService.ListTensorboards call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboards must match the call that provided the page token. */ pageToken?: string; /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * Required. The resource name of the Location to list Tensorboards. Format: `projects/{project\}/locations/{location\}` */ - returnPartialSuccess?: boolean; + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; } - export interface Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait + export interface Params$Resource$Projects$Locations$Tensorboards$Patch extends StandardParameters { /** - * The name of the operation resource to wait on. + * Output only. Name of the Tensorboard. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` */ name?: string; /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * Required. Field mask is used to specify the fields to be overwritten in the Tensorboard resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. */ - timeout?: string; + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Tensorboard; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Readsize + extends StandardParameters { + /** + * Required. The name of the Tensorboard resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` + */ + tensorboard?: string; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Readusage + extends StandardParameters { + /** + * Required. The name of the Tensorboard resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` + */ + tensorboard?: string; } - export class Resource$Projects$Locations$Reasoningengines { + export class Resource$Projects$Locations$Tensorboards$Experiments { context: APIRequestContext; - operations: Resource$Projects$Locations$Reasoningengines$Operations; + operations: Resource$Projects$Locations$Tensorboards$Experiments$Operations; + runs: Resource$Projects$Locations$Tensorboards$Experiments$Runs; constructor(context: APIRequestContext) { this.context = context; this.operations = - new Resource$Projects$Locations$Reasoningengines$Operations( + new Resource$Projects$Locations$Tensorboards$Experiments$Operations( this.context ); + this.runs = new Resource$Projects$Locations$Tensorboards$Experiments$Runs( + this.context + ); } /** - * Creates a reasoning engine. + * Batch create TensorboardTimeSeries that belong to a TensorboardExperiment. * @example * ```js * // Before running the sample: @@ -106737,35 +143512,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.reasoningEngines.create({ - * // Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * const res = + * await aiplatform.projects.locations.tensorboards.experiments.batchCreate({ + * // Required. The resource name of the TensorboardExperiment to create the TensorboardTimeSeries in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` The TensorboardRuns referenced by the parent fields in the CreateTensorboardTimeSeriesRequest messages must be sub resources of this TensorboardExperiment. + * parent: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "spec": {}, - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "requests": [] + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "tensorboardTimeSeries": [] * // } * } * @@ -106781,58 +143546,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Reasoningengines$Create, + batchCreate( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Reasoningengines$Create, + batchCreate( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Reasoningengines$Create, + ): Promise< + GaxiosResponseWithHTTP2 + >; + batchCreate( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Reasoningengines$Create, + batchCreate( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Reasoningengines$Create, - callback: BodyResponseCallback + batchCreate( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + batchCreate( + callback: BodyResponseCallback ): void; - create( + batchCreate( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Create; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Create; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate; options = {}; } @@ -106845,7 +143614,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/reasoningEngines').replace( + url: (rootUrl + '/v1/{+parent}:batchCreate').replace( /([^:]\/)\/+/g, '$1' ), @@ -106860,17 +143629,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a reasoning engine. + * Creates a TensorboardExperiment. * @example * ```js * // Before running the sample: @@ -106899,21 +143670,41 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.reasoningEngines.delete({ - * // Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources. - * force: 'placeholder-value', - * // Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', - * }); + * const res = + * await aiplatform.projects.locations.tensorboards.experiments.create({ + * // Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` + * parent: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', + * // Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`. + * tensorboardExperimentId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "source": "my_source", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, * // "name": "my_name", - * // "response": {} + * // "source": "my_source", + * // "updateTime": "my_updateTime" * // } * } * @@ -106929,58 +143720,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Delete, + create( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Create, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Reasoningengines$Delete, + create( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Create, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Delete, + create( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Delete, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Create, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - delete( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Delete; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Delete; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Create; options = {}; } @@ -106993,29 +143788,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/experiments').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a reasoning engine. + * Deletes a TensorboardExperiment. * @example * ```js * // Before running the sample: @@ -107044,23 +143844,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.reasoningEngines.get({ - * // Required. The name of the ReasoningEngine resource. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', - * }); + * const res = + * await aiplatform.projects.locations.tensorboards.experiments.delete({ + * // Required. The name of the TensorboardExperiment to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', + * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "spec": {}, - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -107076,61 +143873,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Reasoningengines$Get, + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Reasoningengines$Get, + delete( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Reasoningengines$Get, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Reasoningengines$Get, + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Reasoningengines$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - get( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Get; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Reasoningengines$Get; + params = + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete; options = {}; } @@ -107144,7 +143938,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -107155,19 +143949,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists reasoning engines in a location. + * Gets a TensorboardExperiment. * @example * ```js * // Before running the sample: @@ -107188,7 +143980,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -107196,22 +143991,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.reasoningEngines.list({ - * // Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). - * filter: 'placeholder-value', - * // Optional. The standard list page size. - * pageSize: 'placeholder-value', - * // Optional. The standard list page token. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * const res = await aiplatform.projects.locations.tensorboards.experiments.get({ + * // Required. The name of the TensorboardExperiment resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "reasoningEngines": [] + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "source": "my_source", + * // "updateTime": "my_updateTime" * // } * } * @@ -107227,61 +144022,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Reasoningengines$List, + get( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Reasoningengines$List, + get( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Reasoningengines$List, + get( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Reasoningengines$List, + get( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Reasoningengines$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$List; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Reasoningengines$List; + params = + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Get; options = {}; } @@ -107294,34 +144090,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/reasoningEngines').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a reasoning engine. + * Lists TensorboardExperiments in a Location. * @example * ```js * // Before running the sample: @@ -107342,7 +144135,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -107350,37 +144146,29 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.reasoningEngines.patch({ - * // Identifier. The resource name of the ReasoningEngine. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', - * // Optional. Mask specifying which fields to update. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "spec": {}, - * // "updateTime": "my_updateTime" - * // } + * const res = await aiplatform.projects.locations.tensorboards.experiments.list( + * { + * // Lists the TensorboardExperiments that match the filter expression. + * filter: 'placeholder-value', + * // Field to use to sort the list. + * orderBy: 'placeholder-value', + * // The maximum number of TensorboardExperiments to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardExperiments are returned. The maximum value is 1000; values above 1000 are coerced to 1000. + * pageSize: 'placeholder-value', + * // A page token, received from a previous TensorboardService.ListTensorboardExperiments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardExperiments must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Tensorboard to list TensorboardExperiments. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` + * parent: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', * }, - * }); + * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "tensorboardExperiments": [] * // } * } * @@ -107396,58 +144184,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Reasoningengines$Patch, + list( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$List, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Reasoningengines$Patch, + list( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$List, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Reasoningengines$Patch, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Reasoningengines$Patch, + list( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Reasoningengines$Patch, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$List, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - patch( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Patch; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Patch; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$List; options = {}; } @@ -107460,29 +144252,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+parent}/experiments').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Queries using a reasoning engine. + * Updates a TensorboardExperiment. * @example * ```js * // Before running the sample: @@ -107511,24 +144308,40 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.reasoningEngines.query({ - * // Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', + * const res = + * await aiplatform.projects.locations.tensorboards.experiments.patch({ + * // Output only. Name of the TensorboardExperiment. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', + * // Required. Field mask is used to specify the fields to be overwritten in the TensorboardExperiment resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. + * updateMask: 'placeholder-value', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "classMethod": "my_classMethod", - * // "input": {} - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "source": "my_source", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "output": {} + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "source": "my_source", + * // "updateTime": "my_updateTime" * // } * } * @@ -107544,62 +144357,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - query( - params: Params$Resource$Projects$Locations$Reasoningengines$Query, + patch( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch, options: StreamMethodOptions ): Promise>; - query( - params?: Params$Resource$Projects$Locations$Reasoningengines$Query, + patch( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - query( - params: Params$Resource$Projects$Locations$Reasoningengines$Query, + patch( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - query( - params: Params$Resource$Projects$Locations$Reasoningengines$Query, + patch( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - query( - params: Params$Resource$Projects$Locations$Reasoningengines$Query, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch, + callback: BodyResponseCallback ): void; - query( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - query( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Query - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Query; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Query; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch; options = {}; } @@ -107612,8 +144425,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:query').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -107624,19 +144437,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Streams queries using a reasoning engine. + * Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. If any data fail to be ingested, an error is returned. * @example * ```js * // Before running the sample: @@ -107665,27 +144478,24 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.reasoningEngines.streamQuery({ - * // Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', + * const res = + * await aiplatform.projects.locations.tensorboards.experiments.write({ + * // Required. The resource name of the TensorboardExperiment to write data to. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` + * tensorboardExperiment: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "classMethod": "my_classMethod", - * // "input": {} - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "writeRunDataRequests": [] + * // } + * }, + * }); * console.log(res.data); * * // Example response - * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] - * // } + * // {} * } * * main().catch(e => { @@ -107700,54 +144510,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - streamQuery( - params: Params$Resource$Projects$Locations$Reasoningengines$Streamquery, + write( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Write, options: StreamMethodOptions ): Promise>; - streamQuery( - params?: Params$Resource$Projects$Locations$Reasoningengines$Streamquery, + write( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Write, options?: MethodOptions - ): Promise>; - streamQuery( - params: Params$Resource$Projects$Locations$Reasoningengines$Streamquery, + ): Promise< + GaxiosResponseWithHTTP2 + >; + write( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Write, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - streamQuery( - params: Params$Resource$Projects$Locations$Reasoningengines$Streamquery, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + write( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Write, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - streamQuery( - params: Params$Resource$Projects$Locations$Reasoningengines$Streamquery, - callback: BodyResponseCallback + write( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Write, + callback: BodyResponseCallback ): void; - streamQuery(callback: BodyResponseCallback): void; - streamQuery( + write( + callback: BodyResponseCallback + ): void; + write( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Streamquery - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Write + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Streamquery; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Write; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Streamquery; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Write; options = {}; } @@ -107760,7 +144578,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:streamQuery').replace( + url: (rootUrl + '/v1/{+tensorboardExperiment}:write').replace( /([^:]\/)\/+/g, '$1' ), @@ -107770,112 +144588,122 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['tensorboardExperiment'], + pathParams: ['tensorboardExperiment'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Reasoningengines$Create + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate extends StandardParameters { /** - * Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project\}/locations/{location\}` + * Required. The resource name of the TensorboardExperiment to create the TensorboardTimeSeries in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` The TensorboardRuns referenced by the parent fields in the CreateTensorboardTimeSeriesRequest messages must be sub resources of this TensorboardExperiment. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1ReasoningEngine; + requestBody?: Schema$GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest; } - export interface Params$Resource$Projects$Locations$Reasoningengines$Delete + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Create extends StandardParameters { /** - * Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources. + * Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` */ - force?: boolean; + parent?: string; /** - * Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`. + */ + tensorboardExperimentId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1TensorboardExperiment; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete + extends StandardParameters { + /** + * Required. The name of the TensorboardExperiment to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Reasoningengines$Get + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Get extends StandardParameters { /** - * Required. The name of the ReasoningEngine resource. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * Required. The name of the TensorboardExperiment resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Reasoningengines$List + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$List extends StandardParameters { /** - * Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). + * Lists the TensorboardExperiments that match the filter expression. */ filter?: string; /** - * Optional. The standard list page size. + * Field to use to sort the list. + */ + orderBy?: string; + /** + * The maximum number of TensorboardExperiments to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardExperiments are returned. The maximum value is 1000; values above 1000 are coerced to 1000. */ pageSize?: number; /** - * Optional. The standard list page token. + * A page token, received from a previous TensorboardService.ListTensorboardExperiments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardExperiments must match the call that provided the page token. */ pageToken?: string; /** - * Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project\}/locations/{location\}` + * Required. The resource name of the Tensorboard to list TensorboardExperiments. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` */ parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; } - export interface Params$Resource$Projects$Locations$Reasoningengines$Patch + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch extends StandardParameters { /** - * Identifier. The resource name of the ReasoningEngine. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * Output only. Name of the TensorboardExperiment. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` */ name?: string; /** - * Optional. Mask specifying which fields to update. + * Required. Field mask is used to specify the fields to be overwritten in the TensorboardExperiment resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1ReasoningEngine; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Query - extends StandardParameters { - /** - * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1QueryReasoningEngineRequest; + requestBody?: Schema$GoogleCloudAiplatformV1TensorboardExperiment; } - export interface Params$Resource$Projects$Locations$Reasoningengines$Streamquery + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Write extends StandardParameters { /** - * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * Required. The resource name of the TensorboardExperiment to write data to. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` */ - name?: string; + tensorboardExperiment?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest; + requestBody?: Schema$GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest; } - export class Resource$Projects$Locations$Reasoningengines$Operations { + export class Resource$Projects$Locations$Tensorboards$Experiments$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -107912,10 +144740,12 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/operations/my-operation', - * }); + * await aiplatform.projects.locations.tensorboards.experiments.operations.cancel( + * { + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response @@ -107935,31 +144765,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -107975,13 +144805,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel; options = {}; } @@ -108046,10 +144876,12 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/operations/my-operation', - * }); + * await aiplatform.projects.locations.tensorboards.experiments.operations.delete( + * { + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response @@ -108069,31 +144901,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete, + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -108109,13 +144941,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete; options = {}; } @@ -108180,10 +145012,12 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/operations/my-operation', - * }); + * await aiplatform.projects.locations.tensorboards.experiments.operations.get( + * { + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response @@ -108209,27 +145043,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Get, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Reasoningengines$Operations$Get, + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Get, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Get, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Get, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -108237,7 +145071,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Operations$Get + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -108253,13 +145087,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Operations$Get; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Operations$Get; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get; options = {}; } @@ -108324,18 +145158,20 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * await aiplatform.projects.locations.tensorboards.experiments.operations.list( + * { + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response @@ -108359,29 +145195,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$List, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Reasoningengines$Operations$List, + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$List, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$List, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$List, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List, callback: BodyResponseCallback ): void; list( @@ -108389,7 +145225,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Operations$List + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -108407,13 +145243,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Operations$List; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Operations$List; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List; options = {}; } @@ -108483,12 +145319,14 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); + * await aiplatform.projects.locations.tensorboards.experiments.operations.wait( + * { + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response @@ -108514,27 +145352,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait, + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -108542,7 +145380,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -108558,13 +145396,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait; options = {}; } @@ -108599,28 +145437,28 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Reasoningengines$Operations$Get + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Reasoningengines$Operations$List + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List extends StandardParameters { /** * The standard list filter. @@ -108643,7 +145481,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -108655,18 +145493,24 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Schedules { + export class Resource$Projects$Locations$Tensorboards$Experiments$Runs { context: APIRequestContext; - operations: Resource$Projects$Locations$Schedules$Operations; + operations: Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations; + timeSeries: Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries; constructor(context: APIRequestContext) { this.context = context; - this.operations = new Resource$Projects$Locations$Schedules$Operations( - this.context - ); + this.operations = + new Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations( + this.context + ); + this.timeSeries = + new Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries( + this.context + ); } /** - * Creates a Schedule. + * Batch create TensorboardRuns. * @example * ```js * // Before running the sample: @@ -108695,59 +145539,27 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.schedules.create({ - * // Required. The resource name of the Location to create the Schedule in. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * const res = + * await aiplatform.projects.locations.tensorboards.experiments.runs.batchCreate( + * { + * // Required. The resource name of the TensorboardExperiment to create the TensorboardRuns in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` The parent field in the CreateTensorboardRunRequest messages must match this field. + * parent: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "allowQueueing": false, - * // "catchUp": false, - * // "createNotebookExecutionJobRequest": {}, - * // "createPipelineJobRequest": {}, - * // "createTime": "my_createTime", - * // "cron": "my_cron", - * // "displayName": "my_displayName", - * // "endTime": "my_endTime", - * // "lastPauseTime": "my_lastPauseTime", - * // "lastResumeTime": "my_lastResumeTime", - * // "lastScheduledRunResponse": {}, - * // "maxConcurrentRunCount": "my_maxConcurrentRunCount", - * // "maxRunCount": "my_maxRunCount", - * // "name": "my_name", - * // "nextRunTime": "my_nextRunTime", - * // "startTime": "my_startTime", - * // "startedRunCount": "my_startedRunCount", - * // "state": "my_state", - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "requests": [] + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "allowQueueing": false, - * // "catchUp": false, - * // "createNotebookExecutionJobRequest": {}, - * // "createPipelineJobRequest": {}, - * // "createTime": "my_createTime", - * // "cron": "my_cron", - * // "displayName": "my_displayName", - * // "endTime": "my_endTime", - * // "lastPauseTime": "my_lastPauseTime", - * // "lastResumeTime": "my_lastResumeTime", - * // "lastScheduledRunResponse": {}, - * // "maxConcurrentRunCount": "my_maxConcurrentRunCount", - * // "maxRunCount": "my_maxRunCount", - * // "name": "my_name", - * // "nextRunTime": "my_nextRunTime", - * // "startTime": "my_startTime", - * // "startedRunCount": "my_startedRunCount", - * // "state": "my_state", - * // "updateTime": "my_updateTime" + * // "tensorboardRuns": [] * // } * } * @@ -108763,57 +145575,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Schedules$Create, + batchCreate( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Schedules$Create, + batchCreate( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Schedules$Create, + ): Promise< + GaxiosResponseWithHTTP2 + >; + batchCreate( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Schedules$Create, + batchCreate( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Schedules$Create, - callback: BodyResponseCallback + batchCreate( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + batchCreate( + callback: BodyResponseCallback ): void; - create( + batchCreate( paramsOrCallback?: - | Params$Resource$Projects$Locations$Schedules$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Schedules$Create; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Schedules$Create; + params = + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate; options = {}; } @@ -108826,7 +145643,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/schedules').replace( + url: (rootUrl + '/v1/{+parent}/runs:batchCreate').replace( /([^:]\/)\/+/g, '$1' ), @@ -108841,19 +145658,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a Schedule. + * Creates a TensorboardRun. * @example * ```js * // Before running the sample: @@ -108882,19 +145699,39 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.schedules.delete({ - * // Required. The name of the Schedule resource to be deleted. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` - * name: 'projects/my-project/locations/my-location/schedules/my-schedule', - * }); + * const res = + * await aiplatform.projects.locations.tensorboards.experiments.runs.create({ + * // Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` + * parent: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', + * // Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`. + * tensorboardRunId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, * // "name": "my_name", - * // "response": {} + * // "updateTime": "my_updateTime" * // } * } * @@ -108910,57 +145747,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Schedules$Delete, + create( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Schedules$Delete, + create( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Schedules$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Schedules$Delete, + create( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Schedules$Delete, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - delete( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Schedules$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Schedules$Delete; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Schedules$Delete; + params = + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create; options = {}; } @@ -108973,29 +145815,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/runs').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a Schedule. + * Deletes a TensorboardRun. * @example * ```js * // Before running the sample: @@ -109024,33 +145868,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.schedules.get({ - * // Required. The name of the Schedule resource. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` - * name: 'projects/my-project/locations/my-location/schedules/my-schedule', - * }); + * const res = + * await aiplatform.projects.locations.tensorboards.experiments.runs.delete({ + * // Required. The name of the TensorboardRun to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', + * }); * console.log(res.data); * * // Example response * // { - * // "allowQueueing": false, - * // "catchUp": false, - * // "createNotebookExecutionJobRequest": {}, - * // "createPipelineJobRequest": {}, - * // "createTime": "my_createTime", - * // "cron": "my_cron", - * // "displayName": "my_displayName", - * // "endTime": "my_endTime", - * // "lastPauseTime": "my_lastPauseTime", - * // "lastResumeTime": "my_lastResumeTime", - * // "lastScheduledRunResponse": {}, - * // "maxConcurrentRunCount": "my_maxConcurrentRunCount", - * // "maxRunCount": "my_maxRunCount", + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "nextRunTime": "my_nextRunTime", - * // "startTime": "my_startTime", - * // "startedRunCount": "my_startedRunCount", - * // "state": "my_state", - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -109066,57 +145897,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Schedules$Get, + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Schedules$Get, + delete( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Schedules$Get, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Schedules$Get, + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Schedules$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - get( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Schedules$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Schedules$Get; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Schedules$Get; + params = + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete; options = {}; } @@ -109130,7 +145962,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -109141,19 +145973,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists Schedules in a Location. + * Gets a TensorboardRun. * @example * ```js * // Before running the sample: @@ -109174,7 +146004,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -109182,24 +146015,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.schedules.list({ - * // Lists the Schedules that match the filter expression. The following fields are supported: * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `state`: Supports `=` and `!=` comparisons. * `request`: Supports existence of the check. (e.g. `create_pipeline_job_request:*` --\> Schedule has create_pipeline_job_request). * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `start_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, `\>=` comparisons and `:*` existence check. Values must be in RFC 3339 format. * `next_run_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. Filter expressions can be combined together using logical operators (`NOT`, `AND` & `OR`). The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `state="ACTIVE" AND display_name:"my_schedule_*"` * `NOT display_name="my_schedule"` * `create_time\>"2021-05-18T00:00:00Z"` * `end_time\>"2021-05-18T00:00:00Z" OR NOT end_time:*` * `create_pipeline_job_request:*` - * filter: 'placeholder-value', - * // A comma-separated list of fields to order by. The default sort order is in ascending order. Use "desc" after a field name for descending. You can have multiple order_by fields provided. For example, using "create_time desc, end_time" will order results by create time in descending order, and if there are multiple schedules having the same create time, order them by the end time in ascending order. If order_by is not specified, it will order by default with create_time in descending order. Supported fields: * `create_time` * `start_time` * `end_time` * `next_run_time` - * orderBy: 'placeholder-value', - * // The standard list page size. Default to 100 if not specified. - * pageSize: 'placeholder-value', - * // The standard list page token. Typically obtained via ListSchedulesResponse.next_page_token of the previous ScheduleService.ListSchedules call. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list the Schedules from. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * }); + * const res = + * await aiplatform.projects.locations.tensorboards.experiments.runs.get({ + * // Required. The name of the TensorboardRun resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', + * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "schedules": [] + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime" * // } * } * @@ -109215,61 +146046,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Schedules$List, + get( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Schedules$List, + get( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Schedules$List, + get( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Schedules$List, + get( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Schedules$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Schedules$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Schedules$List; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Schedules$List; + params = + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get; options = {}; } @@ -109282,34 +146114,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/schedules').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates an active or paused Schedule. When the Schedule is updated, new runs will be scheduled starting from the updated next execution time after the update time based on the time_specification in the updated Schedule. All unstarted runs before the update time will be skipped while already created runs will NOT be paused or canceled. + * Lists TensorboardRuns in a Location. * @example * ```js * // Before running the sample: @@ -109330,7 +146159,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -109338,61 +146170,28 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.schedules.patch({ - * // Immutable. The resource name of the Schedule. - * name: 'projects/my-project/locations/my-location/schedules/my-schedule', - * // Required. The update mask applies to the resource. See google.protobuf.FieldMask. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "allowQueueing": false, - * // "catchUp": false, - * // "createNotebookExecutionJobRequest": {}, - * // "createPipelineJobRequest": {}, - * // "createTime": "my_createTime", - * // "cron": "my_cron", - * // "displayName": "my_displayName", - * // "endTime": "my_endTime", - * // "lastPauseTime": "my_lastPauseTime", - * // "lastResumeTime": "my_lastResumeTime", - * // "lastScheduledRunResponse": {}, - * // "maxConcurrentRunCount": "my_maxConcurrentRunCount", - * // "maxRunCount": "my_maxRunCount", - * // "name": "my_name", - * // "nextRunTime": "my_nextRunTime", - * // "startTime": "my_startTime", - * // "startedRunCount": "my_startedRunCount", - * // "state": "my_state", - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * const res = + * await aiplatform.projects.locations.tensorboards.experiments.runs.list({ + * // Lists the TensorboardRuns that match the filter expression. + * filter: 'placeholder-value', + * // Field to use to sort the list. + * orderBy: 'placeholder-value', + * // The maximum number of TensorboardRuns to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardRuns are returned. The maximum value is 1000; values above 1000 are coerced to 1000. + * pageSize: 'placeholder-value', + * // A page token, received from a previous TensorboardService.ListTensorboardRuns call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardRuns must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` + * parent: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "allowQueueing": false, - * // "catchUp": false, - * // "createNotebookExecutionJobRequest": {}, - * // "createPipelineJobRequest": {}, - * // "createTime": "my_createTime", - * // "cron": "my_cron", - * // "displayName": "my_displayName", - * // "endTime": "my_endTime", - * // "lastPauseTime": "my_lastPauseTime", - * // "lastResumeTime": "my_lastResumeTime", - * // "lastScheduledRunResponse": {}, - * // "maxConcurrentRunCount": "my_maxConcurrentRunCount", - * // "maxRunCount": "my_maxRunCount", - * // "name": "my_name", - * // "nextRunTime": "my_nextRunTime", - * // "startTime": "my_startTime", - * // "startedRunCount": "my_startedRunCount", - * // "state": "my_state", - * // "updateTime": "my_updateTime" + * // "nextPageToken": "my_nextPageToken", + * // "tensorboardRuns": [] * // } * } * @@ -109408,57 +146207,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Schedules$Patch, + list( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Schedules$Patch, + list( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Schedules$Patch, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Schedules$Patch, + list( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Schedules$Patch, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - patch( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Schedules$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Schedules$Patch; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Schedules$Patch; + params = + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List; options = {}; } @@ -109471,31 +146275,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+parent}/runs').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled. + * Updates a TensorboardRun. * @example * ```js * // Before running the sample: @@ -109524,20 +146328,39 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.schedules.pause({ - * // Required. The name of the Schedule resource to be paused. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` - * name: 'projects/my-project/locations/my-location/schedules/my-schedule', + * const res = + * await aiplatform.projects.locations.tensorboards.experiments.runs.patch({ + * // Output only. Name of the TensorboardRun. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', + * // Required. Field mask is used to specify the fields to be overwritten in the TensorboardRun resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. + * updateMask: 'placeholder-value', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime" + * // } * } * * main().catch(e => { @@ -109552,53 +146375,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - pause( - params: Params$Resource$Projects$Locations$Schedules$Pause, + patch( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch, options: StreamMethodOptions ): Promise>; - pause( - params?: Params$Resource$Projects$Locations$Schedules$Pause, + patch( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch, options?: MethodOptions - ): Promise>; - pause( - params: Params$Resource$Projects$Locations$Schedules$Pause, + ): Promise< + GaxiosResponseWithHTTP2 + >; + patch( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - pause( - params: Params$Resource$Projects$Locations$Schedules$Pause, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - pause( - params: Params$Resource$Projects$Locations$Schedules$Pause, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch, + callback: BodyResponseCallback ): void; - pause(callback: BodyResponseCallback): void; - pause( + patch( + callback: BodyResponseCallback + ): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Schedules$Pause - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Schedules$Pause; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Schedules$Pause; + params = + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch; options = {}; } @@ -109611,8 +146443,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:pause').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -109623,17 +146455,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Resumes a paused Schedule to start scheduling new runs. Will mark Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed. When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If Schedule.catch_up is set up true, all missed runs will be scheduled for backfill first. + * Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned. * @example * ```js * // Before running the sample: @@ -109662,18 +146496,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.schedules.resume({ - * // Required. The name of the Schedule resource to be resumed. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` - * name: 'projects/my-project/locations/my-location/schedules/my-schedule', + * const res = + * await aiplatform.projects.locations.tensorboards.experiments.runs.write({ + * // Required. The resource name of the TensorboardRun to write data to. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` + * tensorboardRun: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "catchUp": false - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "tensorboardRun": "my_tensorboardRun", + * // "timeSeriesData": [] + * // } + * }, + * }); * console.log(res.data); * * // Example response @@ -109692,53 +146529,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - resume( - params: Params$Resource$Projects$Locations$Schedules$Resume, + write( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write, options: StreamMethodOptions ): Promise>; - resume( - params?: Params$Resource$Projects$Locations$Schedules$Resume, + write( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write, options?: MethodOptions - ): Promise>; - resume( - params: Params$Resource$Projects$Locations$Schedules$Resume, + ): Promise< + GaxiosResponseWithHTTP2 + >; + write( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - resume( - params: Params$Resource$Projects$Locations$Schedules$Resume, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + write( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - resume( - params: Params$Resource$Projects$Locations$Schedules$Resume, - callback: BodyResponseCallback + write( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write, + callback: BodyResponseCallback ): void; - resume(callback: BodyResponseCallback): void; - resume( + write( + callback: BodyResponseCallback + ): void; + write( paramsOrCallback?: - | Params$Resource$Projects$Locations$Schedules$Resume - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Schedules$Resume; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Schedules$Resume; + params = + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write; options = {}; } @@ -109751,119 +146597,132 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:resume').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+tensorboardRun}:write').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['tensorboardRun'], + pathParams: ['tensorboardRun'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Schedules$Create + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate extends StandardParameters { /** - * Required. The resource name of the Location to create the Schedule in. Format: `projects/{project\}/locations/{location\}` + * Required. The resource name of the TensorboardExperiment to create the TensorboardRuns in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` The parent field in the CreateTensorboardRunRequest messages must match this field. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1Schedule; + requestBody?: Schema$GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest; } - export interface Params$Resource$Projects$Locations$Schedules$Delete + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create extends StandardParameters { /** - * Required. The name of the Schedule resource to be deleted. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` + * Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` + */ + parent?: string; + /** + * Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`. + */ + tensorboardRunId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1TensorboardRun; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete + extends StandardParameters { + /** + * Required. The name of the TensorboardRun to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Schedules$Get + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get extends StandardParameters { /** - * Required. The name of the Schedule resource. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` + * Required. The name of the TensorboardRun resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Schedules$List + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List extends StandardParameters { /** - * Lists the Schedules that match the filter expression. The following fields are supported: * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `state`: Supports `=` and `!=` comparisons. * `request`: Supports existence of the check. (e.g. `create_pipeline_job_request:*` --\> Schedule has create_pipeline_job_request). * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `start_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, `\>=` comparisons and `:*` existence check. Values must be in RFC 3339 format. * `next_run_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. Filter expressions can be combined together using logical operators (`NOT`, `AND` & `OR`). The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `state="ACTIVE" AND display_name:"my_schedule_*"` * `NOT display_name="my_schedule"` * `create_time\>"2021-05-18T00:00:00Z"` * `end_time\>"2021-05-18T00:00:00Z" OR NOT end_time:*` * `create_pipeline_job_request:*` + * Lists the TensorboardRuns that match the filter expression. */ filter?: string; /** - * A comma-separated list of fields to order by. The default sort order is in ascending order. Use "desc" after a field name for descending. You can have multiple order_by fields provided. For example, using "create_time desc, end_time" will order results by create time in descending order, and if there are multiple schedules having the same create time, order them by the end time in ascending order. If order_by is not specified, it will order by default with create_time in descending order. Supported fields: * `create_time` * `start_time` * `end_time` * `next_run_time` + * Field to use to sort the list. */ orderBy?: string; /** - * The standard list page size. Default to 100 if not specified. + * The maximum number of TensorboardRuns to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardRuns are returned. The maximum value is 1000; values above 1000 are coerced to 1000. */ pageSize?: number; /** - * The standard list page token. Typically obtained via ListSchedulesResponse.next_page_token of the previous ScheduleService.ListSchedules call. + * A page token, received from a previous TensorboardService.ListTensorboardRuns call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardRuns must match the call that provided the page token. */ pageToken?: string; /** - * Required. The resource name of the Location to list the Schedules from. Format: `projects/{project\}/locations/{location\}` + * Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` */ parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; } - export interface Params$Resource$Projects$Locations$Schedules$Patch + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch extends StandardParameters { /** - * Immutable. The resource name of the Schedule. + * Output only. Name of the TensorboardRun. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` */ name?: string; /** - * Required. The update mask applies to the resource. See google.protobuf.FieldMask. + * Required. Field mask is used to specify the fields to be overwritten in the TensorboardRun resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1Schedule; - } - export interface Params$Resource$Projects$Locations$Schedules$Pause - extends StandardParameters { - /** - * Required. The name of the Schedule resource to be paused. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1PauseScheduleRequest; + requestBody?: Schema$GoogleCloudAiplatformV1TensorboardRun; } - export interface Params$Resource$Projects$Locations$Schedules$Resume + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write extends StandardParameters { /** - * Required. The name of the Schedule resource to be resumed. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` + * Required. The resource name of the TensorboardRun to write data to. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` */ - name?: string; + tensorboardRun?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1ResumeScheduleRequest; + requestBody?: Schema$GoogleCloudAiplatformV1WriteTensorboardRunDataRequest; } - export class Resource$Projects$Locations$Schedules$Operations { + export class Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -109899,10 +146758,13 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.schedules.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/schedules/my-schedule/operations/my-operation', - * }); + * const res = + * await aiplatform.projects.locations.tensorboards.experiments.runs.operations.cancel( + * { + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response @@ -109922,31 +146784,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Schedules$Operations$Cancel, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Schedules$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Schedules$Operations$Cancel, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Schedules$Operations$Cancel, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Schedules$Operations$Cancel, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Schedules$Operations$Cancel + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -109962,13 +146824,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Schedules$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Schedules$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel; options = {}; } @@ -110032,10 +146894,13 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.schedules.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/schedules/my-schedule/operations/my-operation', - * }); + * const res = + * await aiplatform.projects.locations.tensorboards.experiments.runs.operations.delete( + * { + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response @@ -110055,31 +146920,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Schedules$Operations$Delete, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Schedules$Operations$Delete, + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Schedules$Operations$Delete, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Schedules$Operations$Delete, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Schedules$Operations$Delete, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Schedules$Operations$Delete + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -110095,13 +146960,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Schedules$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Schedules$Operations$Delete; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete; options = {}; } @@ -110165,10 +147030,13 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.schedules.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/schedules/my-schedule/operations/my-operation', - * }); + * const res = + * await aiplatform.projects.locations.tensorboards.experiments.runs.operations.get( + * { + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response @@ -110194,27 +147062,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Schedules$Operations$Get, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Schedules$Operations$Get, + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Schedules$Operations$Get, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Schedules$Operations$Get, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Schedules$Operations$Get, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -110222,7 +147090,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Schedules$Operations$Get + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -110238,13 +147106,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Schedules$Operations$Get; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Schedules$Operations$Get; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get; options = {}; } @@ -110308,18 +147176,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.schedules.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/schedules/my-schedule', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.tensorboards.experiments.runs.operations.list( + * { + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response @@ -110343,29 +147214,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Schedules$Operations$List, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Schedules$Operations$List, + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Schedules$Operations$List, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Schedules$Operations$List, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Schedules$Operations$List, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List, callback: BodyResponseCallback ): void; list( @@ -110373,7 +147244,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Schedules$Operations$List + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -110391,13 +147262,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Schedules$Operations$List; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Schedules$Operations$List; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List; options = {}; } @@ -110466,12 +147337,15 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.schedules.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/schedules/my-schedule/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.tensorboards.experiments.runs.operations.wait( + * { + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response @@ -110497,27 +147371,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Schedules$Operations$Wait, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Schedules$Operations$Wait, + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Schedules$Operations$Wait, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Schedules$Operations$Wait, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Schedules$Operations$Wait, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -110525,7 +147399,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Schedules$Operations$Wait + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -110541,13 +147415,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Schedules$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Schedules$Operations$Wait; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait; options = {}; } @@ -110582,28 +147456,28 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Schedules$Operations$Cancel + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Schedules$Operations$Delete + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Schedules$Operations$Get + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Schedules$Operations$List + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List extends StandardParameters { /** * The standard list filter. @@ -110626,7 +147500,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Schedules$Operations$Wait + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -110638,19 +147512,19 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Specialistpools { + export class Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries { context: APIRequestContext; - operations: Resource$Projects$Locations$Specialistpools$Operations; + operations: Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations; constructor(context: APIRequestContext) { this.context = context; this.operations = - new Resource$Projects$Locations$Specialistpools$Operations( + new Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations( this.context ); } /** - * Creates a SpecialistPool. + * Creates a TensorboardTimeSeries. * @example * ```js * // Before running the sample: @@ -110679,32 +147553,47 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.specialistPools.create({ - * // Required. The parent Project name for the new SpecialistPool. The form is `projects/{project\}/locations/{location\}`. - * parent: 'projects/my-project/locations/my-location', + * const res = + * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.create( + * { + * // Required. The resource name of the TensorboardRun to create the TensorboardTimeSeries in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` + * parent: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', + * // Optional. The user specified unique ID to use for the TensorboardTimeSeries, which becomes the final component of the TensorboardTimeSeries's resource name. This value should match "a-z0-9{0, 127\}" + * tensorboardTimeSeriesId: 'placeholder-value', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "displayName": "my_displayName", - * // "name": "my_name", - * // "pendingDataLabelingJobs": [], - * // "specialistManagerEmails": [], - * // "specialistManagersCount": 0, - * // "specialistWorkerEmails": [] - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "metadata": {}, + * // "name": "my_name", + * // "pluginData": "my_pluginData", + * // "pluginName": "my_pluginName", + * // "updateTime": "my_updateTime", + * // "valueType": "my_valueType" + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", * // "metadata": {}, * // "name": "my_name", - * // "response": {} + * // "pluginData": "my_pluginData", + * // "pluginName": "my_pluginName", + * // "updateTime": "my_updateTime", + * // "valueType": "my_valueType" * // } * } * @@ -110721,57 +147610,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Specialistpools$Create, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create, options: StreamMethodOptions ): Promise>; create( - params?: Params$Resource$Projects$Locations$Specialistpools$Create, + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create, options?: MethodOptions - ): Promise>; + ): Promise< + GaxiosResponseWithHTTP2 + >; create( - params: Params$Resource$Projects$Locations$Specialistpools$Create, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Specialistpools$Create, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Specialistpools$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Specialistpools$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Specialistpools$Create; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Specialistpools$Create; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create; options = {}; } @@ -110784,7 +147677,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/specialistPools').replace( + url: (rootUrl + '/v1/{+parent}/timeSeries').replace( /([^:]\/)\/+/g, '$1' ), @@ -110799,17 +147692,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a SpecialistPool as well as all Specialists in the pool. + * Deletes a TensorboardTimeSeries. * @example * ```js * // Before running the sample: @@ -110838,12 +147733,13 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.specialistPools.delete({ - * // If set to true, any specialist managers in this SpecialistPool will also be deleted. (Otherwise, the request will only work if the SpecialistPool has no specialist managers.) - * force: 'placeholder-value', - * // Required. The resource name of the SpecialistPool to delete. Format: `projects/{project\}/locations/{location\}/specialistPools/{specialist_pool\}` - * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool', - * }); + * const res = + * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.delete( + * { + * // Required. The name of the TensorboardTimeSeries to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', + * }, + * ); * console.log(res.data); * * // Example response @@ -110869,27 +147765,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Specialistpools$Delete, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Specialistpools$Delete, + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Specialistpools$Delete, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Specialistpools$Delete, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Specialistpools$Delete, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete, callback: BodyResponseCallback ): void; delete( @@ -110897,7 +147793,7 @@ export namespace aiplatform_v1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Specialistpools$Delete + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -110913,13 +147809,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Specialistpools$Delete; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Specialistpools$Delete; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete; options = {}; } @@ -110954,7 +147850,7 @@ export namespace aiplatform_v1 { } /** - * Gets a SpecialistPool. + * Exports a TensorboardTimeSeries' data. Data is returned in paginated responses. * @example * ```js * // Before running the sample: @@ -110983,20 +147879,194 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.specialistPools.get({ - * // Required. The name of the SpecialistPool resource. The form is `projects/{project\}/locations/{location\}/specialistPools/{specialist_pool\}`. - * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool', + * const res = + * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.exportTensorboardTimeSeries( + * { + * // Required. The resource name of the TensorboardTimeSeries to export data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` + * tensorboardTimeSeries: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "filter": "my_filter", + * // "orderBy": "my_orderBy", + * // "pageSize": 0, + * // "pageToken": "my_pageToken" + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "timeSeriesDataPoints": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + exportTensorboardTimeSeries( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries, + options: StreamMethodOptions + ): Promise>; + exportTensorboardTimeSeries( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + exportTensorboardTimeSeries( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + exportTensorboardTimeSeries( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + exportTensorboardTimeSeries( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries, + callback: BodyResponseCallback + ): void; + exportTensorboardTimeSeries( + callback: BodyResponseCallback + ): void; + exportTensorboardTimeSeries( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/{+tensorboardTimeSeries}:exportTensorboardTimeSeries' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['tensorboardTimeSeries'], + pathParams: ['tensorboardTimeSeries'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets a TensorboardTimeSeries. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.get( + * { + * // Required. The name of the TensorboardTimeSeries resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', + * }, + * ); * console.log(res.data); * * // Example response * // { + * // "createTime": "my_createTime", + * // "description": "my_description", * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "metadata": {}, * // "name": "my_name", - * // "pendingDataLabelingJobs": [], - * // "specialistManagerEmails": [], - * // "specialistManagersCount": 0, - * // "specialistWorkerEmails": [] + * // "pluginData": "my_pluginData", + * // "pluginName": "my_pluginName", + * // "updateTime": "my_updateTime", + * // "valueType": "my_valueType" * // } * } * @@ -111013,60 +148083,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Specialistpools$Get, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Specialistpools$Get, + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; get( - params: Params$Resource$Projects$Locations$Specialistpools$Get, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Specialistpools$Get, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Specialistpools$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Specialistpools$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Specialistpools$Get; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Specialistpools$Get; + params = + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get; options = {}; } @@ -111091,19 +148162,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists SpecialistPools in a Location. + * Lists TensorboardTimeSeries in a Location. * @example * ```js * // Before running the sample: @@ -111124,7 +148195,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -111132,22 +148206,30 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.specialistPools.list({ - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. Typically obtained by ListSpecialistPoolsResponse.next_page_token of the previous SpecialistPoolService.ListSpecialistPools call. Return first page if empty. - * pageToken: 'placeholder-value', - * // Required. The name of the SpecialistPool's parent resource. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * // Mask specifying which fields to read. FieldMask represents a set of - * readMask: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.list( + * { + * // Lists the TensorboardTimeSeries that match the filter expression. + * filter: 'placeholder-value', + * // Field to use to sort the list. + * orderBy: 'placeholder-value', + * // The maximum number of TensorboardTimeSeries to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardTimeSeries are returned. The maximum value is 1000; values above 1000 are coerced to 1000. + * pageSize: 'placeholder-value', + * // A page token, received from a previous TensorboardService.ListTensorboardTimeSeries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardTimeSeries must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` + * parent: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "specialistPools": [] + * // "tensorboardTimeSeries": [] * // } * } * @@ -111164,60 +148246,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Specialistpools$List, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Specialistpools$List, + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Specialistpools$List, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Specialistpools$List, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Specialistpools$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Specialistpools$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Specialistpools$List; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Specialistpools$List; + params = + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List; options = {}; } @@ -111230,7 +148313,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/specialistPools').replace( + url: (rootUrl + '/v1/{+parent}/timeSeries').replace( /([^:]\/)\/+/g, '$1' ), @@ -111245,19 +148328,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a SpecialistPool. + * Updates a TensorboardTimeSeries. * @example * ```js * // Before running the sample: @@ -111286,34 +148369,46 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.specialistPools.patch({ - * // Required. The resource name of the SpecialistPool. - * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool', - * // Required. The update mask applies to the resource. - * updateMask: 'placeholder-value', + * const res = + * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.patch( + * { + * // Output only. Name of the TensorboardTimeSeries. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', + * // Required. Field mask is used to specify the fields to be overwritten in the TensorboardTimeSeries resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. + * updateMask: 'placeholder-value', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "displayName": "my_displayName", - * // "name": "my_name", - * // "pendingDataLabelingJobs": [], - * // "specialistManagerEmails": [], - * // "specialistManagersCount": 0, - * // "specialistWorkerEmails": [] - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "metadata": {}, + * // "name": "my_name", + * // "pluginData": "my_pluginData", + * // "pluginName": "my_pluginName", + * // "updateTime": "my_updateTime", + * // "valueType": "my_valueType" + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", * // "metadata": {}, * // "name": "my_name", - * // "response": {} + * // "pluginData": "my_pluginData", + * // "pluginName": "my_pluginName", + * // "updateTime": "my_updateTime", + * // "valueType": "my_valueType" * // } * } * @@ -111330,56 +148425,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Specialistpools$Patch, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch, options: StreamMethodOptions ): Promise>; patch( - params?: Params$Resource$Projects$Locations$Specialistpools$Patch, + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch, options?: MethodOptions - ): Promise>; + ): Promise< + GaxiosResponseWithHTTP2 + >; patch( - params: Params$Resource$Projects$Locations$Specialistpools$Patch, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Specialistpools$Patch, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Specialistpools$Patch, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch, + callback: BodyResponseCallback ): void; patch( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Specialistpools$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Specialistpools$Patch; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Specialistpools$Patch; + params = + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch; options = {}; } @@ -111404,83 +148504,447 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); + } + } + + /** + * Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.read( + * { + * // Reads the TensorboardTimeSeries' data that match the filter expression. + * filter: 'placeholder-value', + * // The maximum number of TensorboardTimeSeries' data to return. This value should be a positive integer. This value can be set to -1 to return all data. + * maxDataPoints: 'placeholder-value', + * // Required. The resource name of the TensorboardTimeSeries to read data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` + * tensorboardTimeSeries: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "timeSeriesData": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + read( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read, + options: StreamMethodOptions + ): Promise>; + read( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + read( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + read( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + read( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read, + callback: BodyResponseCallback + ): void; + read( + callback: BodyResponseCallback + ): void; + read( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+tensorboardTimeSeries}:read').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['tensorboardTimeSeries'], + pathParams: ['tensorboardTimeSeries'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets bytes of TensorboardBlobs. This is to allow reading blob data stored in consumer project's Cloud Storage bucket without users having to obtain Cloud Storage access permission. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.readBlobData( + * { + * // IDs of the blobs to read. + * blobIds: 'placeholder-value', + * // Required. The resource name of the TensorboardTimeSeries to list Blobs. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` + * timeSeries: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "blobs": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + readBlobData( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata, + options: StreamMethodOptions + ): Promise>; + readBlobData( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + readBlobData( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + readBlobData( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + readBlobData( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata, + callback: BodyResponseCallback + ): void; + readBlobData( + callback: BodyResponseCallback + ): void; + readBlobData( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+timeSeries}:readBlobData').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['timeSeries'], + pathParams: ['timeSeries'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Specialistpools$Create + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create extends StandardParameters { /** - * Required. The parent Project name for the new SpecialistPool. The form is `projects/{project\}/locations/{location\}`. + * Required. The resource name of the TensorboardRun to create the TensorboardTimeSeries in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` */ parent?: string; + /** + * Optional. The user specified unique ID to use for the TensorboardTimeSeries, which becomes the final component of the TensorboardTimeSeries's resource name. This value should match "a-z0-9{0, 127\}" + */ + tensorboardTimeSeriesId?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1SpecialistPool; + requestBody?: Schema$GoogleCloudAiplatformV1TensorboardTimeSeries; } - export interface Params$Resource$Projects$Locations$Specialistpools$Delete + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete extends StandardParameters { /** - * If set to true, any specialist managers in this SpecialistPool will also be deleted. (Otherwise, the request will only work if the SpecialistPool has no specialist managers.) + * Required. The name of the TensorboardTimeSeries to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` */ - force?: boolean; + name?: string; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries + extends StandardParameters { /** - * Required. The resource name of the SpecialistPool to delete. Format: `projects/{project\}/locations/{location\}/specialistPools/{specialist_pool\}` + * Required. The resource name of the TensorboardTimeSeries to export data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` */ - name?: string; + tensorboardTimeSeries?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest; } - export interface Params$Resource$Projects$Locations$Specialistpools$Get + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get extends StandardParameters { /** - * Required. The name of the SpecialistPool resource. The form is `projects/{project\}/locations/{location\}/specialistPools/{specialist_pool\}`. + * Required. The name of the TensorboardTimeSeries resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Specialistpools$List + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List extends StandardParameters { /** - * The standard list page size. + * Lists the TensorboardTimeSeries that match the filter expression. + */ + filter?: string; + /** + * Field to use to sort the list. + */ + orderBy?: string; + /** + * The maximum number of TensorboardTimeSeries to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardTimeSeries are returned. The maximum value is 1000; values above 1000 are coerced to 1000. */ pageSize?: number; /** - * The standard list page token. Typically obtained by ListSpecialistPoolsResponse.next_page_token of the previous SpecialistPoolService.ListSpecialistPools call. Return first page if empty. + * A page token, received from a previous TensorboardService.ListTensorboardTimeSeries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardTimeSeries must match the call that provided the page token. */ pageToken?: string; /** - * Required. The name of the SpecialistPool's parent resource. Format: `projects/{project\}/locations/{location\}` + * Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` */ parent?: string; /** - * Mask specifying which fields to read. FieldMask represents a set of + * Mask specifying which fields to read. */ readMask?: string; } - export interface Params$Resource$Projects$Locations$Specialistpools$Patch + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch extends StandardParameters { /** - * Required. The resource name of the SpecialistPool. + * Output only. Name of the TensorboardTimeSeries. */ name?: string; /** - * Required. The update mask applies to the resource. + * Required. Field mask is used to specify the fields to be overwritten in the TensorboardTimeSeries resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1SpecialistPool; + requestBody?: Schema$GoogleCloudAiplatformV1TensorboardTimeSeries; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read + extends StandardParameters { + /** + * Reads the TensorboardTimeSeries' data that match the filter expression. + */ + filter?: string; + /** + * The maximum number of TensorboardTimeSeries' data to return. This value should be a positive integer. This value can be set to -1 to return all data. + */ + maxDataPoints?: number; + /** + * Required. The resource name of the TensorboardTimeSeries to read data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` + */ + tensorboardTimeSeries?: string; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata + extends StandardParameters { + /** + * IDs of the blobs to read. + */ + blobIds?: string[]; + /** + * Required. The resource name of the TensorboardTimeSeries to list Blobs. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` + */ + timeSeries?: string; } - export class Resource$Projects$Locations$Specialistpools$Operations { + export class Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -111517,10 +148981,12 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.specialistPools.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool/operations/my-operation', - * }); + * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.cancel( + * { + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response @@ -111540,31 +149006,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -111580,13 +149046,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel; options = {}; } @@ -111651,10 +149117,12 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.specialistPools.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool/operations/my-operation', - * }); + * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.delete( + * { + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response @@ -111674,31 +149142,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Delete, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Specialistpools$Operations$Delete, + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Delete, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Delete, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Delete, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Specialistpools$Operations$Delete + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -111714,13 +149182,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Specialistpools$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Specialistpools$Operations$Delete; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete; options = {}; } @@ -111785,10 +149253,12 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.specialistPools.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool/operations/my-operation', - * }); + * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.get( + * { + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response @@ -111814,27 +149284,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Get, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Specialistpools$Operations$Get, + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Get, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Get, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Get, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -111842,7 +149312,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Specialistpools$Operations$Get + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -111858,13 +149328,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Specialistpools$Operations$Get; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Specialistpools$Operations$Get; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get; options = {}; } @@ -111929,18 +149399,20 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.specialistPools.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.list( + * { + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response @@ -111964,29 +149436,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$List, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Specialistpools$Operations$List, + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$List, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$List, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$List, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List, callback: BodyResponseCallback ): void; list( @@ -111994,7 +149466,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Specialistpools$Operations$List + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -112012,13 +149484,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Specialistpools$Operations$List; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Specialistpools$Operations$List; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List; options = {}; } @@ -112088,12 +149560,14 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.specialistPools.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); + * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.wait( + * { + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response @@ -112119,27 +149593,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Wait, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Specialistpools$Operations$Wait, + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Wait, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Wait, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Wait, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -112147,7 +149621,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Specialistpools$Operations$Wait + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -112163,13 +149637,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Specialistpools$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Specialistpools$Operations$Wait; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait; options = {}; } @@ -112204,28 +149678,28 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Specialistpools$Operations$Delete + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Specialistpools$Operations$Get + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Specialistpools$Operations$List + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List extends StandardParameters { /** * The standard list filter. @@ -112248,7 +149722,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Specialistpools$Operations$Wait + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -112260,22 +149734,14 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Studies { + export class Resource$Projects$Locations$Tensorboards$Operations { context: APIRequestContext; - operations: Resource$Projects$Locations$Studies$Operations; - trials: Resource$Projects$Locations$Studies$Trials; constructor(context: APIRequestContext) { this.context = context; - this.operations = new Resource$Projects$Locations$Studies$Operations( - this.context - ); - this.trials = new Resource$Projects$Locations$Studies$Trials( - this.context - ); } /** - * Creates a Study. A resource name will be generated after creation of the Study. + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -112304,34 +149770,15 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.create({ - * // Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "inactiveReason": "my_inactiveReason", - * // "name": "my_name", - * // "state": "my_state", - * // "studySpec": {} - * // } - * }, - * }); + * const res = + * await aiplatform.projects.locations.tensorboards.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "inactiveReason": "my_inactiveReason", - * // "name": "my_name", - * // "state": "my_state", - * // "studySpec": {} - * // } + * // {} * } * * main().catch(e => { @@ -112346,57 +149793,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Studies$Create, + cancel( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Studies$Create, + cancel( + params?: Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Studies$Create, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Studies$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Studies$Create, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel, + callback: BodyResponseCallback ): void; - create( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Create; + {}) as Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Studies$Create; + params = + {} as Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel; options = {}; } @@ -112409,34 +149853,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/studies').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes a Study. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -112465,10 +149904,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.delete({ - * // Required. The name of the Study resource to be deleted. Format: `projects/{project\}/locations/{location\}/studies/{study\}` - * name: 'projects/my-project/locations/my-location/studies/my-studie', - * }); + * const res = + * await aiplatform.projects.locations.tensorboards.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -112488,31 +149928,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Studies$Delete, + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Studies$Delete, + params?: Params$Resource$Projects$Locations$Tensorboards$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Studies$Delete, + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Studies$Delete, + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Studies$Delete, + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Delete + | Params$Resource$Projects$Locations$Tensorboards$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -112528,12 +149968,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Delete; + {}) as Params$Resource$Projects$Locations$Tensorboards$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Studies$Delete; + params = + {} as Params$Resource$Projects$Locations$Tensorboards$Operations$Delete; options = {}; } @@ -112568,7 +150009,7 @@ export namespace aiplatform_v1 { } /** - * Gets a Study by name. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -112597,20 +150038,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.get({ - * // Required. The name of the Study resource. Format: `projects/{project\}/locations/{location\}/studies/{study\}` - * name: 'projects/my-project/locations/my-location/studies/my-studie', + * const res = await aiplatform.projects.locations.tensorboards.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/operations/my-operation', * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "inactiveReason": "my_inactiveReason", + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "state": "my_state", - * // "studySpec": {} + * // "response": {} * // } * } * @@ -112627,56 +150067,57 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Studies$Get, + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Studies$Get, + params?: Params$Resource$Projects$Locations$Tensorboards$Operations$Get, options?: MethodOptions - ): Promise>; + ): Promise>; get( - params: Params$Resource$Projects$Locations$Studies$Get, + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Studies$Get, + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Studies$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Get; + {}) as Params$Resource$Projects$Locations$Tensorboards$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Studies$Get; + params = + {} as Params$Resource$Projects$Locations$Tensorboards$Operations$Get; options = {}; } @@ -112701,19 +150142,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists all the studies in a region for an associated project. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -112742,20 +150181,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.list({ - * // Optional. The maximum number of studies to return per "page" of results. If unspecified, service will pick an appropriate default. + * const res = await aiplatform.projects.locations.tensorboards.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', + * // The standard list page size. * pageSize: 'placeholder-value', - * // Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages. + * // The standard list page token. * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list the Study from. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "studies": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -112772,60 +150216,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Studies$List, + params: Params$Resource$Projects$Locations$Tensorboards$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Studies$List, + params?: Params$Resource$Projects$Locations$Tensorboards$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Studies$List, + params: Params$Resource$Projects$Locations$Tensorboards$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Studies$List, + params: Params$Resource$Projects$Locations$Tensorboards$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Studies$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Tensorboards$Operations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$List; + {}) as Params$Resource$Projects$Locations$Tensorboards$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Studies$List; + params = + {} as Params$Resource$Projects$Locations$Tensorboards$Operations$List; options = {}; } @@ -112838,7 +150283,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/studies').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -112848,24 +150293,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Looks a study up using the user-defined display_name field instead of the fully qualified resource name. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -112894,28 +150339,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.lookup({ - * // Required. The resource name of the Location to get the Study from. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "displayName": "my_displayName" - * // } - * }, + * const res = await aiplatform.projects.locations.tensorboards.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "inactiveReason": "my_inactiveReason", + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "state": "my_state", - * // "studySpec": {} + * // "response": {} * // } * } * @@ -112931,57 +150369,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - lookup( - params: Params$Resource$Projects$Locations$Studies$Lookup, + wait( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Wait, options: StreamMethodOptions ): Promise>; - lookup( - params?: Params$Resource$Projects$Locations$Studies$Lookup, + wait( + params?: Params$Resource$Projects$Locations$Tensorboards$Operations$Wait, options?: MethodOptions - ): Promise>; - lookup( - params: Params$Resource$Projects$Locations$Studies$Lookup, + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - lookup( - params: Params$Resource$Projects$Locations$Studies$Lookup, + wait( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - lookup( - params: Params$Resource$Projects$Locations$Studies$Lookup, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Wait, + callback: BodyResponseCallback ): void; - lookup( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - lookup( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Lookup - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Lookup; + {}) as Params$Resource$Projects$Locations$Tensorboards$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Studies$Lookup; + params = + {} as Params$Resource$Projects$Locations$Tensorboards$Operations$Wait; options = {}; } @@ -112994,95 +150433,97 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/studies:lookup').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Studies$Create + export interface Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel extends StandardParameters { /** - * Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata + * The name of the operation resource to be cancelled. */ - requestBody?: Schema$GoogleCloudAiplatformV1Study; + name?: string; } - export interface Params$Resource$Projects$Locations$Studies$Delete + export interface Params$Resource$Projects$Locations$Tensorboards$Operations$Delete extends StandardParameters { /** - * Required. The name of the Study resource to be deleted. Format: `projects/{project\}/locations/{location\}/studies/{study\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Studies$Get + export interface Params$Resource$Projects$Locations$Tensorboards$Operations$Get extends StandardParameters { /** - * Required. The name of the Study resource. Format: `projects/{project\}/locations/{location\}/studies/{study\}` + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Studies$List + export interface Params$Resource$Projects$Locations$Tensorboards$Operations$List extends StandardParameters { /** - * Optional. The maximum number of studies to return per "page" of results. If unspecified, service will pick an appropriate default. + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. */ pageSize?: number; /** - * Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages. + * The standard list page token. */ pageToken?: string; /** - * Required. The resource name of the Location to list the Study from. Format: `projects/{project\}/locations/{location\}` + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - parent?: string; + returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Studies$Lookup + export interface Params$Resource$Projects$Locations$Tensorboards$Operations$Wait extends StandardParameters { /** - * Required. The resource name of the Location to get the Study from. Format: `projects/{project\}/locations/{location\}` + * The name of the operation resource to wait on. */ - parent?: string; - + name?: string; /** - * Request body metadata + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - requestBody?: Schema$GoogleCloudAiplatformV1LookupStudyRequest; + timeout?: string; } - export class Resource$Projects$Locations$Studies$Operations { + export class Resource$Projects$Locations$Trainingpipelines { context: APIRequestContext; + operations: Resource$Projects$Locations$Trainingpipelines$Operations; constructor(context: APIRequestContext) { this.context = context; + this.operations = + new Resource$Projects$Locations$Trainingpipelines$Operations( + this.context + ); } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetTrainingPipeline or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead it becomes a pipeline with a TrainingPipeline.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TrainingPipeline.state is set to `CANCELLED`. * @example * ```js * // Before running the sample: @@ -113111,9 +150552,15 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/studies/my-studie/operations/my-operation', + * const res = await aiplatform.projects.locations.trainingPipelines.cancel({ + * // Required. The name of the TrainingPipeline to cancel. Format: `projects/{project\}/locations/{location\}/trainingPipelines/{training_pipeline\}` + * name: 'projects/my-project/locations/my-location/trainingPipelines/my-trainingPipeline', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, * }); * console.log(res.data); * @@ -113134,31 +150581,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Studies$Operations$Cancel, + params: Params$Resource$Projects$Locations$Trainingpipelines$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Studies$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Trainingpipelines$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Studies$Operations$Cancel, + params: Params$Resource$Projects$Locations$Trainingpipelines$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Studies$Operations$Cancel, + params: Params$Resource$Projects$Locations$Trainingpipelines$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Studies$Operations$Cancel, + params: Params$Resource$Projects$Locations$Trainingpipelines$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Operations$Cancel + | Params$Resource$Projects$Locations$Trainingpipelines$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -113174,13 +150621,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Trainingpipelines$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Studies$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Trainingpipelines$Cancel; options = {}; } @@ -113215,7 +150662,7 @@ export namespace aiplatform_v1 { } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run. * @example * ```js * // Before running the sample: @@ -113244,14 +150691,56 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/studies/my-studie/operations/my-operation', + * const res = await aiplatform.projects.locations.trainingPipelines.create({ + * // Required. The resource name of the Location to create the TrainingPipeline in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "inputDataConfig": {}, + * // "labels": {}, + * // "modelId": "my_modelId", + * // "modelToUpload": {}, + * // "name": "my_name", + * // "parentModel": "my_parentModel", + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "trainingTaskDefinition": "my_trainingTaskDefinition", + * // "trainingTaskInputs": {}, + * // "trainingTaskMetadata": {}, + * // "updateTime": "my_updateTime" + * // } + * }, * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "inputDataConfig": {}, + * // "labels": {}, + * // "modelId": "my_modelId", + * // "modelToUpload": {}, + * // "name": "my_name", + * // "parentModel": "my_parentModel", + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "trainingTaskDefinition": "my_trainingTaskDefinition", + * // "trainingTaskInputs": {}, + * // "trainingTaskMetadata": {}, + * // "updateTime": "my_updateTime" + * // } * } * * main().catch(e => { @@ -113266,54 +150755,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Studies$Operations$Delete, + create( + params: Params$Resource$Projects$Locations$Trainingpipelines$Create, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Studies$Operations$Delete, + create( + params?: Params$Resource$Projects$Locations$Trainingpipelines$Create, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Studies$Operations$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Trainingpipelines$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Studies$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Trainingpipelines$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Studies$Operations$Delete, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Trainingpipelines$Create, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Trainingpipelines$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Trainingpipelines$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Studies$Operations$Delete; + {} as Params$Resource$Projects$Locations$Trainingpipelines$Create; options = {}; } @@ -113326,29 +150823,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/trainingPipelines').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Deletes a TrainingPipeline. * @example * ```js * // Before running the sample: @@ -113377,9 +150879,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/studies/my-studie/operations/my-operation', + * const res = await aiplatform.projects.locations.trainingPipelines.delete({ + * // Required. The name of the TrainingPipeline resource to be deleted. Format: `projects/{project\}/locations/{location\}/trainingPipelines/{training_pipeline\}` + * name: 'projects/my-project/locations/my-location/trainingPipelines/my-trainingPipeline', * }); * console.log(res.data); * @@ -113405,36 +150907,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Studies$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Trainingpipelines$Delete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Studies$Operations$Get, + delete( + params?: Params$Resource$Projects$Locations$Trainingpipelines$Delete, options?: MethodOptions ): Promise>; - get( - params: Params$Resource$Projects$Locations$Studies$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Trainingpipelines$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Studies$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Trainingpipelines$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Studies$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Trainingpipelines$Delete, callback: BodyResponseCallback ): void; - get( + delete( callback: BodyResponseCallback ): void; - get( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Operations$Get + | Params$Resource$Projects$Locations$Trainingpipelines$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -113450,13 +150952,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Operations$Get; + {}) as Params$Resource$Projects$Locations$Trainingpipelines$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Studies$Operations$Get; + {} as Params$Resource$Projects$Locations$Trainingpipelines$Delete; options = {}; } @@ -113470,7 +150972,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -113491,7 +150993,7 @@ export namespace aiplatform_v1 { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Gets a TrainingPipeline. * @example * ```js * // Before running the sample: @@ -113520,25 +151022,31 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/studies/my-studie', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', + * const res = await aiplatform.projects.locations.trainingPipelines.get({ + * // Required. The name of the TrainingPipeline resource. Format: `projects/{project\}/locations/{location\}/trainingPipelines/{training_pipeline\}` + * name: 'projects/my-project/locations/my-location/trainingPipelines/my-trainingPipeline', * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "inputDataConfig": {}, + * // "labels": {}, + * // "modelId": "my_modelId", + * // "modelToUpload": {}, + * // "name": "my_name", + * // "parentModel": "my_parentModel", + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "trainingTaskDefinition": "my_trainingTaskDefinition", + * // "trainingTaskInputs": {}, + * // "trainingTaskMetadata": {}, + * // "updateTime": "my_updateTime" * // } * } * @@ -113554,62 +151062,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Studies$Operations$List, + get( + params: Params$Resource$Projects$Locations$Trainingpipelines$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Studies$Operations$List, + get( + params?: Params$Resource$Projects$Locations$Trainingpipelines$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Studies$Operations$List, + get( + params: Params$Resource$Projects$Locations$Trainingpipelines$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Studies$Operations$List, + get( + params: Params$Resource$Projects$Locations$Trainingpipelines$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Studies$Operations$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Trainingpipelines$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Trainingpipelines$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Operations$List; + {}) as Params$Resource$Projects$Locations$Trainingpipelines$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Studies$Operations$List; + params = {} as Params$Resource$Projects$Locations$Trainingpipelines$Get; options = {}; } @@ -113622,10 +151129,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -113637,19 +151141,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Lists TrainingPipelines in a Location. * @example * ```js * // Before running the sample: @@ -113678,21 +151182,24 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/studies/my-studie/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', + * const res = await aiplatform.projects.locations.trainingPipelines.list({ + * // The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `training_task_definition` `=`, `!=` comparisons, and `:` wildcard. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="PIPELINE_STATE_SUCCEEDED" AND display_name:"my_pipeline_*"` * `state!="PIPELINE_STATE_FAILED" OR display_name="my_pipeline"` * `NOT display_name="my_pipeline"` * `create_time\>"2021-05-18T00:00:00Z"` * `training_task_definition:"*automl_text_classification*"` + * filter: 'placeholder-value', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. Typically obtained via ListTrainingPipelinesResponse.next_page_token of the previous PipelineService.ListTrainingPipelines call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location to list the TrainingPipelines from. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "trainingPipelines": [] * // } * } * @@ -113708,58 +151215,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Studies$Operations$Wait, + list( + params: Params$Resource$Projects$Locations$Trainingpipelines$List, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Studies$Operations$Wait, + list( + params?: Params$Resource$Projects$Locations$Trainingpipelines$List, options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Studies$Operations$Wait, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Trainingpipelines$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Studies$Operations$Wait, + list( + params: Params$Resource$Projects$Locations$Trainingpipelines$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Studies$Operations$Wait, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Trainingpipelines$List, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - wait( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Trainingpipelines$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Trainingpipelines$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Studies$Operations$Wait; + {} as Params$Resource$Projects$Locations$Trainingpipelines$List; options = {}; } @@ -113772,95 +151283,103 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+parent}/trainingPipelines').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Studies$Operations$Cancel + export interface Params$Resource$Projects$Locations$Trainingpipelines$Cancel extends StandardParameters { /** - * The name of the operation resource to be cancelled. + * Required. The name of the TrainingPipeline to cancel. Format: `projects/{project\}/locations/{location\}/trainingPipelines/{training_pipeline\}` */ name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CancelTrainingPipelineRequest; } - export interface Params$Resource$Projects$Locations$Studies$Operations$Delete + export interface Params$Resource$Projects$Locations$Trainingpipelines$Create extends StandardParameters { /** - * The name of the operation resource to be deleted. + * Required. The resource name of the Location to create the TrainingPipeline in. Format: `projects/{project\}/locations/{location\}` */ - name?: string; + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1TrainingPipeline; } - export interface Params$Resource$Projects$Locations$Studies$Operations$Get + export interface Params$Resource$Projects$Locations$Trainingpipelines$Delete extends StandardParameters { /** - * The name of the operation resource. + * Required. The name of the TrainingPipeline resource to be deleted. Format: `projects/{project\}/locations/{location\}/trainingPipelines/{training_pipeline\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Studies$Operations$List + export interface Params$Resource$Projects$Locations$Trainingpipelines$Get extends StandardParameters { /** - * The standard list filter. + * Required. The name of the TrainingPipeline resource. Format: `projects/{project\}/locations/{location\}/trainingPipelines/{training_pipeline\}` */ - filter?: string; + name?: string; + } + export interface Params$Resource$Projects$Locations$Trainingpipelines$List + extends StandardParameters { /** - * The name of the operation's parent resource. + * The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `training_task_definition` `=`, `!=` comparisons, and `:` wildcard. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="PIPELINE_STATE_SUCCEEDED" AND display_name:"my_pipeline_*"` * `state!="PIPELINE_STATE_FAILED" OR display_name="my_pipeline"` * `NOT display_name="my_pipeline"` * `create_time\>"2021-05-18T00:00:00Z"` * `training_task_definition:"*automl_text_classification*"` */ - name?: string; + filter?: string; /** * The standard list page size. */ pageSize?: number; /** - * The standard list page token. + * The standard list page token. Typically obtained via ListTrainingPipelinesResponse.next_page_token of the previous PipelineService.ListTrainingPipelines call. */ pageToken?: string; /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Locations$Studies$Operations$Wait - extends StandardParameters { - /** - * The name of the operation resource to wait on. + * Required. The resource name of the Location to list the TrainingPipelines from. Format: `projects/{project\}/locations/{location\}` */ - name?: string; + parent?: string; /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * Mask specifying which fields to read. */ - timeout?: string; + readMask?: string; } - export class Resource$Projects$Locations$Studies$Trials { + export class Resource$Projects$Locations$Trainingpipelines$Operations { context: APIRequestContext; - operations: Resource$Projects$Locations$Studies$Trials$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = - new Resource$Projects$Locations$Studies$Trials$Operations(this.context); } /** - * Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete. + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -113890,36 +151409,14 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.studies.trials.addTrialMeasurement({ - * // Required. The name of the trial to add measurement. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` - * trialName: - * 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "measurement": {} - * // } - * }, + * await aiplatform.projects.locations.trainingPipelines.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/trainingPipelines/my-trainingPipeline/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "clientId": "my_clientId", - * // "customJob": "my_customJob", - * // "endTime": "my_endTime", - * // "finalMeasurement": {}, - * // "id": "my_id", - * // "infeasibleReason": "my_infeasibleReason", - * // "measurements": [], - * // "name": "my_name", - * // "parameters": [], - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "webAccessUris": {} - * // } + * // {} * } * * main().catch(e => { @@ -113934,58 +151431,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - addTrialMeasurement( - params: Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement, + cancel( + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel, options: StreamMethodOptions ): Promise>; - addTrialMeasurement( - params?: Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement, + cancel( + params?: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel, options?: MethodOptions - ): Promise>; - addTrialMeasurement( - params: Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addTrialMeasurement( - params: Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - addTrialMeasurement( - params: Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - addTrialMeasurement( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel, + callback: BodyResponseCallback ): void; - addTrialMeasurement( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement - | BodyResponseCallback + | Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement; + {}) as Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement; + {} as Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel; options = {}; } @@ -113998,34 +151491,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+trialName}:addTrialMeasurement').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['trialName'], - pathParams: ['trialName'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -114055,29 +151543,14 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.studies.trials.checkTrialEarlyStoppingState( - * { - * // Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` - * trialName: - * 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }, - * ); + * await aiplatform.projects.locations.trainingPipelines.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/trainingPipelines/my-trainingPipeline/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -114092,58 +151565,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - checkTrialEarlyStoppingState( - params: Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate, + delete( + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Delete, options: StreamMethodOptions ): Promise>; - checkTrialEarlyStoppingState( - params?: Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate, + delete( + params?: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Delete, options?: MethodOptions - ): Promise>; - checkTrialEarlyStoppingState( - params: Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - checkTrialEarlyStoppingState( - params: Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - checkTrialEarlyStoppingState( - params: Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - checkTrialEarlyStoppingState( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Delete, + callback: BodyResponseCallback ): void; - checkTrialEarlyStoppingState( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate - | BodyResponseCallback + | Params$Resource$Projects$Locations$Trainingpipelines$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate; + {}) as Params$Resource$Projects$Locations$Trainingpipelines$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate; + {} as Params$Resource$Projects$Locations$Trainingpipelines$Operations$Delete; options = {}; } @@ -114156,31 +151625,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+trialName}:checkTrialEarlyStoppingState' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['trialName'], - pathParams: ['trialName'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Marks a Trial as complete. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -114209,36 +151676,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.trials.complete({ - * // Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` - * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "finalMeasurement": {}, - * // "infeasibleReason": "my_infeasibleReason", - * // "trialInfeasible": false - * // } - * }, - * }); + * const res = + * await aiplatform.projects.locations.trainingPipelines.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/trainingPipelines/my-trainingPipeline/operations/my-operation', + * }); * console.log(res.data); * * // Example response * // { - * // "clientId": "my_clientId", - * // "customJob": "my_customJob", - * // "endTime": "my_endTime", - * // "finalMeasurement": {}, - * // "id": "my_id", - * // "infeasibleReason": "my_infeasibleReason", - * // "measurements": [], + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "parameters": [], - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "webAccessUris": {} + * // "response": {} * // } * } * @@ -114254,58 +151705,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - complete( - params: Params$Resource$Projects$Locations$Studies$Trials$Complete, + get( + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Get, options: StreamMethodOptions ): Promise>; - complete( - params?: Params$Resource$Projects$Locations$Studies$Trials$Complete, + get( + params?: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Get, options?: MethodOptions - ): Promise>; - complete( - params: Params$Resource$Projects$Locations$Studies$Trials$Complete, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - complete( - params: Params$Resource$Projects$Locations$Studies$Trials$Complete, + get( + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - complete( - params: Params$Resource$Projects$Locations$Studies$Trials$Complete, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Get, + callback: BodyResponseCallback ): void; - complete( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - complete( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Complete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Trainingpipelines$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$Complete; + {}) as Params$Resource$Projects$Locations$Trainingpipelines$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Studies$Trials$Complete; + {} as Params$Resource$Projects$Locations$Trainingpipelines$Operations$Get; options = {}; } @@ -114318,11 +151769,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:complete').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -114333,19 +151781,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Adds a user provided Trial to a Study. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -114374,45 +151820,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.trials.create({ - * // Required. The resource name of the Study to create the Trial in. Format: `projects/{project\}/locations/{location\}/studies/{study\}` - * parent: 'projects/my-project/locations/my-location/studies/my-studie', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "clientId": "my_clientId", - * // "customJob": "my_customJob", - * // "endTime": "my_endTime", - * // "finalMeasurement": {}, - * // "id": "my_id", - * // "infeasibleReason": "my_infeasibleReason", - * // "measurements": [], - * // "name": "my_name", - * // "parameters": [], - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "webAccessUris": {} - * // } - * }, - * }); + * const res = + * await aiplatform.projects.locations.trainingPipelines.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/trainingPipelines/my-trainingPipeline', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "clientId": "my_clientId", - * // "customJob": "my_customJob", - * // "endTime": "my_endTime", - * // "finalMeasurement": {}, - * // "id": "my_id", - * // "infeasibleReason": "my_infeasibleReason", - * // "measurements": [], - * // "name": "my_name", - * // "parameters": [], - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "webAccessUris": {} + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -114428,57 +151855,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Studies$Trials$Create, + list( + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$List, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Studies$Trials$Create, + list( + params?: Params$Resource$Projects$Locations$Trainingpipelines$Operations$List, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Studies$Trials$Create, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Studies$Trials$Create, + list( + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Studies$Trials$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$List, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - create( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Trainingpipelines$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$Create; + {}) as Params$Resource$Projects$Locations$Trainingpipelines$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Studies$Trials$Create; + params = + {} as Params$Resource$Projects$Locations$Trainingpipelines$Operations$List; options = {}; } @@ -114491,34 +151923,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/trials').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a Trial. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -114547,14 +151979,23 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.trials.delete({ - * // Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` - * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', - * }); + * const res = + * await aiplatform.projects.locations.trainingPipelines.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/trainingPipelines/my-trainingPipeline/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -114569,53 +152010,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Studies$Trials$Delete, + wait( + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Wait, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Studies$Trials$Delete, + wait( + params?: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Wait, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Studies$Trials$Delete, + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Studies$Trials$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Studies$Trials$Delete, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Wait, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + wait( + callback: BodyResponseCallback + ): void; + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Trainingpipelines$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$Delete; + {}) as Params$Resource$Projects$Locations$Trainingpipelines$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Studies$Trials$Delete; + params = + {} as Params$Resource$Projects$Locations$Trainingpipelines$Operations$Wait; options = {}; } @@ -114628,8 +152074,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -114640,17 +152086,84 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel + extends StandardParameters { /** - * Gets a Trial. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Trainingpipelines$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Trainingpipelines$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Trainingpipelines$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Trainingpipelines$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Tuningjobs { + context: APIRequestContext; + operations: Resource$Projects$Locations$Tuningjobs$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Projects$Locations$Tuningjobs$Operations( + this.context + ); + } + + /** + * Cancels a TuningJob. Starts asynchronous cancellation on the TuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use GenAiTuningService.GetTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the TuningJob is not deleted; instead it becomes a job with a TuningJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TuningJob.state is set to `CANCELLED`. * @example * ```js * // Before running the sample: @@ -114679,27 +152192,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.trials.get({ - * // Required. The name of the Trial resource. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` - * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', + * const res = await aiplatform.projects.locations.tuningJobs.cancel({ + * // Required. The name of the TuningJob to cancel. Format: `projects/{project\}/locations/{location\}/tuningJobs/{tuning_job\}` + * name: 'projects/my-project/locations/my-location/tuningJobs/my-tuningJob', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, * }); * console.log(res.data); * * // Example response - * // { - * // "clientId": "my_clientId", - * // "customJob": "my_customJob", - * // "endTime": "my_endTime", - * // "finalMeasurement": {}, - * // "id": "my_id", - * // "infeasibleReason": "my_infeasibleReason", - * // "measurements": [], - * // "name": "my_name", - * // "parameters": [], - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "webAccessUris": {} - * // } + * // {} * } * * main().catch(e => { @@ -114714,57 +152220,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Studies$Trials$Get, + cancel( + params: Params$Resource$Projects$Locations$Tuningjobs$Cancel, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Studies$Trials$Get, + cancel( + params?: Params$Resource$Projects$Locations$Tuningjobs$Cancel, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Studies$Trials$Get, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Tuningjobs$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Studies$Trials$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Studies$Trials$Get, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Tuningjobs$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Tuningjobs$Cancel, + callback: BodyResponseCallback ): void; - get( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tuningjobs$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$Get; + {}) as Params$Resource$Projects$Locations$Tuningjobs$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Studies$Trials$Get; + params = {} as Params$Resource$Projects$Locations$Tuningjobs$Cancel; options = {}; } @@ -114777,8 +152279,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -114789,19 +152291,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists the Trials associated with a Study. + * Creates a TuningJob. A created TuningJob right away will be attempted to be run. * @example * ```js * // Before running the sample: @@ -114830,20 +152330,57 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.trials.list({ - * // Optional. The number of Trials to retrieve per "page" of results. If unspecified, the service will pick an appropriate default. - * pageSize: 'placeholder-value', - * // Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Study to list the Trial from. Format: `projects/{project\}/locations/{location\}/studies/{study\}` - * parent: 'projects/my-project/locations/my-location/studies/my-studie', + * const res = await aiplatform.projects.locations.tuningJobs.create({ + * // Required. The resource name of the Location to create the TuningJob in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "baseModel": "my_baseModel", + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "encryptionSpec": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "experiment": "my_experiment", + * // "labels": {}, + * // "name": "my_name", + * // "preTunedModel": {}, + * // "serviceAccount": "my_serviceAccount", + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "supervisedTuningSpec": {}, + * // "tunedModel": {}, + * // "tunedModelDisplayName": "my_tunedModelDisplayName", + * // "tuningDataStats": {}, + * // "updateTime": "my_updateTime" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "trials": [] + * // "baseModel": "my_baseModel", + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "encryptionSpec": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "experiment": "my_experiment", + * // "labels": {}, + * // "name": "my_name", + * // "preTunedModel": {}, + * // "serviceAccount": "my_serviceAccount", + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "supervisedTuningSpec": {}, + * // "tunedModel": {}, + * // "tunedModelDisplayName": "my_tunedModelDisplayName", + * // "tuningDataStats": {}, + * // "updateTime": "my_updateTime" * // } * } * @@ -114859,61 +152396,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Studies$Trials$List, + create( + params: Params$Resource$Projects$Locations$Tuningjobs$Create, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Studies$Trials$List, + create( + params?: Params$Resource$Projects$Locations$Tuningjobs$Create, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Studies$Trials$List, + create( + params: Params$Resource$Projects$Locations$Tuningjobs$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Studies$Trials$List, + create( + params: Params$Resource$Projects$Locations$Tuningjobs$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Studies$Trials$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Tuningjobs$Create, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - list( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tuningjobs$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$List; + {}) as Params$Resource$Projects$Locations$Tuningjobs$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Studies$Trials$List; + params = {} as Params$Resource$Projects$Locations$Tuningjobs$Create; options = {}; } @@ -114926,11 +152463,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/trials').replace( + url: (rootUrl + '/v1/{+parent}/tuningJobs').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -114941,19 +152478,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency + * Gets a TuningJob. * @example * ```js * // Before running the sample: @@ -114982,22 +152519,32 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.studies.trials.listOptimalTrials({ - * // Required. The name of the Study that the optimal Trial belongs to. - * parent: 'projects/my-project/locations/my-location/studies/my-studie', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }); + * const res = await aiplatform.projects.locations.tuningJobs.get({ + * // Required. The name of the TuningJob resource. Format: `projects/{project\}/locations/{location\}/tuningJobs/{tuning_job\}` + * name: 'projects/my-project/locations/my-location/tuningJobs/my-tuningJob', + * }); * console.log(res.data); * * // Example response * // { - * // "optimalTrials": [] + * // "baseModel": "my_baseModel", + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "encryptionSpec": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "experiment": "my_experiment", + * // "labels": {}, + * // "name": "my_name", + * // "preTunedModel": {}, + * // "serviceAccount": "my_serviceAccount", + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "supervisedTuningSpec": {}, + * // "tunedModel": {}, + * // "tunedModelDisplayName": "my_tunedModelDisplayName", + * // "tuningDataStats": {}, + * // "updateTime": "my_updateTime" * // } * } * @@ -115013,62 +152560,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listOptimalTrials( - params: Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials, + get( + params: Params$Resource$Projects$Locations$Tuningjobs$Get, options: StreamMethodOptions ): Promise>; - listOptimalTrials( - params?: Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials, + get( + params?: Params$Resource$Projects$Locations$Tuningjobs$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - listOptimalTrials( - params: Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials, + get( + params: Params$Resource$Projects$Locations$Tuningjobs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listOptimalTrials( - params: Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials, + get( + params: Params$Resource$Projects$Locations$Tuningjobs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listOptimalTrials( - params: Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Tuningjobs$Get, + callback: BodyResponseCallback ): void; - listOptimalTrials( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - listOptimalTrials( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tuningjobs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials; + {}) as Params$Resource$Projects$Locations$Tuningjobs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials; + params = {} as Params$Resource$Projects$Locations$Tuningjobs$Get; options = {}; } @@ -115081,34 +152627,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/trials:listOptimalTrials').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Stops a Trial. + * Lists TuningJobs in a Location. * @example * ```js * // Before running the sample: @@ -115137,32 +152680,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.trials.stop({ - * // Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` - * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, + * const res = await aiplatform.projects.locations.tuningJobs.list({ + * // Optional. The standard list filter. + * filter: 'placeholder-value', + * // Optional. The standard list page size. + * pageSize: 'placeholder-value', + * // Optional. The standard list page token. Typically obtained via ListTuningJobsResponse.next_page_token of the previous GenAiTuningService.ListTuningJob][] call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location to list the TuningJobs from. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', * }); * console.log(res.data); * * // Example response * // { - * // "clientId": "my_clientId", - * // "customJob": "my_customJob", - * // "endTime": "my_endTime", - * // "finalMeasurement": {}, - * // "id": "my_id", - * // "infeasibleReason": "my_infeasibleReason", - * // "measurements": [], - * // "name": "my_name", - * // "parameters": [], - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "webAccessUris": {} + * // "nextPageToken": "my_nextPageToken", + * // "tuningJobs": [] * // } * } * @@ -115178,57 +152711,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - stop( - params: Params$Resource$Projects$Locations$Studies$Trials$Stop, + list( + params: Params$Resource$Projects$Locations$Tuningjobs$List, options: StreamMethodOptions ): Promise>; - stop( - params?: Params$Resource$Projects$Locations$Studies$Trials$Stop, + list( + params?: Params$Resource$Projects$Locations$Tuningjobs$List, options?: MethodOptions - ): Promise>; - stop( - params: Params$Resource$Projects$Locations$Studies$Trials$Stop, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Tuningjobs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - stop( - params: Params$Resource$Projects$Locations$Studies$Trials$Stop, + list( + params: Params$Resource$Projects$Locations$Tuningjobs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - stop( - params: Params$Resource$Projects$Locations$Studies$Trials$Stop, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Tuningjobs$List, + callback: BodyResponseCallback ): void; - stop( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - stop( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Stop - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tuningjobs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$Stop; + {}) as Params$Resource$Projects$Locations$Tuningjobs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Studies$Trials$Stop; + params = {} as Params$Resource$Projects$Locations$Tuningjobs$List; options = {}; } @@ -115241,31 +152778,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:stop').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+parent}/tuningJobs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier. Returns a long-running operation associated with the generation of Trial suggestions. When this long-running operation succeeds, it will contain a SuggestTrialsResponse. + * Rebase a TunedModel. * @example * ```js * // Before running the sample: @@ -115294,17 +152834,18 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.trials.suggest({ - * // Required. The project and location that the Study belongs to. Format: `projects/{project\}/locations/{location\}/studies/{study\}` - * parent: 'projects/my-project/locations/my-location/studies/my-studie', + * const res = await aiplatform.projects.locations.tuningJobs.rebaseTunedModel({ + * // Required. The resource name of the Location into which to rebase the Model. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "clientId": "my_clientId", - * // "contexts": [], - * // "suggestionCount": 0 + * // "artifactDestination": {}, + * // "deployToSameEndpoint": false, + * // "tunedModelRef": {}, + * // "tuningJob": {} * // } * }, * }); @@ -115332,36 +152873,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - suggest( - params: Params$Resource$Projects$Locations$Studies$Trials$Suggest, + rebaseTunedModel( + params: Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel, options: StreamMethodOptions ): Promise>; - suggest( - params?: Params$Resource$Projects$Locations$Studies$Trials$Suggest, + rebaseTunedModel( + params?: Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel, options?: MethodOptions ): Promise>; - suggest( - params: Params$Resource$Projects$Locations$Studies$Trials$Suggest, + rebaseTunedModel( + params: Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - suggest( - params: Params$Resource$Projects$Locations$Studies$Trials$Suggest, + rebaseTunedModel( + params: Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - suggest( - params: Params$Resource$Projects$Locations$Studies$Trials$Suggest, + rebaseTunedModel( + params: Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel, callback: BodyResponseCallback ): void; - suggest( + rebaseTunedModel( callback: BodyResponseCallback ): void; - suggest( + rebaseTunedModel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Suggest + | Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -115377,13 +152918,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$Suggest; + {}) as Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Studies$Trials$Suggest; + {} as Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel; options = {}; } @@ -115396,10 +152937,9 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/trials:suggest').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1/{+parent}/tuningJobs:rebaseTunedModel' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -115421,121 +152961,70 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement - extends StandardParameters { - /** - * Required. The name of the trial to add measurement. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` - */ - trialName?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1AddTrialMeasurementRequest; - } - export interface Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate - extends StandardParameters { - /** - * Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` - */ - trialName?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest; - } - export interface Params$Resource$Projects$Locations$Studies$Trials$Complete + export interface Params$Resource$Projects$Locations$Tuningjobs$Cancel extends StandardParameters { /** - * Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + * Required. The name of the TuningJob to cancel. Format: `projects/{project\}/locations/{location\}/tuningJobs/{tuning_job\}` */ name?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1CompleteTrialRequest; + requestBody?: Schema$GoogleCloudAiplatformV1CancelTuningJobRequest; } - export interface Params$Resource$Projects$Locations$Studies$Trials$Create + export interface Params$Resource$Projects$Locations$Tuningjobs$Create extends StandardParameters { /** - * Required. The resource name of the Study to create the Trial in. Format: `projects/{project\}/locations/{location\}/studies/{study\}` + * Required. The resource name of the Location to create the TuningJob in. Format: `projects/{project\}/locations/{location\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1Trial; + requestBody?: Schema$GoogleCloudAiplatformV1TuningJob; } - export interface Params$Resource$Projects$Locations$Studies$Trials$Delete + export interface Params$Resource$Projects$Locations$Tuningjobs$Get extends StandardParameters { /** - * Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + * Required. The name of the TuningJob resource. Format: `projects/{project\}/locations/{location\}/tuningJobs/{tuning_job\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Studies$Trials$Get + export interface Params$Resource$Projects$Locations$Tuningjobs$List extends StandardParameters { /** - * Required. The name of the Trial resource. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + * Optional. The standard list filter. */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Studies$Trials$List - extends StandardParameters { + filter?: string; /** - * Optional. The number of Trials to retrieve per "page" of results. If unspecified, the service will pick an appropriate default. + * Optional. The standard list page size. */ pageSize?: number; /** - * Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages. + * Optional. The standard list page token. Typically obtained via ListTuningJobsResponse.next_page_token of the previous GenAiTuningService.ListTuningJob][] call. */ pageToken?: string; /** - * Required. The resource name of the Study to list the Trial from. Format: `projects/{project\}/locations/{location\}/studies/{study\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials - extends StandardParameters { - /** - * Required. The name of the Study that the optimal Trial belongs to. + * Required. The resource name of the Location to list the TuningJobs from. Format: `projects/{project\}/locations/{location\}` */ parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ListOptimalTrialsRequest; } - export interface Params$Resource$Projects$Locations$Studies$Trials$Stop - extends StandardParameters { - /** - * Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1StopTrialRequest; - } - export interface Params$Resource$Projects$Locations$Studies$Trials$Suggest + export interface Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel extends StandardParameters { /** - * Required. The project and location that the Study belongs to. Format: `projects/{project\}/locations/{location\}/studies/{study\}` + * Required. The resource name of the Location into which to rebase the Model. Format: `projects/{project\}/locations/{location\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1SuggestTrialsRequest; + requestBody?: Schema$GoogleCloudAiplatformV1RebaseTunedModelRequest; } - export class Resource$Projects$Locations$Studies$Trials$Operations { + export class Resource$Projects$Locations$Tuningjobs$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -115571,11 +153060,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.studies.trials.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.tuningJobs.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/tuningJobs/my-tuningJob/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -115595,31 +153083,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel, + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel, + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel, + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel, + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel + | Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -115635,13 +153123,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel; options = {}; } @@ -115705,11 +153193,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.studies.trials.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.tuningJobs.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/tuningJobs/my-tuningJob/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -115729,31 +153216,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete, + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete, + params?: Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete, + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete, + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete, + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete + | Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -115769,13 +153256,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete; + {} as Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete; options = {}; } @@ -115839,12 +153326,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.trials.operations.get( - * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial/operations/my-operation', - * }, - * ); + * const res = await aiplatform.projects.locations.tuningJobs.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/tuningJobs/my-tuningJob/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -115870,27 +153355,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Get, + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Studies$Trials$Operations$Get, + params?: Params$Resource$Projects$Locations$Tuningjobs$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Get, + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Get, + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Get, + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -115898,7 +153383,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Operations$Get + | Params$Resource$Projects$Locations$Tuningjobs$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -115914,13 +153399,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$Operations$Get; + {}) as Params$Resource$Projects$Locations$Tuningjobs$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Studies$Trials$Operations$Get; + {} as Params$Resource$Projects$Locations$Tuningjobs$Operations$Get; options = {}; } @@ -115984,19 +153469,18 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.studies.trials.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * const res = await aiplatform.projects.locations.tuningJobs.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/tuningJobs/my-tuningJob', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -116020,29 +153504,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$List, + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Studies$Trials$Operations$List, + params?: Params$Resource$Projects$Locations$Tuningjobs$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$List, + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$List, + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$List, + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$List, callback: BodyResponseCallback ): void; list( @@ -116050,7 +153534,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Operations$List + | Params$Resource$Projects$Locations$Tuningjobs$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -116068,13 +153552,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$Operations$List; + {}) as Params$Resource$Projects$Locations$Tuningjobs$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Studies$Trials$Operations$List; + {} as Params$Resource$Projects$Locations$Tuningjobs$Operations$List; options = {}; } @@ -116112,176 +153596,30 @@ export namespace aiplatform_v1 { ); } } - - /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const aiplatform = google.aiplatform('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await aiplatform.projects.locations.studies.trials.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - wait( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait, - options: StreamMethodOptions - ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait, - options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - wait( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - wait( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait, - callback: BodyResponseCallback - ): void; - wait( - callback: BodyResponseCallback - ): void; - wait( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } } - export interface Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel + export interface Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete + export interface Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Studies$Trials$Operations$Get + export interface Params$Resource$Projects$Locations$Tuningjobs$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Studies$Trials$Operations$List + export interface Params$Resource$Projects$Locations$Tuningjobs$Operations$List extends StandardParameters { /** * The standard list filter. @@ -116304,33 +153642,24 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait - extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; + + export class Resource$Publishers { + context: APIRequestContext; + models: Resource$Publishers$Models; + constructor(context: APIRequestContext) { + this.context = context; + this.models = new Resource$Publishers$Models(this.context); + } } - export class Resource$Projects$Locations$Tensorboards { + export class Resource$Publishers$Models { context: APIRequestContext; - experiments: Resource$Projects$Locations$Tensorboards$Experiments; - operations: Resource$Projects$Locations$Tensorboards$Operations; constructor(context: APIRequestContext) { this.context = context; - this.experiments = - new Resource$Projects$Locations$Tensorboards$Experiments(this.context); - this.operations = new Resource$Projects$Locations$Tensorboards$Operations( - this.context - ); } /** - * Reads multiple TensorboardTimeSeries' data. The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned. + * Return a list of tokens based on the input text. * @example * ```js * // Before running the sample: @@ -116359,18 +153688,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tensorboards.batchRead({ - * // Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}`. The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard. - * tensorboard: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', - * // Required. The resource names of the TensorboardTimeSeries to read data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` - * timeSeries: 'placeholder-value', + * const res = await aiplatform.publishers.models.computeTokens({ + * // Required. The name of the Endpoint requested to get lists of tokens and token ids. + * endpoint: 'publishers/my-publisher/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "contents": [], + * // "instances": [], + * // "model": "my_model" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "timeSeriesData": [] + * // "tokensInfo": [] * // } * } * @@ -116386,62 +153722,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchRead( - params: Params$Resource$Projects$Locations$Tensorboards$Batchread, + computeTokens( + params: Params$Resource$Publishers$Models$Computetokens, options: StreamMethodOptions ): Promise>; - batchRead( - params?: Params$Resource$Projects$Locations$Tensorboards$Batchread, + computeTokens( + params?: Params$Resource$Publishers$Models$Computetokens, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - batchRead( - params: Params$Resource$Projects$Locations$Tensorboards$Batchread, + computeTokens( + params: Params$Resource$Publishers$Models$Computetokens, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchRead( - params: Params$Resource$Projects$Locations$Tensorboards$Batchread, + computeTokens( + params: Params$Resource$Publishers$Models$Computetokens, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchRead( - params: Params$Resource$Projects$Locations$Tensorboards$Batchread, - callback: BodyResponseCallback + computeTokens( + params: Params$Resource$Publishers$Models$Computetokens, + callback: BodyResponseCallback ): void; - batchRead( - callback: BodyResponseCallback + computeTokens( + callback: BodyResponseCallback ): void; - batchRead( + computeTokens( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Batchread - | BodyResponseCallback + | Params$Resource$Publishers$Models$Computetokens + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Batchread; + {}) as Params$Resource$Publishers$Models$Computetokens; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Batchread; + params = {} as Params$Resource$Publishers$Models$Computetokens; options = {}; } @@ -116454,34 +153789,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+tensorboard}:batchRead').replace( + url: (rootUrl + '/v1/{+endpoint}:computeTokens').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['tensorboard'], - pathParams: ['tensorboard'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Creates a Tensorboard. + * Perform a token counting. * @example * ```js * // Before running the sample: @@ -116510,27 +153845,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tensorboards.create({ - * // Required. The resource name of the Location to create the Tensorboard in. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * const res = await aiplatform.publishers.models.countTokens({ + * // Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: 'publishers/my-publisher/models/my-model', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "blobStoragePathPrefix": "my_blobStoragePathPrefix", - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "isDefault": false, - * // "labels": {}, - * // "name": "my_name", - * // "runCount": 0, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime" + * // "contents": [], + * // "generationConfig": {}, + * // "instances": [], + * // "model": "my_model", + * // "systemInstruction": {}, + * // "tools": [] * // } * }, * }); @@ -116538,309 +153866,9 @@ export namespace aiplatform_v1 { * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - create( - params: Params$Resource$Projects$Locations$Tensorboards$Create, - options: StreamMethodOptions - ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Tensorboards$Create, - options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Tensorboards$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Tensorboards$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Tensorboards$Create, - callback: BodyResponseCallback - ): void; - create( - callback: BodyResponseCallback - ): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Tensorboards$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/tensorboards').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Deletes a Tensorboard. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const aiplatform = google.aiplatform('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await aiplatform.projects.locations.tensorboards.delete({ - * // Required. The name of the Tensorboard to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Delete, - options: StreamMethodOptions - ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Tensorboards$Delete, - options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Delete, - callback: BodyResponseCallback - ): void; - delete( - callback: BodyResponseCallback - ): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Tensorboards$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Gets a Tensorboard. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const aiplatform = google.aiplatform('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await aiplatform.projects.locations.tensorboards.get({ - * // Required. The name of the Tensorboard resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "blobStoragePathPrefix": "my_blobStoragePathPrefix", - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "isDefault": false, - * // "labels": {}, - * // "name": "my_name", - * // "runCount": 0, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime" + * // "promptTokensDetails": [], + * // "totalBillableCharacters": 0, + * // "totalTokens": 0 * // } * } * @@ -116856,61 +153884,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Tensorboards$Get, + countTokens( + params: Params$Resource$Publishers$Models$Counttokens, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Tensorboards$Get, + countTokens( + params?: Params$Resource$Publishers$Models$Counttokens, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Get, + countTokens( + params: Params$Resource$Publishers$Models$Counttokens, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Get, + ): void; + countTokens( + params: Params$Resource$Publishers$Models$Counttokens, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Get, - callback: BodyResponseCallback + countTokens( + params: Params$Resource$Publishers$Models$Counttokens, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + countTokens( + callback: BodyResponseCallback ): void; - get( + countTokens( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Get - | BodyResponseCallback + | Params$Resource$Publishers$Models$Counttokens + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Get; + {}) as Params$Resource$Publishers$Models$Counttokens; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Tensorboards$Get; + params = {} as Params$Resource$Publishers$Models$Counttokens; options = {}; } @@ -116923,31 +153951,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+endpoint}:countTokens').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists Tensorboards in a Location. + * Fetch an asynchronous online prediction operation. * @example * ```js * // Before running the sample: @@ -116979,26 +154010,27 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tensorboards.list({ - * // Lists the Tensorboards that match the filter expression. - * filter: 'placeholder-value', - * // Field to use to sort the list. - * orderBy: 'placeholder-value', - * // The maximum number of Tensorboards to return. The service may return fewer than this value. If unspecified, at most 100 Tensorboards are returned. The maximum value is 100; values above 100 are coerced to 100. - * pageSize: 'placeholder-value', - * // A page token, received from a previous TensorboardService.ListTensorboards call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboards must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list Tensorboards. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', + * const res = await aiplatform.publishers.models.fetchPredictOperation({ + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` + * endpoint: 'publishers/my-publisher/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "operationName": "my_operationName" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "tensorboards": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -117014,61 +154046,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Tensorboards$List, + fetchPredictOperation( + params: Params$Resource$Publishers$Models$Fetchpredictoperation, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Tensorboards$List, + fetchPredictOperation( + params?: Params$Resource$Publishers$Models$Fetchpredictoperation, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Tensorboards$List, + ): Promise>; + fetchPredictOperation( + params: Params$Resource$Publishers$Models$Fetchpredictoperation, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Tensorboards$List, + fetchPredictOperation( + params: Params$Resource$Publishers$Models$Fetchpredictoperation, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Tensorboards$List, - callback: BodyResponseCallback + fetchPredictOperation( + params: Params$Resource$Publishers$Models$Fetchpredictoperation, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + fetchPredictOperation( + callback: BodyResponseCallback ): void; - list( + fetchPredictOperation( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$List - | BodyResponseCallback + | Params$Resource$Publishers$Models$Fetchpredictoperation + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$List; + {}) as Params$Resource$Publishers$Models$Fetchpredictoperation; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Tensorboards$List; + params = {} as Params$Resource$Publishers$Models$Fetchpredictoperation; options = {}; } @@ -117081,34 +154109,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/tensorboards').replace( + url: (rootUrl + '/v1/{+endpoint}:fetchPredictOperation').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a Tensorboard. + * Generate content with multimodal inputs. * @example * ```js * // Before running the sample: @@ -117129,7 +154155,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -117137,29 +154166,23 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tensorboards.patch({ - * // Output only. Name of the Tensorboard. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', - * // Required. Field mask is used to specify the fields to be overwritten in the Tensorboard resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. - * updateMask: 'placeholder-value', + * const res = await aiplatform.publishers.models.generateContent({ + * // Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * model: 'publishers/my-publisher/models/my-model', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "blobStoragePathPrefix": "my_blobStoragePathPrefix", - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "isDefault": false, + * // "cachedContent": "my_cachedContent", + * // "contents": [], + * // "generationConfig": {}, * // "labels": {}, - * // "name": "my_name", - * // "runCount": 0, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime" + * // "modelArmorConfig": {}, + * // "safetySettings": [], + * // "systemInstruction": {}, + * // "toolConfig": {}, + * // "tools": [] * // } * }, * }); @@ -117167,11 +154190,12 @@ export namespace aiplatform_v1 { * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "candidates": [], + * // "createTime": "my_createTime", + * // "modelVersion": "my_modelVersion", + * // "promptFeedback": {}, + * // "responseId": "my_responseId", + * // "usageMetadata": {} * // } * } * @@ -117187,57 +154211,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Tensorboards$Patch, + generateContent( + params: Params$Resource$Publishers$Models$Generatecontent, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Tensorboards$Patch, + generateContent( + params?: Params$Resource$Publishers$Models$Generatecontent, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Tensorboards$Patch, + ): Promise< + GaxiosResponseWithHTTP2 + >; + generateContent( + params: Params$Resource$Publishers$Models$Generatecontent, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Tensorboards$Patch, + generateContent( + params: Params$Resource$Publishers$Models$Generatecontent, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Tensorboards$Patch, - callback: BodyResponseCallback + generateContent( + params: Params$Resource$Publishers$Models$Generatecontent, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + generateContent( + callback: BodyResponseCallback ): void; - patch( + generateContent( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Patch - | BodyResponseCallback + | Params$Resource$Publishers$Models$Generatecontent + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Patch; + {}) as Params$Resource$Publishers$Models$Generatecontent; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Tensorboards$Patch; + params = {} as Params$Resource$Publishers$Models$Generatecontent; options = {}; } @@ -117250,29 +154278,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+model}:generateContent').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['model'], + pathParams: ['model'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Returns the storage size for a given TensorBoard instance. + * Gets a Model Garden publisher model. * @example * ```js * // Before running the sample: @@ -117301,16 +154334,31 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tensorboards.readSize({ - * // Required. The name of the Tensorboard resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` - * tensorboard: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', + * const res = await aiplatform.publishers.models.get({ + * // Optional. Token used to access Hugging Face gated models. + * huggingFaceToken: 'placeholder-value', + * // Optional. Boolean indicates whether the requested model is a Hugging Face model. + * isHuggingFaceModel: 'placeholder-value', + * // Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in. + * languageCode: 'placeholder-value', + * // Required. The name of the PublisherModel resource. Format: `publishers/{publisher\}/models/{publisher_model\}` + * name: 'publishers/my-publisher/models/my-model', + * // Optional. PublisherModel view specifying which fields to read. + * view: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "storageSizeByte": "my_storageSizeByte" + * // "frameworks": [], + * // "launchStage": "my_launchStage", + * // "name": "my_name", + * // "openSourceCategory": "my_openSourceCategory", + * // "predictSchemata": {}, + * // "publisherModelTemplate": "my_publisherModelTemplate", + * // "supportedActions": {}, + * // "versionId": "my_versionId", + * // "versionState": "my_versionState" * // } * } * @@ -117326,61 +154374,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - readSize( - params: Params$Resource$Projects$Locations$Tensorboards$Readsize, + get( + params: Params$Resource$Publishers$Models$Get, options: StreamMethodOptions ): Promise>; - readSize( - params?: Params$Resource$Projects$Locations$Tensorboards$Readsize, + get( + params?: Params$Resource$Publishers$Models$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - readSize( - params: Params$Resource$Projects$Locations$Tensorboards$Readsize, + get( + params: Params$Resource$Publishers$Models$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - readSize( - params: Params$Resource$Projects$Locations$Tensorboards$Readsize, + get( + params: Params$Resource$Publishers$Models$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - readSize( - params: Params$Resource$Projects$Locations$Tensorboards$Readsize, - callback: BodyResponseCallback + get( + params: Params$Resource$Publishers$Models$Get, + callback: BodyResponseCallback ): void; - readSize( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - readSize( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Readsize - | BodyResponseCallback + | Params$Resource$Publishers$Models$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Readsize; + {}) as Params$Resource$Publishers$Models$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Tensorboards$Readsize; + params = {} as Params$Resource$Publishers$Models$Get; options = {}; } @@ -117393,34 +154441,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+tensorboard}:readSize').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['tensorboard'], - pathParams: ['tensorboard'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Returns a list of monthly active users for a given TensorBoard instance. + * Perform an online prediction. * @example * ```js * // Before running the sample: @@ -117441,7 +154486,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -117449,16 +154497,30 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tensorboards.readUsage({ - * // Required. The name of the Tensorboard resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` - * tensorboard: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', + * const res = await aiplatform.publishers.models.predict({ + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: 'publishers/my-publisher/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "instances": [], + * // "labels": {}, + * // "parameters": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "monthlyUsageData": {} + * // "deployedModelId": "my_deployedModelId", + * // "metadata": {}, + * // "model": "my_model", + * // "modelDisplayName": "my_modelDisplayName", + * // "modelVersionId": "my_modelVersionId", + * // "predictions": [] * // } * } * @@ -117474,62 +154536,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - readUsage( - params: Params$Resource$Projects$Locations$Tensorboards$Readusage, + predict( + params: Params$Resource$Publishers$Models$Predict, options: StreamMethodOptions ): Promise>; - readUsage( - params?: Params$Resource$Projects$Locations$Tensorboards$Readusage, + predict( + params?: Params$Resource$Publishers$Models$Predict, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - readUsage( - params: Params$Resource$Projects$Locations$Tensorboards$Readusage, + predict( + params: Params$Resource$Publishers$Models$Predict, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - readUsage( - params: Params$Resource$Projects$Locations$Tensorboards$Readusage, + predict( + params: Params$Resource$Publishers$Models$Predict, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - readUsage( - params: Params$Resource$Projects$Locations$Tensorboards$Readusage, - callback: BodyResponseCallback + predict( + params: Params$Resource$Publishers$Models$Predict, + callback: BodyResponseCallback ): void; - readUsage( - callback: BodyResponseCallback + predict( + callback: BodyResponseCallback ): void; - readUsage( + predict( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Readusage - | BodyResponseCallback + | Params$Resource$Publishers$Models$Predict + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Readusage; + {}) as Params$Resource$Publishers$Models$Predict; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Readusage; + params = {} as Params$Resource$Publishers$Models$Predict; options = {}; } @@ -117542,145 +154603,33 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+tensorboard}:readUsage').replace( + url: (rootUrl + '/v1/{+endpoint}:predict').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['tensorboard'], - pathParams: ['tensorboard'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Tensorboards$Batchread - extends StandardParameters { - /** - * Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}`. The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard. - */ - tensorboard?: string; - /** - * Required. The resource names of the TensorboardTimeSeries to read data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` - */ - timeSeries?: string[]; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Create - extends StandardParameters { - /** - * Required. The resource name of the Location to create the Tensorboard in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Tensorboard; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Delete - extends StandardParameters { - /** - * Required. The name of the Tensorboard to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Get - extends StandardParameters { - /** - * Required. The name of the Tensorboard resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Tensorboards$List - extends StandardParameters { - /** - * Lists the Tensorboards that match the filter expression. - */ - filter?: string; - /** - * Field to use to sort the list. - */ - orderBy?: string; - /** - * The maximum number of Tensorboards to return. The service may return fewer than this value. If unspecified, at most 100 Tensorboards are returned. The maximum value is 100; values above 100 are coerced to 100. - */ - pageSize?: number; - /** - * A page token, received from a previous TensorboardService.ListTensorboards call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboards must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The resource name of the Location to list Tensorboards. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Patch - extends StandardParameters { - /** - * Output only. Name of the Tensorboard. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` - */ - name?: string; - /** - * Required. Field mask is used to specify the fields to be overwritten in the Tensorboard resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Tensorboard; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Readsize - extends StandardParameters { - /** - * Required. The name of the Tensorboard resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` - */ - tensorboard?: string; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Readusage - extends StandardParameters { - /** - * Required. The name of the Tensorboard resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` - */ - tensorboard?: string; - } - - export class Resource$Projects$Locations$Tensorboards$Experiments { - context: APIRequestContext; - operations: Resource$Projects$Locations$Tensorboards$Experiments$Operations; - runs: Resource$Projects$Locations$Tensorboards$Experiments$Runs; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Tensorboards$Experiments$Operations( - this.context - ); - this.runs = new Resource$Projects$Locations$Tensorboards$Experiments$Runs( - this.context - ); - } /** - * Batch create TensorboardTimeSeries that belong to a TensorboardExperiment. * @example * ```js * // Before running the sample: @@ -117701,7 +154650,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -117709,25 +154661,28 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.batchCreate({ - * // Required. The resource name of the TensorboardExperiment to create the TensorboardTimeSeries in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` The TensorboardRuns referenced by the parent fields in the CreateTensorboardTimeSeriesRequest messages must be sub resources of this TensorboardExperiment. - * parent: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', + * const res = await aiplatform.publishers.models.predictLongRunning({ + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` + * endpoint: 'publishers/my-publisher/models/my-model', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "requests": [] - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "instances": [], + * // "parameters": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "tensorboardTimeSeries": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -117743,62 +154698,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchCreate( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate, + predictLongRunning( + params: Params$Resource$Publishers$Models$Predictlongrunning, options: StreamMethodOptions ): Promise>; - batchCreate( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate, + predictLongRunning( + params?: Params$Resource$Publishers$Models$Predictlongrunning, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - batchCreate( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate, + ): Promise>; + predictLongRunning( + params: Params$Resource$Publishers$Models$Predictlongrunning, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate, + predictLongRunning( + params: Params$Resource$Publishers$Models$Predictlongrunning, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate, - callback: BodyResponseCallback + predictLongRunning( + params: Params$Resource$Publishers$Models$Predictlongrunning, + callback: BodyResponseCallback ): void; - batchCreate( - callback: BodyResponseCallback + predictLongRunning( + callback: BodyResponseCallback ): void; - batchCreate( + predictLongRunning( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate - | BodyResponseCallback + | Params$Resource$Publishers$Models$Predictlongrunning + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate; + {}) as Params$Resource$Publishers$Models$Predictlongrunning; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate; + params = {} as Params$Resource$Publishers$Models$Predictlongrunning; options = {}; } @@ -117811,7 +154761,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}:batchCreate').replace( + url: (rootUrl + '/v1/{+endpoint}:predictLongRunning').replace( /([^:]\/)\/+/g, '$1' ), @@ -117821,24 +154771,22 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Creates a TensorboardExperiment. + * Generate content with multimodal inputs with streaming support. * @example * ```js * // Before running the sample: @@ -117859,7 +154807,10 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -117867,41 +154818,36 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.create({ - * // Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` - * parent: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', - * // Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`. - * tensorboardExperimentId: 'placeholder-value', + * const res = await aiplatform.publishers.models.streamGenerateContent({ + * // Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * model: 'publishers/my-publisher/models/my-model', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "source": "my_source", - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "cachedContent": "my_cachedContent", + * // "contents": [], + * // "generationConfig": {}, + * // "labels": {}, + * // "modelArmorConfig": {}, + * // "safetySettings": [], + * // "systemInstruction": {}, + * // "toolConfig": {}, + * // "tools": [] + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { + * // "candidates": [], * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "source": "my_source", - * // "updateTime": "my_updateTime" + * // "modelVersion": "my_modelVersion", + * // "promptFeedback": {}, + * // "responseId": "my_responseId", + * // "usageMetadata": {} * // } * } * @@ -117917,62 +154863,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Create, + streamGenerateContent( + params: Params$Resource$Publishers$Models$Streamgeneratecontent, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Create, + streamGenerateContent( + params?: Params$Resource$Publishers$Models$Streamgeneratecontent, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - create( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Create, + streamGenerateContent( + params: Params$Resource$Publishers$Models$Streamgeneratecontent, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Create, + streamGenerateContent( + params: Params$Resource$Publishers$Models$Streamgeneratecontent, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Create, - callback: BodyResponseCallback + streamGenerateContent( + params: Params$Resource$Publishers$Models$Streamgeneratecontent, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + streamGenerateContent( + callback: BodyResponseCallback ): void; - create( + streamGenerateContent( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Create - | BodyResponseCallback + | Params$Resource$Publishers$Models$Streamgeneratecontent + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Create; + {}) as Params$Resource$Publishers$Models$Streamgeneratecontent; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Create; + params = {} as Params$Resource$Publishers$Models$Streamgeneratecontent; options = {}; } @@ -117985,7 +154930,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/experiments').replace( + url: (rootUrl + '/v1/{+model}:streamGenerateContent').replace( /([^:]\/)\/+/g, '$1' ), @@ -117995,24 +154940,150 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['model'], + pathParams: ['model'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + + export interface Params$Resource$Publishers$Models$Computetokens + extends StandardParameters { + /** + * Required. The name of the Endpoint requested to get lists of tokens and token ids. + */ + endpoint?: string; /** - * Deletes a TensorboardExperiment. + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ComputeTokensRequest; + } + export interface Params$Resource$Publishers$Models$Counttokens + extends StandardParameters { + /** + * Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CountTokensRequest; + } + export interface Params$Resource$Publishers$Models$Fetchpredictoperation + extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1FetchPredictOperationRequest; + } + export interface Params$Resource$Publishers$Models$Generatecontent + extends StandardParameters { + /** + * Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + model?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1GenerateContentRequest; + } + export interface Params$Resource$Publishers$Models$Get + extends StandardParameters { + /** + * Optional. Token used to access Hugging Face gated models. + */ + huggingFaceToken?: string; + /** + * Optional. Boolean indicates whether the requested model is a Hugging Face model. + */ + isHuggingFaceModel?: boolean; + /** + * Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in. + */ + languageCode?: string; + /** + * Required. The name of the PublisherModel resource. Format: `publishers/{publisher\}/models/{publisher_model\}` + */ + name?: string; + /** + * Optional. PublisherModel view specifying which fields to read. + */ + view?: string; + } + export interface Params$Resource$Publishers$Models$Predict + extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1PredictRequest; + } + export interface Params$Resource$Publishers$Models$Predictlongrunning + extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1PredictLongRunningRequest; + } + export interface Params$Resource$Publishers$Models$Streamgeneratecontent + extends StandardParameters { + /** + * Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + model?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1GenerateContentRequest; + } + + export class Resource$Ragcorpora { + context: APIRequestContext; + operations: Resource$Ragcorpora$Operations; + ragFiles: Resource$Ragcorpora$Ragfiles; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Ragcorpora$Operations(this.context); + this.ragFiles = new Resource$Ragcorpora$Ragfiles(this.context); + } + } + + export class Resource$Ragcorpora$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -118041,21 +155112,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.delete({ - * // Required. The name of the TensorboardExperiment to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', - * }); + * const res = await aiplatform.ragCorpora.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'ragCorpora/[^/]+/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -118070,58 +155134,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete, + cancel( + params: Params$Resource$Ragcorpora$Operations$Cancel, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete, + cancel( + params?: Params$Resource$Ragcorpora$Operations$Cancel, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete, + ): Promise>; + cancel( + params: Params$Resource$Ragcorpora$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Ragcorpora$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Ragcorpora$Operations$Cancel, + callback: BodyResponseCallback ): void; - delete( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete - | BodyResponseCallback + | Params$Resource$Ragcorpora$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete; + {}) as Params$Resource$Ragcorpora$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete; + params = {} as Params$Resource$Ragcorpora$Operations$Cancel; options = {}; } @@ -118134,8 +155193,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -118146,17 +155205,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a TensorboardExperiment. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -118177,10 +155236,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -118188,23 +155244,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tensorboards.experiments.get({ - * // Required. The name of the TensorboardExperiment resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', + * const res = await aiplatform.ragCorpora.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'ragCorpora/[^/]+/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "source": "my_source", - * // "updateTime": "my_updateTime" - * // } + * // {} * } * * main().catch(e => { @@ -118219,62 +155266,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Get, + delete( + params: Params$Resource$Ragcorpora$Operations$Delete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Get, + delete( + params?: Params$Resource$Ragcorpora$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Get, + ): Promise>; + delete( + params: Params$Resource$Ragcorpora$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Ragcorpora$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + delete( + params: Params$Resource$Ragcorpora$Operations$Delete, + callback: BodyResponseCallback ): void; - get( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Get - | BodyResponseCallback + | Params$Resource$Ragcorpora$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Get; + {}) as Params$Resource$Ragcorpora$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Get; + params = {} as Params$Resource$Ragcorpora$Operations$Delete; options = {}; } @@ -118288,7 +155326,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -118299,19 +155337,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists TensorboardExperiments in a Location. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -118332,10 +155368,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -118343,29 +155376,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tensorboards.experiments.list( - * { - * // Lists the TensorboardExperiments that match the filter expression. - * filter: 'placeholder-value', - * // Field to use to sort the list. - * orderBy: 'placeholder-value', - * // The maximum number of TensorboardExperiments to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardExperiments are returned. The maximum value is 1000; values above 1000 are coerced to 1000. - * pageSize: 'placeholder-value', - * // A page token, received from a previous TensorboardService.ListTensorboardExperiments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardExperiments must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Tensorboard to list TensorboardExperiments. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` - * parent: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.ragCorpora.operations.get({ + * // The name of the operation resource. + * name: 'ragCorpora/[^/]+/operations/my-operation', + * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "tensorboardExperiments": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -118381,62 +155404,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$List, + get( + params: Params$Resource$Ragcorpora$Operations$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$List, + get( + params?: Params$Resource$Ragcorpora$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$List, + ): Promise>; + get( + params: Params$Resource$Ragcorpora$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$List, + get( + params: Params$Resource$Ragcorpora$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Ragcorpora$Operations$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$List - | BodyResponseCallback + | Params$Resource$Ragcorpora$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$List; + {}) as Params$Resource$Ragcorpora$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$List; + params = {} as Params$Resource$Ragcorpora$Operations$Get; options = {}; } @@ -118449,34 +155467,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/experiments').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a TensorboardExperiment. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -118505,40 +155518,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.patch({ - * // Output only. Name of the TensorboardExperiment. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', - * // Required. Field mask is used to specify the fields to be overwritten in the TensorboardExperiment resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "source": "my_source", - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * const res = await aiplatform.ragCorpora.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'ragCorpora/[^/]+', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "source": "my_source", - * // "updateTime": "my_updateTime" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -118554,62 +155552,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch, + list( + params: Params$Resource$Ragcorpora$Operations$List, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch, + list( + params?: Params$Resource$Ragcorpora$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - patch( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch, + list( + params: Params$Resource$Ragcorpora$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch, + list( + params: Params$Resource$Ragcorpora$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch, - callback: BodyResponseCallback + list( + params: Params$Resource$Ragcorpora$Operations$List, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - patch( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch - | BodyResponseCallback + | Params$Resource$Ragcorpora$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch; + {}) as Params$Resource$Ragcorpora$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch; + params = {} as Params$Resource$Ragcorpora$Operations$List; options = {}; } @@ -118622,8 +155619,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -118634,19 +155634,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. If any data fail to be ingested, an error is returned. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -118675,24 +155675,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.write({ - * // Required. The resource name of the TensorboardExperiment to write data to. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` - * tensorboardExperiment: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "writeRunDataRequests": [] - * // } - * }, - * }); + * const res = await aiplatform.ragCorpora.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'ragCorpora/[^/]+/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -118707,62 +155705,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - write( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Write, + wait( + params: Params$Resource$Ragcorpora$Operations$Wait, options: StreamMethodOptions ): Promise>; - write( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Write, + wait( + params?: Params$Resource$Ragcorpora$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - write( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Write, + ): Promise>; + wait( + params: Params$Resource$Ragcorpora$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - write( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Write, + wait( + params: Params$Resource$Ragcorpora$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - write( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Write, - callback: BodyResponseCallback + wait( + params: Params$Resource$Ragcorpora$Operations$Wait, + callback: BodyResponseCallback ): void; - write( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - write( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Write - | BodyResponseCallback + | Params$Resource$Ragcorpora$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Write; + {}) as Params$Resource$Ragcorpora$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Write; + params = {} as Params$Resource$Ragcorpora$Operations$Wait; options = {}; } @@ -118775,132 +155768,96 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+tensorboardExperiment}:write').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['tensorboardExperiment'], - pathParams: ['tensorboardExperiment'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate - extends StandardParameters { - /** - * Required. The resource name of the TensorboardExperiment to create the TensorboardTimeSeries in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` The TensorboardRuns referenced by the parent fields in the CreateTensorboardTimeSeriesRequest messages must be sub resources of this TensorboardExperiment. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Create + export interface Params$Resource$Ragcorpora$Operations$Cancel extends StandardParameters { /** - * Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` - */ - parent?: string; - /** - * Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`. - */ - tensorboardExperimentId?: string; - - /** - * Request body metadata + * The name of the operation resource to be cancelled. */ - requestBody?: Schema$GoogleCloudAiplatformV1TensorboardExperiment; + name?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete + export interface Params$Resource$Ragcorpora$Operations$Delete extends StandardParameters { /** - * Required. The name of the TensorboardExperiment to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Get + export interface Params$Resource$Ragcorpora$Operations$Get extends StandardParameters { /** - * Required. The name of the TensorboardExperiment resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$List + export interface Params$Resource$Ragcorpora$Operations$List extends StandardParameters { /** - * Lists the TensorboardExperiments that match the filter expression. + * The standard list filter. */ filter?: string; /** - * Field to use to sort the list. + * The name of the operation's parent resource. */ - orderBy?: string; + name?: string; /** - * The maximum number of TensorboardExperiments to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardExperiments are returned. The maximum value is 1000; values above 1000 are coerced to 1000. + * The standard list page size. */ pageSize?: number; /** - * A page token, received from a previous TensorboardService.ListTensorboardExperiments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardExperiments must match the call that provided the page token. + * The standard list page token. */ pageToken?: string; /** - * Required. The resource name of the Tensorboard to list TensorboardExperiments. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - readMask?: string; + returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch + export interface Params$Resource$Ragcorpora$Operations$Wait extends StandardParameters { /** - * Output only. Name of the TensorboardExperiment. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` + * The name of the operation resource to wait on. */ name?: string; /** - * Required. Field mask is used to specify the fields to be overwritten in the TensorboardExperiment resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. - */ - updateMask?: string; - - /** - * Request body metadata + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - requestBody?: Schema$GoogleCloudAiplatformV1TensorboardExperiment; + timeout?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Write - extends StandardParameters { - /** - * Required. The resource name of the TensorboardExperiment to write data to. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` - */ - tensorboardExperiment?: string; - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest; + export class Resource$Ragcorpora$Ragfiles { + context: APIRequestContext; + operations: Resource$Ragcorpora$Ragfiles$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Ragcorpora$Ragfiles$Operations( + this.context + ); + } } - export class Resource$Projects$Locations$Tensorboards$Experiments$Operations { + export class Resource$Ragcorpora$Ragfiles$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -118936,13 +155893,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.operations.cancel( - * { - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/operations/my-operation', - * }, - * ); + * const res = await aiplatform.ragCorpora.ragFiles.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'ragCorpora/[^/]+/ragFiles/my-ragFile/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -118962,31 +155916,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel, + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel, + params?: Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel, + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel, + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel, + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel + | Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -119002,13 +155956,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel; + {}) as Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel; + params = {} as Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel; options = {}; } @@ -119072,13 +156025,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.operations.delete( - * { - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/operations/my-operation', - * }, - * ); + * const res = await aiplatform.ragCorpora.ragFiles.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'ragCorpora/[^/]+/ragFiles/my-ragFile/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -119098,31 +156048,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete, + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete, + params?: Params$Resource$Ragcorpora$Ragfiles$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete, + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete, + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete, + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete + | Params$Resource$Ragcorpora$Ragfiles$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -119138,13 +156088,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete; + {}) as Params$Resource$Ragcorpora$Ragfiles$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete; + params = {} as Params$Resource$Ragcorpora$Ragfiles$Operations$Delete; options = {}; } @@ -119208,13 +156157,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.operations.get( - * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/operations/my-operation', - * }, - * ); + * const res = await aiplatform.ragCorpora.ragFiles.operations.get({ + * // The name of the operation resource. + * name: 'ragCorpora/[^/]+/ragFiles/my-ragFile/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -119240,27 +156186,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get, + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get, + params?: Params$Resource$Ragcorpora$Ragfiles$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get, + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get, + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get, + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -119268,7 +156214,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get + | Params$Resource$Ragcorpora$Ragfiles$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -119284,13 +156230,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get; + {}) as Params$Resource$Ragcorpora$Ragfiles$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get; + params = {} as Params$Resource$Ragcorpora$Ragfiles$Operations$Get; options = {}; } @@ -119354,21 +156299,18 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.operations.list( - * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.ragCorpora.ragFiles.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'ragCorpora/[^/]+/ragFiles/my-ragFile', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -119392,29 +156334,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List, + params: Params$Resource$Ragcorpora$Ragfiles$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List, + params?: Params$Resource$Ragcorpora$Ragfiles$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List, + params: Params$Resource$Ragcorpora$Ragfiles$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List, + params: Params$Resource$Ragcorpora$Ragfiles$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List, + params: Params$Resource$Ragcorpora$Ragfiles$Operations$List, callback: BodyResponseCallback ): void; list( @@ -119422,7 +156364,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List + | Params$Resource$Ragcorpora$Ragfiles$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -119440,13 +156382,12 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List; + {}) as Params$Resource$Ragcorpora$Ragfiles$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List; + params = {} as Params$Resource$Ragcorpora$Ragfiles$Operations$List; options = {}; } @@ -119515,15 +156456,12 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.operations.wait( - * { - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.ragCorpora.ragFiles.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'ragCorpora/[^/]+/ragFiles/my-ragFile/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -119549,27 +156487,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait, + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait, + params?: Params$Resource$Ragcorpora$Ragfiles$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait, + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait, + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait, + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -119577,7 +156515,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait + | Params$Resource$Ragcorpora$Ragfiles$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -119593,13 +156531,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait; + {}) as Params$Resource$Ragcorpora$Ragfiles$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait; + params = {} as Params$Resource$Ragcorpora$Ragfiles$Operations$Wait; options = {}; } @@ -119634,28 +156571,28 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel + export interface Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete + export interface Params$Resource$Ragcorpora$Ragfiles$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get + export interface Params$Resource$Ragcorpora$Ragfiles$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List + export interface Params$Resource$Ragcorpora$Ragfiles$Operations$List extends StandardParameters { /** * The standard list filter. @@ -119678,7 +156615,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait + export interface Params$Resource$Ragcorpora$Ragfiles$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -119690,24 +156627,155 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Tensorboards$Experiments$Runs { + export class Resource$Ragengineconfig { context: APIRequestContext; - operations: Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations; - timeSeries: Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries; + operations: Resource$Ragengineconfig$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = - new Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations( - this.context - ); - this.timeSeries = - new Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries( - this.context + this.operations = new Resource$Ragengineconfig$Operations(this.context); + } + } + + export class Resource$Ragengineconfig$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.ragEngineConfig.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'ragEngineConfig/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Ragengineconfig$Operations$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Ragengineconfig$Operations$Cancel, + options?: MethodOptions + ): Promise>; + cancel( + params: Params$Resource$Ragengineconfig$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Ragengineconfig$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Ragengineconfig$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Ragengineconfig$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Ragengineconfig$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Ragengineconfig$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback ); + } else { + return createAPIRequest(parameters); + } } /** - * Batch create TensorboardRuns. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -119736,27 +156804,151 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.batchCreate( - * { - * // Required. The resource name of the TensorboardExperiment to create the TensorboardRuns in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` The parent field in the CreateTensorboardRunRequest messages must match this field. - * parent: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', + * const res = await aiplatform.ragEngineConfig.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'ragEngineConfig/operations/my-operation', + * }); + * console.log(res.data); * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "requests": [] - * // } - * }, - * }, - * ); + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Ragengineconfig$Operations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Ragengineconfig$Operations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Ragengineconfig$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Ragengineconfig$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Ragengineconfig$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Ragengineconfig$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Ragengineconfig$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Ragengineconfig$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.ragEngineConfig.operations.get({ + * // The name of the operation resource. + * name: 'ragEngineConfig/operations/my-operation', + * }); * console.log(res.data); * * // Example response * // { - * // "tensorboardRuns": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -119772,62 +156964,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchCreate( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate, + get( + params: Params$Resource$Ragengineconfig$Operations$Get, options: StreamMethodOptions ): Promise>; - batchCreate( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate, + get( + params?: Params$Resource$Ragengineconfig$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - batchCreate( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate, + ): Promise>; + get( + params: Params$Resource$Ragengineconfig$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate, + get( + params: Params$Resource$Ragengineconfig$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate, - callback: BodyResponseCallback + get( + params: Params$Resource$Ragengineconfig$Operations$Get, + callback: BodyResponseCallback ): void; - batchCreate( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - batchCreate( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate - | BodyResponseCallback + | Params$Resource$Ragengineconfig$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate; + {}) as Params$Resource$Ragengineconfig$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate; + params = {} as Params$Resource$Ragengineconfig$Operations$Get; options = {}; } @@ -119840,34 +157027,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/runs:batchCreate').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Creates a TensorboardRun. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -119896,39 +157078,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.create({ - * // Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` - * parent: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', - * // Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`. - * tensorboardRunId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * const res = await aiplatform.ragEngineConfig.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'ragEngineConfig', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "updateTime": "my_updateTime" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -119944,62 +157112,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create, + list( + params: Params$Resource$Ragengineconfig$Operations$List, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create, + list( + params?: Params$Resource$Ragengineconfig$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - create( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create, + list( + params: Params$Resource$Ragengineconfig$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create, + list( + params: Params$Resource$Ragengineconfig$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Ragengineconfig$Operations$List, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - create( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create - | BodyResponseCallback + | Params$Resource$Ragengineconfig$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create; + {}) as Params$Resource$Ragengineconfig$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create; + params = {} as Params$Resource$Ragengineconfig$Operations$List; options = {}; } @@ -120012,31 +157179,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/runs').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a TensorboardRun. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -120065,11 +157235,12 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.delete({ - * // Required. The name of the TensorboardRun to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', - * }); + * const res = await aiplatform.ragEngineConfig.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'ragEngineConfig/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -120094,36 +157265,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete, + wait( + params: Params$Resource$Ragengineconfig$Operations$Wait, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete, + wait( + params?: Params$Resource$Ragengineconfig$Operations$Wait, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete, + wait( + params: Params$Resource$Ragengineconfig$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete, + wait( + params: Params$Resource$Ragengineconfig$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete, + wait( + params: Params$Resource$Ragengineconfig$Operations$Wait, callback: BodyResponseCallback ): void; - delete( + wait( callback: BodyResponseCallback ): void; - delete( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete + | Params$Resource$Ragengineconfig$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -120139,13 +157310,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete; + {}) as Params$Resource$Ragengineconfig$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete; + params = {} as Params$Resource$Ragengineconfig$Operations$Wait; options = {}; } @@ -120154,33 +157324,98 @@ export namespace aiplatform_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Ragengineconfig$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Ragengineconfig$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Ragengineconfig$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Ragengineconfig$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Ragengineconfig$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Reasoningengines { + context: APIRequestContext; + operations: Resource$Reasoningengines$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Reasoningengines$Operations(this.context); } /** - * Gets a TensorboardRun. + * Creates a reasoning engine. * @example * ```js * // Before running the sample: @@ -120201,10 +157436,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -120212,22 +157444,35 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.get({ - * // Required. The name of the TensorboardRun resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', - * }); + * const res = await aiplatform.reasoningEngines.create({ + * // Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project\}/locations/{location\}` + * parent: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "spec": {}, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -120243,62 +157488,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get, + create( + params: Params$Resource$Reasoningengines$Create, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get, + create( + params?: Params$Resource$Reasoningengines$Create, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get, + ): Promise>; + create( + params: Params$Resource$Reasoningengines$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get, + create( + params: Params$Resource$Reasoningengines$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Reasoningengines$Create, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get - | BodyResponseCallback + | Params$Resource$Reasoningengines$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get; + {}) as Params$Resource$Reasoningengines$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get; + params = {} as Params$Resource$Reasoningengines$Create; options = {}; } @@ -120311,31 +157551,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/reasoningEngines').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: [], + pathParams: [], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists TensorboardRuns in a Location. + * Deletes a reasoning engine. * @example * ```js * // Before running the sample: @@ -120356,10 +157597,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -120367,28 +157605,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.list({ - * // Lists the TensorboardRuns that match the filter expression. - * filter: 'placeholder-value', - * // Field to use to sort the list. - * orderBy: 'placeholder-value', - * // The maximum number of TensorboardRuns to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardRuns are returned. The maximum value is 1000; values above 1000 are coerced to 1000. - * pageSize: 'placeholder-value', - * // A page token, received from a previous TensorboardService.ListTensorboardRuns call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardRuns must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` - * parent: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', - * }); + * const res = await aiplatform.reasoningEngines.delete({ + * // Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources. + * force: 'placeholder-value', + * // Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * name: 'reasoningEngines/my-reasoningEngine', + * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "tensorboardRuns": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -120404,62 +157635,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List, + delete( + params: Params$Resource$Reasoningengines$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List, + delete( + params?: Params$Resource$Reasoningengines$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List, + ): Promise>; + delete( + params: Params$Resource$Reasoningengines$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List, + delete( + params: Params$Resource$Reasoningengines$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Reasoningengines$Delete, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - list( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List - | BodyResponseCallback + | Params$Resource$Reasoningengines$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List; + {}) as Params$Resource$Reasoningengines$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List; + params = {} as Params$Resource$Reasoningengines$Delete; options = {}; } @@ -120472,31 +157698,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/runs').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a TensorboardRun. + * Gets a reasoning engine. * @example * ```js * // Before running the sample: @@ -120525,27 +157749,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.patch({ - * // Output only. Name of the TensorboardRun. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', - * // Required. Field mask is used to specify the fields to be overwritten in the TensorboardRun resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * const res = await aiplatform.reasoningEngines.get({ + * // Required. The name of the ReasoningEngine resource. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * name: 'reasoningEngines/my-reasoningEngine', + * }); * console.log(res.data); * * // Example response @@ -120553,9 +157760,11 @@ export namespace aiplatform_v1 { * // "createTime": "my_createTime", * // "description": "my_description", * // "displayName": "my_displayName", + * // "encryptionSpec": {}, * // "etag": "my_etag", * // "labels": {}, * // "name": "my_name", + * // "spec": {}, * // "updateTime": "my_updateTime" * // } * } @@ -120572,62 +157781,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch, + get( + params: Params$Resource$Reasoningengines$Get, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch, + get( + params?: Params$Resource$Reasoningengines$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - patch( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch, + get( + params: Params$Resource$Reasoningengines$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch, + get( + params: Params$Resource$Reasoningengines$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Reasoningengines$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch - | BodyResponseCallback + | Params$Resource$Reasoningengines$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch; + {}) as Params$Resource$Reasoningengines$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch; + params = {} as Params$Resource$Reasoningengines$Get; options = {}; } @@ -120641,7 +157849,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -120652,19 +157860,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned. + * Lists reasoning engines in a location. * @example * ```js * // Before running the sample: @@ -120693,25 +157901,23 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.write({ - * // Required. The resource name of the TensorboardRun to write data to. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` - * tensorboardRun: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "tensorboardRun": "my_tensorboardRun", - * // "timeSeriesData": [] - * // } - * }, - * }); + * const res = await aiplatform.reasoningEngines.list({ + * // Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). + * filter: 'placeholder-value', + * // Optional. The standard list page size. + * pageSize: 'placeholder-value', + * // Optional. The standard list page token. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project\}/locations/{location\}` + * parent: 'placeholder-value', + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "nextPageToken": "my_nextPageToken", + * // "reasoningEngines": [] + * // } * } * * main().catch(e => { @@ -120726,62 +157932,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - write( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write, + list( + params: Params$Resource$Reasoningengines$List, options: StreamMethodOptions ): Promise>; - write( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write, + list( + params?: Params$Resource$Reasoningengines$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - write( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write, + list( + params: Params$Resource$Reasoningengines$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - write( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write, + list( + params: Params$Resource$Reasoningengines$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - write( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write, - callback: BodyResponseCallback + list( + params: Params$Resource$Reasoningengines$List, + callback: BodyResponseCallback ): void; - write( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - write( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write - | BodyResponseCallback + | Params$Resource$Reasoningengines$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write; + {}) as Params$Resource$Reasoningengines$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write; + params = {} as Params$Resource$Reasoningengines$List; options = {}; } @@ -120794,139 +157999,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+tensorboardRun}:write').replace( + url: (rootUrl + '/v1/reasoningEngines').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['tensorboardRun'], - pathParams: ['tensorboardRun'], + requiredParams: [], + pathParams: [], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate - extends StandardParameters { - /** - * Required. The resource name of the TensorboardExperiment to create the TensorboardRuns in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` The parent field in the CreateTensorboardRunRequest messages must match this field. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create - extends StandardParameters { - /** - * Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` - */ - parent?: string; - /** - * Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`. - */ - tensorboardRunId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1TensorboardRun; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete - extends StandardParameters { - /** - * Required. The name of the TensorboardRun to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get - extends StandardParameters { - /** - * Required. The name of the TensorboardRun resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List - extends StandardParameters { - /** - * Lists the TensorboardRuns that match the filter expression. - */ - filter?: string; - /** - * Field to use to sort the list. - */ - orderBy?: string; - /** - * The maximum number of TensorboardRuns to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardRuns are returned. The maximum value is 1000; values above 1000 are coerced to 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous TensorboardService.ListTensorboardRuns call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardRuns must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch - extends StandardParameters { - /** - * Output only. Name of the TensorboardRun. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` - */ - name?: string; - /** - * Required. Field mask is used to specify the fields to be overwritten in the TensorboardRun resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1TensorboardRun; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write - extends StandardParameters { - /** - * Required. The resource name of the TensorboardRun to write data to. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` - */ - tensorboardRun?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1WriteTensorboardRunDataRequest; - } - - export class Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Updates a reasoning engine. * @example * ```js * // Before running the sample: @@ -120955,17 +158055,38 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.operations.cancel( - * { - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/operations/my-operation', - * }, - * ); + * const res = await aiplatform.reasoningEngines.patch({ + * // Identifier. The resource name of the ReasoningEngine. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * name: 'reasoningEngines/my-reasoningEngine', + * // Optional. Mask specifying which fields to update. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "spec": {}, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -120980,54 +158101,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel, + patch( + params: Params$Resource$Reasoningengines$Patch, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel, + patch( + params?: Params$Resource$Reasoningengines$Patch, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel, + ): Promise>; + patch( + params: Params$Resource$Reasoningengines$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Reasoningengines$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel, - callback: BodyResponseCallback + patch( + params: Params$Resource$Reasoningengines$Patch, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + patch( + callback: BodyResponseCallback + ): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Reasoningengines$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel; + {}) as Params$Resource$Reasoningengines$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel; + params = {} as Params$Resource$Reasoningengines$Patch; options = {}; } @@ -121040,8 +158164,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -121052,17 +158176,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Queries using a reasoning engine. * @example * ```js * // Before running the sample: @@ -121091,17 +158215,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.operations.delete( - * { - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/operations/my-operation', - * }, - * ); + * const res = await aiplatform.reasoningEngines.query({ + * // Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * name: 'reasoningEngines/my-reasoningEngine', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "classMethod": "my_classMethod", + * // "input": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "output": {} + * // } * } * * main().catch(e => { @@ -121116,54 +158248,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete, + query( + params: Params$Resource$Reasoningengines$Query, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete, + query( + params?: Params$Resource$Reasoningengines$Query, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + query( + params: Params$Resource$Reasoningengines$Query, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + query( + params: Params$Resource$Reasoningengines$Query, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete, - callback: BodyResponseCallback + query( + params: Params$Resource$Reasoningengines$Query, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + query( + callback: BodyResponseCallback + ): void; + query( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete - | BodyResponseCallback + | Params$Resource$Reasoningengines$Query + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete; + {}) as Params$Resource$Reasoningengines$Query; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete; + params = {} as Params$Resource$Reasoningengines$Query; options = {}; } @@ -121176,8 +158315,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}:query').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -121188,17 +158327,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Streams queries using a reasoning engine. * @example * ```js * // Before running the sample: @@ -121227,22 +158368,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.operations.get( - * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/operations/my-operation', - * }, - * ); + * const res = await aiplatform.reasoningEngines.streamQuery({ + * // Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * name: 'reasoningEngines/my-reasoningEngine', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "classMethod": "my_classMethod", + * // "input": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] * // } * } * @@ -121258,58 +158403,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get, + streamQuery( + params: Params$Resource$Reasoningengines$Streamquery, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get, + streamQuery( + params?: Params$Resource$Reasoningengines$Streamquery, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get, + ): Promise>; + streamQuery( + params: Params$Resource$Reasoningengines$Streamquery, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get, - callback: BodyResponseCallback + streamQuery( + params: Params$Resource$Reasoningengines$Streamquery, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + streamQuery( + params: Params$Resource$Reasoningengines$Streamquery, + callback: BodyResponseCallback ): void; - get( + streamQuery(callback: BodyResponseCallback): void; + streamQuery( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get - | BodyResponseCallback + | Params$Resource$Reasoningengines$Streamquery + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get; + {}) as Params$Resource$Reasoningengines$Streamquery; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get; + params = {} as Params$Resource$Reasoningengines$Streamquery; options = {}; } @@ -121322,8 +158462,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:streamQuery').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -121334,17 +158477,114 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Reasoningengines$Create + extends StandardParameters { /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ReasoningEngine; + } + export interface Params$Resource$Reasoningengines$Delete + extends StandardParameters { + /** + * Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources. + */ + force?: boolean; + /** + * Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + name?: string; + } + export interface Params$Resource$Reasoningengines$Get + extends StandardParameters { + /** + * Required. The name of the ReasoningEngine resource. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + name?: string; + } + export interface Params$Resource$Reasoningengines$List + extends StandardParameters { + /** + * Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). + */ + filter?: string; + /** + * Optional. The standard list page size. + */ + pageSize?: number; + /** + * Optional. The standard list page token. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + export interface Params$Resource$Reasoningengines$Patch + extends StandardParameters { + /** + * Identifier. The resource name of the ReasoningEngine. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + name?: string; + /** + * Optional. Mask specifying which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ReasoningEngine; + } + export interface Params$Resource$Reasoningengines$Query + extends StandardParameters { + /** + * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1QueryReasoningEngineRequest; + } + export interface Params$Resource$Reasoningengines$Streamquery + extends StandardParameters { + /** + * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest; + } + + export class Resource$Reasoningengines$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -121373,29 +158613,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.operations.list( - * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.reasoningEngines.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'reasoningEngines/my-reasoningEngine/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] - * // } + * // {} * } * * main().catch(e => { @@ -121410,62 +158635,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List, + cancel( + params: Params$Resource$Reasoningengines$Operations$Cancel, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List, + cancel( + params?: Params$Resource$Reasoningengines$Operations$Cancel, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List, + ): Promise>; + cancel( + params: Params$Resource$Reasoningengines$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Reasoningengines$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Reasoningengines$Operations$Cancel, + callback: BodyResponseCallback ): void; - list( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List - | BodyResponseCallback + | Params$Resource$Reasoningengines$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List; + {}) as Params$Resource$Reasoningengines$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List; + params = {} as Params$Resource$Reasoningengines$Operations$Cancel; options = {}; } @@ -121478,11 +158694,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -121493,19 +158706,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -121527,32 +158738,21 @@ export namespace aiplatform_v1 { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.operations.wait( - * { - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }, - * ); + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.reasoningEngines.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'reasoningEngines/my-reasoningEngine/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -121567,58 +158767,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait, + delete( + params: Params$Resource$Reasoningengines$Operations$Delete, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait, + delete( + params?: Params$Resource$Reasoningengines$Operations$Delete, options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait, + ): Promise>; + delete( + params: Params$Resource$Reasoningengines$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - wait( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait, - callback: BodyResponseCallback + delete( + params: Params$Resource$Reasoningengines$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + delete( + params: Params$Resource$Reasoningengines$Operations$Delete, + callback: BodyResponseCallback ): void; - wait( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait - | BodyResponseCallback + | Params$Resource$Reasoningengines$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait; + {}) as Params$Resource$Reasoningengines$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait; + params = {} as Params$Resource$Reasoningengines$Operations$Delete; options = {}; } @@ -121631,8 +158826,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -121643,85 +158838,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel - extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete - extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait - extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries { - context: APIRequestContext; - operations: Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations( - this.context - ); - } /** - * Creates a TensorboardTimeSeries. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -121750,47 +158877,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.create( - * { - * // Required. The resource name of the TensorboardRun to create the TensorboardTimeSeries in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` - * parent: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', - * // Optional. The user specified unique ID to use for the TensorboardTimeSeries, which becomes the final component of the TensorboardTimeSeries's resource name. This value should match "a-z0-9{0, 127\}" - * tensorboardTimeSeriesId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "metadata": {}, - * // "name": "my_name", - * // "pluginData": "my_pluginData", - * // "pluginName": "my_pluginName", - * // "updateTime": "my_updateTime", - * // "valueType": "my_valueType" - * // } - * }, - * }, - * ); + * const res = await aiplatform.reasoningEngines.operations.get({ + * // The name of the operation resource. + * name: 'reasoningEngines/my-reasoningEngine/operations/my-operation', + * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", + * // "done": false, + * // "error": {}, * // "metadata": {}, * // "name": "my_name", - * // "pluginData": "my_pluginData", - * // "pluginName": "my_pluginName", - * // "updateTime": "my_updateTime", - * // "valueType": "my_valueType" + * // "response": {} * // } * } * @@ -121806,62 +158905,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create, + get( + params: Params$Resource$Reasoningengines$Operations$Get, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create, + get( + params?: Params$Resource$Reasoningengines$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - create( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create, + ): Promise>; + get( + params: Params$Resource$Reasoningengines$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create, + get( + params: Params$Resource$Reasoningengines$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Reasoningengines$Operations$Get, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - create( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create - | BodyResponseCallback + | Params$Resource$Reasoningengines$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create; + {}) as Params$Resource$Reasoningengines$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create; + params = {} as Params$Resource$Reasoningengines$Operations$Get; options = {}; } @@ -121874,34 +158968,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/timeSeries').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes a TensorboardTimeSeries. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -121930,22 +159019,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.delete( - * { - * // Required. The name of the TensorboardTimeSeries to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', - * }, - * ); + * const res = await aiplatform.reasoningEngines.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'reasoningEngines/my-reasoningEngine', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -121961,58 +159053,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete, + list( + params: Params$Resource$Reasoningengines$Operations$List, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete, + list( + params?: Params$Resource$Reasoningengines$Operations$List, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Reasoningengines$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete, + list( + params: Params$Resource$Reasoningengines$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Reasoningengines$Operations$List, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - delete( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete - | BodyResponseCallback + | Params$Resource$Reasoningengines$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete; + {}) as Params$Resource$Reasoningengines$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete; + params = {} as Params$Resource$Reasoningengines$Operations$List; options = {}; } @@ -122025,8 +159120,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -122037,17 +159135,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Exports a TensorboardTimeSeries' data. Data is returned in paginated responses. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -122076,31 +159176,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.exportTensorboardTimeSeries( - * { - * // Required. The resource name of the TensorboardTimeSeries to export data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` - * tensorboardTimeSeries: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "filter": "my_filter", - * // "orderBy": "my_orderBy", - * // "pageSize": 0, - * // "pageToken": "my_pageToken" - * // } - * }, - * }, - * ); + * const res = await aiplatform.reasoningEngines.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'reasoningEngines/my-reasoningEngine/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "timeSeriesDataPoints": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -122116,62 +159206,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - exportTensorboardTimeSeries( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries, + wait( + params: Params$Resource$Reasoningengines$Operations$Wait, options: StreamMethodOptions ): Promise>; - exportTensorboardTimeSeries( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries, + wait( + params?: Params$Resource$Reasoningengines$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - exportTensorboardTimeSeries( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries, + ): Promise>; + wait( + params: Params$Resource$Reasoningengines$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - exportTensorboardTimeSeries( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries, + wait( + params: Params$Resource$Reasoningengines$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - exportTensorboardTimeSeries( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries, - callback: BodyResponseCallback + wait( + params: Params$Resource$Reasoningengines$Operations$Wait, + callback: BodyResponseCallback ): void; - exportTensorboardTimeSeries( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - exportTensorboardTimeSeries( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries - | BodyResponseCallback + | Params$Resource$Reasoningengines$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries; + {}) as Params$Resource$Reasoningengines$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries; + params = {} as Params$Resource$Reasoningengines$Operations$Wait; options = {}; } @@ -122184,34 +159269,101 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + - '/v1/{+tensorboardTimeSeries}:exportTensorboardTimeSeries' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['tensorboardTimeSeries'], - pathParams: ['tensorboardTimeSeries'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Reasoningengines$Operations$Cancel + extends StandardParameters { /** - * Gets a TensorboardTimeSeries. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Reasoningengines$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Reasoningengines$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Reasoningengines$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Reasoningengines$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Schedules { + context: APIRequestContext; + operations: Resource$Schedules$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Schedules$Operations(this.context); + } + } + + export class Resource$Schedules$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -122232,10 +159384,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -122243,28 +159392,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.get( - * { - * // Required. The name of the TensorboardTimeSeries resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', - * }, - * ); + * const res = await aiplatform.schedules.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'schedules/my-schedule/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "metadata": {}, - * // "name": "my_name", - * // "pluginData": "my_pluginData", - * // "pluginName": "my_pluginName", - * // "updateTime": "my_updateTime", - * // "valueType": "my_valueType" - * // } + * // {} * } * * main().catch(e => { @@ -122279,62 +159414,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get, + cancel( + params: Params$Resource$Schedules$Operations$Cancel, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get, + cancel( + params?: Params$Resource$Schedules$Operations$Cancel, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get, + ): Promise>; + cancel( + params: Params$Resource$Schedules$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Schedules$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Schedules$Operations$Cancel, + callback: BodyResponseCallback ): void; - get( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get - | BodyResponseCallback + | Params$Resource$Schedules$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get; + {}) as Params$Resource$Schedules$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get; + params = {} as Params$Resource$Schedules$Operations$Cancel; options = {}; } @@ -122347,8 +159473,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -122359,19 +159485,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists TensorboardTimeSeries in a Location. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -122392,10 +159516,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -122403,31 +159524,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.list( - * { - * // Lists the TensorboardTimeSeries that match the filter expression. - * filter: 'placeholder-value', - * // Field to use to sort the list. - * orderBy: 'placeholder-value', - * // The maximum number of TensorboardTimeSeries to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardTimeSeries are returned. The maximum value is 1000; values above 1000 are coerced to 1000. - * pageSize: 'placeholder-value', - * // A page token, received from a previous TensorboardService.ListTensorboardTimeSeries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardTimeSeries must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` - * parent: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.schedules.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'schedules/my-schedule/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "nextPageToken": "my_nextPageToken", - * // "tensorboardTimeSeries": [] - * // } + * // {} * } * * main().catch(e => { @@ -122442,62 +159546,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List, + delete( + params: Params$Resource$Schedules$Operations$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List, + delete( + params?: Params$Resource$Schedules$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List, + ): Promise>; + delete( + params: Params$Resource$Schedules$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Schedules$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Schedules$Operations$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List - | BodyResponseCallback + | Params$Resource$Schedules$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List; + {}) as Params$Resource$Schedules$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List; + params = {} as Params$Resource$Schedules$Operations$Delete; options = {}; } @@ -122510,34 +159605,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/timeSeries').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a TensorboardTimeSeries. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -122566,46 +159656,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.patch( - * { - * // Output only. Name of the TensorboardTimeSeries. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', - * // Required. Field mask is used to specify the fields to be overwritten in the TensorboardTimeSeries resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "metadata": {}, - * // "name": "my_name", - * // "pluginData": "my_pluginData", - * // "pluginName": "my_pluginName", - * // "updateTime": "my_updateTime", - * // "valueType": "my_valueType" - * // } - * }, - * }, - * ); + * const res = await aiplatform.schedules.operations.get({ + * // The name of the operation resource. + * name: 'schedules/my-schedule/operations/my-operation', + * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", + * // "done": false, + * // "error": {}, * // "metadata": {}, * // "name": "my_name", - * // "pluginData": "my_pluginData", - * // "pluginName": "my_pluginName", - * // "updateTime": "my_updateTime", - * // "valueType": "my_valueType" + * // "response": {} * // } * } * @@ -122621,62 +159684,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch, + get( + params: Params$Resource$Schedules$Operations$Get, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch, + get( + params?: Params$Resource$Schedules$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - patch( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch, + ): Promise>; + get( + params: Params$Resource$Schedules$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch, + get( + params: Params$Resource$Schedules$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Schedules$Operations$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch - | BodyResponseCallback + | Params$Resource$Schedules$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch; + {}) as Params$Resource$Schedules$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch; + params = {} as Params$Resource$Schedules$Operations$Get; options = {}; } @@ -122690,7 +159748,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -122701,19 +159759,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -122734,10 +159790,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -122745,23 +159798,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.read( - * { - * // Reads the TensorboardTimeSeries' data that match the filter expression. - * filter: 'placeholder-value', - * // The maximum number of TensorboardTimeSeries' data to return. This value should be a positive integer. This value can be set to -1 to return all data. - * maxDataPoints: 'placeholder-value', - * // Required. The resource name of the TensorboardTimeSeries to read data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` - * tensorboardTimeSeries: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', - * }, - * ); + * const res = await aiplatform.schedules.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'schedules/my-schedule', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "timeSeriesData": {} + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -122777,62 +159832,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - read( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read, + list( + params: Params$Resource$Schedules$Operations$List, options: StreamMethodOptions ): Promise>; - read( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read, + list( + params?: Params$Resource$Schedules$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - read( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read, + list( + params: Params$Resource$Schedules$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - read( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read, + list( + params: Params$Resource$Schedules$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - read( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read, - callback: BodyResponseCallback + list( + params: Params$Resource$Schedules$Operations$List, + callback: BodyResponseCallback ): void; - read( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - read( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read - | BodyResponseCallback + | Params$Resource$Schedules$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read; + {}) as Params$Resource$Schedules$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read; + params = {} as Params$Resource$Schedules$Operations$List; options = {}; } @@ -122845,7 +159899,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+tensorboardTimeSeries}:read').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -122855,24 +159909,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['tensorboardTimeSeries'], - pathParams: ['tensorboardTimeSeries'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets bytes of TensorboardBlobs. This is to allow reading blob data stored in consumer project's Cloud Storage bucket without users having to obtain Cloud Storage access permission. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -122893,10 +159947,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -122904,21 +159955,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.readBlobData( - * { - * // IDs of the blobs to read. - * blobIds: 'placeholder-value', - * // Required. The resource name of the TensorboardTimeSeries to list Blobs. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` - * timeSeries: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', - * }, - * ); + * const res = await aiplatform.schedules.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'schedules/my-schedule/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "blobs": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -122934,62 +159985,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - readBlobData( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata, + wait( + params: Params$Resource$Schedules$Operations$Wait, options: StreamMethodOptions ): Promise>; - readBlobData( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata, + wait( + params?: Params$Resource$Schedules$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - readBlobData( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata, + ): Promise>; + wait( + params: Params$Resource$Schedules$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - readBlobData( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata, + wait( + params: Params$Resource$Schedules$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - readBlobData( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata, - callback: BodyResponseCallback + wait( + params: Params$Resource$Schedules$Operations$Wait, + callback: BodyResponseCallback ): void; - readBlobData( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - readBlobData( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata - | BodyResponseCallback + | Params$Resource$Schedules$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata; + {}) as Params$Resource$Schedules$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata; + params = {} as Params$Resource$Schedules$Operations$Wait; options = {}; } @@ -123002,146 +160048,94 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+timeSeries}:readBlobData').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['timeSeries'], - pathParams: ['timeSeries'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create - extends StandardParameters { - /** - * Required. The resource name of the TensorboardRun to create the TensorboardTimeSeries in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` - */ - parent?: string; - /** - * Optional. The user specified unique ID to use for the TensorboardTimeSeries, which becomes the final component of the TensorboardTimeSeries's resource name. This value should match "a-z0-9{0, 127\}" - */ - tensorboardTimeSeriesId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1TensorboardTimeSeries; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete + export interface Params$Resource$Schedules$Operations$Cancel extends StandardParameters { /** - * Required. The name of the TensorboardTimeSeries to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` + * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries + export interface Params$Resource$Schedules$Operations$Delete extends StandardParameters { /** - * Required. The resource name of the TensorboardTimeSeries to export data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` - */ - tensorboardTimeSeries?: string; - - /** - * Request body metadata + * The name of the operation resource to be deleted. */ - requestBody?: Schema$GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest; + name?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get + export interface Params$Resource$Schedules$Operations$Get extends StandardParameters { /** - * Required. The name of the TensorboardTimeSeries resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List + export interface Params$Resource$Schedules$Operations$List extends StandardParameters { /** - * Lists the TensorboardTimeSeries that match the filter expression. + * The standard list filter. */ filter?: string; /** - * Field to use to sort the list. + * The name of the operation's parent resource. */ - orderBy?: string; + name?: string; /** - * The maximum number of TensorboardTimeSeries to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardTimeSeries are returned. The maximum value is 1000; values above 1000 are coerced to 1000. + * The standard list page size. */ pageSize?: number; /** - * A page token, received from a previous TensorboardService.ListTensorboardTimeSeries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardTimeSeries must match the call that provided the page token. + * The standard list page token. */ pageToken?: string; /** - * Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - readMask?: string; + returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch + export interface Params$Resource$Schedules$Operations$Wait extends StandardParameters { /** - * Output only. Name of the TensorboardTimeSeries. + * The name of the operation resource to wait on. */ name?: string; /** - * Required. Field mask is used to specify the fields to be overwritten in the TensorboardTimeSeries resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1TensorboardTimeSeries; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read - extends StandardParameters { - /** - * Reads the TensorboardTimeSeries' data that match the filter expression. - */ - filter?: string; - /** - * The maximum number of TensorboardTimeSeries' data to return. This value should be a positive integer. This value can be set to -1 to return all data. - */ - maxDataPoints?: number; - /** - * Required. The resource name of the TensorboardTimeSeries to read data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - tensorboardTimeSeries?: string; + timeout?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata - extends StandardParameters { - /** - * IDs of the blobs to read. - */ - blobIds?: string[]; - /** - * Required. The resource name of the TensorboardTimeSeries to list Blobs. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` - */ - timeSeries?: string; + + export class Resource$Specialistpools { + context: APIRequestContext; + operations: Resource$Specialistpools$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Specialistpools$Operations(this.context); + } } - export class Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations { + export class Resource$Specialistpools$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -123177,13 +160171,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.cancel( - * { - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie/operations/my-operation', - * }, - * ); + * const res = await aiplatform.specialistPools.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'specialistPools/my-specialistPool/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -123203,31 +160194,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel, + params: Params$Resource$Specialistpools$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel, + params?: Params$Resource$Specialistpools$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel, + params: Params$Resource$Specialistpools$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel, + params: Params$Resource$Specialistpools$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel, + params: Params$Resource$Specialistpools$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel + | Params$Resource$Specialistpools$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -123243,13 +160234,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel; + {}) as Params$Resource$Specialistpools$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel; + params = {} as Params$Resource$Specialistpools$Operations$Cancel; options = {}; } @@ -123313,13 +160303,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.delete( - * { - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie/operations/my-operation', - * }, - * ); + * const res = await aiplatform.specialistPools.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'specialistPools/my-specialistPool/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -123339,31 +160326,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete, + params: Params$Resource$Specialistpools$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete, + params?: Params$Resource$Specialistpools$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete, + params: Params$Resource$Specialistpools$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete, + params: Params$Resource$Specialistpools$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete, + params: Params$Resource$Specialistpools$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete + | Params$Resource$Specialistpools$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -123379,13 +160366,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete; + {}) as Params$Resource$Specialistpools$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete; + params = {} as Params$Resource$Specialistpools$Operations$Delete; options = {}; } @@ -123449,13 +160435,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.get( - * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie/operations/my-operation', - * }, - * ); + * const res = await aiplatform.specialistPools.operations.get({ + * // The name of the operation resource. + * name: 'specialistPools/my-specialistPool/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -123481,27 +160464,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get, + params: Params$Resource$Specialistpools$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get, + params?: Params$Resource$Specialistpools$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get, + params: Params$Resource$Specialistpools$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get, + params: Params$Resource$Specialistpools$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get, + params: Params$Resource$Specialistpools$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -123509,7 +160492,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get + | Params$Resource$Specialistpools$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -123525,13 +160508,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get; + {}) as Params$Resource$Specialistpools$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get; + params = {} as Params$Resource$Specialistpools$Operations$Get; options = {}; } @@ -123595,21 +160577,18 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.list( - * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.specialistPools.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'specialistPools/my-specialistPool', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -123633,29 +160612,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List, + params: Params$Resource$Specialistpools$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List, + params?: Params$Resource$Specialistpools$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List, + params: Params$Resource$Specialistpools$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List, + params: Params$Resource$Specialistpools$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List, + params: Params$Resource$Specialistpools$Operations$List, callback: BodyResponseCallback ): void; list( @@ -123663,7 +160642,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List + | Params$Resource$Specialistpools$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -123681,13 +160660,12 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List; + {}) as Params$Resource$Specialistpools$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List; + params = {} as Params$Resource$Specialistpools$Operations$List; options = {}; } @@ -123756,222 +160734,228 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.wait( - * { - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }, - * ); - * console.log(res.data); - * - * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - wait( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait, - options: StreamMethodOptions - ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait, - options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - wait( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - wait( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait, - callback: BodyResponseCallback - ): void; - wait( - callback: BodyResponseCallback - ): void; - wait( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel - extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete - extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait - extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Tensorboards$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const aiplatform = google.aiplatform('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * const res = await aiplatform.specialistPools.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'specialistPools/my-specialistPool/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + wait( + params: Params$Resource$Specialistpools$Operations$Wait, + options: StreamMethodOptions + ): Promise>; + wait( + params?: Params$Resource$Specialistpools$Operations$Wait, + options?: MethodOptions + ): Promise>; + wait( + params: Params$Resource$Specialistpools$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Specialistpools$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Specialistpools$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Specialistpools$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Specialistpools$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Specialistpools$Operations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Specialistpools$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Specialistpools$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Specialistpools$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Specialistpools$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Specialistpools$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Studies { + context: APIRequestContext; + operations: Resource$Studies$Operations; + trials: Resource$Studies$Trials; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Studies$Operations(this.context); + this.trials = new Resource$Studies$Trials(this.context); + } + } + + export class Resource$Studies$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.studies.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'studies/my-studie/operations/my-operation', * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/operations/my-operation', - * }); * console.log(res.data); * * // Example response @@ -123991,31 +160975,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel, + params: Params$Resource$Studies$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel, + params?: Params$Resource$Studies$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel, + params: Params$Resource$Studies$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel, + params: Params$Resource$Studies$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel, + params: Params$Resource$Studies$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel + | Params$Resource$Studies$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -124031,13 +161015,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel; + {}) as Params$Resource$Studies$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel; + params = {} as Params$Resource$Studies$Operations$Cancel; options = {}; } @@ -124101,11 +161084,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/operations/my-operation', - * }); + * const res = await aiplatform.studies.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'studies/my-studie/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -124125,31 +161107,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Delete, + params: Params$Resource$Studies$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Tensorboards$Operations$Delete, + params?: Params$Resource$Studies$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Delete, + params: Params$Resource$Studies$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Delete, + params: Params$Resource$Studies$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Delete, + params: Params$Resource$Studies$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Operations$Delete + | Params$Resource$Studies$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -124165,13 +161147,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Operations$Delete; + {}) as Params$Resource$Studies$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Operations$Delete; + params = {} as Params$Resource$Studies$Operations$Delete; options = {}; } @@ -124235,9 +161216,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tensorboards.operations.get({ + * const res = await aiplatform.studies.operations.get({ * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/operations/my-operation', + * name: 'studies/my-studie/operations/my-operation', * }); * console.log(res.data); * @@ -124264,27 +161245,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Get, + params: Params$Resource$Studies$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Tensorboards$Operations$Get, + params?: Params$Resource$Studies$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Get, + params: Params$Resource$Studies$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Get, + params: Params$Resource$Studies$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Get, + params: Params$Resource$Studies$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -124292,7 +161273,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Operations$Get + | Params$Resource$Studies$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -124308,13 +161289,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Operations$Get; + {}) as Params$Resource$Studies$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Operations$Get; + params = {} as Params$Resource$Studies$Operations$Get; options = {}; } @@ -124378,11 +161358,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tensorboards.operations.list({ + * const res = await aiplatform.studies.operations.list({ * // The standard list filter. * filter: 'placeholder-value', * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', + * name: 'studies/my-studie', * // The standard list page size. * pageSize: 'placeholder-value', * // The standard list page token. @@ -124413,29 +161393,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$List, + params: Params$Resource$Studies$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Tensorboards$Operations$List, + params?: Params$Resource$Studies$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$List, + params: Params$Resource$Studies$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$List, + params: Params$Resource$Studies$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$List, + params: Params$Resource$Studies$Operations$List, callback: BodyResponseCallback ): void; list( @@ -124443,7 +161423,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Operations$List + | Params$Resource$Studies$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -124461,13 +161441,12 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Operations$List; + {}) as Params$Resource$Studies$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Operations$List; + params = {} as Params$Resource$Studies$Operations$List; options = {}; } @@ -124536,9 +161515,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tensorboards.operations.wait({ + * const res = await aiplatform.studies.operations.wait({ * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/operations/my-operation', + * name: 'studies/my-studie/operations/my-operation', * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. * timeout: 'placeholder-value', * }); @@ -124567,27 +161546,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Wait, + params: Params$Resource$Studies$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Tensorboards$Operations$Wait, + params?: Params$Resource$Studies$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Wait, + params: Params$Resource$Studies$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Wait, + params: Params$Resource$Studies$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Wait, + params: Params$Resource$Studies$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -124595,7 +161574,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Operations$Wait + | Params$Resource$Studies$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -124611,13 +161590,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Operations$Wait; + {}) as Params$Resource$Studies$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Operations$Wait; + params = {} as Params$Resource$Studies$Operations$Wait; options = {}; } @@ -124652,28 +161630,28 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel + export interface Params$Resource$Studies$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$Operations$Delete + export interface Params$Resource$Studies$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$Operations$Get + export interface Params$Resource$Studies$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$Operations$List + export interface Params$Resource$Studies$Operations$List extends StandardParameters { /** * The standard list filter. @@ -124696,7 +161674,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Tensorboards$Operations$Wait + export interface Params$Resource$Studies$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -124708,19 +161686,23 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Trainingpipelines { + export class Resource$Studies$Trials { + context: APIRequestContext; + operations: Resource$Studies$Trials$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Studies$Trials$Operations(this.context); + } + } + + export class Resource$Studies$Trials$Operations { context: APIRequestContext; - operations: Resource$Projects$Locations$Trainingpipelines$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = - new Resource$Projects$Locations$Trainingpipelines$Operations( - this.context - ); } /** - * Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetTrainingPipeline or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead it becomes a pipeline with a TrainingPipeline.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TrainingPipeline.state is set to `CANCELLED`. + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -124749,15 +161731,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.trainingPipelines.cancel({ - * // Required. The name of the TrainingPipeline to cancel. Format: `projects/{project\}/locations/{location\}/trainingPipelines/{training_pipeline\}` - * name: 'projects/my-project/locations/my-location/trainingPipelines/my-trainingPipeline', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, + * const res = await aiplatform.studies.trials.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'studies/my-studie/trials/my-trial/operations/my-operation', * }); * console.log(res.data); * @@ -124778,31 +161754,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Trainingpipelines$Cancel, + params: Params$Resource$Studies$Trials$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Trainingpipelines$Cancel, + params?: Params$Resource$Studies$Trials$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Trainingpipelines$Cancel, + params: Params$Resource$Studies$Trials$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Trainingpipelines$Cancel, + params: Params$Resource$Studies$Trials$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Trainingpipelines$Cancel, + params: Params$Resource$Studies$Trials$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Trainingpipelines$Cancel + | Params$Resource$Studies$Trials$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -124818,13 +161794,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Trainingpipelines$Cancel; + {}) as Params$Resource$Studies$Trials$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Trainingpipelines$Cancel; + params = {} as Params$Resource$Studies$Trials$Operations$Cancel; options = {}; } @@ -124859,7 +161834,7 @@ export namespace aiplatform_v1 { } /** - * Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -124888,56 +161863,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.trainingPipelines.create({ - * // Required. The resource name of the Location to create the TrainingPipeline in. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", - * // "error": {}, - * // "inputDataConfig": {}, - * // "labels": {}, - * // "modelId": "my_modelId", - * // "modelToUpload": {}, - * // "name": "my_name", - * // "parentModel": "my_parentModel", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "trainingTaskDefinition": "my_trainingTaskDefinition", - * // "trainingTaskInputs": {}, - * // "trainingTaskMetadata": {}, - * // "updateTime": "my_updateTime" - * // } - * }, + * const res = await aiplatform.studies.trials.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'studies/my-studie/trials/my-trial/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", - * // "error": {}, - * // "inputDataConfig": {}, - * // "labels": {}, - * // "modelId": "my_modelId", - * // "modelToUpload": {}, - * // "name": "my_name", - * // "parentModel": "my_parentModel", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "trainingTaskDefinition": "my_trainingTaskDefinition", - * // "trainingTaskInputs": {}, - * // "trainingTaskMetadata": {}, - * // "updateTime": "my_updateTime" - * // } + * // {} * } * * main().catch(e => { @@ -124952,62 +161885,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Trainingpipelines$Create, + delete( + params: Params$Resource$Studies$Trials$Operations$Delete, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Trainingpipelines$Create, + delete( + params?: Params$Resource$Studies$Trials$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - create( - params: Params$Resource$Projects$Locations$Trainingpipelines$Create, + ): Promise>; + delete( + params: Params$Resource$Studies$Trials$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Trainingpipelines$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Trainingpipelines$Create, - callback: BodyResponseCallback + delete( + params: Params$Resource$Studies$Trials$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + delete( + params: Params$Resource$Studies$Trials$Operations$Delete, + callback: BodyResponseCallback ): void; - create( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Trainingpipelines$Create - | BodyResponseCallback + | Params$Resource$Studies$Trials$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Trainingpipelines$Create; + {}) as Params$Resource$Studies$Trials$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Trainingpipelines$Create; + params = {} as Params$Resource$Studies$Trials$Operations$Delete; options = {}; } @@ -125020,34 +161944,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/trainingPipelines').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes a TrainingPipeline. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -125076,9 +161995,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.trainingPipelines.delete({ - * // Required. The name of the TrainingPipeline resource to be deleted. Format: `projects/{project\}/locations/{location\}/trainingPipelines/{training_pipeline\}` - * name: 'projects/my-project/locations/my-location/trainingPipelines/my-trainingPipeline', + * const res = await aiplatform.studies.trials.operations.get({ + * // The name of the operation resource. + * name: 'studies/my-studie/trials/my-trial/operations/my-operation', * }); * console.log(res.data); * @@ -125104,36 +162023,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Trainingpipelines$Delete, + get( + params: Params$Resource$Studies$Trials$Operations$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Trainingpipelines$Delete, + get( + params?: Params$Resource$Studies$Trials$Operations$Get, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Trainingpipelines$Delete, + get( + params: Params$Resource$Studies$Trials$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Trainingpipelines$Delete, + get( + params: Params$Resource$Studies$Trials$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Trainingpipelines$Delete, + get( + params: Params$Resource$Studies$Trials$Operations$Get, callback: BodyResponseCallback ): void; - delete( + get( callback: BodyResponseCallback ): void; - delete( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Trainingpipelines$Delete + | Params$Resource$Studies$Trials$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -125149,13 +162068,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Trainingpipelines$Delete; + {}) as Params$Resource$Studies$Trials$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Trainingpipelines$Delete; + params = {} as Params$Resource$Studies$Trials$Operations$Get; options = {}; } @@ -125169,7 +162087,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -125190,7 +162108,7 @@ export namespace aiplatform_v1 { } /** - * Gets a TrainingPipeline. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -125219,31 +162137,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.trainingPipelines.get({ - * // Required. The name of the TrainingPipeline resource. Format: `projects/{project\}/locations/{location\}/trainingPipelines/{training_pipeline\}` - * name: 'projects/my-project/locations/my-location/trainingPipelines/my-trainingPipeline', + * const res = await aiplatform.studies.trials.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'studies/my-studie/trials/my-trial', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", - * // "error": {}, - * // "inputDataConfig": {}, - * // "labels": {}, - * // "modelId": "my_modelId", - * // "modelToUpload": {}, - * // "name": "my_name", - * // "parentModel": "my_parentModel", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "trainingTaskDefinition": "my_trainingTaskDefinition", - * // "trainingTaskInputs": {}, - * // "trainingTaskMetadata": {}, - * // "updateTime": "my_updateTime" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -125259,61 +162171,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Trainingpipelines$Get, + list( + params: Params$Resource$Studies$Trials$Operations$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Trainingpipelines$Get, + list( + params?: Params$Resource$Studies$Trials$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Trainingpipelines$Get, + list( + params: Params$Resource$Studies$Trials$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Trainingpipelines$Get, + list( + params: Params$Resource$Studies$Trials$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Trainingpipelines$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Studies$Trials$Operations$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Trainingpipelines$Get - | BodyResponseCallback + | Params$Resource$Studies$Trials$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Trainingpipelines$Get; + {}) as Params$Resource$Studies$Trials$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Trainingpipelines$Get; + params = {} as Params$Resource$Studies$Trials$Operations$List; options = {}; } @@ -125326,7 +162238,10 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -125338,19 +162253,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists TrainingPipelines in a Location. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -125379,24 +162294,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.trainingPipelines.list({ - * // The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `training_task_definition` `=`, `!=` comparisons, and `:` wildcard. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="PIPELINE_STATE_SUCCEEDED" AND display_name:"my_pipeline_*"` * `state!="PIPELINE_STATE_FAILED" OR display_name="my_pipeline"` * `NOT display_name="my_pipeline"` * `create_time\>"2021-05-18T00:00:00Z"` * `training_task_definition:"*automl_text_classification*"` - * filter: 'placeholder-value', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. Typically obtained via ListTrainingPipelinesResponse.next_page_token of the previous PipelineService.ListTrainingPipelines call. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list the TrainingPipelines from. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', + * const res = await aiplatform.studies.trials.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'studies/my-studie/trials/my-trial/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "trainingPipelines": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -125412,62 +162324,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Trainingpipelines$List, + wait( + params: Params$Resource$Studies$Trials$Operations$Wait, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Trainingpipelines$List, + wait( + params?: Params$Resource$Studies$Trials$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Trainingpipelines$List, + ): Promise>; + wait( + params: Params$Resource$Studies$Trials$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Trainingpipelines$List, + wait( + params: Params$Resource$Studies$Trials$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Trainingpipelines$List, - callback: BodyResponseCallback + wait( + params: Params$Resource$Studies$Trials$Operations$Wait, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - list( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Trainingpipelines$List - | BodyResponseCallback + | Params$Resource$Studies$Trials$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Trainingpipelines$List; + {}) as Params$Resource$Studies$Trials$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Trainingpipelines$List; + params = {} as Params$Resource$Studies$Trials$Operations$Wait; options = {}; } @@ -125480,96 +162387,109 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/trainingPipelines').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Trainingpipelines$Cancel + export interface Params$Resource$Studies$Trials$Operations$Cancel extends StandardParameters { /** - * Required. The name of the TrainingPipeline to cancel. Format: `projects/{project\}/locations/{location\}/trainingPipelines/{training_pipeline\}` + * The name of the operation resource to be cancelled. */ name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1CancelTrainingPipelineRequest; } - export interface Params$Resource$Projects$Locations$Trainingpipelines$Create + export interface Params$Resource$Studies$Trials$Operations$Delete extends StandardParameters { /** - * Required. The resource name of the Location to create the TrainingPipeline in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1TrainingPipeline; - } - export interface Params$Resource$Projects$Locations$Trainingpipelines$Delete - extends StandardParameters { - /** - * Required. The name of the TrainingPipeline resource to be deleted. Format: `projects/{project\}/locations/{location\}/trainingPipelines/{training_pipeline\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Trainingpipelines$Get + export interface Params$Resource$Studies$Trials$Operations$Get extends StandardParameters { /** - * Required. The name of the TrainingPipeline resource. Format: `projects/{project\}/locations/{location\}/trainingPipelines/{training_pipeline\}` + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Trainingpipelines$List + export interface Params$Resource$Studies$Trials$Operations$List extends StandardParameters { /** - * The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `training_task_definition` `=`, `!=` comparisons, and `:` wildcard. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="PIPELINE_STATE_SUCCEEDED" AND display_name:"my_pipeline_*"` * `state!="PIPELINE_STATE_FAILED" OR display_name="my_pipeline"` * `NOT display_name="my_pipeline"` * `create_time\>"2021-05-18T00:00:00Z"` * `training_task_definition:"*automl_text_classification*"` + * The standard list filter. */ filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; /** * The standard list page size. */ pageSize?: number; /** - * The standard list page token. Typically obtained via ListTrainingPipelinesResponse.next_page_token of the previous PipelineService.ListTrainingPipelines call. + * The standard list page token. */ pageToken?: string; /** - * Required. The resource name of the Location to list the TrainingPipelines from. Format: `projects/{project\}/locations/{location\}` + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - parent?: string; + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Studies$Trials$Operations$Wait + extends StandardParameters { /** - * Mask specifying which fields to read. + * The name of the operation resource to wait on. */ - readMask?: string; + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; } - export class Resource$Projects$Locations$Trainingpipelines$Operations { + export class Resource$Tensorboards { + context: APIRequestContext; + experiments: Resource$Tensorboards$Experiments; + operations: Resource$Tensorboards$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.experiments = new Resource$Tensorboards$Experiments(this.context); + this.operations = new Resource$Tensorboards$Operations(this.context); + } + } + + export class Resource$Tensorboards$Experiments { + context: APIRequestContext; + operations: Resource$Tensorboards$Experiments$Operations; + runs: Resource$Tensorboards$Experiments$Runs; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Tensorboards$Experiments$Operations( + this.context + ); + this.runs = new Resource$Tensorboards$Experiments$Runs(this.context); + } + } + + export class Resource$Tensorboards$Experiments$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -125605,11 +162525,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.trainingPipelines.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/trainingPipelines/my-trainingPipeline/operations/my-operation', - * }); + * const res = await aiplatform.tensorboards.experiments.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'tensorboards/my-tensorboard/experiments/my-experiment/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -125629,31 +162548,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel, + params: Params$Resource$Tensorboards$Experiments$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel, + params?: Params$Resource$Tensorboards$Experiments$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel, + params: Params$Resource$Tensorboards$Experiments$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel, + params: Params$Resource$Tensorboards$Experiments$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel, + params: Params$Resource$Tensorboards$Experiments$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel + | Params$Resource$Tensorboards$Experiments$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -125669,13 +162588,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel; + {}) as Params$Resource$Tensorboards$Experiments$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel; + {} as Params$Resource$Tensorboards$Experiments$Operations$Cancel; options = {}; } @@ -125739,145 +162658,143 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.trainingPipelines.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/trainingPipelines/my-trainingPipeline/operations/my-operation', - * }); - * console.log(res.data); - * - * // Example response - * // {} - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - delete( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Delete, - options: StreamMethodOptions - ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Delete, - options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Trainingpipelines$Operations$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Trainingpipelines$Operations$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Trainingpipelines$Operations$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const aiplatform = google.aiplatform('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * const res = await aiplatform.tensorboards.experiments.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'tensorboards/my-tensorboard/experiments/my-experiment/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Tensorboards$Experiments$Operations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Tensorboards$Experiments$Operations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Tensorboards$Experiments$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Tensorboards$Experiments$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Tensorboards$Experiments$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Tensorboards$Experiments$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Tensorboards$Experiments$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Tensorboards$Experiments$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await aiplatform.tensorboards.experiments.operations.get({ + * // The name of the operation resource. + * name: 'tensorboards/my-tensorboard/experiments/my-experiment/operations/my-operation', * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await aiplatform.projects.locations.trainingPipelines.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/trainingPipelines/my-trainingPipeline/operations/my-operation', - * }); * console.log(res.data); * * // Example response @@ -125903,27 +162820,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Get, + params: Params$Resource$Tensorboards$Experiments$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Get, + params?: Params$Resource$Tensorboards$Experiments$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Get, + params: Params$Resource$Tensorboards$Experiments$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Get, + params: Params$Resource$Tensorboards$Experiments$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Get, + params: Params$Resource$Tensorboards$Experiments$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -125931,7 +162848,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Trainingpipelines$Operations$Get + | Params$Resource$Tensorboards$Experiments$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -125947,13 +162864,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Trainingpipelines$Operations$Get; + {}) as Params$Resource$Tensorboards$Experiments$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Trainingpipelines$Operations$Get; + params = {} as Params$Resource$Tensorboards$Experiments$Operations$Get; options = {}; } @@ -126017,19 +162933,18 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.trainingPipelines.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/trainingPipelines/my-trainingPipeline', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * const res = await aiplatform.tensorboards.experiments.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'tensorboards/my-tensorboard/experiments/my-experiment', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -126053,29 +162968,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$List, + params: Params$Resource$Tensorboards$Experiments$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Trainingpipelines$Operations$List, + params?: Params$Resource$Tensorboards$Experiments$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$List, + params: Params$Resource$Tensorboards$Experiments$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$List, + params: Params$Resource$Tensorboards$Experiments$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$List, + params: Params$Resource$Tensorboards$Experiments$Operations$List, callback: BodyResponseCallback ): void; list( @@ -126083,7 +162998,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Trainingpipelines$Operations$List + | Params$Resource$Tensorboards$Experiments$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -126101,13 +163016,12 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Trainingpipelines$Operations$List; + {}) as Params$Resource$Tensorboards$Experiments$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Trainingpipelines$Operations$List; + params = {} as Params$Resource$Tensorboards$Experiments$Operations$List; options = {}; } @@ -126176,13 +163090,12 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.trainingPipelines.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/trainingPipelines/my-trainingPipeline/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); + * const res = await aiplatform.tensorboards.experiments.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'tensorboards/my-tensorboard/experiments/my-experiment/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -126208,27 +163121,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Wait, + params: Params$Resource$Tensorboards$Experiments$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Wait, + params?: Params$Resource$Tensorboards$Experiments$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Wait, + params: Params$Resource$Tensorboards$Experiments$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Wait, + params: Params$Resource$Tensorboards$Experiments$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Wait, + params: Params$Resource$Tensorboards$Experiments$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -126236,7 +163149,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Trainingpipelines$Operations$Wait + | Params$Resource$Tensorboards$Experiments$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -126252,13 +163165,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Trainingpipelines$Operations$Wait; + {}) as Params$Resource$Tensorboards$Experiments$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Trainingpipelines$Operations$Wait; + params = {} as Params$Resource$Tensorboards$Experiments$Operations$Wait; options = {}; } @@ -126293,28 +163205,28 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel + export interface Params$Resource$Tensorboards$Experiments$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Trainingpipelines$Operations$Delete + export interface Params$Resource$Tensorboards$Experiments$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Trainingpipelines$Operations$Get + export interface Params$Resource$Tensorboards$Experiments$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Trainingpipelines$Operations$List + export interface Params$Resource$Tensorboards$Experiments$Operations$List extends StandardParameters { /** * The standard list filter. @@ -126337,7 +163249,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Trainingpipelines$Operations$Wait + export interface Params$Resource$Tensorboards$Experiments$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. @@ -126349,18 +163261,29 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Tuningjobs { + export class Resource$Tensorboards$Experiments$Runs { context: APIRequestContext; - operations: Resource$Projects$Locations$Tuningjobs$Operations; + operations: Resource$Tensorboards$Experiments$Runs$Operations; + timeSeries: Resource$Tensorboards$Experiments$Runs$Timeseries; constructor(context: APIRequestContext) { this.context = context; - this.operations = new Resource$Projects$Locations$Tuningjobs$Operations( + this.operations = new Resource$Tensorboards$Experiments$Runs$Operations( + this.context + ); + this.timeSeries = new Resource$Tensorboards$Experiments$Runs$Timeseries( this.context ); } + } + + export class Resource$Tensorboards$Experiments$Runs$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Cancels a TuningJob. Starts asynchronous cancellation on the TuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use GenAiTuningService.GetTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the TuningJob is not deleted; instead it becomes a job with a TuningJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TuningJob.state is set to `CANCELLED`. + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -126389,15 +163312,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tuningJobs.cancel({ - * // Required. The name of the TuningJob to cancel. Format: `projects/{project\}/locations/{location\}/tuningJobs/{tuning_job\}` - * name: 'projects/my-project/locations/my-location/tuningJobs/my-tuningJob', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, + * const res = await aiplatform.tensorboards.experiments.runs.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/operations/my-operation', * }); * console.log(res.data); * @@ -126418,31 +163335,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Tuningjobs$Cancel, + params: Params$Resource$Tensorboards$Experiments$Runs$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Tuningjobs$Cancel, + params?: Params$Resource$Tensorboards$Experiments$Runs$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Tuningjobs$Cancel, + params: Params$Resource$Tensorboards$Experiments$Runs$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Tuningjobs$Cancel, + params: Params$Resource$Tensorboards$Experiments$Runs$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Tuningjobs$Cancel, + params: Params$Resource$Tensorboards$Experiments$Runs$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tuningjobs$Cancel + | Params$Resource$Tensorboards$Experiments$Runs$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -126458,12 +163375,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tuningjobs$Cancel; + {}) as Params$Resource$Tensorboards$Experiments$Runs$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Tuningjobs$Cancel; + params = + {} as Params$Resource$Tensorboards$Experiments$Runs$Operations$Cancel; options = {}; } @@ -126498,7 +163416,7 @@ export namespace aiplatform_v1 { } /** - * Creates a TuningJob. A created TuningJob right away will be attempted to be run. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -126527,58 +163445,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tuningJobs.create({ - * // Required. The resource name of the Location to create the TuningJob in. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "baseModel": "my_baseModel", - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", - * // "error": {}, - * // "experiment": "my_experiment", - * // "labels": {}, - * // "name": "my_name", - * // "preTunedModel": {}, - * // "serviceAccount": "my_serviceAccount", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "supervisedTuningSpec": {}, - * // "tunedModel": {}, - * // "tunedModelDisplayName": "my_tunedModelDisplayName", - * // "tuningDataStats": {}, - * // "updateTime": "my_updateTime" - * // } - * }, + * const res = await aiplatform.tensorboards.experiments.runs.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "baseModel": "my_baseModel", - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", - * // "error": {}, - * // "experiment": "my_experiment", - * // "labels": {}, - * // "name": "my_name", - * // "preTunedModel": {}, - * // "serviceAccount": "my_serviceAccount", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "supervisedTuningSpec": {}, - * // "tunedModel": {}, - * // "tunedModelDisplayName": "my_tunedModelDisplayName", - * // "tuningDataStats": {}, - * // "updateTime": "my_updateTime" - * // } + * // {} * } * * main().catch(e => { @@ -126593,61 +163467,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Tuningjobs$Create, + delete( + params: Params$Resource$Tensorboards$Experiments$Runs$Operations$Delete, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Tuningjobs$Create, + delete( + params?: Params$Resource$Tensorboards$Experiments$Runs$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - create( - params: Params$Resource$Projects$Locations$Tuningjobs$Create, + ): Promise>; + delete( + params: Params$Resource$Tensorboards$Experiments$Runs$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Tuningjobs$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Tuningjobs$Create, - callback: BodyResponseCallback + delete( + params: Params$Resource$Tensorboards$Experiments$Runs$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + delete( + params: Params$Resource$Tensorboards$Experiments$Runs$Operations$Delete, + callback: BodyResponseCallback ): void; - create( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tuningjobs$Create - | BodyResponseCallback + | Params$Resource$Tensorboards$Experiments$Runs$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tuningjobs$Create; + {}) as Params$Resource$Tensorboards$Experiments$Runs$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Tuningjobs$Create; + params = + {} as Params$Resource$Tensorboards$Experiments$Runs$Operations$Delete; options = {}; } @@ -126660,34 +163527,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/tuningJobs').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets a TuningJob. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -126716,32 +163578,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tuningJobs.get({ - * // Required. The name of the TuningJob resource. Format: `projects/{project\}/locations/{location\}/tuningJobs/{tuning_job\}` - * name: 'projects/my-project/locations/my-location/tuningJobs/my-tuningJob', + * const res = await aiplatform.tensorboards.experiments.runs.operations.get({ + * // The name of the operation resource. + * name: 'tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/operations/my-operation', * }); * console.log(res.data); * * // Example response * // { - * // "baseModel": "my_baseModel", - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", + * // "done": false, * // "error": {}, - * // "experiment": "my_experiment", - * // "labels": {}, + * // "metadata": {}, * // "name": "my_name", - * // "preTunedModel": {}, - * // "serviceAccount": "my_serviceAccount", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "supervisedTuningSpec": {}, - * // "tunedModel": {}, - * // "tunedModelDisplayName": "my_tunedModelDisplayName", - * // "tuningDataStats": {}, - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -126758,60 +163607,57 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Tuningjobs$Get, + params: Params$Resource$Tensorboards$Experiments$Runs$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Tuningjobs$Get, + params?: Params$Resource$Tensorboards$Experiments$Runs$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; + ): Promise>; get( - params: Params$Resource$Projects$Locations$Tuningjobs$Get, + params: Params$Resource$Tensorboards$Experiments$Runs$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Tuningjobs$Get, + params: Params$Resource$Tensorboards$Experiments$Runs$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Tuningjobs$Get, - callback: BodyResponseCallback + params: Params$Resource$Tensorboards$Experiments$Runs$Operations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tuningjobs$Get - | BodyResponseCallback + | Params$Resource$Tensorboards$Experiments$Runs$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tuningjobs$Get; + {}) as Params$Resource$Tensorboards$Experiments$Runs$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Tuningjobs$Get; + params = + {} as Params$Resource$Tensorboards$Experiments$Runs$Operations$Get; options = {}; } @@ -126836,19 +163682,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists TuningJobs in a Location. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -126877,22 +163721,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tuningJobs.list({ - * // Optional. The standard list filter. + * const res = await aiplatform.tensorboards.experiments.runs.operations.list({ + * // The standard list filter. * filter: 'placeholder-value', - * // Optional. The standard list page size. + * // The name of the operation's parent resource. + * name: 'tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', + * // The standard list page size. * pageSize: 'placeholder-value', - * // Optional. The standard list page token. Typically obtained via ListTuningJobsResponse.next_page_token of the previous GenAiTuningService.ListTuningJob][] call. + * // The standard list page token. * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list the TuningJobs from. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "tuningJobs": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -126909,60 +163756,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Tuningjobs$List, + params: Params$Resource$Tensorboards$Experiments$Runs$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Tuningjobs$List, + params?: Params$Resource$Tensorboards$Experiments$Runs$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Tuningjobs$List, + params: Params$Resource$Tensorboards$Experiments$Runs$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Tuningjobs$List, + params: Params$Resource$Tensorboards$Experiments$Runs$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Tuningjobs$List, - callback: BodyResponseCallback + params: Params$Resource$Tensorboards$Experiments$Runs$Operations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tuningjobs$List - | BodyResponseCallback + | Params$Resource$Tensorboards$Experiments$Runs$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tuningjobs$List; + {}) as Params$Resource$Tensorboards$Experiments$Runs$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Tuningjobs$List; + params = + {} as Params$Resource$Tensorboards$Experiments$Runs$Operations$List; options = {}; } @@ -126975,7 +163823,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/tuningJobs').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -126985,24 +163833,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Rebase a TunedModel. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -127031,20 +163879,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tuningJobs.rebaseTunedModel({ - * // Required. The resource name of the Location into which to rebase the Model. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "artifactDestination": {}, - * // "deployToSameEndpoint": false, - * // "tunedModelRef": {}, - * // "tuningJob": {} - * // } - * }, + * const res = await aiplatform.tensorboards.experiments.runs.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * @@ -127070,36 +163909,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - rebaseTunedModel( - params: Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel, + wait( + params: Params$Resource$Tensorboards$Experiments$Runs$Operations$Wait, options: StreamMethodOptions ): Promise>; - rebaseTunedModel( - params?: Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel, + wait( + params?: Params$Resource$Tensorboards$Experiments$Runs$Operations$Wait, options?: MethodOptions ): Promise>; - rebaseTunedModel( - params: Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel, + wait( + params: Params$Resource$Tensorboards$Experiments$Runs$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - rebaseTunedModel( - params: Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel, + wait( + params: Params$Resource$Tensorboards$Experiments$Runs$Operations$Wait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - rebaseTunedModel( - params: Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel, + wait( + params: Params$Resource$Tensorboards$Experiments$Runs$Operations$Wait, callback: BodyResponseCallback ): void; - rebaseTunedModel( + wait( callback: BodyResponseCallback ): void; - rebaseTunedModel( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel + | Params$Resource$Tensorboards$Experiments$Runs$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -127115,13 +163954,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel; + {}) as Params$Resource$Tensorboards$Experiments$Runs$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel; + {} as Params$Resource$Tensorboards$Experiments$Runs$Operations$Wait; options = {}; } @@ -127134,17 +163973,15 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+parent}/tuningJobs:rebaseTunedModel' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -127158,70 +163995,75 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Tuningjobs$Cancel + export interface Params$Resource$Tensorboards$Experiments$Runs$Operations$Cancel extends StandardParameters { /** - * Required. The name of the TuningJob to cancel. Format: `projects/{project\}/locations/{location\}/tuningJobs/{tuning_job\}` + * The name of the operation resource to be cancelled. */ name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1CancelTuningJobRequest; } - export interface Params$Resource$Projects$Locations$Tuningjobs$Create + export interface Params$Resource$Tensorboards$Experiments$Runs$Operations$Delete extends StandardParameters { /** - * Required. The resource name of the Location to create the TuningJob in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata + * The name of the operation resource to be deleted. */ - requestBody?: Schema$GoogleCloudAiplatformV1TuningJob; + name?: string; } - export interface Params$Resource$Projects$Locations$Tuningjobs$Get + export interface Params$Resource$Tensorboards$Experiments$Runs$Operations$Get extends StandardParameters { /** - * Required. The name of the TuningJob resource. Format: `projects/{project\}/locations/{location\}/tuningJobs/{tuning_job\}` + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Tuningjobs$List + export interface Params$Resource$Tensorboards$Experiments$Runs$Operations$List extends StandardParameters { /** - * Optional. The standard list filter. + * The standard list filter. */ filter?: string; /** - * Optional. The standard list page size. + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. */ pageSize?: number; /** - * Optional. The standard list page token. Typically obtained via ListTuningJobsResponse.next_page_token of the previous GenAiTuningService.ListTuningJob][] call. + * The standard list page token. */ pageToken?: string; /** - * Required. The resource name of the Location to list the TuningJobs from. Format: `projects/{project\}/locations/{location\}` + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - parent?: string; + returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel + export interface Params$Resource$Tensorboards$Experiments$Runs$Operations$Wait extends StandardParameters { /** - * Required. The resource name of the Location into which to rebase the Model. Format: `projects/{project\}/locations/{location\}` + * The name of the operation resource to wait on. */ - parent?: string; - + name?: string; /** - * Request body metadata + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - requestBody?: Schema$GoogleCloudAiplatformV1RebaseTunedModelRequest; + timeout?: string; } - export class Resource$Projects$Locations$Tuningjobs$Operations { + export class Resource$Tensorboards$Experiments$Runs$Timeseries { + context: APIRequestContext; + operations: Resource$Tensorboards$Experiments$Runs$Timeseries$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Tensorboards$Experiments$Runs$Timeseries$Operations( + this.context + ); + } + } + + export class Resource$Tensorboards$Experiments$Runs$Timeseries$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -127257,10 +164099,13 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tuningJobs.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/tuningJobs/my-tuningJob/operations/my-operation', - * }); + * const res = + * await aiplatform.tensorboards.experiments.runs.timeSeries.operations.cancel( + * { + * // The name of the operation resource to be cancelled. + * name: 'tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response @@ -127280,31 +164125,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel, + params: Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel, + params?: Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel, + params: Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel, + params: Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel, + params: Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel + | Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -127320,13 +164165,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel; + {}) as Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel; + {} as Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel; options = {}; } @@ -127390,10 +164235,13 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tuningJobs.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/tuningJobs/my-tuningJob/operations/my-operation', - * }); + * const res = + * await aiplatform.tensorboards.experiments.runs.timeSeries.operations.delete( + * { + * // The name of the operation resource to be deleted. + * name: 'tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response @@ -127413,31 +164261,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete, + params: Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete, + params?: Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete, + params: Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete, + params: Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete, + params: Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete + | Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -127453,13 +164301,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete; + {}) as Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete; + {} as Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete; options = {}; } @@ -127523,10 +164371,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tuningJobs.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/tuningJobs/my-tuningJob/operations/my-operation', - * }); + * const res = + * await aiplatform.tensorboards.experiments.runs.timeSeries.operations.get({ + * // The name of the operation resource. + * name: 'tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -127552,27 +164401,27 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Get, + params: Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Tuningjobs$Operations$Get, + params?: Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Get, + params: Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Get, + params: Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Get, + params: Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -127580,7 +164429,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tuningjobs$Operations$Get + | Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -127596,13 +164445,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tuningjobs$Operations$Get; + {}) as Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tuningjobs$Operations$Get; + {} as Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$Get; options = {}; } @@ -127666,18 +164515,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tuningJobs.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/tuningJobs/my-tuningJob', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * const res = + * await aiplatform.tensorboards.experiments.runs.timeSeries.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -127701,29 +164551,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Tuningjobs$Operations$List, + params: Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Tuningjobs$Operations$List, + params?: Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Tuningjobs$Operations$List, + params: Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Tuningjobs$Operations$List, + params: Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Tuningjobs$Operations$List, + params: Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$List, callback: BodyResponseCallback ): void; list( @@ -127731,7 +164581,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tuningjobs$Operations$List + | Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -127749,13 +164599,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tuningjobs$Operations$List; + {}) as Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tuningjobs$Operations$List; + {} as Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$List; options = {}; } @@ -127793,70 +164643,9 @@ export namespace aiplatform_v1 { ); } } - } - - export interface Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel - extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete - extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Tuningjobs$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Tuningjobs$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - - export class Resource$Publishers { - context: APIRequestContext; - models: Resource$Publishers$Models; - constructor(context: APIRequestContext) { - this.context = context; - this.models = new Resource$Publishers$Models(this.context); - } - } - - export class Resource$Publishers$Models { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Return a list of tokens based on the input text. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -127885,25 +164674,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.publishers.models.computeTokens({ - * // Required. The name of the Endpoint requested to get lists of tokens and token ids. - * endpoint: 'publishers/my-publisher/models/my-model', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "contents": [], - * // "instances": [], - * // "model": "my_model" - * // } - * }, - * }); + * const res = + * await aiplatform.tensorboards.experiments.runs.timeSeries.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "tokensInfo": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -127919,61 +164705,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - computeTokens( - params: Params$Resource$Publishers$Models$Computetokens, + wait( + params: Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait, options: StreamMethodOptions ): Promise>; - computeTokens( - params?: Params$Resource$Publishers$Models$Computetokens, + wait( + params?: Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - computeTokens( - params: Params$Resource$Publishers$Models$Computetokens, + ): Promise>; + wait( + params: Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - computeTokens( - params: Params$Resource$Publishers$Models$Computetokens, + wait( + params: Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - computeTokens( - params: Params$Resource$Publishers$Models$Computetokens, - callback: BodyResponseCallback + wait( + params: Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait, + callback: BodyResponseCallback ): void; - computeTokens( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - computeTokens( + wait( paramsOrCallback?: - | Params$Resource$Publishers$Models$Computetokens - | BodyResponseCallback + | Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Publishers$Models$Computetokens; + {}) as Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Publishers$Models$Computetokens; + params = + {} as Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait; options = {}; } @@ -127986,34 +164769,92 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:computeTokens').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel + extends StandardParameters { /** - * Perform a token counting. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Tensorboards$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -128042,31 +164883,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.publishers.models.countTokens({ - * // Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: 'publishers/my-publisher/models/my-model', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "contents": [], - * // "generationConfig": {}, - * // "instances": [], - * // "model": "my_model", - * // "systemInstruction": {}, - * // "tools": [] - * // } - * }, + * const res = await aiplatform.tensorboards.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'tensorboards/my-tensorboard/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "promptTokensDetails": [], - * // "totalBillableCharacters": 0, - * // "totalTokens": 0 - * // } + * // {} * } * * main().catch(e => { @@ -128081,61 +164905,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - countTokens( - params: Params$Resource$Publishers$Models$Counttokens, + cancel( + params: Params$Resource$Tensorboards$Operations$Cancel, options: StreamMethodOptions ): Promise>; - countTokens( - params?: Params$Resource$Publishers$Models$Counttokens, + cancel( + params?: Params$Resource$Tensorboards$Operations$Cancel, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - countTokens( - params: Params$Resource$Publishers$Models$Counttokens, + ): Promise>; + cancel( + params: Params$Resource$Tensorboards$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - countTokens( - params: Params$Resource$Publishers$Models$Counttokens, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - countTokens( - params: Params$Resource$Publishers$Models$Counttokens, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Tensorboards$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - countTokens( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Tensorboards$Operations$Cancel, + callback: BodyResponseCallback ): void; - countTokens( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Publishers$Models$Counttokens - | BodyResponseCallback + | Params$Resource$Tensorboards$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Publishers$Models$Counttokens; + {}) as Params$Resource$Tensorboards$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Publishers$Models$Counttokens; + params = {} as Params$Resource$Tensorboards$Operations$Cancel; options = {}; } @@ -128148,34 +164964,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:countTokens').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Fetch an asynchronous online prediction operation. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -128196,10 +165007,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -128207,28 +165015,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.publishers.models.fetchPredictOperation({ - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` - * endpoint: 'publishers/my-publisher/models/my-model', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "operationName": "my_operationName" - * // } - * }, + * const res = await aiplatform.tensorboards.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'tensorboards/my-tensorboard/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -128243,57 +165037,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - fetchPredictOperation( - params: Params$Resource$Publishers$Models$Fetchpredictoperation, + delete( + params: Params$Resource$Tensorboards$Operations$Delete, options: StreamMethodOptions ): Promise>; - fetchPredictOperation( - params?: Params$Resource$Publishers$Models$Fetchpredictoperation, + delete( + params?: Params$Resource$Tensorboards$Operations$Delete, options?: MethodOptions - ): Promise>; - fetchPredictOperation( - params: Params$Resource$Publishers$Models$Fetchpredictoperation, + ): Promise>; + delete( + params: Params$Resource$Tensorboards$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - fetchPredictOperation( - params: Params$Resource$Publishers$Models$Fetchpredictoperation, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - fetchPredictOperation( - params: Params$Resource$Publishers$Models$Fetchpredictoperation, - callback: BodyResponseCallback + delete( + params: Params$Resource$Tensorboards$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - fetchPredictOperation( - callback: BodyResponseCallback + delete( + params: Params$Resource$Tensorboards$Operations$Delete, + callback: BodyResponseCallback ): void; - fetchPredictOperation( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Publishers$Models$Fetchpredictoperation - | BodyResponseCallback + | Params$Resource$Tensorboards$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Publishers$Models$Fetchpredictoperation; + {}) as Params$Resource$Tensorboards$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Publishers$Models$Fetchpredictoperation; + params = {} as Params$Resource$Tensorboards$Operations$Delete; options = {}; } @@ -128306,32 +165096,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:fetchPredictOperation').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Generate content with multimodal inputs. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -128352,10 +165139,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -128363,36 +165147,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.publishers.models.generateContent({ - * // Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * model: 'publishers/my-publisher/models/my-model', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "cachedContent": "my_cachedContent", - * // "contents": [], - * // "generationConfig": {}, - * // "labels": {}, - * // "modelArmorConfig": {}, - * // "safetySettings": [], - * // "systemInstruction": {}, - * // "toolConfig": {}, - * // "tools": [] - * // } - * }, + * const res = await aiplatform.tensorboards.operations.get({ + * // The name of the operation resource. + * name: 'tensorboards/my-tensorboard/operations/my-operation', * }); * console.log(res.data); * * // Example response * // { - * // "candidates": [], - * // "createTime": "my_createTime", - * // "modelVersion": "my_modelVersion", - * // "promptFeedback": {}, - * // "responseId": "my_responseId", - * // "usageMetadata": {} + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -128408,61 +165175,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - generateContent( - params: Params$Resource$Publishers$Models$Generatecontent, + get( + params: Params$Resource$Tensorboards$Operations$Get, options: StreamMethodOptions ): Promise>; - generateContent( - params?: Params$Resource$Publishers$Models$Generatecontent, + get( + params?: Params$Resource$Tensorboards$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - generateContent( - params: Params$Resource$Publishers$Models$Generatecontent, + ): Promise>; + get( + params: Params$Resource$Tensorboards$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - generateContent( - params: Params$Resource$Publishers$Models$Generatecontent, + get( + params: Params$Resource$Tensorboards$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - generateContent( - params: Params$Resource$Publishers$Models$Generatecontent, - callback: BodyResponseCallback + get( + params: Params$Resource$Tensorboards$Operations$Get, + callback: BodyResponseCallback ): void; - generateContent( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - generateContent( + get( paramsOrCallback?: - | Params$Resource$Publishers$Models$Generatecontent - | BodyResponseCallback + | Params$Resource$Tensorboards$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Publishers$Models$Generatecontent; + {}) as Params$Resource$Tensorboards$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Publishers$Models$Generatecontent; + params = {} as Params$Resource$Tensorboards$Operations$Get; options = {}; } @@ -128475,34 +165238,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+model}:generateContent').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['model'], - pathParams: ['model'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets a Model Garden publisher model. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -128531,31 +165289,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.publishers.models.get({ - * // Optional. Token used to access Hugging Face gated models. - * huggingFaceToken: 'placeholder-value', - * // Optional. Boolean indicates whether the requested model is a Hugging Face model. - * isHuggingFaceModel: 'placeholder-value', - * // Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in. - * languageCode: 'placeholder-value', - * // Required. The name of the PublisherModel resource. Format: `publishers/{publisher\}/models/{publisher_model\}` - * name: 'publishers/my-publisher/models/my-model', - * // Optional. PublisherModel view specifying which fields to read. - * view: 'placeholder-value', + * const res = await aiplatform.tensorboards.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'tensorboards/my-tensorboard', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "frameworks": [], - * // "launchStage": "my_launchStage", - * // "name": "my_name", - * // "openSourceCategory": "my_openSourceCategory", - * // "predictSchemata": {}, - * // "publisherModelTemplate": "my_publisherModelTemplate", - * // "supportedActions": {}, - * // "versionId": "my_versionId", - * // "versionState": "my_versionState" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -128571,61 +165323,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Publishers$Models$Get, + list( + params: Params$Resource$Tensorboards$Operations$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Publishers$Models$Get, + list( + params?: Params$Resource$Tensorboards$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Publishers$Models$Get, + list( + params: Params$Resource$Tensorboards$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Publishers$Models$Get, + list( + params: Params$Resource$Tensorboards$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Publishers$Models$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Tensorboards$Operations$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Publishers$Models$Get - | BodyResponseCallback + | Params$Resource$Tensorboards$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Publishers$Models$Get; + {}) as Params$Resource$Tensorboards$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Publishers$Models$Get; + params = {} as Params$Resource$Tensorboards$Operations$List; options = {}; } @@ -128638,7 +165390,10 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -128650,19 +165405,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Perform an online prediction. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -128683,10 +165438,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -128694,29 +165446,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.publishers.models.predict({ - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: 'publishers/my-publisher/models/my-model', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "instances": [], - * // "parameters": {} - * // } - * }, + * const res = await aiplatform.tensorboards.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'tensorboards/my-tensorboard/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "deployedModelId": "my_deployedModelId", + * // "done": false, + * // "error": {}, * // "metadata": {}, - * // "model": "my_model", - * // "modelDisplayName": "my_modelDisplayName", - * // "modelVersionId": "my_modelVersionId", - * // "predictions": [] + * // "name": "my_name", + * // "response": {} * // } * } * @@ -128732,100 +165476,164 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - predict( - params: Params$Resource$Publishers$Models$Predict, + wait( + params: Params$Resource$Tensorboards$Operations$Wait, options: StreamMethodOptions ): Promise>; - predict( - params?: Params$Resource$Publishers$Models$Predict, + wait( + params?: Params$Resource$Tensorboards$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - predict( - params: Params$Resource$Publishers$Models$Predict, + ): Promise>; + wait( + params: Params$Resource$Tensorboards$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - predict( - params: Params$Resource$Publishers$Models$Predict, + wait( + params: Params$Resource$Tensorboards$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - predict( - params: Params$Resource$Publishers$Models$Predict, - callback: BodyResponseCallback + wait( + params: Params$Resource$Tensorboards$Operations$Wait, + callback: BodyResponseCallback ): void; - predict( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - predict( + wait( paramsOrCallback?: - | Params$Resource$Publishers$Models$Predict - | BodyResponseCallback + | Params$Resource$Tensorboards$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Publishers$Models$Predict; + {}) as Params$Resource$Tensorboards$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Publishers$Models$Predict; + params = {} as Params$Resource$Tensorboards$Operations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; options = {}; } - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Tensorboards$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Tensorboards$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Tensorboards$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Tensorboards$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Tensorboards$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Trainingpipelines { + context: APIRequestContext; + operations: Resource$Trainingpipelines$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Trainingpipelines$Operations(this.context); + } + } - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+endpoint}:predict').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } + export class Resource$Trainingpipelines$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -128846,10 +165654,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -128857,29 +165662,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.publishers.models.predictLongRunning({ - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` - * endpoint: 'publishers/my-publisher/models/my-model', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "instances": [], - * // "parameters": {} - * // } - * }, + * const res = await aiplatform.trainingPipelines.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'trainingPipelines/my-trainingPipeline/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -128894,57 +165684,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - predictLongRunning( - params: Params$Resource$Publishers$Models$Predictlongrunning, + cancel( + params: Params$Resource$Trainingpipelines$Operations$Cancel, options: StreamMethodOptions ): Promise>; - predictLongRunning( - params?: Params$Resource$Publishers$Models$Predictlongrunning, + cancel( + params?: Params$Resource$Trainingpipelines$Operations$Cancel, options?: MethodOptions - ): Promise>; - predictLongRunning( - params: Params$Resource$Publishers$Models$Predictlongrunning, + ): Promise>; + cancel( + params: Params$Resource$Trainingpipelines$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - predictLongRunning( - params: Params$Resource$Publishers$Models$Predictlongrunning, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - predictLongRunning( - params: Params$Resource$Publishers$Models$Predictlongrunning, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Trainingpipelines$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - predictLongRunning( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Trainingpipelines$Operations$Cancel, + callback: BodyResponseCallback ): void; - predictLongRunning( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Publishers$Models$Predictlongrunning - | BodyResponseCallback + | Params$Resource$Trainingpipelines$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Publishers$Models$Predictlongrunning; + {}) as Params$Resource$Trainingpipelines$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Publishers$Models$Predictlongrunning; + params = {} as Params$Resource$Trainingpipelines$Operations$Cancel; options = {}; } @@ -128957,32 +165743,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:predictLongRunning').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Generate content with multimodal inputs with streaming support. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -129003,10 +165786,7 @@ export namespace aiplatform_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -129014,37 +165794,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.publishers.models.streamGenerateContent({ - * // Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * model: 'publishers/my-publisher/models/my-model', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "cachedContent": "my_cachedContent", - * // "contents": [], - * // "generationConfig": {}, - * // "labels": {}, - * // "modelArmorConfig": {}, - * // "safetySettings": [], - * // "systemInstruction": {}, - * // "toolConfig": {}, - * // "tools": [] - * // } - * }, + * const res = await aiplatform.trainingPipelines.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'trainingPipelines/my-trainingPipeline/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "candidates": [], - * // "createTime": "my_createTime", - * // "modelVersion": "my_modelVersion", - * // "promptFeedback": {}, - * // "responseId": "my_responseId", - * // "usageMetadata": {} - * // } + * // {} * } * * main().catch(e => { @@ -129059,61 +165816,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - streamGenerateContent( - params: Params$Resource$Publishers$Models$Streamgeneratecontent, + delete( + params: Params$Resource$Trainingpipelines$Operations$Delete, options: StreamMethodOptions ): Promise>; - streamGenerateContent( - params?: Params$Resource$Publishers$Models$Streamgeneratecontent, + delete( + params?: Params$Resource$Trainingpipelines$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - streamGenerateContent( - params: Params$Resource$Publishers$Models$Streamgeneratecontent, + ): Promise>; + delete( + params: Params$Resource$Trainingpipelines$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - streamGenerateContent( - params: Params$Resource$Publishers$Models$Streamgeneratecontent, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - streamGenerateContent( - params: Params$Resource$Publishers$Models$Streamgeneratecontent, - callback: BodyResponseCallback + delete( + params: Params$Resource$Trainingpipelines$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - streamGenerateContent( - callback: BodyResponseCallback + delete( + params: Params$Resource$Trainingpipelines$Operations$Delete, + callback: BodyResponseCallback ): void; - streamGenerateContent( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Publishers$Models$Streamgeneratecontent - | BodyResponseCallback + | Params$Resource$Trainingpipelines$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Publishers$Models$Streamgeneratecontent; + {}) as Params$Resource$Trainingpipelines$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Publishers$Models$Streamgeneratecontent; + params = {} as Params$Resource$Trainingpipelines$Operations$Delete; options = {}; } @@ -129126,149 +165875,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+model}:streamGenerateContent').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['model'], - pathParams: ['model'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Publishers$Models$Computetokens - extends StandardParameters { - /** - * Required. The name of the Endpoint requested to get lists of tokens and token ids. - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ComputeTokensRequest; - } - export interface Params$Resource$Publishers$Models$Counttokens - extends StandardParameters { - /** - * Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1CountTokensRequest; - } - export interface Params$Resource$Publishers$Models$Fetchpredictoperation - extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1FetchPredictOperationRequest; - } - export interface Params$Resource$Publishers$Models$Generatecontent - extends StandardParameters { - /** - * Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - model?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1GenerateContentRequest; - } - export interface Params$Resource$Publishers$Models$Get - extends StandardParameters { - /** - * Optional. Token used to access Hugging Face gated models. - */ - huggingFaceToken?: string; - /** - * Optional. Boolean indicates whether the requested model is a Hugging Face model. - */ - isHuggingFaceModel?: boolean; - /** - * Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in. - */ - languageCode?: string; - /** - * Required. The name of the PublisherModel resource. Format: `publishers/{publisher\}/models/{publisher_model\}` - */ - name?: string; - /** - * Optional. PublisherModel view specifying which fields to read. - */ - view?: string; - } - export interface Params$Resource$Publishers$Models$Predict - extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1PredictRequest; - } - export interface Params$Resource$Publishers$Models$Predictlongrunning - extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1PredictLongRunningRequest; - } - export interface Params$Resource$Publishers$Models$Streamgeneratecontent - extends StandardParameters { - /** - * Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - model?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1GenerateContentRequest; - } - - export class Resource$Reasoningengines { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Creates a reasoning engine. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -129297,25 +165926,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.create({ - * // Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project\}/locations/{location\}` - * parent: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "spec": {}, - * // "updateTime": "my_updateTime" - * // } - * }, + * const res = await aiplatform.trainingPipelines.operations.get({ + * // The name of the operation resource. + * name: 'trainingPipelines/my-trainingPipeline/operations/my-operation', * }); * console.log(res.data); * @@ -129341,36 +165954,36 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Reasoningengines$Create, + get( + params: Params$Resource$Trainingpipelines$Operations$Get, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Reasoningengines$Create, + get( + params?: Params$Resource$Trainingpipelines$Operations$Get, options?: MethodOptions ): Promise>; - create( - params: Params$Resource$Reasoningengines$Create, + get( + params: Params$Resource$Trainingpipelines$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Reasoningengines$Create, + get( + params: Params$Resource$Trainingpipelines$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Reasoningengines$Create, + get( + params: Params$Resource$Trainingpipelines$Operations$Get, callback: BodyResponseCallback ): void; - create( + get( callback: BodyResponseCallback ): void; - create( + get( paramsOrCallback?: - | Params$Resource$Reasoningengines$Create + | Params$Resource$Trainingpipelines$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -129386,12 +165999,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Create; + {}) as Params$Resource$Trainingpipelines$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reasoningengines$Create; + params = {} as Params$Resource$Trainingpipelines$Operations$Get; options = {}; } @@ -129404,18 +166017,15 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/reasoningEngines').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: [], - pathParams: [], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -129429,7 +166039,7 @@ export namespace aiplatform_v1 { } /** - * Deletes a reasoning engine. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -129458,21 +166068,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.delete({ - * // Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources. - * force: 'placeholder-value', - * // Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * name: 'reasoningEngines/my-reasoningEngine', + * const res = await aiplatform.trainingPipelines.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'trainingPipelines/my-trainingPipeline', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -129488,57 +166102,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Reasoningengines$Delete, + list( + params: Params$Resource$Trainingpipelines$Operations$List, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Reasoningengines$Delete, + list( + params?: Params$Resource$Trainingpipelines$Operations$List, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Reasoningengines$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Trainingpipelines$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Reasoningengines$Delete, + list( + params: Params$Resource$Trainingpipelines$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Reasoningengines$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Trainingpipelines$Operations$List, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - delete( + list( paramsOrCallback?: - | Params$Resource$Reasoningengines$Delete - | BodyResponseCallback + | Params$Resource$Trainingpipelines$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Delete; + {}) as Params$Resource$Trainingpipelines$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reasoningengines$Delete; + params = {} as Params$Resource$Trainingpipelines$Operations$List; options = {}; } @@ -129551,8 +166169,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -129563,17 +166184,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a reasoning engine. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -129602,23 +166225,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.get({ - * // Required. The name of the ReasoningEngine resource. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * name: 'reasoningEngines/my-reasoningEngine', + * const res = await aiplatform.trainingPipelines.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'trainingPipelines/my-trainingPipeline/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "spec": {}, - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -129634,61 +166255,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Reasoningengines$Get, + wait( + params: Params$Resource$Trainingpipelines$Operations$Wait, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Reasoningengines$Get, + wait( + params?: Params$Resource$Trainingpipelines$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Reasoningengines$Get, + ): Promise>; + wait( + params: Params$Resource$Trainingpipelines$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Reasoningengines$Get, + wait( + params: Params$Resource$Trainingpipelines$Operations$Wait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Reasoningengines$Get, - callback: BodyResponseCallback + wait( + params: Params$Resource$Trainingpipelines$Operations$Wait, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - get( + wait( paramsOrCallback?: - | Params$Resource$Reasoningengines$Get - | BodyResponseCallback + | Params$Resource$Trainingpipelines$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Get; + {}) as Params$Resource$Trainingpipelines$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reasoningengines$Get; + params = {} as Params$Resource$Trainingpipelines$Operations$Wait; options = {}; } @@ -129701,8 +166318,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -129713,19 +166330,89 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Trainingpipelines$Operations$Cancel + extends StandardParameters { /** - * Lists reasoning engines in a location. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Trainingpipelines$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Trainingpipelines$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Trainingpipelines$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Trainingpipelines$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Tuningjobs { + context: APIRequestContext; + operations: Resource$Tuningjobs$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Tuningjobs$Operations(this.context); + } + } + + export class Resource$Tuningjobs$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -129754,23 +166441,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.list({ - * // Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). - * filter: 'placeholder-value', - * // Optional. The standard list page size. - * pageSize: 'placeholder-value', - * // Optional. The standard list page token. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project\}/locations/{location\}` - * parent: 'placeholder-value', + * const res = await aiplatform.tuningJobs.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'tuningJobs/my-tuningJob/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "nextPageToken": "my_nextPageToken", - * // "reasoningEngines": [] - * // } + * // {} * } * * main().catch(e => { @@ -129785,61 +166463,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Reasoningengines$List, + cancel( + params: Params$Resource$Tuningjobs$Operations$Cancel, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Reasoningengines$List, + cancel( + params?: Params$Resource$Tuningjobs$Operations$Cancel, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Reasoningengines$List, + ): Promise>; + cancel( + params: Params$Resource$Tuningjobs$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Reasoningengines$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Reasoningengines$List, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Tuningjobs$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Tuningjobs$Operations$Cancel, + callback: BodyResponseCallback ): void; - list( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Reasoningengines$List - | BodyResponseCallback + | Params$Resource$Tuningjobs$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$List; + {}) as Params$Resource$Tuningjobs$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reasoningengines$List; + params = {} as Params$Resource$Tuningjobs$Operations$Cancel; options = {}; } @@ -129852,34 +166522,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/reasoningEngines').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: [], - pathParams: [], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a reasoning engine. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -129908,38 +166573,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.patch({ - * // Identifier. The resource name of the ReasoningEngine. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * name: 'reasoningEngines/my-reasoningEngine', - * // Optional. Mask specifying which fields to update. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "spec": {}, - * // "updateTime": "my_updateTime" - * // } - * }, + * const res = await aiplatform.tuningJobs.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'tuningJobs/my-tuningJob/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -129954,57 +166595,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Reasoningengines$Patch, + delete( + params: Params$Resource$Tuningjobs$Operations$Delete, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Reasoningengines$Patch, + delete( + params?: Params$Resource$Tuningjobs$Operations$Delete, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Reasoningengines$Patch, + ): Promise>; + delete( + params: Params$Resource$Tuningjobs$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Reasoningengines$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Reasoningengines$Patch, - callback: BodyResponseCallback + delete( + params: Params$Resource$Tuningjobs$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + delete( + params: Params$Resource$Tuningjobs$Operations$Delete, + callback: BodyResponseCallback ): void; - patch( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Reasoningengines$Patch - | BodyResponseCallback + | Params$Resource$Tuningjobs$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Patch; + {}) as Params$Resource$Tuningjobs$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reasoningengines$Patch; + params = {} as Params$Resource$Tuningjobs$Operations$Delete; options = {}; } @@ -130018,7 +166655,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options @@ -130029,17 +166666,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Queries using a reasoning engine. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -130068,24 +166705,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.query({ - * // Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * name: 'reasoningEngines/my-reasoningEngine', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "classMethod": "my_classMethod", - * // "input": {} - * // } - * }, + * const res = await aiplatform.tuningJobs.operations.get({ + * // The name of the operation resource. + * name: 'tuningJobs/my-tuningJob/operations/my-operation', * }); * console.log(res.data); * * // Example response * // { - * // "output": {} + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -130101,61 +166733,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - query( - params: Params$Resource$Reasoningengines$Query, + get( + params: Params$Resource$Tuningjobs$Operations$Get, options: StreamMethodOptions ): Promise>; - query( - params?: Params$Resource$Reasoningengines$Query, + get( + params?: Params$Resource$Tuningjobs$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - query( - params: Params$Resource$Reasoningengines$Query, + ): Promise>; + get( + params: Params$Resource$Tuningjobs$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - query( - params: Params$Resource$Reasoningengines$Query, + get( + params: Params$Resource$Tuningjobs$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - query( - params: Params$Resource$Reasoningengines$Query, - callback: BodyResponseCallback + get( + params: Params$Resource$Tuningjobs$Operations$Get, + callback: BodyResponseCallback ): void; - query( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - query( + get( paramsOrCallback?: - | Params$Resource$Reasoningengines$Query - | BodyResponseCallback + | Params$Resource$Tuningjobs$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Query; + {}) as Params$Resource$Tuningjobs$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reasoningengines$Query; + params = {} as Params$Resource$Tuningjobs$Operations$Get; options = {}; } @@ -130168,8 +166796,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:query').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -130180,19 +166808,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Streams queries using a reasoning engine. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -130221,26 +166847,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.streamQuery({ - * // Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * name: 'reasoningEngines/my-reasoningEngine', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "classMethod": "my_classMethod", - * // "input": {} - * // } - * }, + * const res = await aiplatform.tuningJobs.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'tuningJobs/my-tuningJob', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -130256,53 +166881,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - streamQuery( - params: Params$Resource$Reasoningengines$Streamquery, + list( + params: Params$Resource$Tuningjobs$Operations$List, options: StreamMethodOptions ): Promise>; - streamQuery( - params?: Params$Resource$Reasoningengines$Streamquery, + list( + params?: Params$Resource$Tuningjobs$Operations$List, options?: MethodOptions - ): Promise>; - streamQuery( - params: Params$Resource$Reasoningengines$Streamquery, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Tuningjobs$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - streamQuery( - params: Params$Resource$Reasoningengines$Streamquery, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Tuningjobs$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - streamQuery( - params: Params$Resource$Reasoningengines$Streamquery, - callback: BodyResponseCallback + list( + params: Params$Resource$Tuningjobs$Operations$List, + callback: BodyResponseCallback ): void; - streamQuery(callback: BodyResponseCallback): void; - streamQuery( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Reasoningengines$Streamquery - | BodyResponseCallback + | Params$Resource$Tuningjobs$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Streamquery; + {}) as Params$Resource$Tuningjobs$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reasoningengines$Streamquery; + params = {} as Params$Resource$Tuningjobs$Operations$List; options = {}; } @@ -130315,11 +166948,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:streamQuery').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -130330,103 +166963,60 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Reasoningengines$Create + export interface Params$Resource$Tuningjobs$Operations$Cancel extends StandardParameters { /** - * Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata + * The name of the operation resource to be cancelled. */ - requestBody?: Schema$GoogleCloudAiplatformV1ReasoningEngine; + name?: string; } - export interface Params$Resource$Reasoningengines$Delete + export interface Params$Resource$Tuningjobs$Operations$Delete extends StandardParameters { /** - * Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources. - */ - force?: boolean; - /** - * Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Reasoningengines$Get + export interface Params$Resource$Tuningjobs$Operations$Get extends StandardParameters { /** - * Required. The name of the ReasoningEngine resource. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Reasoningengines$List + export interface Params$Resource$Tuningjobs$Operations$List extends StandardParameters { /** - * Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). + * The standard list filter. */ filter?: string; /** - * Optional. The standard list page size. - */ - pageSize?: number; - /** - * Optional. The standard list page token. - */ - pageToken?: string; - /** - * Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - } - export interface Params$Resource$Reasoningengines$Patch - extends StandardParameters { - /** - * Identifier. The resource name of the ReasoningEngine. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - */ - name?: string; - /** - * Optional. Mask specifying which fields to update. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ReasoningEngine; - } - export interface Params$Resource$Reasoningengines$Query - extends StandardParameters { - /** - * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * The name of the operation's parent resource. */ name?: string; - /** - * Request body metadata + * The standard list page size. */ - requestBody?: Schema$GoogleCloudAiplatformV1QueryReasoningEngineRequest; - } - export interface Params$Resource$Reasoningengines$Streamquery - extends StandardParameters { + pageSize?: number; /** - * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * The standard list page token. */ - name?: string; - + pageToken?: string; /** - * Request body metadata + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - requestBody?: Schema$GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest; + returnPartialSuccess?: boolean; } } diff --git a/src/apis/alloydb/v1.ts b/src/apis/alloydb/v1.ts index 2028b61e06..818f66e213 100644 --- a/src/apis/alloydb/v1.ts +++ b/src/apis/alloydb/v1.ts @@ -455,6 +455,10 @@ export namespace alloydb_v1 { * Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used. */ databaseVersion?: string | null; + /** + * Optional. Configuration for Dataplex integration. + */ + dataplexConfig?: Schema$DataplexConfig; /** * Output only. Delete time stamp */ @@ -717,6 +721,15 @@ export namespace alloydb_v1 { */ table?: string | null; } + /** + * Configuration for Dataplex integration. + */ + export interface Schema$DataplexConfig { + /** + * Dataplex is enabled by default for resources such as clusters and instances. This flag controls the integration of AlloyDB PG resources (like databases, schemas, and tables) with Dataplex." + */ + enabled?: boolean | null; + } /** * DenyMaintenancePeriod definition. Excepting emergencies, maintenance will not be scheduled to start within this deny period. The start_date must be less than the end_date. */ @@ -3972,6 +3985,7 @@ export namespace alloydb_v1 { * // "continuousBackupInfo": {}, * // "createTime": "my_createTime", * // "databaseVersion": "my_databaseVersion", + * // "dataplexConfig": {}, * // "deleteTime": "my_deleteTime", * // "displayName": "my_displayName", * // "encryptionConfig": {}, @@ -4162,6 +4176,7 @@ export namespace alloydb_v1 { * // "continuousBackupInfo": {}, * // "createTime": "my_createTime", * // "databaseVersion": "my_databaseVersion", + * // "dataplexConfig": {}, * // "deleteTime": "my_deleteTime", * // "displayName": "my_displayName", * // "encryptionConfig": {}, @@ -4644,6 +4659,7 @@ export namespace alloydb_v1 { * // "continuousBackupInfo": {}, * // "createTime": "my_createTime", * // "databaseVersion": "my_databaseVersion", + * // "dataplexConfig": {}, * // "deleteTime": "my_deleteTime", * // "displayName": "my_displayName", * // "encryptionConfig": {}, @@ -5120,6 +5136,7 @@ export namespace alloydb_v1 { * // "continuousBackupInfo": {}, * // "createTime": "my_createTime", * // "databaseVersion": "my_databaseVersion", + * // "dataplexConfig": {}, * // "deleteTime": "my_deleteTime", * // "displayName": "my_displayName", * // "encryptionConfig": {}, diff --git a/src/apis/alloydb/v1alpha.ts b/src/apis/alloydb/v1alpha.ts index 38cce21001..200a6c4567 100644 --- a/src/apis/alloydb/v1alpha.ts +++ b/src/apis/alloydb/v1alpha.ts @@ -472,6 +472,10 @@ export namespace alloydb_v1alpha { * Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used. */ databaseVersion?: string | null; + /** + * Optional. Configuration for Dataplex integration. + */ + dataplexConfig?: Schema$DataplexConfig; /** * Output only. Delete time stamp */ @@ -807,6 +811,15 @@ export namespace alloydb_v1alpha { */ table?: string | null; } + /** + * Configuration for Dataplex integration. + */ + export interface Schema$DataplexConfig { + /** + * Dataplex is enabled by default for resources such as clusters and instances. This flag controls the integration of AlloyDB PG resources (like databases, schemas, and tables) with Dataplex." + */ + enabled?: boolean | null; + } /** * DenyMaintenancePeriod definition. Excepting emergencies, maintenance will not be scheduled to start within this deny period. The start_date must be less than the end_date. */ @@ -4165,6 +4178,7 @@ export namespace alloydb_v1alpha { * // "continuousBackupInfo": {}, * // "createTime": "my_createTime", * // "databaseVersion": "my_databaseVersion", + * // "dataplexConfig": {}, * // "deleteTime": "my_deleteTime", * // "displayName": "my_displayName", * // "encryptionConfig": {}, @@ -4359,6 +4373,7 @@ export namespace alloydb_v1alpha { * // "continuousBackupInfo": {}, * // "createTime": "my_createTime", * // "databaseVersion": "my_databaseVersion", + * // "dataplexConfig": {}, * // "deleteTime": "my_deleteTime", * // "displayName": "my_displayName", * // "encryptionConfig": {}, @@ -4847,6 +4862,7 @@ export namespace alloydb_v1alpha { * // "continuousBackupInfo": {}, * // "createTime": "my_createTime", * // "databaseVersion": "my_databaseVersion", + * // "dataplexConfig": {}, * // "deleteTime": "my_deleteTime", * // "displayName": "my_displayName", * // "encryptionConfig": {}, @@ -5330,6 +5346,7 @@ export namespace alloydb_v1alpha { * // "continuousBackupInfo": {}, * // "createTime": "my_createTime", * // "databaseVersion": "my_databaseVersion", + * // "dataplexConfig": {}, * // "deleteTime": "my_deleteTime", * // "displayName": "my_displayName", * // "encryptionConfig": {}, diff --git a/src/apis/alloydb/v1beta.ts b/src/apis/alloydb/v1beta.ts index 4fa06d2b76..ffc0324cb2 100644 --- a/src/apis/alloydb/v1beta.ts +++ b/src/apis/alloydb/v1beta.ts @@ -464,6 +464,10 @@ export namespace alloydb_v1beta { * Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used. */ databaseVersion?: string | null; + /** + * Optional. Configuration for Dataplex integration. + */ + dataplexConfig?: Schema$DataplexConfig; /** * Output only. Delete time stamp */ @@ -795,6 +799,15 @@ export namespace alloydb_v1beta { */ table?: string | null; } + /** + * Configuration for Dataplex integration. + */ + export interface Schema$DataplexConfig { + /** + * Dataplex is enabled by default for resources such as clusters and instances. This flag controls the integration of AlloyDB PG resources (like databases, schemas, and tables) with Dataplex." + */ + enabled?: boolean | null; + } /** * DenyMaintenancePeriod definition. Excepting emergencies, maintenance will not be scheduled to start within this deny period. The start_date must be less than the end_date. */ @@ -4146,6 +4159,7 @@ export namespace alloydb_v1beta { * // "continuousBackupInfo": {}, * // "createTime": "my_createTime", * // "databaseVersion": "my_databaseVersion", + * // "dataplexConfig": {}, * // "deleteTime": "my_deleteTime", * // "displayName": "my_displayName", * // "encryptionConfig": {}, @@ -4339,6 +4353,7 @@ export namespace alloydb_v1beta { * // "continuousBackupInfo": {}, * // "createTime": "my_createTime", * // "databaseVersion": "my_databaseVersion", + * // "dataplexConfig": {}, * // "deleteTime": "my_deleteTime", * // "displayName": "my_displayName", * // "encryptionConfig": {}, @@ -4826,6 +4841,7 @@ export namespace alloydb_v1beta { * // "continuousBackupInfo": {}, * // "createTime": "my_createTime", * // "databaseVersion": "my_databaseVersion", + * // "dataplexConfig": {}, * // "deleteTime": "my_deleteTime", * // "displayName": "my_displayName", * // "encryptionConfig": {}, @@ -5308,6 +5324,7 @@ export namespace alloydb_v1beta { * // "continuousBackupInfo": {}, * // "createTime": "my_createTime", * // "databaseVersion": "my_databaseVersion", + * // "dataplexConfig": {}, * // "deleteTime": "my_deleteTime", * // "displayName": "my_displayName", * // "encryptionConfig": {}, diff --git a/src/apis/analyticshub/v1.ts b/src/apis/analyticshub/v1.ts index eb2868fce9..ba6ddb10e9 100644 --- a/src/apis/analyticshub/v1.ts +++ b/src/apis/analyticshub/v1.ts @@ -581,6 +581,10 @@ export namespace analyticshub_v1 { * Optional. A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message. */ retryPolicy?: Schema$RetryPolicy; + /** + * Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + */ + tags?: {[key: string]: string} | null; } /** * User-defined JavaScript function that can transform or filter a Pub/Sub message. @@ -705,6 +709,10 @@ export namespace analyticshub_v1 { * Output only. Current state of the listing. */ state?: string | null; + /** + * Optional. If set, stored procedure configuration will be propagated and enforced on the linked dataset. + */ + storedProcedureConfig?: Schema$StoredProcedureConfig; } /** * Message for response to the list of Listings. @@ -1148,6 +1156,19 @@ export namespace analyticshub_v1 { */ message?: string | null; } + /** + * Stored procedure configuration, used to configure stored procedure sharing on linked dataset. + */ + export interface Schema$StoredProcedureConfig { + /** + * Output only. Types of stored procedure supported to share. + */ + allowedStoredProcedureTypes?: string[] | null; + /** + * Optional. If true, enable sharing of stored procedure. + */ + enabled?: boolean | null; + } /** * Message for submitting a QueryTemplate. */ @@ -3266,7 +3287,8 @@ export namespace analyticshub_v1 { * // "requestAccess": "my_requestAccess", * // "resourceType": "my_resourceType", * // "restrictedExportConfig": {}, - * // "state": "my_state" + * // "state": "my_state", + * // "storedProcedureConfig": {} * // } * }, * }); @@ -3292,7 +3314,8 @@ export namespace analyticshub_v1 { * // "requestAccess": "my_requestAccess", * // "resourceType": "my_resourceType", * // "restrictedExportConfig": {}, - * // "state": "my_state" + * // "state": "my_state", + * // "storedProcedureConfig": {} * // } * } * @@ -3590,7 +3613,8 @@ export namespace analyticshub_v1 { * // "requestAccess": "my_requestAccess", * // "resourceType": "my_resourceType", * // "restrictedExportConfig": {}, - * // "state": "my_state" + * // "state": "my_state", + * // "storedProcedureConfig": {} * // } * } * @@ -4216,7 +4240,8 @@ export namespace analyticshub_v1 { * // "requestAccess": "my_requestAccess", * // "resourceType": "my_resourceType", * // "restrictedExportConfig": {}, - * // "state": "my_state" + * // "state": "my_state", + * // "storedProcedureConfig": {} * // } * }, * }); @@ -4242,7 +4267,8 @@ export namespace analyticshub_v1 { * // "requestAccess": "my_requestAccess", * // "resourceType": "my_resourceType", * // "restrictedExportConfig": {}, - * // "state": "my_state" + * // "state": "my_state", + * // "storedProcedureConfig": {} * // } * } * diff --git a/src/apis/androidpublisher/v3.ts b/src/apis/androidpublisher/v3.ts index ca17b231cf..0cce1dc500 100644 --- a/src/apis/androidpublisher/v3.ts +++ b/src/apis/androidpublisher/v3.ts @@ -2898,6 +2898,10 @@ export namespace androidpublisher_v3 { * The offer ID of the one-time purchase offer. */ offerId?: string | null; + /** + * The details of a pre-order purchase. Only set if it is a pre-order purchase. Note that this field will be set even after pre-order is fulfilled. + */ + preorderDetails?: Schema$PreorderDetails; /** * ID of the purchase option. This field is set for both purchase options and variant offers. For purchase options, this ID identifies the purchase option itself. For variant offers, this ID refers to the associated purchase option, and in conjunction with offer_id it identifies the variant offer. */ @@ -3155,6 +3159,19 @@ export namespace androidpublisher_v3 { */ pointsSpent?: string | null; } + /** + * Details of a pre-order purchase. + */ + export interface Schema$PreorderDetails {} + /** + * Offer details information related to a preorder line item. + */ + export interface Schema$PreorderOfferDetails { + /** + * The time when a preordered item is released for a preorder purchase. + */ + preorderReleaseTime?: string | null; + } /** * Represents a base plan that does not automatically renew at the end of the base plan, and must be manually renewed by the user. */ @@ -3249,6 +3266,10 @@ export namespace androidpublisher_v3 { * The per-transaction offer token used to make this purchase line item. */ offerToken?: string | null; + /** + * Offer details for a preorder offer. This will only be set for preorders. + */ + preorderOfferDetails?: Schema$PreorderOfferDetails; /** * The purchase option ID. */ diff --git a/src/apis/apihub/v1.ts b/src/apis/apihub/v1.ts index 6a573d55d2..b02f5bdee1 100644 --- a/src/apis/apihub/v1.ts +++ b/src/apis/apihub/v1.ts @@ -205,7 +205,7 @@ export namespace apihub_v1 { */ documentation?: Schema$GoogleCloudApihubV1Documentation; /** - * Optional. Fingerprint of the API resource. + * Optional. Fingerprint of the API resource. This must be unique for each API resource. It can neither be unset nor be updated to an existing fingerprint of another API resource. */ fingerprint?: string | null; /** @@ -2481,6 +2481,10 @@ export namespace apihub_v1 { * A list of operations that matches the specified filter in the request. */ operations?: Schema$GoogleLongrunningOperation[]; + /** + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -2908,7 +2912,7 @@ export namespace apihub_v1 { * * // Do the magic * const res = await apihub.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -3362,7 +3366,7 @@ export namespace apihub_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** @@ -4687,7 +4691,7 @@ export namespace apihub_v1 { } /** - * Update an API resource in the API hub. The following fields in the API can be updated: * display_name * description * owner * documentation * target_user * team * business_unit * maturity_level * api_style * attributes The update_mask should be used to specify the fields being updated. Updating the owner field requires complete owner message and updates both owner and email fields. + * Update an API resource in the API hub. The following fields in the API can be updated: * display_name * description * owner * documentation * target_user * team * business_unit * maturity_level * api_style * attributes * fingerprint The update_mask should be used to specify the fields being updated. Updating the owner field requires complete owner message and updates both owner and email fields. * @example * ```js * // Before running the sample: @@ -6600,7 +6604,7 @@ export namespace apihub_v1 { } /** - * Update an operation in an API version. The following fields in the ApiOperation resource can be updated: * details.description * details.documentation * details.http_operation.path * details.http_operation.method * details.deprecated * attributes The update_mask should be used to specify the fields being updated. An operation can be updated only if the operation was created via CreateApiOperation API. If the operation was created by parsing the spec, then it can be edited by updating the spec. + * Update an operation in an API version. The following fields in the ApiOperation resource can be updated: * details.description * details.documentation * details.http_operation.path * details.http_operation.method * details.deprecated * attributes * details.mcp_tool.title * details.mcp_tool.description * details.input_schema * details.output_schema * details.mcp_tool.annotations.title * details.mcp_tool.annotations.read_only_hint * details.mcp_tool.annotations.destructive_hint * details.mcp_tool.annotations.idempotent_hint * details.mcp_tool.annotations.open_world_hint * details.mcp_tool.annotations.additional_hints The update_mask should be used to specify the fields being updated. An operation can be updated only if the operation was created via CreateApiOperation API. If the operation was created by parsing the spec, then it can be edited by updating the spec. * @example * ```js * // Before running the sample: @@ -13921,13 +13925,16 @@ export namespace apihub_v1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -14081,6 +14088,10 @@ export namespace apihub_v1 { * The standard list page token. */ pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Plugins { diff --git a/src/apis/apim/v1alpha.ts b/src/apis/apim/v1alpha.ts index c820faf014..398d36bf52 100644 --- a/src/apis/apim/v1alpha.ts +++ b/src/apis/apim/v1alpha.ts @@ -986,7 +986,7 @@ export namespace apim_v1alpha { * * // Do the magic * const res = await apim.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -1269,7 +1269,7 @@ export namespace apim_v1alpha { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/authorizedbuyersmarketplace/v1.ts b/src/apis/authorizedbuyersmarketplace/v1.ts index 422e05d00b..c22db36a05 100644 --- a/src/apis/authorizedbuyersmarketplace/v1.ts +++ b/src/apis/authorizedbuyersmarketplace/v1.ts @@ -1633,6 +1633,157 @@ export namespace authorizedbuyersmarketplace_v1 { return createAPIRequest(parameters); } } + + /** + * Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. In addition, bidders can use the URL path "/v1/bidders/{accountId\}/finalizedDeals/{dealId\}" to set ready to serve for the finalized deals belong to itself, its child seats and all their clients. This method only applies to programmatic guaranteed deals. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/authorizedbuyersmarketplace.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const authorizedbuyersmarketplace = google.authorizedbuyersmarketplace('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/authorized-buyers-marketplace'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await authorizedbuyersmarketplace.bidders.finalizedDeals.setReadyToServe({ + * // Required. Format: `buyers/{accountId\}/finalizedDeals/{dealId\}` or `bidders/{accountId\}/finalizedDeals/{dealId\}` + * deal: 'bidders/my-bidder/finalizedDeals/my-finalizedDeal', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "deal": {}, + * // "dealPausingInfo": {}, + * // "dealServingStatus": "my_dealServingStatus", + * // "name": "my_name", + * // "readyToServe": false, + * // "rtbMetrics": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setReadyToServe( + params: Params$Resource$Bidders$Finalizeddeals$Setreadytoserve, + options: StreamMethodOptions + ): Promise>; + setReadyToServe( + params?: Params$Resource$Bidders$Finalizeddeals$Setreadytoserve, + options?: MethodOptions + ): Promise>; + setReadyToServe( + params: Params$Resource$Bidders$Finalizeddeals$Setreadytoserve, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setReadyToServe( + params: Params$Resource$Bidders$Finalizeddeals$Setreadytoserve, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setReadyToServe( + params: Params$Resource$Bidders$Finalizeddeals$Setreadytoserve, + callback: BodyResponseCallback + ): void; + setReadyToServe(callback: BodyResponseCallback): void; + setReadyToServe( + paramsOrCallback?: + | Params$Resource$Bidders$Finalizeddeals$Setreadytoserve + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Bidders$Finalizeddeals$Setreadytoserve; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Bidders$Finalizeddeals$Setreadytoserve; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+deal}:setReadyToServe').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['deal'], + pathParams: ['deal'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Bidders$Finalizeddeals$List @@ -1658,6 +1809,18 @@ export namespace authorizedbuyersmarketplace_v1 { */ parent?: string; } + export interface Params$Resource$Bidders$Finalizeddeals$Setreadytoserve + extends StandardParameters { + /** + * Required. Format: `buyers/{accountId\}/finalizedDeals/{dealId\}` or `bidders/{accountId\}/finalizedDeals/{dealId\}` + */ + deal?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetReadyToServeRequest; + } export class Resource$Buyers { context: APIRequestContext; @@ -5372,7 +5535,7 @@ export namespace authorizedbuyersmarketplace_v1 { } /** - * Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. This method only applies to programmatic guaranteed deals. + * Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. In addition, bidders can use the URL path "/v1/bidders/{accountId\}/finalizedDeals/{dealId\}" to set ready to serve for the finalized deals belong to itself, its child seats and all their clients. This method only applies to programmatic guaranteed deals. * @example * ```js * // Before running the sample: @@ -5403,7 +5566,7 @@ export namespace authorizedbuyersmarketplace_v1 { * // Do the magic * const res = * await authorizedbuyersmarketplace.buyers.finalizedDeals.setReadyToServe({ - * // Required. Format: `buyers/{accountId\}/finalizedDeals/{dealId\}` + * // Required. Format: `buyers/{accountId\}/finalizedDeals/{dealId\}` or `bidders/{accountId\}/finalizedDeals/{dealId\}` * deal: 'buyers/my-buyer/finalizedDeals/my-finalizedDeal', * * // Request body metadata @@ -5592,7 +5755,7 @@ export namespace authorizedbuyersmarketplace_v1 { export interface Params$Resource$Buyers$Finalizeddeals$Setreadytoserve extends StandardParameters { /** - * Required. Format: `buyers/{accountId\}/finalizedDeals/{dealId\}` + * Required. Format: `buyers/{accountId\}/finalizedDeals/{dealId\}` or `bidders/{accountId\}/finalizedDeals/{dealId\}` */ deal?: string; diff --git a/src/apis/authorizedbuyersmarketplace/v1alpha.ts b/src/apis/authorizedbuyersmarketplace/v1alpha.ts index ea3e8308e1..7fdc006e8d 100644 --- a/src/apis/authorizedbuyersmarketplace/v1alpha.ts +++ b/src/apis/authorizedbuyersmarketplace/v1alpha.ts @@ -1681,6 +1681,158 @@ export namespace authorizedbuyersmarketplace_v1alpha { return createAPIRequest(parameters); } } + + /** + * Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. In addition, bidders can use the URL path "/v1alpha/bidders/{accountId\}/finalizedDeals/{dealId\}" to set ready to serve for the finalized deals belong to itself, its child seats and all their clients. This method only applies to programmatic guaranteed deals. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/authorizedbuyersmarketplace.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const authorizedbuyersmarketplace = + * google.authorizedbuyersmarketplace('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/authorized-buyers-marketplace'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await authorizedbuyersmarketplace.bidders.finalizedDeals.setReadyToServe({ + * // Required. Format: `buyers/{accountId\}/finalizedDeals/{dealId\}` or `bidders/{accountId\}/finalizedDeals/{dealId\}` + * deal: 'bidders/my-bidder/finalizedDeals/my-finalizedDeal', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "deal": {}, + * // "dealPausingInfo": {}, + * // "dealServingStatus": "my_dealServingStatus", + * // "name": "my_name", + * // "readyToServe": false, + * // "rtbMetrics": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setReadyToServe( + params: Params$Resource$Bidders$Finalizeddeals$Setreadytoserve, + options: StreamMethodOptions + ): Promise>; + setReadyToServe( + params?: Params$Resource$Bidders$Finalizeddeals$Setreadytoserve, + options?: MethodOptions + ): Promise>; + setReadyToServe( + params: Params$Resource$Bidders$Finalizeddeals$Setreadytoserve, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setReadyToServe( + params: Params$Resource$Bidders$Finalizeddeals$Setreadytoserve, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setReadyToServe( + params: Params$Resource$Bidders$Finalizeddeals$Setreadytoserve, + callback: BodyResponseCallback + ): void; + setReadyToServe(callback: BodyResponseCallback): void; + setReadyToServe( + paramsOrCallback?: + | Params$Resource$Bidders$Finalizeddeals$Setreadytoserve + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Bidders$Finalizeddeals$Setreadytoserve; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Bidders$Finalizeddeals$Setreadytoserve; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+deal}:setReadyToServe').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['deal'], + pathParams: ['deal'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Bidders$Finalizeddeals$List @@ -1706,6 +1858,18 @@ export namespace authorizedbuyersmarketplace_v1alpha { */ parent?: string; } + export interface Params$Resource$Bidders$Finalizeddeals$Setreadytoserve + extends StandardParameters { + /** + * Required. Format: `buyers/{accountId\}/finalizedDeals/{dealId\}` or `bidders/{accountId\}/finalizedDeals/{dealId\}` + */ + deal?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetReadyToServeRequest; + } export class Resource$Buyers { context: APIRequestContext; @@ -6430,7 +6594,7 @@ export namespace authorizedbuyersmarketplace_v1alpha { } /** - * Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. This method only applies to programmatic guaranteed deals. + * Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. In addition, bidders can use the URL path "/v1alpha/bidders/{accountId\}/finalizedDeals/{dealId\}" to set ready to serve for the finalized deals belong to itself, its child seats and all their clients. This method only applies to programmatic guaranteed deals. * @example * ```js * // Before running the sample: @@ -6462,7 +6626,7 @@ export namespace authorizedbuyersmarketplace_v1alpha { * // Do the magic * const res = * await authorizedbuyersmarketplace.buyers.finalizedDeals.setReadyToServe({ - * // Required. Format: `buyers/{accountId\}/finalizedDeals/{dealId\}` + * // Required. Format: `buyers/{accountId\}/finalizedDeals/{dealId\}` or `bidders/{accountId\}/finalizedDeals/{dealId\}` * deal: 'buyers/my-buyer/finalizedDeals/my-finalizedDeal', * * // Request body metadata @@ -6651,7 +6815,7 @@ export namespace authorizedbuyersmarketplace_v1alpha { export interface Params$Resource$Buyers$Finalizeddeals$Setreadytoserve extends StandardParameters { /** - * Required. Format: `buyers/{accountId\}/finalizedDeals/{dealId\}` + * Required. Format: `buyers/{accountId\}/finalizedDeals/{dealId\}` or `bidders/{accountId\}/finalizedDeals/{dealId\}` */ deal?: string; diff --git a/src/apis/backupdr/v1.ts b/src/apis/backupdr/v1.ts index 58d2c2f64b..b199c4ea9f 100644 --- a/src/apis/backupdr/v1.ts +++ b/src/apis/backupdr/v1.ts @@ -423,6 +423,10 @@ export namespace backupdr_v1 { * Output only. Configuration for a Google Cloud resource. */ gcpBackupPlanInfo?: Schema$GCPBackupPlanInfo; + /** + * Output only. Unique identifier of the GCP resource that is being backed up. + */ + gcpResource?: Schema$BackupGcpResource; /** * Optional. Resource labels to represent user provided metadata. No labels currently defined. */ @@ -648,6 +652,23 @@ export namespace backupdr_v1 { */ thirdPartyManagementUri?: string | null; } + /** + * Minimum details to identify a Google Cloud resource for a backup. + */ + export interface Schema$BackupGcpResource { + /** + * Name of the Google Cloud resource. + */ + gcpResourcename?: string | null; + /** + * Location of the resource: //"global"/"unspecified". + */ + location?: string | null; + /** + * Type of the resource. Use the Unified Resource Type, eg. compute.googleapis.com/Instance. + */ + type?: string | null; + } /** * BackupLocation represents a cloud location where a backup can be stored. */ @@ -962,6 +983,14 @@ export namespace backupdr_v1 { * Output only. Whether the backup is a final backup. */ finalBackup?: boolean | null; + /** + * Output only. The instance creation timestamp. + */ + instanceCreateTime?: string | null; + /** + * Output only. The instance delete timestamp. + */ + instanceDeleteTime?: string | null; /** * Output only. The tier (or machine type) for this instance. Example: `db-custom-1-3840` */ @@ -1445,6 +1474,10 @@ export namespace backupdr_v1 { * Identifier. The resource name of the DataSourceReference. Format: projects/{project\}/locations/{location\}/dataSourceReferences/{data_source_reference\} */ name?: string | null; + /** + * Output only. Total size of the storage used by all backup resources for the referenced datasource. + */ + totalStoredBytes?: string | null; } /** * DiskBackupProperties represents the properties of a Disk backup. @@ -1716,6 +1749,19 @@ export namespace backupdr_v1 { */ nextPageToken?: string | null; } + /** + * Response for the FetchBackupsForResourceType method. + */ + export interface Schema$FetchBackupsForResourceTypeResponse { + /** + * The Backups from the specified parent. + */ + backups?: Schema$Backup[]; + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } /** * Response for the FetchDataSourceReferencesForResourceType method. */ @@ -2027,6 +2073,19 @@ export namespace backupdr_v1 { */ unreachable?: string[] | null; } + /** + * Response for the ListDataSourceReferences method. + */ + export interface Schema$ListDataSourceReferencesResponse { + /** + * The DataSourceReferences from the specified parent. + */ + dataSourceReferences?: Schema$DataSourceReference[]; + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } /** * Response message for listing DataSources. */ @@ -8665,6 +8724,170 @@ export namespace backupdr_v1 { } } + /** + * Fetch Backups for a given resource type. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/backupdr.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const backupdr = google.backupdr('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await backupdr.projects.locations.backupVaults.dataSources.backups.fetchForResourceType( + * { + * // Optional. A filter expression that filters the results fetched in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. Supported fields: + * filter: 'placeholder-value', + * // Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. + * orderBy: 'placeholder-value', + * // Optional. The maximum number of Backups to return. The service may return fewer than this value. If unspecified, at most 50 Backups will be returned. The maximum value is 100; values above 100 will be coerced to 100. + * pageSize: 'placeholder-value', + * // Optional. A page token, received from a previous call of `FetchBackupsForResourceType`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchBackupsForResourceType` must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. Datasources are the parent resource for the backups. Format: projects/{project\}/locations/{location\}/backupVaults/{backupVaultId\}/dataSources/{datasourceId\} + * parent: + * 'projects/my-project/locations/my-location/backupVaults/my-backupVault/dataSources/my-dataSource', + * // Required. The type of the GCP resource. Ex: sqladmin.googleapis.com/Instance + * resourceType: 'placeholder-value', + * // Optional. This parameter is used to specify the view of the backup. If not specified, the default view is BASIC. + * view: 'placeholder-value', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "backups": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + fetchForResourceType( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Fetchforresourcetype, + options: StreamMethodOptions + ): Promise>; + fetchForResourceType( + params?: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Fetchforresourcetype, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + fetchForResourceType( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Fetchforresourcetype, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchForResourceType( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Fetchforresourcetype, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchForResourceType( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Fetchforresourcetype, + callback: BodyResponseCallback + ): void; + fetchForResourceType( + callback: BodyResponseCallback + ): void; + fetchForResourceType( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Fetchforresourcetype + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Fetchforresourcetype; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Fetchforresourcetype; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+parent}/backups:fetchForResourceType' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Gets details of a Backup. * @example @@ -8720,6 +8943,7 @@ export namespace backupdr_v1 { * // "etag": "my_etag", * // "expireTime": "my_expireTime", * // "gcpBackupPlanInfo": {}, + * // "gcpResource": {}, * // "labels": {}, * // "name": "my_name", * // "resourceSizeBytes": "my_resourceSizeBytes", @@ -9033,6 +9257,7 @@ export namespace backupdr_v1 { * // "etag": "my_etag", * // "expireTime": "my_expireTime", * // "gcpBackupPlanInfo": {}, + * // "gcpResource": {}, * // "labels": {}, * // "name": "my_name", * // "resourceSizeBytes": "my_resourceSizeBytes", @@ -9317,6 +9542,37 @@ export namespace backupdr_v1 { */ requestId?: string; } + export interface Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Fetchforresourcetype + extends StandardParameters { + /** + * Optional. A filter expression that filters the results fetched in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. Supported fields: + */ + filter?: string; + /** + * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. + */ + orderBy?: string; + /** + * Optional. The maximum number of Backups to return. The service may return fewer than this value. If unspecified, at most 50 Backups will be returned. The maximum value is 100; values above 100 will be coerced to 100. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous call of `FetchBackupsForResourceType`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchBackupsForResourceType` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. Datasources are the parent resource for the backups. Format: projects/{project\}/locations/{location\}/backupVaults/{backupVaultId\}/dataSources/{datasourceId\} + */ + parent?: string; + /** + * Required. The type of the GCP resource. Ex: sqladmin.googleapis.com/Instance + */ + resourceType?: string; + /** + * Optional. This parameter is used to specify the view of the backup. If not specified, the default view is BASIC. + */ + view?: string; + } export interface Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Get extends StandardParameters { /** @@ -9600,7 +9856,8 @@ export namespace backupdr_v1 { * // "dataSourceBackupConfigState": "my_dataSourceBackupConfigState", * // "dataSourceBackupCount": "my_dataSourceBackupCount", * // "dataSourceGcpResourceInfo": {}, - * // "name": "my_name" + * // "name": "my_name", + * // "totalStoredBytes": "my_totalStoredBytes" * // } * } * @@ -9696,6 +9953,163 @@ export namespace backupdr_v1 { return createAPIRequest(parameters); } } + + /** + * Lists DataSourceReferences for a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/backupdr.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const backupdr = google.backupdr('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await backupdr.projects.locations.dataSourceReferences.list({ + * // Optional. A filter expression that filters the results listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The following field and operator combinations are supported: * data_source_gcp_resource_info.gcp_resourcename with `=`, `!=` * data_source_gcp_resource_info.type with `=`, `!=` + * filter: 'placeholder-value', + * // Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * data_source * data_source_gcp_resource_info.gcp_resourcename + * orderBy: 'placeholder-value', + * // Optional. The maximum number of DataSourceReferences to return. The service may return fewer than this value. If unspecified, at most 50 DataSourceReferences will be returned. The maximum value is 100; values above 100 will be coerced to 100. + * pageSize: 'placeholder-value', + * // Optional. A page token, received from a previous `ListDataSourceReferences` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDataSourceReferences` must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The parent resource name. Format: projects/{project\}/locations/{location\} + * parent: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "dataSourceReferences": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Datasourcereferences$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Datasourcereferences$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Datasourcereferences$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Datasourcereferences$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Datasourcereferences$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasourcereferences$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasourcereferences$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasourcereferences$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/dataSourceReferences').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } } export interface Params$Resource$Projects$Locations$Datasourcereferences$Fetchforresourcetype @@ -9732,6 +10146,29 @@ export namespace backupdr_v1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Datasourcereferences$List + extends StandardParameters { + /** + * Optional. A filter expression that filters the results listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The following field and operator combinations are supported: * data_source_gcp_resource_info.gcp_resourcename with `=`, `!=` * data_source_gcp_resource_info.type with `=`, `!=` + */ + filter?: string; + /** + * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * data_source * data_source_gcp_resource_info.gcp_resourcename + */ + orderBy?: string; + /** + * Optional. The maximum number of DataSourceReferences to return. The service may return fewer than this value. If unspecified, at most 50 DataSourceReferences will be returned. The maximum value is 100; values above 100 will be coerced to 100. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListDataSourceReferences` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDataSourceReferences` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent resource name. Format: projects/{project\}/locations/{location\} + */ + parent?: string; + } export class Resource$Projects$Locations$Managementservers { context: APIRequestContext; diff --git a/src/apis/beyondcorp/README.md b/src/apis/beyondcorp/README.md index eed46b976d..14f02727c8 100644 --- a/src/apis/beyondcorp/README.md +++ b/src/apis/beyondcorp/README.md @@ -2,7 +2,7 @@ # beyondcorp -> Beyondcorp Enterprise provides identity and context aware access controls for enterprise resources and enables zero-trust access. Using the Beyondcorp Enterprise APIs, enterprises can set up multi-cloud and on-prem connectivity solutions. +> Chrome Enterprise Premium is a secure enterprise browsing solution that provides secure access to applications and resources, and offers integrated threat and data protection. It adds an extra layer of security to safeguard your Chrome browser environment, including Data Loss Prevention (DLP), real-time URL and file scanning, and Context-Aware Access for SaaS and web apps. ## Support status **Note**: Google provides multiple libraries for this service. This library is in diff --git a/src/apis/bigquery/v2.ts b/src/apis/bigquery/v2.ts index 86e678232a..f8604661c0 100644 --- a/src/apis/bigquery/v2.ts +++ b/src/apis/bigquery/v2.ts @@ -2055,6 +2055,10 @@ export namespace bigquery_v2 { * The base table reference. */ baseTable?: Schema$TableReference; + /** + * The index id. + */ + indexId?: string | null; /** * The number of parallel inputs after index pruning. */ diff --git a/src/apis/bigquerydatatransfer/v1.ts b/src/apis/bigquerydatatransfer/v1.ts index 27cdc60a07..1eeaf1da6c 100644 --- a/src/apis/bigquerydatatransfer/v1.ts +++ b/src/apis/bigquerydatatransfer/v1.ts @@ -586,6 +586,10 @@ export namespace bigquerydatatransfer_v1 { * Output only. Error code with detailed information about reason of the latest config failure. */ error?: Schema$Status; + /** + * The classification of the destination table. + */ + managedTableType?: string | null; /** * Identifier. The resource name of the transfer config. Transfer config names have the form either `projects/{project_id\}/locations/{region\}/transferConfigs/{config_id\}` or `projects/{project_id\}/transferConfigs/{config_id\}`, where `config_id` is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config. */ @@ -2633,6 +2637,7 @@ export namespace bigquerydatatransfer_v1 { * // "emailPreferences": {}, * // "encryptionConfiguration": {}, * // "error": {}, + * // "managedTableType": "my_managedTableType", * // "name": "my_name", * // "nextRunTime": "my_nextRunTime", * // "notificationPubsubTopic": "my_notificationPubsubTopic", @@ -2660,6 +2665,7 @@ export namespace bigquerydatatransfer_v1 { * // "emailPreferences": {}, * // "encryptionConfiguration": {}, * // "error": {}, + * // "managedTableType": "my_managedTableType", * // "name": "my_name", * // "nextRunTime": "my_nextRunTime", * // "notificationPubsubTopic": "my_notificationPubsubTopic", @@ -2962,6 +2968,7 @@ export namespace bigquerydatatransfer_v1 { * // "emailPreferences": {}, * // "encryptionConfiguration": {}, * // "error": {}, + * // "managedTableType": "my_managedTableType", * // "name": "my_name", * // "nextRunTime": "my_nextRunTime", * // "notificationPubsubTopic": "my_notificationPubsubTopic", @@ -3279,6 +3286,7 @@ export namespace bigquerydatatransfer_v1 { * // "emailPreferences": {}, * // "encryptionConfiguration": {}, * // "error": {}, + * // "managedTableType": "my_managedTableType", * // "name": "my_name", * // "nextRunTime": "my_nextRunTime", * // "notificationPubsubTopic": "my_notificationPubsubTopic", @@ -3306,6 +3314,7 @@ export namespace bigquerydatatransfer_v1 { * // "emailPreferences": {}, * // "encryptionConfiguration": {}, * // "error": {}, + * // "managedTableType": "my_managedTableType", * // "name": "my_name", * // "nextRunTime": "my_nextRunTime", * // "notificationPubsubTopic": "my_notificationPubsubTopic", @@ -4584,6 +4593,7 @@ export namespace bigquerydatatransfer_v1 { * // "emailPreferences": {}, * // "encryptionConfiguration": {}, * // "error": {}, + * // "managedTableType": "my_managedTableType", * // "name": "my_name", * // "nextRunTime": "my_nextRunTime", * // "notificationPubsubTopic": "my_notificationPubsubTopic", @@ -4611,6 +4621,7 @@ export namespace bigquerydatatransfer_v1 { * // "emailPreferences": {}, * // "encryptionConfiguration": {}, * // "error": {}, + * // "managedTableType": "my_managedTableType", * // "name": "my_name", * // "nextRunTime": "my_nextRunTime", * // "notificationPubsubTopic": "my_notificationPubsubTopic", @@ -4908,6 +4919,7 @@ export namespace bigquerydatatransfer_v1 { * // "emailPreferences": {}, * // "encryptionConfiguration": {}, * // "error": {}, + * // "managedTableType": "my_managedTableType", * // "name": "my_name", * // "nextRunTime": "my_nextRunTime", * // "notificationPubsubTopic": "my_notificationPubsubTopic", @@ -5223,6 +5235,7 @@ export namespace bigquerydatatransfer_v1 { * // "emailPreferences": {}, * // "encryptionConfiguration": {}, * // "error": {}, + * // "managedTableType": "my_managedTableType", * // "name": "my_name", * // "nextRunTime": "my_nextRunTime", * // "notificationPubsubTopic": "my_notificationPubsubTopic", @@ -5250,6 +5263,7 @@ export namespace bigquerydatatransfer_v1 { * // "emailPreferences": {}, * // "encryptionConfiguration": {}, * // "error": {}, + * // "managedTableType": "my_managedTableType", * // "name": "my_name", * // "nextRunTime": "my_nextRunTime", * // "notificationPubsubTopic": "my_notificationPubsubTopic", diff --git a/src/apis/bigqueryreservation/v1.ts b/src/apis/bigqueryreservation/v1.ts index ef3087eb02..7601000ff7 100644 --- a/src/apis/bigqueryreservation/v1.ts +++ b/src/apis/bigqueryreservation/v1.ts @@ -144,6 +144,10 @@ export namespace bigqueryreservation_v1 { * Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. */ name?: string | null; + /** + * Optional. The scheduling policy to use for jobs and queries of this assignee when running under the associated reservation. The scheduling policy controls how the reservation's resources are distributed. This overrides the default scheduling policy specified on the reservation. This feature is not yet generally available. + */ + schedulingPolicy?: Schema$SchedulingPolicy; /** * Output only. State of the assignment. */ @@ -489,6 +493,10 @@ export namespace bigqueryreservation_v1 { * Optional. The scaling mode for the reservation. If the field is present but max_slots is not present, requests will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`. */ scalingMode?: string | null; + /** + * Optional. The scheduling policy to use for jobs and queries running under this reservation. The scheduling policy controls how the reservation's resources are distributed. This feature is not yet generally available. + */ + schedulingPolicy?: Schema$SchedulingPolicy; /** * Optional. The current location of the reservation's secondary replica. This field is only set for reservations using the managed disaster recovery feature. Users can set this in create reservation calls to create a failover reservation or in update reservation calls to convert a non-failover reservation to a failover reservation(or vice versa). */ @@ -511,6 +519,19 @@ export namespace bigqueryreservation_v1 { */ name?: string | null; } + /** + * The scheduling policy controls how a reservation's resources are distributed. + */ + export interface Schema$SchedulingPolicy { + /** + * Optional. If present and \> 0, the reservation will attempt to limit the concurrency of jobs running for any particular project within it to the given value. This feature is not yet generally available. + */ + concurrency?: string | null; + /** + * Optional. If present and \> 0, the reservation will attempt to limit the slot consumption of queries running for any particular project within it to the given value. This feature is not yet generally available. + */ + maxSlots?: string | null; + } /** * The response for ReservationService.SearchAllAssignments. */ @@ -3230,6 +3251,7 @@ export namespace bigqueryreservation_v1 { * // "replicationStatus": {}, * // "reservationGroup": "my_reservationGroup", * // "scalingMode": "my_scalingMode", + * // "schedulingPolicy": {}, * // "secondaryLocation": "my_secondaryLocation", * // "slotCapacity": "my_slotCapacity", * // "updateTime": "my_updateTime" @@ -3254,6 +3276,7 @@ export namespace bigqueryreservation_v1 { * // "replicationStatus": {}, * // "reservationGroup": "my_reservationGroup", * // "scalingMode": "my_scalingMode", + * // "schedulingPolicy": {}, * // "secondaryLocation": "my_secondaryLocation", * // "slotCapacity": "my_slotCapacity", * // "updateTime": "my_updateTime" @@ -3558,6 +3581,7 @@ export namespace bigqueryreservation_v1 { * // "replicationStatus": {}, * // "reservationGroup": "my_reservationGroup", * // "scalingMode": "my_scalingMode", + * // "schedulingPolicy": {}, * // "secondaryLocation": "my_secondaryLocation", * // "slotCapacity": "my_slotCapacity", * // "updateTime": "my_updateTime" @@ -3718,6 +3742,7 @@ export namespace bigqueryreservation_v1 { * // "replicationStatus": {}, * // "reservationGroup": "my_reservationGroup", * // "scalingMode": "my_scalingMode", + * // "schedulingPolicy": {}, * // "secondaryLocation": "my_secondaryLocation", * // "slotCapacity": "my_slotCapacity", * // "updateTime": "my_updateTime" @@ -4171,6 +4196,7 @@ export namespace bigqueryreservation_v1 { * // "replicationStatus": {}, * // "reservationGroup": "my_reservationGroup", * // "scalingMode": "my_scalingMode", + * // "schedulingPolicy": {}, * // "secondaryLocation": "my_secondaryLocation", * // "slotCapacity": "my_slotCapacity", * // "updateTime": "my_updateTime" @@ -4195,6 +4221,7 @@ export namespace bigqueryreservation_v1 { * // "replicationStatus": {}, * // "reservationGroup": "my_reservationGroup", * // "scalingMode": "my_scalingMode", + * // "schedulingPolicy": {}, * // "secondaryLocation": "my_secondaryLocation", * // "slotCapacity": "my_slotCapacity", * // "updateTime": "my_updateTime" @@ -4774,6 +4801,7 @@ export namespace bigqueryreservation_v1 { * // "enableGeminiInBigquery": false, * // "jobType": "my_jobType", * // "name": "my_name", + * // "schedulingPolicy": {}, * // "state": "my_state" * // } * }, @@ -4787,6 +4815,7 @@ export namespace bigqueryreservation_v1 { * // "enableGeminiInBigquery": false, * // "jobType": "my_jobType", * // "name": "my_name", + * // "schedulingPolicy": {}, * // "state": "my_state" * // } * } @@ -5385,6 +5414,7 @@ export namespace bigqueryreservation_v1 { * // "enableGeminiInBigquery": false, * // "jobType": "my_jobType", * // "name": "my_name", + * // "schedulingPolicy": {}, * // "state": "my_state" * // } * } @@ -5532,6 +5562,7 @@ export namespace bigqueryreservation_v1 { * // "enableGeminiInBigquery": false, * // "jobType": "my_jobType", * // "name": "my_name", + * // "schedulingPolicy": {}, * // "state": "my_state" * // } * }, @@ -5545,6 +5576,7 @@ export namespace bigqueryreservation_v1 { * // "enableGeminiInBigquery": false, * // "jobType": "my_jobType", * // "name": "my_name", + * // "schedulingPolicy": {}, * // "state": "my_state" * // } * } diff --git a/src/apis/bigtableadmin/v2.ts b/src/apis/bigtableadmin/v2.ts index 1042acaf39..a76d7ca5e2 100644 --- a/src/apis/bigtableadmin/v2.ts +++ b/src/apis/bigtableadmin/v2.ts @@ -460,7 +460,7 @@ export namespace bigtableadmin_v2 { */ stats?: Schema$ColumnFamilyStats; /** - * The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + * The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. This field is mutually exclusive with `sql_type`. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations */ valueType?: Schema$Type; } @@ -15635,7 +15635,7 @@ export namespace bigtableadmin_v2 { * * // Do the magic * const res = await bigtableadmin.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -15757,7 +15757,7 @@ export namespace bigtableadmin_v2 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/chat/v1.ts b/src/apis/chat/v1.ts index c0e3bb6a41..9865eb4f46 100644 --- a/src/apis/chat/v1.ts +++ b/src/apis/chat/v1.ts @@ -1107,7 +1107,7 @@ export namespace chat_v1 { */ type?: string | null; /** - * Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + * The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). */ valueMsEpoch?: string | null; } @@ -2338,6 +2338,10 @@ export namespace chat_v1 { * Represents a space permission setting. */ export interface Schema$PermissionSetting { + /** + * Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. + */ + assistantManagersAllowed?: boolean | null; /** * Optional. Whether space owners (`ROLE_MANAGER`) have this permission. */ @@ -2586,7 +2590,7 @@ export namespace chat_v1 { */ createTime?: string | null; /** - * Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer\}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. + * Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer\}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users. */ customer?: string | null; /** diff --git a/src/apis/chromewebstore/index.ts b/src/apis/chromewebstore/index.ts index 3e2c3fe32b..5456328533 100644 --- a/src/apis/chromewebstore/index.ts +++ b/src/apis/chromewebstore/index.ts @@ -15,9 +15,11 @@ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; import {chromewebstore_v1_1} from './v1.1'; +import {chromewebstore_v2} from './v2'; export const VERSIONS = { 'v1.1': chromewebstore_v1_1.Chromewebstore, + v2: chromewebstore_v2.Chromewebstore, }; export function chromewebstore( @@ -26,9 +28,19 @@ export function chromewebstore( export function chromewebstore( options: chromewebstore_v1_1.Options ): chromewebstore_v1_1.Chromewebstore; -export function chromewebstore( +export function chromewebstore(version: 'v2'): chromewebstore_v2.Chromewebstore; +export function chromewebstore( + options: chromewebstore_v2.Options +): chromewebstore_v2.Chromewebstore; +export function chromewebstore< + T = chromewebstore_v1_1.Chromewebstore | chromewebstore_v2.Chromewebstore, +>( this: GoogleConfigurable, - versionOrOptions: 'v1.1' | chromewebstore_v1_1.Options + versionOrOptions: + | 'v1.1' + | chromewebstore_v1_1.Options + | 'v2' + | chromewebstore_v2.Options ) { return getAPI('chromewebstore', versionOrOptions, VERSIONS, this); } @@ -36,6 +48,7 @@ export function chromewebstore( const auth = new AuthPlus(); export {auth}; export {chromewebstore_v1_1}; +export {chromewebstore_v2}; export { AuthPlus, GlobalOptions, diff --git a/src/apis/chromewebstore/v2.ts b/src/apis/chromewebstore/v2.ts new file mode 100644 index 0000000000..97a9e0366c --- /dev/null +++ b/src/apis/chromewebstore/v2.ts @@ -0,0 +1,1134 @@ +// Copyright 2020 Google LLC +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/* eslint-disable @typescript-eslint/no-explicit-any */ +/* eslint-disable @typescript-eslint/no-unused-vars */ +/* eslint-disable @typescript-eslint/no-empty-interface */ +/* eslint-disable @typescript-eslint/no-namespace */ +/* eslint-disable no-irregular-whitespace */ + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, + BaseExternalAccountClient, + GaxiosResponseWithHTTP2, + GoogleConfigurable, + createAPIRequest, + MethodOptions, + StreamMethodOptions, + GlobalOptions, + GoogleAuth, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {Readable} from 'stream'; + +export namespace chromewebstore_v2 { + export interface Options extends GlobalOptions { + version: 'v2'; + } + + interface StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: + | string + | OAuth2Client + | JWT + | Compute + | UserRefreshClient + | BaseExternalAccountClient + | GoogleAuth; + + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + + /** + * Chrome Web Store API + * + * The Chrome Web Store API provides access to data about apps and extensions, as well as developer tools for managing them. + * + * @example + * ```js + * const {google} = require('googleapis'); + * const chromewebstore = google.chromewebstore('v2'); + * ``` + */ + export class Chromewebstore { + context: APIRequestContext; + media: Resource$Media; + publishers: Resource$Publishers; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.media = new Resource$Media(this.context); + this.publishers = new Resource$Publishers(this.context); + } + } + + /** + * Request message for CancelSubmission. + */ + export interface Schema$CancelSubmissionRequest {} + /** + * Response message for `CancelSubmission`. + */ + export interface Schema$CancelSubmissionResponse {} + /** + * Deployment information for a specific release channel. Used in requests to update deployment parameters. + */ + export interface Schema$DeployInfo { + /** + * Required. The current deploy percentage for the release channel (nonnegative number between 0 and 100). + */ + deployPercentage?: number | null; + } + /** + * Deployment information for a specific release channel + */ + export interface Schema$DistributionChannel { + /** + * The extension version provided in the manifest of the uploaded package. + */ + crxVersion?: string | null; + /** + * The current deploy percentage for the release channel (nonnegative number between 0 and 100). + */ + deployPercentage?: number | null; + } + /** + * Response message for `FetchItemStatus`. + */ + export interface Schema$FetchItemStatusResponse { + /** + * Output only. The ID of the item. + */ + itemId?: string | null; + /** + * Output only. The state of the last async upload for an item. Only set when there has been an async upload for the item in the past 24 hours. + */ + lastAsyncUploadState?: string | null; + /** + * The name of the requested item. + */ + name?: string | null; + /** + * The public key of the item, which may be generated by the store. + */ + publicKey?: string | null; + /** + * Output only. Status of the current published revision of the item. Will be unset if the item is not published. + */ + publishedItemRevisionStatus?: Schema$ItemRevisionStatus; + /** + * Status of the item revision submitted to be published. Will be unset if the item has not been submitted for publishing since the last successful publish. + */ + submittedItemRevisionStatus?: Schema$ItemRevisionStatus; + /** + * If true, the item has been taken down for a policy violation. Check the developer dashboard for details. + */ + takenDown?: boolean | null; + /** + * If true, the item has been warned for a policy violation and will be taken down if not resolved. Check the developer dashboard for details. + */ + warned?: boolean | null; + } + /** + * Details on the status of an item revision. + */ + export interface Schema$ItemRevisionStatus { + /** + * Details on the package of the item + */ + distributionChannels?: Schema$DistributionChannel[]; + /** + * Output only. Current state of the item + */ + state?: string | null; + } + /** + * Request message for PublishItem. + */ + export interface Schema$PublishItemRequest { + /** + * Optional. Additional deploy information including the desired initial percentage rollout. Defaults to the current value saved in the developer dashboard if unset. + */ + deployInfos?: Schema$DeployInfo[]; + /** + * Optional. Use this to control if the item is published immediately on approval or staged for publishing in the future. Defaults to `DEFAULT_PUBLISH` if unset. + */ + publishType?: string | null; + /** + * Optional. Whether to attempt to skip item review. The API will validate if the item qualifies and return a validation error if the item requires review. Defaults to `false` if unset. + */ + skipReview?: boolean | null; + } + /** + * Response message for `PublishItem`. + */ + export interface Schema$PublishItemResponse { + /** + * Output only. The ID of the item. + */ + itemId?: string | null; + /** + * The name of the item that was submitted + */ + name?: string | null; + /** + * Output only. The current state of the submission. + */ + state?: string | null; + } + /** + * Request message for SetPublishedDeployPercentage. + */ + export interface Schema$SetPublishedDeployPercentageRequest { + /** + * Required. Unscaled percentage value for the publised revision (nonnegative number between 0 and 100). It must be larger than the existing target percentage. + */ + deployPercentage?: number | null; + } + /** + * Response message for `SetPublishedDeployPercentage`. + */ + export interface Schema$SetPublishedDeployPercentageResponse {} + /** + * Request message for UploadItemPackage. + */ + export interface Schema$UploadItemPackageRequest {} + /** + * Response message for `UploadItemPackage`. + */ + export interface Schema$UploadItemPackageResponse { + /** + * The extension version provided in the manifest of the uploaded package. This will not be set if the upload is still in progress (`upload_state` is `UPLOAD_IN_PROGRESS`). + */ + crxVersion?: string | null; + /** + * Output only. The ID of the item the package was uploaded to. + */ + itemId?: string | null; + /** + * The name of the item the package was uploaded to. + */ + name?: string | null; + /** + * Output only. The state of the upload. If `upload_state` is `UPLOAD_IN_PROGRESS`, you can poll for updates using the fetchStatus method. + */ + uploadState?: string | null; + } + + export class Resource$Media { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Upload a new package to an existing item. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/chromewebstore.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const chromewebstore = google.chromewebstore('v2'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/chromewebstore'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await chromewebstore.media.upload({ + * // Required. Name of the item to upload the new package to in the form `publishers/{publisherId\}/items/{itemId\}` + * name: 'publishers/my-publisher/items/my-item', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * media: { + * mimeType: 'placeholder-value', + * body: 'placeholder-value', + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "crxVersion": "my_crxVersion", + * // "itemId": "my_itemId", + * // "name": "my_name", + * // "uploadState": "my_uploadState" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + upload( + params: Params$Resource$Media$Upload, + options: StreamMethodOptions + ): Promise>; + upload( + params?: Params$Resource$Media$Upload, + options?: MethodOptions + ): Promise>; + upload( + params: Params$Resource$Media$Upload, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + upload( + params: Params$Resource$Media$Upload, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + upload( + params: Params$Resource$Media$Upload, + callback: BodyResponseCallback + ): void; + upload( + callback: BodyResponseCallback + ): void; + upload( + paramsOrCallback?: + | Params$Resource$Media$Upload + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Media$Upload; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Media$Upload; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://chromewebstore.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}:upload').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + mediaUrl: (rootUrl + '/upload/v2/{+name}:upload').replace( + /([^:]\/)\/+/g, + '$1' + ), + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Media$Upload extends StandardParameters { + /** + * Required. Name of the item to upload the new package to in the form `publishers/{publisherId\}/items/{itemId\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UploadItemPackageRequest; + + /** + * Media metadata + */ + media?: { + /** + * Media mime-type + */ + mimeType?: string; + + /** + * Media body contents + */ + body?: any; + }; + } + + export class Resource$Publishers { + context: APIRequestContext; + items: Resource$Publishers$Items; + constructor(context: APIRequestContext) { + this.context = context; + this.items = new Resource$Publishers$Items(this.context); + } + } + + export class Resource$Publishers$Items { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Cancel the current active submission of an item if present. This can be used to cancel the review of a pending submission. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/chromewebstore.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const chromewebstore = google.chromewebstore('v2'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/chromewebstore'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await chromewebstore.publishers.items.cancelSubmission({ + * // Required. Name of the item to cancel the submission of in the form `publishers/{publisherId\}/items/{itemId\}` + * name: 'publishers/my-publisher/items/my-item', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancelSubmission( + params: Params$Resource$Publishers$Items$Cancelsubmission, + options: StreamMethodOptions + ): Promise>; + cancelSubmission( + params?: Params$Resource$Publishers$Items$Cancelsubmission, + options?: MethodOptions + ): Promise>; + cancelSubmission( + params: Params$Resource$Publishers$Items$Cancelsubmission, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancelSubmission( + params: Params$Resource$Publishers$Items$Cancelsubmission, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancelSubmission( + params: Params$Resource$Publishers$Items$Cancelsubmission, + callback: BodyResponseCallback + ): void; + cancelSubmission( + callback: BodyResponseCallback + ): void; + cancelSubmission( + paramsOrCallback?: + | Params$Resource$Publishers$Items$Cancelsubmission + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Publishers$Items$Cancelsubmission; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Publishers$Items$Cancelsubmission; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://chromewebstore.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}:cancelSubmission').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Fetch the status of an item. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/chromewebstore.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const chromewebstore = google.chromewebstore('v2'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/chromewebstore', + * 'https://www.googleapis.com/auth/chromewebstore.readonly', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await chromewebstore.publishers.items.fetchStatus({ + * // Required. Name of the item to retrieve the status of in the form `publishers/{publisherId\}/items/{itemId\}` + * name: 'publishers/my-publisher/items/my-item', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "itemId": "my_itemId", + * // "lastAsyncUploadState": "my_lastAsyncUploadState", + * // "name": "my_name", + * // "publicKey": "my_publicKey", + * // "publishedItemRevisionStatus": {}, + * // "submittedItemRevisionStatus": {}, + * // "takenDown": false, + * // "warned": false + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + fetchStatus( + params: Params$Resource$Publishers$Items$Fetchstatus, + options: StreamMethodOptions + ): Promise>; + fetchStatus( + params?: Params$Resource$Publishers$Items$Fetchstatus, + options?: MethodOptions + ): Promise>; + fetchStatus( + params: Params$Resource$Publishers$Items$Fetchstatus, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchStatus( + params: Params$Resource$Publishers$Items$Fetchstatus, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchStatus( + params: Params$Resource$Publishers$Items$Fetchstatus, + callback: BodyResponseCallback + ): void; + fetchStatus( + callback: BodyResponseCallback + ): void; + fetchStatus( + paramsOrCallback?: + | Params$Resource$Publishers$Items$Fetchstatus + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Publishers$Items$Fetchstatus; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Publishers$Items$Fetchstatus; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://chromewebstore.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}:fetchStatus').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Submit the item to be published in the store. The item will be submitted for review unless `skip_review` is set to true, or the item is staged from a previous submission with `publish_type` set to `STAGED_PUBLISH`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/chromewebstore.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const chromewebstore = google.chromewebstore('v2'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/chromewebstore'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await chromewebstore.publishers.items.publish({ + * // Required. Name of the item in the form `publishers/{publisherId\}/items/{itemId\}` + * name: 'publishers/my-publisher/items/my-item', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "deployInfos": [], + * // "publishType": "my_publishType", + * // "skipReview": false + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "itemId": "my_itemId", + * // "name": "my_name", + * // "state": "my_state" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + publish( + params: Params$Resource$Publishers$Items$Publish, + options: StreamMethodOptions + ): Promise>; + publish( + params?: Params$Resource$Publishers$Items$Publish, + options?: MethodOptions + ): Promise>; + publish( + params: Params$Resource$Publishers$Items$Publish, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + publish( + params: Params$Resource$Publishers$Items$Publish, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + publish( + params: Params$Resource$Publishers$Items$Publish, + callback: BodyResponseCallback + ): void; + publish(callback: BodyResponseCallback): void; + publish( + paramsOrCallback?: + | Params$Resource$Publishers$Items$Publish + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Publishers$Items$Publish; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Publishers$Items$Publish; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://chromewebstore.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}:publish').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Set a higher target deploy percentage for the item's published revision. This will be updated without the item being submitted for review. This is only available to items with over 10,000 seven-day active users. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/chromewebstore.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const chromewebstore = google.chromewebstore('v2'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/chromewebstore'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await chromewebstore.publishers.items.setPublishedDeployPercentage({ + * // Required. Name of the item to update the published revision of in the form `publishers/{publisherId\}/items/{itemId\}` + * name: 'publishers/my-publisher/items/my-item', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "deployPercentage": 0 + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setPublishedDeployPercentage( + params: Params$Resource$Publishers$Items$Setpublisheddeploypercentage, + options: StreamMethodOptions + ): Promise>; + setPublishedDeployPercentage( + params?: Params$Resource$Publishers$Items$Setpublisheddeploypercentage, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + setPublishedDeployPercentage( + params: Params$Resource$Publishers$Items$Setpublisheddeploypercentage, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setPublishedDeployPercentage( + params: Params$Resource$Publishers$Items$Setpublisheddeploypercentage, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setPublishedDeployPercentage( + params: Params$Resource$Publishers$Items$Setpublisheddeploypercentage, + callback: BodyResponseCallback + ): void; + setPublishedDeployPercentage( + callback: BodyResponseCallback + ): void; + setPublishedDeployPercentage( + paramsOrCallback?: + | Params$Resource$Publishers$Items$Setpublisheddeploypercentage + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Publishers$Items$Setpublisheddeploypercentage; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Publishers$Items$Setpublisheddeploypercentage; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://chromewebstore.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}:setPublishedDeployPercentage').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Publishers$Items$Cancelsubmission + extends StandardParameters { + /** + * Required. Name of the item to cancel the submission of in the form `publishers/{publisherId\}/items/{itemId\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CancelSubmissionRequest; + } + export interface Params$Resource$Publishers$Items$Fetchstatus + extends StandardParameters { + /** + * Required. Name of the item to retrieve the status of in the form `publishers/{publisherId\}/items/{itemId\}` + */ + name?: string; + } + export interface Params$Resource$Publishers$Items$Publish + extends StandardParameters { + /** + * Required. Name of the item in the form `publishers/{publisherId\}/items/{itemId\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PublishItemRequest; + } + export interface Params$Resource$Publishers$Items$Setpublisheddeploypercentage + extends StandardParameters { + /** + * Required. Name of the item to update the published revision of in the form `publishers/{publisherId\}/items/{itemId\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetPublishedDeployPercentageRequest; + } +} diff --git a/src/apis/cloudbuild/v2.ts b/src/apis/cloudbuild/v2.ts index c95db720c7..35a5c32ff1 100644 --- a/src/apis/cloudbuild/v2.ts +++ b/src/apis/cloudbuild/v2.ts @@ -1939,7 +1939,7 @@ export namespace cloudbuild_v2 { * * // Do the magic * const res = await cloudbuild.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -2067,7 +2067,7 @@ export namespace cloudbuild_v2 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/cloudfunctions/v1.ts b/src/apis/cloudfunctions/v1.ts index f68fa171a6..11e499c778 100644 --- a/src/apis/cloudfunctions/v1.ts +++ b/src/apis/cloudfunctions/v1.ts @@ -1103,7 +1103,7 @@ export namespace cloudfunctions_v1 { * * // Do the magic * const res = await cloudfunctions.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -1225,7 +1225,7 @@ export namespace cloudfunctions_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/cloudfunctions/v2.ts b/src/apis/cloudfunctions/v2.ts index 46137e6c0c..49de1bcdc9 100644 --- a/src/apis/cloudfunctions/v2.ts +++ b/src/apis/cloudfunctions/v2.ts @@ -1117,7 +1117,7 @@ export namespace cloudfunctions_v2 { * * // Do the magic * const res = await cloudfunctions.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -1239,7 +1239,7 @@ export namespace cloudfunctions_v2 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/cloudfunctions/v2alpha.ts b/src/apis/cloudfunctions/v2alpha.ts index 0d108a1e52..cc348d6308 100644 --- a/src/apis/cloudfunctions/v2alpha.ts +++ b/src/apis/cloudfunctions/v2alpha.ts @@ -251,6 +251,23 @@ export namespace cloudfunctions_v2alpha { * Request for the `DetachFunction` method. */ export interface Schema$DetachFunctionRequest {} + /** + * The Direct VPC network interface. This is mutually exclusive with VPC Connector. + */ + export interface Schema$DirectVpcNetworkInterface { + /** + * Optional. The name of the VPC network to which the function will be connected. Specify either a VPC network or a subnet, or both. If you specify only a network, the subnet uses the same name as the network. + */ + network?: string | null; + /** + * Optional. The name of the VPC subnetwork that the Cloud Function resource will get IPs from. Specify either a VPC network or a subnet, or both. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used. + */ + subnetwork?: string | null; + /** + * Optional. Network tags applied to this Cloud Function resource. + */ + tags?: string[] | null; + } /** * Filters events based on exact matches on the CloudEvents attributes. */ @@ -868,6 +885,14 @@ export namespace cloudfunctions_v2alpha { * Optional. The binary authorization policy to be checked when deploying the Cloud Run service. */ binaryAuthorizationPolicy?: string | null; + /** + * Optional. Egress settings for direct VPC. If not provided, it defaults to VPC_EGRESS_PRIVATE_RANGES_ONLY. + */ + directVpcEgress?: string | null; + /** + * Optional. The Direct VPC network interface for the Cloud Function. Currently only a single Direct VPC is supported. + */ + directVpcNetworkInterface?: Schema$DirectVpcNetworkInterface[]; /** * Environment variables that shall be available during function execution. */ @@ -1117,7 +1142,7 @@ export namespace cloudfunctions_v2alpha { * * // Do the magic * const res = await cloudfunctions.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -1239,7 +1264,7 @@ export namespace cloudfunctions_v2alpha { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/cloudfunctions/v2beta.ts b/src/apis/cloudfunctions/v2beta.ts index b27ed5a489..5a636b26c8 100644 --- a/src/apis/cloudfunctions/v2beta.ts +++ b/src/apis/cloudfunctions/v2beta.ts @@ -251,6 +251,23 @@ export namespace cloudfunctions_v2beta { * Request for the `DetachFunction` method. */ export interface Schema$DetachFunctionRequest {} + /** + * The Direct VPC network interface. This is mutually exclusive with VPC Connector. + */ + export interface Schema$DirectVpcNetworkInterface { + /** + * Optional. The name of the VPC network to which the function will be connected. Specify either a VPC network or a subnet, or both. If you specify only a network, the subnet uses the same name as the network. + */ + network?: string | null; + /** + * Optional. The name of the VPC subnetwork that the Cloud Function resource will get IPs from. Specify either a VPC network or a subnet, or both. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used. + */ + subnetwork?: string | null; + /** + * Optional. Network tags applied to this Cloud Function resource. + */ + tags?: string[] | null; + } /** * Filters events based on exact matches on the CloudEvents attributes. */ @@ -868,6 +885,14 @@ export namespace cloudfunctions_v2beta { * Optional. The binary authorization policy to be checked when deploying the Cloud Run service. */ binaryAuthorizationPolicy?: string | null; + /** + * Optional. Egress settings for direct VPC. If not provided, it defaults to VPC_EGRESS_PRIVATE_RANGES_ONLY. + */ + directVpcEgress?: string | null; + /** + * Optional. The Direct VPC network interface for the Cloud Function. Currently only a single Direct VPC is supported. + */ + directVpcNetworkInterface?: Schema$DirectVpcNetworkInterface[]; /** * Environment variables that shall be available during function execution. */ @@ -1117,7 +1142,7 @@ export namespace cloudfunctions_v2beta { * * // Do the magic * const res = await cloudfunctions.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -1239,7 +1264,7 @@ export namespace cloudfunctions_v2beta { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/cloudidentity/v1.ts b/src/apis/cloudidentity/v1.ts index 52517561bd..8f53fb48f9 100644 --- a/src/apis/cloudidentity/v1.ts +++ b/src/apis/cloudidentity/v1.ts @@ -11974,7 +11974,7 @@ export namespace cloudidentity_v1 { } /** - * Get a Policy + * Get a policy. * @example * ```js * // Before running the sample: @@ -12115,7 +12115,7 @@ export namespace cloudidentity_v1 { } /** - * List Policies + * List policies. * @example * ```js * // Before running the sample: diff --git a/src/apis/cloudidentity/v1beta1.ts b/src/apis/cloudidentity/v1beta1.ts index a086db7272..34562f458f 100644 --- a/src/apis/cloudidentity/v1beta1.ts +++ b/src/apis/cloudidentity/v1beta1.ts @@ -12645,7 +12645,292 @@ export namespace cloudidentity_v1beta1 { } /** - * Get a Policy + * Create a policy. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudidentity.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudidentity = google.cloudidentity('v1beta1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-identity.policies'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudidentity.policies.create({ + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "customer": "my_customer", + * // "name": "my_name", + * // "policyQuery": {}, + * // "setting": {}, + * // "type": "my_type" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Policies$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Policies$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Policies$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Policies$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Policies$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Policies$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Policies$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Policies$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudidentity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/policies').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Delete a policy. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudidentity.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudidentity = google.cloudidentity('v1beta1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-identity.policies'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudidentity.policies.delete({ + * // Required. The name of the policy to retrieve. Format: "policies/{policy\}". + * name: 'policies/my-policie', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Policies$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Policies$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Policies$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Policies$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Policies$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Policies$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Policies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Policies$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudidentity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Get a policy. * @example * ```js * // Before running the sample: @@ -12786,7 +13071,7 @@ export namespace cloudidentity_v1beta1 { } /** - * List Policies + * List policies. * @example * ```js * // Before running the sample: @@ -12928,8 +13213,170 @@ export namespace cloudidentity_v1beta1 { return createAPIRequest(parameters); } } + + /** + * Update a policy. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudidentity.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudidentity = google.cloudidentity('v1beta1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-identity.policies'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudidentity.policies.patch({ + * // Output only. Identifier. The [resource name](https://cloud.google.com/apis/design/resource_names) of the Policy. Format: policies/{policy\}. + * name: 'policies/my-policie', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "customer": "my_customer", + * // "name": "my_name", + * // "policyQuery": {}, + * // "setting": {}, + * // "type": "my_type" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Policies$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Policies$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Policies$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Policies$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Policies$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Policies$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Policies$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Policies$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudidentity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } + export interface Params$Resource$Policies$Create extends StandardParameters { + /** + * Request body metadata + */ + requestBody?: Schema$Policy; + } + export interface Params$Resource$Policies$Delete extends StandardParameters { + /** + * Required. The name of the policy to retrieve. Format: "policies/{policy\}". + */ + name?: string; + } export interface Params$Resource$Policies$Get extends StandardParameters { /** * Required. The name of the policy to retrieve. Format: "policies/{policy\}". @@ -12950,4 +13397,15 @@ export namespace cloudidentity_v1beta1 { */ pageToken?: string; } + export interface Params$Resource$Policies$Patch extends StandardParameters { + /** + * Output only. Identifier. The [resource name](https://cloud.google.com/apis/design/resource_names) of the Policy. Format: policies/{policy\}. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Policy; + } } diff --git a/src/apis/cloudlocationfinder/v1.ts b/src/apis/cloudlocationfinder/v1.ts index d4682611d0..bc0f40acfc 100644 --- a/src/apis/cloudlocationfinder/v1.ts +++ b/src/apis/cloudlocationfinder/v1.ts @@ -411,7 +411,7 @@ export namespace cloudlocationfinder_v1 { * * // Do the magic * const res = await cloudlocationfinder.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -540,7 +540,7 @@ export namespace cloudlocationfinder_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/cloudlocationfinder/v1alpha.ts b/src/apis/cloudlocationfinder/v1alpha.ts index ce598b7ba6..5a26b67d45 100644 --- a/src/apis/cloudlocationfinder/v1alpha.ts +++ b/src/apis/cloudlocationfinder/v1alpha.ts @@ -411,7 +411,7 @@ export namespace cloudlocationfinder_v1alpha { * * // Do the magic * const res = await cloudlocationfinder.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -540,7 +540,7 @@ export namespace cloudlocationfinder_v1alpha { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/cloudscheduler/v1.ts b/src/apis/cloudscheduler/v1.ts index 8d05b54f1e..f223ec3833 100644 --- a/src/apis/cloudscheduler/v1.ts +++ b/src/apis/cloudscheduler/v1.ts @@ -174,6 +174,19 @@ export namespace cloudscheduler_v1 { * The request message for Operations.CancelOperation. */ export interface Schema$CancelOperationRequest {} + /** + * Describes the project/location configuration of Cloud Scheduler Resources. + */ + export interface Schema$CmekConfig { + /** + * Optional. Resource name of the Cloud KMS key, of the form `projects/PROJECT_ID/locations/LOCATION_ID/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID`, that will be used to encrypt Jobs in the region. Setting this as blank will turn off CMEK encryption. + */ + kmsKeyName?: string | null; + /** + * Identifier. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig` + */ + name?: string | null; + } /** * 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); \} */ @@ -232,7 +245,7 @@ export namespace cloudscheduler_v1 { */ lastAttemptTime?: string | null; /** - * Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. + * Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling [locations.list](/scheduler/docs/reference/rest/v1/projects.locations/list). For more information, see [Cloud Scheduler locations](/scheduler/docs/locations). * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. */ name?: string | null; /** @@ -248,7 +261,7 @@ export namespace cloudscheduler_v1 { */ satisfiesPzs?: boolean | null; /** - * Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count \> 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure. + * Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count \> 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure. */ schedule?: string | null; /** @@ -475,7 +488,7 @@ export namespace cloudscheduler_v1 { */ export interface Schema$ResumeJobRequest {} /** - * Settings that determine the retry behavior. For more information, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. + * Settings that determine the retry behavior. For more information, see [Retry jobs](/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. */ export interface Schema$RetryConfig { /** @@ -483,7 +496,7 @@ export namespace cloudscheduler_v1 { */ maxBackoffDuration?: string | null; /** - * The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5. + * The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5. */ maxDoublings?: number | null; /** @@ -681,6 +694,142 @@ export namespace cloudscheduler_v1 { } } + /** + * Gets the Scheduler config in the project/region. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudscheduler.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudscheduler = google.cloudscheduler('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudscheduler.projects.locations.getCmekConfig({ + * // Required. The config name. For example: projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig + * name: 'projects/my-project/locations/my-location/cmekConfig', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "kmsKeyName": "my_kmsKeyName", + * // "name": "my_name" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getCmekConfig( + params: Params$Resource$Projects$Locations$Getcmekconfig, + options: StreamMethodOptions + ): Promise>; + getCmekConfig( + params?: Params$Resource$Projects$Locations$Getcmekconfig, + options?: MethodOptions + ): Promise>; + getCmekConfig( + params: Params$Resource$Projects$Locations$Getcmekconfig, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getCmekConfig( + params: Params$Resource$Projects$Locations$Getcmekconfig, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getCmekConfig( + params: Params$Resource$Projects$Locations$Getcmekconfig, + callback: BodyResponseCallback + ): void; + getCmekConfig(callback: BodyResponseCallback): void; + getCmekConfig( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Getcmekconfig + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Getcmekconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Getcmekconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudscheduler.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Lists information about the supported locations for this service. * @example @@ -712,7 +861,7 @@ export namespace cloudscheduler_v1 { * * // Do the magic * const res = await cloudscheduler.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -829,6 +978,156 @@ export namespace cloudscheduler_v1 { return createAPIRequest(parameters); } } + + /** + * Initializes or Updates the a scheduler config. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudscheduler.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudscheduler = google.cloudscheduler('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudscheduler.projects.locations.updateCmekConfig({ + * // Identifier. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig` + * name: 'projects/my-project/locations/my-location/cmekConfig', + * // Optional. List of fields to be updated in this request. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "kmsKeyName": "my_kmsKeyName", + * // "name": "my_name" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + updateCmekConfig( + params: Params$Resource$Projects$Locations$Updatecmekconfig, + options: StreamMethodOptions + ): Promise>; + updateCmekConfig( + params?: Params$Resource$Projects$Locations$Updatecmekconfig, + options?: MethodOptions + ): Promise>; + updateCmekConfig( + params: Params$Resource$Projects$Locations$Updatecmekconfig, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateCmekConfig( + params: Params$Resource$Projects$Locations$Updatecmekconfig, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateCmekConfig( + params: Params$Resource$Projects$Locations$Updatecmekconfig, + callback: BodyResponseCallback + ): void; + updateCmekConfig(callback: BodyResponseCallback): void; + updateCmekConfig( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Updatecmekconfig + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Updatecmekconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Updatecmekconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudscheduler.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Projects$Locations$Get @@ -838,10 +1137,17 @@ export namespace cloudscheduler_v1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Getcmekconfig + extends StandardParameters { + /** + * Required. The config name. For example: projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig + */ + name?: string; + } export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** @@ -861,6 +1167,22 @@ export namespace cloudscheduler_v1 { */ pageToken?: string; } + export interface Params$Resource$Projects$Locations$Updatecmekconfig + extends StandardParameters { + /** + * Identifier. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig` + */ + name?: string; + /** + * Optional. List of fields to be updated in this request. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CmekConfig; + } export class Resource$Projects$Locations$Jobs { context: APIRequestContext; @@ -1492,7 +1814,7 @@ export namespace cloudscheduler_v1 { * * // Do the magic * const res = await cloudscheduler.projects.locations.jobs.patch({ - * // Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. + * // Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling [locations.list](/scheduler/docs/reference/rest/v1/projects.locations/list). For more information, see [Cloud Scheduler locations](/scheduler/docs/locations). * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. * name: 'projects/my-project/locations/my-location/jobs/my-job', * // A mask used to specify which fields of the job are being updated. * updateMask: 'placeholder-value', @@ -2144,7 +2466,7 @@ export namespace cloudscheduler_v1 { export interface Params$Resource$Projects$Locations$Jobs$Patch extends StandardParameters { /** - * Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. + * Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling [locations.list](/scheduler/docs/reference/rest/v1/projects.locations/list). For more information, see [Cloud Scheduler locations](/scheduler/docs/locations). * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. */ name?: string; /** diff --git a/src/apis/cloudscheduler/v1beta1.ts b/src/apis/cloudscheduler/v1beta1.ts index 5972bec5ac..f67231c726 100644 --- a/src/apis/cloudscheduler/v1beta1.ts +++ b/src/apis/cloudscheduler/v1beta1.ts @@ -170,6 +170,10 @@ export namespace cloudscheduler_v1beta1 { */ version?: string | null; } + /** + * The request message for Operations.CancelOperation. + */ + export interface Schema$CancelOperationRequest {} /** * 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); \} */ @@ -232,7 +236,7 @@ export namespace cloudscheduler_v1beta1 { */ legacyAppEngineCron?: boolean | null; /** - * Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. + * Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling [locations.list](/scheduler/docs/reference/rest/v1beta1/projects.locations/list). For more information, see [Cloud Scheduler locations](/scheduler/docs/locations). * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. */ name?: string | null; /** @@ -248,7 +252,7 @@ export namespace cloudscheduler_v1beta1 { */ satisfiesPzs?: boolean | null; /** - * Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count \> 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure. + * Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count \> 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure. */ schedule?: string | null; /** @@ -298,6 +302,23 @@ export namespace cloudscheduler_v1beta1 { */ nextPageToken?: string | null; } + /** + * The response message for Operations.ListOperations. + */ + export interface Schema$ListOperationsResponse { + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + /** + * A list of operations that matches the specified filter in the request. + */ + operations?: Schema$Operation[]; + /** + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; + } /** * A resource that represents a Google Cloud location. */ @@ -349,6 +370,31 @@ export namespace cloudscheduler_v1beta1 { */ serviceAccountEmail?: string | null; } + /** + * This resource represents a long-running operation that is the result of a network API call. + */ + export interface Schema$Operation { + /** + * 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. + */ + done?: boolean | null; + /** + * The error result of the operation in case of failure or cancellation. + */ + error?: Schema$Status; + /** + * 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. + */ + metadata?: {[key: string]: any} | null; + /** + * 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\}`. + */ + name?: string | null; + /** + * 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`. + */ + response?: {[key: string]: any} | null; + } /** * Represents the metadata of the long-running operation. */ @@ -433,7 +479,7 @@ export namespace cloudscheduler_v1beta1 { */ export interface Schema$ResumeJobRequest {} /** - * Settings that determine the retry behavior. For more information, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. + * Settings that determine the retry behavior. For more information, see [Retry jobs](/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. */ export interface Schema$RetryConfig { /** @@ -441,7 +487,7 @@ export namespace cloudscheduler_v1beta1 { */ maxBackoffDuration?: string | null; /** - * The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5. + * The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5. */ maxDoublings?: number | null; /** @@ -496,9 +542,13 @@ export namespace cloudscheduler_v1beta1 { export class Resource$Projects$Locations { context: APIRequestContext; jobs: Resource$Projects$Locations$Jobs; + operations: Resource$Projects$Locations$Operations; constructor(context: APIRequestContext) { this.context = context; this.jobs = new Resource$Projects$Locations$Jobs(this.context); + this.operations = new Resource$Projects$Locations$Operations( + this.context + ); } /** @@ -671,7 +721,7 @@ export namespace cloudscheduler_v1beta1 { * * // Do the magic * const res = await cloudscheduler.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -800,7 +850,7 @@ export namespace cloudscheduler_v1beta1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** @@ -1466,7 +1516,7 @@ export namespace cloudscheduler_v1beta1 { * * // Do the magic * const res = await cloudscheduler.projects.locations.jobs.patch({ - * // Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. + * // Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling [locations.list](/scheduler/docs/reference/rest/v1beta1/projects.locations/list). For more information, see [Cloud Scheduler locations](/scheduler/docs/locations). * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. * name: 'projects/my-project/locations/my-location/jobs/my-job', * // A mask used to specify which fields of the job are being updated. * updateMask: 'placeholder-value', @@ -2146,7 +2196,7 @@ export namespace cloudscheduler_v1beta1 { export interface Params$Resource$Projects$Locations$Jobs$Patch extends StandardParameters { /** - * Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. + * Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling [locations.list](/scheduler/docs/reference/rest/v1beta1/projects.locations/list). For more information, see [Cloud Scheduler locations](/scheduler/docs/locations). * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. */ name?: string; /** @@ -2195,4 +2245,625 @@ export namespace cloudscheduler_v1beta1 { */ requestBody?: Schema$RunJobRequest; } + + export class Resource$Projects$Locations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudscheduler.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudscheduler = google.cloudscheduler('v1beta1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudscheduler.projects.locations.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/operations/my-operation', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Projects$Locations$Operations$Cancel, + options?: MethodOptions + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudscheduler.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:cancel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudscheduler.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudscheduler = google.cloudscheduler('v1beta1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudscheduler.projects.locations.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Operations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudscheduler.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudscheduler.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudscheduler = google.cloudscheduler('v1beta1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudscheduler.projects.locations.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Operations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Operations$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Operations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Operations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudscheduler.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/cloudscheduler.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const cloudscheduler = google.cloudscheduler('v1beta1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await cloudscheduler.projects.locations.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Operations$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Operations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudscheduler.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CancelOperationRequest; + } + export interface Params$Resource$Projects$Locations$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } } diff --git a/src/apis/cloudtasks/v2.ts b/src/apis/cloudtasks/v2.ts index 9cc144470d..b99242266f 100644 --- a/src/apis/cloudtasks/v2.ts +++ b/src/apis/cloudtasks/v2.ts @@ -1066,7 +1066,7 @@ export namespace cloudtasks_v2 { * * // Do the magic * const res = await cloudtasks.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -1347,7 +1347,7 @@ export namespace cloudtasks_v2 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/cloudtasks/v2beta2.ts b/src/apis/cloudtasks/v2beta2.ts index 96e12a9e91..bca9713c10 100644 --- a/src/apis/cloudtasks/v2beta2.ts +++ b/src/apis/cloudtasks/v2beta2.ts @@ -1373,7 +1373,7 @@ export namespace cloudtasks_v2beta2 { * * // Do the magic * const res = await cloudtasks.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -1654,7 +1654,7 @@ export namespace cloudtasks_v2beta2 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/cloudtasks/v2beta3.ts b/src/apis/cloudtasks/v2beta3.ts index 15ba157a41..a667f89bd9 100644 --- a/src/apis/cloudtasks/v2beta3.ts +++ b/src/apis/cloudtasks/v2beta3.ts @@ -1133,7 +1133,7 @@ export namespace cloudtasks_v2beta3 { * * // Do the magic * const res = await cloudtasks.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -1414,7 +1414,7 @@ export namespace cloudtasks_v2beta3 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/compute/alpha.ts b/src/apis/compute/alpha.ts index 82da7663a4..f372b75f1e 100644 --- a/src/apis/compute/alpha.ts +++ b/src/apis/compute/alpha.ts @@ -221,6 +221,8 @@ export namespace compute_alpha { reservations: Resource$Reservations; reservationSubBlocks: Resource$Reservationsubblocks; resourcePolicies: Resource$Resourcepolicies; + rolloutPlans: Resource$Rolloutplans; + rollouts: Resource$Rollouts; routers: Resource$Routers; routes: Resource$Routes; securityPolicies: Resource$Securitypolicies; @@ -433,6 +435,8 @@ export namespace compute_alpha { this.context ); this.resourcePolicies = new Resource$Resourcepolicies(this.context); + this.rolloutPlans = new Resource$Rolloutplans(this.context); + this.rollouts = new Resource$Rollouts(this.context); this.routers = new Resource$Routers(this.context); this.routes = new Resource$Routes(this.context); this.securityPolicies = new Resource$Securitypolicies(this.context); @@ -2899,7 +2903,7 @@ export namespace compute_alpha { export interface Schema$BackendBucketCdnPolicyNegativeCachingPolicy { /** * The HTTP status code to define a TTL against. Only HTTP status codes - * 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be + * 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be * specified as values, and you cannot specify a status code more than * once. */ @@ -3043,7 +3047,8 @@ export namespace compute_alpha { maxUtilization?: number | null; /** * Name of a custom utilization signal. The name must be 1-64 characters - * long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the + * long and match the regular expression + * `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the * first character must be a lowercase letter, and all following * characters must be a dash, period, underscore, lowercase letter, or * digit, except the last character, which cannot be a dash, period, or @@ -3835,7 +3840,7 @@ export namespace compute_alpha { export interface Schema$BackendServiceCdnPolicyNegativeCachingPolicy { /** * The HTTP status code to define a TTL against. Only HTTP status codes - * 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be + * 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be * specified as values, and you cannot specify a status code more than * once. */ @@ -3931,7 +3936,8 @@ export namespace compute_alpha { dryRun?: boolean | null; /** * Name of a custom utilization signal. The name must be 1-64 characters - * long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the + * long and match the regular expression + * `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the * first character must be a lowercase letter, and all following * characters must be a dash, period, underscore, lowercase letter, or * digit, except the last character, which cannot be a dash, period, or @@ -4481,25 +4487,24 @@ export namespace compute_alpha { */ authenticationConfig?: string | null; /** - * Assigns the Managed Identity for the RegionBackendService Workload. + * Assigns the Managed Identity for the BackendService Workload. * * * Use this property to configure the load balancer back-end to use * certificates and roots of trust provisioned by the Managed Workload * Identity system. * - * The `managedIdentity` property is the + * The `identity` property is the * fully-specified SPIFFE ID to use in the SVID presented by the Load * Balancer Workload. * * The SPIFFE ID must be a resource starting with the - * "spiffe" scheme identifier, followed by the "trustDomain" property value, - * followed by the path to the Managed Workload Identity. + * `trustDomain` property value, followed by the path to the Managed + * Workload Identity. * - * Supported - * SPIFFE ID format: + * Supported SPIFFE ID format: * - * - spiffe:///ns//sa/ + * - ///ns//sa/ * * * The Trust Domain within the Managed Identity must refer to a valid @@ -4508,14 +4513,14 @@ export namespace compute_alpha { * * Restrictions: * - * - If you set the `managedIdentity` property, you cannot manually set + * - If you set the `identity` property, you cannot manually set * the following fields: * - tlsSettings.sni * - tlsSettings.subjectAltNames * - tlsSettings.authenticationConfig * * - * When defining a `managedIdentity` for a RegionBackendServices, the + * When defining a `identity` for a RegionBackendServices, the * corresponding Workload Identity Pool must have a ca_pool * configured in the same region. * @@ -5317,7 +5322,8 @@ export namespace compute_alpha { */ obtainability?: number | null; /** - * The uptime score indicates the availability of your Spot VMs. For more + * The uptime score indicates the likelihood that your Spot VMs will + * continue to run without preemption within the next few hours. For more * information about the preemption process, see Preemption * of Spot VMs. * The score range is 0.0 through 1.0. Higher is better. @@ -10466,370 +10472,430 @@ export namespace compute_alpha { */ stackType?: string | null; } - export interface Schema$HaControllersFailoverRequest { - /** - * Name of the destination zone for the failover. - */ - primaryZone?: string | null; - } - export interface Schema$HaControllersList { + export interface Schema$HaControllersAggregatedList { etag?: string | null; - /** - * Unique identifier for the resource; defined by the server. - */ - id?: string | null; - /** - * A list of HaControllers in the specified project and region. - */ - items?: Schema$HaController[]; - /** - * This token allows you to get the next page of results formaxResults, use the nextPageToken as a value for - * the query parameter pageToken in the next list request. - * Subsequent list requests will have their own nextPageToken to - * continue paging through the results. - */ - nextPageToken?: string | null; - /** - * [Output only] Server-defined URL for this resource. - */ - selfLink?: string | null; - /** - * [Output only] Unreachable resources. - */ - unreachables?: string[] | null; - /** - * Informational warning message. - */ - warning?: { - code?: string; - data?: Array<{key?: string; value?: string}>; - message?: string; - } | null; - } - /** - * Contains information about current status of the HaController. - */ - export interface Schema$HaControllerStatus { - /** - * [Output Only] Contains the details of the ongoing failover. This message - * is not displayed if failover is NOT in progress. - */ - failoverProgress?: Schema$HaControllerStatusFailoverProgress; - /** - * [Output Only] Contains the details of the last successful failover. - */ - lastFailoverInfo?: Schema$HaControllerStatusFailoverProgress; - /** - * [Output Only] Indicates if the failover is currently in-progress. - */ - ongoingFailover?: boolean | null; - /** - * [Output Only] The URL to the instance that is intended to be primary at - * this moment. Primary instance will be changed at the very beginning of a - * failover operation. - */ - primaryInstance?: string | null; - /** - * [Output Only] The name of the zone that is intended to be primary at this - * moment. Primary zone will be changed at the very beginning of a failover - * operation. The zone may not be operational in the middle of a failover - * operation. - */ - primaryZone?: string | null; - /** - * [Output Only] Indicates if the resource is ready for initiating a - * failover to the secondary zone. - */ - readyForFailover?: boolean | null; - /** - * [Output Only] Map of zone statuses. - * Key: name of the zone - * Value: ZoneStatus - */ - zoneStatus?: {[key: string]: Schema$HaControllerStatusZoneStatus} | null; - } - /** - * Contains information about the current failover operation. - */ - export interface Schema$HaControllerStatusFailoverProgress { - /** - * [Output Only] Timestamp of the failover completion. - * Filled only if the failover is completed, in lastFailoverInfo. - */ - failoverCompleteTimestamp?: string | null; - /** - * [Output Only] Indicates if failover has been triggered automatically or - * manually. - */ - failoverTrigger?: string | null; - /** - * [Output Only] Timestamp of the last failover trigger. - */ - failoverTriggerTimestamp?: string | null; - /** - * [Output Only] Contains details of the last failed failover. This field - * is filled only if the current failover is failing - */ - lastFailoverAttempt?: Schema$HaControllerStatusFailoverProgressLastFailoverAttempt; - } - export interface Schema$HaControllerStatusFailoverProgressLastFailoverAttempt { - /** - * [Output Only] Encountered errors during the last attempt to process - * failover. - */ - errors?: { - errors?: Array<{ - code?: string; - errorDetails?: Array<{ - errorInfo?: Schema$ErrorInfo; - help?: Schema$Help; - localizedMessage?: Schema$LocalizedMessage; - quotaInfo?: Schema$QuotaExceededInfo; - }>; - location?: string; - message?: string; - }>; - } | null; - /** - * [Output Only] Show timestamp only if there is an error.RFC3339 - * text format. - */ - timestamp?: string | null; - } - /** - * Contains the status of a specific zone. - */ - export interface Schema$HaControllerStatusZoneStatus { - /** - * [Output Only] Indicates if the zone is primary at this moment. - */ - isPrimary?: boolean | null; - /** - * [Output Only] Indicates if the zone is ready for initiating a failover. - */ - isZoneReady?: boolean | null; - /** - * [Output Only] This field is filled only if the current operation is - * failing. - */ - lastError?: Schema$HaControllerStatusZoneStatusLastError; - } - /** - * Contains details of the last failed operation. - */ - export interface Schema$HaControllerStatusZoneStatusLastError { - /** - * [Output Only] Encountered errors. - */ - errors?: { - errors?: Array<{ - code?: string; - errorDetails?: Array<{ - errorInfo?: Schema$ErrorInfo; - help?: Schema$Help; - localizedMessage?: Schema$LocalizedMessage; - quotaInfo?: Schema$QuotaExceededInfo; - }>; - location?: string; - message?: string; - }>; - } | null; - /** - * [Output Only] Show timestamp only if there is an error.RFC3339 - * text format. - */ - timestamp?: string | null; - } - /** - * Config for a zone that the HaController may use for running the VM - * instance. - */ - export interface Schema$HaControllerZoneConfiguration { - /** - * A set of node affinity configurations. Refer toConfiguring node - * affinity for more information. - * Overrides reservationAffinity. - */ - nodeAffinities?: Schema$HaControllerZoneConfigurationNodeAffinity[]; - /** - * Specifies the reservations that the instance can consume from. - */ - reservationAffinity?: Schema$HaControllerZoneConfigurationReservationAffinity; - } - /** - * Node Affinity: the configuration of desired nodes onto which the - * Instance could be scheduled. - * This message should be an exact copy of the Instances representation - * of NodeAffinity. - * LINT.IfChange(HaControllerNodeAffinityMixer) - */ - export interface Schema$HaControllerZoneConfigurationNodeAffinity { - /** - * Corresponds to the label key of Node resource. - */ - key?: string | null; - /** - * Defines the operation of node selection. Valid operators areIN for affinity and NOT_IN for anti-affinity. - */ - operator?: string | null; - /** - * Corresponds to the label values of Node resource. - */ - values?: string[] | null; - } - /** - * Specifies the reservations that this instance can consume from. - * This message should be an exact copy of the Instances representation - * of AllocationAffinity. - * LINT.IfChange(HaControllerAllocationAffinityMixer) - */ - export interface Schema$HaControllerZoneConfigurationReservationAffinity { - /** - * Specifies the type of reservation from which this instance can consume - * resources: ANY_RESERVATION (default),SPECIFIC_RESERVATION, or NO_RESERVATION. See - * Consuming reserved instances for examples. - */ - consumeReservationType?: string | null; - /** - * Corresponds to the label key of a reservation resource. To target aSPECIFIC_RESERVATION by name, specifygoogleapis.com/reservation-name as the key and specify - * the name of your reservation as its value. - */ - key?: string | null; - /** - * Corresponds to the label values of a reservation resource. This can be - * either a name to a reservation in the same project or - * "projects/different-project/reservations/some-reservation-name" to - * target a shared reservation in the same zone but in a different - * project. - */ - values?: string[] | null; - } - export interface Schema$HealthAggregationPoliciesScopedList { - /** - * A list of HealthAggregationPolicys contained in this scope. - */ - healthAggregationPolicies?: Schema$HealthAggregationPolicy[]; - /** - * Informational warning which replaces the list of health aggregation - * policies when the list is empty. - */ - warning?: { - code?: string; - data?: Array<{key?: string; value?: string}>; - message?: string; - } | null; - } - /** - * Represents a health aggregation policy. - * - * A health aggregation policy resource defines a policy to aggregate health. - * - * For more information, see - * Health checks overview. - */ - export interface Schema$HealthAggregationPolicy { - /** - * [Output Only] Creation timestamp inRFC3339 - * text format. - */ - creationTimestamp?: string | null; - /** - * An optional description of this resource. Provide this property when you - * create the resource. - */ - description?: string | null; - /** - * Fingerprint of this resource. A hash of the contents stored in this object. - * This field is used in optimistic locking. This field will be ignored when - * inserting a HealthAggregationPolicy. An up-to-date fingerprint - * must be provided in order to patch the HealthAggregationPolicy; Otherwise, - * the request will fail with error 412 conditionNotMet. To see - * the latest fingerprint, make a get() request to retrieve the - * HealthAggregationPolicy. - */ - fingerprint?: string | null; - /** - * Can only be set if the policyType field isBACKEND_SERVICE_POLICY. Specifies the threshold (as a - * percentage) of healthy endpoints required in order to consider the - * aggregated health result HEALTHY. Defaults to 60. Must be in - * range [0, 100]. Not applicable if the policyType field isDNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional, - * and will be set to the default if unspecified. Note that both this - * threshold and minHealthyThreshold must be satisfied in order - * for HEALTHY to be the aggregated result. "Endpoints" refers to network - * endpoints within a Network Endpoint Group or instances within an Instance - * Group. - */ - healthyPercentThreshold?: number | null; - /** - * [Output Only] The unique identifier for the resource. This identifier is - * defined by the server. - */ - id?: string | null; - /** - * [Output Only] Type of the resource. Alwayscompute#healthAggregationPolicy for health aggregation - * policies. - */ - kind?: string | null; - /** - * Can only be set if the policyType field isBACKEND_SERVICE_POLICY. Specifies the minimum number of - * healthy endpoints required in order to consider the aggregated health - * result HEALTHY. Defaults to 1. Must be positive. Not - * applicable if the policyType field isDNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional, - * and will be set to the default if unspecified. Note that both this - * threshold and healthyPercentThreshold must be satisfied in - * order for HEALTHY to be the aggregated result. "Endpoints" refers to - * network endpoints within a Network Endpoint Group or instances within an - * Instance Group. - */ - minHealthyThreshold?: number | null; - /** - * Name of the resource. Provided by the client when the resource is created. - * The name must be 1-63 characters long, and comply withRFC1035. - * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first - * character must be a lowercase letter, and all following characters must - * be a dash, lowercase letter, or digit, except the last character, which - * cannot be a dash. - */ - name?: string | null; - /** - * Specifies the type of the healthAggregationPolicy. The only allowed value - * for global resources is DNS_PUBLIC_IP_POLICY. The only allowed - * value for regional resources is BACKEND_SERVICE_POLICY. Must - * be specified when the healthAggregationPolicy is created, and cannot be - * mutated. - */ - policyType?: string | null; - /** - * [Output Only] URL of the region where the health aggregation policy - * resides. This field applies only to the regional resource. You must specify - * this field as part of the HTTP request URL. It is not settable as a field - * in the request body. - */ - region?: string | null; - /** - * [Output Only] Server-defined URL for the resource. - */ - selfLink?: string | null; - /** - * [Output Only] Server-defined URL with id for the resource. - */ - selfLinkWithId?: string | null; - } - /** - * Contains a list of HealthAggregationPoliciesScopedList. - */ - export interface Schema$HealthAggregationPolicyAggregatedList { /** * [Output Only] Unique identifier for the resource; defined by the server. */ id?: string | null; /** - * A list of HealthAggregationPoliciesScopedList resources. + * A list of HaControllersScopedList resources. */ - items?: {[key: string]: Schema$HealthAggregationPoliciesScopedList} | null; + items?: {[key: string]: Schema$HaControllersScopedList} | null; /** - * Type of resource. + * [Output Only] Type of resource. Alwayscompute#haControllersAggregatedList for lists of + * HaControllers. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for + * list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for + * the query parameter pageToken in the next list request. + * Subsequent list requests will have their own nextPageToken to + * continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Unreachable resources. + */ + unreachables?: string[] | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$HaControllersFailoverRequest { + /** + * Name of the destination zone for the failover. + */ + failoverToZone?: string | null; + /** + * Name of the destination zone for the failover. + * Deprecated: use failover_to_zone instead. + */ + primaryZone?: string | null; + } + export interface Schema$HaControllersList { + etag?: string | null; + /** + * Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of HaControllers in the specified project and region. + */ + items?: Schema$HaController[]; + /** + * This token allows you to get the next page of results formaxResults, use the nextPageToken as a value for + * the query parameter pageToken in the next list request. + * Subsequent list requests will have their own nextPageToken to + * continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output only] Unreachable resources. + */ + unreachables?: string[] | null; + /** + * Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$HaControllersScopedList { + /** + * List of HaControllers contained in this scope. + */ + haControllers?: Schema$HaController[]; + /** + * Informational warning which replaces the list of + * backend services when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * Contains information about current status of the HaController. + */ + export interface Schema$HaControllerStatus { + /** + * [Output Only] Contains the details of the ongoing failover. This message + * is not displayed if failover is NOT in progress. + */ + failoverProgress?: Schema$HaControllerStatusFailoverProgress; + /** + * [Output Only] Contains the details of the last successful failover. + */ + lastFailoverInfo?: Schema$HaControllerStatusFailoverProgress; + /** + * [Output Only] Indicates if the failover is currently in-progress. + */ + ongoingFailover?: boolean | null; + /** + * [Output Only] The URL to the instance that is intended to be primary at + * this moment. Primary instance will be changed at the very beginning of a + * failover operation. + */ + primaryInstance?: string | null; + /** + * [Output Only] The name of the zone that is intended to be primary at this + * moment. Primary zone will be changed at the very beginning of a failover + * operation. The zone may not be operational in the middle of a failover + * operation. + */ + primaryZone?: string | null; + /** + * [Output Only] Indicates if the resource is ready for initiating a + * failover to the secondary zone. + */ + readyForFailover?: boolean | null; + /** + * [Output Only] Map of zone statuses. + * Key: name of the zone + * Value: ZoneStatus + */ + zoneStatus?: {[key: string]: Schema$HaControllerStatusZoneStatus} | null; + } + /** + * Contains information about the current failover operation. + */ + export interface Schema$HaControllerStatusFailoverProgress { + /** + * [Output Only] Timestamp of the failover completion. + * Filled only if the failover is completed, in lastFailoverInfo. + */ + failoverCompleteTimestamp?: string | null; + /** + * [Output Only] Indicates if failover has been triggered automatically or + * manually. + */ + failoverTrigger?: string | null; + /** + * [Output Only] Timestamp of the last failover trigger. + */ + failoverTriggerTimestamp?: string | null; + /** + * [Output Only] Contains details of the last failed failover. This field + * is filled only if the current failover is failing + */ + lastFailoverAttempt?: Schema$HaControllerStatusFailoverProgressLastFailoverAttempt; + } + export interface Schema$HaControllerStatusFailoverProgressLastFailoverAttempt { + /** + * [Output Only] Encountered errors during the last attempt to process + * failover. + */ + errors?: { + errors?: Array<{ + code?: string; + errorDetails?: Array<{ + errorInfo?: Schema$ErrorInfo; + help?: Schema$Help; + localizedMessage?: Schema$LocalizedMessage; + quotaInfo?: Schema$QuotaExceededInfo; + }>; + location?: string; + message?: string; + }>; + } | null; + /** + * [Output Only] Show timestamp only if there is an error.RFC3339 + * text format. + */ + timestamp?: string | null; + } + /** + * Contains the status of a specific zone. + */ + export interface Schema$HaControllerStatusZoneStatus { + /** + * [Output Only] Indicates if the zone is primary at this moment. + */ + isPrimary?: boolean | null; + /** + * [Output Only] Indicates if the zone is ready for initiating a failover. + */ + isZoneReady?: boolean | null; + /** + * [Output Only] This field is filled only if the current operation is + * failing. + */ + lastError?: Schema$HaControllerStatusZoneStatusLastError; + } + /** + * Contains details of the last failed operation. + */ + export interface Schema$HaControllerStatusZoneStatusLastError { + /** + * [Output Only] Encountered errors. + */ + errors?: { + errors?: Array<{ + code?: string; + errorDetails?: Array<{ + errorInfo?: Schema$ErrorInfo; + help?: Schema$Help; + localizedMessage?: Schema$LocalizedMessage; + quotaInfo?: Schema$QuotaExceededInfo; + }>; + location?: string; + message?: string; + }>; + } | null; + /** + * [Output Only] Show timestamp only if there is an error.RFC3339 + * text format. + */ + timestamp?: string | null; + } + /** + * Config for a zone that the HaController may use for running the VM + * instance. + */ + export interface Schema$HaControllerZoneConfiguration { + /** + * A set of node affinity configurations. Refer toConfiguring node + * affinity for more information. + * Overrides reservationAffinity. + */ + nodeAffinities?: Schema$HaControllerZoneConfigurationNodeAffinity[]; + /** + * Specifies the reservations that the instance can consume from. + */ + reservationAffinity?: Schema$HaControllerZoneConfigurationReservationAffinity; + } + /** + * Node Affinity: the configuration of desired nodes onto which the + * Instance could be scheduled. + * This message should be an exact copy of the Instances representation + * of NodeAffinity. + * LINT.IfChange(HaControllerNodeAffinityMixer) + */ + export interface Schema$HaControllerZoneConfigurationNodeAffinity { + /** + * Corresponds to the label key of Node resource. + */ + key?: string | null; + /** + * Defines the operation of node selection. Valid operators areIN for affinity and NOT_IN for anti-affinity. + */ + operator?: string | null; + /** + * Corresponds to the label values of Node resource. + */ + values?: string[] | null; + } + /** + * Specifies the reservations that this instance can consume from. + * This message should be an exact copy of the Instances representation + * of AllocationAffinity. + * LINT.IfChange(HaControllerAllocationAffinityMixer) + */ + export interface Schema$HaControllerZoneConfigurationReservationAffinity { + /** + * Specifies the type of reservation from which this instance can consume + * resources: ANY_RESERVATION (default),SPECIFIC_RESERVATION, or NO_RESERVATION. See + * Consuming reserved instances for examples. + */ + consumeReservationType?: string | null; + /** + * Corresponds to the label key of a reservation resource. To target aSPECIFIC_RESERVATION by name, specifygoogleapis.com/reservation-name as the key and specify + * the name of your reservation as its value. + */ + key?: string | null; + /** + * Corresponds to the label values of a reservation resource. This can be + * either a name to a reservation in the same project or + * "projects/different-project/reservations/some-reservation-name" to + * target a shared reservation in the same zone but in a different + * project. + */ + values?: string[] | null; + } + export interface Schema$HealthAggregationPoliciesScopedList { + /** + * A list of HealthAggregationPolicys contained in this scope. + */ + healthAggregationPolicies?: Schema$HealthAggregationPolicy[]; + /** + * Informational warning which replaces the list of health aggregation + * policies when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * Represents a health aggregation policy. + * + * A health aggregation policy resource defines a policy to aggregate health. + * + * For more information, see + * Health checks overview. + */ + export interface Schema$HealthAggregationPolicy { + /** + * [Output Only] Creation timestamp inRFC3339 + * text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you + * create the resource. + */ + description?: string | null; + /** + * Fingerprint of this resource. A hash of the contents stored in this object. + * This field is used in optimistic locking. This field will be ignored when + * inserting a HealthAggregationPolicy. An up-to-date fingerprint + * must be provided in order to patch the HealthAggregationPolicy; Otherwise, + * the request will fail with error 412 conditionNotMet. To see + * the latest fingerprint, make a get() request to retrieve the + * HealthAggregationPolicy. + */ + fingerprint?: string | null; + /** + * Can only be set if the policyType field isBACKEND_SERVICE_POLICY. Specifies the threshold (as a + * percentage) of healthy endpoints required in order to consider the + * aggregated health result HEALTHY. Defaults to 60. Must be in + * range [0, 100]. Not applicable if the policyType field isDNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional, + * and will be set to the default if unspecified. Note that both this + * threshold and minHealthyThreshold must be satisfied in order + * for HEALTHY to be the aggregated result. "Endpoints" refers to network + * endpoints within a Network Endpoint Group or instances within an Instance + * Group. + */ + healthyPercentThreshold?: number | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is + * defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of the resource. Alwayscompute#healthAggregationPolicy for health aggregation + * policies. + */ + kind?: string | null; + /** + * Can only be set if the policyType field isBACKEND_SERVICE_POLICY. Specifies the minimum number of + * healthy endpoints required in order to consider the aggregated health + * result HEALTHY. Defaults to 1. Must be positive. Not + * applicable if the policyType field isDNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional, + * and will be set to the default if unspecified. Note that both this + * threshold and healthyPercentThreshold must be satisfied in + * order for HEALTHY to be the aggregated result. "Endpoints" refers to + * network endpoints within a Network Endpoint Group or instances within an + * Instance Group. + */ + minHealthyThreshold?: number | null; + /** + * Name of the resource. Provided by the client when the resource is created. + * The name must be 1-63 characters long, and comply withRFC1035. + * Specifically, the name must be 1-63 characters long and match the regular + * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first + * character must be a lowercase letter, and all following characters must + * be a dash, lowercase letter, or digit, except the last character, which + * cannot be a dash. + */ + name?: string | null; + /** + * Specifies the type of the healthAggregationPolicy. The only allowed value + * for global resources is DNS_PUBLIC_IP_POLICY. The only allowed + * value for regional resources is BACKEND_SERVICE_POLICY. Must + * be specified when the healthAggregationPolicy is created, and cannot be + * mutated. + */ + policyType?: string | null; + /** + * [Output Only] URL of the region where the health aggregation policy + * resides. This field applies only to the regional resource. You must specify + * this field as part of the HTTP request URL. It is not settable as a field + * in the request body. + */ + region?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL with id for the resource. + */ + selfLinkWithId?: string | null; + } + /** + * Contains a list of HealthAggregationPoliciesScopedList. + */ + export interface Schema$HealthAggregationPolicyAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of HealthAggregationPoliciesScopedList resources. + */ + items?: {[key: string]: Schema$HealthAggregationPoliciesScopedList} | null; + /** + * Type of resource. */ kind?: string | null; /** @@ -13541,6 +13607,7 @@ export namespace compute_alpha { * upcoming maintenance for the instance. */ upcomingMaintenance?: Schema$UpcomingMaintenance; + workloadIdentityConfig?: Schema$WorkloadIdentityConfig; /** * [Output Only] URL of the zone where the instance resides. * You must specify this field as part of the HTTP request URL. It is @@ -14300,10 +14367,20 @@ export namespace compute_alpha { provisioningModelMix?: Schema$InstanceGroupManagerInstanceFlexibilityPolicyProvisioningModelMix; } export interface Schema$InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection { + /** + * List of disks to be attached to the instances created from this + * selection. + */ + disks?: Schema$AttachedDisk[]; /** * Full machine-type names, e.g. "n1-standard-16". */ machineTypes?: string[] | null; + /** + * Name of the minimum CPU platform to be used by this instance selection. + * e.g. 'Intel Ice Lake'. + */ + minCpuPlatform?: string | null; /** * Preference of this instance selection. Lower number means higher * preference. MIG will first try to create a VM based on the machine-type @@ -14401,6 +14478,12 @@ export namespace compute_alpha { export interface Schema$InstanceGroupManagerInstanceLifecyclePolicyOnRepair { /** * Specifies whether the MIG can change a VM's zone during a repair. + * Valid values are: + * + * - NO (default): MIG cannot change a VM's zone during a + * repair. + * - YES: MIG can select a different zone for the VM during + * a repair. */ allowChangingZone?: string | null; } @@ -15658,6 +15741,7 @@ export namespace compute_alpha { * the list must comply with RFC1035. */ tags?: Schema$Tags; + workloadIdentityConfig?: Schema$WorkloadIdentityConfig; } /** * Represents the change that you want to make to the instance properties. @@ -17189,6 +17273,8 @@ export namespace compute_alpha { * customer. * - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by * the partner. + * + * - L2_DEDICATED: a L2 attachment to a Dedicated Interconnect. */ type?: string | null; /** @@ -18214,7 +18300,7 @@ export namespace compute_alpha { * If provided when patching a configuration in update mode, the provided * token must match the current token or the update is rejected. This provides * a reliable means of doing read-modify-write (optimistic locking) as - * described byAPI 154. + * described by AIP 154. */ etag?: string | null; /** @@ -20392,10 +20478,19 @@ export namespace compute_alpha { trigger?: string | null; } export interface Schema$ManagedInstanceInstanceFlexibilityOverride { + /** + * List of disks to be attached to the instance. + */ + disks?: Schema$AttachedDisk[]; /** * The machine type to be used for this instance. */ machineType?: string | null; + /** + * Name of the minimum CPU platform to be used by this instance. + * e.g. 'Intel Ice Lake'. + */ + minCpuPlatform?: string | null; /** * The provisioning model to be used for this instance. */ @@ -22748,6 +22843,10 @@ export namespace compute_alpha { * purposes are supported. */ addressPurposes?: string[] | null; + /** + * Specifies whether address creation is allowed. + */ + allowAddressCreation?: string | null; /** * Specifies whether alias IP ranges (and secondary address ranges) are * allowed. @@ -22794,10 +22893,18 @@ export namespace compute_alpha { * Specifies whether cloud load balancing is allowed. */ allowLoadBalancing?: string | null; + /** + * Specifies whether multicast is allowed. + */ + allowMulticast?: string | null; /** * Specifies whether multi-nic in the same network is allowed. */ allowMultiNicInSameNetwork?: string | null; + /** + * Specifies whether multi-nic in the same subnetwork is allowed. + */ + allowMultiNicInSameSubnetwork?: string | null; /** * Specifies whether NCC is allowed. */ @@ -22830,6 +22937,10 @@ export namespace compute_alpha { * Specifies whether sub interfaces are allowed. */ allowSubInterfaces?: string | null; + /** + * Specifies whether subnetwork creation is allowed. + */ + allowSubnetworkCreation?: string | null; /** * Specifies whether VPC firewall rules can be created under the network. */ @@ -22848,6 +22959,18 @@ export namespace compute_alpha { * empty, all interface types are supported. */ interfaceTypes?: string[] | null; + /** + * Specifies which type of multicast is supported. + */ + multicast?: string | null; + /** + * Specifies a predefined internal IPv6 range for the network. + */ + predefinedNetworkInternalIpv6Range?: string | null; + /** + * Predefined subnetwork ranges for the network. + */ + predefinedSubnetworkRanges?: Schema$NetworkProfileNetworkFeaturesPredefinedSubnetworkRange[]; /** * Specifies which subnetwork purposes are supported. */ @@ -22869,6 +22992,16 @@ export namespace compute_alpha { */ unicast?: string | null; } + export interface Schema$NetworkProfileNetworkFeaturesPredefinedSubnetworkRange { + /** + * The IPv6 range of the predefined subnetwork. + */ + ipv6Range?: string | null; + /** + * The naming prefix of the predefined subnetwork. + */ + namePrefix?: string | null; + } export interface Schema$NetworkProfileProfileType { networkType?: string | null; rdmaSubtype?: string | null; @@ -28526,6 +28659,11 @@ export namespace compute_alpha { * It specifies the failure bucket separation */ export interface Schema$ResourcePolicyGroupPlacementPolicy { + /** + * Specifies the connection mode for the accelerator topology. If not + * specified, the default is AUTO_CONNECT. + */ + acceleratorTopologyMode?: string | null; /** * The number of availability domains to spread instances across. If two * instances are in different availability domain, they are not in the same @@ -29139,6 +29277,322 @@ export namespace compute_alpha { */ referenceUrl?: string | null; } + /** + * Represent a Rollout resource. + */ + export interface Schema$Rollout { + /** + * Output only. The timestamp at which the Rollout was cancelled. + */ + cancellationTime?: string | null; + /** + * Output only. The timestamp at which the Rollout was completed. + */ + completionTime?: string | null; + /** + * [Output Only] Creation timestamp inRFC3339 + * text format. + */ + creationTimestamp?: string | null; + /** + * Output only. The number of the currently running wave. + * Ex. 1 + */ + currentWaveNumber?: string | null; + /** + * An optional description of this resource. Provide this property when you + * create the resource. + */ + description?: string | null; + /** + * Output only. etag of the Rollout + * Ex. abc1234 + */ + etag?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is + * defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of the resource. Always compute#rollout + * for rollouts. + */ + kind?: string | null; + /** + * Name of the resource. Provided by the client when the resource is created. + * The name must be 1-63 characters long, and comply withRFC1035. + * Specifically, the name must be 1-63 characters long and match the regular + * expression `[a-z]([-a-z0-9]*[a-z0-9])?` + * which means the first character must be a lowercase letter, and all + * following characters must be a dash, lowercase letter, or digit, except + * the last character, which cannot be a dash. + */ + name?: string | null; + /** + * Required. The resource being rolled out. + */ + rolloutEntity?: Schema$RolloutRolloutEntity; + /** + * Required. Rollout Plan used to model the Rollout. + * Ex. progressiverollout.googleapis.com/v1/organizations/1/rolloutPlans + * Ex. progressiverollout.googleapis.com/v1/folders/1/rolloutPlans + */ + rolloutPlan?: string | null; + /** + * [Output Only] Server-defined fully-qualified URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource's resource id. + */ + selfLinkWithId?: string | null; + /** + * Output only. The current state of the Rollout. + */ + state?: string | null; + /** + * Output only. Details about each wave of the rollout. + */ + waveDetails?: Schema$RolloutWaveDetails[]; + } + /** + * Message describing RolloutPlan object + */ + export interface Schema$RolloutPlan { + /** + * [Output Only] Creation timestamp inRFC3339 + * text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you + * create the resource. + */ + description?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is + * defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of the resource. Always compute#rolloutPlan + * for rolloutPlans. + */ + kind?: string | null; + /** + * The location scope of the rollout plan. If not specified, the location + * scope is considered as ZONAL. + */ + locationScope?: string | null; + /** + * Name of the resource. Provided by the client when the resource is created. + * The name must be 1-63 characters long, and comply withRFC1035. + * Specifically, the name must be 1-63 characters long and match the regular + * expression `[a-z]([-a-z0-9]*[a-z0-9])?` + * which means the first character must be a lowercase letter, and all + * following characters must be a dash, lowercase letter, or digit, except + * the last character, which cannot be a dash. + */ + name?: string | null; + /** + * [Output Only] Server-defined fully-qualified URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource's resource id. + */ + selfLinkWithId?: string | null; + /** + * Required. The waves included in this rollout plan. + */ + waves?: Schema$RolloutPlanWave[]; + } + /** + * Contains a list of RolloutPlan resources. + */ + export interface Schema$RolloutPlansListResponse { + etag?: string | null; + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of RolloutPlan resources. + */ + items?: Schema$RolloutPlan[]; + /** + * [Output Only] This token allows you to get the next page of results for + * list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for + * the query parameter pageToken in the next list request. + * Subsequent list requests will have their own nextPageToken to + * continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Unreachable resources. + * end_interface: MixerListResponseWithEtagBuilder + */ + unreachables?: string[] | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * A single wave in a rollout plan. + */ + export interface Schema$RolloutPlanWave { + /** + * Optional. The display name of this wave of the rollout plan. + */ + displayName?: string | null; + /** + * Output only. The wave number. + */ + number?: string | null; + /** + * Optional. The orchestration options for this wave. + */ + orchestrationOptions?: Schema$RolloutPlanWaveOrchestrationOptions; + /** + * Required. The selectors for this wave. There is a logical AND between each selector + * defined in a wave, so a resource must satisfy the criteria of *all* the + * specified selectors to be in scope for the wave. + */ + selectors?: Schema$RolloutPlanWaveSelector[]; + /** + * Required. The validation to be performed at the end of this wave. + */ + validation?: Schema$RolloutPlanWaveValidation; + } + /** + * Options to control the pace of orchestration of a wave. These options are + * required only if the resource being rolled out follows the Orchestrated + * pattern. + */ + export interface Schema$RolloutPlanWaveOrchestrationOptions { + /** + * Optional. Delays, if any, to be added between batches of projects. We allow + * multiple Delays to be specified, letting users set separate delays + * between batches of projects corresponding to different locations and + * batches of projects corresponding to the same location. + */ + delays?: Schema$RolloutPlanWaveOrchestrationOptionsDelay[]; + /** + * Optional. Maximum number of locations to be orchestrated in parallel. + */ + maxConcurrentLocations?: string | null; + /** + * Optional. Maximum number of resources to be orchestrated per location in + * parallel. + */ + maxConcurrentResourcesPerLocation?: string | null; + } + /** + * Options to control the delay, if any, between batches of projects. + */ + export interface Schema$RolloutPlanWaveOrchestrationOptionsDelay { + /** + * Optional. Controls whether the delay should only be added between batches of + * projects corresponding to different locations, or also between + * batches of projects corresponding to the same location. + * + * Must be set to DELIMITER_UNSPECIFIED if no delay is to be added. + */ + delimiter?: string | null; + /** + * Optional. The duration of the delay, if any, to be added between batches of + * projects. A zero duration corresponds to no delay. + */ + duration?: string | null; + /** + * Optional. Controls whether the specified duration is to be added at the end of + * each batch, or if the total processing time for each batch will be + * padded if needed to meet the specified duration. + * + * Must be set to TYPE_UNSPECIFIED if no delay is to be added. + */ + type?: string | null; + } + /** + * A selector which specifies what resource(s) are included in a given wave. + */ + export interface Schema$RolloutPlanWaveSelector { + /** + * Optional. Roll out to resources by Cloud locations. + */ + locationSelector?: Schema$RolloutPlanWaveSelectorLocationSelector; + /** + * Optional. Roll out to resources by Cloud Resource Manager resource hierarchy. + */ + resourceHierarchySelector?: Schema$RolloutPlanWaveSelectorResourceHierarchySelector; + } + /** + * Roll out to resources by location. + */ + export interface Schema$RolloutPlanWaveSelectorLocationSelector { + /** + * Optional. Example: "us-central1-a" + */ + includedLocations?: string[] | null; + } + /** + * Roll out to resources by Cloud Resource Manager resource hierarchy + * nodes such as projects, folders, orgs. + */ + export interface Schema$RolloutPlanWaveSelectorResourceHierarchySelector { + /** + * Optional. Format: "folders/{folder_id\}" + */ + includedFolders?: string[] | null; + /** + * Optional. Format: "organizations/{organization_id\}" + */ + includedOrganizations?: string[] | null; + /** + * Optional. Format: "projects/{project_id\}" + */ + includedProjects?: string[] | null; + } + /** + * The validation to be performed before progressing to the next wave. + */ + export interface Schema$RolloutPlanWaveValidation { + /** + * Optional. Metadata required if type = "time". + */ + timeBasedValidationMetadata?: Schema$RolloutPlanWaveValidationTimeBasedValidationMetadata; + /** + * Required. The type of the validation. If a type of validation is associated with + * a metadata object, the appropriate metadata field mapping to the + * validation type must be provided in the validation message. Possible + * values are in quotes below alongside an explanation: + * "manual": The system waits for an end-user approval API before + * progressing to the next wave. + * "time": The system waits for a user specified duration before + * progressing to the next wave. TimeBasedValidation must be provided. + */ + type?: string | null; + } + /** + * Metadata required if type = "time". + */ + export interface Schema$RolloutPlanWaveValidationTimeBasedValidationMetadata { + /** + * Optional. The duration that the system waits in between waves. This wait starts + * after all changes in the wave are rolled out. + */ + waitDuration?: string | null; + } /** * A rollout policy configuration. */ @@ -29159,6 +29613,128 @@ export namespace compute_alpha { */ locationRolloutPolicies?: {[key: string]: string} | null; } + /** + * Specifications of the resource to roll out. + */ + export interface Schema$RolloutRolloutEntity { + /** + * Optional. Entity details for products using the Orchestrated Integration model. + */ + orchestratedEntity?: Schema$RolloutRolloutEntityOrchestratedEntity; + } + /** + * This message is used if the resource type follows the Orchestrated + * integration model with ProgressiveRollout. + */ + export interface Schema$RolloutRolloutEntityOrchestratedEntity { + /** + * Required. Specifies the behavior of the Rollout if an out of band update is + * detected in a project during a Rollout. It can be one of the following + * values: + * 1) overwrite : Overwrite the local value with the rollout value. + * 2) no_overwrite : Do not overwrite the local value with the rollout + * value. + */ + conflictBehavior?: string | null; + /** + * Required. Orchestration action during the Rollout. It can be one of the following + * values: + * 1) "update": Resources will be updated by the rollout. + * 2) "delete": Resources will be deleted by the rollout. + */ + orchestrationAction?: string | null; + /** + * Required. Fully qualified resource name of the resource which contains the source + * of truth of the configuration being rolled out across + * locations/projects. For example, in the case of a global Rollout which + * is applied across regions, this contains the name of the global + * resource created by the user which contains a payload for a resource + * that is orchestrated across regions. This follows the following format: + * //.googleapis.com/organizations//locations/global// + * e.g. + * //osconfig.googleapis.com/organizations/1/locations/global/policyOrchestrators/po1 + */ + orchestrationSource?: string | null; + } + export interface Schema$RolloutsListResponse { + etag?: string | null; + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of Rollout resources. + */ + items?: Schema$Rollout[]; + /** + * [Output Only] This token allows you to get the next page of results for + * list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for + * the query parameter pageToken in the next list request. + * Subsequent list requests will have their own nextPageToken to + * continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Unreachable resources. + * end_interface: MixerListResponseWithEtagBuilder + */ + unreachables?: string[] | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * Additional metadata about the status of each wave provided by the server. + */ + export interface Schema$RolloutWaveDetails { + /** + * Output only. Additional details of the wave for products using the Orchestrated + * Integration model. + */ + orchestratedWaveDetails?: Schema$RolloutWaveDetailsOrchestratedWaveDetails; + /** + * Output only. Wave name. + * Ex. wave1 + */ + waveDisplayName?: string | null; + /** + * Output only. System generated number for the wave. + */ + waveNumber?: string | null; + } + /** + * Details of the wave for products using the Orchestrated integration + * model. + */ + export interface Schema$RolloutWaveDetailsOrchestratedWaveDetails { + /** + * Output only. Resource completed so far. + */ + completedResourcesCount?: string | null; + /** + * Output only. Estimated total count of resources. + */ + estimatedTotalResourcesCount?: string | null; + /** + * Output only. Locations that failed during orchestration, and ProgressiveRollout + * stopped retrying. There may be some successful resources rolled out in + * the wave as the location may have failed later in the Rollout. + */ + failedLocations?: string[] | null; + /** + * Output only. Resources failed. + */ + failedResourcesCount?: string | null; + } /** * Represents a Route resource. * @@ -29328,7 +29904,9 @@ export namespace compute_alpha { */ priority?: number | null; /** - * [Output only] The status of the route. + * [Output only] The status of the route. This status only applies to + * dynamic routes learned by Cloud Routers. This status is not applicable + * to static routes. */ routeStatus?: string | null; /** @@ -39318,6 +39896,10 @@ export namespace compute_alpha { */ networkServiceClass?: string | null; } + export interface Schema$WorkloadIdentityConfig { + identity?: string | null; + identityCertificateEnabled?: boolean | null; + } export interface Schema$XpnHostList { /** * [Output Only] Unique identifier for the resource; defined by the server. @@ -39504,7 +40086,7 @@ export namespace compute_alpha { /** * Retrieves an aggregated list of accelerator types. * - * To prevent failure, Google recommends that you set the + * To prevent failure, it is recommended that you set the * `returnPartialSuccess` parameter to `true`. * @example * ```js @@ -40405,7 +40987,7 @@ export namespace compute_alpha { /** * Retrieves an aggregated list of addresses. * - * To prevent failure, Google recommends that you set the + * To prevent failure, it is recommended that you set the * `returnPartialSuccess` parameter to `true`. * @example * ```js @@ -42761,7 +43343,7 @@ export namespace compute_alpha { /** * Retrieves an aggregated list of autoscalers. * - * To prevent failure, Google recommends that you set the + * To prevent failure, it is recommended that you set the * `returnPartialSuccess` parameter to `true`. * @example * ```js @@ -48325,7 +48907,7 @@ export namespace compute_alpha { * Retrieves the list of all BackendService resources, regional and global, * available to the specified project. * - * To prevent failure, Google recommends that you set the + * To prevent failure, it is recommended that you set the * `returnPartialSuccess` parameter to `true`. * @example * ```js @@ -53607,7 +54189,7 @@ export namespace compute_alpha { /** * Retrieves an aggregated list of persistent disks. * - * To prevent failure, Google recommends that you set the + * To prevent failure, it is recommended that you set the * `returnPartialSuccess` parameter to `true`. * @example * ```js @@ -59042,7 +59624,7 @@ export namespace compute_alpha { /** * Retrieves an aggregated list of disk types. * - * To prevent failure, Google recommends that you set the + * To prevent failure, it is recommended that you set the * `returnPartialSuccess` parameter to `true`. * @example * ```js @@ -67649,7 +68231,7 @@ export namespace compute_alpha { /** * Retrieves an aggregated list of forwarding rules. * - * To prevent failure, Google recommends that you set the + * To prevent failure, it is recommended that you set the * `returnPartialSuccess` parameter to `true`. * @example * ```js @@ -69977,7 +70559,7 @@ export namespace compute_alpha { /** * Retrieves an aggregated list of future reservations. * - * To prevent failure, recommendation is that you set the + * To prevent failure, it is recommended that you set the * `returnPartialSuccess` parameter to `true`. * @example * ```js @@ -81237,29 +81819,17 @@ export namespace compute_alpha { * // a valid UUID with the exception that zero UUID is not supported * // (00000000-0000-0000-0000-000000000000). * requestId: 'placeholder-value', - * // Optional. [Optional] Specifies the behavior of the Rollout if a conflict is - * // detected in a project during a Rollout. It can be one of the following - * // values: - * // 1) empty : don't overwrite the local value if conflict happens. This is - * // the default behavior. - * // 2) "overwrite" : Overwrite the local value with the rollout value. - * // The concept of "conflict" applies to: - * // 1) Insert action. If the zonal policy already exists when Insert - * // happens, it's a conflict. - * // 2) Update action. If the zonal policy was updated out of band by a - * // zonal API, it's a conflict. - * 'rolloutInput.conflictBehavior': 'placeholder-value', - * // Optional. The name of the rollout plan. - * // Ex. - * // projects//locations/global/rolloutPlans/. - * 'rolloutInput.name': 'placeholder-value', - * // Optional. Predefined rollout plan. - * 'rolloutInput.predefinedRolloutPlan': 'placeholder-value', - * // Optional. The UUID of the retry action. Only set it if this is a retry - * // for an existing resource. This is for the user re-populate the resource - * // without changes. An error will be returned if the retry_uuid is set but - * // the resource get modified. - * 'rolloutInput.retryUuid': 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "conflictBehavior": "my_conflictBehavior", + * // "name": "my_name", + * // "predefinedRolloutPlan": "my_predefinedRolloutPlan", + * // "retryUuid": "my_retryUuid" + * // } + * }, * }); * console.log(res.data); * @@ -81368,9 +81938,9 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}' + '/compute/alpha/projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}/delete' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'POST', apiVersion: '', }, options @@ -82341,37 +82911,11 @@ export namespace compute_alpha { * (00000000-0000-0000-0000-000000000000). */ requestId?: string; + /** - * Optional. [Optional] Specifies the behavior of the Rollout if a conflict is - * detected in a project during a Rollout. It can be one of the following - * values: - * 1) empty : don't overwrite the local value if conflict happens. This is - * the default behavior. - * 2) "overwrite" : Overwrite the local value with the rollout value. - * The concept of "conflict" applies to: - * 1) Insert action. If the zonal policy already exists when Insert - * happens, it's a conflict. - * 2) Update action. If the zonal policy was updated out of band by a - * zonal API, it's a conflict. - */ - 'rolloutInput.conflictBehavior'?: string; - /** - * Optional. The name of the rollout plan. - * Ex. - * projects//locations/global/rolloutPlans/. - */ - 'rolloutInput.name'?: string; - /** - * Optional. Predefined rollout plan. - */ - 'rolloutInput.predefinedRolloutPlan'?: string; - /** - * Optional. The UUID of the retry action. Only set it if this is a retry - * for an existing resource. This is for the user re-populate the resource - * without changes. An error will be returned if the retry_uuid is set but - * the resource get modified. + * Request body metadata */ - 'rolloutInput.retryUuid'?: string; + requestBody?: Schema$GlobalVmExtensionPolicyRolloutOperationRolloutInput; } export interface Params$Resource$Globalvmextensionpolicies$Get extends StandardParameters { @@ -82556,6 +83100,259 @@ export namespace compute_alpha { this.context = context; } + /** + * Retrieves an aggregated list of all of the HaControllers in the specified + * project across all regions. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const compute = google.compute('alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await compute.haControllers.aggregatedList({ + * // A filter expression that filters resources listed in the response. Most + * // Compute resources support two types of filter expressions: + * // expressions that support regular expressions and expressions that follow + * // API improvement proposal AIP-160. + * // These two types of filter expressions cannot be mixed in one request. + * // + * // If you want to use AIP-160, your expression must specify the field name, an + * // operator, and the value that you want to use for filtering. The value + * // must be a string, a number, or a boolean. The operator + * // must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. + * // + * // For example, if you are filtering Compute Engine instances, you can + * // exclude instances named `example-instance` by specifying + * // `name != example-instance`. + * // + * // The `:*` comparison can be used to test whether a key has been defined. + * // For example, to find all objects with `owner` label use: + * // ``` + * // labels.owner:* + * // ``` + * // + * // You can also filter nested fields. For example, you could specify + * // `scheduling.automaticRestart = false` to include instances only + * // if they are not scheduled for automatic restarts. You can use filtering + * // on nested fields to filter based onresource labels. + * // + * // To filter on multiple expressions, provide each separate expression within + * // parentheses. For example: + * // ``` + * // (scheduling.automaticRestart = true) + * // (cpuPlatform = "Intel Skylake") + * // ``` + * // By default, each expression is an `AND` expression. However, you + * // can include `AND` and `OR` expressions explicitly. + * // For example: + * // ``` + * // (cpuPlatform = "Intel Skylake") OR + * // (cpuPlatform = "Intel Broadwell") AND + * // (scheduling.automaticRestart = true) + * // ``` + * // + * // If you want to use a regular expression, use the `eq` (equal) or `ne` + * // (not equal) operator against a single un-parenthesized expression with or + * // without quotes or against multiple parenthesized expressions. Examples: + * // + * // `fieldname eq unquoted literal` + * // `fieldname eq 'single quoted literal'` + * // `fieldname eq "double quoted literal"` + * // `(fieldname1 eq literal) (fieldname2 ne "literal")` + * // + * // The literal value is interpreted as a regular expression using GoogleRE2 library syntax. + * // The literal value must match the entire field. + * // + * // For example, to filter for instances that do not end with name "instance", + * // you would use `name ne .*instance`. + * // + * // You cannot combine constraints on multiple fields using regular + * // expressions. + * filter: 'placeholder-value', + * // Indicates whether every visible scope for each scope type (zone, region, + * // global) should be included in the response. For new resource types added + * // after this field, the flag has no effect as new resource types will always + * // include every visible scope for each scope type in response. For resource + * // types which predate this field, if this flag is omitted or false, only + * // scopes of the scope types where the resource type is expected to be found + * // will be included. + * includeAllScopes: 'placeholder-value', + * // The maximum number of results per page that should be returned. + * // If the number of available results is larger than `maxResults`, + * // Compute Engine returns a `nextPageToken` that can be used to get + * // the next page of results in subsequent list requests. Acceptable values are + * // `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results + * // are returned in alphanumerical order based on the resource name. + * // + * // You can also sort results in descending order based on the creation + * // timestamp using `orderBy="creationTimestamp desc"`. This sorts + * // results based on the `creationTimestamp` field in + * // reverse chronological order (newest result first). Use this to sort + * // resources like operations so that the newest operation is returned first. + * // + * // Currently, only sorting by `name` or + * // `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the + * // `nextPageToken` returned by a previous list request to get + * // the next page of results. + * pageToken: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Opt-in for partial success behavior which provides partial results in case + * // of failure. The default value is false. + * // + * // For example, when partial success behavior is enabled, aggregatedList for a + * // single zone scope either returns all resources in the zone or no resources, + * // with an error code. + * returnPartialSuccess: 'placeholder-value', + * // The Shared VPC service project id or service project number for which + * // aggregated list request is invoked for subnetworks list-usable api. + * serviceProjectNumber: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "etag": "my_etag", + * // "id": "my_id", + * // "items": {}, + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", + * // "selfLink": "my_selfLink", + * // "unreachables": [], + * // "warning": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + aggregatedList( + params: Params$Resource$Hacontrollers$Aggregatedlist, + options: StreamMethodOptions + ): Promise>; + aggregatedList( + params?: Params$Resource$Hacontrollers$Aggregatedlist, + options?: MethodOptions + ): Promise>; + aggregatedList( + params: Params$Resource$Hacontrollers$Aggregatedlist, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Hacontrollers$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Hacontrollers$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Hacontrollers$Aggregatedlist + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Hacontrollers$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Hacontrollers$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/aggregated/haControllers' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Deletes an HaController in the specified project. * @example @@ -82782,6 +83579,7 @@ export namespace compute_alpha { * requestBody: { * // request body parameters * // { + * // "failoverToZone": "my_failoverToZone", * // "primaryZone": "my_primaryZone" * // } * }, @@ -83708,6 +84506,126 @@ export namespace compute_alpha { } } + export interface Params$Resource$Hacontrollers$Aggregatedlist + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most + * Compute resources support two types of filter expressions: + * expressions that support regular expressions and expressions that follow + * API improvement proposal AIP-160. + * These two types of filter expressions cannot be mixed in one request. + * + * If you want to use AIP-160, your expression must specify the field name, an + * operator, and the value that you want to use for filtering. The value + * must be a string, a number, or a boolean. The operator + * must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. + * + * For example, if you are filtering Compute Engine instances, you can + * exclude instances named `example-instance` by specifying + * `name != example-instance`. + * + * The `:*` comparison can be used to test whether a key has been defined. + * For example, to find all objects with `owner` label use: + * ``` + * labels.owner:* + * ``` + * + * You can also filter nested fields. For example, you could specify + * `scheduling.automaticRestart = false` to include instances only + * if they are not scheduled for automatic restarts. You can use filtering + * on nested fields to filter based onresource labels. + * + * To filter on multiple expressions, provide each separate expression within + * parentheses. For example: + * ``` + * (scheduling.automaticRestart = true) + * (cpuPlatform = "Intel Skylake") + * ``` + * By default, each expression is an `AND` expression. However, you + * can include `AND` and `OR` expressions explicitly. + * For example: + * ``` + * (cpuPlatform = "Intel Skylake") OR + * (cpuPlatform = "Intel Broadwell") AND + * (scheduling.automaticRestart = true) + * ``` + * + * If you want to use a regular expression, use the `eq` (equal) or `ne` + * (not equal) operator against a single un-parenthesized expression with or + * without quotes or against multiple parenthesized expressions. Examples: + * + * `fieldname eq unquoted literal` + * `fieldname eq 'single quoted literal'` + * `fieldname eq "double quoted literal"` + * `(fieldname1 eq literal) (fieldname2 ne "literal")` + * + * The literal value is interpreted as a regular expression using GoogleRE2 library syntax. + * The literal value must match the entire field. + * + * For example, to filter for instances that do not end with name "instance", + * you would use `name ne .*instance`. + * + * You cannot combine constraints on multiple fields using regular + * expressions. + */ + filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, + * global) should be included in the response. For new resource types added + * after this field, the flag has no effect as new resource types will always + * include every visible scope for each scope type in response. For resource + * types which predate this field, if this flag is omitted or false, only + * scopes of the scope types where the resource type is expected to be found + * will be included. + */ + includeAllScopes?: boolean; + /** + * The maximum number of results per page that should be returned. + * If the number of available results is larger than `maxResults`, + * Compute Engine returns a `nextPageToken` that can be used to get + * the next page of results in subsequent list requests. Acceptable values are + * `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results + * are returned in alphanumerical order based on the resource name. + * + * You can also sort results in descending order based on the creation + * timestamp using `orderBy="creationTimestamp desc"`. This sorts + * results based on the `creationTimestamp` field in + * reverse chronological order (newest result first). Use this to sort + * resources like operations so that the newest operation is returned first. + * + * Currently, only sorting by `name` or + * `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the + * `nextPageToken` returned by a previous list request to get + * the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case + * of failure. The default value is false. + * + * For example, when partial success behavior is enabled, aggregatedList for a + * single zone scope either returns all resources in the zone or no resources, + * with an error code. + */ + returnPartialSuccess?: boolean; + /** + * The Shared VPC service project id or service project number for which + * aggregated list request is invoked for subnetworks list-usable api. + */ + serviceProjectNumber?: string; + } export interface Params$Resource$Hacontrollers$Delete extends StandardParameters { /** @@ -105392,6 +106310,7 @@ export namespace compute_alpha { * // "statusMessage": "my_statusMessage", * // "tags": {}, * // "upcomingMaintenance": {}, + * // "workloadIdentityConfig": {}, * // "zone": "my_zone" * // } * } @@ -106869,6 +107788,7 @@ export namespace compute_alpha { * // "statusMessage": "my_statusMessage", * // "tags": {}, * // "upcomingMaintenance": {}, + * // "workloadIdentityConfig": {}, * // "zone": "my_zone" * // } * }, @@ -112954,6 +113874,7 @@ export namespace compute_alpha { * // "statusMessage": "my_statusMessage", * // "tags": {}, * // "upcomingMaintenance": {}, + * // "workloadIdentityConfig": {}, * // "zone": "my_zone" * // } * }, @@ -143711,7 +144632,7 @@ export namespace compute_alpha { * firewall policies from all applicable scopes (global and regional) and * grouping the results per scope. * - * To prevent failure, Google recommends that you set the + * To prevent failure, it is recommended that you set the * `returnPartialSuccess` parameter to `true`. * @example * ```js @@ -166696,10 +167617,13 @@ export namespace compute_alpha { } /** + * Moves a persistent disk from one zone to another. + * *Note*: The moveDisk API will be deprecated on September 29, 2026. + * * Starting September 29, 2025, you can't use the moveDisk API on new * projects. To move a disk to a different region or zone, follow the steps in * [Change the location of a - * disk](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd). + * disk](https://cloud.google.com/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd). * * Projects that already use the moveDisk API can continue usage until * September 29, 2026. @@ -181077,7 +182001,7 @@ export namespace compute_alpha { /** * Retrieves an aggregated list of commitments by region. * - * To prevent failure, Google recommends that you set the + * To prevent failure, it is recommended that you set the * `returnPartialSuccess` parameter to `true`. * @example * ```js @@ -183347,7 +184271,7 @@ export namespace compute_alpha { * Retrieves the list of all CompositeHealthCheck resources (all * regional) available to the specified project. * - * To prevent failure, Google recommends that you set the + * To prevent failure, it is recommended that you set the * `returnPartialSuccess` parameter to `true`. * @example * ```js @@ -190697,7 +191621,7 @@ export namespace compute_alpha { * Retrieves the list of all HealthAggregationPolicy resources, * regional and global, available to the specified project. * - * To prevent failure, Google recommends that you set the + * To prevent failure, it is recommended that you set the * `returnPartialSuccess` parameter to `true`. * @example * ```js @@ -194172,7 +195096,7 @@ export namespace compute_alpha { * Retrieves the list of all HealthCheckService resources, * regional and global, available to the specified project. * - * To prevent failure, Google recommends that you set the + * To prevent failure, it is recommended that you set the * `returnPartialSuccess` parameter to `true`. * @example * ```js @@ -240997,7 +241921,7 @@ export namespace compute_alpha { /** * Retrieves an aggregated list of reservations. * - * To prevent failure, Google recommends that you set the + * To prevent failure, it is recommended that you set the * `returnPartialSuccess` parameter to `true`. * @example * ```js @@ -246802,17 +247726,1905 @@ export namespace compute_alpha { requestBody?: Schema$TestPermissionsRequest; } - export class Resource$Routers { + export class Resource$Rolloutplans { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Retrieves an aggregated list of routers. + * Deletes a RolloutPlan. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` * - * To prevent failure, Google recommends that you set the - * `returnPartialSuccess` parameter to `true`. + * const {google} = require('googleapis'); + * const compute = google.compute('alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await compute.rolloutPlans.delete({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so + * // that if you must retry your request, the server will know to ignore the + * // request if it has already been completed. + * // + * // For example, consider a situation where you make an initial request and + * // the request times out. If you make the request again with the same + * // request ID, the server can check if original operation with the same + * // request ID was received, and if so, will ignore the second request. This + * // prevents clients from accidentally creating duplicate commitments. + * // + * // The request ID must be + * // a valid UUID with the exception that zero UUID is not supported + * // (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // Name of the RolloutPlan resource to delete. + * rolloutPlan: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Rolloutplans$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Rolloutplans$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Rolloutplans$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Rolloutplans$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Rolloutplans$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Rolloutplans$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Rolloutplans$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Rolloutplans$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/global/rolloutPlans/{rolloutPlan}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'rolloutPlan'], + pathParams: ['project', 'rolloutPlan'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a single project-scoped RolloutPlan. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const compute = google.compute('alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await compute.rolloutPlans.get({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the persistent rollout plan to return. + * rolloutPlan: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "id": "my_id", + * // "kind": "my_kind", + * // "locationScope": "my_locationScope", + * // "name": "my_name", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "waves": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Rolloutplans$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Rolloutplans$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Rolloutplans$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Rolloutplans$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Rolloutplans$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Rolloutplans$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Rolloutplans$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Rolloutplans$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/global/rolloutPlans/{rolloutPlan}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'rolloutPlan'], + pathParams: ['project', 'rolloutPlan'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a new RolloutPlan in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const compute = google.compute('alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await compute.rolloutPlans.insert({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so + * // that if you must retry your request, the server will know to ignore the + * // request if it has already been completed. + * // + * // For example, consider a situation where you make an initial request and + * // the request times out. If you make the request again with the same + * // request ID, the server can check if original operation with the same + * // request ID was received, and if so, will ignore the second request. This + * // prevents clients from accidentally creating duplicate commitments. + * // + * // The request ID must be + * // a valid UUID with the exception that zero UUID is not supported + * // (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "id": "my_id", + * // "kind": "my_kind", + * // "locationScope": "my_locationScope", + * // "name": "my_name", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "waves": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + insert( + params: Params$Resource$Rolloutplans$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Rolloutplans$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Rolloutplans$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Rolloutplans$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Rolloutplans$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Rolloutplans$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Rolloutplans$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Rolloutplans$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/compute/alpha/projects/{project}/global/rolloutPlans' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists RolloutPlans in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const compute = google.compute('alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await compute.rolloutPlans.list({ + * // A filter expression that filters resources listed in the response. Most + * // Compute resources support two types of filter expressions: + * // expressions that support regular expressions and expressions that follow + * // API improvement proposal AIP-160. + * // These two types of filter expressions cannot be mixed in one request. + * // + * // If you want to use AIP-160, your expression must specify the field name, an + * // operator, and the value that you want to use for filtering. The value + * // must be a string, a number, or a boolean. The operator + * // must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. + * // + * // For example, if you are filtering Compute Engine instances, you can + * // exclude instances named `example-instance` by specifying + * // `name != example-instance`. + * // + * // The `:*` comparison can be used to test whether a key has been defined. + * // For example, to find all objects with `owner` label use: + * // ``` + * // labels.owner:* + * // ``` + * // + * // You can also filter nested fields. For example, you could specify + * // `scheduling.automaticRestart = false` to include instances only + * // if they are not scheduled for automatic restarts. You can use filtering + * // on nested fields to filter based onresource labels. + * // + * // To filter on multiple expressions, provide each separate expression within + * // parentheses. For example: + * // ``` + * // (scheduling.automaticRestart = true) + * // (cpuPlatform = "Intel Skylake") + * // ``` + * // By default, each expression is an `AND` expression. However, you + * // can include `AND` and `OR` expressions explicitly. + * // For example: + * // ``` + * // (cpuPlatform = "Intel Skylake") OR + * // (cpuPlatform = "Intel Broadwell") AND + * // (scheduling.automaticRestart = true) + * // ``` + * // + * // If you want to use a regular expression, use the `eq` (equal) or `ne` + * // (not equal) operator against a single un-parenthesized expression with or + * // without quotes or against multiple parenthesized expressions. Examples: + * // + * // `fieldname eq unquoted literal` + * // `fieldname eq 'single quoted literal'` + * // `fieldname eq "double quoted literal"` + * // `(fieldname1 eq literal) (fieldname2 ne "literal")` + * // + * // The literal value is interpreted as a regular expression using GoogleRE2 library syntax. + * // The literal value must match the entire field. + * // + * // For example, to filter for instances that do not end with name "instance", + * // you would use `name ne .*instance`. + * // + * // You cannot combine constraints on multiple fields using regular + * // expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. + * // If the number of available results is larger than `maxResults`, + * // Compute Engine returns a `nextPageToken` that can be used to get + * // the next page of results in subsequent list requests. Acceptable values are + * // `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results + * // are returned in alphanumerical order based on the resource name. + * // + * // You can also sort results in descending order based on the creation + * // timestamp using `orderBy="creationTimestamp desc"`. This sorts + * // results based on the `creationTimestamp` field in + * // reverse chronological order (newest result first). Use this to sort + * // resources like operations so that the newest operation is returned first. + * // + * // Currently, only sorting by `name` or + * // `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the + * // `nextPageToken` returned by a previous list request to get + * // the next page of results. + * pageToken: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Opt-in for partial success behavior which provides partial results in case + * // of failure. The default value is false. + * // + * // For example, when partial success behavior is enabled, aggregatedList for a + * // single zone scope either returns all resources in the zone or no resources, + * // with an error code. + * returnPartialSuccess: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "etag": "my_etag", + * // "id": "my_id", + * // "items": [], + * // "nextPageToken": "my_nextPageToken", + * // "selfLink": "my_selfLink", + * // "unreachables": [], + * // "warning": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Rolloutplans$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Rolloutplans$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Rolloutplans$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Rolloutplans$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Rolloutplans$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Rolloutplans$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Rolloutplans$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Rolloutplans$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/compute/alpha/projects/{project}/global/rolloutPlans' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Rolloutplans$Delete + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so + * that if you must retry your request, the server will know to ignore the + * request if it has already been completed. + * + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same + * request ID, the server can check if original operation with the same + * request ID was received, and if so, will ignore the second request. This + * prevents clients from accidentally creating duplicate commitments. + * + * The request ID must be + * a valid UUID with the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the RolloutPlan resource to delete. + */ + rolloutPlan?: string; + } + export interface Params$Resource$Rolloutplans$Get extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the persistent rollout plan to return. + */ + rolloutPlan?: string; + } + export interface Params$Resource$Rolloutplans$Insert + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so + * that if you must retry your request, the server will know to ignore the + * request if it has already been completed. + * + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same + * request ID, the server can check if original operation with the same + * request ID was received, and if so, will ignore the second request. This + * prevents clients from accidentally creating duplicate commitments. + * + * The request ID must be + * a valid UUID with the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RolloutPlan; + } + export interface Params$Resource$Rolloutplans$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most + * Compute resources support two types of filter expressions: + * expressions that support regular expressions and expressions that follow + * API improvement proposal AIP-160. + * These two types of filter expressions cannot be mixed in one request. + * + * If you want to use AIP-160, your expression must specify the field name, an + * operator, and the value that you want to use for filtering. The value + * must be a string, a number, or a boolean. The operator + * must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. + * + * For example, if you are filtering Compute Engine instances, you can + * exclude instances named `example-instance` by specifying + * `name != example-instance`. + * + * The `:*` comparison can be used to test whether a key has been defined. + * For example, to find all objects with `owner` label use: + * ``` + * labels.owner:* + * ``` + * + * You can also filter nested fields. For example, you could specify + * `scheduling.automaticRestart = false` to include instances only + * if they are not scheduled for automatic restarts. You can use filtering + * on nested fields to filter based onresource labels. + * + * To filter on multiple expressions, provide each separate expression within + * parentheses. For example: + * ``` + * (scheduling.automaticRestart = true) + * (cpuPlatform = "Intel Skylake") + * ``` + * By default, each expression is an `AND` expression. However, you + * can include `AND` and `OR` expressions explicitly. + * For example: + * ``` + * (cpuPlatform = "Intel Skylake") OR + * (cpuPlatform = "Intel Broadwell") AND + * (scheduling.automaticRestart = true) + * ``` + * + * If you want to use a regular expression, use the `eq` (equal) or `ne` + * (not equal) operator against a single un-parenthesized expression with or + * without quotes or against multiple parenthesized expressions. Examples: + * + * `fieldname eq unquoted literal` + * `fieldname eq 'single quoted literal'` + * `fieldname eq "double quoted literal"` + * `(fieldname1 eq literal) (fieldname2 ne "literal")` + * + * The literal value is interpreted as a regular expression using GoogleRE2 library syntax. + * The literal value must match the entire field. + * + * For example, to filter for instances that do not end with name "instance", + * you would use `name ne .*instance`. + * + * You cannot combine constraints on multiple fields using regular + * expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. + * If the number of available results is larger than `maxResults`, + * Compute Engine returns a `nextPageToken` that can be used to get + * the next page of results in subsequent list requests. Acceptable values are + * `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results + * are returned in alphanumerical order based on the resource name. + * + * You can also sort results in descending order based on the creation + * timestamp using `orderBy="creationTimestamp desc"`. This sorts + * results based on the `creationTimestamp` field in + * reverse chronological order (newest result first). Use this to sort + * resources like operations so that the newest operation is returned first. + * + * Currently, only sorting by `name` or + * `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the + * `nextPageToken` returned by a previous list request to get + * the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case + * of failure. The default value is false. + * + * For example, when partial success behavior is enabled, aggregatedList for a + * single zone scope either returns all resources in the zone or no resources, + * with an error code. + */ + returnPartialSuccess?: boolean; + } + + export class Resource$Rollouts { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Cancels a Rollout. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const compute = google.compute('alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await compute.rollouts.cancel({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so + * // that if you must retry your request, the server will know to ignore the + * // request if it has already been completed. + * // + * // For example, consider a situation where you make an initial request and + * // the request times out. If you make the request again with the same + * // request ID, the server can check if original operation with the same + * // request ID was received, and if so, will ignore the second request. This + * // prevents clients from accidentally creating duplicate commitments. + * // + * // The request ID must be + * // a valid UUID with the exception that zero UUID is not supported + * // (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // Optional. If true, then the ongoing rollout must be rolled back. Else, just cancel + * // the rollout without taking any further actions. Note that products must + * // support at least one of these options, however, it does not need to support + * // both. + * rollback: 'placeholder-value', + * // Name of the Rollout resource to cancel. + * rollout: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Rollouts$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Rollouts$Cancel, + options?: MethodOptions + ): Promise>; + cancel( + params: Params$Resource$Rollouts$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Rollouts$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Rollouts$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Rollouts$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Rollouts$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Rollouts$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/global/rollouts/{rollout}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'rollout'], + pathParams: ['project', 'rollout'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a Rollout. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const compute = google.compute('alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await compute.rollouts.delete({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so + * // that if you must retry your request, the server will know to ignore the + * // request if it has already been completed. + * // + * // For example, consider a situation where you make an initial request and + * // the request times out. If you make the request again with the same + * // request ID, the server can check if original operation with the same + * // request ID was received, and if so, will ignore the second request. This + * // prevents clients from accidentally creating duplicate commitments. + * // + * // The request ID must be + * // a valid UUID with the exception that zero UUID is not supported + * // (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // Name of the Rollout resource to delete. + * rollout: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Rollouts$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Rollouts$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Rollouts$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Rollouts$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Rollouts$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Rollouts$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Rollouts$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Rollouts$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/global/rollouts/{rollout}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'rollout'], + pathParams: ['project', 'rollout'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a single project-scoped Rollout. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const compute = google.compute('alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await compute.rollouts.get({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the persistent rollout to return. + * rollout: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "cancellationTime": "my_cancellationTime", + * // "completionTime": "my_completionTime", + * // "creationTimestamp": "my_creationTimestamp", + * // "currentWaveNumber": "my_currentWaveNumber", + * // "description": "my_description", + * // "etag": "my_etag", + * // "id": "my_id", + * // "kind": "my_kind", + * // "name": "my_name", + * // "rolloutEntity": {}, + * // "rolloutPlan": "my_rolloutPlan", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "state": "my_state", + * // "waveDetails": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Rollouts$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Rollouts$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Rollouts$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Rollouts$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Rollouts$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Rollouts$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Rollouts$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Rollouts$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/global/rollouts/{rollout}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'rollout'], + pathParams: ['project', 'rollout'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists Rollouts in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const compute = google.compute('alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await compute.rollouts.list({ + * // A filter expression that filters resources listed in the response. Most + * // Compute resources support two types of filter expressions: + * // expressions that support regular expressions and expressions that follow + * // API improvement proposal AIP-160. + * // These two types of filter expressions cannot be mixed in one request. + * // + * // If you want to use AIP-160, your expression must specify the field name, an + * // operator, and the value that you want to use for filtering. The value + * // must be a string, a number, or a boolean. The operator + * // must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. + * // + * // For example, if you are filtering Compute Engine instances, you can + * // exclude instances named `example-instance` by specifying + * // `name != example-instance`. + * // + * // The `:*` comparison can be used to test whether a key has been defined. + * // For example, to find all objects with `owner` label use: + * // ``` + * // labels.owner:* + * // ``` + * // + * // You can also filter nested fields. For example, you could specify + * // `scheduling.automaticRestart = false` to include instances only + * // if they are not scheduled for automatic restarts. You can use filtering + * // on nested fields to filter based onresource labels. + * // + * // To filter on multiple expressions, provide each separate expression within + * // parentheses. For example: + * // ``` + * // (scheduling.automaticRestart = true) + * // (cpuPlatform = "Intel Skylake") + * // ``` + * // By default, each expression is an `AND` expression. However, you + * // can include `AND` and `OR` expressions explicitly. + * // For example: + * // ``` + * // (cpuPlatform = "Intel Skylake") OR + * // (cpuPlatform = "Intel Broadwell") AND + * // (scheduling.automaticRestart = true) + * // ``` + * // + * // If you want to use a regular expression, use the `eq` (equal) or `ne` + * // (not equal) operator against a single un-parenthesized expression with or + * // without quotes or against multiple parenthesized expressions. Examples: + * // + * // `fieldname eq unquoted literal` + * // `fieldname eq 'single quoted literal'` + * // `fieldname eq "double quoted literal"` + * // `(fieldname1 eq literal) (fieldname2 ne "literal")` + * // + * // The literal value is interpreted as a regular expression using GoogleRE2 library syntax. + * // The literal value must match the entire field. + * // + * // For example, to filter for instances that do not end with name "instance", + * // you would use `name ne .*instance`. + * // + * // You cannot combine constraints on multiple fields using regular + * // expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. + * // If the number of available results is larger than `maxResults`, + * // Compute Engine returns a `nextPageToken` that can be used to get + * // the next page of results in subsequent list requests. Acceptable values are + * // `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results + * // are returned in alphanumerical order based on the resource name. + * // + * // You can also sort results in descending order based on the creation + * // timestamp using `orderBy="creationTimestamp desc"`. This sorts + * // results based on the `creationTimestamp` field in + * // reverse chronological order (newest result first). Use this to sort + * // resources like operations so that the newest operation is returned first. + * // + * // Currently, only sorting by `name` or + * // `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the + * // `nextPageToken` returned by a previous list request to get + * // the next page of results. + * pageToken: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Opt-in for partial success behavior which provides partial results in case + * // of failure. The default value is false. + * // + * // For example, when partial success behavior is enabled, aggregatedList for a + * // single zone scope either returns all resources in the zone or no resources, + * // with an error code. + * returnPartialSuccess: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "etag": "my_etag", + * // "id": "my_id", + * // "items": [], + * // "nextPageToken": "my_nextPageToken", + * // "selfLink": "my_selfLink", + * // "unreachables": [], + * // "warning": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Rollouts$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Rollouts$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Rollouts$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Rollouts$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Rollouts$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Rollouts$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Rollouts$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Rollouts$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/compute/alpha/projects/{project}/global/rollouts' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Rollouts$Cancel extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so + * that if you must retry your request, the server will know to ignore the + * request if it has already been completed. + * + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same + * request ID, the server can check if original operation with the same + * request ID was received, and if so, will ignore the second request. This + * prevents clients from accidentally creating duplicate commitments. + * + * The request ID must be + * a valid UUID with the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. If true, then the ongoing rollout must be rolled back. Else, just cancel + * the rollout without taking any further actions. Note that products must + * support at least one of these options, however, it does not need to support + * both. + */ + rollback?: boolean; + /** + * Name of the Rollout resource to cancel. + */ + rollout?: string; + } + export interface Params$Resource$Rollouts$Delete extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so + * that if you must retry your request, the server will know to ignore the + * request if it has already been completed. + * + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same + * request ID, the server can check if original operation with the same + * request ID was received, and if so, will ignore the second request. This + * prevents clients from accidentally creating duplicate commitments. + * + * The request ID must be + * a valid UUID with the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the Rollout resource to delete. + */ + rollout?: string; + } + export interface Params$Resource$Rollouts$Get extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the persistent rollout to return. + */ + rollout?: string; + } + export interface Params$Resource$Rollouts$List extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most + * Compute resources support two types of filter expressions: + * expressions that support regular expressions and expressions that follow + * API improvement proposal AIP-160. + * These two types of filter expressions cannot be mixed in one request. + * + * If you want to use AIP-160, your expression must specify the field name, an + * operator, and the value that you want to use for filtering. The value + * must be a string, a number, or a boolean. The operator + * must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. + * + * For example, if you are filtering Compute Engine instances, you can + * exclude instances named `example-instance` by specifying + * `name != example-instance`. + * + * The `:*` comparison can be used to test whether a key has been defined. + * For example, to find all objects with `owner` label use: + * ``` + * labels.owner:* + * ``` + * + * You can also filter nested fields. For example, you could specify + * `scheduling.automaticRestart = false` to include instances only + * if they are not scheduled for automatic restarts. You can use filtering + * on nested fields to filter based onresource labels. + * + * To filter on multiple expressions, provide each separate expression within + * parentheses. For example: + * ``` + * (scheduling.automaticRestart = true) + * (cpuPlatform = "Intel Skylake") + * ``` + * By default, each expression is an `AND` expression. However, you + * can include `AND` and `OR` expressions explicitly. + * For example: + * ``` + * (cpuPlatform = "Intel Skylake") OR + * (cpuPlatform = "Intel Broadwell") AND + * (scheduling.automaticRestart = true) + * ``` + * + * If you want to use a regular expression, use the `eq` (equal) or `ne` + * (not equal) operator against a single un-parenthesized expression with or + * without quotes or against multiple parenthesized expressions. Examples: + * + * `fieldname eq unquoted literal` + * `fieldname eq 'single quoted literal'` + * `fieldname eq "double quoted literal"` + * `(fieldname1 eq literal) (fieldname2 ne "literal")` + * + * The literal value is interpreted as a regular expression using GoogleRE2 library syntax. + * The literal value must match the entire field. + * + * For example, to filter for instances that do not end with name "instance", + * you would use `name ne .*instance`. + * + * You cannot combine constraints on multiple fields using regular + * expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. + * If the number of available results is larger than `maxResults`, + * Compute Engine returns a `nextPageToken` that can be used to get + * the next page of results in subsequent list requests. Acceptable values are + * `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results + * are returned in alphanumerical order based on the resource name. + * + * You can also sort results in descending order based on the creation + * timestamp using `orderBy="creationTimestamp desc"`. This sorts + * results based on the `creationTimestamp` field in + * reverse chronological order (newest result first). Use this to sort + * resources like operations so that the newest operation is returned first. + * + * Currently, only sorting by `name` or + * `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the + * `nextPageToken` returned by a previous list request to get + * the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case + * of failure. The default value is false. + * + * For example, when partial success behavior is enabled, aggregatedList for a + * single zone scope either returns all resources in the zone or no resources, + * with an error code. + */ + returnPartialSuccess?: boolean; + } + + export class Resource$Routers { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves an aggregated list of routers. + * + * To prevent failure, Google recommends that you set the + * `returnPartialSuccess` parameter to `true`. * @example * ```js * // Before running the sample: @@ -270605,6 +273417,12 @@ export namespace compute_alpha { * // The Shared VPC service project id or service project number for which * // aggregated list request is invoked for subnetworks list-usable api. * serviceProjectNumber: 'placeholder-value', + * // Defines the extra views returned back in the subnetwork resource. + * // Supported values: + * // + * // - WITH_UTILIZATION: Utilization data is included in the + * // response. + * views: 'placeholder-value', * }); * console.log(res.data); * @@ -273039,6 +275857,14 @@ export namespace compute_alpha { * aggregated list request is invoked for subnetworks list-usable api. */ serviceProjectNumber?: string; + /** + * Defines the extra views returned back in the subnetwork resource. + * Supported values: + * + * - WITH_UTILIZATION: Utilization data is included in the + * response. + */ + views?: string[]; } export interface Params$Resource$Subnetworks$Delete extends StandardParameters { diff --git a/src/apis/compute/beta.ts b/src/apis/compute/beta.ts index 61f79c07f5..2f8a13dcc6 100644 --- a/src/apis/compute/beta.ts +++ b/src/apis/compute/beta.ts @@ -137,6 +137,7 @@ export namespace compute_beta { globalOperations: Resource$Globaloperations; globalOrganizationOperations: Resource$Globalorganizationoperations; globalPublicDelegatedPrefixes: Resource$Globalpublicdelegatedprefixes; + globalVmExtensionPolicies: Resource$Globalvmextensionpolicies; healthChecks: Resource$Healthchecks; httpHealthChecks: Resource$Httphealthchecks; httpsHealthChecks: Resource$Httpshealthchecks; @@ -238,6 +239,7 @@ export namespace compute_beta { wireGroups: Resource$Wiregroups; zoneOperations: Resource$Zoneoperations; zones: Resource$Zones; + zoneVmExtensionPolicies: Resource$Zonevmextensionpolicies; constructor(options: GlobalOptions, google?: GoogleConfigurable) { this.context = { @@ -271,6 +273,9 @@ export namespace compute_beta { new Resource$Globalorganizationoperations(this.context); this.globalPublicDelegatedPrefixes = new Resource$Globalpublicdelegatedprefixes(this.context); + this.globalVmExtensionPolicies = new Resource$Globalvmextensionpolicies( + this.context + ); this.healthChecks = new Resource$Healthchecks(this.context); this.httpHealthChecks = new Resource$Httphealthchecks(this.context); this.httpsHealthChecks = new Resource$Httpshealthchecks(this.context); @@ -426,6 +431,9 @@ export namespace compute_beta { this.wireGroups = new Resource$Wiregroups(this.context); this.zoneOperations = new Resource$Zoneoperations(this.context); this.zones = new Resource$Zones(this.context); + this.zoneVmExtensionPolicies = new Resource$Zonevmextensionpolicies( + this.context + ); } } @@ -448,6 +456,41 @@ export namespace compute_beta { */ acceleratorType?: string | null; } + /** + * Info for accelerator topologies within a densely packed reservation. + */ + export interface Schema$AcceleratorTopologiesInfo { + /** + * Info for each accelerator topology. + */ + acceleratorTopologyInfos?: Schema$AcceleratorTopologiesInfoAcceleratorTopologyInfo[]; + } + /** + * Info for a slice of a given topology. + */ + export interface Schema$AcceleratorTopologiesInfoAcceleratorTopologyInfo { + /** + * The accelerator topology. + */ + acceleratorTopology?: string | null; + /** + * Info for each topology state. + */ + infoPerTopologyStates?: Schema$AcceleratorTopologiesInfoAcceleratorTopologyInfoInfoPerTopologyState[]; + } + /** + * Info for each topology state. + */ + export interface Schema$AcceleratorTopologiesInfoAcceleratorTopologyInfoInfoPerTopologyState { + /** + * The number of accelerator topologies in this state. + */ + count?: number | null; + /** + * The state of the accelerator topology. + */ + state?: string | null; + } /** * Represents an Accelerator Type resource. * @@ -2488,6 +2531,13 @@ export namespace compute_beta { * as part of resource payload. */ params?: Schema$BackendBucketParams; + /** + * [Output Only] URL of the region where the regional backend bucket + * resides. This field is not applicable to global backend buckets. + * You must specify this field as part of the HTTP request URL. It is + * not settable as a field in the request body. + */ + region?: string | null; /** * [Output Only] Server-defined URL for the resource. */ @@ -2703,7 +2753,7 @@ export namespace compute_beta { export interface Schema$BackendBucketCdnPolicyNegativeCachingPolicy { /** * The HTTP status code to define a TTL against. Only HTTP status codes - * 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be + * 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be * specified as values, and you cannot specify a status code more than * once. */ @@ -2847,7 +2897,8 @@ export namespace compute_beta { maxUtilization?: number | null; /** * Name of a custom utilization signal. The name must be 1-64 characters - * long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the + * long and match the regular expression + * `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the * first character must be a lowercase letter, and all following * characters must be a dash, period, underscore, lowercase letter, or * digit, except the last character, which cannot be a dash, period, or @@ -3617,7 +3668,7 @@ export namespace compute_beta { export interface Schema$BackendServiceCdnPolicyNegativeCachingPolicy { /** * The HTTP status code to define a TTL against. Only HTTP status codes - * 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be + * 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be * specified as values, and you cannot specify a status code more than * once. */ @@ -3713,7 +3764,8 @@ export namespace compute_beta { dryRun?: boolean | null; /** * Name of a custom utilization signal. The name must be 1-64 characters - * long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the + * long and match the regular expression + * `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the * first character must be a lowercase letter, and all following * characters must be a dash, period, underscore, lowercase letter, or * digit, except the last character, which cannot be a dash, period, or @@ -4233,6 +4285,47 @@ export namespace compute_beta { * field. Can only be specified if authenticationMode is not NONE. */ authenticationConfig?: string | null; + /** + * Assigns the Managed Identity for the BackendService Workload. + * + * + * Use this property to configure the load balancer back-end to use + * certificates and roots of trust provisioned by the Managed Workload + * Identity system. + * + * The `identity` property is the + * fully-specified SPIFFE ID to use in the SVID presented by the Load + * Balancer Workload. + * + * The SPIFFE ID must be a resource starting with the + * `trustDomain` property value, followed by the path to the Managed + * Workload Identity. + * + * Supported SPIFFE ID format: + * + * - ///ns//sa/ + * + * + * The Trust Domain within the Managed Identity must refer to a valid + * Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig + * will be inherited from the Workload Identity Pool. + * + * Restrictions: + * + * - If you set the `identity` property, you cannot manually set + * the following fields: + * - tlsSettings.sni + * - tlsSettings.subjectAltNames + * - tlsSettings.authenticationConfig + * + * + * When defining a `identity` for a RegionBackendServices, the + * corresponding Workload Identity Pool must have a ca_pool + * configured in the same region. + * + * The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity. + */ + identity?: string | null; /** * Server Name Indication - see RFC3546 section 3.1. If set, the load * balancer sends this string as the SNI hostname in the TLS connection to @@ -5281,6 +5374,10 @@ export namespace compute_beta { * [Output Only] Server-defined URL for this resource. */ selfLink?: string | null; + /** + * [Output Only] Unreachable resources. + */ + unreachables?: string[] | null; /** * [Output Only] Informational warning message. */ @@ -9067,6 +9164,195 @@ export namespace compute_beta { */ policy?: Schema$Policy; } + /** + * Message describing GlobalVmExtensionPolicy object. + */ + export interface Schema$GlobalVmExtensionPolicy { + /** + * [Output Only] Creation timestamp inRFC3339 + * text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you + * create the resource. + */ + description?: string | null; + /** + * Required. Map from extension (eg: "cloudops") to its policy configuration. + * The key is the name of the extension. + */ + extensionPolicies?: { + [key: string]: Schema$GlobalVmExtensionPolicyExtensionPolicy; + } | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is + * defined by the server. + */ + id?: string | null; + /** + * Optional. Selector to target VMs for a policy. + * There is a logical "AND" between instance_selectors. + */ + instanceSelectors?: Schema$GlobalVmExtensionPolicyInstanceSelector[]; + /** + * [Output Only] Type of the resource. Alwayscompute#globalVmExtensionPolicy for globalVmExtensionPolicies. + */ + kind?: string | null; + /** + * Name of the resource. Provided by the client when the resource is created. + * The name must be 1-63 characters long, and comply withRFC1035. + * Specifically, the name must be 1-63 characters long and match the regular + * expression `[a-z]([-a-z0-9]*[a-z0-9])?` + * which means the first character must be a lowercase letter, and all + * following characters must be a dash, lowercase letter, or digit, except + * the last character, which cannot be a dash. + */ + name?: string | null; + /** + * Optional. Used to resolve conflicts when multiple policies are active for the same + * extension. Defaults to 0. + * + * Larger the number, higher the priority. When the priority is the same, + * the policy with the newer create time has higher priority. + */ + priority?: number | null; + /** + * Required. The rollout strategy and status. + */ + rolloutOperation?: Schema$GlobalVmExtensionPolicyRolloutOperation; + /** + * [Output Only] The scoped resource status. It's only for tracking the + * purging status of the policy. + */ + scopedResourceStatus?: string | null; + /** + * [Output Only] Server-defined fully-qualified URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource's resource id. + */ + selfLinkWithId?: string | null; + /** + * [Output Only] Update timestamp inRFC3339 + * text format. + */ + updateTimestamp?: string | null; + } + /** + * Policy for a single extension. + */ + export interface Schema$GlobalVmExtensionPolicyExtensionPolicy { + /** + * Optional. The version pinning for the extension. + * If empty, the extension will be installed with the latest version + * released by the extension producer. + */ + pinnedVersion?: string | null; + /** + * Optional. String configuration. Any string payload that the extension + * understands. + */ + stringConfig?: string | null; + } + /** + * Selector to target VMs for a zone VM extension policy. + */ + export interface Schema$GlobalVmExtensionPolicyInstanceSelector { + /** + * Optional. Labels within the LabelSelector are OR'd. + */ + labelSelector?: Schema$GlobalVmExtensionPolicyLabelSelector; + } + /** + * A LabelSelector is applicable for a VM only if it matches all labels in + * the LabelSelector. + */ + export interface Schema$GlobalVmExtensionPolicyLabelSelector { + /** + * Optional. Labels as key value pairs. + * A VM should contain all the pairs specified in this map to be selected; + * Labels within the LabelSelector are OR'ed. + */ + inclusionLabels?: {[key: string]: string} | null; + } + /** + * Represents the rollout operation + */ + export interface Schema$GlobalVmExtensionPolicyRolloutOperation { + /** + * Required. The rollout input which defines the rollout plan. + */ + rolloutInput?: Schema$GlobalVmExtensionPolicyRolloutOperationRolloutInput; + /** + * [Output Only] The rollout status of the policy. + */ + rolloutStatus?: Schema$GlobalVmExtensionPolicyRolloutOperationRolloutStatus; + } + export interface Schema$GlobalVmExtensionPolicyRolloutOperationRolloutInput { + /** + * Optional. [Optional] Specifies the behavior of the Rollout if a conflict is + * detected in a project during a Rollout. It can be one of the following + * values: + * 1) empty : don't overwrite the local value if conflict happens. This is + * the default behavior. + * 2) "overwrite" : Overwrite the local value with the rollout value. + * The concept of "conflict" applies to: + * 1) Insert action. If the zonal policy already exists when Insert + * happens, it's a conflict. + * 2) Update action. If the zonal policy was updated out of band by a + * zonal API, it's a conflict. + */ + conflictBehavior?: string | null; + /** + * Optional. The name of the rollout plan. + * Ex. + * projects//locations/global/rolloutPlans/. + */ + name?: string | null; + /** + * Optional. Predefined rollout plan. + */ + predefinedRolloutPlan?: string | null; + /** + * Optional. The UUID of the retry action. Only set it if this is a retry + * for an existing resource. This is for the user re-populate the resource + * without changes. An error will be returned if the retry_uuid is set but + * the resource get modified. + */ + retryUuid?: string | null; + } + export interface Schema$GlobalVmExtensionPolicyRolloutOperationRolloutStatus { + /** + * [Output Only] The current rollouts for the latest version of the + * resource. There should be only one current rollout, but for + * scalability, we make it repeated. + */ + currentRollouts?: Schema$GlobalVmExtensionPolicyRolloutOperationRolloutStatusRolloutMetadata[]; + /** + * [Output Only] The last completed rollout resource. This field will not + * be populated until the first rollout is completed. + */ + previousRollout?: Schema$GlobalVmExtensionPolicyRolloutOperationRolloutStatusRolloutMetadata; + } + export interface Schema$GlobalVmExtensionPolicyRolloutOperationRolloutStatusRolloutMetadata { + /** + * [Output Only] The name of the rollout. + * Ex. projects//locations/global/rollouts/. + */ + rollout?: string | null; + /** + * [Output Only] The name of the rollout plan. + * Ex. + * projects//locations/global/rolloutPlans/. + */ + rolloutPlan?: string | null; + /** + * [Output Only] The overall state of the rollout. + */ + state?: string | null; + } /** * Maintenance Info for ReservationBlocks. */ @@ -9976,6 +10262,10 @@ export namespace compute_beta { * [Output Only] Server-defined URL for this resource. */ selfLink?: string | null; + /** + * [Output Only] Unreachable resources. + */ + unreachables?: string[] | null; /** * [Output Only] Informational warning message. */ @@ -12720,6 +13010,12 @@ export namespace compute_beta { export interface Schema$InstanceGroupManagerInstanceLifecyclePolicyOnRepair { /** * Specifies whether the MIG can change a VM's zone during a repair. + * Valid values are: + * + * - NO (default): MIG cannot change a VM's zone during a + * repair. + * - YES: MIG can select a different zone for the VM during + * a repair. */ allowChangingZone?: string | null; } @@ -13060,6 +13356,24 @@ export namespace compute_beta { */ names?: string[] | null; } + export interface Schema$InstanceGroupManagersGetAvailableAcceleratorTopologiesResponse { + /** + * The accelerator topology information returned per id of the topology + * location. + */ + acceleratorTopologiesInfo?: { + [ + key: string + ]: Schema$InstanceGroupManagersGetAvailableAcceleratorTopologiesResponseAcceleratorTopologyInfo; + } | null; + } + export interface Schema$InstanceGroupManagersGetAvailableAcceleratorTopologiesResponseAcceleratorTopologyInfo { + /** + * Topology in the format of: "16x16", "4x4x4", etc. + */ + acceleratorTopology?: string | null; + acceleratorTopologyHealth?: string | null; + } export interface Schema$InstanceGroupManagersListErrorsResponse { /** * [Output Only] The list of errors of the managed instance group. @@ -15120,6 +15434,16 @@ export namespace compute_beta { * [Output Only] Type of the resource. Alwayscompute#interconnectAttachment for interconnect attachments. */ kind?: string | null; + /** + * L2 Interconnect Attachment related config. This field is required if the + * type is L2_DEDICATED. + * + * The configuration specifies how VLAN tags (like dot1q, qinq, or dot1ad) + * within L2 packets are mapped to the destination appliances IP addresses. + * The packet is then encapsulated with the appliance IP address and sent to + * the edge appliance. + */ + l2Forwarding?: Schema$InterconnectAttachmentL2Forwarding; /** * A fingerprint for the labels being applied to this InterconnectAttachment, * which is essentially a hash of the labels set used for optimistic locking. @@ -15291,6 +15615,8 @@ export namespace compute_beta { * customer. * - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by * the partner. + * + * - L2_DEDICATED: a L2 attachment to a Dedicated Interconnect. */ type?: string | null; /** @@ -15646,6 +15972,110 @@ export namespace compute_beta { */ status?: string | null; } + /** + * L2 Interconnect Attachment related configuration. + */ + export interface Schema$InterconnectAttachmentL2Forwarding { + /** + * Optional. A map of VLAN tags to appliances and optional inner mapping + * rules. If VLANs are not explicitly mapped to any appliance, the + * defaultApplianceIpAddress is used. + * + * Each VLAN tag can be a single number or a range of numbers in the range + * of 1 to 4094, e.g., "1" or "4001-4094". Non-empty and non-overlapping + * VLAN tag ranges are enforced, and violating operations will be rejected. + * + * The VLAN tags in the Ethernet header must use an ethertype value of + * 0x88A8 or 0x8100. + */ + applianceMappings?: { + [key: string]: Schema$InterconnectAttachmentL2ForwardingApplianceMapping; + } | null; + /** + * Optional. A single IPv4 or IPv6 address used as the default destination + * IP when there is no VLAN mapping result found. + * + * Unset field (null-value) indicates the unmatched packet should be + * dropped. + */ + defaultApplianceIpAddress?: string | null; + /** + * Optional. It represents the structure of a Geneve (Generic Network + * Virtualization Encapsulation) header, as defined in RFC8926. It encapsulates packets from various + * protocols (e.g., Ethernet, IPv4, IPv6) for use in network virtualization + * environments. + */ + geneveHeader?: Schema$InterconnectAttachmentL2ForwardingGeneveHeader; + /** + * Required. Resource URL of the network to which this attachment belongs. + */ + network?: string | null; + /** + * Required. A single IPv4 or IPv6 address. This address will be used as the + * source IP address for packets sent to the appliances, and must be used as + * the destination IP address for packets that should be sent out through + * this attachment. + */ + tunnelEndpointIpAddress?: string | null; + } + /** + * Two-level VLAN-to-Appliance mapping rule. + */ + export interface Schema$InterconnectAttachmentL2ForwardingApplianceMapping { + /** + * Optional. A single IPv4 or IPv6 address used as the destination IP + * address for ingress packets that match on a VLAN tag, but do not match + * a more specific inner VLAN tag. + * + * Unset field (null-value) indicates both VLAN tags are required to be + * mapped. Otherwise, defaultApplianceIpAddress is used. + */ + applianceIpAddress?: string | null; + /** + * Optional. Used to match against the inner VLAN when the packet + * contains two VLAN tags. + * + * A list of mapping rules from inner VLAN tags to IP addresses. If the + * inner VLAN is not explicitly mapped to an IP address range, the + * applianceIpAddress is used. + */ + innerVlanToApplianceMappings?: Schema$InterconnectAttachmentL2ForwardingApplianceMappingInnerVlanToApplianceMapping[]; + /** + * Optional. The name of this appliance mapping rule. + */ + name?: string | null; + } + /** + * The inner VLAN-to-Appliance mapping. + */ + export interface Schema$InterconnectAttachmentL2ForwardingApplianceMappingInnerVlanToApplianceMapping { + /** + * Required in this object. A single IPv4 or IPv6 address used as the + * destination IP address for ingress packets that match on both VLAN + * tags. + */ + innerApplianceIpAddress?: string | null; + /** + * Required in this object. Used to match the inner VLAN tag on the + * packet. Each entry can be a single number or a range of numbers in + * the range of 1 to 4094, e.g., ["1", "4001-4094"] is valid. Non-empty + * and Non-overlapping VLAN tag ranges are enforced, and violating + * operations will be rejected. + * + * The inner VLAN tags must have an ethertype value of 0x8100. + */ + innerVlanTags?: string[] | null; + } + /** + * GeneveHeader related configurations. + */ + export interface Schema$InterconnectAttachmentL2ForwardingGeneveHeader { + /** + * Optional. VNI is a 24-bit unique virtual network identifier, from 0 to + * 16,777,215. + */ + vni?: number | null; + } /** * Response to the list request, and contains a list of interconnect * attachments. @@ -15934,7 +16364,7 @@ export namespace compute_beta { * If provided when patching a configuration in update mode, the provided * token must match the current token or the update is rejected. This provides * a reliable means of doing read-modify-write (optimistic locking) as - * described byAPI 154. + * described by AIP 154. */ etag?: string | null; /** @@ -16522,6 +16952,11 @@ export namespace compute_beta { * to a VM in this region. */ expectedRttMs?: string | null; + /** + * Identifies whether L2 Interconnect Attachments can be created in this + * region for interconnects that are in this location. + */ + l2ForwardingEnabled?: boolean | null; /** * Identifies the network presence of this location. */ @@ -19844,6 +20279,10 @@ export namespace compute_beta { * Specifies whether cloud load balancing is allowed. */ allowLoadBalancing?: string | null; + /** + * Specifies whether multicast is allowed. + */ + allowMulticast?: string | null; /** * Specifies whether multi-nic in the same network is allowed. */ @@ -19894,6 +20333,10 @@ export namespace compute_beta { * empty, all interface types are supported. */ interfaceTypes?: string[] | null; + /** + * Specifies which type of multicast is supported. + */ + multicast?: string | null; /** * Specifies which subnetwork purposes are supported. */ @@ -24182,6 +24625,10 @@ export namespace compute_beta { * Represents a reservation subBlock resource. */ export interface Schema$ReservationSubBlock { + /** + * [Output Only] Slice info for the reservation subBlock. + */ + acceleratorTopologiesInfo?: Schema$AcceleratorTopologiesInfo; /** * [Output Only] The number of hosts that are allocated in this * reservation subBlock. @@ -24554,6 +25001,11 @@ export namespace compute_beta { * It specifies the failure bucket separation */ export interface Schema$ResourcePolicyGroupPlacementPolicy { + /** + * Specifies the connection mode for the accelerator topology. If not + * specified, the default is AUTO_CONNECT. + */ + acceleratorTopologyMode?: string | null; /** * The number of availability domains to spread instances across. If two * instances are in different availability domain, they are not in the same @@ -25153,7 +25605,9 @@ export namespace compute_beta { */ priority?: number | null; /** - * [Output only] The status of the route. + * [Output only] The status of the route. This status only applies to + * dynamic routes learned by Cloud Routers. This status is not applicable + * to static routes. */ routeStatus?: string | null; /** @@ -28334,6 +28788,16 @@ export namespace compute_beta { * A Shielded Instance Identity. */ export interface Schema$ShieldedInstanceIdentity { + /** + * An Endorsement Key (EK) made by the ECC P256 algorithm + * issued to the Shielded Instance's vTPM. + */ + eccP256EncryptionKey?: Schema$ShieldedInstanceIdentityEntry; + /** + * An Attestation Key (AK) made by the ECC P256 algorithm + * issued to the Shielded Instance's vTPM. + */ + eccP256SigningKey?: Schema$ShieldedInstanceIdentityEntry; /** * An Endorsement Key (EK) made by the RSA 2048 algorithm * issued to the Shielded Instance's vTPM. @@ -33077,103 +33541,332 @@ export namespace compute_beta { message?: string; } | null; } + export interface Schema$VmExtensionPoliciesScopedList { + /** + * List of VmExtensionPolicy resources contained in this scope. + */ + vmExtensionPolicies?: Schema$VmExtensionPolicy[]; + /** + * Informational warning which replaces the list of + * backend services when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } /** - * Represents a HA VPN gateway. - * - * HA VPN is a high-availability (HA) Cloud VPN solution that lets you securely - * connect your on-premises network to your Google Cloud Virtual Private Cloud - * network through an IPsec VPN connection in a single region. - * For more information about Cloud HA VPN solutions, see - * Cloud VPN topologies . + * Represents a VM extension policy. */ - export interface Schema$VpnGateway { + export interface Schema$VmExtensionPolicy { /** * [Output Only] Creation timestamp inRFC3339 * text format. */ creationTimestamp?: string | null; /** - * An optional description of this resource. Provide this property when you - * create the resource. + * An optional description of this resource. */ description?: string | null; /** - * The IP family of the gateway IPs for the HA-VPN gateway interfaces. If not - * specified, IPV4 will be used. + * Required. A map of extension names (e.g., "cloudops") to their corresponding policy + * configurations. */ - gatewayIpVersion?: string | null; + extensionPolicies?: { + [key: string]: Schema$VmExtensionPolicyExtensionPolicy; + } | null; + /** + * Optional. [Output Only] Link to the global policy that manages this zone policy, if + * applicable. + */ + globalResourceLink?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is * defined by the server. */ id?: string | null; /** - * [Output Only] Type of resource. Always compute#vpnGateway for - * VPN gateways. + * Optional. Selectors to target VMs for this policy. VMs are selected if they match + * *any* of the provided selectors (logical OR). If this list is empty, the + * policy applies to all VMs. */ - kind?: string | null; + instanceSelectors?: Schema$VmExtensionPolicyInstanceSelector[]; /** - * A fingerprint for the labels being applied to this VpnGateway, which - * is essentially a hash of the labels set used for optimistic locking. The - * fingerprint is initially generated by Compute Engine and changes after - * every request to modify or update labels. You must always provide an - * up-to-date fingerprint hash in order to update or change labels, - * otherwise the request will fail with error412 conditionNotMet. - * - * To see the latest fingerprint, make a get() request to - * retrieve a VpnGateway. + * [Output Only] Type of the resource. Alwayscompute#vmExtensionPolicy. */ - labelFingerprint?: string | null; + kind?: string | null; /** - * Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035. - * Label values may be empty. + * Optional. [Output Only] Indicates if this policy is managed by a global policy. */ - labels?: {[key: string]: string} | null; + managedByGlobal?: boolean | null; /** * Name of the resource. Provided by the client when the resource is created. * The name must be 1-63 characters long, and comply withRFC1035. * Specifically, the name must be 1-63 characters long and match the regular - * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first - * character must be a lowercase letter, and all following characters must - * be a dash, lowercase letter, or digit, except the last character, which - * cannot be a dash. + * expression `[a-z]([-a-z0-9]*[a-z0-9])?` + * which means the first character must be a lowercase letter, and all + * following characters must be a dash, lowercase letter, or digit, except + * the last character, which cannot be a dash. */ name?: string | null; /** - * URL of the network to which this VPN gateway is attached. Provided by the - * client when the VPN gateway is created. + * Optional. Priority of this policy. Used to resolve conflicts when multiple policies + * apply to the same extension. + * The policy priority is an integer from 0 to 65535, inclusive. Lower + * integers indicate higher priorities. If you do not specify a priority when + * creating a rule, it is assigned a priority of 1000. If priorities are + * equal, the policy with the more recent creation timestamp takes precedence. */ - network?: string | null; + priority?: number | null; /** - * [Output Only] URL of the region where the VPN gateway resides. + * [Output Only] Server-defined fully-qualified URL for this resource. */ - region?: string | null; + selfLink?: string | null; /** - * [Output Only] Server-defined URL for the resource. + * [Output Only] Server-defined URL for this resource's resource id. */ - selfLink?: string | null; + selfLinkWithId?: string | null; /** - * The stack type for this VPN gateway to identify the IP protocols that are - * enabled. Possible values are: IPV4_ONLY,IPV4_IPV6, IPV6_ONLY. If not specified,IPV4_ONLY is used if the gateway IP version isIPV4, or IPV4_IPV6 if the gateway IP version isIPV6. + * Optional. [Output Only] Current state of the policy: ACTIVE or DELETING. */ - stackType?: string | null; + state?: string | null; /** - * The list of VPN interfaces associated with this VPN gateway. + * [Output Only] Update timestamp inRFC3339 + * text format. */ - vpnInterfaces?: Schema$VpnGatewayVpnGatewayInterface[]; + updateTimestamp?: string | null; } - export interface Schema$VpnGatewayAggregatedList { + /** + * Response for the aggregated list of VM extension policies. + */ + export interface Schema$VmExtensionPolicyAggregatedListResponse { + etag?: string | null; /** * [Output Only] Unique identifier for the resource; defined by the server. */ id?: string | null; /** - * A list of VpnGateway resources. + * A list of VmExtensionPoliciesScopedList resources. */ - items?: {[key: string]: Schema$VpnGatewaysScopedList} | null; + items?: {[key: string]: Schema$VmExtensionPoliciesScopedList} | null; /** - * [Output Only] Type of resource. Always compute#vpnGateway for - * VPN gateways. + * [Output Only] Type of resource. Alwayscompute#VmExtensionPolicyAggregatedList for lists of + * VmExtensionPolicies. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for + * list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for + * the query parameter pageToken in the next list request. + * Subsequent list requests will have their own nextPageToken to + * continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Unreachable resources. + */ + unreachables?: string[] | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * Configuration for a specific VM extension. + */ + export interface Schema$VmExtensionPolicyExtensionPolicy { + /** + * Optional. The specific version of the extension to install. If not set, the latest + * version is used. + */ + pinnedVersion?: string | null; + /** + * Optional. String-based configuration data for the extension. + */ + stringConfig?: string | null; + } + /** + * Defines how to select VMs to apply a zone VM extension policy. + */ + export interface Schema$VmExtensionPolicyInstanceSelector { + /** + * Optional. LabelSelector selects VMs based on their labels. + */ + labelSelector?: Schema$VmExtensionPolicyLabelSelector; + } + /** + * A LabelSelector is applied to a VM only if it matches all the specified + * labels. + */ + export interface Schema$VmExtensionPolicyLabelSelector { + /** + * Optional. A map of key-value pairs representing VM labels. + * VMs must have all of the labels specified in this map to be selected + * (logical AND). + * + * e.g. If the `inclusion_labels` are {("key1", "value1"), ("key2", + * "value2")\}, the VM labels must contain both ("key1", "value1") and + * ("key2", "value2") to be selected. If the VM labels are ("key1", + * "value1") and ("something", "else"), it will not be selected. + * + * If the map is empty, it's considered a match. + */ + inclusionLabels?: {[key: string]: string} | null; + } + export interface Schema$VmExtensionPolicyList { + /** + * [Output Only] Fingerprint of this resource. A hash of the contents stored + * in this object. This field is used in optimistic locking. This field will + * be ignored when inserting a VmExtensionPolicy. An up-to-date + * fingerprint must be provided in order to update the VmExtensionPolicy. + * + * To see the latest value of the fingerprint, make a get() request to + * retrieve a VmExtensionPolicy. + */ + etag?: string | null; + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * [Output Only] A list of VM extension policy resources. + */ + items?: Schema$VmExtensionPolicy[]; + /** + * Type of resource. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for + * list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for + * the query parameter pageToken in the next list request. + * Subsequent list requests will have their own nextPageToken to + * continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Unreachable resources. + */ + unreachables?: string[] | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * Represents a HA VPN gateway. + * + * HA VPN is a high-availability (HA) Cloud VPN solution that lets you securely + * connect your on-premises network to your Google Cloud Virtual Private Cloud + * network through an IPsec VPN connection in a single region. + * For more information about Cloud HA VPN solutions, see + * Cloud VPN topologies . + */ + export interface Schema$VpnGateway { + /** + * [Output Only] Creation timestamp inRFC3339 + * text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you + * create the resource. + */ + description?: string | null; + /** + * The IP family of the gateway IPs for the HA-VPN gateway interfaces. If not + * specified, IPV4 will be used. + */ + gatewayIpVersion?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is + * defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of resource. Always compute#vpnGateway for + * VPN gateways. + */ + kind?: string | null; + /** + * A fingerprint for the labels being applied to this VpnGateway, which + * is essentially a hash of the labels set used for optimistic locking. The + * fingerprint is initially generated by Compute Engine and changes after + * every request to modify or update labels. You must always provide an + * up-to-date fingerprint hash in order to update or change labels, + * otherwise the request will fail with error412 conditionNotMet. + * + * To see the latest fingerprint, make a get() request to + * retrieve a VpnGateway. + */ + labelFingerprint?: string | null; + /** + * Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035. + * Label values may be empty. + */ + labels?: {[key: string]: string} | null; + /** + * Name of the resource. Provided by the client when the resource is created. + * The name must be 1-63 characters long, and comply withRFC1035. + * Specifically, the name must be 1-63 characters long and match the regular + * expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first + * character must be a lowercase letter, and all following characters must + * be a dash, lowercase letter, or digit, except the last character, which + * cannot be a dash. + */ + name?: string | null; + /** + * URL of the network to which this VPN gateway is attached. Provided by the + * client when the VPN gateway is created. + */ + network?: string | null; + /** + * [Output Only] URL of the region where the VPN gateway resides. + */ + region?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * The stack type for this VPN gateway to identify the IP protocols that are + * enabled. Possible values are: IPV4_ONLY,IPV4_IPV6, IPV6_ONLY. If not specified,IPV4_ONLY is used if the gateway IP version isIPV4, or IPV4_IPV6 if the gateway IP version isIPV6. + */ + stackType?: string | null; + /** + * The list of VPN interfaces associated with this VPN gateway. + */ + vpnInterfaces?: Schema$VpnGatewayVpnGatewayInterface[]; + } + export interface Schema$VpnGatewayAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of VpnGateway resources. + */ + items?: {[key: string]: Schema$VpnGatewaysScopedList} | null; + /** + * [Output Only] Type of resource. Always compute#vpnGateway for + * VPN gateways. */ kind?: string | null; /** @@ -34241,7 +34934,7 @@ export namespace compute_beta { /** * Retrieves an aggregated list of accelerator types. * - * To prevent failure, Google recommends that you set the + * To prevent failure, it is recommended that you set the * `returnPartialSuccess` parameter to `true`. * @example * ```js @@ -35141,7 +35834,7 @@ export namespace compute_beta { /** * Retrieves an aggregated list of addresses. * - * To prevent failure, Google recommends that you set the + * To prevent failure, it is recommended that you set the * `returnPartialSuccess` parameter to `true`. * @example * ```js @@ -37317,7 +38010,7 @@ export namespace compute_beta { /** * Retrieves an aggregated list of autoscalers. * - * To prevent failure, Google recommends that you set the + * To prevent failure, it is recommended that you set the * `returnPartialSuccess` parameter to `true`. * @example * ```js @@ -40201,6 +40894,7 @@ export namespace compute_beta { * // "loadBalancingScheme": "my_loadBalancingScheme", * // "name": "my_name", * // "params": {}, + * // "region": "my_region", * // "selfLink": "my_selfLink", * // "usedBy": [] * // } @@ -40521,6 +41215,7 @@ export namespace compute_beta { * // "loadBalancingScheme": "my_loadBalancingScheme", * // "name": "my_name", * // "params": {}, + * // "region": "my_region", * // "selfLink": "my_selfLink", * // "usedBy": [] * // } @@ -41201,6 +41896,7 @@ export namespace compute_beta { * // "loadBalancingScheme": "my_loadBalancingScheme", * // "name": "my_name", * // "params": {}, + * // "region": "my_region", * // "selfLink": "my_selfLink", * // "usedBy": [] * // } @@ -41912,6 +42608,7 @@ export namespace compute_beta { * // "loadBalancingScheme": "my_loadBalancingScheme", * // "name": "my_name", * // "params": {}, + * // "region": "my_region", * // "selfLink": "my_selfLink", * // "usedBy": [] * // } @@ -42855,7 +43552,7 @@ export namespace compute_beta { * Retrieves the list of all BackendService resources, regional and global, * available to the specified project. * - * To prevent failure, Google recommends that you set the + * To prevent failure, it is recommended that you set the * `returnPartialSuccess` parameter to `true`. * @example * ```js @@ -48111,7 +48808,7 @@ export namespace compute_beta { /** * Retrieves an aggregated list of persistent disks. * - * To prevent failure, Google recommends that you set the + * To prevent failure, it is recommended that you set the * `returnPartialSuccess` parameter to `true`. * @example * ```js @@ -52885,7 +53582,7 @@ export namespace compute_beta { /** * Retrieves an aggregated list of disk types. * - * To prevent failure, Google recommends that you set the + * To prevent failure, it is recommended that you set the * `returnPartialSuccess` parameter to `true`. * @example * ```js @@ -57313,6 +58010,10 @@ export namespace compute_beta { * * // Do the magic * const res = await compute.firewallPolicies.listAssociations({ + * // If set to "true", the response will contain a list of all associations for + * // the containing folders and the containing organization of the target. The + * // parameter has no effect if the target is an organization. + * includeInheritedPolicies: 'placeholder-value', * // The target resource to list associations. It is an organization, or a * // folder. * targetResource: 'placeholder-value', @@ -59415,6 +60116,12 @@ export namespace compute_beta { } export interface Params$Resource$Firewallpolicies$Listassociations extends StandardParameters { + /** + * If set to "true", the response will contain a list of all associations for + * the containing folders and the containing organization of the target. The + * parameter has no effect if the target is an organization. + */ + includeInheritedPolicies?: boolean; /** * The target resource to list associations. It is an organization, or a * folder. @@ -61275,7 +61982,7 @@ export namespace compute_beta { /** * Retrieves an aggregated list of forwarding rules. * - * To prevent failure, Google recommends that you set the + * To prevent failure, it is recommended that you set the * `returnPartialSuccess` parameter to `true`. * @example * ```js @@ -63589,7 +64296,7 @@ export namespace compute_beta { /** * Retrieves an aggregated list of future reservations. * - * To prevent failure, recommendation is that you set the + * To prevent failure, it is recommended that you set the * `returnPartialSuccess` parameter to `true`. * @example * ```js @@ -73787,17 +74494,17 @@ export namespace compute_beta { requestBody?: Schema$PublicDelegatedPrefix; } - export class Resource$Healthchecks { + export class Resource$Globalvmextensionpolicies { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Retrieves the list of all HealthCheck resources, regional and global, + * Retrieves the list of all VM Extension Policy resources * available to the specified project. * - * To prevent failure, Google recommends that you set the + * To prevent failure, it's recommended that you set the * `returnPartialSuccess` parameter to `true`. * @example * ```js @@ -73831,7 +74538,7 @@ export namespace compute_beta { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.healthChecks.aggregatedList({ + * const res = await compute.globalVmExtensionPolicies.aggregatedList({ * // A filter expression that filters resources listed in the response. Most * // Compute resources support two types of filter expressions: * // expressions that support regular expressions and expressions that follow @@ -73939,6 +74646,7 @@ export namespace compute_beta { * * // Example response * // { + * // "etag": "my_etag", * // "id": "my_id", * // "items": {}, * // "kind": "my_kind", @@ -73962,56 +74670,60 @@ export namespace compute_beta { * @returns A promise if used with async/await, or void if used with a callback. */ aggregatedList( - params: Params$Resource$Healthchecks$Aggregatedlist, + params: Params$Resource$Globalvmextensionpolicies$Aggregatedlist, options: StreamMethodOptions ): Promise>; aggregatedList( - params?: Params$Resource$Healthchecks$Aggregatedlist, + params?: Params$Resource$Globalvmextensionpolicies$Aggregatedlist, options?: MethodOptions - ): Promise>; + ): Promise< + GaxiosResponseWithHTTP2 + >; aggregatedList( - params: Params$Resource$Healthchecks$Aggregatedlist, + params: Params$Resource$Globalvmextensionpolicies$Aggregatedlist, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; aggregatedList( - params: Params$Resource$Healthchecks$Aggregatedlist, + params: Params$Resource$Globalvmextensionpolicies$Aggregatedlist, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; aggregatedList( - params: Params$Resource$Healthchecks$Aggregatedlist, - callback: BodyResponseCallback + params: Params$Resource$Globalvmextensionpolicies$Aggregatedlist, + callback: BodyResponseCallback ): void; aggregatedList( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; aggregatedList( paramsOrCallback?: - | Params$Resource$Healthchecks$Aggregatedlist - | BodyResponseCallback + | Params$Resource$Globalvmextensionpolicies$Aggregatedlist + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Healthchecks$Aggregatedlist; + {}) as Params$Resource$Globalvmextensionpolicies$Aggregatedlist; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Healthchecks$Aggregatedlist; + params = {} as Params$Resource$Globalvmextensionpolicies$Aggregatedlist; options = {}; } @@ -74026,7 +74738,7 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/aggregated/healthChecks' + '/compute/beta/projects/{project}/aggregated/vmExtensionPolicies' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -74039,199 +74751,754 @@ export namespace compute_beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); - } - } - - /** - * Deletes the specified HealthCheck resource. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/compute.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const compute = google.compute('beta'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/compute', - * ], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await compute.healthChecks.delete({ - * // Name of the HealthCheck resource to delete. - * healthCheck: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', - * // Project ID for this request. - * project: - * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', - * // An optional request ID to identify requests. Specify a unique request ID so - * // that if you must retry your request, the server will know to ignore the - * // request if it has already been completed. - * // - * // For example, consider a situation where you make an initial request and - * // the request times out. If you make the request again with the same - * // request ID, the server can check if original operation with the same - * // request ID was received, and if so, will ignore the second request. This - * // prevents clients from accidentally creating duplicate commitments. - * // - * // The request ID must be - * // a valid UUID with the exception that zero UUID is not supported - * // (00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - delete( - params: Params$Resource$Healthchecks$Delete, - options: StreamMethodOptions - ): Promise>; - delete( - params?: Params$Resource$Healthchecks$Delete, - options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Healthchecks$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Healthchecks$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Healthchecks$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Healthchecks$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Healthchecks$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Healthchecks$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/beta/projects/{project}/global/healthChecks/{healthCheck}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'healthCheck'], - pathParams: ['healthCheck', 'project'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback + return createAPIRequest( + parameters ); - } else { - return createAPIRequest(parameters); } } /** - * Returns the specified HealthCheck resource. + * Gets details of a global VM extension policy. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const compute = google.compute('beta'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await compute.globalVmExtensionPolicies.get({ + * // Name of the GlobalVmExtensionPolicy resource to return. + * globalVmExtensionPolicy: + * '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "extensionPolicies": {}, + * // "id": "my_id", + * // "instanceSelectors": [], + * // "kind": "my_kind", + * // "name": "my_name", + * // "priority": 0, + * // "rolloutOperation": {}, + * // "scopedResourceStatus": "my_scopedResourceStatus", + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "updateTimestamp": "my_updateTimestamp" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Globalvmextensionpolicies$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Globalvmextensionpolicies$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Globalvmextensionpolicies$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Globalvmextensionpolicies$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Globalvmextensionpolicies$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Globalvmextensionpolicies$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Globalvmextensionpolicies$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globalvmextensionpolicies$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'globalVmExtensionPolicy'], + pathParams: ['globalVmExtensionPolicy', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Globalvmextensionpolicies$Aggregatedlist + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most + * Compute resources support two types of filter expressions: + * expressions that support regular expressions and expressions that follow + * API improvement proposal AIP-160. + * These two types of filter expressions cannot be mixed in one request. + * + * If you want to use AIP-160, your expression must specify the field name, an + * operator, and the value that you want to use for filtering. The value + * must be a string, a number, or a boolean. The operator + * must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. + * + * For example, if you are filtering Compute Engine instances, you can + * exclude instances named `example-instance` by specifying + * `name != example-instance`. + * + * The `:*` comparison can be used to test whether a key has been defined. + * For example, to find all objects with `owner` label use: + * ``` + * labels.owner:* + * ``` + * + * You can also filter nested fields. For example, you could specify + * `scheduling.automaticRestart = false` to include instances only + * if they are not scheduled for automatic restarts. You can use filtering + * on nested fields to filter based onresource labels. + * + * To filter on multiple expressions, provide each separate expression within + * parentheses. For example: + * ``` + * (scheduling.automaticRestart = true) + * (cpuPlatform = "Intel Skylake") + * ``` + * By default, each expression is an `AND` expression. However, you + * can include `AND` and `OR` expressions explicitly. + * For example: + * ``` + * (cpuPlatform = "Intel Skylake") OR + * (cpuPlatform = "Intel Broadwell") AND + * (scheduling.automaticRestart = true) + * ``` + * + * If you want to use a regular expression, use the `eq` (equal) or `ne` + * (not equal) operator against a single un-parenthesized expression with or + * without quotes or against multiple parenthesized expressions. Examples: + * + * `fieldname eq unquoted literal` + * `fieldname eq 'single quoted literal'` + * `fieldname eq "double quoted literal"` + * `(fieldname1 eq literal) (fieldname2 ne "literal")` + * + * The literal value is interpreted as a regular expression using GoogleRE2 library syntax. + * The literal value must match the entire field. + * + * For example, to filter for instances that do not end with name "instance", + * you would use `name ne .*instance`. + * + * You cannot combine constraints on multiple fields using regular + * expressions. + */ + filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, + * global) should be included in the response. For new resource types added + * after this field, the flag has no effect as new resource types will always + * include every visible scope for each scope type in response. For resource + * types which predate this field, if this flag is omitted or false, only + * scopes of the scope types where the resource type is expected to be found + * will be included. + */ + includeAllScopes?: boolean; + /** + * The maximum number of results per page that should be returned. + * If the number of available results is larger than `maxResults`, + * Compute Engine returns a `nextPageToken` that can be used to get + * the next page of results in subsequent list requests. Acceptable values are + * `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results + * are returned in alphanumerical order based on the resource name. + * + * You can also sort results in descending order based on the creation + * timestamp using `orderBy="creationTimestamp desc"`. This sorts + * results based on the `creationTimestamp` field in + * reverse chronological order (newest result first). Use this to sort + * resources like operations so that the newest operation is returned first. + * + * Currently, only sorting by `name` or + * `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the + * `nextPageToken` returned by a previous list request to get + * the next page of results. + */ + pageToken?: string; + /** + * Name of the project scoping this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case + * of failure. The default value is false. + * + * For example, when partial success behavior is enabled, aggregatedList for a + * single zone scope either returns all resources in the zone or no resources, + * with an error code. + */ + returnPartialSuccess?: boolean; + /** + * The Shared VPC service project id or service project number for which + * aggregated list request is invoked for subnetworks list-usable api. + */ + serviceProjectNumber?: string; + } + export interface Params$Resource$Globalvmextensionpolicies$Get + extends StandardParameters { + /** + * Name of the GlobalVmExtensionPolicy resource to return. + */ + globalVmExtensionPolicy?: string; + /** + * Project ID for this request. + */ + project?: string; + } + + export class Resource$Healthchecks { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves the list of all HealthCheck resources, regional and global, + * available to the specified project. + * + * To prevent failure, Google recommends that you set the + * `returnPartialSuccess` parameter to `true`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const compute = google.compute('beta'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await compute.healthChecks.aggregatedList({ + * // A filter expression that filters resources listed in the response. Most + * // Compute resources support two types of filter expressions: + * // expressions that support regular expressions and expressions that follow + * // API improvement proposal AIP-160. + * // These two types of filter expressions cannot be mixed in one request. + * // + * // If you want to use AIP-160, your expression must specify the field name, an + * // operator, and the value that you want to use for filtering. The value + * // must be a string, a number, or a boolean. The operator + * // must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. + * // + * // For example, if you are filtering Compute Engine instances, you can + * // exclude instances named `example-instance` by specifying + * // `name != example-instance`. + * // + * // The `:*` comparison can be used to test whether a key has been defined. + * // For example, to find all objects with `owner` label use: + * // ``` + * // labels.owner:* + * // ``` + * // + * // You can also filter nested fields. For example, you could specify + * // `scheduling.automaticRestart = false` to include instances only + * // if they are not scheduled for automatic restarts. You can use filtering + * // on nested fields to filter based onresource labels. + * // + * // To filter on multiple expressions, provide each separate expression within + * // parentheses. For example: + * // ``` + * // (scheduling.automaticRestart = true) + * // (cpuPlatform = "Intel Skylake") + * // ``` + * // By default, each expression is an `AND` expression. However, you + * // can include `AND` and `OR` expressions explicitly. + * // For example: + * // ``` + * // (cpuPlatform = "Intel Skylake") OR + * // (cpuPlatform = "Intel Broadwell") AND + * // (scheduling.automaticRestart = true) + * // ``` + * // + * // If you want to use a regular expression, use the `eq` (equal) or `ne` + * // (not equal) operator against a single un-parenthesized expression with or + * // without quotes or against multiple parenthesized expressions. Examples: + * // + * // `fieldname eq unquoted literal` + * // `fieldname eq 'single quoted literal'` + * // `fieldname eq "double quoted literal"` + * // `(fieldname1 eq literal) (fieldname2 ne "literal")` + * // + * // The literal value is interpreted as a regular expression using GoogleRE2 library syntax. + * // The literal value must match the entire field. + * // + * // For example, to filter for instances that do not end with name "instance", + * // you would use `name ne .*instance`. + * // + * // You cannot combine constraints on multiple fields using regular + * // expressions. + * filter: 'placeholder-value', + * // Indicates whether every visible scope for each scope type (zone, region, + * // global) should be included in the response. For new resource types added + * // after this field, the flag has no effect as new resource types will always + * // include every visible scope for each scope type in response. For resource + * // types which predate this field, if this flag is omitted or false, only + * // scopes of the scope types where the resource type is expected to be found + * // will be included. + * includeAllScopes: 'placeholder-value', + * // The maximum number of results per page that should be returned. + * // If the number of available results is larger than `maxResults`, + * // Compute Engine returns a `nextPageToken` that can be used to get + * // the next page of results in subsequent list requests. Acceptable values are + * // `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results + * // are returned in alphanumerical order based on the resource name. + * // + * // You can also sort results in descending order based on the creation + * // timestamp using `orderBy="creationTimestamp desc"`. This sorts + * // results based on the `creationTimestamp` field in + * // reverse chronological order (newest result first). Use this to sort + * // resources like operations so that the newest operation is returned first. + * // + * // Currently, only sorting by `name` or + * // `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the + * // `nextPageToken` returned by a previous list request to get + * // the next page of results. + * pageToken: 'placeholder-value', + * // Name of the project scoping this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Opt-in for partial success behavior which provides partial results in case + * // of failure. The default value is false. + * // + * // For example, when partial success behavior is enabled, aggregatedList for a + * // single zone scope either returns all resources in the zone or no resources, + * // with an error code. + * returnPartialSuccess: 'placeholder-value', + * // The Shared VPC service project id or service project number for which + * // aggregated list request is invoked for subnetworks list-usable api. + * serviceProjectNumber: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "id": "my_id", + * // "items": {}, + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", + * // "selfLink": "my_selfLink", + * // "unreachables": [], + * // "warning": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + aggregatedList( + params: Params$Resource$Healthchecks$Aggregatedlist, + options: StreamMethodOptions + ): Promise>; + aggregatedList( + params?: Params$Resource$Healthchecks$Aggregatedlist, + options?: MethodOptions + ): Promise>; + aggregatedList( + params: Params$Resource$Healthchecks$Aggregatedlist, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Healthchecks$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Healthchecks$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Healthchecks$Aggregatedlist + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Healthchecks$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Healthchecks$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/aggregated/healthChecks' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes the specified HealthCheck resource. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const compute = google.compute('beta'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await compute.healthChecks.delete({ + * // Name of the HealthCheck resource to delete. + * healthCheck: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so + * // that if you must retry your request, the server will know to ignore the + * // request if it has already been completed. + * // + * // For example, consider a situation where you make an initial request and + * // the request times out. If you make the request again with the same + * // request ID, the server can check if original operation with the same + * // request ID was received, and if so, will ignore the second request. This + * // prevents clients from accidentally creating duplicate commitments. + * // + * // The request ID must be + * // a valid UUID with the exception that zero UUID is not supported + * // (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Healthchecks$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Healthchecks$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Healthchecks$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Healthchecks$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Healthchecks$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Healthchecks$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Healthchecks$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Healthchecks$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/global/healthChecks/{healthCheck}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'healthCheck'], + pathParams: ['healthCheck', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns the specified HealthCheck resource. * @example * ```js * // Before running the sample: @@ -84484,6 +85751,167 @@ export namespace compute_beta { } } + /** + * Returns information about available accelerator topologies for a given MIG. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const compute = google.compute('beta'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await compute.instanceGroupManagers.getAvailableAcceleratorTopologies({ + * // Required. Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Required. The name of the managed instance group. + * // It should conform to RFC1035. + * resourceId: 'placeholder-value', + * // Required. The name of thezone where the managed + * // instance group is located. + * // Name should conform to RFC1035. + * zone: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "acceleratorTopologiesInfo": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getAvailableAcceleratorTopologies( + params: Params$Resource$Instancegroupmanagers$Getavailableacceleratortopologies, + options: StreamMethodOptions + ): Promise>; + getAvailableAcceleratorTopologies( + params?: Params$Resource$Instancegroupmanagers$Getavailableacceleratortopologies, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + getAvailableAcceleratorTopologies( + params: Params$Resource$Instancegroupmanagers$Getavailableacceleratortopologies, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getAvailableAcceleratorTopologies( + params: Params$Resource$Instancegroupmanagers$Getavailableacceleratortopologies, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getAvailableAcceleratorTopologies( + params: Params$Resource$Instancegroupmanagers$Getavailableacceleratortopologies, + callback: BodyResponseCallback + ): void; + getAvailableAcceleratorTopologies( + callback: BodyResponseCallback + ): void; + getAvailableAcceleratorTopologies( + paramsOrCallback?: + | Params$Resource$Instancegroupmanagers$Getavailableacceleratortopologies + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroupmanagers$Getavailableacceleratortopologies; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Instancegroupmanagers$Getavailableacceleratortopologies; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/instanceGroupManagers/{resourceId}/getAvailableAcceleratorTopologies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resourceId'], + pathParams: ['project', 'resourceId', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Creates a managed instance group using the information that you specify * in the request. After the group is created, instances in the group are @@ -89156,6 +90584,24 @@ export namespace compute_beta { */ zone?: string; } + export interface Params$Resource$Instancegroupmanagers$Getavailableacceleratortopologies + extends StandardParameters { + /** + * Required. Project ID for this request. + */ + project?: string; + /** + * Required. The name of the managed instance group. + * It should conform to RFC1035. + */ + resourceId?: string; + /** + * Required. The name of thezone where the managed + * instance group is located. + * Name should conform to RFC1035. + */ + zone?: string; + } export interface Params$Resource$Instancegroupmanagers$Insert extends StandardParameters { /** @@ -96048,6 +97494,8 @@ export namespace compute_beta { * * // Example response * // { + * // "eccP256EncryptionKey": {}, + * // "eccP256SigningKey": {}, * // "encryptionKey": {}, * // "kind": "my_kind", * // "signingKey": {} @@ -112529,6 +113977,7 @@ export namespace compute_beta { * // "interconnect": "my_interconnect", * // "ipsecInternalAddresses": [], * // "kind": "my_kind", + * // "l2Forwarding": {}, * // "labelFingerprint": "my_labelFingerprint", * // "labels": {}, * // "mtu": 0, @@ -112736,6 +114185,7 @@ export namespace compute_beta { * // "interconnect": "my_interconnect", * // "ipsecInternalAddresses": [], * // "kind": "my_kind", + * // "l2Forwarding": {}, * // "labelFingerprint": "my_labelFingerprint", * // "labels": {}, * // "mtu": 0, @@ -113219,6 +114669,7 @@ export namespace compute_beta { * // "interconnect": "my_interconnect", * // "ipsecInternalAddresses": [], * // "kind": "my_kind", + * // "l2Forwarding": {}, * // "labelFingerprint": "my_labelFingerprint", * // "labels": {}, * // "mtu": 0, @@ -130378,7 +131829,7 @@ export namespace compute_beta { * firewall policies from all applicable scopes (global and regional) and * grouping the results per scope. * - * To prevent failure, Google recommends that you set the + * To prevent failure, it is recommended that you set the * `returnPartialSuccess` parameter to `true`. * @example * ```js @@ -152094,10 +153545,13 @@ export namespace compute_beta { } /** + * Moves a persistent disk from one zone to another. + * *Note*: The moveDisk API will be deprecated on September 29, 2026. + * * Starting September 29, 2025, you can't use the moveDisk API on new * projects. To move a disk to a different region or zone, follow the steps in * [Change the location of a - * disk](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd). + * disk](https://cloud.google.com/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd). * * Projects that already use the moveDisk API can continue usage until * September 29, 2026. @@ -159555,6 +161009,7 @@ export namespace compute_beta { * // "loadBalancingScheme": "my_loadBalancingScheme", * // "name": "my_name", * // "params": {}, + * // "region": "my_region", * // "selfLink": "my_selfLink", * // "usedBy": [] * // } @@ -159879,6 +161334,7 @@ export namespace compute_beta { * // "loadBalancingScheme": "my_loadBalancingScheme", * // "name": "my_name", * // "params": {}, + * // "region": "my_region", * // "selfLink": "my_selfLink", * // "usedBy": [] * // } @@ -160570,6 +162026,7 @@ export namespace compute_beta { * // "loadBalancingScheme": "my_loadBalancingScheme", * // "name": "my_name", * // "params": {}, + * // "region": "my_region", * // "selfLink": "my_selfLink", * // "usedBy": [] * // } @@ -164347,7 +165804,7 @@ export namespace compute_beta { /** * Retrieves an aggregated list of commitments by region. * - * To prevent failure, Google recommends that you set the + * To prevent failure, it is recommended that you set the * `returnPartialSuccess` parameter to `true`. * @example * ```js @@ -166176,7 +167633,7 @@ export namespace compute_beta { * Retrieves the list of all CompositeHealthCheck resources (all * regional) available to the specified project. * - * To prevent failure, Google recommends that you set the + * To prevent failure, it is recommended that you set the * `returnPartialSuccess` parameter to `true`. * @example * ```js @@ -166323,6 +167780,7 @@ export namespace compute_beta { * // "kind": "my_kind", * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", + * // "unreachables": [], * // "warning": {} * // } * } @@ -172852,7 +174310,7 @@ export namespace compute_beta { * Retrieves the list of all HealthAggregationPolicy resources, * regional and global, available to the specified project. * - * To prevent failure, Google recommends that you set the + * To prevent failure, it is recommended that you set the * `returnPartialSuccess` parameter to `true`. * @example * ```js @@ -177867,6 +179325,7 @@ export namespace compute_beta { * // "kind": "my_kind", * // "nextPageToken": "my_nextPageToken", * // "selfLink": "my_selfLink", + * // "unreachables": [], * // "warning": {} * // } * } @@ -219961,7 +221420,7 @@ export namespace compute_beta { /** * Retrieves an aggregated list of reservations. * - * To prevent failure, Google recommends that you set the + * To prevent failure, it is recommended that you set the * `returnPartialSuccess` parameter to `true`. * @example * ```js @@ -222628,6 +224087,8 @@ export namespace compute_beta { * // The name of the reservation subBlock. * // Name should conform to RFC1035 or be a resource ID. * reservationSubBlock: 'placeholder-value', + * // View of the subBlock. + * view: 'placeholder-value', * // Name of the zone for this request. Zone name should conform to RFC1035. * zone: 'placeholder-value', * }); @@ -223880,6 +225341,10 @@ export namespace compute_beta { * Name should conform to RFC1035 or be a resource ID. */ reservationSubBlock?: string; + /** + * View of the subBlock. + */ + view?: string; /** * Name of the zone for this request. Zone name should conform to RFC1035. */ @@ -246865,6 +248330,12 @@ export namespace compute_beta { * // The Shared VPC service project id or service project number for which * // aggregated list request is invoked for subnetworks list-usable api. * serviceProjectNumber: 'placeholder-value', + * // Defines the extra views returned back in the subnetwork resource. + * // Supported values: + * // + * // - WITH_UTILIZATION: Utilization data is included in the + * // response. + * views: 'placeholder-value', * }); * console.log(res.data); * @@ -249273,6 +250744,14 @@ export namespace compute_beta { * aggregated list request is invoked for subnetworks list-usable api. */ serviceProjectNumber?: string; + /** + * Defines the extra views returned back in the subnetwork resource. + * Supported values: + * + * - WITH_UTILIZATION: Utilization data is included in the + * response. + */ + views?: string[]; } export interface Params$Resource$Subnetworks$Delete extends StandardParameters { @@ -275475,4 +276954,1227 @@ export namespace compute_beta { */ returnPartialSuccess?: boolean; } + + export class Resource$Zonevmextensionpolicies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes a specified zone VM extension policy. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const compute = google.compute('beta'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await compute.zoneVmExtensionPolicies.delete({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so + * // that if you must retry your request, the server will know to ignore the + * // request if it has already been completed. + * // + * // For example, consider a situation where you make an initial request and + * // the request times out. If you make the request again with the same + * // request ID, the server can check if original operation with the same + * // request ID was received, and if so, will ignore the second request. This + * // prevents clients from accidentally creating duplicate commitments. + * // + * // The request ID must be + * // a valid UUID with the exception that zero UUID is not supported + * // (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // Name of the zone VM extension policy to delete. + * vmExtensionPolicy: 'placeholder-value', + * // Name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Zonevmextensionpolicies$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Zonevmextensionpolicies$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Zonevmextensionpolicies$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Zonevmextensionpolicies$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Zonevmextensionpolicies$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Zonevmextensionpolicies$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Zonevmextensionpolicies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Zonevmextensionpolicies$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'vmExtensionPolicy'], + pathParams: ['project', 'vmExtensionPolicy', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves details of a specific zone VM extension policy. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const compute = google.compute('beta'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await compute.zoneVmExtensionPolicies.get({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name of the VM extension policy resource to return. + * vmExtensionPolicy: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // Name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "extensionPolicies": {}, + * // "globalResourceLink": "my_globalResourceLink", + * // "id": "my_id", + * // "instanceSelectors": [], + * // "kind": "my_kind", + * // "managedByGlobal": false, + * // "name": "my_name", + * // "priority": 0, + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "state": "my_state", + * // "updateTimestamp": "my_updateTimestamp" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Zonevmextensionpolicies$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Zonevmextensionpolicies$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Zonevmextensionpolicies$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Zonevmextensionpolicies$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Zonevmextensionpolicies$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Zonevmextensionpolicies$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Zonevmextensionpolicies$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Zonevmextensionpolicies$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'vmExtensionPolicy'], + pathParams: ['project', 'vmExtensionPolicy', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a new zone-level VM extension policy within a project. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const compute = google.compute('beta'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await compute.zoneVmExtensionPolicies.insert({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so + * // that if you must retry your request, the server will know to ignore the + * // request if it has already been completed. + * // + * // For example, consider a situation where you make an initial request and + * // the request times out. If you make the request again with the same + * // request ID, the server can check if original operation with the same + * // request ID was received, and if so, will ignore the second request. This + * // prevents clients from accidentally creating duplicate commitments. + * // + * // The request ID must be + * // a valid UUID with the exception that zero UUID is not supported + * // (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // Name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "extensionPolicies": {}, + * // "globalResourceLink": "my_globalResourceLink", + * // "id": "my_id", + * // "instanceSelectors": [], + * // "kind": "my_kind", + * // "managedByGlobal": false, + * // "name": "my_name", + * // "priority": 0, + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "state": "my_state", + * // "updateTimestamp": "my_updateTimestamp" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + insert( + params: Params$Resource$Zonevmextensionpolicies$Insert, + options: StreamMethodOptions + ): Promise>; + insert( + params?: Params$Resource$Zonevmextensionpolicies$Insert, + options?: MethodOptions + ): Promise>; + insert( + params: Params$Resource$Zonevmextensionpolicies$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Zonevmextensionpolicies$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Zonevmextensionpolicies$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Zonevmextensionpolicies$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Zonevmextensionpolicies$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Zonevmextensionpolicies$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/vmExtensionPolicies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists all VM extension policies within a specific zone for a project. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const compute = google.compute('beta'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await compute.zoneVmExtensionPolicies.list({ + * // A filter expression that filters resources listed in the response. Most + * // Compute resources support two types of filter expressions: + * // expressions that support regular expressions and expressions that follow + * // API improvement proposal AIP-160. + * // These two types of filter expressions cannot be mixed in one request. + * // + * // If you want to use AIP-160, your expression must specify the field name, an + * // operator, and the value that you want to use for filtering. The value + * // must be a string, a number, or a boolean. The operator + * // must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. + * // + * // For example, if you are filtering Compute Engine instances, you can + * // exclude instances named `example-instance` by specifying + * // `name != example-instance`. + * // + * // The `:*` comparison can be used to test whether a key has been defined. + * // For example, to find all objects with `owner` label use: + * // ``` + * // labels.owner:* + * // ``` + * // + * // You can also filter nested fields. For example, you could specify + * // `scheduling.automaticRestart = false` to include instances only + * // if they are not scheduled for automatic restarts. You can use filtering + * // on nested fields to filter based onresource labels. + * // + * // To filter on multiple expressions, provide each separate expression within + * // parentheses. For example: + * // ``` + * // (scheduling.automaticRestart = true) + * // (cpuPlatform = "Intel Skylake") + * // ``` + * // By default, each expression is an `AND` expression. However, you + * // can include `AND` and `OR` expressions explicitly. + * // For example: + * // ``` + * // (cpuPlatform = "Intel Skylake") OR + * // (cpuPlatform = "Intel Broadwell") AND + * // (scheduling.automaticRestart = true) + * // ``` + * // + * // If you want to use a regular expression, use the `eq` (equal) or `ne` + * // (not equal) operator against a single un-parenthesized expression with or + * // without quotes or against multiple parenthesized expressions. Examples: + * // + * // `fieldname eq unquoted literal` + * // `fieldname eq 'single quoted literal'` + * // `fieldname eq "double quoted literal"` + * // `(fieldname1 eq literal) (fieldname2 ne "literal")` + * // + * // The literal value is interpreted as a regular expression using GoogleRE2 library syntax. + * // The literal value must match the entire field. + * // + * // For example, to filter for instances that do not end with name "instance", + * // you would use `name ne .*instance`. + * // + * // You cannot combine constraints on multiple fields using regular + * // expressions. + * filter: 'placeholder-value', + * // The maximum number of results per page that should be returned. + * // If the number of available results is larger than `maxResults`, + * // Compute Engine returns a `nextPageToken` that can be used to get + * // the next page of results in subsequent list requests. Acceptable values are + * // `0` to `500`, inclusive. (Default: `500`) + * maxResults: 'placeholder-value', + * // Sorts list results by a certain order. By default, results + * // are returned in alphanumerical order based on the resource name. + * // + * // You can also sort results in descending order based on the creation + * // timestamp using `orderBy="creationTimestamp desc"`. This sorts + * // results based on the `creationTimestamp` field in + * // reverse chronological order (newest result first). Use this to sort + * // resources like operations so that the newest operation is returned first. + * // + * // Currently, only sorting by `name` or + * // `creationTimestamp desc` is supported. + * orderBy: 'placeholder-value', + * // Specifies a page token to use. Set `pageToken` to the + * // `nextPageToken` returned by a previous list request to get + * // the next page of results. + * pageToken: 'placeholder-value', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Opt-in for partial success behavior which provides partial results in case + * // of failure. The default value is false. + * // + * // For example, when partial success behavior is enabled, aggregatedList for a + * // single zone scope either returns all resources in the zone or no resources, + * // with an error code. + * returnPartialSuccess: 'placeholder-value', + * // Name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "etag": "my_etag", + * // "id": "my_id", + * // "items": [], + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken", + * // "selfLink": "my_selfLink", + * // "unreachables": [], + * // "warning": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Zonevmextensionpolicies$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Zonevmextensionpolicies$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Zonevmextensionpolicies$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Zonevmextensionpolicies$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Zonevmextensionpolicies$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Zonevmextensionpolicies$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Zonevmextensionpolicies$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Zonevmextensionpolicies$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/vmExtensionPolicies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Modifies an existing zone VM extension policy. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const compute = google.compute('beta'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await compute.zoneVmExtensionPolicies.update({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // An optional request ID to identify requests. Specify a unique request ID so + * // that if you must retry your request, the server will know to ignore the + * // request if it has already been completed. + * // + * // For example, consider a situation where you make an initial request and + * // the request times out. If you make the request again with the same + * // request ID, the server can check if original operation with the same + * // request ID was received, and if so, will ignore the second request. This + * // prevents clients from accidentally creating duplicate commitments. + * // + * // The request ID must be + * // a valid UUID with the exception that zero UUID is not supported + * // (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // Name of the zone VM extension policy to update. + * vmExtensionPolicy: 'placeholder-value', + * // Name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "extensionPolicies": {}, + * // "globalResourceLink": "my_globalResourceLink", + * // "id": "my_id", + * // "instanceSelectors": [], + * // "kind": "my_kind", + * // "managedByGlobal": false, + * // "name": "my_name", + * // "priority": 0, + * // "selfLink": "my_selfLink", + * // "selfLinkWithId": "my_selfLinkWithId", + * // "state": "my_state", + * // "updateTimestamp": "my_updateTimestamp" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + update( + params: Params$Resource$Zonevmextensionpolicies$Update, + options: StreamMethodOptions + ): Promise>; + update( + params?: Params$Resource$Zonevmextensionpolicies$Update, + options?: MethodOptions + ): Promise>; + update( + params: Params$Resource$Zonevmextensionpolicies$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Zonevmextensionpolicies$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Zonevmextensionpolicies$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Zonevmextensionpolicies$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Zonevmextensionpolicies$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Zonevmextensionpolicies$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'vmExtensionPolicy'], + pathParams: ['project', 'vmExtensionPolicy', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Zonevmextensionpolicies$Delete + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so + * that if you must retry your request, the server will know to ignore the + * request if it has already been completed. + * + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same + * request ID, the server can check if original operation with the same + * request ID was received, and if so, will ignore the second request. This + * prevents clients from accidentally creating duplicate commitments. + * + * The request ID must be + * a valid UUID with the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the zone VM extension policy to delete. + */ + vmExtensionPolicy?: string; + /** + * Name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Zonevmextensionpolicies$Get + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the VM extension policy resource to return. + */ + vmExtensionPolicy?: string; + /** + * Name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Zonevmextensionpolicies$Insert + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so + * that if you must retry your request, the server will know to ignore the + * request if it has already been completed. + * + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same + * request ID, the server can check if original operation with the same + * request ID was received, and if so, will ignore the second request. This + * prevents clients from accidentally creating duplicate commitments. + * + * The request ID must be + * a valid UUID with the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$VmExtensionPolicy; + } + export interface Params$Resource$Zonevmextensionpolicies$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most + * Compute resources support two types of filter expressions: + * expressions that support regular expressions and expressions that follow + * API improvement proposal AIP-160. + * These two types of filter expressions cannot be mixed in one request. + * + * If you want to use AIP-160, your expression must specify the field name, an + * operator, and the value that you want to use for filtering. The value + * must be a string, a number, or a boolean. The operator + * must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. + * + * For example, if you are filtering Compute Engine instances, you can + * exclude instances named `example-instance` by specifying + * `name != example-instance`. + * + * The `:*` comparison can be used to test whether a key has been defined. + * For example, to find all objects with `owner` label use: + * ``` + * labels.owner:* + * ``` + * + * You can also filter nested fields. For example, you could specify + * `scheduling.automaticRestart = false` to include instances only + * if they are not scheduled for automatic restarts. You can use filtering + * on nested fields to filter based onresource labels. + * + * To filter on multiple expressions, provide each separate expression within + * parentheses. For example: + * ``` + * (scheduling.automaticRestart = true) + * (cpuPlatform = "Intel Skylake") + * ``` + * By default, each expression is an `AND` expression. However, you + * can include `AND` and `OR` expressions explicitly. + * For example: + * ``` + * (cpuPlatform = "Intel Skylake") OR + * (cpuPlatform = "Intel Broadwell") AND + * (scheduling.automaticRestart = true) + * ``` + * + * If you want to use a regular expression, use the `eq` (equal) or `ne` + * (not equal) operator against a single un-parenthesized expression with or + * without quotes or against multiple parenthesized expressions. Examples: + * + * `fieldname eq unquoted literal` + * `fieldname eq 'single quoted literal'` + * `fieldname eq "double quoted literal"` + * `(fieldname1 eq literal) (fieldname2 ne "literal")` + * + * The literal value is interpreted as a regular expression using GoogleRE2 library syntax. + * The literal value must match the entire field. + * + * For example, to filter for instances that do not end with name "instance", + * you would use `name ne .*instance`. + * + * You cannot combine constraints on multiple fields using regular + * expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. + * If the number of available results is larger than `maxResults`, + * Compute Engine returns a `nextPageToken` that can be used to get + * the next page of results in subsequent list requests. Acceptable values are + * `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results + * are returned in alphanumerical order based on the resource name. + * + * You can also sort results in descending order based on the creation + * timestamp using `orderBy="creationTimestamp desc"`. This sorts + * results based on the `creationTimestamp` field in + * reverse chronological order (newest result first). Use this to sort + * resources like operations so that the newest operation is returned first. + * + * Currently, only sorting by `name` or + * `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the + * `nextPageToken` returned by a previous list request to get + * the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case + * of failure. The default value is false. + * + * For example, when partial success behavior is enabled, aggregatedList for a + * single zone scope either returns all resources in the zone or no resources, + * with an error code. + */ + returnPartialSuccess?: boolean; + /** + * Name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Zonevmextensionpolicies$Update + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so + * that if you must retry your request, the server will know to ignore the + * request if it has already been completed. + * + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same + * request ID, the server can check if original operation with the same + * request ID was received, and if so, will ignore the second request. This + * prevents clients from accidentally creating duplicate commitments. + * + * The request ID must be + * a valid UUID with the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the zone VM extension policy to update. + */ + vmExtensionPolicy?: string; + /** + * Name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$VmExtensionPolicy; + } } diff --git a/src/apis/compute/v1.ts b/src/apis/compute/v1.ts index 573d7d62ad..73503bfdba 100644 --- a/src/apis/compute/v1.ts +++ b/src/apis/compute/v1.ts @@ -415,6 +415,41 @@ export namespace compute_v1 { */ acceleratorType?: string | null; } + /** + * Info for accelerator topologies within a densely packed reservation. + */ + export interface Schema$AcceleratorTopologiesInfo { + /** + * Info for each accelerator topology. + */ + acceleratorTopologyInfos?: Schema$AcceleratorTopologiesInfoAcceleratorTopologyInfo[]; + } + /** + * Info for a slice of a given topology. + */ + export interface Schema$AcceleratorTopologiesInfoAcceleratorTopologyInfo { + /** + * The accelerator topology. + */ + acceleratorTopology?: string | null; + /** + * Info for each topology state. + */ + infoPerTopologyStates?: Schema$AcceleratorTopologiesInfoAcceleratorTopologyInfoInfoPerTopologyState[]; + } + /** + * Info for each topology state. + */ + export interface Schema$AcceleratorTopologiesInfoAcceleratorTopologyInfoInfoPerTopologyState { + /** + * The number of accelerator topologies in this state. + */ + count?: number | null; + /** + * The state of the accelerator topology. + */ + state?: string | null; + } /** * Represents an Accelerator Type resource. * @@ -2511,7 +2546,7 @@ export namespace compute_v1 { export interface Schema$BackendBucketCdnPolicyNegativeCachingPolicy { /** * The HTTP status code to define a TTL against. Only HTTP status codes - * 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be + * 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be * specified as values, and you cannot specify a status code more than * once. */ @@ -2605,7 +2640,8 @@ export namespace compute_v1 { maxUtilization?: number | null; /** * Name of a custom utilization signal. The name must be 1-64 characters - * long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the + * long and match the regular expression + * `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the * first character must be a lowercase letter, and all following * characters must be a dash, period, underscore, lowercase letter, or * digit, except the last character, which cannot be a dash, period, or @@ -3362,7 +3398,7 @@ export namespace compute_v1 { export interface Schema$BackendServiceCdnPolicyNegativeCachingPolicy { /** * The HTTP status code to define a TTL against. Only HTTP status codes - * 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be + * 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be * specified as values, and you cannot specify a status code more than * once. */ @@ -3458,7 +3494,8 @@ export namespace compute_v1 { dryRun?: boolean | null; /** * Name of a custom utilization signal. The name must be 1-64 characters - * long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the + * long and match the regular expression + * `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the * first character must be a lowercase letter, and all following * characters must be a dash, period, underscore, lowercase letter, or * digit, except the last character, which cannot be a dash, period, or @@ -7821,6 +7858,11 @@ export namespace compute_v1 { * Planning state before being submitted for evaluation */ planningStatus?: string | null; + /** + * The reservation mode which determines reservation-termination behavior and + * expected pricing. + */ + reservationMode?: string | null; /** * Name of reservations where the capacity is provisioned at the time of * delivery of future reservations. If the reservation with the given name @@ -8310,6 +8352,51 @@ export namespace compute_v1 { */ portSpecification?: string | null; } + export interface Schema$GRPCTLSHealthCheck { + /** + * The gRPC service name for the health check. This field is optional. The + * value of grpc_service_name has the following meanings by convention: + * + * - Empty service_name means the overall status of all services at the + * backend. + * + * - Non-empty service_name means the health of that gRPC service, as defined + * by the owner of the service. + * + * The grpc_service_name can only be ASCII. + */ + grpcServiceName?: string | null; + /** + * The TCP port number to which the health check prober sends packets. Valid + * values are 1 through 65535. + */ + port?: number | null; + /** + * Specifies how a port is selected for health checking. Can be one of the + * following values: + * USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services + * for passthrough load balancers and backend services for proxy load + * balancers. Not supported by target pools. The health check supports all + * backends supported by the backend service provided the backend can be + * health checked. For example, GCE_VM_IP network endpoint + * groups, GCE_VM_IP_PORT network endpoint groups, and instance + * group backends. + * USE_NAMED_PORT: Not supported. + * USE_SERVING_PORT: Provides an indirect method of specifying + * the health check port by referring to the backend service. Only supported + * by backend services for proxy load balancers. Not supported by target + * pools. Not supported by backend services for passthrough load balancers. + * Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group + * backends. + * + * For GCE_VM_IP_PORT network endpoint group backends, the health + * check uses the port number specified for each endpoint in the network + * endpoint group. For instance group backends, the health check uses the + * port number determined by looking up the backend service's named port in + * the instance group's list of named ports. + */ + portSpecification?: string | null; + } /** * A guest attributes entry. */ @@ -8436,6 +8523,7 @@ export namespace compute_v1 { */ description?: string | null; grpcHealthCheck?: Schema$GRPCHealthCheck; + grpcTlsHealthCheck?: Schema$GRPCTLSHealthCheck; /** * A so-far unhealthy instance will be marked healthy after this * many consecutive successes. The default value is 2. @@ -13145,6 +13233,11 @@ export namespace compute_v1 { * Interconnect. */ operationalStatus?: string | null; + /** + * Input only. [Input Only] Additional params passed with the request, but not persisted + * as part of resource payload. + */ + params?: Schema$InterconnectParams; /** * [Output Only] IP address configured on the customer side of the * Interconnect link. The customer should configure this IP address during @@ -13429,6 +13522,16 @@ export namespace compute_v1 { * [Output Only] Type of the resource. Alwayscompute#interconnectAttachment for interconnect attachments. */ kind?: string | null; + /** + * L2 Interconnect Attachment related config. This field is required if the + * type is L2_DEDICATED. + * + * The configuration specifies how VLAN tags (like dot1q, qinq, or dot1ad) + * within L2 packets are mapped to the destination appliances IP addresses. + * The packet is then encapsulated with the appliance IP address and sent to + * the edge appliance. + */ + l2Forwarding?: Schema$InterconnectAttachmentL2Forwarding; /** * A fingerprint for the labels being applied to this InterconnectAttachment, * which is essentially a hash of the labels set used for optimistic locking. @@ -13481,6 +13584,11 @@ export namespace compute_v1 { * Of the form "XXXXX/region/domain" */ pairingKey?: string | null; + /** + * Input only. [Input Only] Additional params passed with the request, but not persisted + * as part of resource payload. + */ + params?: Schema$InterconnectAttachmentParams; /** * Optional BGP ASN for the router supplied by a Layer 3 Partner if they * configured BGP on behalf of the customer. @@ -13595,6 +13703,8 @@ export namespace compute_v1 { * customer. * - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by * the partner. + * + * - L2_DEDICATED: a L2 attachment to a Dedicated Interconnect. */ type?: string | null; /** @@ -13950,6 +14060,110 @@ export namespace compute_v1 { */ status?: string | null; } + /** + * L2 Interconnect Attachment related configuration. + */ + export interface Schema$InterconnectAttachmentL2Forwarding { + /** + * Optional. A map of VLAN tags to appliances and optional inner mapping + * rules. If VLANs are not explicitly mapped to any appliance, the + * defaultApplianceIpAddress is used. + * + * Each VLAN tag can be a single number or a range of numbers in the range + * of 1 to 4094, e.g., "1" or "4001-4094". Non-empty and non-overlapping + * VLAN tag ranges are enforced, and violating operations will be rejected. + * + * The VLAN tags in the Ethernet header must use an ethertype value of + * 0x88A8 or 0x8100. + */ + applianceMappings?: { + [key: string]: Schema$InterconnectAttachmentL2ForwardingApplianceMapping; + } | null; + /** + * Optional. A single IPv4 or IPv6 address used as the default destination + * IP when there is no VLAN mapping result found. + * + * Unset field (null-value) indicates the unmatched packet should be + * dropped. + */ + defaultApplianceIpAddress?: string | null; + /** + * Optional. It represents the structure of a Geneve (Generic Network + * Virtualization Encapsulation) header, as defined in RFC8926. It encapsulates packets from various + * protocols (e.g., Ethernet, IPv4, IPv6) for use in network virtualization + * environments. + */ + geneveHeader?: Schema$InterconnectAttachmentL2ForwardingGeneveHeader; + /** + * Required. Resource URL of the network to which this attachment belongs. + */ + network?: string | null; + /** + * Required. A single IPv4 or IPv6 address. This address will be used as the + * source IP address for packets sent to the appliances, and must be used as + * the destination IP address for packets that should be sent out through + * this attachment. + */ + tunnelEndpointIpAddress?: string | null; + } + /** + * Two-level VLAN-to-Appliance mapping rule. + */ + export interface Schema$InterconnectAttachmentL2ForwardingApplianceMapping { + /** + * Optional. A single IPv4 or IPv6 address used as the destination IP + * address for ingress packets that match on a VLAN tag, but do not match + * a more specific inner VLAN tag. + * + * Unset field (null-value) indicates both VLAN tags are required to be + * mapped. Otherwise, defaultApplianceIpAddress is used. + */ + applianceIpAddress?: string | null; + /** + * Optional. Used to match against the inner VLAN when the packet + * contains two VLAN tags. + * + * A list of mapping rules from inner VLAN tags to IP addresses. If the + * inner VLAN is not explicitly mapped to an IP address range, the + * applianceIpAddress is used. + */ + innerVlanToApplianceMappings?: Schema$InterconnectAttachmentL2ForwardingApplianceMappingInnerVlanToApplianceMapping[]; + /** + * Optional. The name of this appliance mapping rule. + */ + name?: string | null; + } + /** + * The inner VLAN-to-Appliance mapping. + */ + export interface Schema$InterconnectAttachmentL2ForwardingApplianceMappingInnerVlanToApplianceMapping { + /** + * Required in this object. A single IPv4 or IPv6 address used as the + * destination IP address for ingress packets that match on both VLAN + * tags. + */ + innerApplianceIpAddress?: string | null; + /** + * Required in this object. Used to match the inner VLAN tag on the + * packet. Each entry can be a single number or a range of numbers in + * the range of 1 to 4094, e.g., ["1", "4001-4094"] is valid. Non-empty + * and Non-overlapping VLAN tag ranges are enforced, and violating + * operations will be rejected. + * + * The inner VLAN tags must have an ethertype value of 0x8100. + */ + innerVlanTags?: string[] | null; + } + /** + * GeneveHeader related configurations. + */ + export interface Schema$InterconnectAttachmentL2ForwardingGeneveHeader { + /** + * Optional. VNI is a 24-bit unique virtual network identifier, from 0 to + * 16,777,215. + */ + vni?: number | null; + } /** * Response to the list request, and contains a list of interconnect * attachments. @@ -13989,6 +14203,28 @@ export namespace compute_v1 { message?: string; } | null; } + /** + * Additional interconnect attachment parameters. + */ + export interface Schema$InterconnectAttachmentParams { + /** + * Tag keys/values directly bound to this resource. + * Tag keys and values have the same definition as resource + * manager tags. The field is allowed for INSERT + * only. The keys/values to set on the resource should be specified in + * either ID { : \} or Namespaced format + * { : \}. + * For example the following are valid inputs: + * * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"\} + * * {"123/environment" : "production", "345/abc" : "xyz"\} + * Note: + * * Invalid combinations of ID & namespaced format is not supported. For + * instance: {"123/environment" : "tagValues/444"\} is invalid. + * * Inconsistent format is not supported. For instance: + * {"tagKeys/333" : "tagValues/444", "123/env" : "prod"\} is invalid. + */ + resourceManagerTags?: {[key: string]: string} | null; + } /** * Informational metadata about Partner attachments from Partners to display * to customers. These fields are propagated from PARTNER_PROVIDER @@ -14216,7 +14452,7 @@ export namespace compute_v1 { * If provided when patching a configuration in update mode, the provided * token must match the current token or the update is rejected. This provides * a reliable means of doing read-modify-write (optimistic locking) as - * described byAPI 154. + * described by AIP 154. */ etag?: string | null; /** @@ -14804,6 +15040,11 @@ export namespace compute_v1 { * to a VM in this region. */ expectedRttMs?: string | null; + /** + * Identifies whether L2 Interconnect Attachments can be created in this + * region for interconnects that are in this location. + */ + l2ForwardingEnabled?: boolean | null; /** * Identifies the network presence of this location. */ @@ -14964,6 +15205,28 @@ export namespace compute_v1 { */ state?: string | null; } + /** + * Additional interconnect parameters. + */ + export interface Schema$InterconnectParams { + /** + * Tag keys/values directly bound to this resource. + * Tag keys and values have the same definition as resource + * manager tags. The field is allowed for INSERT + * only. The keys/values to set on the resource should be specified in + * either ID { : \} or Namespaced format + * { : \}. + * For example the following are valid inputs: + * * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"\} + * * {"123/environment" : "production", "345/abc" : "xyz"\} + * Note: + * * Invalid combinations of ID & namespaced format is not supported. For + * instance: {"123/environment" : "tagValues/444"\} is invalid. + * * Inconsistent format is not supported. For instance: + * {"tagKeys/333" : "tagValues/444", "123/env" : "prod"\} is invalid. + */ + resourceManagerTags?: {[key: string]: string} | null; + } /** * Represents a Cross-Cloud Interconnect Remote Location resource. * @@ -17097,6 +17360,11 @@ export namespace compute_v1 { * fingerprint must be provided in order to update theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date. */ fingerprint?: string | null; + /** + * Indicate whether igmp query is enabled on the network interface + * or not. If enabled, also indicates the version of IGMP supported. + */ + igmpQuery?: string | null; /** * The prefix length of the primary internal IPv6 range. */ @@ -17520,6 +17788,10 @@ export namespace compute_v1 { * Specifies whether cloud load balancing is allowed. */ allowLoadBalancing?: string | null; + /** + * Specifies whether multicast is allowed. + */ + allowMulticast?: string | null; /** * Specifies whether multi-nic in the same network is allowed. */ @@ -17569,6 +17841,10 @@ export namespace compute_v1 { * empty, all interface types are supported. */ interfaceTypes?: string[] | null; + /** + * Specifies which type of multicast is supported. + */ + multicast?: string | null; /** * Specifies which subnetwork purposes are supported. */ @@ -21317,6 +21593,12 @@ export namespace compute_v1 { * be a dash. */ name?: string | null; + /** + * Protection tier for the workload which specifies the workload expectations + * in the event of infrastructure failures at data center (e.g. power + * and/or cooling failures). + */ + protectionTier?: string | null; /** * Specify the reservation sharing policy. If unspecified, the reservation * will not be shared with Google Cloud managed services. @@ -21701,6 +21983,10 @@ export namespace compute_v1 { * Represents a reservation subBlock resource. */ export interface Schema$ReservationSubBlock { + /** + * [Output Only] Slice info for the reservation subBlock. + */ + acceleratorTopologiesInfo?: Schema$AcceleratorTopologiesInfo; /** * [Output Only] The number of hosts that are allocated in this * reservation subBlock. @@ -22587,7 +22873,9 @@ export namespace compute_v1 { */ priority?: number | null; /** - * [Output only] The status of the route. + * [Output only] The status of the route. This status only applies to + * dynamic routes learned by Cloud Routers. This status is not applicable + * to static routes. */ routeStatus?: string | null; /** @@ -25570,6 +25858,16 @@ export namespace compute_v1 { * A Shielded Instance Identity. */ export interface Schema$ShieldedInstanceIdentity { + /** + * An Endorsement Key (EK) made by the ECC P256 algorithm + * issued to the Shielded Instance's vTPM. + */ + eccP256EncryptionKey?: Schema$ShieldedInstanceIdentityEntry; + /** + * An Attestation Key (AK) made by the ECC P256 algorithm + * issued to the Shielded Instance's vTPM. + */ + eccP256SigningKey?: Schema$ShieldedInstanceIdentityEntry; /** * An Endorsement Key (EK) made by the RSA 2048 algorithm * issued to the Shielded Instance's vTPM. @@ -31146,6 +31444,24 @@ export namespace compute_v1 { */ labels?: {[key: string]: string} | null; } + export interface Schema$ZoneSetNestedPolicyRequest { + /** + * Flatten Policy to create a backwacd compatible wire-format. + * Deprecated. Use 'policy' to specify bindings. + */ + bindings?: Schema$Binding[]; + /** + * Flatten Policy to create a backward compatible wire-format. + * Deprecated. Use 'policy' to specify the etag. + */ + etag?: string | null; + /** + * REQUIRED: The complete policy to be applied to the 'resource'. The size of + * the policy is limited to a few 10s of KB. An empty policy is in general a + * valid policy but certain services (like Projects) might reject them. + */ + policy?: Schema$Policy; + } export interface Schema$ZoneSetPolicyRequest { /** * Flatten Policy to create a backwacd compatible wire-format. @@ -31174,7 +31490,7 @@ export namespace compute_v1 { /** * Retrieves an aggregated list of accelerator types. * - * To prevent failure, Google recommends that you set the + * To prevent failure, it is recommended that you set the * `returnPartialSuccess` parameter to `true`. * @example * ```js @@ -32074,7 +32390,7 @@ export namespace compute_v1 { /** * Retrieves an aggregated list of addresses. * - * To prevent failure, Google recommends that you set the + * To prevent failure, it is recommended that you set the * `returnPartialSuccess` parameter to `true`. * @example * ```js @@ -34066,7 +34382,7 @@ export namespace compute_v1 { /** * Retrieves an aggregated list of autoscalers. * - * To prevent failure, Google recommends that you set the + * To prevent failure, it is recommended that you set the * `returnPartialSuccess` parameter to `true`. * @example * ```js @@ -38707,7 +39023,7 @@ export namespace compute_v1 { * Retrieves the list of all BackendService resources, regional and global, * available to the specified project. * - * To prevent failure, Google recommends that you set the + * To prevent failure, it is recommended that you set the * `returnPartialSuccess` parameter to `true`. * @example * ```js @@ -43936,7 +44252,7 @@ export namespace compute_v1 { /** * Retrieves an aggregated list of persistent disks. * - * To prevent failure, Google recommends that you set the + * To prevent failure, it is recommended that you set the * `returnPartialSuccess` parameter to `true`. * @example * ```js @@ -48301,7 +48617,7 @@ export namespace compute_v1 { /** * Retrieves an aggregated list of disk types. * - * To prevent failure, Google recommends that you set the + * To prevent failure, it is recommended that you set the * `returnPartialSuccess` parameter to `true`. * @example * ```js @@ -55196,6 +55512,162 @@ export namespace compute_v1 { } } + /** + * Returns permissions that a caller has on the specified resource. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const compute = google.compute('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await compute.firewalls.testIamPermissions({ + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "permissions": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + testIamPermissions( + params: Params$Resource$Firewalls$Testiampermissions, + options: StreamMethodOptions + ): Promise>; + testIamPermissions( + params?: Params$Resource$Firewalls$Testiampermissions, + options?: MethodOptions + ): Promise>; + testIamPermissions( + params: Params$Resource$Firewalls$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Firewalls$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Firewalls$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Firewalls$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Firewalls$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Firewalls$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/global/firewalls/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'resource'], + pathParams: ['project', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Updates the specified firewall rule with the data included in the * request. @@ -55606,6 +56078,22 @@ export namespace compute_v1 { */ requestBody?: Schema$Firewall; } + export interface Params$Resource$Firewalls$Testiampermissions + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } export interface Params$Resource$Firewalls$Update extends StandardParameters { /** * Name of the firewall rule to update. @@ -55647,7 +56135,7 @@ export namespace compute_v1 { /** * Retrieves an aggregated list of forwarding rules. * - * To prevent failure, Google recommends that you set the + * To prevent failure, it is recommended that you set the * `returnPartialSuccess` parameter to `true`. * @example * ```js @@ -57780,7 +58268,7 @@ export namespace compute_v1 { /** * Retrieves an aggregated list of future reservations. * - * To prevent failure, recommendation is that you set the + * To prevent failure, it is recommended that you set the * `returnPartialSuccess` parameter to `true`. * @example * ```js @@ -58467,6 +58955,7 @@ export namespace compute_v1 { * // "name": "my_name", * // "namePrefix": "my_namePrefix", * // "planningStatus": "my_planningStatus", + * // "reservationMode": "my_reservationMode", * // "reservationName": "my_reservationName", * // "schedulingType": "my_schedulingType", * // "selfLink": "my_selfLink", @@ -58647,6 +59136,7 @@ export namespace compute_v1 { * // "name": "my_name", * // "namePrefix": "my_namePrefix", * // "planningStatus": "my_planningStatus", + * // "reservationMode": "my_reservationMode", * // "reservationName": "my_reservationName", * // "schedulingType": "my_schedulingType", * // "selfLink": "my_selfLink", @@ -59110,6 +59600,7 @@ export namespace compute_v1 { * // "name": "my_name", * // "namePrefix": "my_namePrefix", * // "planningStatus": "my_planningStatus", + * // "reservationMode": "my_reservationMode", * // "reservationName": "my_reservationName", * // "schedulingType": "my_schedulingType", * // "selfLink": "my_selfLink", @@ -68278,6 +68769,7 @@ export namespace compute_v1 { * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", * // "grpcHealthCheck": {}, + * // "grpcTlsHealthCheck": {}, * // "healthyThreshold": 0, * // "http2HealthCheck": {}, * // "httpHealthCheck": {}, @@ -68452,6 +68944,7 @@ export namespace compute_v1 { * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", * // "grpcHealthCheck": {}, + * // "grpcTlsHealthCheck": {}, * // "healthyThreshold": 0, * // "http2HealthCheck": {}, * // "httpHealthCheck": {}, @@ -68898,6 +69391,7 @@ export namespace compute_v1 { * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", * // "grpcHealthCheck": {}, + * // "grpcTlsHealthCheck": {}, * // "healthyThreshold": 0, * // "http2HealthCheck": {}, * // "httpHealthCheck": {}, @@ -69108,6 +69602,7 @@ export namespace compute_v1 { * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", * // "grpcHealthCheck": {}, + * // "grpcTlsHealthCheck": {}, * // "healthyThreshold": 0, * // "http2HealthCheck": {}, * // "httpHealthCheck": {}, @@ -85592,6 +86087,7 @@ export namespace compute_v1 { * // "accessConfigs": [], * // "aliasIpRanges": [], * // "fingerprint": "my_fingerprint", + * // "igmpQuery": "my_igmpQuery", * // "internalIpv6PrefixLength": 0, * // "ipv6AccessConfigs": [], * // "ipv6AccessType": "my_ipv6AccessType", @@ -88385,6 +88881,8 @@ export namespace compute_v1 { * * // Example response * // { + * // "eccP256EncryptionKey": {}, + * // "eccP256SigningKey": {}, * // "encryptionKey": {}, * // "kind": "my_kind", * // "signingKey": {} @@ -94841,6 +95339,7 @@ export namespace compute_v1 { * // "accessConfigs": [], * // "aliasIpRanges": [], * // "fingerprint": "my_fingerprint", + * // "igmpQuery": "my_igmpQuery", * // "internalIpv6PrefixLength": 0, * // "ipv6AccessConfigs": [], * // "ipv6AccessType": "my_ipv6AccessType", @@ -103917,12 +104416,14 @@ export namespace compute_v1 { * // "interconnect": "my_interconnect", * // "ipsecInternalAddresses": [], * // "kind": "my_kind", + * // "l2Forwarding": {}, * // "labelFingerprint": "my_labelFingerprint", * // "labels": {}, * // "mtu": 0, * // "name": "my_name", * // "operationalStatus": "my_operationalStatus", * // "pairingKey": "my_pairingKey", + * // "params": {}, * // "partnerAsn": "my_partnerAsn", * // "partnerMetadata": {}, * // "privateInterconnectInfo": {}, @@ -104119,12 +104620,14 @@ export namespace compute_v1 { * // "interconnect": "my_interconnect", * // "ipsecInternalAddresses": [], * // "kind": "my_kind", + * // "l2Forwarding": {}, * // "labelFingerprint": "my_labelFingerprint", * // "labels": {}, * // "mtu": 0, * // "name": "my_name", * // "operationalStatus": "my_operationalStatus", * // "pairingKey": "my_pairingKey", + * // "params": {}, * // "partnerAsn": "my_partnerAsn", * // "partnerMetadata": {}, * // "privateInterconnectInfo": {}, @@ -104597,12 +105100,14 @@ export namespace compute_v1 { * // "interconnect": "my_interconnect", * // "ipsecInternalAddresses": [], * // "kind": "my_kind", + * // "l2Forwarding": {}, * // "labelFingerprint": "my_labelFingerprint", * // "labels": {}, * // "mtu": 0, * // "name": "my_name", * // "operationalStatus": "my_operationalStatus", * // "pairingKey": "my_pairingKey", + * // "params": {}, * // "partnerAsn": "my_partnerAsn", * // "partnerMetadata": {}, * // "privateInterconnectInfo": {}, @@ -108724,6 +109229,7 @@ export namespace compute_v1 { * // "name": "my_name", * // "nocContactEmail": "my_nocContactEmail", * // "operationalStatus": "my_operationalStatus", + * // "params": {}, * // "peerIpAddress": "my_peerIpAddress", * // "provisionedLinkCount": 0, * // "remoteLocation": "my_remoteLocation", @@ -109233,6 +109739,7 @@ export namespace compute_v1 { * // "name": "my_name", * // "nocContactEmail": "my_nocContactEmail", * // "operationalStatus": "my_operationalStatus", + * // "params": {}, * // "peerIpAddress": "my_peerIpAddress", * // "provisionedLinkCount": 0, * // "remoteLocation": "my_remoteLocation", @@ -109693,6 +110200,7 @@ export namespace compute_v1 { * // "name": "my_name", * // "nocContactEmail": "my_nocContactEmail", * // "operationalStatus": "my_operationalStatus", + * // "params": {}, * // "peerIpAddress": "my_peerIpAddress", * // "provisionedLinkCount": 0, * // "remoteLocation": "my_remoteLocation", @@ -121390,7 +121898,7 @@ export namespace compute_v1 { * firewall policies from all applicable scopes (global and regional) and * grouping the results per scope. * - * To prevent failure, Google recommends that you set the + * To prevent failure, it is recommended that you set the * `returnPartialSuccess` parameter to `true`. * @example * ```js @@ -142870,10 +143378,13 @@ export namespace compute_v1 { } /** + * Moves a persistent disk from one zone to another. + * *Note*: The moveDisk API will be deprecated on September 29, 2026. + * * Starting September 29, 2025, you can't use the moveDisk API on new * projects. To move a disk to a different region or zone, follow the steps in * [Change the location of a - * disk](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd). + * disk](https://cloud.google.com/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd). * * Projects that already use the moveDisk API can continue usage until * September 29, 2026. @@ -152592,7 +153103,7 @@ export namespace compute_v1 { /** * Retrieves an aggregated list of commitments by region. * - * To prevent failure, Google recommends that you set the + * To prevent failure, it is recommended that you set the * `returnPartialSuccess` parameter to `true`. * @example * ```js @@ -158727,6 +159238,7 @@ export namespace compute_v1 { * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", * // "grpcHealthCheck": {}, + * // "grpcTlsHealthCheck": {}, * // "healthyThreshold": 0, * // "http2HealthCheck": {}, * // "httpHealthCheck": {}, @@ -158904,6 +159416,7 @@ export namespace compute_v1 { * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", * // "grpcHealthCheck": {}, + * // "grpcTlsHealthCheck": {}, * // "healthyThreshold": 0, * // "http2HealthCheck": {}, * // "httpHealthCheck": {}, @@ -159356,6 +159869,7 @@ export namespace compute_v1 { * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", * // "grpcHealthCheck": {}, + * // "grpcTlsHealthCheck": {}, * // "healthyThreshold": 0, * // "http2HealthCheck": {}, * // "httpHealthCheck": {}, @@ -159568,6 +160082,7 @@ export namespace compute_v1 { * // "creationTimestamp": "my_creationTimestamp", * // "description": "my_description", * // "grpcHealthCheck": {}, + * // "grpcTlsHealthCheck": {}, * // "healthyThreshold": 0, * // "http2HealthCheck": {}, * // "httpHealthCheck": {}, @@ -190196,6 +190711,160 @@ export namespace compute_v1 { } } + /** + * Gets the access control policy for a resource. May be empty if no such + * policy or resource exists. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const compute = google.compute('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await compute.reservationBlocks.getIamPolicy({ + * // Requested IAM Policy version. + * optionsRequestedPolicyVersion: 'placeholder-value', + * // Name or id of parent resource of the resource for this request. + * parentResource: '[a-z](?:[-a-zA-Z0-9/]{0,255}[a-zA-Z0-9])?', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Reservationblocks$Getiampolicy, + options: StreamMethodOptions + ): Promise>; + getIamPolicy( + params?: Params$Resource$Reservationblocks$Getiampolicy, + options?: MethodOptions + ): Promise>; + getIamPolicy( + params: Params$Resource$Reservationblocks$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Reservationblocks$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Reservationblocks$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Reservationblocks$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Reservationblocks$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reservationblocks$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/reservations/{parentResource}/reservationBlocks/{resource}/getIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'parentResource', 'resource'], + pathParams: ['parentResource', 'project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Retrieves a list of reservation blocks under a single reservation. * @example @@ -190635,201 +191304,593 @@ export namespace compute_v1 { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Reservationblocks$Get - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the reservation. - * Name should conform to RFC1035 or be a resource ID. - */ - reservation?: string; - /** - * The name of the reservation block. - * Name should conform to RFC1035 or be a resource ID. - */ - reservationBlock?: string; - /** - * View of the Block. - */ - view?: string; - /** - * Name of the zone for this request. Zone name should conform to RFC1035. - */ - zone?: string; - } - export interface Params$Resource$Reservationblocks$List - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most - * Compute resources support two types of filter expressions: - * expressions that support regular expressions and expressions that follow - * API improvement proposal AIP-160. - * These two types of filter expressions cannot be mixed in one request. - * - * If you want to use AIP-160, your expression must specify the field name, an - * operator, and the value that you want to use for filtering. The value - * must be a string, a number, or a boolean. The operator - * must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. - * - * For example, if you are filtering Compute Engine instances, you can - * exclude instances named `example-instance` by specifying - * `name != example-instance`. - * - * The `:*` comparison can be used to test whether a key has been defined. - * For example, to find all objects with `owner` label use: - * ``` - * labels.owner:* - * ``` - * - * You can also filter nested fields. For example, you could specify - * `scheduling.automaticRestart = false` to include instances only - * if they are not scheduled for automatic restarts. You can use filtering - * on nested fields to filter based onresource labels. - * - * To filter on multiple expressions, provide each separate expression within - * parentheses. For example: - * ``` - * (scheduling.automaticRestart = true) - * (cpuPlatform = "Intel Skylake") - * ``` - * By default, each expression is an `AND` expression. However, you - * can include `AND` and `OR` expressions explicitly. - * For example: - * ``` - * (cpuPlatform = "Intel Skylake") OR - * (cpuPlatform = "Intel Broadwell") AND - * (scheduling.automaticRestart = true) - * ``` - * - * If you want to use a regular expression, use the `eq` (equal) or `ne` - * (not equal) operator against a single un-parenthesized expression with or - * without quotes or against multiple parenthesized expressions. Examples: - * - * `fieldname eq unquoted literal` - * `fieldname eq 'single quoted literal'` - * `fieldname eq "double quoted literal"` - * `(fieldname1 eq literal) (fieldname2 ne "literal")` - * - * The literal value is interpreted as a regular expression using GoogleRE2 library syntax. - * The literal value must match the entire field. - * - * For example, to filter for instances that do not end with name "instance", - * you would use `name ne .*instance`. - * - * You cannot combine constraints on multiple fields using regular - * expressions. - */ - filter?: string; - /** - * The maximum number of results per page that should be returned. - * If the number of available results is larger than `maxResults`, - * Compute Engine returns a `nextPageToken` that can be used to get - * the next page of results in subsequent list requests. Acceptable values are - * `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results - * are returned in alphanumerical order based on the resource name. - * - * You can also sort results in descending order based on the creation - * timestamp using `orderBy="creationTimestamp desc"`. This sorts - * results based on the `creationTimestamp` field in - * reverse chronological order (newest result first). Use this to sort - * resources like operations so that the newest operation is returned first. - * - * Currently, only sorting by `name` or - * `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the - * `nextPageToken` returned by a previous list request to get - * the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * The name of the reservation. - * Name should conform to RFC1035 or be a resource ID. - */ - reservation?: string; - /** - * Opt-in for partial success behavior which provides partial results in case - * of failure. The default value is false. - * - * For example, when partial success behavior is enabled, aggregatedList for a - * single zone scope either returns all resources in the zone or no resources, - * with an error code. - */ - returnPartialSuccess?: boolean; - /** - * Name of the zone for this request. Zone name should conform to RFC1035. - */ - zone?: string; - } - export interface Params$Resource$Reservationblocks$Performmaintenance - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so - * that if you must retry your request, the server will know to ignore the - * request if it has already been completed. - * - * For example, consider a situation where you make an initial request and - * the request times out. If you make the request again with the same - * request ID, the server can check if original operation with the same - * request ID was received, and if so, will ignore the second request. This - * prevents clients from accidentally creating duplicate commitments. - * - * The request ID must be - * a valid UUID with the exception that zero UUID is not supported - * (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the reservation. - * Name should conform to RFC1035 or be a resource ID. - */ - reservation?: string; - /** - * The name of the reservation block. - * Name should conform to RFC1035 or be a resource ID. - */ - reservationBlock?: string; - /** - * Name of the zone for this request. Zone name should conform to RFC1035. - */ - zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ReservationsBlocksPerformMaintenanceRequest; - } - - export class Resource$Reservations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Retrieves an aggregated list of reservations. - * - * To prevent failure, Google recommends that you set the - * `returnPartialSuccess` parameter to `true`. + * Sets the access control policy on the specified resource. + * Replaces any existing policy. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const compute = google.compute('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await compute.reservationBlocks.setIamPolicy({ + * // Name or id of parent resource of the resource for this request. + * parentResource: '[a-z](?:[-a-zA-Z0-9/]{0,255}[a-zA-Z0-9])?', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bindings": [], + * // "etag": "my_etag", + * // "policy": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Reservationblocks$Setiampolicy, + options: StreamMethodOptions + ): Promise>; + setIamPolicy( + params?: Params$Resource$Reservationblocks$Setiampolicy, + options?: MethodOptions + ): Promise>; + setIamPolicy( + params: Params$Resource$Reservationblocks$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Reservationblocks$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Reservationblocks$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Reservationblocks$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Reservationblocks$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reservationblocks$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/reservations/{parentResource}/reservationBlocks/{resource}/setIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'parentResource', 'resource'], + pathParams: ['parentResource', 'project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns permissions that a caller has on the specified resource. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const compute = google.compute('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await compute.reservationBlocks.testIamPermissions({ + * // Name or id of parent resource of the resource for this request. + * parentResource: '[a-z](?:[-a-zA-Z0-9/]{0,255}[a-zA-Z0-9])?', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "permissions": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + testIamPermissions( + params: Params$Resource$Reservationblocks$Testiampermissions, + options: StreamMethodOptions + ): Promise>; + testIamPermissions( + params?: Params$Resource$Reservationblocks$Testiampermissions, + options?: MethodOptions + ): Promise>; + testIamPermissions( + params: Params$Resource$Reservationblocks$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Reservationblocks$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Reservationblocks$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Reservationblocks$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Reservationblocks$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reservationblocks$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/reservations/{parentResource}/reservationBlocks/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'parentResource', 'resource'], + pathParams: ['parentResource', 'project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Reservationblocks$Get + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the reservation. + * Name should conform to RFC1035 or be a resource ID. + */ + reservation?: string; + /** + * The name of the reservation block. + * Name should conform to RFC1035 or be a resource ID. + */ + reservationBlock?: string; + /** + * View of the Block. + */ + view?: string; + /** + * Name of the zone for this request. Zone name should conform to RFC1035. + */ + zone?: string; + } + export interface Params$Resource$Reservationblocks$Getiampolicy + extends StandardParameters { + /** + * Requested IAM Policy version. + */ + optionsRequestedPolicyVersion?: number; + /** + * Name or id of parent resource of the resource for this request. + */ + parentResource?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Reservationblocks$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most + * Compute resources support two types of filter expressions: + * expressions that support regular expressions and expressions that follow + * API improvement proposal AIP-160. + * These two types of filter expressions cannot be mixed in one request. + * + * If you want to use AIP-160, your expression must specify the field name, an + * operator, and the value that you want to use for filtering. The value + * must be a string, a number, or a boolean. The operator + * must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. + * + * For example, if you are filtering Compute Engine instances, you can + * exclude instances named `example-instance` by specifying + * `name != example-instance`. + * + * The `:*` comparison can be used to test whether a key has been defined. + * For example, to find all objects with `owner` label use: + * ``` + * labels.owner:* + * ``` + * + * You can also filter nested fields. For example, you could specify + * `scheduling.automaticRestart = false` to include instances only + * if they are not scheduled for automatic restarts. You can use filtering + * on nested fields to filter based onresource labels. + * + * To filter on multiple expressions, provide each separate expression within + * parentheses. For example: + * ``` + * (scheduling.automaticRestart = true) + * (cpuPlatform = "Intel Skylake") + * ``` + * By default, each expression is an `AND` expression. However, you + * can include `AND` and `OR` expressions explicitly. + * For example: + * ``` + * (cpuPlatform = "Intel Skylake") OR + * (cpuPlatform = "Intel Broadwell") AND + * (scheduling.automaticRestart = true) + * ``` + * + * If you want to use a regular expression, use the `eq` (equal) or `ne` + * (not equal) operator against a single un-parenthesized expression with or + * without quotes or against multiple parenthesized expressions. Examples: + * + * `fieldname eq unquoted literal` + * `fieldname eq 'single quoted literal'` + * `fieldname eq "double quoted literal"` + * `(fieldname1 eq literal) (fieldname2 ne "literal")` + * + * The literal value is interpreted as a regular expression using GoogleRE2 library syntax. + * The literal value must match the entire field. + * + * For example, to filter for instances that do not end with name "instance", + * you would use `name ne .*instance`. + * + * You cannot combine constraints on multiple fields using regular + * expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. + * If the number of available results is larger than `maxResults`, + * Compute Engine returns a `nextPageToken` that can be used to get + * the next page of results in subsequent list requests. Acceptable values are + * `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results + * are returned in alphanumerical order based on the resource name. + * + * You can also sort results in descending order based on the creation + * timestamp using `orderBy="creationTimestamp desc"`. This sorts + * results based on the `creationTimestamp` field in + * reverse chronological order (newest result first). Use this to sort + * resources like operations so that the newest operation is returned first. + * + * Currently, only sorting by `name` or + * `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the + * `nextPageToken` returned by a previous list request to get + * the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the reservation. + * Name should conform to RFC1035 or be a resource ID. + */ + reservation?: string; + /** + * Opt-in for partial success behavior which provides partial results in case + * of failure. The default value is false. + * + * For example, when partial success behavior is enabled, aggregatedList for a + * single zone scope either returns all resources in the zone or no resources, + * with an error code. + */ + returnPartialSuccess?: boolean; + /** + * Name of the zone for this request. Zone name should conform to RFC1035. + */ + zone?: string; + } + export interface Params$Resource$Reservationblocks$Performmaintenance + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so + * that if you must retry your request, the server will know to ignore the + * request if it has already been completed. + * + * For example, consider a situation where you make an initial request and + * the request times out. If you make the request again with the same + * request ID, the server can check if original operation with the same + * request ID was received, and if so, will ignore the second request. This + * prevents clients from accidentally creating duplicate commitments. + * + * The request ID must be + * a valid UUID with the exception that zero UUID is not supported + * (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the reservation. + * Name should conform to RFC1035 or be a resource ID. + */ + reservation?: string; + /** + * The name of the reservation block. + * Name should conform to RFC1035 or be a resource ID. + */ + reservationBlock?: string; + /** + * Name of the zone for this request. Zone name should conform to RFC1035. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ReservationsBlocksPerformMaintenanceRequest; + } + export interface Params$Resource$Reservationblocks$Setiampolicy + extends StandardParameters { + /** + * Name or id of parent resource of the resource for this request. + */ + parentResource?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ZoneSetNestedPolicyRequest; + } + export interface Params$Resource$Reservationblocks$Testiampermissions + extends StandardParameters { + /** + * Name or id of parent resource of the resource for this request. + */ + parentResource?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Reservations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves an aggregated list of reservations. + * + * To prevent failure, it is recommended that you set the + * `returnPartialSuccess` parameter to `true`. * @example * ```js * // Before running the sample: @@ -191322,6 +192383,7 @@ export namespace compute_v1 { * // "kind": "my_kind", * // "linkedCommitments": [], * // "name": "my_name", + * // "protectionTier": "my_protectionTier", * // "reservationSharingPolicy": {}, * // "resourcePolicies": {}, * // "resourceStatus": {}, @@ -191654,6 +192716,7 @@ export namespace compute_v1 { * // "kind": "my_kind", * // "linkedCommitments": [], * // "name": "my_name", + * // "protectionTier": "my_protectionTier", * // "reservationSharingPolicy": {}, * // "resourcePolicies": {}, * // "resourceStatus": {}, @@ -192813,6 +193876,7 @@ export namespace compute_v1 { * // "kind": "my_kind", * // "linkedCommitments": [], * // "name": "my_name", + * // "protectionTier": "my_protectionTier", * // "reservationSharingPolicy": {}, * // "resourcePolicies": {}, * // "resourceStatus": {}, @@ -193488,6 +194552,8 @@ export namespace compute_v1 { * // The name of the reservation subBlock. * // Name should conform to RFC1035 or be a resource ID. * reservationSubBlock: 'placeholder-value', + * // View of the subBlock. + * view: 'placeholder-value', * // Name of the zone for this request. Zone name should conform to RFC1035. * zone: 'placeholder-value', * }); @@ -193605,6 +194671,160 @@ export namespace compute_v1 { } } + /** + * Gets the access control policy for a resource. May be empty if no such + * policy or resource exists. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const compute = google.compute('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await compute.reservationSubBlocks.getIamPolicy({ + * // Requested IAM Policy version. + * optionsRequestedPolicyVersion: 'placeholder-value', + * // Name or id of parent resource of the resource for this request. + * parentResource: '[a-z](?:[-a-zA-Z0-9/]{0,255}[a-zA-Z0-9])?', + * // Project ID for this request. + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Reservationsubblocks$Getiampolicy, + options: StreamMethodOptions + ): Promise>; + getIamPolicy( + params?: Params$Resource$Reservationsubblocks$Getiampolicy, + options?: MethodOptions + ): Promise>; + getIamPolicy( + params: Params$Resource$Reservationsubblocks$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Reservationsubblocks$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Reservationsubblocks$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Reservationsubblocks$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Reservationsubblocks$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reservationsubblocks$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/getIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'parentResource', 'resource'], + pathParams: ['parentResource', 'project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Retrieves a list of reservation subBlocks under a single reservation. * @example @@ -193887,62 +195107,430 @@ export namespace compute_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.reservationSubBlocks.performMaintenance({ - * // The name of the parent reservation and parent block. In the format of - * // reservations/{reservation_name\}/reservationBlocks/{reservation_block_name\} - * parentName: 'placeholder-value', + * const res = await compute.reservationSubBlocks.performMaintenance({ + * // The name of the parent reservation and parent block. In the format of + * // reservations/{reservation_name\}/reservationBlocks/{reservation_block_name\} + * parentName: 'placeholder-value', + * // Project ID for this request. + * project: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so + * // that if you must retry your request, the server will know to ignore the + * // request if it has already been completed. + * // + * // For example, consider a situation where you make an initial request and + * // the request times out. If you make the request again with the same + * // request ID, the server can check if original operation with the same + * // request ID was received, and if so, will ignore the second request. This + * // prevents clients from accidentally creating duplicate commitments. + * // + * // The request ID must be + * // a valid UUID with the exception that zero UUID is not supported + * // (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // The name of the reservation subBlock. + * // Name should conform to RFC1035 or be a resource ID. + * reservationSubBlock: 'placeholder-value', + * // Name of the zone for this request. Zone name should conform to RFC1035. + * zone: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + performMaintenance( + params: Params$Resource$Reservationsubblocks$Performmaintenance, + options: StreamMethodOptions + ): Promise>; + performMaintenance( + params?: Params$Resource$Reservationsubblocks$Performmaintenance, + options?: MethodOptions + ): Promise>; + performMaintenance( + params: Params$Resource$Reservationsubblocks$Performmaintenance, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + performMaintenance( + params: Params$Resource$Reservationsubblocks$Performmaintenance, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + performMaintenance( + params: Params$Resource$Reservationsubblocks$Performmaintenance, + callback: BodyResponseCallback + ): void; + performMaintenance(callback: BodyResponseCallback): void; + performMaintenance( + paramsOrCallback?: + | Params$Resource$Reservationsubblocks$Performmaintenance + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Reservationsubblocks$Performmaintenance; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reservationsubblocks$Performmaintenance; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/performMaintenance' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: [ + 'project', + 'zone', + 'parentName', + 'reservationSubBlock', + ], + pathParams: ['parentName', 'project', 'reservationSubBlock', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Allows customers to report a faulty subBlock. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const compute = google.compute('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await compute.reservationSubBlocks.reportFaulty({ + * // The name of the parent reservation and parent block. In the format of + * // reservations/{reservation_name\}/reservationBlocks/{reservation_block_name\} + * parentName: 'placeholder-value', + * // Project ID for this request. + * project: 'placeholder-value', + * // An optional request ID to identify requests. Specify a unique request ID so + * // that if you must retry your request, the server will know to ignore the + * // request if it has already been completed. + * // + * // For example, consider a situation where you make an initial request and + * // the request times out. If you make the request again with the same + * // request ID, the server can check if original operation with the same + * // request ID was received, and if so, will ignore the second request. This + * // prevents clients from accidentally creating duplicate commitments. + * // + * // The request ID must be + * // a valid UUID with the exception that zero UUID is not supported + * // (00000000-0000-0000-0000-000000000000). + * requestId: 'placeholder-value', + * // The name of the reservation subBlock. + * // Name should conform to RFC1035 or be a resource ID. + * reservationSubBlock: 'placeholder-value', + * // Name of the zone for this request. Zone name should conform to RFC1035. + * zone: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "disruptionSchedule": "my_disruptionSchedule", + * // "failureComponent": "my_failureComponent", + * // "faultReasons": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientOperationId": "my_clientOperationId", + * // "creationTimestamp": "my_creationTimestamp", + * // "description": "my_description", + * // "endTime": "my_endTime", + * // "error": {}, + * // "httpErrorMessage": "my_httpErrorMessage", + * // "httpErrorStatusCode": 0, + * // "id": "my_id", + * // "insertTime": "my_insertTime", + * // "instancesBulkInsertOperationMetadata": {}, + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationGroupId": "my_operationGroupId", + * // "operationType": "my_operationType", + * // "progress": 0, + * // "region": "my_region", + * // "selfLink": "my_selfLink", + * // "setCommonInstanceMetadataOperationMetadata": {}, + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "statusMessage": "my_statusMessage", + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "user": "my_user", + * // "warnings": [], + * // "zone": "my_zone" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + reportFaulty( + params: Params$Resource$Reservationsubblocks$Reportfaulty, + options: StreamMethodOptions + ): Promise>; + reportFaulty( + params?: Params$Resource$Reservationsubblocks$Reportfaulty, + options?: MethodOptions + ): Promise>; + reportFaulty( + params: Params$Resource$Reservationsubblocks$Reportfaulty, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + reportFaulty( + params: Params$Resource$Reservationsubblocks$Reportfaulty, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + reportFaulty( + params: Params$Resource$Reservationsubblocks$Reportfaulty, + callback: BodyResponseCallback + ): void; + reportFaulty(callback: BodyResponseCallback): void; + reportFaulty( + paramsOrCallback?: + | Params$Resource$Reservationsubblocks$Reportfaulty + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Reservationsubblocks$Reportfaulty; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reservationsubblocks$Reportfaulty; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/reportFaulty' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: [ + 'project', + 'zone', + 'parentName', + 'reservationSubBlock', + ], + pathParams: ['parentName', 'project', 'reservationSubBlock', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the access control policy on the specified resource. + * Replaces any existing policy. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/compute.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const compute = google.compute('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/compute', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await compute.reservationSubBlocks.setIamPolicy({ + * // Name or id of parent resource of the resource for this request. + * parentResource: '[a-z](?:[-a-zA-Z0-9/]{0,255}[a-zA-Z0-9])?', * // Project ID for this request. - * project: 'placeholder-value', - * // An optional request ID to identify requests. Specify a unique request ID so - * // that if you must retry your request, the server will know to ignore the - * // request if it has already been completed. - * // - * // For example, consider a situation where you make an initial request and - * // the request times out. If you make the request again with the same - * // request ID, the server can check if original operation with the same - * // request ID was received, and if so, will ignore the second request. This - * // prevents clients from accidentally creating duplicate commitments. - * // - * // The request ID must be - * // a valid UUID with the exception that zero UUID is not supported - * // (00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * // The name of the reservation subBlock. - * // Name should conform to RFC1035 or be a resource ID. - * reservationSubBlock: 'placeholder-value', - * // Name of the zone for this request. Zone name should conform to RFC1035. - * zone: 'placeholder-value', + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bindings": [], + * // "etag": "my_etag", + * // "policy": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "auditConfigs": [], + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -193958,53 +195546,53 @@ export namespace compute_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - performMaintenance( - params: Params$Resource$Reservationsubblocks$Performmaintenance, + setIamPolicy( + params: Params$Resource$Reservationsubblocks$Setiampolicy, options: StreamMethodOptions ): Promise>; - performMaintenance( - params?: Params$Resource$Reservationsubblocks$Performmaintenance, + setIamPolicy( + params?: Params$Resource$Reservationsubblocks$Setiampolicy, options?: MethodOptions - ): Promise>; - performMaintenance( - params: Params$Resource$Reservationsubblocks$Performmaintenance, + ): Promise>; + setIamPolicy( + params: Params$Resource$Reservationsubblocks$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - performMaintenance( - params: Params$Resource$Reservationsubblocks$Performmaintenance, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Reservationsubblocks$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - performMaintenance( - params: Params$Resource$Reservationsubblocks$Performmaintenance, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Reservationsubblocks$Setiampolicy, + callback: BodyResponseCallback ): void; - performMaintenance(callback: BodyResponseCallback): void; - performMaintenance( + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( paramsOrCallback?: - | Params$Resource$Reservationsubblocks$Performmaintenance - | BodyResponseCallback + | Params$Resource$Reservationsubblocks$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reservationsubblocks$Performmaintenance; + {}) as Params$Resource$Reservationsubblocks$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reservationsubblocks$Performmaintenance; + params = {} as Params$Resource$Reservationsubblocks$Setiampolicy; options = {}; } @@ -194019,7 +195607,7 @@ export namespace compute_v1 { { url: ( rootUrl + - '/compute/v1/projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/performMaintenance' + '/compute/v1/projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/setIamPolicy' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -194027,27 +195615,22 @@ export namespace compute_v1 { options ), params, - requiredParams: [ - 'project', - 'zone', - 'parentName', - 'reservationSubBlock', - ], - pathParams: ['parentName', 'project', 'reservationSubBlock', 'zone'], + requiredParams: ['project', 'zone', 'parentResource', 'resource'], + pathParams: ['parentResource', 'project', 'resource', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Allows customers to report a faulty subBlock. + * Returns permissions that a caller has on the specified resource. * @example * ```js * // Before running the sample: @@ -194071,6 +195654,7 @@ export namespace compute_v1 { * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', * 'https://www.googleapis.com/auth/compute', + * 'https://www.googleapis.com/auth/compute.readonly', * ], * }); * @@ -194079,39 +195663,22 @@ export namespace compute_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await compute.reservationSubBlocks.reportFaulty({ - * // The name of the parent reservation and parent block. In the format of - * // reservations/{reservation_name\}/reservationBlocks/{reservation_block_name\} - * parentName: 'placeholder-value', + * const res = await compute.reservationSubBlocks.testIamPermissions({ + * // Name or id of parent resource of the resource for this request. + * parentResource: '[a-z](?:[-a-zA-Z0-9/]{0,255}[a-zA-Z0-9])?', * // Project ID for this request. - * project: 'placeholder-value', - * // An optional request ID to identify requests. Specify a unique request ID so - * // that if you must retry your request, the server will know to ignore the - * // request if it has already been completed. - * // - * // For example, consider a situation where you make an initial request and - * // the request times out. If you make the request again with the same - * // request ID, the server can check if original operation with the same - * // request ID was received, and if so, will ignore the second request. This - * // prevents clients from accidentally creating duplicate commitments. - * // - * // The request ID must be - * // a valid UUID with the exception that zero UUID is not supported - * // (00000000-0000-0000-0000-000000000000). - * requestId: 'placeholder-value', - * // The name of the reservation subBlock. - * // Name should conform to RFC1035 or be a resource ID. - * reservationSubBlock: 'placeholder-value', - * // Name of the zone for this request. Zone name should conform to RFC1035. - * zone: 'placeholder-value', + * project: + * '(?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))', + * // Name or id of the resource for this request. + * resource: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}', + * // The name of the zone for this request. + * zone: '[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "disruptionSchedule": "my_disruptionSchedule", - * // "failureComponent": "my_failureComponent", - * // "faultReasons": [] + * // "permissions": [] * // } * }, * }); @@ -194119,32 +195686,7 @@ export namespace compute_v1 { * * // Example response * // { - * // "clientOperationId": "my_clientOperationId", - * // "creationTimestamp": "my_creationTimestamp", - * // "description": "my_description", - * // "endTime": "my_endTime", - * // "error": {}, - * // "httpErrorMessage": "my_httpErrorMessage", - * // "httpErrorStatusCode": 0, - * // "id": "my_id", - * // "insertTime": "my_insertTime", - * // "instancesBulkInsertOperationMetadata": {}, - * // "kind": "my_kind", - * // "name": "my_name", - * // "operationGroupId": "my_operationGroupId", - * // "operationType": "my_operationType", - * // "progress": 0, - * // "region": "my_region", - * // "selfLink": "my_selfLink", - * // "setCommonInstanceMetadataOperationMetadata": {}, - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "statusMessage": "my_statusMessage", - * // "targetId": "my_targetId", - * // "targetLink": "my_targetLink", - * // "user": "my_user", - * // "warnings": [], - * // "zone": "my_zone" + * // "permissions": [] * // } * } * @@ -194160,53 +195702,57 @@ export namespace compute_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - reportFaulty( - params: Params$Resource$Reservationsubblocks$Reportfaulty, + testIamPermissions( + params: Params$Resource$Reservationsubblocks$Testiampermissions, options: StreamMethodOptions ): Promise>; - reportFaulty( - params?: Params$Resource$Reservationsubblocks$Reportfaulty, + testIamPermissions( + params?: Params$Resource$Reservationsubblocks$Testiampermissions, options?: MethodOptions - ): Promise>; - reportFaulty( - params: Params$Resource$Reservationsubblocks$Reportfaulty, + ): Promise>; + testIamPermissions( + params: Params$Resource$Reservationsubblocks$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - reportFaulty( - params: Params$Resource$Reservationsubblocks$Reportfaulty, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Reservationsubblocks$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - reportFaulty( - params: Params$Resource$Reservationsubblocks$Reportfaulty, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Reservationsubblocks$Testiampermissions, + callback: BodyResponseCallback ): void; - reportFaulty(callback: BodyResponseCallback): void; - reportFaulty( + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( paramsOrCallback?: - | Params$Resource$Reservationsubblocks$Reportfaulty - | BodyResponseCallback + | Params$Resource$Reservationsubblocks$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reservationsubblocks$Reportfaulty; + {}) as Params$Resource$Reservationsubblocks$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reservationsubblocks$Reportfaulty; + params = {} as Params$Resource$Reservationsubblocks$Testiampermissions; options = {}; } @@ -194221,7 +195767,7 @@ export namespace compute_v1 { { url: ( rootUrl + - '/compute/v1/projects/{project}/zones/{zone}/{parentName}/reservationSubBlocks/{reservationSubBlock}/reportFaulty' + '/compute/v1/projects/{project}/zones/{zone}/{parentResource}/reservationSubBlocks/{resource}/testIamPermissions' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -194229,22 +195775,17 @@ export namespace compute_v1 { options ), params, - requiredParams: [ - 'project', - 'zone', - 'parentName', - 'reservationSubBlock', - ], - pathParams: ['parentName', 'project', 'reservationSubBlock', 'zone'], + requiredParams: ['project', 'zone', 'parentResource', 'resource'], + pathParams: ['parentResource', 'project', 'resource', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } @@ -194265,11 +195806,38 @@ export namespace compute_v1 { * Name should conform to RFC1035 or be a resource ID. */ reservationSubBlock?: string; + /** + * View of the subBlock. + */ + view?: string; /** * Name of the zone for this request. Zone name should conform to RFC1035. */ zone?: string; } + export interface Params$Resource$Reservationsubblocks$Getiampolicy + extends StandardParameters { + /** + * Requested IAM Policy version. + */ + optionsRequestedPolicyVersion?: number; + /** + * Name or id of parent resource of the resource for this request. + */ + parentResource?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } export interface Params$Resource$Reservationsubblocks$List extends StandardParameters { /** @@ -194463,6 +196031,54 @@ export namespace compute_v1 { */ requestBody?: Schema$ReservationSubBlocksReportFaultyRequest; } + export interface Params$Resource$Reservationsubblocks$Setiampolicy + extends StandardParameters { + /** + * Name or id of parent resource of the resource for this request. + */ + parentResource?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ZoneSetNestedPolicyRequest; + } + export interface Params$Resource$Reservationsubblocks$Testiampermissions + extends StandardParameters { + /** + * Name or id of parent resource of the resource for this request. + */ + parentResource?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } export class Resource$Resourcepolicies { context: APIRequestContext; @@ -215884,6 +217500,12 @@ export namespace compute_v1 { * // The Shared VPC service project id or service project number for which * // aggregated list request is invoked for subnetworks list-usable api. * serviceProjectNumber: 'placeholder-value', + * // Defines the extra views returned back in the subnetwork resource. + * // Supported values: + * // + * // - WITH_UTILIZATION: Utilization data is included in the + * // response. + * views: 'placeholder-value', * }); * console.log(res.data); * @@ -218285,6 +219907,14 @@ export namespace compute_v1 { * aggregated list request is invoked for subnetworks list-usable api. */ serviceProjectNumber?: string; + /** + * Defines the extra views returned back in the subnetwork resource. + * Supported values: + * + * - WITH_UTILIZATION: Utilization data is included in the + * response. + */ + views?: string[]; } export interface Params$Resource$Subnetworks$Delete extends StandardParameters { diff --git a/src/apis/contactcenteraiplatform/v1alpha1.ts b/src/apis/contactcenteraiplatform/v1alpha1.ts index b552f4f870..6a3c18a71d 100644 --- a/src/apis/contactcenteraiplatform/v1alpha1.ts +++ b/src/apis/contactcenteraiplatform/v1alpha1.ts @@ -817,7 +817,7 @@ export namespace contactcenteraiplatform_v1alpha1 { * * // Do the magic * const res = await contactcenteraiplatform.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -1089,7 +1089,7 @@ export namespace contactcenteraiplatform_v1alpha1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/contactcenterinsights/v1.ts b/src/apis/contactcenterinsights/v1.ts index 07f87c7b67..f7d8046ecf 100644 --- a/src/apis/contactcenterinsights/v1.ts +++ b/src/apis/contactcenterinsights/v1.ts @@ -1154,6 +1154,22 @@ export namespace contactcenterinsights_v1 { * Output only. Metadata about the agent dimension. */ agentDimensionMetadata?: Schema$GoogleCloudContactcenterinsightsV1alpha1DimensionAgentDimensionMetadata; + /** + * Output only. Metadata about the client sentiment category dimension. + */ + clientSentimentCategoryDimensionMetadata?: Schema$GoogleCloudContactcenterinsightsV1alpha1DimensionClientSentimentCategoryDimensionMetadata; + /** + * Output only. Metadata about the Conversational Agents playbook dimension. + */ + conversationalAgentsPlaybookDimensionMetadata?: Schema$GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsPlaybookDimensionMetadata; + /** + * Output only. Metadata about the Conversational Agents tool dimension. + */ + conversationalAgentsToolDimensionMetadata?: Schema$GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsToolDimensionMetadata; + /** + * Output only. Metadata about the conversation profile dimension. + */ + conversationProfileDimensionMetadata?: Schema$GoogleCloudContactcenterinsightsV1alpha1DimensionConversationProfileDimensionMetadata; /** * The key of the dimension. */ @@ -1162,6 +1178,10 @@ export namespace contactcenterinsights_v1 { * Output only. Metadata about the issue dimension. */ issueDimensionMetadata?: Schema$GoogleCloudContactcenterinsightsV1alpha1DimensionIssueDimensionMetadata; + /** + * Output only. Metadata about the conversation medium dimension. + */ + mediumDimensionMetadata?: Schema$GoogleCloudContactcenterinsightsV1alpha1DimensionMediumDimensionMetadata; /** * Output only. Metadata about the QA question-answer dimension. */ @@ -1208,6 +1228,50 @@ export namespace contactcenterinsights_v1 { */ agentVersionId?: string | null; } + /** + * Metadata about the client sentiment category dimension. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1alpha1DimensionClientSentimentCategoryDimensionMetadata { + /** + * Optional. The client sentiment category. + */ + sentimentCategory?: string | null; + } + /** + * Metadata about the Conversational Agents playbook dimension. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsPlaybookDimensionMetadata { + /** + * Optional. The dialogflow playbook display name. + */ + playbookDisplayName?: string | null; + /** + * Optional. The dialogflow playbook ID. + */ + playbookId?: string | null; + } + /** + * Metadata about the Conversational Agents tool dimension. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsToolDimensionMetadata { + /** + * Optional. The dialogflow tool display name. + */ + toolDisplayName?: string | null; + /** + * Optional. The dialogflow tool ID. + */ + toolId?: string | null; + } + /** + * Metadata about the conversation profile dimension. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1alpha1DimensionConversationProfileDimensionMetadata { + /** + * Optional. The conversation profile ID. + */ + conversationProfileId?: string | null; + } /** * Metadata about the issue dimension. */ @@ -1225,6 +1289,15 @@ export namespace contactcenterinsights_v1 { */ issueModelId?: string | null; } + /** + * Metadata about the conversation medium dimension. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1alpha1DimensionMediumDimensionMetadata { + /** + * Optional. The conversation medium. Currently supports : PHONE_CALL, CHAT. + */ + medium?: string | null; + } /** * Metadata about the QA question-answer dimension. This is useful for showing the answer distribution for questions for a given scorecard. */ @@ -4093,6 +4166,22 @@ export namespace contactcenterinsights_v1 { * Output only. Metadata about the agent dimension. */ agentDimensionMetadata?: Schema$GoogleCloudContactcenterinsightsV1DimensionAgentDimensionMetadata; + /** + * Output only. Metadata about the client sentiment category dimension. + */ + clientSentimentCategoryDimensionMetadata?: Schema$GoogleCloudContactcenterinsightsV1DimensionClientSentimentCategoryDimensionMetadata; + /** + * Output only. Metadata about the Conversational Agents playbook dimension. + */ + conversationalAgentsPlaybookDimensionMetadata?: Schema$GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsPlaybookDimensionMetadata; + /** + * Output only. Metadata about the Conversational Agents tool dimension. + */ + conversationalAgentsToolDimensionMetadata?: Schema$GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsToolDimensionMetadata; + /** + * Output only. Metadata about the conversation profile dimension. + */ + conversationProfileDimensionMetadata?: Schema$GoogleCloudContactcenterinsightsV1DimensionConversationProfileDimensionMetadata; /** * The key of the dimension. */ @@ -4101,6 +4190,10 @@ export namespace contactcenterinsights_v1 { * Output only. Metadata about the issue dimension. */ issueDimensionMetadata?: Schema$GoogleCloudContactcenterinsightsV1DimensionIssueDimensionMetadata; + /** + * Output only. Metadata about the conversation medium dimension. + */ + mediumDimensionMetadata?: Schema$GoogleCloudContactcenterinsightsV1DimensionMediumDimensionMetadata; /** * Output only. Metadata about the QA question-answer dimension. */ @@ -4147,6 +4240,50 @@ export namespace contactcenterinsights_v1 { */ agentVersionId?: string | null; } + /** + * Metadata about the client sentiment category dimension. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1DimensionClientSentimentCategoryDimensionMetadata { + /** + * Optional. The client sentiment category. + */ + sentimentCategory?: string | null; + } + /** + * Metadata about the Conversational Agents playbook dimension. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsPlaybookDimensionMetadata { + /** + * Optional. The dialogflow playbook display name. + */ + playbookDisplayName?: string | null; + /** + * Optional. The dialogflow playbook ID. + */ + playbookId?: string | null; + } + /** + * Metadata about the Conversational Agents tool dimension. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsToolDimensionMetadata { + /** + * Optional. The dialogflow tool display name. + */ + toolDisplayName?: string | null; + /** + * Optional. The dialogflow tool ID. + */ + toolId?: string | null; + } + /** + * Metadata about the conversation profile dimension. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1DimensionConversationProfileDimensionMetadata { + /** + * Optional. The conversation profile ID. + */ + conversationProfileId?: string | null; + } /** * Metadata about the issue dimension. */ @@ -4164,6 +4301,15 @@ export namespace contactcenterinsights_v1 { */ issueModelId?: string | null; } + /** + * Metadata about the conversation medium dimension. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1DimensionMediumDimensionMetadata { + /** + * Optional. The conversation medium. Currently supports : PHONE_CALL, CHAT. + */ + medium?: string | null; + } /** * Metadata about the QA question-answer dimension. This is useful for showing the answer distribution for questions for a given scorecard. */ @@ -12637,15 +12783,10 @@ export namespace contactcenterinsights_v1 { export class Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations { context: APIRequestContext; - analyses: Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses; assessments: Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments; feedbackLabels: Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels; constructor(context: APIRequestContext) { this.context = context; - this.analyses = - new Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses( - this.context - ); this.assessments = new Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments( this.context @@ -12656,168 +12797,6 @@ export namespace contactcenterinsights_v1 { ); } - /** - * Analyzes multiple conversations in a single request. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/contactcenterinsights.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const contactcenterinsights = google.contactcenterinsights('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.bulkAnalyze( - * { - * // Required. The parent resource to create analyses in. - * parent: - * 'projects/my-project/locations/my-location/authorizedViewSets/my-authorizedViewSet/authorizedViews/my-authorizedView', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "analysisPercentage": {}, - * // "annotatorSelector": {}, - * // "filter": "my_filter", - * // "parent": "my_parent" - * // } - * }, - * }, - * ); - * console.log(res.data); - * - * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - bulkAnalyze( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Bulkanalyze, - options: StreamMethodOptions - ): Promise>; - bulkAnalyze( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Bulkanalyze, - options?: MethodOptions - ): Promise>; - bulkAnalyze( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Bulkanalyze, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - bulkAnalyze( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Bulkanalyze, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - bulkAnalyze( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Bulkanalyze, - callback: BodyResponseCallback - ): void; - bulkAnalyze( - callback: BodyResponseCallback - ): void; - bulkAnalyze( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Bulkanalyze - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Bulkanalyze; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Bulkanalyze; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/conversations:bulkAnalyze').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - /** * Gets conversation statistics. * @example @@ -13455,18 +13434,6 @@ export namespace contactcenterinsights_v1 { } } - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Bulkanalyze - extends StandardParameters { - /** - * Required. The parent resource to create analyses in. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest; - } export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Calculatestats extends StandardParameters { /** @@ -13528,14 +13495,19 @@ export namespace contactcenterinsights_v1 { view?: string; } - export class Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses { + export class Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments { context: APIRequestContext; + notes: Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes; constructor(context: APIRequestContext) { this.context = context; + this.notes = + new Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes( + this.context + ); } /** - * Creates an analysis. The long running operation is done when the analysis has completed. + * Appeal an Assessment. * @example * ```js * // Before running the sample: @@ -13565,22 +13537,15 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.create( + * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.appeal( * { - * // Required. The parent resource of the analysis. - * parent: - * 'projects/my-project/locations/my-location/authorizedViewSets/my-authorizedViewSet/authorizedViews/my-authorizedView/conversations/my-conversation', + * // Required. The name of the assessment to appeal. + * name: 'projects/my-project/locations/my-location/authorizedViewSets/my-authorizedViewSet/authorizedViews/my-authorizedView/conversations/my-conversation/assessments/my-assessment', * * // Request body metadata * requestBody: { * // request body parameters - * // { - * // "analysisResult": {}, - * // "annotatorSelector": {}, - * // "createTime": "my_createTime", - * // "name": "my_name", - * // "requestTime": "my_requestTime" - * // } + * // {} * }, * }, * ); @@ -13588,11 +13553,11 @@ export namespace contactcenterinsights_v1 { * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "agentInfo": {}, + * // "createTime": "my_createTime", * // "name": "my_name", - * // "response": {} + * // "state": "my_state", + * // "updateTime": "my_updateTime" * // } * } * @@ -13608,58 +13573,62 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Create, + appeal( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Appeal, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Create, + appeal( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Appeal, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Create, + ): Promise< + GaxiosResponseWithHTTP2 + >; + appeal( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Appeal, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Create, + appeal( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Appeal, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Create, - callback: BodyResponseCallback + appeal( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Appeal, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + appeal( + callback: BodyResponseCallback ): void; - create( + appeal( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Appeal + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Create; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Appeal; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Create; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Appeal; options = {}; } @@ -13673,32 +13642,31 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/analyses').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:appeal').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes an analysis. + * Create Assessment. * @example * ```js * // Before running the sample: @@ -13728,16 +13696,35 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.delete( + * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.create( * { - * // Required. The name of the analysis to delete. - * name: 'projects/my-project/locations/my-location/authorizedViewSets/my-authorizedViewSet/authorizedViews/my-authorizedView/conversations/my-conversation/analyses/my-analyse', + * // Required. The parent resource of the assessment. + * parent: + * 'projects/my-project/locations/my-location/authorizedViewSets/my-authorizedViewSet/authorizedViews/my-authorizedView/conversations/my-conversation', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "agentInfo": {}, + * // "createTime": "my_createTime", + * // "name": "my_name", + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } + * }, * }, * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "agentInfo": {}, + * // "createTime": "my_createTime", + * // "name": "my_name", + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } * } * * main().catch(e => { @@ -13752,54 +13739,62 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Delete, + create( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Create, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Delete, + create( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Create, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Delete, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Create, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Delete; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Delete; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Create; options = {}; } @@ -13813,29 +13808,34 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/assessments').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets an analysis. + * Delete an Assessment. * @example * ```js * // Before running the sample: @@ -13865,22 +13865,18 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.get( + * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.delete( * { - * // Required. The name of the analysis to get. - * name: 'projects/my-project/locations/my-location/authorizedViewSets/my-authorizedViewSet/authorizedViews/my-authorizedView/conversations/my-conversation/analyses/my-analyse', + * // Optional. If set to true, all of this assessment's notes will also be deleted. Otherwise, the request will only succeed if it has no notes. + * force: 'placeholder-value', + * // Required. The name of the assessment to delete. + * name: 'projects/my-project/locations/my-location/authorizedViewSets/my-authorizedViewSet/authorizedViews/my-authorizedView/conversations/my-conversation/assessments/my-assessment', * }, * ); * console.log(res.data); * * // Example response - * // { - * // "analysisResult": {}, - * // "annotatorSelector": {}, - * // "createTime": "my_createTime", - * // "name": "my_name", - * // "requestTime": "my_requestTime" - * // } + * // {} * } * * main().catch(e => { @@ -13895,62 +13891,54 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Get, + delete( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Delete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Get, + delete( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Get, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Delete, + callback: BodyResponseCallback ): void; - get( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Get; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Get; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Delete; options = {}; } @@ -13965,7 +13953,7 @@ export namespace contactcenterinsights_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -13976,19 +13964,17 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists analyses. + * Finalize an Assessment. * @example * ```js * // Before running the sample: @@ -14018,25 +14004,27 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.list( + * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.finalize( * { - * // A filter to reduce results to a specific subset. Useful for querying conversations with specific properties. - * filter: 'placeholder-value', - * // The maximum number of analyses to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. - * pageSize: 'placeholder-value', - * // The value returned by the last `ListAnalysesResponse`; indicates that this is a continuation of a prior `ListAnalyses` call and the system should return the next page of data. - * pageToken: 'placeholder-value', - * // Required. The parent resource of the analyses. - * parent: - * 'projects/my-project/locations/my-location/authorizedViewSets/my-authorizedViewSet/authorizedViews/my-authorizedView/conversations/my-conversation', + * // Required. The name of the assessment to finalize. + * name: 'projects/my-project/locations/my-location/authorizedViewSets/my-authorizedViewSet/authorizedViews/my-authorizedView/conversations/my-conversation/assessments/my-assessment', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, * }, * ); * console.log(res.data); * * // Example response * // { - * // "analyses": [], - * // "nextPageToken": "my_nextPageToken" + * // "agentInfo": {}, + * // "createTime": "my_createTime", + * // "name": "my_name", + * // "state": "my_state", + * // "updateTime": "my_updateTime" * // } * } * @@ -14052,62 +14040,62 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$List, + finalize( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Finalize, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$List, + finalize( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Finalize, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$List, + finalize( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Finalize, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$List, + finalize( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Finalize, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$List, - callback: BodyResponseCallback + finalize( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Finalize, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + finalize( + callback: BodyResponseCallback ): void; - list( + finalize( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Finalize + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$List; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Finalize; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$List; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Finalize; options = {}; } @@ -14121,92 +14109,34 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/analyses').replace( + url: (rootUrl + '/v1/{+name}:finalize').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Create - extends StandardParameters { - /** - * Required. The parent resource of the analysis. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1Analysis; - } - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Delete - extends StandardParameters { - /** - * Required. The name of the analysis to delete. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$Get - extends StandardParameters { - /** - * Required. The name of the analysis to get. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Analyses$List - extends StandardParameters { - /** - * A filter to reduce results to a specific subset. Useful for querying conversations with specific properties. - */ - filter?: string; - /** - * The maximum number of analyses to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. - */ - pageSize?: number; - /** - * The value returned by the last `ListAnalysesResponse`; indicates that this is a continuation of a prior `ListAnalyses` call and the system should return the next page of data. - */ - pageToken?: string; - /** - * Required. The parent resource of the analyses. - */ - parent?: string; - } - - export class Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments { - context: APIRequestContext; - notes: Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes; - constructor(context: APIRequestContext) { - this.context = context; - this.notes = - new Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes( - this.context - ); - } /** - * Appeal an Assessment. + * Get Assessment. * @example * ```js * // Before running the sample: @@ -14236,16 +14166,10 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.appeal( + * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.get( * { - * // Required. The name of the assessment to appeal. + * // Required. The name of the assessment to get. * name: 'projects/my-project/locations/my-location/authorizedViewSets/my-authorizedViewSet/authorizedViews/my-authorizedView/conversations/my-conversation/assessments/my-assessment', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, * }, * ); * console.log(res.data); @@ -14272,38 +14196,38 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - appeal( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Appeal, + get( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Get, options: StreamMethodOptions ): Promise>; - appeal( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Appeal, + get( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Get, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; - appeal( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Appeal, + get( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - appeal( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Appeal, + get( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - appeal( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Appeal, + get( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Get, callback: BodyResponseCallback ): void; - appeal( + get( callback: BodyResponseCallback ): void; - appeal( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Appeal + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -14321,13 +14245,13 @@ export namespace contactcenterinsights_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Appeal; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Appeal; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Get; options = {}; } @@ -14341,8 +14265,8 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:appeal').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -14365,7 +14289,7 @@ export namespace contactcenterinsights_v1 { } /** - * Create Assessment. + * List Assessments. * @example * ```js * // Before running the sample: @@ -14395,34 +14319,25 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.create( + * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.list( * { - * // Required. The parent resource of the assessment. + * // Optional. A filter to reduce results to a specific subset. Supported filters include: * `state` - The state of the assessment * `agent_info.agent_id` - The ID of the agent the assessment is for + * filter: 'placeholder-value', + * // The maximum number of assessments to list. If zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. + * pageSize: 'placeholder-value', + * // Optional. The value returned by the last `ListAssessmentRulesResponse`; indicates that this is a continuation of a prior `ListAssessmentRules` call and the system should return the next page of data. + * pageToken: 'placeholder-value', + * // Required. The parent resource of the assessments. To list all assessments in a location, substitute the conversation ID with a '-' character. * parent: * 'projects/my-project/locations/my-location/authorizedViewSets/my-authorizedViewSet/authorizedViews/my-authorizedView/conversations/my-conversation', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "agentInfo": {}, - * // "createTime": "my_createTime", - * // "name": "my_name", - * // "state": "my_state", - * // "updateTime": "my_updateTime" - * // } - * }, * }, * ); * console.log(res.data); * * // Example response * // { - * // "agentInfo": {}, - * // "createTime": "my_createTime", - * // "name": "my_name", - * // "state": "my_state", - * // "updateTime": "my_updateTime" + * // "assessments": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -14438,62 +14353,62 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Create, + list( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$List, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Create, + list( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - create( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Create, + list( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Create, + list( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$List, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - create( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Create; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Create; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$List; options = {}; } @@ -14511,7 +14426,7 @@ export namespace contactcenterinsights_v1 { /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -14522,19 +14437,19 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Delete an Assessment. + * Publish an Assessment. * @example * ```js * // Before running the sample: @@ -14564,18 +14479,28 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.delete( + * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.publish( * { - * // Optional. If set to true, all of this assessment's notes will also be deleted. Otherwise, the request will only succeed if it has no notes. - * force: 'placeholder-value', - * // Required. The name of the assessment to delete. + * // Required. The name of the assessment to publish. * name: 'projects/my-project/locations/my-location/authorizedViewSets/my-authorizedViewSet/authorizedViews/my-authorizedView/conversations/my-conversation/assessments/my-assessment', - * }, - * ); - * console.log(res.data); * - * // Example response - * // {} + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "agentInfo": {}, + * // "createTime": "my_createTime", + * // "name": "my_name", + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } * } * * main().catch(e => { @@ -14590,54 +14515,62 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Delete, + publish( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Publish, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Delete, + publish( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Publish, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + publish( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Publish, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + publish( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Publish, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Delete, - callback: BodyResponseCallback + publish( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Publish, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + publish( + callback: BodyResponseCallback + ): void; + publish( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Publish + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Delete; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Publish; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Delete; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Publish; options = {}; } @@ -14651,8 +14584,11 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}:publish').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -14663,17 +14599,112 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Appeal + extends StandardParameters { /** - * Finalize an Assessment. + * Required. The name of the assessment to appeal. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1AppealAssessmentRequest; + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Create + extends StandardParameters { + /** + * Required. The parent resource of the assessment. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1Assessment; + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Delete + extends StandardParameters { + /** + * Optional. If set to true, all of this assessment's notes will also be deleted. Otherwise, the request will only succeed if it has no notes. + */ + force?: boolean; + /** + * Required. The name of the assessment to delete. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Finalize + extends StandardParameters { + /** + * Required. The name of the assessment to finalize. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1FinalizeAssessmentRequest; + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Get + extends StandardParameters { + /** + * Required. The name of the assessment to get. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$List + extends StandardParameters { + /** + * Optional. A filter to reduce results to a specific subset. Supported filters include: * `state` - The state of the assessment * `agent_info.agent_id` - The ID of the agent the assessment is for + */ + filter?: string; + /** + * The maximum number of assessments to list. If zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. + */ + pageSize?: number; + /** + * Optional. The value returned by the last `ListAssessmentRulesResponse`; indicates that this is a continuation of a prior `ListAssessmentRules` call and the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. The parent resource of the assessments. To list all assessments in a location, substitute the conversation ID with a '-' character. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Publish + extends StandardParameters { + /** + * Required. The name of the assessment to publish. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1PublishAssessmentRequest; + } + + export class Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Create Note. * @example * ```js * // Before running the sample: @@ -14703,15 +14734,25 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.finalize( + * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.notes.create( * { - * // Required. The name of the assessment to finalize. - * name: 'projects/my-project/locations/my-location/authorizedViewSets/my-authorizedViewSet/authorizedViews/my-authorizedView/conversations/my-conversation/assessments/my-assessment', + * // Required. The parent resource of the note. + * parent: + * 'projects/my-project/locations/my-location/authorizedViewSets/my-authorizedViewSet/authorizedViews/my-authorizedView/conversations/my-conversation/assessments/my-assessment', * * // Request body metadata * requestBody: { * // request body parameters - * // {} + * // { + * // "assessmentNote": {}, + * // "content": "my_content", + * // "conversationTurnNote": {}, + * // "createTime": "my_createTime", + * // "name": "my_name", + * // "noteCreator": {}, + * // "qaQuestionNote": {}, + * // "updateTime": "my_updateTime" + * // } * }, * }, * ); @@ -14719,10 +14760,13 @@ export namespace contactcenterinsights_v1 { * * // Example response * // { - * // "agentInfo": {}, + * // "assessmentNote": {}, + * // "content": "my_content", + * // "conversationTurnNote": {}, * // "createTime": "my_createTime", * // "name": "my_name", - * // "state": "my_state", + * // "noteCreator": {}, + * // "qaQuestionNote": {}, * // "updateTime": "my_updateTime" * // } * } @@ -14739,62 +14783,62 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - finalize( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Finalize, + create( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Create, options: StreamMethodOptions ): Promise>; - finalize( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Finalize, + create( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Create, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - finalize( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Finalize, + create( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - finalize( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Finalize, + create( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - finalize( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Finalize, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Create, + callback: BodyResponseCallback ): void; - finalize( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - finalize( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Finalize - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Finalize; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Finalize; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Create; options = {}; } @@ -14808,7 +14852,7 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:finalize').replace( + url: (rootUrl + '/v1/{+parent}/notes').replace( /([^:]\/)\/+/g, '$1' ), @@ -14818,24 +14862,24 @@ export namespace contactcenterinsights_v1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Get Assessment. + * Deletes a Note. * @example * ```js * // Before running the sample: @@ -14865,22 +14909,16 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.get( + * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.notes.delete( * { - * // Required. The name of the assessment to get. - * name: 'projects/my-project/locations/my-location/authorizedViewSets/my-authorizedViewSet/authorizedViews/my-authorizedView/conversations/my-conversation/assessments/my-assessment', + * // Required. The name of the note to delete. + * name: 'projects/my-project/locations/my-location/authorizedViewSets/my-authorizedViewSet/authorizedViews/my-authorizedView/conversations/my-conversation/assessments/my-assessment/notes/my-note', * }, * ); * console.log(res.data); * * // Example response - * // { - * // "agentInfo": {}, - * // "createTime": "my_createTime", - * // "name": "my_name", - * // "state": "my_state", - * // "updateTime": "my_updateTime" - * // } + * // {} * } * * main().catch(e => { @@ -14895,62 +14933,54 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Get, + delete( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Delete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Get, + delete( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Get, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Delete, + callback: BodyResponseCallback ): void; - get( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Get; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Get; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Delete; options = {}; } @@ -14965,7 +14995,7 @@ export namespace contactcenterinsights_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -14976,19 +15006,17 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * List Assessments. + * List Notes. * @example * ```js * // Before running the sample: @@ -15018,25 +15046,23 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.list( + * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.notes.list( * { - * // Optional. A filter to reduce results to a specific subset. Supported filters include: * `state` - The state of the assessment * `agent_info.agent_id` - The ID of the agent the assessment is for - * filter: 'placeholder-value', - * // The maximum number of assessments to list. If zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. + * // Optional. The maximum number of notes to return in the response. If zero the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. * pageSize: 'placeholder-value', - * // Optional. The value returned by the last `ListAssessmentRulesResponse`; indicates that this is a continuation of a prior `ListAssessmentRules` call and the system should return the next page of data. + * // Optional. The value returned by the last `ListNotesResponse`. This value indicates that this is a continuation of a prior `ListNotes` call and that the system should return the next page of data. * pageToken: 'placeholder-value', - * // Required. The parent resource of the assessments. To list all assessments in a location, substitute the conversation ID with a '-' character. + * // Required. The parent resource of the notes. * parent: - * 'projects/my-project/locations/my-location/authorizedViewSets/my-authorizedViewSet/authorizedViews/my-authorizedView/conversations/my-conversation', + * 'projects/my-project/locations/my-location/authorizedViewSets/my-authorizedViewSet/authorizedViews/my-authorizedView/conversations/my-conversation/assessments/my-assessment', * }, * ); * console.log(res.data); * * // Example response * // { - * // "assessments": [], - * // "nextPageToken": "my_nextPageToken" + * // "nextPageToken": "my_nextPageToken", + * // "notes": [] * // } * } * @@ -15053,61 +15079,61 @@ export namespace contactcenterinsights_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$List, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$List, + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$List, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$List, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$List; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$List; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$List; options = {}; } @@ -15121,7 +15147,7 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/assessments').replace( + url: (rootUrl + '/v1/{+parent}/notes').replace( /([^:]\/)\/+/g, '$1' ), @@ -15136,19 +15162,19 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Publish an Assessment. + * Update Note. * @example * ```js * // Before running the sample: @@ -15178,15 +15204,26 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.publish( + * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.notes.patch( * { - * // Required. The name of the assessment to publish. - * name: 'projects/my-project/locations/my-location/authorizedViewSets/my-authorizedViewSet/authorizedViews/my-authorizedView/conversations/my-conversation/assessments/my-assessment', + * // Identifier. The resource name of the note. Format: projects/{project\}/locations/{location\}/conversations/{conversation\}/assessments/{assessment\}/notes/{note\} + * name: 'projects/my-project/locations/my-location/authorizedViewSets/my-authorizedViewSet/authorizedViews/my-authorizedView/conversations/my-conversation/assessments/my-assessment/notes/my-note', + * // Optional. The list of fields to be updated. If the update_mask is empty, all updateable fields will be updated. Acceptable fields include: * `content` + * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters - * // {} + * // { + * // "assessmentNote": {}, + * // "content": "my_content", + * // "conversationTurnNote": {}, + * // "createTime": "my_createTime", + * // "name": "my_name", + * // "noteCreator": {}, + * // "qaQuestionNote": {}, + * // "updateTime": "my_updateTime" + * // } * }, * }, * ); @@ -15194,10 +15231,13 @@ export namespace contactcenterinsights_v1 { * * // Example response * // { - * // "agentInfo": {}, + * // "assessmentNote": {}, + * // "content": "my_content", + * // "conversationTurnNote": {}, * // "createTime": "my_createTime", * // "name": "my_name", - * // "state": "my_state", + * // "noteCreator": {}, + * // "qaQuestionNote": {}, * // "updateTime": "my_updateTime" * // } * } @@ -15214,62 +15254,62 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - publish( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Publish, + patch( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Patch, options: StreamMethodOptions ): Promise>; - publish( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Publish, + patch( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Patch, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - publish( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Publish, + patch( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - publish( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Publish, + patch( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - publish( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Publish, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Patch, + callback: BodyResponseCallback ): void; - publish( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - publish( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Publish - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Publish; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Publish; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Patch; options = {}; } @@ -15283,11 +15323,8 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:publish').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -15298,112 +15335,77 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Appeal + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Create extends StandardParameters { /** - * Required. The name of the assessment to appeal. + * Required. The parent resource of the note. */ - name?: string; + parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1AppealAssessmentRequest; + requestBody?: Schema$GoogleCloudContactcenterinsightsV1Note; } - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Create + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Delete extends StandardParameters { /** - * Required. The parent resource of the assessment. - */ - parent?: string; - - /** - * Request body metadata + * Required. The name of the note to delete. */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1Assessment; + name?: string; } - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Delete + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$List extends StandardParameters { /** - * Optional. If set to true, all of this assessment's notes will also be deleted. Otherwise, the request will only succeed if it has no notes. + * Optional. The maximum number of notes to return in the response. If zero the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. */ - force?: boolean; + pageSize?: number; /** - * Required. The name of the assessment to delete. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Finalize - extends StandardParameters { - /** - * Required. The name of the assessment to finalize. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1FinalizeAssessmentRequest; - } - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Get - extends StandardParameters { - /** - * Required. The name of the assessment to get. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$List - extends StandardParameters { - /** - * Optional. A filter to reduce results to a specific subset. Supported filters include: * `state` - The state of the assessment * `agent_info.agent_id` - The ID of the agent the assessment is for - */ - filter?: string; - /** - * The maximum number of assessments to list. If zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. - */ - pageSize?: number; - /** - * Optional. The value returned by the last `ListAssessmentRulesResponse`; indicates that this is a continuation of a prior `ListAssessmentRules` call and the system should return the next page of data. + * Optional. The value returned by the last `ListNotesResponse`. This value indicates that this is a continuation of a prior `ListNotes` call and that the system should return the next page of data. */ pageToken?: string; /** - * Required. The parent resource of the assessments. To list all assessments in a location, substitute the conversation ID with a '-' character. + * Required. The parent resource of the notes. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Publish + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Patch extends StandardParameters { /** - * Required. The name of the assessment to publish. + * Identifier. The resource name of the note. Format: projects/{project\}/locations/{location\}/conversations/{conversation\}/assessments/{assessment\}/notes/{note\} */ name?: string; + /** + * Optional. The list of fields to be updated. If the update_mask is empty, all updateable fields will be updated. Acceptable fields include: * `content` + */ + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1PublishAssessmentRequest; + requestBody?: Schema$GoogleCloudContactcenterinsightsV1Note; } - export class Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes { + export class Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Create Note. + * Create feedback label. * @example * ```js * // Before running the sample: @@ -15433,23 +15435,23 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.notes.create( + * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.create( * { - * // Required. The parent resource of the note. + * // Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server. + * feedbackLabelId: 'placeholder-value', + * // Required. The parent resource of the feedback label. * parent: - * 'projects/my-project/locations/my-location/authorizedViewSets/my-authorizedViewSet/authorizedViews/my-authorizedView/conversations/my-conversation/assessments/my-assessment', + * 'projects/my-project/locations/my-location/authorizedViewSets/my-authorizedViewSet/authorizedViews/my-authorizedView/conversations/my-conversation', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "assessmentNote": {}, - * // "content": "my_content", - * // "conversationTurnNote": {}, * // "createTime": "my_createTime", + * // "label": "my_label", + * // "labeledResource": "my_labeledResource", * // "name": "my_name", - * // "noteCreator": {}, - * // "qaQuestionNote": {}, + * // "qaAnswerLabel": {}, * // "updateTime": "my_updateTime" * // } * }, @@ -15459,13 +15461,11 @@ export namespace contactcenterinsights_v1 { * * // Example response * // { - * // "assessmentNote": {}, - * // "content": "my_content", - * // "conversationTurnNote": {}, * // "createTime": "my_createTime", + * // "label": "my_label", + * // "labeledResource": "my_labeledResource", * // "name": "my_name", - * // "noteCreator": {}, - * // "qaQuestionNote": {}, + * // "qaAnswerLabel": {}, * // "updateTime": "my_updateTime" * // } * } @@ -15483,61 +15483,61 @@ export namespace contactcenterinsights_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Create, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create, options: StreamMethodOptions ): Promise>; create( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Create, + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; create( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Create, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Create, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Create; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Create; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create; options = {}; } @@ -15551,7 +15551,7 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/notes').replace( + url: (rootUrl + '/v1/{+parent}/feedbackLabels').replace( /([^:]\/)\/+/g, '$1' ), @@ -15566,19 +15566,19 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a Note. + * Delete feedback label. * @example * ```js * // Before running the sample: @@ -15608,10 +15608,10 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.notes.delete( + * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.delete( * { - * // Required. The name of the note to delete. - * name: 'projects/my-project/locations/my-location/authorizedViewSets/my-authorizedViewSet/authorizedViews/my-authorizedView/conversations/my-conversation/assessments/my-assessment/notes/my-note', + * // Required. The name of the feedback label to delete. + * name: 'projects/my-project/locations/my-location/authorizedViewSets/my-authorizedViewSet/authorizedViews/my-authorizedView/conversations/my-conversation/feedbackLabels/my-feedbackLabel', * }, * ); * console.log(res.data); @@ -15633,31 +15633,31 @@ export namespace contactcenterinsights_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Delete, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Delete, + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Delete, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Delete, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Delete, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Delete + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -15673,13 +15673,13 @@ export namespace contactcenterinsights_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Delete; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Delete; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete; options = {}; } @@ -15715,7 +15715,7 @@ export namespace contactcenterinsights_v1 { } /** - * List Notes. + * Get feedback label. * @example * ```js * // Before running the sample: @@ -15745,23 +15745,22 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.notes.list( + * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.get( * { - * // Optional. The maximum number of notes to return in the response. If zero the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. - * pageSize: 'placeholder-value', - * // Optional. The value returned by the last `ListNotesResponse`. This value indicates that this is a continuation of a prior `ListNotes` call and that the system should return the next page of data. - * pageToken: 'placeholder-value', - * // Required. The parent resource of the notes. - * parent: - * 'projects/my-project/locations/my-location/authorizedViewSets/my-authorizedViewSet/authorizedViews/my-authorizedView/conversations/my-conversation/assessments/my-assessment', + * // Required. The name of the feedback label to get. + * name: 'projects/my-project/locations/my-location/authorizedViewSets/my-authorizedViewSet/authorizedViews/my-authorizedView/conversations/my-conversation/feedbackLabels/my-feedbackLabel', * }, * ); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "notes": [] + * // "createTime": "my_createTime", + * // "label": "my_label", + * // "labeledResource": "my_labeledResource", + * // "name": "my_name", + * // "qaAnswerLabel": {}, + * // "updateTime": "my_updateTime" * // } * } * @@ -15777,62 +15776,62 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$List, + get( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$List, + get( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$List, + get( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$List, + get( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$List; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$List; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get; options = {}; } @@ -15846,34 +15845,31 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/notes').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Update Note. + * List feedback labels. * @example * ```js * // Before running the sample: @@ -15903,41 +15899,25 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.notes.patch( + * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.list( * { - * // Identifier. The resource name of the note. Format: projects/{project\}/locations/{location\}/conversations/{conversation\}/assessments/{assessment\}/notes/{note\} - * name: 'projects/my-project/locations/my-location/authorizedViewSets/my-authorizedViewSet/authorizedViews/my-authorizedView/conversations/my-conversation/assessments/my-assessment/notes/my-note', - * // Optional. The list of fields to be updated. If the update_mask is empty, all updateable fields will be updated. Acceptable fields include: * `content` - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "assessmentNote": {}, - * // "content": "my_content", - * // "conversationTurnNote": {}, - * // "createTime": "my_createTime", - * // "name": "my_name", - * // "noteCreator": {}, - * // "qaQuestionNote": {}, - * // "updateTime": "my_updateTime" - * // } - * }, + * // Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING + * filter: 'placeholder-value', + * // Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. + * pageSize: 'placeholder-value', + * // Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListFeedbackLabels` call and that the system should return the next page of data. + * pageToken: 'placeholder-value', + * // Required. The parent resource of the feedback labels. + * parent: + * 'projects/my-project/locations/my-location/authorizedViewSets/my-authorizedViewSet/authorizedViews/my-authorizedView/conversations/my-conversation', * }, * ); * console.log(res.data); * * // Example response * // { - * // "assessmentNote": {}, - * // "content": "my_content", - * // "conversationTurnNote": {}, - * // "createTime": "my_createTime", - * // "name": "my_name", - * // "noteCreator": {}, - * // "qaQuestionNote": {}, - * // "updateTime": "my_updateTime" + * // "feedbackLabels": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -15953,62 +15933,62 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Patch, + list( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Patch, + list( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - patch( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Patch, + list( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Patch, + list( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Patch, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - patch( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Patch; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Patch; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List; options = {}; } @@ -16022,89 +16002,34 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+parent}/feedbackLabels').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Create - extends StandardParameters { - /** - * Required. The parent resource of the note. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1Note; - } - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Delete - extends StandardParameters { - /** - * Required. The name of the note to delete. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$List - extends StandardParameters { - /** - * Optional. The maximum number of notes to return in the response. If zero the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. - */ - pageSize?: number; - /** - * Optional. The value returned by the last `ListNotesResponse`. This value indicates that this is a continuation of a prior `ListNotes` call and that the system should return the next page of data. - */ - pageToken?: string; - /** - * Required. The parent resource of the notes. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Assessments$Notes$Patch - extends StandardParameters { - /** - * Identifier. The resource name of the note. Format: projects/{project\}/locations/{location\}/conversations/{conversation\}/assessments/{assessment\}/notes/{note\} - */ - name?: string; - /** - * Optional. The list of fields to be updated. If the update_mask is empty, all updateable fields will be updated. Acceptable fields include: * `content` - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1Note; - } - - export class Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Create feedback label. + * Update feedback label. * @example * ```js * // Before running the sample: @@ -16134,13 +16059,12 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.create( + * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.patch( * { - * // Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server. - * feedbackLabelId: 'placeholder-value', - * // Required. The parent resource of the feedback label. - * parent: - * 'projects/my-project/locations/my-location/authorizedViewSets/my-authorizedViewSet/authorizedViews/my-authorizedView/conversations/my-conversation', + * // Immutable. Resource name of the FeedbackLabel. Format: projects/{project\}/locations/{location\}/conversations/{conversation\}/feedbackLabels/{feedback_label\} + * name: 'projects/my-project/locations/my-location/authorizedViewSets/my-authorizedViewSet/authorizedViews/my-authorizedView/conversations/my-conversation/feedbackLabels/my-feedbackLabel', + * // Required. The list of fields to be updated. + * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { @@ -16181,38 +16105,38 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create, + patch( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create, + patch( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; - create( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create, + patch( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create, + patch( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create, + patch( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch, callback: BodyResponseCallback ): void; - create( + patch( callback: BodyResponseCallback ): void; - create( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -16230,13 +16154,13 @@ export namespace contactcenterinsights_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch; options = {}; } @@ -16250,18 +16174,15 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/feedbackLabels').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -16275,9 +16196,82 @@ export namespace contactcenterinsights_v1 { ); } } + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create + extends StandardParameters { /** - * Delete feedback label. + * Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server. + */ + feedbackLabelId?: string; + /** + * Required. The parent resource of the feedback label. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1FeedbackLabel; + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete + extends StandardParameters { + /** + * Required. The name of the feedback label to delete. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get + extends StandardParameters { + /** + * Required. The name of the feedback label to get. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List + extends StandardParameters { + /** + * Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING + */ + filter?: string; + /** + * Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. + */ + pageSize?: number; + /** + * Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListFeedbackLabels` call and that the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. The parent resource of the feedback labels. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch + extends StandardParameters { + /** + * Immutable. Resource name of the FeedbackLabel. Format: projects/{project\}/locations/{location\}/conversations/{conversation\}/feedbackLabels/{feedback_label\} + */ + name?: string; + /** + * Required. The list of fields to be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1FeedbackLabel; + } + + export class Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -16307,10 +16301,10 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.delete( + * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.cancel( * { - * // Required. The name of the feedback label to delete. - * name: 'projects/my-project/locations/my-location/authorizedViewSets/my-authorizedViewSet/authorizedViews/my-authorizedView/conversations/my-conversation/feedbackLabels/my-feedbackLabel', + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/authorizedViewSets/my-authorizedViewSet/authorizedViews/my-authorizedView/operations/my-operation', * }, * ); * console.log(res.data); @@ -16331,32 +16325,32 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete, + cancel( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Cancel, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete, + cancel( + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Cancel, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete, + cancel( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete, + cancel( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete, + cancel( + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Cancel, callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -16372,13 +16366,13 @@ export namespace contactcenterinsights_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Cancel; options = {}; } @@ -16392,8 +16386,8 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -16414,7 +16408,7 @@ export namespace contactcenterinsights_v1 { } /** - * Get feedback label. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -16444,22 +16438,21 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.get( + * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.get( * { - * // Required. The name of the feedback label to get. - * name: 'projects/my-project/locations/my-location/authorizedViewSets/my-authorizedViewSet/authorizedViews/my-authorizedView/conversations/my-conversation/feedbackLabels/my-feedbackLabel', + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/authorizedViewSets/my-authorizedViewSet/authorizedViews/my-authorizedView/operations/my-operation', * }, * ); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "label": "my_label", - * // "labeledResource": "my_labeledResource", + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "qaAnswerLabel": {}, - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -16476,61 +16469,57 @@ export namespace contactcenterinsights_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get, + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; + ): Promise>; get( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get; options = {}; } @@ -16556,19 +16545,17 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * List feedback labels. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -16598,25 +16585,27 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.list( + * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.list( * { - * // Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING + * // The standard list filter. * filter: 'placeholder-value', - * // Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/authorizedViewSets/my-authorizedViewSet/authorizedViews/my-authorizedView', + * // The standard list page size. * pageSize: 'placeholder-value', - * // Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListFeedbackLabels` call and that the system should return the next page of data. + * // The standard list page token. * pageToken: 'placeholder-value', - * // Required. The parent resource of the feedback labels. - * parent: - * 'projects/my-project/locations/my-location/authorizedViewSets/my-authorizedViewSet/authorizedViews/my-authorizedView/conversations/my-conversation', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); * * // Example response * // { - * // "feedbackLabels": [], - * // "nextPageToken": "my_nextPageToken" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -16633,61 +16622,61 @@ export namespace contactcenterinsights_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List, + params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List, + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List; + {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List; + {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$List; options = {}; } @@ -16701,7 +16690,7 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/feedbackLabels').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -16711,24 +16700,85 @@ export namespace contactcenterinsights_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Cancel + extends StandardParameters { /** - * Update feedback label. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + + export class Resource$Projects$Locations$Conversations { + context: APIRequestContext; + analyses: Resource$Projects$Locations$Conversations$Analyses; + assessments: Resource$Projects$Locations$Conversations$Assessments; + feedbackLabels: Resource$Projects$Locations$Conversations$Feedbacklabels; + segments: Resource$Projects$Locations$Conversations$Segments; + constructor(context: APIRequestContext) { + this.context = context; + this.analyses = new Resource$Projects$Locations$Conversations$Analyses( + this.context + ); + this.assessments = + new Resource$Projects$Locations$Conversations$Assessments(this.context); + this.feedbackLabels = + new Resource$Projects$Locations$Conversations$Feedbacklabels( + this.context + ); + this.segments = new Resource$Projects$Locations$Conversations$Segments( + this.context + ); + } + + /** + * Analyzes multiple conversations in a single request. * @example * ```js * // Before running the sample: @@ -16758,37 +16808,30 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.patch( - * { - * // Immutable. Resource name of the FeedbackLabel. Format: projects/{project\}/locations/{location\}/conversations/{conversation\}/feedbackLabels/{feedback_label\} - * name: 'projects/my-project/locations/my-location/authorizedViewSets/my-authorizedViewSet/authorizedViews/my-authorizedView/conversations/my-conversation/feedbackLabels/my-feedbackLabel', - * // Required. The list of fields to be updated. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "label": "my_label", - * // "labeledResource": "my_labeledResource", - * // "name": "my_name", - * // "qaAnswerLabel": {}, - * // "updateTime": "my_updateTime" - * // } - * }, - * }, - * ); - * console.log(res.data); + * await contactcenterinsights.projects.locations.conversations.bulkAnalyze({ + * // Required. The parent resource to create analyses in. + * parent: 'projects/my-project/locations/my-location', * - * // Example response - * // { - * // "createTime": "my_createTime", - * // "label": "my_label", - * // "labeledResource": "my_labeledResource", + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "analysisPercentage": {}, + * // "annotatorSelector": {}, + * // "filter": "my_filter", + * // "parent": "my_parent" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "qaAnswerLabel": {}, - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -16804,62 +16847,58 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch, + bulkAnalyze( + params: Params$Resource$Projects$Locations$Conversations$Bulkanalyze, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch, + bulkAnalyze( + params?: Params$Resource$Projects$Locations$Conversations$Bulkanalyze, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - patch( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch, + ): Promise>; + bulkAnalyze( + params: Params$Resource$Projects$Locations$Conversations$Bulkanalyze, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch, + bulkAnalyze( + params: Params$Resource$Projects$Locations$Conversations$Bulkanalyze, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch, - callback: BodyResponseCallback + bulkAnalyze( + params: Params$Resource$Projects$Locations$Conversations$Bulkanalyze, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + bulkAnalyze( + callback: BodyResponseCallback ): void; - patch( + bulkAnalyze( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Conversations$Bulkanalyze + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch; + {}) as Params$Resource$Projects$Locations$Conversations$Bulkanalyze; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch; + {} as Params$Resource$Projects$Locations$Conversations$Bulkanalyze; options = {}; } @@ -16873,104 +16912,32 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+parent}/conversations:bulkAnalyze').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Create - extends StandardParameters { - /** - * Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server. - */ - feedbackLabelId?: string; - /** - * Required. The parent resource of the feedback label. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1FeedbackLabel; - } - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Delete - extends StandardParameters { - /** - * Required. The name of the feedback label to delete. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Get - extends StandardParameters { - /** - * Required. The name of the feedback label to get. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$List - extends StandardParameters { - /** - * Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING - */ - filter?: string; - /** - * Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. - */ - pageSize?: number; - /** - * Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListFeedbackLabels` call and that the system should return the next page of data. - */ - pageToken?: string; - /** - * Required. The parent resource of the feedback labels. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Conversations$Feedbacklabels$Patch - extends StandardParameters { - /** - * Immutable. Resource name of the FeedbackLabel. Format: projects/{project\}/locations/{location\}/conversations/{conversation\}/feedbackLabels/{feedback_label\} - */ - name?: string; - /** - * Required. The list of fields to be updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1FeedbackLabel; - } - - export class Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Deletes multiple conversations in a single request. * @example * ```js * // Before running the sample: @@ -17000,16 +16967,31 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.cancel( - * { - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/authorizedViewSets/my-authorizedViewSet/authorizedViews/my-authorizedView/operations/my-operation', + * await contactcenterinsights.projects.locations.conversations.bulkDelete({ + * // Required. The parent resource to delete conversations from. Format: projects/{project\}/locations/{location\} + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "filter": "my_filter", + * // "force": false, + * // "maxDeleteCount": 0, + * // "parent": "my_parent" + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -17024,54 +17006,58 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Cancel, + bulkDelete( + params: Params$Resource$Projects$Locations$Conversations$Bulkdelete, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Cancel, + bulkDelete( + params?: Params$Resource$Projects$Locations$Conversations$Bulkdelete, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Cancel, + ): Promise>; + bulkDelete( + params: Params$Resource$Projects$Locations$Conversations$Bulkdelete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + bulkDelete( + params: Params$Resource$Projects$Locations$Conversations$Bulkdelete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Cancel, - callback: BodyResponseCallback + bulkDelete( + params: Params$Resource$Projects$Locations$Conversations$Bulkdelete, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + bulkDelete( + callback: BodyResponseCallback + ): void; + bulkDelete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Conversations$Bulkdelete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Conversations$Bulkdelete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Conversations$Bulkdelete; options = {}; } @@ -17085,29 +17071,32 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/conversations:bulkDelete').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Gets conversation statistics. * @example * ```js * // Before running the sample: @@ -17137,21 +17126,26 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.get( + * await contactcenterinsights.projects.locations.conversations.calculateStats( * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/authorizedViewSets/my-authorizedViewSet/authorizedViews/my-authorizedView/operations/my-operation', + * // A filter to reduce results to a specific subset. This field is useful for getting statistics about conversations with specific properties. + * filter: 'placeholder-value', + * // Required. The location of the conversations. + * location: 'projects/my-project/locations/my-location', * }, * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "averageDuration": "my_averageDuration", + * // "averageTurnCount": 0, + * // "conversationCount": 0, + * // "conversationCountTimeSeries": {}, + * // "customHighlighterMatches": {}, + * // "issueMatches": {}, + * // "issueMatchesStats": {}, + * // "smartHighlighterMatches": {} * // } * } * @@ -17167,58 +17161,62 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get, + calculateStats( + params: Params$Resource$Projects$Locations$Conversations$Calculatestats, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get, + calculateStats( + params?: Params$Resource$Projects$Locations$Conversations$Calculatestats, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + calculateStats( + params: Params$Resource$Projects$Locations$Conversations$Calculatestats, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get, + calculateStats( + params: Params$Resource$Projects$Locations$Conversations$Calculatestats, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get, - callback: BodyResponseCallback + calculateStats( + params: Params$Resource$Projects$Locations$Conversations$Calculatestats, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + calculateStats( + callback: BodyResponseCallback ): void; - get( + calculateStats( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Conversations$Calculatestats + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get; + {}) as Params$Resource$Projects$Locations$Conversations$Calculatestats; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get; + {} as Params$Resource$Projects$Locations$Conversations$Calculatestats; options = {}; } @@ -17232,29 +17230,33 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: ( + rootUrl + '/v1/{+location}/conversations:calculateStats' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['location'], + pathParams: ['location'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Creates a conversation. Note that this method does not support audio transcription or redaction. Use `conversations.upload` instead. * @example * ```js * // Before running the sample: @@ -17284,27 +17286,67 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.operations.list( - * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/authorizedViewSets/my-authorizedViewSet/authorizedViews/my-authorizedView', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', + * await contactcenterinsights.projects.locations.conversations.create({ + * // A unique ID for the new conversation. This ID will become the final component of the conversation's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64\}$`. Valid characters are `a-z-` + * conversationId: 'placeholder-value', + * // Required. The parent resource of the conversation. + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "agentId": "my_agentId", + * // "callMetadata": {}, + * // "createTime": "my_createTime", + * // "dataSource": {}, + * // "dialogflowIntents": {}, + * // "duration": "my_duration", + * // "expireTime": "my_expireTime", + * // "labels": {}, + * // "languageCode": "my_languageCode", + * // "latestAnalysis": {}, + * // "latestSummary": {}, + * // "medium": "my_medium", + * // "metadataJson": "my_metadataJson", + * // "name": "my_name", + * // "obfuscatedUserId": "my_obfuscatedUserId", + * // "qualityMetadata": {}, + * // "runtimeAnnotations": [], + * // "startTime": "my_startTime", + * // "transcript": {}, + * // "ttl": "my_ttl", + * // "turnCount": 0, + * // "updateTime": "my_updateTime" + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "agentId": "my_agentId", + * // "callMetadata": {}, + * // "createTime": "my_createTime", + * // "dataSource": {}, + * // "dialogflowIntents": {}, + * // "duration": "my_duration", + * // "expireTime": "my_expireTime", + * // "labels": {}, + * // "languageCode": "my_languageCode", + * // "latestAnalysis": {}, + * // "latestSummary": {}, + * // "medium": "my_medium", + * // "metadataJson": "my_metadataJson", + * // "name": "my_name", + * // "obfuscatedUserId": "my_obfuscatedUserId", + * // "qualityMetadata": {}, + * // "runtimeAnnotations": [], + * // "startTime": "my_startTime", + * // "transcript": {}, + * // "ttl": "my_ttl", + * // "turnCount": 0, + * // "updateTime": "my_updateTime" * // } * } * @@ -17320,62 +17362,61 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$List, + create( + params: Params$Resource$Projects$Locations$Conversations$Create, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$List, + create( + params?: Params$Resource$Projects$Locations$Conversations$Create, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$List, + create( + params: Params$Resource$Projects$Locations$Conversations$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$List, + create( + params: Params$Resource$Projects$Locations$Conversations$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Conversations$Create, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - list( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Conversations$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$List; + {}) as Params$Resource$Projects$Locations$Conversations$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$List; + params = {} as Params$Resource$Projects$Locations$Conversations$Create; options = {}; } @@ -17389,91 +17430,34 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+parent}/conversations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Cancel - extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Authorizedviewsets$Authorizedviews$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; /** - * The standard list page token. - */ - pageToken?: string; - /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - - export class Resource$Projects$Locations$Conversations { - context: APIRequestContext; - analyses: Resource$Projects$Locations$Conversations$Analyses; - assessments: Resource$Projects$Locations$Conversations$Assessments; - feedbackLabels: Resource$Projects$Locations$Conversations$Feedbacklabels; - constructor(context: APIRequestContext) { - this.context = context; - this.analyses = new Resource$Projects$Locations$Conversations$Analyses( - this.context - ); - this.assessments = - new Resource$Projects$Locations$Conversations$Assessments(this.context); - this.feedbackLabels = - new Resource$Projects$Locations$Conversations$Feedbacklabels( - this.context - ); - } - - /** - * Analyzes multiple conversations in a single request. + * Deletes a conversation. * @example * ```js * // Before running the sample: @@ -17503,31 +17487,16 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.conversations.bulkAnalyze({ - * // Required. The parent resource to create analyses in. - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "analysisPercentage": {}, - * // "annotatorSelector": {}, - * // "filter": "my_filter", - * // "parent": "my_parent" - * // } - * }, + * await contactcenterinsights.projects.locations.conversations.delete({ + * // If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses. + * force: 'placeholder-value', + * // Required. The name of the conversation to delete. + * name: 'projects/my-project/locations/my-location/conversations/my-conversation', * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -17542,58 +17511,53 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - bulkAnalyze( - params: Params$Resource$Projects$Locations$Conversations$Bulkanalyze, + delete( + params: Params$Resource$Projects$Locations$Conversations$Delete, options: StreamMethodOptions ): Promise>; - bulkAnalyze( - params?: Params$Resource$Projects$Locations$Conversations$Bulkanalyze, + delete( + params?: Params$Resource$Projects$Locations$Conversations$Delete, options?: MethodOptions - ): Promise>; - bulkAnalyze( - params: Params$Resource$Projects$Locations$Conversations$Bulkanalyze, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Conversations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - bulkAnalyze( - params: Params$Resource$Projects$Locations$Conversations$Bulkanalyze, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - bulkAnalyze( - params: Params$Resource$Projects$Locations$Conversations$Bulkanalyze, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Conversations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - bulkAnalyze( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Conversations$Delete, + callback: BodyResponseCallback ): void; - bulkAnalyze( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Bulkanalyze - | BodyResponseCallback + | Params$Resource$Projects$Locations$Conversations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$Bulkanalyze; + {}) as Params$Resource$Projects$Locations$Conversations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Conversations$Bulkanalyze; + params = {} as Params$Resource$Projects$Locations$Conversations$Delete; options = {}; } @@ -17607,32 +17571,29 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/conversations:bulkAnalyze').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes multiple conversations in a single request. + * Gets a conversation. * @example * ```js * // Before running the sample: @@ -17661,31 +17622,38 @@ export namespace contactcenterinsights_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await contactcenterinsights.projects.locations.conversations.bulkDelete({ - * // Required. The parent resource to delete conversations from. Format: projects/{project\}/locations/{location\} - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "filter": "my_filter", - * // "force": false, - * // "maxDeleteCount": 0, - * // "parent": "my_parent" - * // } - * }, - * }); + * const res = await contactcenterinsights.projects.locations.conversations.get({ + * // Required. The name of the conversation to get. + * name: 'projects/my-project/locations/my-location/conversations/my-conversation', + * // The level of details of the conversation. Default is `FULL`. + * view: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "agentId": "my_agentId", + * // "callMetadata": {}, + * // "createTime": "my_createTime", + * // "dataSource": {}, + * // "dialogflowIntents": {}, + * // "duration": "my_duration", + * // "expireTime": "my_expireTime", + * // "labels": {}, + * // "languageCode": "my_languageCode", + * // "latestAnalysis": {}, + * // "latestSummary": {}, + * // "medium": "my_medium", + * // "metadataJson": "my_metadataJson", * // "name": "my_name", - * // "response": {} + * // "obfuscatedUserId": "my_obfuscatedUserId", + * // "qualityMetadata": {}, + * // "runtimeAnnotations": [], + * // "startTime": "my_startTime", + * // "transcript": {}, + * // "ttl": "my_ttl", + * // "turnCount": 0, + * // "updateTime": "my_updateTime" * // } * } * @@ -17701,58 +17669,61 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - bulkDelete( - params: Params$Resource$Projects$Locations$Conversations$Bulkdelete, + get( + params: Params$Resource$Projects$Locations$Conversations$Get, options: StreamMethodOptions ): Promise>; - bulkDelete( - params?: Params$Resource$Projects$Locations$Conversations$Bulkdelete, + get( + params?: Params$Resource$Projects$Locations$Conversations$Get, options?: MethodOptions - ): Promise>; - bulkDelete( - params: Params$Resource$Projects$Locations$Conversations$Bulkdelete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Conversations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - bulkDelete( - params: Params$Resource$Projects$Locations$Conversations$Bulkdelete, + get( + params: Params$Resource$Projects$Locations$Conversations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - bulkDelete( - params: Params$Resource$Projects$Locations$Conversations$Bulkdelete, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Conversations$Get, + callback: BodyResponseCallback ): void; - bulkDelete( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - bulkDelete( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Bulkdelete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Conversations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$Bulkdelete; + {}) as Params$Resource$Projects$Locations$Conversations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Conversations$Bulkdelete; + params = {} as Params$Resource$Projects$Locations$Conversations$Get; options = {}; } @@ -17766,32 +17737,31 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/conversations:bulkDelete').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets conversation statistics. + * Imports conversations and processes them according to the user's configuration. * @example * ```js * // Before running the sample: @@ -17821,26 +17791,33 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.conversations.calculateStats( - * { - * // A filter to reduce results to a specific subset. This field is useful for getting statistics about conversations with specific properties. - * filter: 'placeholder-value', - * // Required. The location of the conversations. - * location: 'projects/my-project/locations/my-location', - * }, - * ); - * console.log(res.data); + * await contactcenterinsights.projects.locations.conversations.ingest({ + * // Required. The parent resource for new conversations. + * parent: 'projects/my-project/locations/my-location', * - * // Example response - * // { - * // "averageDuration": "my_averageDuration", - * // "averageTurnCount": 0, - * // "conversationCount": 0, - * // "conversationCountTimeSeries": {}, - * // "customHighlighterMatches": {}, - * // "issueMatches": {}, - * // "issueMatchesStats": {}, - * // "smartHighlighterMatches": {} + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "conversationConfig": {}, + * // "gcsSource": {}, + * // "parent": "my_parent", + * // "redactionConfig": {}, + * // "sampleSize": 0, + * // "speechConfig": {}, + * // "transcriptObjectConfig": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -17856,62 +17833,57 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - calculateStats( - params: Params$Resource$Projects$Locations$Conversations$Calculatestats, + ingest( + params: Params$Resource$Projects$Locations$Conversations$Ingest, options: StreamMethodOptions ): Promise>; - calculateStats( - params?: Params$Resource$Projects$Locations$Conversations$Calculatestats, + ingest( + params?: Params$Resource$Projects$Locations$Conversations$Ingest, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - calculateStats( - params: Params$Resource$Projects$Locations$Conversations$Calculatestats, + ): Promise>; + ingest( + params: Params$Resource$Projects$Locations$Conversations$Ingest, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - calculateStats( - params: Params$Resource$Projects$Locations$Conversations$Calculatestats, + ingest( + params: Params$Resource$Projects$Locations$Conversations$Ingest, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - calculateStats( - params: Params$Resource$Projects$Locations$Conversations$Calculatestats, - callback: BodyResponseCallback + ingest( + params: Params$Resource$Projects$Locations$Conversations$Ingest, + callback: BodyResponseCallback ): void; - calculateStats( - callback: BodyResponseCallback + ingest( + callback: BodyResponseCallback ): void; - calculateStats( + ingest( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Calculatestats - | BodyResponseCallback + | Params$Resource$Projects$Locations$Conversations$Ingest + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$Calculatestats; + {}) as Params$Resource$Projects$Locations$Conversations$Ingest; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Conversations$Calculatestats; + params = {} as Params$Resource$Projects$Locations$Conversations$Ingest; options = {}; } @@ -17925,33 +17897,32 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+location}/conversations:calculateStats' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+parent}/conversations:ingest').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['location'], - pathParams: ['location'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Creates a conversation. Note that this method does not support audio transcription or redaction. Use `conversations.upload` instead. + * Lists conversations. * @example * ```js * // Before running the sample: @@ -17980,68 +17951,28 @@ export namespace contactcenterinsights_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await contactcenterinsights.projects.locations.conversations.create({ - * // A unique ID for the new conversation. This ID will become the final component of the conversation's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64\}$`. Valid characters are `a-z-` - * conversationId: 'placeholder-value', + * const res = await contactcenterinsights.projects.locations.conversations.list( + * { + * // A filter to reduce results to a specific subset. Useful for querying conversations with specific properties. + * filter: 'placeholder-value', + * // Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering). + * orderBy: 'placeholder-value', + * // The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. + * pageSize: 'placeholder-value', + * // The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data. + * pageToken: 'placeholder-value', * // Required. The parent resource of the conversation. * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "agentId": "my_agentId", - * // "callMetadata": {}, - * // "createTime": "my_createTime", - * // "dataSource": {}, - * // "dialogflowIntents": {}, - * // "duration": "my_duration", - * // "expireTime": "my_expireTime", - * // "labels": {}, - * // "languageCode": "my_languageCode", - * // "latestAnalysis": {}, - * // "latestSummary": {}, - * // "medium": "my_medium", - * // "metadataJson": "my_metadataJson", - * // "name": "my_name", - * // "obfuscatedUserId": "my_obfuscatedUserId", - * // "qualityMetadata": {}, - * // "runtimeAnnotations": [], - * // "startTime": "my_startTime", - * // "transcript": {}, - * // "ttl": "my_ttl", - * // "turnCount": 0, - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * // The level of details of the conversation. Default is `BASIC`. + * view: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "agentId": "my_agentId", - * // "callMetadata": {}, - * // "createTime": "my_createTime", - * // "dataSource": {}, - * // "dialogflowIntents": {}, - * // "duration": "my_duration", - * // "expireTime": "my_expireTime", - * // "labels": {}, - * // "languageCode": "my_languageCode", - * // "latestAnalysis": {}, - * // "latestSummary": {}, - * // "medium": "my_medium", - * // "metadataJson": "my_metadataJson", - * // "name": "my_name", - * // "obfuscatedUserId": "my_obfuscatedUserId", - * // "qualityMetadata": {}, - * // "runtimeAnnotations": [], - * // "startTime": "my_startTime", - * // "transcript": {}, - * // "ttl": "my_ttl", - * // "turnCount": 0, - * // "updateTime": "my_updateTime" + * // "conversations": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -18057,61 +17988,61 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Conversations$Create, + list( + params: Params$Resource$Projects$Locations$Conversations$List, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Conversations$Create, + list( + params?: Params$Resource$Projects$Locations$Conversations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - create( - params: Params$Resource$Projects$Locations$Conversations$Create, + list( + params: Params$Resource$Projects$Locations$Conversations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Conversations$Create, + list( + params: Params$Resource$Projects$Locations$Conversations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Conversations$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Conversations$List, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - create( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Conversations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$Create; + {}) as Params$Resource$Projects$Locations$Conversations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Conversations$Create; + params = {} as Params$Resource$Projects$Locations$Conversations$List; options = {}; } @@ -18129,7 +18060,7 @@ export namespace contactcenterinsights_v1 { /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -18140,19 +18071,19 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a conversation. + * Updates a conversation. * @example * ```js * // Before running the sample: @@ -18182,147 +18113,43 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.conversations.delete({ - * // If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses. - * force: 'placeholder-value', - * // Required. The name of the conversation to delete. + * await contactcenterinsights.projects.locations.conversations.patch({ + * // Optional. Defaults to false. If set to true, and the conversation is not found, a new conversation will be created. In this situation, `update_mask` is ignored. + * allowMissing: 'placeholder-value', + * // Immutable. The resource name of the conversation. Format: projects/{project\}/locations/{location\}/conversations/{conversation\} * name: 'projects/my-project/locations/my-location/conversations/my-conversation', - * }); - * console.log(res.data); - * - * // Example response - * // {} - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` + * // The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `agent_id` * `language_code` * `labels` * `metadata` * `quality_metadata` * `call_metadata` * `start_time` * `expire_time` or `ttl` * `data_source.gcs_source.audio_uri` or * `data_source.dialogflow_source.audio_uri` * `data_source.screen_recordings` + * updateMask: 'placeholder-value', * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - delete( - params: Params$Resource$Projects$Locations$Conversations$Delete, - options: StreamMethodOptions - ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Conversations$Delete, - options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Conversations$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Conversations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Conversations$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Conversations$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Gets a conversation. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/contactcenterinsights.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const contactcenterinsights = google.contactcenterinsights('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await contactcenterinsights.projects.locations.conversations.get({ - * // Required. The name of the conversation to get. - * name: 'projects/my-project/locations/my-location/conversations/my-conversation', - * // The level of details of the conversation. Default is `FULL`. - * view: 'placeholder-value', - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "agentId": "my_agentId", + * // "callMetadata": {}, + * // "createTime": "my_createTime", + * // "dataSource": {}, + * // "dialogflowIntents": {}, + * // "duration": "my_duration", + * // "expireTime": "my_expireTime", + * // "labels": {}, + * // "languageCode": "my_languageCode", + * // "latestAnalysis": {}, + * // "latestSummary": {}, + * // "medium": "my_medium", + * // "metadataJson": "my_metadataJson", + * // "name": "my_name", + * // "obfuscatedUserId": "my_obfuscatedUserId", + * // "qualityMetadata": {}, + * // "runtimeAnnotations": [], + * // "startTime": "my_startTime", + * // "transcript": {}, + * // "ttl": "my_ttl", + * // "turnCount": 0, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response @@ -18364,38 +18191,38 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Conversations$Get, + patch( + params: Params$Resource$Projects$Locations$Conversations$Patch, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Conversations$Get, + patch( + params?: Params$Resource$Projects$Locations$Conversations$Patch, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Conversations$Get, + patch( + params: Params$Resource$Projects$Locations$Conversations$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Conversations$Get, + patch( + params: Params$Resource$Projects$Locations$Conversations$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Conversations$Get, + patch( + params: Params$Resource$Projects$Locations$Conversations$Patch, callback: BodyResponseCallback ): void; - get( + patch( callback: BodyResponseCallback ): void; - get( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Get + | Params$Resource$Projects$Locations$Conversations$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -18413,12 +18240,12 @@ export namespace contactcenterinsights_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$Get; + {}) as Params$Resource$Projects$Locations$Conversations$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Conversations$Get; + params = {} as Params$Resource$Projects$Locations$Conversations$Patch; options = {}; } @@ -18433,7 +18260,7 @@ export namespace contactcenterinsights_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -18456,7 +18283,7 @@ export namespace contactcenterinsights_v1 { } /** - * Imports conversations and processes them according to the user's configuration. + * Samples conversations based on user configuration and handles the sampled conversations for different use cases. * @example * ```js * // Before running the sample: @@ -18486,21 +18313,17 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.conversations.ingest({ - * // Required. The parent resource for new conversations. + * await contactcenterinsights.projects.locations.conversations.sample({ + * // Required. The parent resource of the dataset. * parent: 'projects/my-project/locations/my-location', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "conversationConfig": {}, - * // "gcsSource": {}, + * // "destinationDataset": {}, * // "parent": "my_parent", - * // "redactionConfig": {}, - * // "sampleSize": 0, - * // "speechConfig": {}, - * // "transcriptObjectConfig": {} + * // "sampleRule": {} * // } * }, * }); @@ -18528,36 +18351,36 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - ingest( - params: Params$Resource$Projects$Locations$Conversations$Ingest, + sample( + params: Params$Resource$Projects$Locations$Conversations$Sample, options: StreamMethodOptions ): Promise>; - ingest( - params?: Params$Resource$Projects$Locations$Conversations$Ingest, + sample( + params?: Params$Resource$Projects$Locations$Conversations$Sample, options?: MethodOptions ): Promise>; - ingest( - params: Params$Resource$Projects$Locations$Conversations$Ingest, + sample( + params: Params$Resource$Projects$Locations$Conversations$Sample, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - ingest( - params: Params$Resource$Projects$Locations$Conversations$Ingest, + sample( + params: Params$Resource$Projects$Locations$Conversations$Sample, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - ingest( - params: Params$Resource$Projects$Locations$Conversations$Ingest, + sample( + params: Params$Resource$Projects$Locations$Conversations$Sample, callback: BodyResponseCallback ): void; - ingest( + sample( callback: BodyResponseCallback ): void; - ingest( + sample( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Ingest + | Params$Resource$Projects$Locations$Conversations$Sample | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -18573,12 +18396,12 @@ export namespace contactcenterinsights_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$Ingest; + {}) as Params$Resource$Projects$Locations$Conversations$Sample; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Conversations$Ingest; + params = {} as Params$Resource$Projects$Locations$Conversations$Sample; options = {}; } @@ -18592,7 +18415,7 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/conversations:ingest').replace( + url: (rootUrl + '/v1/{+parent}/conversations:sample').replace( /([^:]\/)\/+/g, '$1' ), @@ -18617,7 +18440,7 @@ export namespace contactcenterinsights_v1 { } /** - * Lists conversations. + * Create a long-running conversation upload operation. This method differs from `CreateConversation` by allowing audio transcription and optional DLP redaction. * @example * ```js * // Before running the sample: @@ -18646,1316 +18469,32 @@ export namespace contactcenterinsights_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await contactcenterinsights.projects.locations.conversations.list( - * { - * // A filter to reduce results to a specific subset. Useful for querying conversations with specific properties. - * filter: 'placeholder-value', - * // Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering). - * orderBy: 'placeholder-value', - * // The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. - * pageSize: 'placeholder-value', - * // The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data. - * pageToken: 'placeholder-value', + * const res = + * await contactcenterinsights.projects.locations.conversations.upload({ * // Required. The parent resource of the conversation. * parent: 'projects/my-project/locations/my-location', - * // The level of details of the conversation. Default is `BASIC`. - * view: 'placeholder-value', - * }, - * ); - * console.log(res.data); * - * // Example response - * // { - * // "conversations": [], - * // "nextPageToken": "my_nextPageToken" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - list( - params: Params$Resource$Projects$Locations$Conversations$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Conversations$List, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Conversations$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Conversations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Conversations$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Conversations$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/conversations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Updates a conversation. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/contactcenterinsights.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const contactcenterinsights = google.contactcenterinsights('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await contactcenterinsights.projects.locations.conversations.patch({ - * // Optional. Defaults to false. If set to true, and the conversation is not found, a new conversation will be created. In this situation, `update_mask` is ignored. - * allowMissing: 'placeholder-value', - * // Immutable. The resource name of the conversation. Format: projects/{project\}/locations/{location\}/conversations/{conversation\} - * name: 'projects/my-project/locations/my-location/conversations/my-conversation', - * // The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `agent_id` * `language_code` * `labels` * `metadata` * `quality_metadata` * `call_metadata` * `start_time` * `expire_time` or `ttl` * `data_source.gcs_source.audio_uri` or * `data_source.dialogflow_source.audio_uri` * `data_source.screen_recordings` - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "agentId": "my_agentId", - * // "callMetadata": {}, - * // "createTime": "my_createTime", - * // "dataSource": {}, - * // "dialogflowIntents": {}, - * // "duration": "my_duration", - * // "expireTime": "my_expireTime", - * // "labels": {}, - * // "languageCode": "my_languageCode", - * // "latestAnalysis": {}, - * // "latestSummary": {}, - * // "medium": "my_medium", - * // "metadataJson": "my_metadataJson", - * // "name": "my_name", - * // "obfuscatedUserId": "my_obfuscatedUserId", - * // "qualityMetadata": {}, - * // "runtimeAnnotations": [], - * // "startTime": "my_startTime", - * // "transcript": {}, - * // "ttl": "my_ttl", - * // "turnCount": 0, - * // "updateTime": "my_updateTime" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "agentId": "my_agentId", - * // "callMetadata": {}, - * // "createTime": "my_createTime", - * // "dataSource": {}, - * // "dialogflowIntents": {}, - * // "duration": "my_duration", - * // "expireTime": "my_expireTime", - * // "labels": {}, - * // "languageCode": "my_languageCode", - * // "latestAnalysis": {}, - * // "latestSummary": {}, - * // "medium": "my_medium", - * // "metadataJson": "my_metadataJson", - * // "name": "my_name", - * // "obfuscatedUserId": "my_obfuscatedUserId", - * // "qualityMetadata": {}, - * // "runtimeAnnotations": [], - * // "startTime": "my_startTime", - * // "transcript": {}, - * // "ttl": "my_ttl", - * // "turnCount": 0, - * // "updateTime": "my_updateTime" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - patch( - params: Params$Resource$Projects$Locations$Conversations$Patch, - options: StreamMethodOptions - ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Conversations$Patch, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - patch( - params: Params$Resource$Projects$Locations$Conversations$Patch, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Conversations$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Conversations$Patch, - callback: BodyResponseCallback - ): void; - patch( - callback: BodyResponseCallback - ): void; - patch( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Patch - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Conversations$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Samples conversations based on user configuration and handles the sampled conversations for different use cases. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/contactcenterinsights.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const contactcenterinsights = google.contactcenterinsights('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await contactcenterinsights.projects.locations.conversations.sample({ - * // Required. The parent resource of the dataset. - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "destinationDataset": {}, - * // "parent": "my_parent", - * // "sampleRule": {} - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - sample( - params: Params$Resource$Projects$Locations$Conversations$Sample, - options: StreamMethodOptions - ): Promise>; - sample( - params?: Params$Resource$Projects$Locations$Conversations$Sample, - options?: MethodOptions - ): Promise>; - sample( - params: Params$Resource$Projects$Locations$Conversations$Sample, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - sample( - params: Params$Resource$Projects$Locations$Conversations$Sample, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - sample( - params: Params$Resource$Projects$Locations$Conversations$Sample, - callback: BodyResponseCallback - ): void; - sample( - callback: BodyResponseCallback - ): void; - sample( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Sample - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$Sample; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Conversations$Sample; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/conversations:sample').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Create a long-running conversation upload operation. This method differs from `CreateConversation` by allowing audio transcription and optional DLP redaction. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/contactcenterinsights.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const contactcenterinsights = google.contactcenterinsights('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await contactcenterinsights.projects.locations.conversations.upload({ - * // Required. The parent resource of the conversation. - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "conversation": {}, - * // "conversationId": "my_conversationId", - * // "parent": "my_parent", - * // "redactionConfig": {}, - * // "speechConfig": {} - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - upload( - params: Params$Resource$Projects$Locations$Conversations$Upload, - options: StreamMethodOptions - ): Promise>; - upload( - params?: Params$Resource$Projects$Locations$Conversations$Upload, - options?: MethodOptions - ): Promise>; - upload( - params: Params$Resource$Projects$Locations$Conversations$Upload, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - upload( - params: Params$Resource$Projects$Locations$Conversations$Upload, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - upload( - params: Params$Resource$Projects$Locations$Conversations$Upload, - callback: BodyResponseCallback - ): void; - upload( - callback: BodyResponseCallback - ): void; - upload( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Upload - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$Upload; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Conversations$Upload; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/conversations:upload').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Conversations$Bulkanalyze - extends StandardParameters { - /** - * Required. The parent resource to create analyses in. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest; - } - export interface Params$Resource$Projects$Locations$Conversations$Bulkdelete - extends StandardParameters { - /** - * Required. The parent resource to delete conversations from. Format: projects/{project\}/locations/{location\} - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest; - } - export interface Params$Resource$Projects$Locations$Conversations$Calculatestats - extends StandardParameters { - /** - * A filter to reduce results to a specific subset. This field is useful for getting statistics about conversations with specific properties. - */ - filter?: string; - /** - * Required. The location of the conversations. - */ - location?: string; - } - export interface Params$Resource$Projects$Locations$Conversations$Create - extends StandardParameters { - /** - * A unique ID for the new conversation. This ID will become the final component of the conversation's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64\}$`. Valid characters are `a-z-` - */ - conversationId?: string; - /** - * Required. The parent resource of the conversation. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1Conversation; - } - export interface Params$Resource$Projects$Locations$Conversations$Delete - extends StandardParameters { - /** - * If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses. - */ - force?: boolean; - /** - * Required. The name of the conversation to delete. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Conversations$Get - extends StandardParameters { - /** - * Required. The name of the conversation to get. - */ - name?: string; - /** - * The level of details of the conversation. Default is `FULL`. - */ - view?: string; - } - export interface Params$Resource$Projects$Locations$Conversations$Ingest - extends StandardParameters { - /** - * Required. The parent resource for new conversations. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1IngestConversationsRequest; - } - export interface Params$Resource$Projects$Locations$Conversations$List - extends StandardParameters { - /** - * A filter to reduce results to a specific subset. Useful for querying conversations with specific properties. - */ - filter?: string; - /** - * Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering). - */ - orderBy?: string; - /** - * The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. - */ - pageSize?: number; - /** - * The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data. - */ - pageToken?: string; - /** - * Required. The parent resource of the conversation. - */ - parent?: string; - /** - * The level of details of the conversation. Default is `BASIC`. - */ - view?: string; - } - export interface Params$Resource$Projects$Locations$Conversations$Patch - extends StandardParameters { - /** - * Optional. Defaults to false. If set to true, and the conversation is not found, a new conversation will be created. In this situation, `update_mask` is ignored. - */ - allowMissing?: boolean; - /** - * Immutable. The resource name of the conversation. Format: projects/{project\}/locations/{location\}/conversations/{conversation\} - */ - name?: string; - /** - * The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `agent_id` * `language_code` * `labels` * `metadata` * `quality_metadata` * `call_metadata` * `start_time` * `expire_time` or `ttl` * `data_source.gcs_source.audio_uri` or * `data_source.dialogflow_source.audio_uri` * `data_source.screen_recordings` - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1Conversation; - } - export interface Params$Resource$Projects$Locations$Conversations$Sample - extends StandardParameters { - /** - * Required. The parent resource of the dataset. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1SampleConversationsRequest; - } - export interface Params$Resource$Projects$Locations$Conversations$Upload - extends StandardParameters { - /** - * Required. The parent resource of the conversation. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1UploadConversationRequest; - } - - export class Resource$Projects$Locations$Conversations$Analyses { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Creates an analysis. The long running operation is done when the analysis has completed. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/contactcenterinsights.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const contactcenterinsights = google.contactcenterinsights('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await contactcenterinsights.projects.locations.conversations.analyses.create( - * { - * // Required. The parent resource of the analysis. - * parent: - * 'projects/my-project/locations/my-location/conversations/my-conversation', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "analysisResult": {}, - * // "annotatorSelector": {}, - * // "createTime": "my_createTime", - * // "name": "my_name", - * // "requestTime": "my_requestTime" - * // } - * }, - * }, - * ); - * console.log(res.data); - * - * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - create( - params: Params$Resource$Projects$Locations$Conversations$Analyses$Create, - options: StreamMethodOptions - ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Conversations$Analyses$Create, - options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Conversations$Analyses$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Conversations$Analyses$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Conversations$Analyses$Create, - callback: BodyResponseCallback - ): void; - create( - callback: BodyResponseCallback - ): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Analyses$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$Analyses$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Conversations$Analyses$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/analyses').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Deletes an analysis. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/contactcenterinsights.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const contactcenterinsights = google.contactcenterinsights('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await contactcenterinsights.projects.locations.conversations.analyses.delete( - * { - * // Required. The name of the analysis to delete. - * name: 'projects/my-project/locations/my-location/conversations/my-conversation/analyses/my-analyse', - * }, - * ); - * console.log(res.data); - * - * // Example response - * // {} - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - delete( - params: Params$Resource$Projects$Locations$Conversations$Analyses$Delete, - options: StreamMethodOptions - ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Conversations$Analyses$Delete, - options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Conversations$Analyses$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Conversations$Analyses$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Conversations$Analyses$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Analyses$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$Analyses$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Conversations$Analyses$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Gets an analysis. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/contactcenterinsights.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const contactcenterinsights = google.contactcenterinsights('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await contactcenterinsights.projects.locations.conversations.analyses.get({ - * // Required. The name of the analysis to get. - * name: 'projects/my-project/locations/my-location/conversations/my-conversation/analyses/my-analyse', + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "conversation": {}, + * // "conversationId": "my_conversationId", + * // "parent": "my_parent", + * // "redactionConfig": {}, + * // "speechConfig": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "analysisResult": {}, - * // "annotatorSelector": {}, - * // "createTime": "my_createTime", + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "requestTime": "my_requestTime" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - get( - params: Params$Resource$Projects$Locations$Conversations$Analyses$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Conversations$Analyses$Get, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Conversations$Analyses$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Conversations$Analyses$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Conversations$Analyses$Get, - callback: BodyResponseCallback - ): void; - get( - callback: BodyResponseCallback - ): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Analyses$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$Analyses$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Conversations$Analyses$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Lists analyses. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/contactcenterinsights.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const contactcenterinsights = google.contactcenterinsights('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await contactcenterinsights.projects.locations.conversations.analyses.list({ - * // A filter to reduce results to a specific subset. Useful for querying conversations with specific properties. - * filter: 'placeholder-value', - * // The maximum number of analyses to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. - * pageSize: 'placeholder-value', - * // The value returned by the last `ListAnalysesResponse`; indicates that this is a continuation of a prior `ListAnalyses` call and the system should return the next page of data. - * pageToken: 'placeholder-value', - * // Required. The parent resource of the analyses. - * parent: - * 'projects/my-project/locations/my-location/conversations/my-conversation', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "analyses": [], - * // "nextPageToken": "my_nextPageToken" + * // "response": {} * // } * } * @@ -19971,62 +18510,57 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Conversations$Analyses$List, + upload( + params: Params$Resource$Projects$Locations$Conversations$Upload, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Conversations$Analyses$List, + upload( + params?: Params$Resource$Projects$Locations$Conversations$Upload, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Conversations$Analyses$List, + ): Promise>; + upload( + params: Params$Resource$Projects$Locations$Conversations$Upload, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Conversations$Analyses$List, + upload( + params: Params$Resource$Projects$Locations$Conversations$Upload, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Conversations$Analyses$List, - callback: BodyResponseCallback + upload( + params: Params$Resource$Projects$Locations$Conversations$Upload, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + upload( + callback: BodyResponseCallback ): void; - list( + upload( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Analyses$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Conversations$Upload + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$Analyses$List; + {}) as Params$Resource$Projects$Locations$Conversations$Upload; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Conversations$Analyses$List; + params = {} as Params$Resource$Projects$Locations$Conversations$Upload; options = {}; } @@ -20040,11 +18574,11 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/analyses').replace( + url: (rootUrl + '/v1/{+parent}/conversations:upload').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -20055,77 +18589,181 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters + callback as BodyResponseCallback ); + } else { + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Conversations$Analyses$Create + export interface Params$Resource$Projects$Locations$Conversations$Bulkanalyze extends StandardParameters { /** - * Required. The parent resource of the analysis. + * Required. The parent resource to create analyses in. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1Analysis; + requestBody?: Schema$GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest; } - export interface Params$Resource$Projects$Locations$Conversations$Analyses$Delete + export interface Params$Resource$Projects$Locations$Conversations$Bulkdelete extends StandardParameters { /** - * Required. The name of the analysis to delete. + * Required. The parent resource to delete conversations from. Format: projects/{project\}/locations/{location\} + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest; + } + export interface Params$Resource$Projects$Locations$Conversations$Calculatestats + extends StandardParameters { + /** + * A filter to reduce results to a specific subset. This field is useful for getting statistics about conversations with specific properties. + */ + filter?: string; + /** + * Required. The location of the conversations. + */ + location?: string; + } + export interface Params$Resource$Projects$Locations$Conversations$Create + extends StandardParameters { + /** + * A unique ID for the new conversation. This ID will become the final component of the conversation's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64\}$`. Valid characters are `a-z-` + */ + conversationId?: string; + /** + * Required. The parent resource of the conversation. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1Conversation; + } + export interface Params$Resource$Projects$Locations$Conversations$Delete + extends StandardParameters { + /** + * If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses. + */ + force?: boolean; + /** + * Required. The name of the conversation to delete. */ name?: string; } - export interface Params$Resource$Projects$Locations$Conversations$Analyses$Get + export interface Params$Resource$Projects$Locations$Conversations$Get extends StandardParameters { /** - * Required. The name of the analysis to get. + * Required. The name of the conversation to get. */ name?: string; + /** + * The level of details of the conversation. Default is `FULL`. + */ + view?: string; } - export interface Params$Resource$Projects$Locations$Conversations$Analyses$List + export interface Params$Resource$Projects$Locations$Conversations$Ingest + extends StandardParameters { + /** + * Required. The parent resource for new conversations. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1IngestConversationsRequest; + } + export interface Params$Resource$Projects$Locations$Conversations$List extends StandardParameters { /** * A filter to reduce results to a specific subset. Useful for querying conversations with specific properties. */ filter?: string; /** - * The maximum number of analyses to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. + * Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering). + */ + orderBy?: string; + /** + * The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. */ pageSize?: number; /** - * The value returned by the last `ListAnalysesResponse`; indicates that this is a continuation of a prior `ListAnalyses` call and the system should return the next page of data. + * The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data. */ pageToken?: string; /** - * Required. The parent resource of the analyses. + * Required. The parent resource of the conversation. */ parent?: string; + /** + * The level of details of the conversation. Default is `BASIC`. + */ + view?: string; + } + export interface Params$Resource$Projects$Locations$Conversations$Patch + extends StandardParameters { + /** + * Optional. Defaults to false. If set to true, and the conversation is not found, a new conversation will be created. In this situation, `update_mask` is ignored. + */ + allowMissing?: boolean; + /** + * Immutable. The resource name of the conversation. Format: projects/{project\}/locations/{location\}/conversations/{conversation\} + */ + name?: string; + /** + * The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `agent_id` * `language_code` * `labels` * `metadata` * `quality_metadata` * `call_metadata` * `start_time` * `expire_time` or `ttl` * `data_source.gcs_source.audio_uri` or * `data_source.dialogflow_source.audio_uri` * `data_source.screen_recordings` + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1Conversation; } + export interface Params$Resource$Projects$Locations$Conversations$Sample + extends StandardParameters { + /** + * Required. The parent resource of the dataset. + */ + parent?: string; - export class Resource$Projects$Locations$Conversations$Assessments { + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1SampleConversationsRequest; + } + export interface Params$Resource$Projects$Locations$Conversations$Upload + extends StandardParameters { + /** + * Required. The parent resource of the conversation. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1UploadConversationRequest; + } + + export class Resource$Projects$Locations$Conversations$Analyses { context: APIRequestContext; - notes: Resource$Projects$Locations$Conversations$Assessments$Notes; constructor(context: APIRequestContext) { this.context = context; - this.notes = - new Resource$Projects$Locations$Conversations$Assessments$Notes( - this.context - ); } /** - * Appeal an Assessment. + * Creates an analysis. The long running operation is done when the analysis has completed. * @example * ```js * // Before running the sample: @@ -20155,15 +18793,22 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.conversations.assessments.appeal( + * await contactcenterinsights.projects.locations.conversations.analyses.create( * { - * // Required. The name of the assessment to appeal. - * name: 'projects/my-project/locations/my-location/conversations/my-conversation/assessments/my-assessment', + * // Required. The parent resource of the analysis. + * parent: + * 'projects/my-project/locations/my-location/conversations/my-conversation', * * // Request body metadata * requestBody: { * // request body parameters - * // {} + * // { + * // "analysisResult": {}, + * // "annotatorSelector": {}, + * // "createTime": "my_createTime", + * // "name": "my_name", + * // "requestTime": "my_requestTime" + * // } * }, * }, * ); @@ -20171,11 +18816,11 @@ export namespace contactcenterinsights_v1 { * * // Example response * // { - * // "agentInfo": {}, - * // "createTime": "my_createTime", + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "state": "my_state", - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -20191,62 +18836,58 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - appeal( - params: Params$Resource$Projects$Locations$Conversations$Assessments$Appeal, + create( + params: Params$Resource$Projects$Locations$Conversations$Analyses$Create, options: StreamMethodOptions ): Promise>; - appeal( - params?: Params$Resource$Projects$Locations$Conversations$Assessments$Appeal, + create( + params?: Params$Resource$Projects$Locations$Conversations$Analyses$Create, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - appeal( - params: Params$Resource$Projects$Locations$Conversations$Assessments$Appeal, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Conversations$Analyses$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - appeal( - params: Params$Resource$Projects$Locations$Conversations$Assessments$Appeal, + create( + params: Params$Resource$Projects$Locations$Conversations$Analyses$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - appeal( - params: Params$Resource$Projects$Locations$Conversations$Assessments$Appeal, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Conversations$Analyses$Create, + callback: BodyResponseCallback ): void; - appeal( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - appeal( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Assessments$Appeal - | BodyResponseCallback + | Params$Resource$Projects$Locations$Conversations$Analyses$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$Assessments$Appeal; + {}) as Params$Resource$Projects$Locations$Conversations$Analyses$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Conversations$Assessments$Appeal; + {} as Params$Resource$Projects$Locations$Conversations$Analyses$Create; options = {}; } @@ -20260,31 +18901,32 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:appeal').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/analyses').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Create Assessment. + * Deletes an analysis. * @example * ```js * // Before running the sample: @@ -20312,37 +18954,18 @@ export namespace contactcenterinsights_v1 { * const authClient = await auth.getClient(); * google.options({auth: authClient}); * - * // Do the magic - * const res = - * await contactcenterinsights.projects.locations.conversations.assessments.create( - * { - * // Required. The parent resource of the assessment. - * parent: - * 'projects/my-project/locations/my-location/conversations/my-conversation', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "agentInfo": {}, - * // "createTime": "my_createTime", - * // "name": "my_name", - * // "state": "my_state", - * // "updateTime": "my_updateTime" - * // } - * }, + * // Do the magic + * const res = + * await contactcenterinsights.projects.locations.conversations.analyses.delete( + * { + * // Required. The name of the analysis to delete. + * name: 'projects/my-project/locations/my-location/conversations/my-conversation/analyses/my-analyse', * }, * ); * console.log(res.data); * * // Example response - * // { - * // "agentInfo": {}, - * // "createTime": "my_createTime", - * // "name": "my_name", - * // "state": "my_state", - * // "updateTime": "my_updateTime" - * // } + * // {} * } * * main().catch(e => { @@ -20357,62 +18980,54 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Conversations$Assessments$Create, + delete( + params: Params$Resource$Projects$Locations$Conversations$Analyses$Delete, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Conversations$Assessments$Create, + delete( + params?: Params$Resource$Projects$Locations$Conversations$Analyses$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - create( - params: Params$Resource$Projects$Locations$Conversations$Assessments$Create, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Conversations$Analyses$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Conversations$Assessments$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Conversations$Assessments$Create, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Conversations$Analyses$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Conversations$Analyses$Delete, + callback: BodyResponseCallback ): void; - create( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Assessments$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Conversations$Analyses$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$Assessments$Create; + {}) as Params$Resource$Projects$Locations$Conversations$Analyses$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Conversations$Assessments$Create; + {} as Params$Resource$Projects$Locations$Conversations$Analyses$Delete; options = {}; } @@ -20426,34 +19041,29 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/assessments').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Delete an Assessment. + * Gets an analysis. * @example * ```js * // Before running the sample: @@ -20483,18 +19093,20 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.conversations.assessments.delete( - * { - * // Optional. If set to true, all of this assessment's notes will also be deleted. Otherwise, the request will only succeed if it has no notes. - * force: 'placeholder-value', - * // Required. The name of the assessment to delete. - * name: 'projects/my-project/locations/my-location/conversations/my-conversation/assessments/my-assessment', - * }, - * ); + * await contactcenterinsights.projects.locations.conversations.analyses.get({ + * // Required. The name of the analysis to get. + * name: 'projects/my-project/locations/my-location/conversations/my-conversation/analyses/my-analyse', + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "analysisResult": {}, + * // "annotatorSelector": {}, + * // "createTime": "my_createTime", + * // "name": "my_name", + * // "requestTime": "my_requestTime" + * // } * } * * main().catch(e => { @@ -20509,54 +19121,62 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Conversations$Assessments$Delete, + get( + params: Params$Resource$Projects$Locations$Conversations$Analyses$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Conversations$Assessments$Delete, + get( + params?: Params$Resource$Projects$Locations$Conversations$Analyses$Get, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Conversations$Assessments$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Conversations$Analyses$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Conversations$Assessments$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Conversations$Analyses$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Conversations$Assessments$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Conversations$Analyses$Get, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Assessments$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Conversations$Analyses$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$Assessments$Delete; + {}) as Params$Resource$Projects$Locations$Conversations$Analyses$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Conversations$Assessments$Delete; + {} as Params$Resource$Projects$Locations$Conversations$Analyses$Get; options = {}; } @@ -20571,7 +19191,7 @@ export namespace contactcenterinsights_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -20582,17 +19202,19 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Finalize an Assessment. + * Lists analyses. * @example * ```js * // Before running the sample: @@ -20622,27 +19244,23 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.conversations.assessments.finalize( - * { - * // Required. The name of the assessment to finalize. - * name: 'projects/my-project/locations/my-location/conversations/my-conversation/assessments/my-assessment', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }, - * ); + * await contactcenterinsights.projects.locations.conversations.analyses.list({ + * // A filter to reduce results to a specific subset. Useful for querying conversations with specific properties. + * filter: 'placeholder-value', + * // The maximum number of analyses to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. + * pageSize: 'placeholder-value', + * // The value returned by the last `ListAnalysesResponse`; indicates that this is a continuation of a prior `ListAnalyses` call and the system should return the next page of data. + * pageToken: 'placeholder-value', + * // Required. The parent resource of the analyses. + * parent: + * 'projects/my-project/locations/my-location/conversations/my-conversation', + * }); * console.log(res.data); * * // Example response * // { - * // "agentInfo": {}, - * // "createTime": "my_createTime", - * // "name": "my_name", - * // "state": "my_state", - * // "updateTime": "my_updateTime" + * // "analyses": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -20658,62 +19276,62 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - finalize( - params: Params$Resource$Projects$Locations$Conversations$Assessments$Finalize, + list( + params: Params$Resource$Projects$Locations$Conversations$Analyses$List, options: StreamMethodOptions ): Promise>; - finalize( - params?: Params$Resource$Projects$Locations$Conversations$Assessments$Finalize, + list( + params?: Params$Resource$Projects$Locations$Conversations$Analyses$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - finalize( - params: Params$Resource$Projects$Locations$Conversations$Assessments$Finalize, + list( + params: Params$Resource$Projects$Locations$Conversations$Analyses$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - finalize( - params: Params$Resource$Projects$Locations$Conversations$Assessments$Finalize, + list( + params: Params$Resource$Projects$Locations$Conversations$Analyses$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - finalize( - params: Params$Resource$Projects$Locations$Conversations$Assessments$Finalize, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Conversations$Analyses$List, + callback: BodyResponseCallback ): void; - finalize( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - finalize( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Assessments$Finalize - | BodyResponseCallback + | Params$Resource$Projects$Locations$Conversations$Analyses$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$Assessments$Finalize; + {}) as Params$Resource$Projects$Locations$Conversations$Analyses$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Conversations$Assessments$Finalize; + {} as Params$Resource$Projects$Locations$Conversations$Analyses$List; options = {}; } @@ -20727,34 +19345,92 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:finalize').replace( + url: (rootUrl + '/v1/{+parent}/analyses').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + + export interface Params$Resource$Projects$Locations$Conversations$Analyses$Create + extends StandardParameters { + /** + * Required. The parent resource of the analysis. + */ + parent?: string; /** - * Get Assessment. + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1Analysis; + } + export interface Params$Resource$Projects$Locations$Conversations$Analyses$Delete + extends StandardParameters { + /** + * Required. The name of the analysis to delete. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Conversations$Analyses$Get + extends StandardParameters { + /** + * Required. The name of the analysis to get. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Conversations$Analyses$List + extends StandardParameters { + /** + * A filter to reduce results to a specific subset. Useful for querying conversations with specific properties. + */ + filter?: string; + /** + * The maximum number of analyses to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. + */ + pageSize?: number; + /** + * The value returned by the last `ListAnalysesResponse`; indicates that this is a continuation of a prior `ListAnalyses` call and the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. The parent resource of the analyses. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Conversations$Assessments { + context: APIRequestContext; + notes: Resource$Projects$Locations$Conversations$Assessments$Notes; + constructor(context: APIRequestContext) { + this.context = context; + this.notes = + new Resource$Projects$Locations$Conversations$Assessments$Notes( + this.context + ); + } + + /** + * Appeal an Assessment. * @example * ```js * // Before running the sample: @@ -20784,10 +19460,16 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.conversations.assessments.get( + * await contactcenterinsights.projects.locations.conversations.assessments.appeal( * { - * // Required. The name of the assessment to get. + * // Required. The name of the assessment to appeal. * name: 'projects/my-project/locations/my-location/conversations/my-conversation/assessments/my-assessment', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, * }, * ); * console.log(res.data); @@ -20814,38 +19496,38 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Conversations$Assessments$Get, + appeal( + params: Params$Resource$Projects$Locations$Conversations$Assessments$Appeal, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Conversations$Assessments$Get, + appeal( + params?: Params$Resource$Projects$Locations$Conversations$Assessments$Appeal, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Conversations$Assessments$Get, + appeal( + params: Params$Resource$Projects$Locations$Conversations$Assessments$Appeal, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Conversations$Assessments$Get, + appeal( + params: Params$Resource$Projects$Locations$Conversations$Assessments$Appeal, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Conversations$Assessments$Get, + appeal( + params: Params$Resource$Projects$Locations$Conversations$Assessments$Appeal, callback: BodyResponseCallback ): void; - get( + appeal( callback: BodyResponseCallback ): void; - get( + appeal( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Assessments$Get + | Params$Resource$Projects$Locations$Conversations$Assessments$Appeal | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -20863,13 +19545,13 @@ export namespace contactcenterinsights_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$Assessments$Get; + {}) as Params$Resource$Projects$Locations$Conversations$Assessments$Appeal; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Conversations$Assessments$Get; + {} as Params$Resource$Projects$Locations$Conversations$Assessments$Appeal; options = {}; } @@ -20883,8 +19565,8 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:appeal').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -20907,7 +19589,7 @@ export namespace contactcenterinsights_v1 { } /** - * List Assessments. + * Create Assessment. * @example * ```js * // Before running the sample: @@ -20937,25 +19619,34 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.conversations.assessments.list( + * await contactcenterinsights.projects.locations.conversations.assessments.create( * { - * // Optional. A filter to reduce results to a specific subset. Supported filters include: * `state` - The state of the assessment * `agent_info.agent_id` - The ID of the agent the assessment is for - * filter: 'placeholder-value', - * // The maximum number of assessments to list. If zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. - * pageSize: 'placeholder-value', - * // Optional. The value returned by the last `ListAssessmentRulesResponse`; indicates that this is a continuation of a prior `ListAssessmentRules` call and the system should return the next page of data. - * pageToken: 'placeholder-value', - * // Required. The parent resource of the assessments. To list all assessments in a location, substitute the conversation ID with a '-' character. + * // Required. The parent resource of the assessment. * parent: * 'projects/my-project/locations/my-location/conversations/my-conversation', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "agentInfo": {}, + * // "createTime": "my_createTime", + * // "name": "my_name", + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } + * }, * }, * ); * console.log(res.data); * * // Example response * // { - * // "assessments": [], - * // "nextPageToken": "my_nextPageToken" + * // "agentInfo": {}, + * // "createTime": "my_createTime", + * // "name": "my_name", + * // "state": "my_state", + * // "updateTime": "my_updateTime" * // } * } * @@ -20971,62 +19662,62 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Conversations$Assessments$List, + create( + params: Params$Resource$Projects$Locations$Conversations$Assessments$Create, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Conversations$Assessments$List, + create( + params?: Params$Resource$Projects$Locations$Conversations$Assessments$Create, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Conversations$Assessments$List, + create( + params: Params$Resource$Projects$Locations$Conversations$Assessments$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Conversations$Assessments$List, + create( + params: Params$Resource$Projects$Locations$Conversations$Assessments$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Conversations$Assessments$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Conversations$Assessments$Create, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - list( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Assessments$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Conversations$Assessments$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$Assessments$List; + {}) as Params$Resource$Projects$Locations$Conversations$Assessments$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Conversations$Assessments$List; + {} as Params$Resource$Projects$Locations$Conversations$Assessments$Create; options = {}; } @@ -21044,7 +19735,7 @@ export namespace contactcenterinsights_v1 { /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -21055,19 +19746,19 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Publish an Assessment. + * Delete an Assessment. * @example * ```js * // Before running the sample: @@ -21097,28 +19788,18 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.conversations.assessments.publish( + * await contactcenterinsights.projects.locations.conversations.assessments.delete( * { - * // Required. The name of the assessment to publish. + * // Optional. If set to true, all of this assessment's notes will also be deleted. Otherwise, the request will only succeed if it has no notes. + * force: 'placeholder-value', + * // Required. The name of the assessment to delete. * name: 'projects/my-project/locations/my-location/conversations/my-conversation/assessments/my-assessment', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, * }, * ); * console.log(res.data); * * // Example response - * // { - * // "agentInfo": {}, - * // "createTime": "my_createTime", - * // "name": "my_name", - * // "state": "my_state", - * // "updateTime": "my_updateTime" - * // } + * // {} * } * * main().catch(e => { @@ -21133,62 +19814,54 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - publish( - params: Params$Resource$Projects$Locations$Conversations$Assessments$Publish, + delete( + params: Params$Resource$Projects$Locations$Conversations$Assessments$Delete, options: StreamMethodOptions ): Promise>; - publish( - params?: Params$Resource$Projects$Locations$Conversations$Assessments$Publish, + delete( + params?: Params$Resource$Projects$Locations$Conversations$Assessments$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - publish( - params: Params$Resource$Projects$Locations$Conversations$Assessments$Publish, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Conversations$Assessments$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - publish( - params: Params$Resource$Projects$Locations$Conversations$Assessments$Publish, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - publish( - params: Params$Resource$Projects$Locations$Conversations$Assessments$Publish, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Conversations$Assessments$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - publish( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Conversations$Assessments$Delete, + callback: BodyResponseCallback ): void; - publish( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Assessments$Publish - | BodyResponseCallback + | Params$Resource$Projects$Locations$Conversations$Assessments$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$Assessments$Publish; + {}) as Params$Resource$Projects$Locations$Conversations$Assessments$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Conversations$Assessments$Publish; + {} as Params$Resource$Projects$Locations$Conversations$Assessments$Delete; options = {}; } @@ -21202,11 +19875,8 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:publish').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -21217,112 +19887,17 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Conversations$Assessments$Appeal - extends StandardParameters { - /** - * Required. The name of the assessment to appeal. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1AppealAssessmentRequest; - } - export interface Params$Resource$Projects$Locations$Conversations$Assessments$Create - extends StandardParameters { - /** - * Required. The parent resource of the assessment. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1Assessment; - } - export interface Params$Resource$Projects$Locations$Conversations$Assessments$Delete - extends StandardParameters { - /** - * Optional. If set to true, all of this assessment's notes will also be deleted. Otherwise, the request will only succeed if it has no notes. - */ - force?: boolean; - /** - * Required. The name of the assessment to delete. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Conversations$Assessments$Finalize - extends StandardParameters { - /** - * Required. The name of the assessment to finalize. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1FinalizeAssessmentRequest; - } - export interface Params$Resource$Projects$Locations$Conversations$Assessments$Get - extends StandardParameters { - /** - * Required. The name of the assessment to get. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Conversations$Assessments$List - extends StandardParameters { - /** - * Optional. A filter to reduce results to a specific subset. Supported filters include: * `state` - The state of the assessment * `agent_info.agent_id` - The ID of the agent the assessment is for - */ - filter?: string; - /** - * The maximum number of assessments to list. If zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. - */ - pageSize?: number; - /** - * Optional. The value returned by the last `ListAssessmentRulesResponse`; indicates that this is a continuation of a prior `ListAssessmentRules` call and the system should return the next page of data. - */ - pageToken?: string; - /** - * Required. The parent resource of the assessments. To list all assessments in a location, substitute the conversation ID with a '-' character. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Conversations$Assessments$Publish - extends StandardParameters { - /** - * Required. The name of the assessment to publish. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1PublishAssessmentRequest; - } - - export class Resource$Projects$Locations$Conversations$Assessments$Notes { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Create Note. + * Finalize an Assessment. * @example * ```js * // Before running the sample: @@ -21352,25 +19927,15 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.conversations.assessments.notes.create( + * await contactcenterinsights.projects.locations.conversations.assessments.finalize( * { - * // Required. The parent resource of the note. - * parent: - * 'projects/my-project/locations/my-location/conversations/my-conversation/assessments/my-assessment', + * // Required. The name of the assessment to finalize. + * name: 'projects/my-project/locations/my-location/conversations/my-conversation/assessments/my-assessment', * * // Request body metadata * requestBody: { * // request body parameters - * // { - * // "assessmentNote": {}, - * // "content": "my_content", - * // "conversationTurnNote": {}, - * // "createTime": "my_createTime", - * // "name": "my_name", - * // "noteCreator": {}, - * // "qaQuestionNote": {}, - * // "updateTime": "my_updateTime" - * // } + * // {} * }, * }, * ); @@ -21378,13 +19943,10 @@ export namespace contactcenterinsights_v1 { * * // Example response * // { - * // "assessmentNote": {}, - * // "content": "my_content", - * // "conversationTurnNote": {}, + * // "agentInfo": {}, * // "createTime": "my_createTime", * // "name": "my_name", - * // "noteCreator": {}, - * // "qaQuestionNote": {}, + * // "state": "my_state", * // "updateTime": "my_updateTime" * // } * } @@ -21401,62 +19963,62 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Create, + finalize( + params: Params$Resource$Projects$Locations$Conversations$Assessments$Finalize, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Create, + finalize( + params?: Params$Resource$Projects$Locations$Conversations$Assessments$Finalize, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - create( - params: Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Create, + finalize( + params: Params$Resource$Projects$Locations$Conversations$Assessments$Finalize, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Create, + finalize( + params: Params$Resource$Projects$Locations$Conversations$Assessments$Finalize, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Create, - callback: BodyResponseCallback + finalize( + params: Params$Resource$Projects$Locations$Conversations$Assessments$Finalize, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + finalize( + callback: BodyResponseCallback ): void; - create( + finalize( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Conversations$Assessments$Finalize + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Create; + {}) as Params$Resource$Projects$Locations$Conversations$Assessments$Finalize; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Create; + {} as Params$Resource$Projects$Locations$Conversations$Assessments$Finalize; options = {}; } @@ -21470,7 +20032,7 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/notes').replace( + url: (rootUrl + '/v1/{+name}:finalize').replace( /([^:]\/)\/+/g, '$1' ), @@ -21480,24 +20042,24 @@ export namespace contactcenterinsights_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a Note. + * Get Assessment. * @example * ```js * // Before running the sample: @@ -21527,16 +20089,22 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.conversations.assessments.notes.delete( + * await contactcenterinsights.projects.locations.conversations.assessments.get( * { - * // Required. The name of the note to delete. - * name: 'projects/my-project/locations/my-location/conversations/my-conversation/assessments/my-assessment/notes/my-note', + * // Required. The name of the assessment to get. + * name: 'projects/my-project/locations/my-location/conversations/my-conversation/assessments/my-assessment', * }, * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "agentInfo": {}, + * // "createTime": "my_createTime", + * // "name": "my_name", + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } * } * * main().catch(e => { @@ -21551,54 +20119,62 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Delete, + get( + params: Params$Resource$Projects$Locations$Conversations$Assessments$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Delete, + get( + params?: Params$Resource$Projects$Locations$Conversations$Assessments$Get, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Conversations$Assessments$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Conversations$Assessments$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Conversations$Assessments$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Conversations$Assessments$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Delete; + {}) as Params$Resource$Projects$Locations$Conversations$Assessments$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Delete; + {} as Params$Resource$Projects$Locations$Conversations$Assessments$Get; options = {}; } @@ -21613,7 +20189,7 @@ export namespace contactcenterinsights_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -21624,17 +20200,19 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * List Notes. + * List Assessments. * @example * ```js * // Before running the sample: @@ -21664,23 +20242,25 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.conversations.assessments.notes.list( + * await contactcenterinsights.projects.locations.conversations.assessments.list( * { - * // Optional. The maximum number of notes to return in the response. If zero the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. + * // Optional. A filter to reduce results to a specific subset. Supported filters include: * `state` - The state of the assessment * `agent_info.agent_id` - The ID of the agent the assessment is for + * filter: 'placeholder-value', + * // The maximum number of assessments to list. If zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. * pageSize: 'placeholder-value', - * // Optional. The value returned by the last `ListNotesResponse`. This value indicates that this is a continuation of a prior `ListNotes` call and that the system should return the next page of data. + * // Optional. The value returned by the last `ListAssessmentRulesResponse`; indicates that this is a continuation of a prior `ListAssessmentRules` call and the system should return the next page of data. * pageToken: 'placeholder-value', - * // Required. The parent resource of the notes. + * // Required. The parent resource of the assessments. To list all assessments in a location, substitute the conversation ID with a '-' character. * parent: - * 'projects/my-project/locations/my-location/conversations/my-conversation/assessments/my-assessment', + * 'projects/my-project/locations/my-location/conversations/my-conversation', * }, * ); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "notes": [] + * // "assessments": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -21697,61 +20277,61 @@ export namespace contactcenterinsights_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Conversations$Assessments$Notes$List, + params: Params$Resource$Projects$Locations$Conversations$Assessments$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Conversations$Assessments$Notes$List, + params?: Params$Resource$Projects$Locations$Conversations$Assessments$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Conversations$Assessments$Notes$List, + params: Params$Resource$Projects$Locations$Conversations$Assessments$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Conversations$Assessments$Notes$List, + params: Params$Resource$Projects$Locations$Conversations$Assessments$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Conversations$Assessments$Notes$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Conversations$Assessments$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Assessments$Notes$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Conversations$Assessments$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$Assessments$Notes$List; + {}) as Params$Resource$Projects$Locations$Conversations$Assessments$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Conversations$Assessments$Notes$List; + {} as Params$Resource$Projects$Locations$Conversations$Assessments$List; options = {}; } @@ -21765,7 +20345,7 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/notes').replace( + url: (rootUrl + '/v1/{+parent}/assessments').replace( /([^:]\/)\/+/g, '$1' ), @@ -21780,19 +20360,19 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Update Note. + * Publish an Assessment. * @example * ```js * // Before running the sample: @@ -21822,26 +20402,15 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.conversations.assessments.notes.patch( + * await contactcenterinsights.projects.locations.conversations.assessments.publish( * { - * // Identifier. The resource name of the note. Format: projects/{project\}/locations/{location\}/conversations/{conversation\}/assessments/{assessment\}/notes/{note\} - * name: 'projects/my-project/locations/my-location/conversations/my-conversation/assessments/my-assessment/notes/my-note', - * // Optional. The list of fields to be updated. If the update_mask is empty, all updateable fields will be updated. Acceptable fields include: * `content` - * updateMask: 'placeholder-value', + * // Required. The name of the assessment to publish. + * name: 'projects/my-project/locations/my-location/conversations/my-conversation/assessments/my-assessment', * * // Request body metadata * requestBody: { * // request body parameters - * // { - * // "assessmentNote": {}, - * // "content": "my_content", - * // "conversationTurnNote": {}, - * // "createTime": "my_createTime", - * // "name": "my_name", - * // "noteCreator": {}, - * // "qaQuestionNote": {}, - * // "updateTime": "my_updateTime" - * // } + * // {} * }, * }, * ); @@ -21849,13 +20418,10 @@ export namespace contactcenterinsights_v1 { * * // Example response * // { - * // "assessmentNote": {}, - * // "content": "my_content", - * // "conversationTurnNote": {}, + * // "agentInfo": {}, * // "createTime": "my_createTime", * // "name": "my_name", - * // "noteCreator": {}, - * // "qaQuestionNote": {}, + * // "state": "my_state", * // "updateTime": "my_updateTime" * // } * } @@ -21872,62 +20438,62 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Patch, + publish( + params: Params$Resource$Projects$Locations$Conversations$Assessments$Publish, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Patch, + publish( + params?: Params$Resource$Projects$Locations$Conversations$Assessments$Publish, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - patch( - params: Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Patch, + publish( + params: Params$Resource$Projects$Locations$Conversations$Assessments$Publish, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Patch, + publish( + params: Params$Resource$Projects$Locations$Conversations$Assessments$Publish, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Patch, - callback: BodyResponseCallback + publish( + params: Params$Resource$Projects$Locations$Conversations$Assessments$Publish, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + publish( + callback: BodyResponseCallback ): void; - patch( + publish( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Conversations$Assessments$Publish + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Patch; + {}) as Params$Resource$Projects$Locations$Conversations$Assessments$Publish; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Patch; + {} as Params$Resource$Projects$Locations$Conversations$Assessments$Publish; options = {}; } @@ -21941,8 +20507,11 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+name}:publish').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -21953,77 +20522,112 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Create + export interface Params$Resource$Projects$Locations$Conversations$Assessments$Appeal extends StandardParameters { /** - * Required. The parent resource of the note. + * Required. The name of the assessment to appeal. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1AppealAssessmentRequest; + } + export interface Params$Resource$Projects$Locations$Conversations$Assessments$Create + extends StandardParameters { + /** + * Required. The parent resource of the assessment. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1Note; + requestBody?: Schema$GoogleCloudContactcenterinsightsV1Assessment; } - export interface Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Delete + export interface Params$Resource$Projects$Locations$Conversations$Assessments$Delete extends StandardParameters { /** - * Required. The name of the note to delete. + * Optional. If set to true, all of this assessment's notes will also be deleted. Otherwise, the request will only succeed if it has no notes. + */ + force?: boolean; + /** + * Required. The name of the assessment to delete. */ name?: string; } - export interface Params$Resource$Projects$Locations$Conversations$Assessments$Notes$List + export interface Params$Resource$Projects$Locations$Conversations$Assessments$Finalize extends StandardParameters { /** - * Optional. The maximum number of notes to return in the response. If zero the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. + * Required. The name of the assessment to finalize. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1FinalizeAssessmentRequest; + } + export interface Params$Resource$Projects$Locations$Conversations$Assessments$Get + extends StandardParameters { + /** + * Required. The name of the assessment to get. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Conversations$Assessments$List + extends StandardParameters { + /** + * Optional. A filter to reduce results to a specific subset. Supported filters include: * `state` - The state of the assessment * `agent_info.agent_id` - The ID of the agent the assessment is for + */ + filter?: string; + /** + * The maximum number of assessments to list. If zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. */ pageSize?: number; /** - * Optional. The value returned by the last `ListNotesResponse`. This value indicates that this is a continuation of a prior `ListNotes` call and that the system should return the next page of data. + * Optional. The value returned by the last `ListAssessmentRulesResponse`; indicates that this is a continuation of a prior `ListAssessmentRules` call and the system should return the next page of data. */ pageToken?: string; /** - * Required. The parent resource of the notes. + * Required. The parent resource of the assessments. To list all assessments in a location, substitute the conversation ID with a '-' character. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Patch + export interface Params$Resource$Projects$Locations$Conversations$Assessments$Publish extends StandardParameters { /** - * Identifier. The resource name of the note. Format: projects/{project\}/locations/{location\}/conversations/{conversation\}/assessments/{assessment\}/notes/{note\} + * Required. The name of the assessment to publish. */ name?: string; - /** - * Optional. The list of fields to be updated. If the update_mask is empty, all updateable fields will be updated. Acceptable fields include: * `content` - */ - updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1Note; + requestBody?: Schema$GoogleCloudContactcenterinsightsV1PublishAssessmentRequest; } - export class Resource$Projects$Locations$Conversations$Feedbacklabels { + export class Resource$Projects$Locations$Conversations$Assessments$Notes { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Create feedback label. + * Create Note. * @example * ```js * // Before running the sample: @@ -22053,23 +20657,23 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.conversations.feedbackLabels.create( + * await contactcenterinsights.projects.locations.conversations.assessments.notes.create( * { - * // Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server. - * feedbackLabelId: 'placeholder-value', - * // Required. The parent resource of the feedback label. + * // Required. The parent resource of the note. * parent: - * 'projects/my-project/locations/my-location/conversations/my-conversation', + * 'projects/my-project/locations/my-location/conversations/my-conversation/assessments/my-assessment', * * // Request body metadata * requestBody: { * // request body parameters * // { + * // "assessmentNote": {}, + * // "content": "my_content", + * // "conversationTurnNote": {}, * // "createTime": "my_createTime", - * // "label": "my_label", - * // "labeledResource": "my_labeledResource", * // "name": "my_name", - * // "qaAnswerLabel": {}, + * // "noteCreator": {}, + * // "qaQuestionNote": {}, * // "updateTime": "my_updateTime" * // } * }, @@ -22079,11 +20683,13 @@ export namespace contactcenterinsights_v1 { * * // Example response * // { + * // "assessmentNote": {}, + * // "content": "my_content", + * // "conversationTurnNote": {}, * // "createTime": "my_createTime", - * // "label": "my_label", - * // "labeledResource": "my_labeledResource", * // "name": "my_name", - * // "qaAnswerLabel": {}, + * // "noteCreator": {}, + * // "qaQuestionNote": {}, * // "updateTime": "my_updateTime" * // } * } @@ -22101,61 +20707,61 @@ export namespace contactcenterinsights_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create, + params: Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Create, options: StreamMethodOptions ): Promise>; create( - params?: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create, + params?: Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Create, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; create( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create, + params: Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create, + params: Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create; + {}) as Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create; + {} as Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Create; options = {}; } @@ -22169,7 +20775,7 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/feedbackLabels').replace( + url: (rootUrl + '/v1/{+parent}/notes').replace( /([^:]\/)\/+/g, '$1' ), @@ -22184,19 +20790,19 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Delete feedback label. + * Deletes a Note. * @example * ```js * // Before running the sample: @@ -22226,10 +20832,10 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.conversations.feedbackLabels.delete( + * await contactcenterinsights.projects.locations.conversations.assessments.notes.delete( * { - * // Required. The name of the feedback label to delete. - * name: 'projects/my-project/locations/my-location/conversations/my-conversation/feedbackLabels/my-feedbackLabel', + * // Required. The name of the note to delete. + * name: 'projects/my-project/locations/my-location/conversations/my-conversation/assessments/my-assessment/notes/my-note', * }, * ); * console.log(res.data); @@ -22251,31 +20857,31 @@ export namespace contactcenterinsights_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete, + params: Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete, + params?: Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete, + params: Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete, + params: Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete, + params: Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete + | Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -22291,13 +20897,13 @@ export namespace contactcenterinsights_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete; + {}) as Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete; + {} as Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Delete; options = {}; } @@ -22333,7 +20939,7 @@ export namespace contactcenterinsights_v1 { } /** - * Get feedback label. + * List Notes. * @example * ```js * // Before running the sample: @@ -22363,22 +20969,23 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.conversations.feedbackLabels.get( + * await contactcenterinsights.projects.locations.conversations.assessments.notes.list( * { - * // Required. The name of the feedback label to get. - * name: 'projects/my-project/locations/my-location/conversations/my-conversation/feedbackLabels/my-feedbackLabel', + * // Optional. The maximum number of notes to return in the response. If zero the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. + * pageSize: 'placeholder-value', + * // Optional. The value returned by the last `ListNotesResponse`. This value indicates that this is a continuation of a prior `ListNotes` call and that the system should return the next page of data. + * pageToken: 'placeholder-value', + * // Required. The parent resource of the notes. + * parent: + * 'projects/my-project/locations/my-location/conversations/my-conversation/assessments/my-assessment', * }, * ); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "label": "my_label", - * // "labeledResource": "my_labeledResource", - * // "name": "my_name", - * // "qaAnswerLabel": {}, - * // "updateTime": "my_updateTime" + * // "nextPageToken": "my_nextPageToken", + * // "notes": [] * // } * } * @@ -22394,62 +21001,62 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get, + list( + params: Params$Resource$Projects$Locations$Conversations$Assessments$Notes$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get, + list( + params?: Params$Resource$Projects$Locations$Conversations$Assessments$Notes$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get, + list( + params: Params$Resource$Projects$Locations$Conversations$Assessments$Notes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get, + list( + params: Params$Resource$Projects$Locations$Conversations$Assessments$Notes$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Conversations$Assessments$Notes$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Conversations$Assessments$Notes$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get; + {}) as Params$Resource$Projects$Locations$Conversations$Assessments$Notes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get; + {} as Params$Resource$Projects$Locations$Conversations$Assessments$Notes$List; options = {}; } @@ -22463,31 +21070,34 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/notes').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * List feedback labels. + * Update Note. * @example * ```js * // Before running the sample: @@ -22517,25 +21127,41 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.conversations.feedbackLabels.list( + * await contactcenterinsights.projects.locations.conversations.assessments.notes.patch( * { - * // Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING - * filter: 'placeholder-value', - * // Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. - * pageSize: 'placeholder-value', - * // Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListFeedbackLabels` call and that the system should return the next page of data. - * pageToken: 'placeholder-value', - * // Required. The parent resource of the feedback labels. - * parent: - * 'projects/my-project/locations/my-location/conversations/my-conversation', + * // Identifier. The resource name of the note. Format: projects/{project\}/locations/{location\}/conversations/{conversation\}/assessments/{assessment\}/notes/{note\} + * name: 'projects/my-project/locations/my-location/conversations/my-conversation/assessments/my-assessment/notes/my-note', + * // Optional. The list of fields to be updated. If the update_mask is empty, all updateable fields will be updated. Acceptable fields include: * `content` + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "assessmentNote": {}, + * // "content": "my_content", + * // "conversationTurnNote": {}, + * // "createTime": "my_createTime", + * // "name": "my_name", + * // "noteCreator": {}, + * // "qaQuestionNote": {}, + * // "updateTime": "my_updateTime" + * // } + * }, * }, * ); * console.log(res.data); * * // Example response * // { - * // "feedbackLabels": [], - * // "nextPageToken": "my_nextPageToken" + * // "assessmentNote": {}, + * // "content": "my_content", + * // "conversationTurnNote": {}, + * // "createTime": "my_createTime", + * // "name": "my_name", + * // "noteCreator": {}, + * // "qaQuestionNote": {}, + * // "updateTime": "my_updateTime" * // } * } * @@ -22551,62 +21177,62 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List, + patch( + params: Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Patch, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List, + patch( + params?: Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Patch, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List, + patch( + params: Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List, + patch( + params: Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Patch, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - list( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List; + {}) as Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List; + {} as Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Patch; options = {}; } @@ -22620,34 +21246,89 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/feedbackLabels').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + + export interface Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Create + extends StandardParameters { + /** + * Required. The parent resource of the note. + */ + parent?: string; /** - * Update feedback label. + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1Note; + } + export interface Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Delete + extends StandardParameters { + /** + * Required. The name of the note to delete. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Conversations$Assessments$Notes$List + extends StandardParameters { + /** + * Optional. The maximum number of notes to return in the response. If zero the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. + */ + pageSize?: number; + /** + * Optional. The value returned by the last `ListNotesResponse`. This value indicates that this is a continuation of a prior `ListNotes` call and that the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. The parent resource of the notes. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Conversations$Assessments$Notes$Patch + extends StandardParameters { + /** + * Identifier. The resource name of the note. Format: projects/{project\}/locations/{location\}/conversations/{conversation\}/assessments/{assessment\}/notes/{note\} + */ + name?: string; + /** + * Optional. The list of fields to be updated. If the update_mask is empty, all updateable fields will be updated. Acceptable fields include: * `content` + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1Note; + } + + export class Resource$Projects$Locations$Conversations$Feedbacklabels { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Create feedback label. * @example * ```js * // Before running the sample: @@ -22677,12 +21358,13 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.conversations.feedbackLabels.patch( + * await contactcenterinsights.projects.locations.conversations.feedbackLabels.create( * { - * // Immutable. Resource name of the FeedbackLabel. Format: projects/{project\}/locations/{location\}/conversations/{conversation\}/feedbackLabels/{feedback_label\} - * name: 'projects/my-project/locations/my-location/conversations/my-conversation/feedbackLabels/my-feedbackLabel', - * // Required. The list of fields to be updated. - * updateMask: 'placeholder-value', + * // Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server. + * feedbackLabelId: 'placeholder-value', + * // Required. The parent resource of the feedback label. + * parent: + * 'projects/my-project/locations/my-location/conversations/my-conversation', * * // Request body metadata * requestBody: { @@ -22723,38 +21405,38 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch, + create( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch, + create( + params?: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; - patch( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch, + create( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch, + create( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch, + create( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create, callback: BodyResponseCallback ): void; - patch( + create( callback: BodyResponseCallback ): void; - patch( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch + | Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -22772,13 +21454,13 @@ export namespace contactcenterinsights_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch; + {}) as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch; + {} as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create; options = {}; } @@ -22792,15 +21474,18 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+parent}/feedbackLabels').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -22814,89 +21499,9 @@ export namespace contactcenterinsights_v1 { ); } } - } - - export interface Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create - extends StandardParameters { - /** - * Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server. - */ - feedbackLabelId?: string; - /** - * Required. The parent resource of the feedback label. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1FeedbackLabel; - } - export interface Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete - extends StandardParameters { - /** - * Required. The name of the feedback label to delete. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get - extends StandardParameters { - /** - * Required. The name of the feedback label to get. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List - extends StandardParameters { - /** - * Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING - */ - filter?: string; - /** - * Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. - */ - pageSize?: number; - /** - * Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListFeedbackLabels` call and that the system should return the next page of data. - */ - pageToken?: string; - /** - * Required. The parent resource of the feedback labels. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch - extends StandardParameters { - /** - * Immutable. Resource name of the FeedbackLabel. Format: projects/{project\}/locations/{location\}/conversations/{conversation\}/feedbackLabels/{feedback_label\} - */ - name?: string; - /** - * Required. The list of fields to be updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1FeedbackLabel; - } - - export class Resource$Projects$Locations$Datasets { - context: APIRequestContext; - conversations: Resource$Projects$Locations$Datasets$Conversations; - insightsdata: Resource$Projects$Locations$Datasets$Insightsdata; - constructor(context: APIRequestContext) { - this.context = context; - this.conversations = - new Resource$Projects$Locations$Datasets$Conversations(this.context); - this.insightsdata = new Resource$Projects$Locations$Datasets$Insightsdata( - this.context - ); - } /** - * Delete feedback labels in bulk using a filter. + * Delete feedback label. * @example * ```js * // Before running the sample: @@ -22926,31 +21531,16 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.datasets.bulkDeleteFeedbackLabels( + * await contactcenterinsights.projects.locations.conversations.feedbackLabels.delete( * { - * // Required. The parent resource for new feedback labels. - * parent: 'projects/my-project/locations/my-location/datasets/my-dataset', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "filter": "my_filter", - * // "parent": "my_parent" - * // } - * }, + * // Required. The name of the feedback label to delete. + * name: 'projects/my-project/locations/my-location/conversations/my-conversation/feedbackLabels/my-feedbackLabel', * }, * ); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -22965,58 +21555,54 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - bulkDeleteFeedbackLabels( - params: Params$Resource$Projects$Locations$Datasets$Bulkdeletefeedbacklabels, + delete( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete, options: StreamMethodOptions ): Promise>; - bulkDeleteFeedbackLabels( - params?: Params$Resource$Projects$Locations$Datasets$Bulkdeletefeedbacklabels, + delete( + params?: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete, options?: MethodOptions - ): Promise>; - bulkDeleteFeedbackLabels( - params: Params$Resource$Projects$Locations$Datasets$Bulkdeletefeedbacklabels, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - bulkDeleteFeedbackLabels( - params: Params$Resource$Projects$Locations$Datasets$Bulkdeletefeedbacklabels, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - bulkDeleteFeedbackLabels( - params: Params$Resource$Projects$Locations$Datasets$Bulkdeletefeedbacklabels, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - bulkDeleteFeedbackLabels( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete, + callback: BodyResponseCallback ): void; - bulkDeleteFeedbackLabels( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Bulkdeletefeedbacklabels - | BodyResponseCallback + | Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Bulkdeletefeedbacklabels; + {}) as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Bulkdeletefeedbacklabels; + {} as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete; options = {}; } @@ -23030,32 +21616,29 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}:bulkDeleteFeedbackLabels').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Download feedback labels in bulk from an external source. Currently supports exporting Quality AI example conversations with transcripts and question bodies. + * Get feedback label. * @example * ```js * // Before running the sample: @@ -23085,36 +21668,22 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.datasets.bulkDownloadFeedbackLabels( + * await contactcenterinsights.projects.locations.conversations.feedbackLabels.get( * { - * // Required. The parent resource for new feedback labels. - * parent: 'projects/my-project/locations/my-location/datasets/my-dataset', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "conversationFilter": "my_conversationFilter", - * // "feedbackLabelType": "my_feedbackLabelType", - * // "filter": "my_filter", - * // "gcsDestination": {}, - * // "maxDownloadCount": 0, - * // "parent": "my_parent", - * // "sheetsDestination": {}, - * // "templateQaScorecardId": [] - * // } - * }, + * // Required. The name of the feedback label to get. + * name: 'projects/my-project/locations/my-location/conversations/my-conversation/feedbackLabels/my-feedbackLabel', * }, * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "createTime": "my_createTime", + * // "label": "my_label", + * // "labeledResource": "my_labeledResource", * // "name": "my_name", - * // "response": {} + * // "qaAnswerLabel": {}, + * // "updateTime": "my_updateTime" * // } * } * @@ -23130,58 +21699,62 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - bulkDownloadFeedbackLabels( - params: Params$Resource$Projects$Locations$Datasets$Bulkdownloadfeedbacklabels, + get( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get, options: StreamMethodOptions ): Promise>; - bulkDownloadFeedbackLabels( - params?: Params$Resource$Projects$Locations$Datasets$Bulkdownloadfeedbacklabels, + get( + params?: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get, options?: MethodOptions - ): Promise>; - bulkDownloadFeedbackLabels( - params: Params$Resource$Projects$Locations$Datasets$Bulkdownloadfeedbacklabels, + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - bulkDownloadFeedbackLabels( - params: Params$Resource$Projects$Locations$Datasets$Bulkdownloadfeedbacklabels, + get( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - bulkDownloadFeedbackLabels( - params: Params$Resource$Projects$Locations$Datasets$Bulkdownloadfeedbacklabels, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get, + callback: BodyResponseCallback ): void; - bulkDownloadFeedbackLabels( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - bulkDownloadFeedbackLabels( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Bulkdownloadfeedbacklabels - | BodyResponseCallback + | Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Bulkdownloadfeedbacklabels; + {}) as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Bulkdownloadfeedbacklabels; + {} as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get; options = {}; } @@ -23195,32 +21768,31 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}:bulkDownloadFeedbackLabels').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Upload feedback labels from an external source in bulk. Currently supports labeling Quality AI example conversations. + * List feedback labels. * @example * ```js * // Before running the sample: @@ -23250,31 +21822,25 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.datasets.bulkUploadFeedbackLabels( + * await contactcenterinsights.projects.locations.conversations.feedbackLabels.list( * { - * // Required. The parent resource for new feedback labels. - * parent: 'projects/my-project/locations/my-location/datasets/my-dataset', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "gcsSource": {}, - * // "sheetsSource": {}, - * // "validateOnly": false - * // } - * }, + * // Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING + * filter: 'placeholder-value', + * // Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. + * pageSize: 'placeholder-value', + * // Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListFeedbackLabels` call and that the system should return the next page of data. + * pageToken: 'placeholder-value', + * // Required. The parent resource of the feedback labels. + * parent: + * 'projects/my-project/locations/my-location/conversations/my-conversation', * }, * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "feedbackLabels": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -23290,58 +21856,62 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - bulkUploadFeedbackLabels( - params: Params$Resource$Projects$Locations$Datasets$Bulkuploadfeedbacklabels, + list( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List, options: StreamMethodOptions ): Promise>; - bulkUploadFeedbackLabels( - params?: Params$Resource$Projects$Locations$Datasets$Bulkuploadfeedbacklabels, + list( + params?: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List, options?: MethodOptions - ): Promise>; - bulkUploadFeedbackLabels( - params: Params$Resource$Projects$Locations$Datasets$Bulkuploadfeedbacklabels, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - bulkUploadFeedbackLabels( - params: Params$Resource$Projects$Locations$Datasets$Bulkuploadfeedbacklabels, + list( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - bulkUploadFeedbackLabels( - params: Params$Resource$Projects$Locations$Datasets$Bulkuploadfeedbacklabels, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List, + callback: BodyResponseCallback ): void; - bulkUploadFeedbackLabels( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - bulkUploadFeedbackLabels( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Bulkuploadfeedbacklabels - | BodyResponseCallback + | Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Bulkuploadfeedbacklabels; + {}) as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Bulkuploadfeedbacklabels; + {} as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List; options = {}; } @@ -23355,11 +21925,11 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}:bulkUploadFeedbackLabels').replace( + url: (rootUrl + '/v1/{+parent}/feedbackLabels').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -23370,17 +21940,19 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Creates a dataset. + * Update feedback label. * @example * ```js * // Before running the sample: @@ -23401,44 +21973,45 @@ export namespace contactcenterinsights_v1 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await contactcenterinsights.projects.locations.datasets.create({ - * // Optional. The ID to use for the dataset. - * datasetId: 'placeholder-value', - * // Required. The parent resource of the dataset. - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "name": "my_name", - * // "ttl": "my_ttl", - * // "type": "my_type", - * // "updateTime": "my_updateTime" - * // } - * }, + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await contactcenterinsights.projects.locations.conversations.feedbackLabels.patch( + * { + * // Immutable. Resource name of the FeedbackLabel. Format: projects/{project\}/locations/{location\}/conversations/{conversation\}/feedbackLabels/{feedback_label\} + * name: 'projects/my-project/locations/my-location/conversations/my-conversation/feedbackLabels/my-feedbackLabel', + * // Required. The list of fields to be updated. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "label": "my_label", + * // "labeledResource": "my_labeledResource", + * // "name": "my_name", + * // "qaAnswerLabel": {}, + * // "updateTime": "my_updateTime" + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", + * // "label": "my_label", + * // "labeledResource": "my_labeledResource", * // "name": "my_name", - * // "ttl": "my_ttl", - * // "type": "my_type", + * // "qaAnswerLabel": {}, * // "updateTime": "my_updateTime" * // } * } @@ -23455,61 +22028,62 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Datasets$Create, + patch( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Datasets$Create, + patch( + params?: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - create( - params: Params$Resource$Projects$Locations$Datasets$Create, + patch( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datasets$Create, + patch( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datasets$Create, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - create( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Create; + {}) as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Create; + params = + {} as Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch; options = {}; } @@ -23523,34 +22097,104 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/datasets').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Create + extends StandardParameters { /** - * Delete a dataset. + * Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server. + */ + feedbackLabelId?: string; + /** + * Required. The parent resource of the feedback label. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1FeedbackLabel; + } + export interface Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Delete + extends StandardParameters { + /** + * Required. The name of the feedback label to delete. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Get + extends StandardParameters { + /** + * Required. The name of the feedback label to get. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Conversations$Feedbacklabels$List + extends StandardParameters { + /** + * Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING + */ + filter?: string; + /** + * Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. + */ + pageSize?: number; + /** + * Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListFeedbackLabels` call and that the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. The parent resource of the feedback labels. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Conversations$Feedbacklabels$Patch + extends StandardParameters { + /** + * Immutable. Resource name of the FeedbackLabel. Format: projects/{project\}/locations/{location\}/conversations/{conversation\}/feedbackLabels/{feedback_label\} + */ + name?: string; + /** + * Required. The list of fields to be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1FeedbackLabel; + } + + export class Resource$Projects$Locations$Conversations$Segments { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Analyzes multiple conversations in a single request. * @example * ```js * // Before running the sample: @@ -23579,10 +22223,25 @@ export namespace contactcenterinsights_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await contactcenterinsights.projects.locations.datasets.delete({ - * // Required. The name of the dataset to delete. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset', - * }); + * const res = + * await contactcenterinsights.projects.locations.conversations.segments.bulkAnalyze( + * { + * // Required. The parent resource to create analyses in. + * parent: + * 'projects/my-project/locations/my-location/conversations/my-conversation', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "analysisPercentage": {}, + * // "annotatorSelector": {}, + * // "filter": "my_filter", + * // "parent": "my_parent" + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response @@ -23607,36 +22266,36 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Datasets$Delete, + bulkAnalyze( + params: Params$Resource$Projects$Locations$Conversations$Segments$Bulkanalyze, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Datasets$Delete, + bulkAnalyze( + params?: Params$Resource$Projects$Locations$Conversations$Segments$Bulkanalyze, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Datasets$Delete, + bulkAnalyze( + params: Params$Resource$Projects$Locations$Conversations$Segments$Bulkanalyze, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datasets$Delete, + bulkAnalyze( + params: Params$Resource$Projects$Locations$Conversations$Segments$Bulkanalyze, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datasets$Delete, + bulkAnalyze( + params: Params$Resource$Projects$Locations$Conversations$Segments$Bulkanalyze, callback: BodyResponseCallback ): void; - delete( + bulkAnalyze( callback: BodyResponseCallback ): void; - delete( + bulkAnalyze( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Delete + | Params$Resource$Projects$Locations$Conversations$Segments$Bulkanalyze | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -23652,12 +22311,13 @@ export namespace contactcenterinsights_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Delete; + {}) as Params$Resource$Projects$Locations$Conversations$Segments$Bulkanalyze; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Delete; + params = + {} as Params$Resource$Projects$Locations$Conversations$Segments$Bulkanalyze; options = {}; } @@ -23671,15 +22331,18 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/segments:bulkAnalyze').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -23691,9 +22354,36 @@ export namespace contactcenterinsights_v1 { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Conversations$Segments$Bulkanalyze + extends StandardParameters { /** - * Gets a dataset. + * Required. The parent resource to create analyses in. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest; + } + + export class Resource$Projects$Locations$Datasets { + context: APIRequestContext; + conversations: Resource$Projects$Locations$Datasets$Conversations; + insightsdata: Resource$Projects$Locations$Datasets$Insightsdata; + constructor(context: APIRequestContext) { + this.context = context; + this.conversations = + new Resource$Projects$Locations$Datasets$Conversations(this.context); + this.insightsdata = new Resource$Projects$Locations$Datasets$Insightsdata( + this.context + ); + } + + /** + * Delete feedback labels in bulk using a filter. * @example * ```js * // Before running the sample: @@ -23722,21 +22412,31 @@ export namespace contactcenterinsights_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await contactcenterinsights.projects.locations.datasets.get({ - * // Required. The name of the dataset to get. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset', - * }); + * const res = + * await contactcenterinsights.projects.locations.datasets.bulkDeleteFeedbackLabels( + * { + * // Required. The parent resource for new feedback labels. + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "filter": "my_filter", + * // "parent": "my_parent" + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "ttl": "my_ttl", - * // "type": "my_type", - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -23752,61 +22452,58 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datasets$Get, + bulkDeleteFeedbackLabels( + params: Params$Resource$Projects$Locations$Datasets$Bulkdeletefeedbacklabels, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Datasets$Get, + bulkDeleteFeedbackLabels( + params?: Params$Resource$Projects$Locations$Datasets$Bulkdeletefeedbacklabels, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Datasets$Get, + ): Promise>; + bulkDeleteFeedbackLabels( + params: Params$Resource$Projects$Locations$Datasets$Bulkdeletefeedbacklabels, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datasets$Get, + bulkDeleteFeedbackLabels( + params: Params$Resource$Projects$Locations$Datasets$Bulkdeletefeedbacklabels, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datasets$Get, - callback: BodyResponseCallback + bulkDeleteFeedbackLabels( + params: Params$Resource$Projects$Locations$Datasets$Bulkdeletefeedbacklabels, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + bulkDeleteFeedbackLabels( + callback: BodyResponseCallback ): void; - get( + bulkDeleteFeedbackLabels( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Bulkdeletefeedbacklabels + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Get; + {}) as Params$Resource$Projects$Locations$Datasets$Bulkdeletefeedbacklabels; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Get; + params = + {} as Params$Resource$Projects$Locations$Datasets$Bulkdeletefeedbacklabels; options = {}; } @@ -23820,31 +22517,32 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+parent}:bulkDeleteFeedbackLabels').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * List datasets matching the input. + * Download feedback labels in bulk from an external source. Currently supports exporting Quality AI example conversations with transcripts and question bodies. * @example * ```js * // Before running the sample: @@ -23873,22 +22571,37 @@ export namespace contactcenterinsights_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await contactcenterinsights.projects.locations.datasets.list({ - * // Optional. A filter to reduce results to a specific subset. Useful for querying datasets with specific properties. Supported fields include, for Q2 though we only support list by project: - `type` - `description` - `project_number` - * filter: 'placeholder-value', - * // Optional. The maximum number of datasets to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. - * pageSize: 'placeholder-value', - * // Optional. The value returned by the last `ListDatasetsResponse`; indicates that this is a continuation of a prior `ListDatasets` call and the system should return the next page of data. - * pageToken: 'placeholder-value', - * // Required. The parent resource of the dataset. - * parent: 'projects/my-project/locations/my-location', - * }); + * const res = + * await contactcenterinsights.projects.locations.datasets.bulkDownloadFeedbackLabels( + * { + * // Required. The parent resource for new feedback labels. + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "conversationFilter": "my_conversationFilter", + * // "feedbackLabelType": "my_feedbackLabelType", + * // "filter": "my_filter", + * // "gcsDestination": {}, + * // "maxDownloadCount": 0, + * // "parent": "my_parent", + * // "sheetsDestination": {}, + * // "templateQaScorecardId": [] + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "datasets": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -23904,61 +22617,58 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datasets$List, + bulkDownloadFeedbackLabels( + params: Params$Resource$Projects$Locations$Datasets$Bulkdownloadfeedbacklabels, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Datasets$List, + bulkDownloadFeedbackLabels( + params?: Params$Resource$Projects$Locations$Datasets$Bulkdownloadfeedbacklabels, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Datasets$List, + ): Promise>; + bulkDownloadFeedbackLabels( + params: Params$Resource$Projects$Locations$Datasets$Bulkdownloadfeedbacklabels, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$List, + bulkDownloadFeedbackLabels( + params: Params$Resource$Projects$Locations$Datasets$Bulkdownloadfeedbacklabels, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$List, - callback: BodyResponseCallback + bulkDownloadFeedbackLabels( + params: Params$Resource$Projects$Locations$Datasets$Bulkdownloadfeedbacklabels, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + bulkDownloadFeedbackLabels( + callback: BodyResponseCallback ): void; - list( + bulkDownloadFeedbackLabels( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Bulkdownloadfeedbacklabels + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$List; + {}) as Params$Resource$Projects$Locations$Datasets$Bulkdownloadfeedbacklabels; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$List; + params = + {} as Params$Resource$Projects$Locations$Datasets$Bulkdownloadfeedbacklabels; options = {}; } @@ -23972,11 +22682,11 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/datasets').replace( + url: (rootUrl + '/v1/{+parent}:bulkDownloadFeedbackLabels').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -23987,19 +22697,17 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * List all feedback labels by project number. + * Upload feedback labels from an external source in bulk. Currently supports labeling Quality AI example conversations. * @example * ```js * // Before running the sample: @@ -24029,24 +22737,31 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.datasets.listAllFeedbackLabels( + * await contactcenterinsights.projects.locations.datasets.bulkUploadFeedbackLabels( * { - * // Optional. A filter to reduce results to a specific subset in the entire project. Supports disjunctions (OR) and conjunctions (AND). Supported fields: * `issue_model_id` * `qa_question_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING - * filter: 'placeholder-value', - * // Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. - * pageSize: 'placeholder-value', - * // Optional. The value returned by the last `ListAllFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListAllFeedbackLabels` call and that the system should return the next page of data. - * pageToken: 'placeholder-value', - * // Required. The parent resource of all feedback labels per project. + * // Required. The parent resource for new feedback labels. * parent: 'projects/my-project/locations/my-location/datasets/my-dataset', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "gcsSource": {}, + * // "sheetsSource": {}, + * // "validateOnly": false + * // } + * }, * }, * ); * console.log(res.data); * * // Example response * // { - * // "feedbackLabels": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -24062,62 +22777,58 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listAllFeedbackLabels( - params: Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels, + bulkUploadFeedbackLabels( + params: Params$Resource$Projects$Locations$Datasets$Bulkuploadfeedbacklabels, options: StreamMethodOptions ): Promise>; - listAllFeedbackLabels( - params?: Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels, + bulkUploadFeedbackLabels( + params?: Params$Resource$Projects$Locations$Datasets$Bulkuploadfeedbacklabels, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - listAllFeedbackLabels( - params: Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels, + ): Promise>; + bulkUploadFeedbackLabels( + params: Params$Resource$Projects$Locations$Datasets$Bulkuploadfeedbacklabels, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listAllFeedbackLabels( - params: Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels, + bulkUploadFeedbackLabels( + params: Params$Resource$Projects$Locations$Datasets$Bulkuploadfeedbacklabels, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listAllFeedbackLabels( - params: Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels, - callback: BodyResponseCallback + bulkUploadFeedbackLabels( + params: Params$Resource$Projects$Locations$Datasets$Bulkuploadfeedbacklabels, + callback: BodyResponseCallback ): void; - listAllFeedbackLabels( - callback: BodyResponseCallback + bulkUploadFeedbackLabels( + callback: BodyResponseCallback ): void; - listAllFeedbackLabels( + bulkUploadFeedbackLabels( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Bulkuploadfeedbacklabels + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels; + {}) as Params$Resource$Projects$Locations$Datasets$Bulkuploadfeedbacklabels; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels; + {} as Params$Resource$Projects$Locations$Datasets$Bulkuploadfeedbacklabels; options = {}; } @@ -24131,11 +22842,11 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}:listAllFeedbackLabels').replace( + url: (rootUrl + '/v1/{+parent}:bulkUploadFeedbackLabels').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -24146,19 +22857,17 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a dataset. + * Creates a dataset. * @example * ```js * // Before running the sample: @@ -24187,11 +22896,11 @@ export namespace contactcenterinsights_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await contactcenterinsights.projects.locations.datasets.patch({ - * // Immutable. Identifier. Resource name of the dataset. Format: projects/{project\}/locations/{location\}/datasets/{dataset\} - * name: 'projects/my-project/locations/my-location/datasets/my-dataset', - * // Optional. The list of fields to update. - * updateMask: 'placeholder-value', + * const res = await contactcenterinsights.projects.locations.datasets.create({ + * // Optional. The ID to use for the dataset. + * datasetId: 'placeholder-value', + * // Required. The parent resource of the dataset. + * parent: 'projects/my-project/locations/my-location', * * // Request body metadata * requestBody: { @@ -24233,237 +22942,102 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Datasets$Patch, + create( + params: Params$Resource$Projects$Locations$Datasets$Create, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Datasets$Patch, + create( + params?: Params$Resource$Projects$Locations$Datasets$Create, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; - patch( - params: Params$Resource$Projects$Locations$Datasets$Patch, + create( + params: Params$Resource$Projects$Locations$Datasets$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datasets$Patch, + create( + params: Params$Resource$Projects$Locations$Datasets$Create, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Datasets$Patch, - callback: BodyResponseCallback - ): void; - patch( - callback: BodyResponseCallback - ): void; - patch( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Patch - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Datasets$Bulkdeletefeedbacklabels - extends StandardParameters { - /** - * Required. The parent resource for new feedback labels. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest; - } - export interface Params$Resource$Projects$Locations$Datasets$Bulkdownloadfeedbacklabels - extends StandardParameters { - /** - * Required. The parent resource for new feedback labels. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest; - } - export interface Params$Resource$Projects$Locations$Datasets$Bulkuploadfeedbacklabels - extends StandardParameters { - /** - * Required. The parent resource for new feedback labels. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequest; - } - export interface Params$Resource$Projects$Locations$Datasets$Create - extends StandardParameters { - /** - * Optional. The ID to use for the dataset. - */ - datasetId?: string; - /** - * Required. The parent resource of the dataset. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1Dataset; - } - export interface Params$Resource$Projects$Locations$Datasets$Delete - extends StandardParameters { - /** - * Required. The name of the dataset to delete. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Get - extends StandardParameters { - /** - * Required. The name of the dataset to get. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$List - extends StandardParameters { - /** - * Optional. A filter to reduce results to a specific subset. Useful for querying datasets with specific properties. Supported fields include, for Q2 though we only support list by project: - `type` - `description` - `project_number` - */ - filter?: string; - /** - * Optional. The maximum number of datasets to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. - */ - pageSize?: number; - /** - * Optional. The value returned by the last `ListDatasetsResponse`; indicates that this is a continuation of a prior `ListDatasets` call and the system should return the next page of data. - */ - pageToken?: string; - /** - * Required. The parent resource of the dataset. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels - extends StandardParameters { - /** - * Optional. A filter to reduce results to a specific subset in the entire project. Supports disjunctions (OR) and conjunctions (AND). Supported fields: * `issue_model_id` * `qa_question_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING - */ - filter?: string; - /** - * Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. - */ - pageSize?: number; - /** - * Optional. The value returned by the last `ListAllFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListAllFeedbackLabels` call and that the system should return the next page of data. - */ - pageToken?: string; - /** - * Required. The parent resource of all feedback labels per project. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Patch - extends StandardParameters { - /** - * Immutable. Identifier. Resource name of the dataset. Format: projects/{project\}/locations/{location\}/datasets/{dataset\} - */ - name?: string; - /** - * Optional. The list of fields to update. - */ - updateMask?: string; + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Datasets$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Create; + let options = (optionsOrCallback || {}) as MethodOptions; - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1Dataset; - } + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Datasets$Create; + options = {}; + } - export class Resource$Projects$Locations$Datasets$Conversations { - context: APIRequestContext; - analyses: Resource$Projects$Locations$Datasets$Conversations$Analyses; - feedbackLabels: Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels; - constructor(context: APIRequestContext) { - this.context = context; - this.analyses = - new Resource$Projects$Locations$Datasets$Conversations$Analyses( - this.context + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/datasets').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback ); - this.feedbackLabels = - new Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels( - this.context + } else { + return createAPIRequest( + parameters ); + } } /** - * Analyzes multiple conversations in a single request. + * Delete a dataset. * @example * ```js * // Before running the sample: @@ -24492,24 +23066,10 @@ export namespace contactcenterinsights_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await contactcenterinsights.projects.locations.datasets.conversations.bulkAnalyze( - * { - * // Required. The parent resource to create analyses in. - * parent: 'projects/my-project/locations/my-location/datasets/my-dataset', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "analysisPercentage": {}, - * // "annotatorSelector": {}, - * // "filter": "my_filter", - * // "parent": "my_parent" - * // } - * }, - * }, - * ); + * const res = await contactcenterinsights.projects.locations.datasets.delete({ + * // Required. The name of the dataset to delete. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset', + * }); * console.log(res.data); * * // Example response @@ -24534,36 +23094,36 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - bulkAnalyze( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Bulkanalyze, + delete( + params: Params$Resource$Projects$Locations$Datasets$Delete, options: StreamMethodOptions ): Promise>; - bulkAnalyze( - params?: Params$Resource$Projects$Locations$Datasets$Conversations$Bulkanalyze, + delete( + params?: Params$Resource$Projects$Locations$Datasets$Delete, options?: MethodOptions ): Promise>; - bulkAnalyze( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Bulkanalyze, + delete( + params: Params$Resource$Projects$Locations$Datasets$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - bulkAnalyze( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Bulkanalyze, + delete( + params: Params$Resource$Projects$Locations$Datasets$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - bulkAnalyze( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Bulkanalyze, + delete( + params: Params$Resource$Projects$Locations$Datasets$Delete, callback: BodyResponseCallback ): void; - bulkAnalyze( + delete( callback: BodyResponseCallback ): void; - bulkAnalyze( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Conversations$Bulkanalyze + | Params$Resource$Projects$Locations$Datasets$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -24579,13 +23139,12 @@ export namespace contactcenterinsights_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Conversations$Bulkanalyze; + {}) as Params$Resource$Projects$Locations$Datasets$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Conversations$Bulkanalyze; + params = {} as Params$Resource$Projects$Locations$Datasets$Delete; options = {}; } @@ -24599,18 +23158,15 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/conversations:bulkAnalyze').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -24624,7 +23180,7 @@ export namespace contactcenterinsights_v1 { } /** - * Deletes multiple conversations in a single request. + * Gets a dataset. * @example * ```js * // Before running the sample: @@ -24653,33 +23209,21 @@ export namespace contactcenterinsights_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await contactcenterinsights.projects.locations.datasets.conversations.bulkDelete( - * { - * // Required. The parent resource to delete conversations from. Format: projects/{project\}/locations/{location\} - * parent: 'projects/my-project/locations/my-location/datasets/my-dataset', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "filter": "my_filter", - * // "force": false, - * // "maxDeleteCount": 0, - * // "parent": "my_parent" - * // } - * }, - * }, - * ); + * const res = await contactcenterinsights.projects.locations.datasets.get({ + * // Required. The name of the dataset to get. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", * // "name": "my_name", - * // "response": {} + * // "ttl": "my_ttl", + * // "type": "my_type", + * // "updateTime": "my_updateTime" * // } * } * @@ -24695,58 +23239,61 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - bulkDelete( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Bulkdelete, + get( + params: Params$Resource$Projects$Locations$Datasets$Get, options: StreamMethodOptions ): Promise>; - bulkDelete( - params?: Params$Resource$Projects$Locations$Datasets$Conversations$Bulkdelete, + get( + params?: Params$Resource$Projects$Locations$Datasets$Get, options?: MethodOptions - ): Promise>; - bulkDelete( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Bulkdelete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Datasets$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - bulkDelete( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Bulkdelete, + get( + params: Params$Resource$Projects$Locations$Datasets$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - bulkDelete( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Bulkdelete, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datasets$Get, + callback: BodyResponseCallback ): void; - bulkDelete( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - bulkDelete( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Conversations$Bulkdelete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Conversations$Bulkdelete; + {}) as Params$Resource$Projects$Locations$Datasets$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Conversations$Bulkdelete; + params = {} as Params$Resource$Projects$Locations$Datasets$Get; options = {}; } @@ -24760,32 +23307,31 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/conversations:bulkDelete').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets conversation statistics. + * List datasets matching the input. * @example * ```js * // Before running the sample: @@ -24811,37 +23357,25 @@ export namespace contactcenterinsights_v1 { * * // Acquire an auth client, and bind it to all future calls * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await contactcenterinsights.projects.locations.datasets.conversations.calculateStats( - * { - * // Required. The location of the conversations. - * location: - * 'projects/my-project/locations/my-location/datasets/my-dataset', + * google.options({auth: authClient}); * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "filter": "my_filter" - * // } - * }, - * }, - * ); + * // Do the magic + * const res = await contactcenterinsights.projects.locations.datasets.list({ + * // Optional. A filter to reduce results to a specific subset. Useful for querying datasets with specific properties. Supported fields include, for Q2 though we only support list by project: - `type` - `description` - `project_number` + * filter: 'placeholder-value', + * // Optional. The maximum number of datasets to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. + * pageSize: 'placeholder-value', + * // Optional. The value returned by the last `ListDatasetsResponse`; indicates that this is a continuation of a prior `ListDatasets` call and the system should return the next page of data. + * pageToken: 'placeholder-value', + * // Required. The parent resource of the dataset. + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { - * // "averageDuration": "my_averageDuration", - * // "averageTurnCount": 0, - * // "conversationCount": 0, - * // "conversationCountTimeSeries": {}, - * // "customHighlighterMatches": {}, - * // "issueMatches": {}, - * // "issueMatchesStats": {}, - * // "smartHighlighterMatches": {} + * // "datasets": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -24857,62 +23391,61 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - calculateStats( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Calculatestats, + list( + params: Params$Resource$Projects$Locations$Datasets$List, options: StreamMethodOptions ): Promise>; - calculateStats( - params?: Params$Resource$Projects$Locations$Datasets$Conversations$Calculatestats, + list( + params?: Params$Resource$Projects$Locations$Datasets$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - calculateStats( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Calculatestats, + list( + params: Params$Resource$Projects$Locations$Datasets$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - calculateStats( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Calculatestats, + list( + params: Params$Resource$Projects$Locations$Datasets$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - calculateStats( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Calculatestats, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datasets$List, + callback: BodyResponseCallback ): void; - calculateStats( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - calculateStats( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Conversations$Calculatestats - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Conversations$Calculatestats; + {}) as Params$Resource$Projects$Locations$Datasets$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Conversations$Calculatestats; + params = {} as Params$Resource$Projects$Locations$Datasets$List; options = {}; } @@ -24926,33 +23459,34 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+location}/conversations:calculateStats' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+parent}/datasets').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['location'], - pathParams: ['location'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a conversation. + * List all feedback labels by project number. * @example * ```js * // Before running the sample: @@ -24982,18 +23516,25 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.datasets.conversations.delete( + * await contactcenterinsights.projects.locations.datasets.listAllFeedbackLabels( * { - * // If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses. - * force: 'placeholder-value', - * // Required. The name of the conversation to delete. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/conversations/my-conversation', + * // Optional. A filter to reduce results to a specific subset in the entire project. Supports disjunctions (OR) and conjunctions (AND). Supported fields: * `issue_model_id` * `qa_question_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING + * filter: 'placeholder-value', + * // Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. + * pageSize: 'placeholder-value', + * // Optional. The value returned by the last `ListAllFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListAllFeedbackLabels` call and that the system should return the next page of data. + * pageToken: 'placeholder-value', + * // Required. The parent resource of all feedback labels per project. + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset', * }, * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "feedbackLabels": [], + * // "nextPageToken": "my_nextPageToken" + * // } * } * * main().catch(e => { @@ -25008,54 +23549,62 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Delete, + listAllFeedbackLabels( + params: Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Datasets$Conversations$Delete, + listAllFeedbackLabels( + params?: Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + listAllFeedbackLabels( + params: Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + listAllFeedbackLabels( + params: Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Delete, - callback: BodyResponseCallback + listAllFeedbackLabels( + params: Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + listAllFeedbackLabels( + callback: BodyResponseCallback + ): void; + listAllFeedbackLabels( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Conversations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Conversations$Delete; + {}) as Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Conversations$Delete; + {} as Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels; options = {}; } @@ -25069,29 +23618,34 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}:listAllFeedbackLabels').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a conversation. + * Updates a dataset. * @example * ```js * // Before running the sample: @@ -25120,38 +23674,36 @@ export namespace contactcenterinsights_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await contactcenterinsights.projects.locations.datasets.conversations.get({ - * // Required. The name of the conversation to get. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/conversations/my-conversation', - * // The level of details of the conversation. Default is `FULL`. - * view: 'placeholder-value', - * }); + * const res = await contactcenterinsights.projects.locations.datasets.patch({ + * // Immutable. Identifier. Resource name of the dataset. Format: projects/{project\}/locations/{location\}/datasets/{dataset\} + * name: 'projects/my-project/locations/my-location/datasets/my-dataset', + * // Optional. The list of fields to update. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "name": "my_name", + * // "ttl": "my_ttl", + * // "type": "my_type", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "agentId": "my_agentId", - * // "callMetadata": {}, * // "createTime": "my_createTime", - * // "dataSource": {}, - * // "dialogflowIntents": {}, - * // "duration": "my_duration", - * // "expireTime": "my_expireTime", - * // "labels": {}, - * // "languageCode": "my_languageCode", - * // "latestAnalysis": {}, - * // "latestSummary": {}, - * // "medium": "my_medium", - * // "metadataJson": "my_metadataJson", + * // "description": "my_description", + * // "displayName": "my_displayName", * // "name": "my_name", - * // "obfuscatedUserId": "my_obfuscatedUserId", - * // "qualityMetadata": {}, - * // "runtimeAnnotations": [], - * // "startTime": "my_startTime", - * // "transcript": {}, * // "ttl": "my_ttl", - * // "turnCount": 0, + * // "type": "my_type", * // "updateTime": "my_updateTime" * // } * } @@ -25168,62 +23720,61 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Get, + patch( + params: Params$Resource$Projects$Locations$Datasets$Patch, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Datasets$Conversations$Get, + patch( + params?: Params$Resource$Projects$Locations$Datasets$Patch, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Get, + patch( + params: Params$Resource$Projects$Locations$Datasets$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Get, + ): void; + patch( + params: Params$Resource$Projects$Locations$Datasets$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datasets$Patch, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - get( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Conversations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Conversations$Get; + {}) as Params$Resource$Projects$Locations$Datasets$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Conversations$Get; + params = {} as Params$Resource$Projects$Locations$Datasets$Patch; options = {}; } @@ -25238,7 +23789,7 @@ export namespace contactcenterinsights_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -25249,19 +23800,152 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Datasets$Bulkdeletefeedbacklabels + extends StandardParameters { /** - * Imports conversations and processes them according to the user's configuration. + * Required. The parent resource for new feedback labels. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1BulkDeleteFeedbackLabelsRequest; + } + export interface Params$Resource$Projects$Locations$Datasets$Bulkdownloadfeedbacklabels + extends StandardParameters { + /** + * Required. The parent resource for new feedback labels. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1BulkDownloadFeedbackLabelsRequest; + } + export interface Params$Resource$Projects$Locations$Datasets$Bulkuploadfeedbacklabels + extends StandardParameters { + /** + * Required. The parent resource for new feedback labels. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1BulkUploadFeedbackLabelsRequest; + } + export interface Params$Resource$Projects$Locations$Datasets$Create + extends StandardParameters { + /** + * Optional. The ID to use for the dataset. + */ + datasetId?: string; + /** + * Required. The parent resource of the dataset. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1Dataset; + } + export interface Params$Resource$Projects$Locations$Datasets$Delete + extends StandardParameters { + /** + * Required. The name of the dataset to delete. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Get + extends StandardParameters { + /** + * Required. The name of the dataset to get. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$List + extends StandardParameters { + /** + * Optional. A filter to reduce results to a specific subset. Useful for querying datasets with specific properties. Supported fields include, for Q2 though we only support list by project: - `type` - `description` - `project_number` + */ + filter?: string; + /** + * Optional. The maximum number of datasets to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. + */ + pageSize?: number; + /** + * Optional. The value returned by the last `ListDatasetsResponse`; indicates that this is a continuation of a prior `ListDatasets` call and the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. The parent resource of the dataset. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Listallfeedbacklabels + extends StandardParameters { + /** + * Optional. A filter to reduce results to a specific subset in the entire project. Supports disjunctions (OR) and conjunctions (AND). Supported fields: * `issue_model_id` * `qa_question_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING + */ + filter?: string; + /** + * Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. + */ + pageSize?: number; + /** + * Optional. The value returned by the last `ListAllFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListAllFeedbackLabels` call and that the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. The parent resource of all feedback labels per project. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Patch + extends StandardParameters { + /** + * Immutable. Identifier. Resource name of the dataset. Format: projects/{project\}/locations/{location\}/datasets/{dataset\} + */ + name?: string; + /** + * Optional. The list of fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1Dataset; + } + + export class Resource$Projects$Locations$Datasets$Conversations { + context: APIRequestContext; + feedbackLabels: Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels; + constructor(context: APIRequestContext) { + this.context = context; + this.feedbackLabels = + new Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels( + this.context + ); + } + + /** + * Deletes multiple conversations in a single request. * @example * ```js * // Before running the sample: @@ -25291,22 +23975,19 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.datasets.conversations.ingest( + * await contactcenterinsights.projects.locations.datasets.conversations.bulkDelete( * { - * // Required. The parent resource for new conversations. + * // Required. The parent resource to delete conversations from. Format: projects/{project\}/locations/{location\} * parent: 'projects/my-project/locations/my-location/datasets/my-dataset', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "conversationConfig": {}, - * // "gcsSource": {}, - * // "parent": "my_parent", - * // "redactionConfig": {}, - * // "sampleSize": 0, - * // "speechConfig": {}, - * // "transcriptObjectConfig": {} + * // "filter": "my_filter", + * // "force": false, + * // "maxDeleteCount": 0, + * // "parent": "my_parent" * // } * }, * }, @@ -25335,36 +24016,36 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - ingest( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Ingest, + bulkDelete( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Bulkdelete, options: StreamMethodOptions ): Promise>; - ingest( - params?: Params$Resource$Projects$Locations$Datasets$Conversations$Ingest, + bulkDelete( + params?: Params$Resource$Projects$Locations$Datasets$Conversations$Bulkdelete, options?: MethodOptions ): Promise>; - ingest( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Ingest, + bulkDelete( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Bulkdelete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - ingest( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Ingest, + bulkDelete( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Bulkdelete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - ingest( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Ingest, + bulkDelete( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Bulkdelete, callback: BodyResponseCallback ): void; - ingest( + bulkDelete( callback: BodyResponseCallback ): void; - ingest( + bulkDelete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Conversations$Ingest + | Params$Resource$Projects$Locations$Datasets$Conversations$Bulkdelete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -25380,13 +24061,13 @@ export namespace contactcenterinsights_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Conversations$Ingest; + {}) as Params$Resource$Projects$Locations$Datasets$Conversations$Bulkdelete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Conversations$Ingest; + {} as Params$Resource$Projects$Locations$Datasets$Conversations$Bulkdelete; options = {}; } @@ -25400,7 +24081,7 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/conversations:ingest').replace( + url: (rootUrl + '/v1/{+parent}/conversations:bulkDelete').replace( /([^:]\/)\/+/g, '$1' ), @@ -25425,7 +24106,7 @@ export namespace contactcenterinsights_v1 { } /** - * Lists conversations. + * Gets conversation statistics. * @example * ```js * // Before running the sample: @@ -25455,26 +24136,33 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.datasets.conversations.list({ - * // A filter to reduce results to a specific subset. Useful for querying conversations with specific properties. - * filter: 'placeholder-value', - * // Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering). - * orderBy: 'placeholder-value', - * // The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. - * pageSize: 'placeholder-value', - * // The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data. - * pageToken: 'placeholder-value', - * // Required. The parent resource of the conversation. - * parent: 'projects/my-project/locations/my-location/datasets/my-dataset', - * // The level of details of the conversation. Default is `BASIC`. - * view: 'placeholder-value', - * }); + * await contactcenterinsights.projects.locations.datasets.conversations.calculateStats( + * { + * // Required. The location of the conversations. + * location: + * 'projects/my-project/locations/my-location/datasets/my-dataset', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "filter": "my_filter" + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "conversations": [], - * // "nextPageToken": "my_nextPageToken" + * // "averageDuration": "my_averageDuration", + * // "averageTurnCount": 0, + * // "conversationCount": 0, + * // "conversationCountTimeSeries": {}, + * // "customHighlighterMatches": {}, + * // "issueMatches": {}, + * // "issueMatchesStats": {}, + * // "smartHighlighterMatches": {} * // } * } * @@ -25490,62 +24178,62 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datasets$Conversations$List, + calculateStats( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Calculatestats, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Datasets$Conversations$List, + calculateStats( + params?: Params$Resource$Projects$Locations$Datasets$Conversations$Calculatestats, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Datasets$Conversations$List, + calculateStats( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Calculatestats, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Conversations$List, + calculateStats( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Calculatestats, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Conversations$List, - callback: BodyResponseCallback + calculateStats( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Calculatestats, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + calculateStats( + callback: BodyResponseCallback ): void; - list( + calculateStats( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Conversations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Conversations$Calculatestats + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Conversations$List; + {}) as Params$Resource$Projects$Locations$Datasets$Conversations$Calculatestats; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Conversations$List; + {} as Params$Resource$Projects$Locations$Datasets$Conversations$Calculatestats; options = {}; } @@ -25559,34 +24247,33 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/conversations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: ( + rootUrl + '/v1/{+location}/conversations:calculateStats' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['location'], + pathParams: ['location'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Samples conversations based on user configuration and handles the sampled conversations for different use cases. + * Deletes a conversation. * @example * ```js * // Before running the sample: @@ -25616,32 +24303,18 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.datasets.conversations.sample( + * await contactcenterinsights.projects.locations.datasets.conversations.delete( * { - * // Required. The parent resource of the dataset. - * parent: 'projects/my-project/locations/my-location/datasets/my-dataset', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "destinationDataset": {}, - * // "parent": "my_parent", - * // "sampleRule": {} - * // } - * }, + * // If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses. + * force: 'placeholder-value', + * // Required. The name of the conversation to delete. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/conversations/my-conversation', * }, * ); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -25656,214 +24329,90 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - sample( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Sample, + delete( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Delete, options: StreamMethodOptions ): Promise>; - sample( - params?: Params$Resource$Projects$Locations$Datasets$Conversations$Sample, + delete( + params?: Params$Resource$Projects$Locations$Datasets$Conversations$Delete, options?: MethodOptions - ): Promise>; - sample( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Sample, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - sample( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Sample, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - sample( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Sample, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - sample( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Delete, + callback: BodyResponseCallback ): void; - sample( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Conversations$Sample - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Conversations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Conversations$Sample; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Conversations$Sample; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/conversations:sample').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Datasets$Conversations$Bulkanalyze - extends StandardParameters { - /** - * Required. The parent resource to create analyses in. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest; - } - export interface Params$Resource$Projects$Locations$Datasets$Conversations$Bulkdelete - extends StandardParameters { - /** - * Required. The parent resource to delete conversations from. Format: projects/{project\}/locations/{location\} - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest; - } - export interface Params$Resource$Projects$Locations$Datasets$Conversations$Calculatestats - extends StandardParameters { - /** - * Required. The location of the conversations. - */ - location?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1CalculateStatsRequest; - } - export interface Params$Resource$Projects$Locations$Datasets$Conversations$Delete - extends StandardParameters { - /** - * If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses. - */ - force?: boolean; - /** - * Required. The name of the conversation to delete. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Conversations$Get - extends StandardParameters { - /** - * Required. The name of the conversation to get. - */ - name?: string; - /** - * The level of details of the conversation. Default is `FULL`. - */ - view?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Conversations$Ingest - extends StandardParameters { - /** - * Required. The parent resource for new conversations. - */ - parent?: string; + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Conversations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1IngestConversationsRequest; - } - export interface Params$Resource$Projects$Locations$Datasets$Conversations$List - extends StandardParameters { - /** - * A filter to reduce results to a specific subset. Useful for querying conversations with specific properties. - */ - filter?: string; - /** - * Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering). - */ - orderBy?: string; - /** - * The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. - */ - pageSize?: number; - /** - * The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data. - */ - pageToken?: string; - /** - * Required. The parent resource of the conversation. - */ - parent?: string; - /** - * The level of details of the conversation. Default is `BASIC`. - */ - view?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Conversations$Sample - extends StandardParameters { - /** - * Required. The parent resource of the dataset. - */ - parent?: string; + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Conversations$Delete; + options = {}; + } - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1SampleConversationsRequest; - } + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } - export class Resource$Projects$Locations$Datasets$Conversations$Analyses { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } } /** - * Creates an analysis. The long running operation is done when the analysis has completed. + * Gets a conversation. * @example * ```js * // Before running the sample: @@ -25893,34 +24442,38 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.datasets.conversations.analyses.create( - * { - * // Required. The parent resource of the analysis. - * parent: - * 'projects/my-project/locations/my-location/datasets/my-dataset/conversations/my-conversation', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "analysisResult": {}, - * // "annotatorSelector": {}, - * // "createTime": "my_createTime", - * // "name": "my_name", - * // "requestTime": "my_requestTime" - * // } - * }, - * }, - * ); + * await contactcenterinsights.projects.locations.datasets.conversations.get({ + * // Required. The name of the conversation to get. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/conversations/my-conversation', + * // The level of details of the conversation. Default is `FULL`. + * view: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "agentId": "my_agentId", + * // "callMetadata": {}, + * // "createTime": "my_createTime", + * // "dataSource": {}, + * // "dialogflowIntents": {}, + * // "duration": "my_duration", + * // "expireTime": "my_expireTime", + * // "labels": {}, + * // "languageCode": "my_languageCode", + * // "latestAnalysis": {}, + * // "latestSummary": {}, + * // "medium": "my_medium", + * // "metadataJson": "my_metadataJson", * // "name": "my_name", - * // "response": {} + * // "obfuscatedUserId": "my_obfuscatedUserId", + * // "qualityMetadata": {}, + * // "runtimeAnnotations": [], + * // "startTime": "my_startTime", + * // "transcript": {}, + * // "ttl": "my_ttl", + * // "turnCount": 0, + * // "updateTime": "my_updateTime" * // } * } * @@ -25936,58 +24489,62 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Create, + get( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Get, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Create, + get( + params?: Params$Resource$Projects$Locations$Datasets$Conversations$Get, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Create, + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Create, + get( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Get, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - create( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Conversations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Create; + {}) as Params$Resource$Projects$Locations$Datasets$Conversations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Create; + {} as Params$Resource$Projects$Locations$Datasets$Conversations$Get; options = {}; } @@ -26001,32 +24558,31 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/analyses').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes an analysis. + * Imports conversations and processes them according to the user's configuration. * @example * ```js * // Before running the sample: @@ -26056,16 +24612,36 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.datasets.conversations.analyses.delete( + * await contactcenterinsights.projects.locations.datasets.conversations.ingest( * { - * // Required. The name of the analysis to delete. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/conversations/my-conversation/analyses/my-analyse', + * // Required. The parent resource for new conversations. + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "conversationConfig": {}, + * // "gcsSource": {}, + * // "parent": "my_parent", + * // "redactionConfig": {}, + * // "sampleSize": 0, + * // "speechConfig": {}, + * // "transcriptObjectConfig": {} + * // } + * }, * }, * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -26080,54 +24656,58 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Delete, + ingest( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Ingest, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Delete, + ingest( + params?: Params$Resource$Projects$Locations$Datasets$Conversations$Ingest, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Delete, + ): Promise>; + ingest( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Ingest, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ingest( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Ingest, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Delete, - callback: BodyResponseCallback + ingest( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Ingest, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + ingest( + callback: BodyResponseCallback + ): void; + ingest( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Conversations$Ingest + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Delete; + {}) as Params$Resource$Projects$Locations$Datasets$Conversations$Ingest; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Delete; + {} as Params$Resource$Projects$Locations$Datasets$Conversations$Ingest; options = {}; } @@ -26141,29 +24721,32 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/conversations:ingest').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets an analysis. + * Lists conversations. * @example * ```js * // Before running the sample: @@ -26193,21 +24776,26 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.datasets.conversations.analyses.get( - * { - * // Required. The name of the analysis to get. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/conversations/my-conversation/analyses/my-analyse', - * }, - * ); + * await contactcenterinsights.projects.locations.datasets.conversations.list({ + * // A filter to reduce results to a specific subset. Useful for querying conversations with specific properties. + * filter: 'placeholder-value', + * // Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering). + * orderBy: 'placeholder-value', + * // The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. + * pageSize: 'placeholder-value', + * // The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data. + * pageToken: 'placeholder-value', + * // Required. The parent resource of the conversation. + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset', + * // The level of details of the conversation. Default is `BASIC`. + * view: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "analysisResult": {}, - * // "annotatorSelector": {}, - * // "createTime": "my_createTime", - * // "name": "my_name", - * // "requestTime": "my_requestTime" + * // "conversations": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -26223,62 +24811,62 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Get, + list( + params: Params$Resource$Projects$Locations$Datasets$Conversations$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Get, + list( + params?: Params$Resource$Projects$Locations$Datasets$Conversations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Get, + list( + params: Params$Resource$Projects$Locations$Datasets$Conversations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Get, + list( + params: Params$Resource$Projects$Locations$Datasets$Conversations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datasets$Conversations$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Conversations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Get; + {}) as Params$Resource$Projects$Locations$Datasets$Conversations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Get; + {} as Params$Resource$Projects$Locations$Datasets$Conversations$List; options = {}; } @@ -26292,31 +24880,34 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/conversations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists analyses. + * Samples conversations based on user configuration and handles the sampled conversations for different use cases. * @example * ```js * // Before running the sample: @@ -26346,25 +24937,31 @@ export namespace contactcenterinsights_v1 { * * // Do the magic * const res = - * await contactcenterinsights.projects.locations.datasets.conversations.analyses.list( + * await contactcenterinsights.projects.locations.datasets.conversations.sample( * { - * // A filter to reduce results to a specific subset. Useful for querying conversations with specific properties. - * filter: 'placeholder-value', - * // The maximum number of analyses to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. - * pageSize: 'placeholder-value', - * // The value returned by the last `ListAnalysesResponse`; indicates that this is a continuation of a prior `ListAnalyses` call and the system should return the next page of data. - * pageToken: 'placeholder-value', - * // Required. The parent resource of the analyses. - * parent: - * 'projects/my-project/locations/my-location/datasets/my-dataset/conversations/my-conversation', + * // Required. The parent resource of the dataset. + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "destinationDataset": {}, + * // "parent": "my_parent", + * // "sampleRule": {} + * // } + * }, * }, * ); * console.log(res.data); * * // Example response * // { - * // "analyses": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -26380,62 +24977,58 @@ export namespace contactcenterinsights_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$List, + sample( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Sample, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$List, + sample( + params?: Params$Resource$Projects$Locations$Datasets$Conversations$Sample, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$List, + ): Promise>; + sample( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Sample, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$List, + sample( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Sample, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$List, - callback: BodyResponseCallback + sample( + params: Params$Resource$Projects$Locations$Datasets$Conversations$Sample, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + sample( + callback: BodyResponseCallback ): void; - list( + sample( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Conversations$Sample + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$List; + {}) as Params$Resource$Projects$Locations$Datasets$Conversations$Sample; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$List; + {} as Params$Resource$Projects$Locations$Datasets$Conversations$Sample; options = {}; } @@ -26449,11 +25042,11 @@ export namespace contactcenterinsights_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/analyses').replace( + url: (rootUrl + '/v1/{+parent}/conversations:sample').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -26464,62 +25057,112 @@ export namespace contactcenterinsights_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Create + export interface Params$Resource$Projects$Locations$Datasets$Conversations$Bulkdelete extends StandardParameters { /** - * Required. The parent resource of the analysis. + * Required. The parent resource to delete conversations from. Format: projects/{project\}/locations/{location\} */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudContactcenterinsightsV1Analysis; + requestBody?: Schema$GoogleCloudContactcenterinsightsV1BulkDeleteConversationsRequest; + } + export interface Params$Resource$Projects$Locations$Datasets$Conversations$Calculatestats + extends StandardParameters { + /** + * Required. The location of the conversations. + */ + location?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1CalculateStatsRequest; } - export interface Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Delete + export interface Params$Resource$Projects$Locations$Datasets$Conversations$Delete extends StandardParameters { /** - * Required. The name of the analysis to delete. + * If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses. + */ + force?: boolean; + /** + * Required. The name of the conversation to delete. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$Get + export interface Params$Resource$Projects$Locations$Datasets$Conversations$Get extends StandardParameters { /** - * Required. The name of the analysis to get. + * Required. The name of the conversation to get. */ name?: string; + /** + * The level of details of the conversation. Default is `FULL`. + */ + view?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Conversations$Ingest + extends StandardParameters { + /** + * Required. The parent resource for new conversations. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1IngestConversationsRequest; } - export interface Params$Resource$Projects$Locations$Datasets$Conversations$Analyses$List + export interface Params$Resource$Projects$Locations$Datasets$Conversations$List extends StandardParameters { /** * A filter to reduce results to a specific subset. Useful for querying conversations with specific properties. */ filter?: string; /** - * The maximum number of analyses to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. + * Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering). + */ + orderBy?: string; + /** + * The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size. */ pageSize?: number; /** - * The value returned by the last `ListAnalysesResponse`; indicates that this is a continuation of a prior `ListAnalyses` call and the system should return the next page of data. + * The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data. */ pageToken?: string; /** - * Required. The parent resource of the analyses. + * Required. The parent resource of the conversation. */ parent?: string; + /** + * The level of details of the conversation. Default is `BASIC`. + */ + view?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Conversations$Sample + extends StandardParameters { + /** + * Required. The parent resource of the dataset. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1SampleConversationsRequest; } export class Resource$Projects$Locations$Datasets$Conversations$Feedbacklabels { diff --git a/src/apis/container/v1.ts b/src/apis/container/v1.ts index 16935fb89c..db14d777e7 100644 --- a/src/apis/container/v1.ts +++ b/src/apis/container/v1.ts @@ -133,7 +133,7 @@ export namespace container_v1 { */ acceleratorCount?: string | null; /** - * The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/gpus) + * The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) */ acceleratorType?: string | null; /** @@ -254,7 +254,7 @@ export namespace container_v1 { */ httpLoadBalancing?: Schema$HttpLoadBalancing; /** - * Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain\}/kubernetes-engine/docs/concepts/dashboards + * Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards */ kubernetesDashboard?: Schema$KubernetesDashboard; /** @@ -412,7 +412,7 @@ export namespace container_v1 { */ export interface Schema$AutoprovisioningNodePoolDefaults { /** - * The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain\}/compute/docs/disks/customer-managed-encryption + * The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption */ bootDiskKmsKey?: string | null; /** @@ -424,7 +424,7 @@ export namespace container_v1 { */ diskType?: string | null; /** - * The image type to use for NAP created node. Please see https://{$universe.dns_names.final_documentation_domain\}/kubernetes-engine/docs/concepts/node-images for available image types. + * The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. */ imageType?: string | null; /** @@ -436,7 +436,7 @@ export namespace container_v1 { */ management?: Schema$NodeManagement; /** - * Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. + * Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. */ minCpuPlatform?: string | null; /** @@ -589,11 +589,11 @@ export namespace container_v1 { */ operationId?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -727,7 +727,7 @@ export namespace container_v1 { */ currentNodeCount?: number | null; /** - * Output only. Deprecated, use [NodePools.version](https://{$universe.dns_names.final_documentation_domain\}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + * Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. */ currentNodeVersion?: string | null; /** @@ -791,7 +791,7 @@ export namespace container_v1 { */ initialClusterVersion?: string | null; /** - * The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain\}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. + * The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. */ initialNodeCount?: number | null; /** @@ -811,11 +811,11 @@ export namespace container_v1 { */ legacyAbac?: Schema$LegacyAbac; /** - * Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + * Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. */ location?: string | null; /** - * The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain\}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain\}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. + * The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. */ locations?: string[] | null; /** @@ -855,7 +855,7 @@ export namespace container_v1 { */ name?: string | null; /** - * The name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. + * The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. */ network?: string | null; /** @@ -955,7 +955,7 @@ export namespace container_v1 { */ statusMessage?: string | null; /** - * The name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/subnetworks) to which the cluster is connected. + * The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. */ subnetwork?: string | null; /** @@ -975,7 +975,7 @@ export namespace container_v1 { */ workloadIdentityConfig?: Schema$WorkloadIdentityConfig; /** - * Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + * Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. */ zone?: string | null; } @@ -984,7 +984,7 @@ export namespace container_v1 { */ export interface Schema$ClusterAutoscaling { /** - * The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. + * The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. */ autoprovisioningLocations?: string[] | null; /** @@ -1154,7 +1154,7 @@ export namespace container_v1 { */ desiredL4ilbSubsettingConfig?: Schema$ILBSubsettingConfig; /** - * The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed. + * The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed. */ desiredLocations?: string[] | null; /** @@ -1360,11 +1360,11 @@ export namespace container_v1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -1465,7 +1465,7 @@ export namespace container_v1 { */ export interface Schema$CreateClusterRequest { /** - * Required. A [cluster resource](https://{$universe.dns_names.final_documentation_domain\}/container-engine/reference/rest/v1/projects.locations.clusters) + * Required. A [cluster resource](https://cloud.google.com/container-engine/reference/rest/v1/projects.locations.clusters) */ cluster?: Schema$Cluster; /** @@ -1473,11 +1473,11 @@ export namespace container_v1 { */ parent?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. */ zone?: string | null; } @@ -1498,11 +1498,11 @@ export namespace container_v1 { */ parent?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. */ zone?: string | null; } @@ -1657,7 +1657,7 @@ export namespace container_v1 { */ dataCacheCount?: number | null; /** - * Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain\}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain\}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + * Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. */ localSsdCount?: number | null; } @@ -1824,7 +1824,7 @@ export namespace container_v1 { enabled?: boolean | null; } /** - * GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain\}/secret-manager). + * GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). */ export interface Schema$GCPSecretManagerCertificateConfig { /** @@ -2225,6 +2225,10 @@ export namespace container_v1 { * Optional. Amounts for 2M and 1G hugepages */ hugepages?: Schema$HugepagesConfig; + /** + * Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. + */ + nodeKernelModuleLoading?: Schema$NodeKernelModuleLoading; /** * The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes */ @@ -2291,7 +2295,7 @@ export namespace container_v1 { */ export interface Schema$LocalNvmeSsdBlockConfig { /** - * Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain\}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain\}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + * Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. */ localSsdCount?: number | null; } @@ -2339,6 +2343,10 @@ export namespace container_v1 { * Represents the Maintenance exclusion option. */ export interface Schema$MaintenanceExclusionOptions { + /** + * EndTimeBehavior specifies the behavior of the exclusion end time. + */ + endTimeBehavior?: string | null; /** * Scope specifies the upgrade scope which upgrades are blocked by the exclusion. */ @@ -2408,11 +2416,11 @@ export namespace container_v1 { */ clusterCaCertificate?: string | null; /** - * The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain\}/kubernetes-engine/docs/how-to/api-server-authentication + * The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication */ password?: string | null; /** - * The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain\}/kubernetes-engine/docs/how-to/api-server-authentication + * The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication */ username?: string | null; } @@ -2564,7 +2572,7 @@ export namespace container_v1 { */ inTransitEncryptionConfig?: string | null; /** - * Output only. The relative name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network + * Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network */ network?: string | null; /** @@ -2580,7 +2588,7 @@ export namespace container_v1 { */ serviceExternalIpsConfig?: Schema$ServiceExternalIPsConfig; /** - * Output only. The relative name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet + * Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet */ subnetwork?: string | null; } @@ -2634,7 +2642,7 @@ export namespace container_v1 { networkTier?: string | null; } /** - * Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + * Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). */ export interface Schema$NodeAffinity { /** @@ -2655,7 +2663,7 @@ export namespace container_v1 { */ export interface Schema$NodeConfig { /** - * A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain\}/compute/docs/gpus for more information about support for GPUs. + * A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. */ accelerators?: Schema$AcceleratorConfig[]; /** @@ -2667,7 +2675,7 @@ export namespace container_v1 { */ bootDisk?: Schema$BootDisk; /** - * The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain\}/compute/docs/disks/customer-managed-encryption + * The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption */ bootDiskKmsKey?: string | null; /** @@ -2715,7 +2723,7 @@ export namespace container_v1 { */ gvnic?: Schema$VirtualNIC; /** - * The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain\}/kubernetes-engine/docs/concepts/node-images for available image types. + * The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. */ imageType?: string | null; /** @@ -2735,7 +2743,7 @@ export namespace container_v1 { */ localNvmeSsdBlockConfig?: Schema$LocalNvmeSsdBlockConfig; /** - * The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain\}/compute/docs/disks/local-ssd for more information. + * The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. */ localSsdCount?: number | null; /** @@ -2747,7 +2755,7 @@ export namespace container_v1 { */ loggingConfig?: Schema$NodePoolLoggingConfig; /** - * The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. + * The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. */ machineType?: string | null; /** @@ -2759,23 +2767,23 @@ export namespace container_v1 { */ metadata?: {[key: string]: string} | null; /** - * Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/instances/specify-min-cpu-platform) + * Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) */ minCpuPlatform?: string | null; /** - * Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/nodes/sole-tenant-nodes). + * Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). */ nodeGroup?: string | null; /** - * The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain\}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + * The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. */ oauthScopes?: string[] | null; /** - * Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain\}/compute/docs/instances/preemptible for more information about preemptible VM instances. + * Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. */ preemptible?: boolean | null; /** - * The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/instances/reserving-zonal-resources) to this node pool. + * The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. */ reservationAffinity?: Schema$ReservationAffinity; /** @@ -2856,6 +2864,15 @@ export namespace container_v1 { */ nodeKubeletConfig?: Schema$NodeKubeletConfig; } + /** + * Configuration for kernel module loading on nodes. + */ + export interface Schema$NodeKernelModuleLoading { + /** + * Set the node module loading policy for nodes in the node pool. + */ + policy?: string | null; + } /** * Node kubelet configs. */ @@ -3045,15 +3062,15 @@ export namespace container_v1 { */ etag?: string | null; /** - * The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain\}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. + * The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. */ initialNodeCount?: number | null; /** - * Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + * Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. */ instanceGroupUrls?: string[] | null; /** - * The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://{$universe.dns_names.final_documentation_domain\}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. + * The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. */ locations?: string[] | null; /** @@ -3105,7 +3122,7 @@ export namespace container_v1 { */ upgradeSettings?: Schema$UpgradeSettings; /** - * The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain\}/kubernetes-engine/versioning#specifying_node_version). + * The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version). */ version?: string | null; } @@ -3270,7 +3287,7 @@ export namespace container_v1 { */ error?: Schema$Status; /** - * Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + * Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. */ location?: string | null; /** @@ -3310,7 +3327,7 @@ export namespace container_v1 { */ targetLink?: string | null; /** - * Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + * Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. */ zone?: string | null; } @@ -3383,7 +3400,7 @@ export namespace container_v1 { */ policyName?: string | null; /** - * Optional. TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain\}/tpu/docs/types-topologies#tpu_topologies + * Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies */ tpuTopology?: string | null; /** @@ -3608,7 +3625,7 @@ export namespace container_v1 { validVersions?: string[] | null; } /** - * [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. + * [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. */ export interface Schema$ReservationAffinity { /** @@ -3625,7 +3642,7 @@ export namespace container_v1 { values?: string[] | null; } /** - * Collection of [Resource Manager labels](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-labels). + * Collection of [Resource Manager labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels). */ export interface Schema$ResourceLabels { /** @@ -3651,7 +3668,7 @@ export namespace container_v1 { resourceType?: string | null; } /** - * A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain\}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. + * A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. */ export interface Schema$ResourceManagerTags { /** @@ -3693,7 +3710,7 @@ export namespace container_v1 { */ nodePoolId?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** @@ -3701,7 +3718,7 @@ export namespace container_v1 { */ respectPdb?: boolean | null; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -3874,11 +3891,11 @@ export namespace container_v1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -3899,7 +3916,7 @@ export namespace container_v1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** @@ -3907,7 +3924,7 @@ export namespace container_v1 { */ resourceLabels?: {[key: string]: string} | null; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -3928,11 +3945,11 @@ export namespace container_v1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -3945,7 +3962,7 @@ export namespace container_v1 { */ clusterId?: string | null; /** - * Required. The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone. + * Required. The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone. */ locations?: string[] | null; /** @@ -3953,11 +3970,11 @@ export namespace container_v1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -3978,11 +3995,11 @@ export namespace container_v1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -4003,11 +4020,11 @@ export namespace container_v1 { */ name?: string | null; /** - * Required. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). + * Required. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). */ projectId?: string | null; /** - * Required. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. + * Required. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. */ zone?: string | null; } @@ -4028,7 +4045,7 @@ export namespace container_v1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** @@ -4036,7 +4053,7 @@ export namespace container_v1 { */ update?: Schema$MasterAuth; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -4057,11 +4074,11 @@ export namespace container_v1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -4082,11 +4099,11 @@ export namespace container_v1 { */ networkPolicy?: Schema$NetworkPolicy; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -4111,11 +4128,11 @@ export namespace container_v1 { */ nodePoolId?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -4140,11 +4157,11 @@ export namespace container_v1 { */ nodePoolId?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -4169,11 +4186,11 @@ export namespace container_v1 { */ nodePoolId?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -4242,7 +4259,7 @@ export namespace container_v1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** @@ -4250,7 +4267,7 @@ export namespace container_v1 { */ rotateCredentials?: boolean | null; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -4340,7 +4357,7 @@ export namespace container_v1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** @@ -4348,7 +4365,7 @@ export namespace container_v1 { */ update?: Schema$ClusterUpdate; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -4378,11 +4395,11 @@ export namespace container_v1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -4391,7 +4408,7 @@ export namespace container_v1 { */ export interface Schema$UpdateNodePoolRequest { /** - * A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain\}/compute/docs/gpus for more information about support for GPUs. + * A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. */ accelerators?: Schema$AcceleratorConfig[]; /** @@ -4439,7 +4456,7 @@ export namespace container_v1 { */ gvnic?: Schema$VirtualNIC; /** - * Required. The desired image type for the node pool. Please see https://{$universe.dns_names.final_documentation_domain\}/kubernetes-engine/docs/concepts/node-images for available image types. + * Required. The desired image type for the node pool. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. */ imageType?: string | null; /** @@ -4455,7 +4472,7 @@ export namespace container_v1 { */ linuxNodeConfig?: Schema$LinuxNodeConfig; /** - * The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed. + * The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed. Warning: It is recommended to update node pool locations in a standalone API call. Do not combine a location update with changes to other fields (such as `tags`, `labels`, `taints`, etc.) in the same request. Otherwise, the API performs a structural modification where changes to other fields will only apply to newly created nodes and will not be applied to existing nodes in the node pool. To ensure all nodes are updated consistently, use a separate API call for location changes. */ locations?: string[] | null; /** @@ -4463,7 +4480,7 @@ export namespace container_v1 { */ loggingConfig?: Schema$NodePoolLoggingConfig; /** - * Optional. The desired [Google Compute Engine machine type](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/machine-types) for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified machine type. + * Optional. The desired [Google Compute Engine machine type](https://cloud.google.com/compute/docs/machine-types) for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified machine type. */ machineType?: string | null; /** @@ -4487,7 +4504,7 @@ export namespace container_v1 { */ nodeVersion?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** @@ -4527,7 +4544,7 @@ export namespace container_v1 { */ workloadMetadataConfig?: Schema$WorkloadMetadataConfig; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -5076,9 +5093,9 @@ export namespace container_v1 { * const res = await container.projects.locations.getServerConfig({ * // The name (project and location) of the server config to get, specified in the format `projects/x/locations/x`. * name: 'projects/my-project/locations/my-location', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * }); * console.log(res.data); @@ -5197,11 +5214,11 @@ export namespace container_v1 { */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -5534,7 +5551,7 @@ export namespace container_v1 { } /** - * Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using. + * Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using. * @example * ```js * // Before running the sample: @@ -5730,9 +5747,9 @@ export namespace container_v1 { * clusterId: 'placeholder-value', * // The name (project, location, cluster) of the cluster to delete. Specified in the format `projects/x/locations/x/clusters/x`. * name: 'projects/my-project/locations/my-location/clusters/my-cluster', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * }); * console.log(res.data); @@ -6033,9 +6050,9 @@ export namespace container_v1 { * clusterId: 'placeholder-value', * // The name (project, location, cluster) of the cluster to retrieve. Specified in the format `projects/x/locations/x/clusters/x`. * name: 'projects/my-project/locations/my-location/clusters/my-cluster', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * }); * console.log(res.data); @@ -6388,9 +6405,9 @@ export namespace container_v1 { * const res = await container.projects.locations.clusters.list({ * // The parent (project and location) where the clusters will be listed. Specified in the format `projects/x/locations/x`. Location "-" matches all zones and all regions. * parent: 'projects/my-project/locations/my-location', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. * zone: 'placeholder-value', * }); * console.log(res.data); @@ -6827,7 +6844,7 @@ export namespace container_v1 { } /** - * Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://{$universe.dns_names.final_documentation_domain\}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead. + * Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead. * @example * ```js * // Before running the sample: @@ -8506,11 +8523,11 @@ export namespace container_v1 { */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -8536,11 +8553,11 @@ export namespace container_v1 { */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -8558,11 +8575,11 @@ export namespace container_v1 { */ parent?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. */ zone?: string; } @@ -9061,9 +9078,9 @@ export namespace container_v1 { * name: 'projects/my-project/locations/my-location/clusters/my-cluster/nodePools/my-nodePool', * // Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. * nodePoolId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * }); * console.log(res.data); @@ -9369,9 +9386,9 @@ export namespace container_v1 { * name: 'projects/my-project/locations/my-location/clusters/my-cluster/nodePools/my-nodePool', * // Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. * nodePoolId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * }); * console.log(res.data); @@ -9531,9 +9548,9 @@ export namespace container_v1 { * clusterId: 'placeholder-value', * // The parent (project, location, cluster name) where the node pools will be listed. Specified in the format `projects/x/locations/x/clusters/x`. * parent: 'projects/my-project/locations/my-location/clusters/my-cluster', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. * zone: 'placeholder-value', * }); * console.log(res.data); @@ -10535,11 +10552,11 @@ export namespace container_v1 { */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -10569,11 +10586,11 @@ export namespace container_v1 { */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -10588,11 +10605,11 @@ export namespace container_v1 { */ parent?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. */ zone?: string; } @@ -11007,9 +11024,9 @@ export namespace container_v1 { * name: 'projects/my-project/locations/my-location/operations/my-operation', * // Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. * operationId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * }); * console.log(res.data); @@ -11159,9 +11176,9 @@ export namespace container_v1 { * const res = await container.projects.locations.operations.list({ * // The parent (project and location) where the operations will be listed. Specified in the format `projects/x/locations/x`. Location "-" matches all zones and all regions. * parent: 'projects/my-project/locations/my-location', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. * zone: 'placeholder-value', * }); * console.log(res.data); @@ -11294,11 +11311,11 @@ export namespace container_v1 { */ operationId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -11309,11 +11326,11 @@ export namespace container_v1 { */ parent?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. */ zone?: string; } @@ -11361,9 +11378,9 @@ export namespace container_v1 { * const res = await container.projects.zones.getServerconfig({ * // The name (project and location) of the server config to get, specified in the format `projects/x/locations/x`. * name: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * }); * console.log(res.data); @@ -11481,11 +11498,11 @@ export namespace container_v1 { */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -11533,9 +11550,9 @@ export namespace container_v1 { * const res = await container.projects.zones.clusters.addons({ * // Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. * clusterId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * * // Request body metadata @@ -11700,9 +11717,9 @@ export namespace container_v1 { * const res = await container.projects.zones.clusters.completeIpRotation({ * // Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. * clusterId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * * // Request body metadata @@ -11835,7 +11852,7 @@ export namespace container_v1 { } /** - * Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using. + * Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using. * @example * ```js * // Before running the sample: @@ -11865,9 +11882,9 @@ export namespace container_v1 { * * // Do the magic * const res = await container.projects.zones.clusters.create({ - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. * zone: 'placeholder-value', * * // Request body metadata @@ -12032,9 +12049,9 @@ export namespace container_v1 { * clusterId: 'placeholder-value', * // The name (project, location, cluster) of the cluster to delete. Specified in the format `projects/x/locations/x/clusters/x`. * name: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * }); * console.log(res.data); @@ -12337,9 +12354,9 @@ export namespace container_v1 { * clusterId: 'placeholder-value', * // The name (project, location, cluster) of the cluster to retrieve. Specified in the format `projects/x/locations/x/clusters/x`. * name: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * }); * console.log(res.data); @@ -12556,9 +12573,9 @@ export namespace container_v1 { * const res = await container.projects.zones.clusters.legacyAbac({ * // Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. * clusterId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * * // Request body metadata @@ -12723,9 +12740,9 @@ export namespace container_v1 { * const res = await container.projects.zones.clusters.list({ * // The parent (project and location) where the clusters will be listed. Specified in the format `projects/x/locations/x`. Location "-" matches all zones and all regions. * parent: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. * zone: 'placeholder-value', * }); * console.log(res.data); @@ -12834,7 +12851,7 @@ export namespace container_v1 { } /** - * Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://{$universe.dns_names.final_documentation_domain\}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead. + * Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead. * @example * ```js * // Before running the sample: @@ -12866,9 +12883,9 @@ export namespace container_v1 { * const res = await container.projects.zones.clusters.locations({ * // Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. * clusterId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * * // Request body metadata @@ -13033,9 +13050,9 @@ export namespace container_v1 { * const res = await container.projects.zones.clusters.logging({ * // Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. * clusterId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * * // Request body metadata @@ -13200,9 +13217,9 @@ export namespace container_v1 { * const res = await container.projects.zones.clusters.master({ * // Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. * clusterId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * * // Request body metadata @@ -13367,9 +13384,9 @@ export namespace container_v1 { * const res = await container.projects.zones.clusters.monitoring({ * // Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. * clusterId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * * // Request body metadata @@ -13534,9 +13551,9 @@ export namespace container_v1 { * const res = await container.projects.zones.clusters.resourceLabels({ * // Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. * clusterId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * * // Request body metadata @@ -13702,9 +13719,9 @@ export namespace container_v1 { * const res = await container.projects.zones.clusters.setMaintenancePolicy({ * // Required. The name of the cluster to update. * clusterId: 'placeholder-value', - * // Required. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). + * // Required. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). * projectId: 'placeholder-value', - * // Required. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. + * // Required. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. * zone: 'placeholder-value', * * // Request body metadata @@ -13872,9 +13889,9 @@ export namespace container_v1 { * const res = await container.projects.zones.clusters.setMasterAuth({ * // Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. * clusterId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * * // Request body metadata @@ -14040,9 +14057,9 @@ export namespace container_v1 { * const res = await container.projects.zones.clusters.setNetworkPolicy({ * // Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. * clusterId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * * // Request body metadata @@ -14207,9 +14224,9 @@ export namespace container_v1 { * const res = await container.projects.zones.clusters.startIpRotation({ * // Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. * clusterId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * * // Request body metadata @@ -14374,9 +14391,9 @@ export namespace container_v1 { * const res = await container.projects.zones.clusters.update({ * // Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. * clusterId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * * // Request body metadata @@ -14516,11 +14533,11 @@ export namespace container_v1 { */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -14536,11 +14553,11 @@ export namespace container_v1 { */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -14552,11 +14569,11 @@ export namespace container_v1 { export interface Params$Resource$Projects$Zones$Clusters$Create extends StandardParameters { /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. */ zone?: string; @@ -14576,11 +14593,11 @@ export namespace container_v1 { */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -14606,11 +14623,11 @@ export namespace container_v1 { */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -14621,11 +14638,11 @@ export namespace container_v1 { */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -14641,11 +14658,11 @@ export namespace container_v1 { */ parent?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. */ zone?: string; } @@ -14656,11 +14673,11 @@ export namespace container_v1 { */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -14676,11 +14693,11 @@ export namespace container_v1 { */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -14696,11 +14713,11 @@ export namespace container_v1 { */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -14716,11 +14733,11 @@ export namespace container_v1 { */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -14736,11 +14753,11 @@ export namespace container_v1 { */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -14756,11 +14773,11 @@ export namespace container_v1 { */ clusterId?: string; /** - * Required. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). + * Required. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). */ projectId?: string; /** - * Required. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. + * Required. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. */ zone?: string; @@ -14776,11 +14793,11 @@ export namespace container_v1 { */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -14796,11 +14813,11 @@ export namespace container_v1 { */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -14816,11 +14833,11 @@ export namespace container_v1 { */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -14836,11 +14853,11 @@ export namespace container_v1 { */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -14891,9 +14908,9 @@ export namespace container_v1 { * clusterId: 'placeholder-value', * // Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. * nodePoolId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * * // Request body metadata @@ -15060,9 +15077,9 @@ export namespace container_v1 { * const res = await container.projects.zones.clusters.nodePools.create({ * // Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. * clusterId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. * zone: 'placeholder-value', * * // Request body metadata @@ -15231,9 +15248,9 @@ export namespace container_v1 { * name: 'placeholder-value', * // Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. * nodePoolId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * }); * console.log(res.data); @@ -15539,9 +15556,9 @@ export namespace container_v1 { * name: 'placeholder-value', * // Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. * nodePoolId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * }); * console.log(res.data); @@ -15703,9 +15720,9 @@ export namespace container_v1 { * clusterId: 'placeholder-value', * // The parent (project, location, cluster name) where the node pools will be listed. Specified in the format `projects/x/locations/x/clusters/x`. * parent: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. * zone: 'placeholder-value', * }); * console.log(res.data); @@ -15848,9 +15865,9 @@ export namespace container_v1 { * clusterId: 'placeholder-value', * // Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field. * nodePoolId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * * // Request body metadata @@ -16019,9 +16036,9 @@ export namespace container_v1 { * clusterId: 'placeholder-value', * // Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. * nodePoolId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * * // Request body metadata @@ -16190,9 +16207,9 @@ export namespace container_v1 { * clusterId: 'placeholder-value', * // Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. * nodePoolId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * * // Request body metadata @@ -16361,9 +16378,9 @@ export namespace container_v1 { * clusterId: 'placeholder-value', * // Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. * nodePoolId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * * // Request body metadata @@ -16537,11 +16554,11 @@ export namespace container_v1 { */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -16557,11 +16574,11 @@ export namespace container_v1 { */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. */ zone?: string; @@ -16585,11 +16602,11 @@ export namespace container_v1 { */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -16619,11 +16636,11 @@ export namespace container_v1 { */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -16638,11 +16655,11 @@ export namespace container_v1 { */ parent?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. */ zone?: string; } @@ -16657,11 +16674,11 @@ export namespace container_v1 { */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -16681,11 +16698,11 @@ export namespace container_v1 { */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -16705,11 +16722,11 @@ export namespace container_v1 { */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -16729,11 +16746,11 @@ export namespace container_v1 { */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -16782,9 +16799,9 @@ export namespace container_v1 { * const res = await container.projects.zones.operations.cancel({ * // Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. * operationId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * * // Request body metadata @@ -16934,9 +16951,9 @@ export namespace container_v1 { * name: 'placeholder-value', * // Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. * operationId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * }); * console.log(res.data); @@ -17089,9 +17106,9 @@ export namespace container_v1 { * const res = await container.projects.zones.operations.list({ * // The parent (project and location) where the operations will be listed. Specified in the format `projects/x/locations/x`. Location "-" matches all zones and all regions. * parent: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. * zone: 'placeholder-value', * }); * console.log(res.data); @@ -17207,11 +17224,11 @@ export namespace container_v1 { */ operationId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -17231,11 +17248,11 @@ export namespace container_v1 { */ operationId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -17246,11 +17263,11 @@ export namespace container_v1 { */ parent?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. */ zone?: string; } diff --git a/src/apis/container/v1beta1.ts b/src/apis/container/v1beta1.ts index 96d1121257..45c5f27368 100644 --- a/src/apis/container/v1beta1.ts +++ b/src/apis/container/v1beta1.ts @@ -133,7 +133,7 @@ export namespace container_v1beta1 { */ acceleratorCount?: string | null; /** - * The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/gpus) + * The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) */ acceleratorType?: string | null; /** @@ -266,7 +266,7 @@ export namespace container_v1beta1 { */ kalmConfig?: Schema$KalmConfig; /** - * Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain\}/kubernetes-engine/docs/concepts/dashboards + * Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards */ kubernetesDashboard?: Schema$KubernetesDashboard; /** @@ -437,7 +437,7 @@ export namespace container_v1beta1 { */ export interface Schema$AutoprovisioningNodePoolDefaults { /** - * The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain\}/compute/docs/disks/customer-managed-encryption + * The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption */ bootDiskKmsKey?: string | null; /** @@ -449,7 +449,7 @@ export namespace container_v1beta1 { */ diskType?: string | null; /** - * The image type to use for NAP created node. Please see https://{$universe.dns_names.final_documentation_domain\}/kubernetes-engine/docs/concepts/node-images for available image types. + * The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. */ imageType?: string | null; /** @@ -461,11 +461,11 @@ export namespace container_v1beta1 { */ management?: Schema$NodeManagement; /** - * Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. + * Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. */ minCpuPlatform?: string | null; /** - * The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain\}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + * The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. */ oauthScopes?: string[] | null; /** @@ -618,6 +618,19 @@ export namespace container_v1beta1 { */ sizeGb?: string | null; } + /** + * Swap on the node's boot disk. + */ + export interface Schema$BootDiskProfile { + /** + * Specifies the size of the swap space in gibibytes (GiB). + */ + swapSizeGib?: string | null; + /** + * Specifies the size of the swap space as a percentage of the boot disk size. + */ + swapSizePercent?: number | null; + } /** * CancelOperationRequest cancels a single operation. */ @@ -631,11 +644,11 @@ export namespace container_v1beta1 { */ operationId?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -773,7 +786,7 @@ export namespace container_v1beta1 { */ currentNodeCount?: number | null; /** - * Output only. Deprecated, use [NodePool.version](https://{$universe.dns_names.final_documentation_domain\}/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + * Output only. Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. */ currentNodeVersion?: string | null; /** @@ -837,7 +850,7 @@ export namespace container_v1beta1 { */ initialClusterVersion?: string | null; /** - * The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain\}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. + * The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. */ initialNodeCount?: number | null; /** @@ -857,11 +870,11 @@ export namespace container_v1beta1 { */ legacyAbac?: Schema$LegacyAbac; /** - * Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + * Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. */ location?: string | null; /** - * The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain\}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain\}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. + * The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. */ locations?: string[] | null; /** @@ -909,7 +922,7 @@ export namespace container_v1beta1 { */ name?: string | null; /** - * The name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. On output this shows the network ID instead of the name. + * The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. On output this shows the network ID instead of the name. */ network?: string | null; /** @@ -1025,7 +1038,7 @@ export namespace container_v1beta1 { */ statusMessage?: string | null; /** - * The name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name. + * The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name. */ subnetwork?: string | null; /** @@ -1057,7 +1070,7 @@ export namespace container_v1beta1 { */ workloadIdentityConfig?: Schema$WorkloadIdentityConfig; /** - * Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + * Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. */ zone?: string | null; } @@ -1066,7 +1079,7 @@ export namespace container_v1beta1 { */ export interface Schema$ClusterAutoscaling { /** - * The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. + * The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. */ autoprovisioningLocations?: string[] | null; /** @@ -1253,7 +1266,7 @@ export namespace container_v1beta1 { */ desiredL4ilbSubsettingConfig?: Schema$ILBSubsettingConfig; /** - * The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed. + * The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed. */ desiredLocations?: string[] | null; /** @@ -1376,6 +1389,10 @@ export namespace container_v1beta1 { * Enable/Disable Secret Manager Config. */ desiredSecretManagerConfig?: Schema$SecretManagerConfig; + /** + * Configuration for sync Secret Manager secrets as k8s secrets. + */ + desiredSecretSyncConfig?: Schema$SecretSyncConfig; /** * Enable/Disable Security Posture API features for the cluster. */ @@ -1487,11 +1504,11 @@ export namespace container_v1beta1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -1592,7 +1609,7 @@ export namespace container_v1beta1 { */ export interface Schema$CreateClusterRequest { /** - * Required. A [cluster resource](https://{$universe.dns_names.final_documentation_domain\}/container-engine/reference/rest/v1beta1/projects.locations.clusters) + * Required. A [cluster resource](https://cloud.google.com/container-engine/reference/rest/v1beta1/projects.locations.clusters) */ cluster?: Schema$Cluster; /** @@ -1600,11 +1617,11 @@ export namespace container_v1beta1 { */ parent?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. */ zone?: string | null; } @@ -1625,11 +1642,11 @@ export namespace container_v1beta1 { */ parent?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. */ zone?: string | null; } @@ -1688,6 +1705,15 @@ export namespace container_v1beta1 { */ year?: number | null; } + /** + * Provisions a new, separate local NVMe SSD exclusively for swap. + */ + export interface Schema$DedicatedLocalSsdProfile { + /** + * The number of physical local NVMe SSD disks to attach. + */ + diskCount?: string | null; + } /** * DefaultComputeClassConfig defines default compute class configuration. */ @@ -1779,6 +1805,15 @@ export namespace container_v1beta1 { * 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); \} */ export interface Schema$Empty {} + /** + * Defines encryption settings for the swap space. + */ + export interface Schema$EncryptionConfig { + /** + * Optional. If true, swap space will not be encrypted. Defaults to false (encrypted). + */ + disabled?: boolean | null; + } /** * EnterpriseConfig is the cluster enterprise configuration. Deprecated: GKE Enterprise features are now available without an Enterprise tier. */ @@ -1792,12 +1827,25 @@ export namespace container_v1beta1 { */ desiredTier?: string | null; } + /** + * Swap on the local SSD shared with pod ephemeral storage. + */ + export interface Schema$EphemeralLocalSsdProfile { + /** + * Specifies the size of the swap space in gibibytes (GiB). + */ + swapSizeGib?: string | null; + /** + * Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. + */ + swapSizePercent?: number | null; + } /** * EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. */ export interface Schema$EphemeralStorageConfig { /** - * Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain\}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain\}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + * Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. */ localSsdCount?: number | null; } @@ -1810,7 +1858,7 @@ export namespace container_v1beta1 { */ dataCacheCount?: number | null; /** - * Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain\}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain\}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + * Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. */ localSsdCount?: number | null; } @@ -1977,7 +2025,7 @@ export namespace container_v1beta1 { enabled?: boolean | null; } /** - * GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain\}/secret-manager). + * GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). */ export interface Schema$GCPSecretManagerCertificateConfig { /** @@ -2417,6 +2465,14 @@ export namespace container_v1beta1 { * Optional. Amounts for 2M and 1G hugepages */ hugepages?: Schema$HugepagesConfig; + /** + * Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. + */ + nodeKernelModuleLoading?: Schema$NodeKernelModuleLoading; + /** + * Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. + */ + swapConfig?: Schema$SwapConfig; /** * The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes */ @@ -2496,7 +2552,7 @@ export namespace container_v1beta1 { */ export interface Schema$LocalNvmeSsdBlockConfig { /** - * Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain\}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain\}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + * Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. */ localSsdCount?: number | null; } @@ -2561,6 +2617,10 @@ export namespace container_v1beta1 { * Represents the Maintenance exclusion option. */ export interface Schema$MaintenanceExclusionOptions { + /** + * EndTimeBehavior specifies the behavior of the exclusion end time. + */ + endTimeBehavior?: string | null; /** * Scope specifies the upgrade scope which upgrades are blocked by the exclusion. */ @@ -2634,11 +2694,11 @@ export namespace container_v1beta1 { */ clusterCaCertificate?: string | null; /** - * The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain\}/kubernetes-engine/docs/how-to/api-server-authentication + * The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication */ password?: string | null; /** - * The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain\}/kubernetes-engine/docs/how-to/api-server-authentication + * The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication */ username?: string | null; } @@ -2790,7 +2850,7 @@ export namespace container_v1beta1 { */ inTransitEncryptionConfig?: string | null; /** - * Output only. The relative name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network + * Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network */ network?: string | null; /** @@ -2806,7 +2866,7 @@ export namespace container_v1beta1 { */ serviceExternalIpsConfig?: Schema$ServiceExternalIPsConfig; /** - * Output only. The relative name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet + * Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet */ subnetwork?: string | null; } @@ -2864,7 +2924,7 @@ export namespace container_v1beta1 { networkTier?: string | null; } /** - * Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + * Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). */ export interface Schema$NodeAffinity { /** @@ -2885,7 +2945,7 @@ export namespace container_v1beta1 { */ export interface Schema$NodeConfig { /** - * A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain\}/compute/docs/gpus for more information about support for GPUs. + * A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. */ accelerators?: Schema$AcceleratorConfig[]; /** @@ -2897,7 +2957,7 @@ export namespace container_v1beta1 { */ bootDisk?: Schema$BootDisk; /** - * The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain\}/compute/docs/disks/customer-managed-encryption + * The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption */ bootDiskKmsKey?: string | null; /** @@ -2953,7 +3013,7 @@ export namespace container_v1beta1 { */ hostMaintenancePolicy?: Schema$HostMaintenancePolicy; /** - * The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain\}/kubernetes-engine/docs/concepts/node-images for available image types. + * The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. */ imageType?: string | null; /** @@ -2973,7 +3033,7 @@ export namespace container_v1beta1 { */ localNvmeSsdBlockConfig?: Schema$LocalNvmeSsdBlockConfig; /** - * The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain\}/compute/docs/disks/local-ssd for more information. + * The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. */ localSsdCount?: number | null; /** @@ -2985,7 +3045,7 @@ export namespace container_v1beta1 { */ loggingConfig?: Schema$NodePoolLoggingConfig; /** - * The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. + * The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. */ machineType?: string | null; /** @@ -2997,23 +3057,23 @@ export namespace container_v1beta1 { */ metadata?: {[key: string]: string} | null; /** - * Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/instances/specify-min-cpu-platform). + * Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). */ minCpuPlatform?: string | null; /** - * Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/nodes/sole-tenant-nodes). + * Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). */ nodeGroup?: string | null; /** - * The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain\}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + * The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. */ oauthScopes?: string[] | null; /** - * Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain\}/compute/docs/instances/preemptible for more information about preemptible VM instances. + * Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. */ preemptible?: boolean | null; /** - * The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/instances/reserving-zonal-resources) to this node pool. + * The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. */ reservationAffinity?: Schema$ReservationAffinity; /** @@ -3098,6 +3158,15 @@ export namespace container_v1beta1 { */ nodeKubeletConfig?: Schema$NodeKubeletConfig; } + /** + * Configuration for kernel module loading on nodes. + */ + export interface Schema$NodeKernelModuleLoading { + /** + * Set the node module loading policy for nodes in the node pool. + */ + policy?: string | null; + } /** * Node kubelet configs. */ @@ -3213,6 +3282,10 @@ export namespace container_v1beta1 { * Parameters for node pool-level network config. */ export interface Schema$NodeNetworkConfig { + /** + * Immutable. The accelerator network profile for the node pool. For now the only valid value is "auto". If specified, the network configuration of the nodes in this node pool will be managed by this profile for the supported machine types, zone, etc. + */ + acceleratorNetworkProfile?: string | null; /** * We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface */ @@ -3287,15 +3360,15 @@ export namespace container_v1beta1 { */ etag?: string | null; /** - * The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain\}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. + * The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. */ initialNodeCount?: number | null; /** - * Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + * Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. */ instanceGroupUrls?: string[] | null; /** - * The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://{$universe.dns_names.final_documentation_domain\}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. + * The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. */ locations?: string[] | null; /** @@ -3347,7 +3420,7 @@ export namespace container_v1beta1 { */ upgradeSettings?: Schema$UpgradeSettings; /** - * The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain\}/kubernetes-engine/versioning#specifying_node_version). + * The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version). */ version?: string | null; } @@ -3512,7 +3585,7 @@ export namespace container_v1beta1 { */ error?: Schema$Status; /** - * Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + * Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. */ location?: string | null; /** @@ -3552,7 +3625,7 @@ export namespace container_v1beta1 { */ targetLink?: string | null; /** - * Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + * Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. */ zone?: string | null; } @@ -3642,7 +3715,7 @@ export namespace container_v1beta1 { */ policyName?: string | null; /** - * TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain\}/tpu/docs/types-topologies#tpu_topologies + * TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies */ tpuTopology?: string | null; /** @@ -3902,7 +3975,7 @@ export namespace container_v1beta1 { validVersions?: string[] | null; } /** - * [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. + * [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. */ export interface Schema$ReservationAffinity { /** @@ -3919,7 +3992,7 @@ export namespace container_v1beta1 { values?: string[] | null; } /** - * Collection of [Resource Manager labels](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-labels). + * Collection of [Resource Manager labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels). */ export interface Schema$ResourceLabels { /** @@ -3945,7 +4018,7 @@ export namespace container_v1beta1 { resourceType?: string | null; } /** - * A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain\}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. + * A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. */ export interface Schema$ResourceManagerTags { /** @@ -3987,7 +4060,7 @@ export namespace container_v1beta1 { */ nodePoolId?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** @@ -3995,7 +4068,7 @@ export namespace container_v1beta1 { */ respectPdb?: boolean | null; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -4189,11 +4262,11 @@ export namespace container_v1beta1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -4214,7 +4287,7 @@ export namespace container_v1beta1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** @@ -4222,7 +4295,7 @@ export namespace container_v1beta1 { */ resourceLabels?: {[key: string]: string} | null; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -4243,11 +4316,11 @@ export namespace container_v1beta1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -4260,7 +4333,7 @@ export namespace container_v1beta1 { */ clusterId?: string | null; /** - * Required. The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone. + * Required. The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone. */ locations?: string[] | null; /** @@ -4268,11 +4341,11 @@ export namespace container_v1beta1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -4293,11 +4366,11 @@ export namespace container_v1beta1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -4318,11 +4391,11 @@ export namespace container_v1beta1 { */ name?: string | null; /** - * Required. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). + * Required. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). */ projectId?: string | null; /** - * Required. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. + * Required. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. */ zone?: string | null; } @@ -4343,7 +4416,7 @@ export namespace container_v1beta1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** @@ -4351,7 +4424,7 @@ export namespace container_v1beta1 { */ update?: Schema$MasterAuth; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -4372,11 +4445,11 @@ export namespace container_v1beta1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -4397,11 +4470,11 @@ export namespace container_v1beta1 { */ networkPolicy?: Schema$NetworkPolicy; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -4426,11 +4499,11 @@ export namespace container_v1beta1 { */ nodePoolId?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -4455,11 +4528,11 @@ export namespace container_v1beta1 { */ nodePoolId?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -4484,11 +4557,11 @@ export namespace container_v1beta1 { */ nodePoolId?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -4557,7 +4630,7 @@ export namespace container_v1beta1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** @@ -4565,7 +4638,7 @@ export namespace container_v1beta1 { */ rotateCredentials?: boolean | null; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -4612,6 +4685,31 @@ export namespace container_v1beta1 { */ message?: string | null; } + /** + * Configuration for swap memory on a node pool. + */ + export interface Schema$SwapConfig { + /** + * Swap on the node's boot disk. + */ + bootDiskProfile?: Schema$BootDiskProfile; + /** + * Provisions a new, separate local NVMe SSD exclusively for swap. + */ + dedicatedLocalSsdProfile?: Schema$DedicatedLocalSsdProfile; + /** + * Optional. Enables or disables swap for the node pool. + */ + enabled?: boolean | null; + /** + * Optional. If omitted, swap space is encrypted by default. + */ + encryptionConfig?: Schema$EncryptionConfig; + /** + * Swap on the local SSD shared with pod ephemeral storage. + */ + ephemeralLocalSsdProfile?: Schema$EphemeralLocalSsdProfile; + } /** * SyncRotationConfig is config for secret manager auto rotation. */ @@ -4685,7 +4783,7 @@ export namespace container_v1beta1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** @@ -4693,7 +4791,7 @@ export namespace container_v1beta1 { */ update?: Schema$ClusterUpdate; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -4723,11 +4821,11 @@ export namespace container_v1beta1 { */ name?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -4736,7 +4834,7 @@ export namespace container_v1beta1 { */ export interface Schema$UpdateNodePoolRequest { /** - * A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain\}/compute/docs/gpus for more information about support for GPUs. + * A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. */ accelerators?: Schema$AcceleratorConfig[]; /** @@ -4784,7 +4882,7 @@ export namespace container_v1beta1 { */ gvnic?: Schema$VirtualNIC; /** - * Required. The desired image type for the node pool. Please see https://{$universe.dns_names.final_documentation_domain\}/kubernetes-engine/docs/concepts/node-images for available image types. + * Required. The desired image type for the node pool. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. */ imageType?: string | null; /** @@ -4800,7 +4898,7 @@ export namespace container_v1beta1 { */ linuxNodeConfig?: Schema$LinuxNodeConfig; /** - * The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed. + * The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed. Warning: It is recommended to update node pool locations in a standalone API call. Do not combine a location update with changes to other fields (such as `tags`, `labels`, `taints`, etc.) in the same request. Otherwise, the API performs a structural modification where changes to other fields will only apply to newly created nodes and will not be applied to existing nodes in the node pool. To ensure all nodes are updated consistently, use a separate API call for location changes. */ locations?: string[] | null; /** @@ -4832,7 +4930,7 @@ export namespace container_v1beta1 { */ nodeVersion?: string | null; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string | null; /** @@ -4872,7 +4970,7 @@ export namespace container_v1beta1 { */ workloadMetadataConfig?: Schema$WorkloadMetadataConfig; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } @@ -4934,6 +5032,10 @@ export namespace container_v1beta1 { * UpgradeEvent is a notification sent to customers by the cluster server when a resource is upgrading. */ export interface Schema$UpgradeEvent { + /** + * The current emulated version before the upgrade. + */ + currentEmulatedVersion?: string | null; /** * The current version before the upgrade. */ @@ -4954,6 +5056,10 @@ export namespace container_v1beta1 { * The resource type that is upgrading. */ resourceType?: string | null; + /** + * The target emulated version for the upgrade. + */ + targetEmulatedVersion?: string | null; /** * The target version for the upgrade. */ @@ -4963,6 +5069,10 @@ export namespace container_v1beta1 { * UpgradeInfoEvent is a notification sent to customers about the upgrade information of a resource. */ export interface Schema$UpgradeInfoEvent { + /** + * The current emulated version before the upgrade. + */ + currentEmulatedVersion?: string | null; /** * The current version before the upgrade. */ @@ -5007,6 +5117,10 @@ export namespace container_v1beta1 { * Output only. The state of the upgrade. */ state?: string | null; + /** + * The target emulated version for the upgrade. + */ + targetEmulatedVersion?: string | null; /** * The target version for the upgrade. */ @@ -5490,9 +5604,9 @@ export namespace container_v1beta1 { * const res = await container.projects.locations.getServerConfig({ * // The name (project and location) of the server config to get, specified in the format `projects/x/locations/x`. * name: 'projects/my-project/locations/my-location', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * }); * console.log(res.data); @@ -5752,11 +5866,11 @@ export namespace container_v1beta1 { */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -6095,7 +6209,7 @@ export namespace container_v1beta1 { } /** - * Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using. + * Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using. * @example * ```js * // Before running the sample: @@ -6291,9 +6405,9 @@ export namespace container_v1beta1 { * clusterId: 'placeholder-value', * // The name (project, location, cluster) of the cluster to delete. Specified in the format `projects/x/locations/x/clusters/x`. * name: 'projects/my-project/locations/my-location/clusters/my-cluster', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * }); * console.log(res.data); @@ -6594,9 +6708,9 @@ export namespace container_v1beta1 { * clusterId: 'placeholder-value', * // The name (project, location, cluster) of the cluster to retrieve. Specified in the format `projects/x/locations/x/clusters/x`. * name: 'projects/my-project/locations/my-location/clusters/my-cluster', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * }); * console.log(res.data); @@ -6962,9 +7076,9 @@ export namespace container_v1beta1 { * const res = await container.projects.locations.clusters.list({ * // The parent (project and location) where the clusters will be listed. Specified in the format `projects/x/locations/x`. Location "-" matches all zones and all regions. * parent: 'projects/my-project/locations/my-location', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. * zone: 'placeholder-value', * }); * console.log(res.data); @@ -7401,7 +7515,7 @@ export namespace container_v1beta1 { } /** - * Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://{$universe.dns_names.final_documentation_domain\}/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) instead. + * Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) instead. * @example * ```js * // Before running the sample: @@ -9080,11 +9194,11 @@ export namespace container_v1beta1 { */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -9110,11 +9224,11 @@ export namespace container_v1beta1 { */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -9132,11 +9246,11 @@ export namespace container_v1beta1 { */ parent?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. */ zone?: string; } @@ -9635,9 +9749,9 @@ export namespace container_v1beta1 { * name: 'projects/my-project/locations/my-location/clusters/my-cluster/nodePools/my-nodePool', * // Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. * nodePoolId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * }); * console.log(res.data); @@ -9942,9 +10056,9 @@ export namespace container_v1beta1 { * name: 'projects/my-project/locations/my-location/clusters/my-cluster/nodePools/my-nodePool', * // Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. * nodePoolId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * }); * console.log(res.data); @@ -10104,9 +10218,9 @@ export namespace container_v1beta1 { * clusterId: 'placeholder-value', * // The parent (project, location, cluster name) where the node pools will be listed. Specified in the format `projects/x/locations/x/clusters/x`. * parent: 'projects/my-project/locations/my-location/clusters/my-cluster', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. * zone: 'placeholder-value', * }); * console.log(res.data); @@ -11108,11 +11222,11 @@ export namespace container_v1beta1 { */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -11142,11 +11256,11 @@ export namespace container_v1beta1 { */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -11161,11 +11275,11 @@ export namespace container_v1beta1 { */ parent?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. */ zone?: string; } @@ -11583,9 +11697,9 @@ export namespace container_v1beta1 { * name: 'projects/my-project/locations/my-location/operations/my-operation', * // Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. * operationId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * }); * console.log(res.data); @@ -11735,9 +11849,9 @@ export namespace container_v1beta1 { * const res = await container.projects.locations.operations.list({ * // The parent (project and location) where the operations will be listed. Specified in the format `projects/x/locations/x`. Location "-" matches all zones and all regions. * parent: 'projects/my-project/locations/my-location', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. * zone: 'placeholder-value', * }); * console.log(res.data); @@ -11870,11 +11984,11 @@ export namespace container_v1beta1 { */ operationId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -11885,11 +11999,11 @@ export namespace container_v1beta1 { */ parent?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. */ zone?: string; } @@ -11937,9 +12051,9 @@ export namespace container_v1beta1 { * const res = await container.projects.zones.getServerconfig({ * // The name (project and location) of the server config to get, specified in the format `projects/x/locations/x`. * name: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * }); * console.log(res.data); @@ -12059,11 +12173,11 @@ export namespace container_v1beta1 { */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -12111,9 +12225,9 @@ export namespace container_v1beta1 { * const res = await container.projects.zones.clusters.addons({ * // Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. * clusterId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * * // Request body metadata @@ -12278,9 +12392,9 @@ export namespace container_v1beta1 { * const res = await container.projects.zones.clusters.completeIpRotation({ * // Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. * clusterId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * * // Request body metadata @@ -12413,7 +12527,7 @@ export namespace container_v1beta1 { } /** - * Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using. + * Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using. * @example * ```js * // Before running the sample: @@ -12443,9 +12557,9 @@ export namespace container_v1beta1 { * * // Do the magic * const res = await container.projects.zones.clusters.create({ - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. * zone: 'placeholder-value', * * // Request body metadata @@ -12610,9 +12724,9 @@ export namespace container_v1beta1 { * clusterId: 'placeholder-value', * // The name (project, location, cluster) of the cluster to delete. Specified in the format `projects/x/locations/x/clusters/x`. * name: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * }); * console.log(res.data); @@ -12915,9 +13029,9 @@ export namespace container_v1beta1 { * clusterId: 'placeholder-value', * // The name (project, location, cluster) of the cluster to retrieve. Specified in the format `projects/x/locations/x/clusters/x`. * name: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * }); * console.log(res.data); @@ -13144,9 +13258,9 @@ export namespace container_v1beta1 { * const res = await container.projects.zones.clusters.legacyAbac({ * // Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. * clusterId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * * // Request body metadata @@ -13311,9 +13425,9 @@ export namespace container_v1beta1 { * const res = await container.projects.zones.clusters.list({ * // The parent (project and location) where the clusters will be listed. Specified in the format `projects/x/locations/x`. Location "-" matches all zones and all regions. * parent: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. * zone: 'placeholder-value', * }); * console.log(res.data); @@ -13422,7 +13536,7 @@ export namespace container_v1beta1 { } /** - * Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://{$universe.dns_names.final_documentation_domain\}/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) instead. + * Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) instead. * @example * ```js * // Before running the sample: @@ -13454,9 +13568,9 @@ export namespace container_v1beta1 { * const res = await container.projects.zones.clusters.locations({ * // Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. * clusterId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * * // Request body metadata @@ -13621,9 +13735,9 @@ export namespace container_v1beta1 { * const res = await container.projects.zones.clusters.logging({ * // Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. * clusterId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * * // Request body metadata @@ -13788,9 +13902,9 @@ export namespace container_v1beta1 { * const res = await container.projects.zones.clusters.master({ * // Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. * clusterId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * * // Request body metadata @@ -13955,9 +14069,9 @@ export namespace container_v1beta1 { * const res = await container.projects.zones.clusters.monitoring({ * // Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. * clusterId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * * // Request body metadata @@ -14122,9 +14236,9 @@ export namespace container_v1beta1 { * const res = await container.projects.zones.clusters.resourceLabels({ * // Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. * clusterId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * * // Request body metadata @@ -14290,9 +14404,9 @@ export namespace container_v1beta1 { * const res = await container.projects.zones.clusters.setMaintenancePolicy({ * // Required. The name of the cluster to update. * clusterId: 'placeholder-value', - * // Required. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). + * // Required. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). * projectId: 'placeholder-value', - * // Required. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. + * // Required. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. * zone: 'placeholder-value', * * // Request body metadata @@ -14460,9 +14574,9 @@ export namespace container_v1beta1 { * const res = await container.projects.zones.clusters.setMasterAuth({ * // Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. * clusterId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * * // Request body metadata @@ -14628,9 +14742,9 @@ export namespace container_v1beta1 { * const res = await container.projects.zones.clusters.setNetworkPolicy({ * // Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. * clusterId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * * // Request body metadata @@ -14795,9 +14909,9 @@ export namespace container_v1beta1 { * const res = await container.projects.zones.clusters.startIpRotation({ * // Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. * clusterId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * * // Request body metadata @@ -14962,9 +15076,9 @@ export namespace container_v1beta1 { * const res = await container.projects.zones.clusters.update({ * // Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. * clusterId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * * // Request body metadata @@ -15104,11 +15218,11 @@ export namespace container_v1beta1 { */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -15124,11 +15238,11 @@ export namespace container_v1beta1 { */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -15140,11 +15254,11 @@ export namespace container_v1beta1 { export interface Params$Resource$Projects$Zones$Clusters$Create extends StandardParameters { /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. */ zone?: string; @@ -15164,11 +15278,11 @@ export namespace container_v1beta1 { */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -15194,11 +15308,11 @@ export namespace container_v1beta1 { */ name?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -15209,11 +15323,11 @@ export namespace container_v1beta1 { */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -15229,11 +15343,11 @@ export namespace container_v1beta1 { */ parent?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. */ zone?: string; } @@ -15244,11 +15358,11 @@ export namespace container_v1beta1 { */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -15264,11 +15378,11 @@ export namespace container_v1beta1 { */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -15284,11 +15398,11 @@ export namespace container_v1beta1 { */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -15304,11 +15418,11 @@ export namespace container_v1beta1 { */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -15324,11 +15438,11 @@ export namespace container_v1beta1 { */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -15344,11 +15458,11 @@ export namespace container_v1beta1 { */ clusterId?: string; /** - * Required. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). + * Required. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). */ projectId?: string; /** - * Required. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. + * Required. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. */ zone?: string; @@ -15364,11 +15478,11 @@ export namespace container_v1beta1 { */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -15384,11 +15498,11 @@ export namespace container_v1beta1 { */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -15404,11 +15518,11 @@ export namespace container_v1beta1 { */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -15424,11 +15538,11 @@ export namespace container_v1beta1 { */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -15479,9 +15593,9 @@ export namespace container_v1beta1 { * clusterId: 'placeholder-value', * // Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. * nodePoolId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * * // Request body metadata @@ -15648,9 +15762,9 @@ export namespace container_v1beta1 { * const res = await container.projects.zones.clusters.nodePools.create({ * // Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. * clusterId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. * zone: 'placeholder-value', * * // Request body metadata @@ -15819,9 +15933,9 @@ export namespace container_v1beta1 { * name: 'placeholder-value', * // Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. * nodePoolId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * }); * console.log(res.data); @@ -16126,9 +16240,9 @@ export namespace container_v1beta1 { * name: 'placeholder-value', * // Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. * nodePoolId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * }); * console.log(res.data); @@ -16290,9 +16404,9 @@ export namespace container_v1beta1 { * clusterId: 'placeholder-value', * // The parent (project, location, cluster name) where the node pools will be listed. Specified in the format `projects/x/locations/x/clusters/x`. * parent: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. * zone: 'placeholder-value', * }); * console.log(res.data); @@ -16435,9 +16549,9 @@ export namespace container_v1beta1 { * clusterId: 'placeholder-value', * // Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field. * nodePoolId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * * // Request body metadata @@ -16606,9 +16720,9 @@ export namespace container_v1beta1 { * clusterId: 'placeholder-value', * // Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. * nodePoolId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * * // Request body metadata @@ -16777,9 +16891,9 @@ export namespace container_v1beta1 { * clusterId: 'placeholder-value', * // Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. * nodePoolId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * * // Request body metadata @@ -16948,9 +17062,9 @@ export namespace container_v1beta1 { * clusterId: 'placeholder-value', * // Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. * nodePoolId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * * // Request body metadata @@ -17124,11 +17238,11 @@ export namespace container_v1beta1 { */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -17144,11 +17258,11 @@ export namespace container_v1beta1 { */ clusterId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. */ zone?: string; @@ -17172,11 +17286,11 @@ export namespace container_v1beta1 { */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -17206,11 +17320,11 @@ export namespace container_v1beta1 { */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -17225,11 +17339,11 @@ export namespace container_v1beta1 { */ parent?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. */ zone?: string; } @@ -17244,11 +17358,11 @@ export namespace container_v1beta1 { */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -17268,11 +17382,11 @@ export namespace container_v1beta1 { */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -17292,11 +17406,11 @@ export namespace container_v1beta1 { */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -17316,11 +17430,11 @@ export namespace container_v1beta1 { */ nodePoolId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -17369,9 +17483,9 @@ export namespace container_v1beta1 { * const res = await container.projects.zones.operations.cancel({ * // Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. * operationId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * * // Request body metadata @@ -17521,9 +17635,9 @@ export namespace container_v1beta1 { * name: 'placeholder-value', * // Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. * operationId: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. * zone: 'placeholder-value', * }); * console.log(res.data); @@ -17676,9 +17790,9 @@ export namespace container_v1beta1 { * const res = await container.projects.zones.operations.list({ * // The parent (project and location) where the operations will be listed. Specified in the format `projects/x/locations/x`. Location "-" matches all zones and all regions. * parent: 'placeholder-value', - * // Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + * // Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. * projectId: 'placeholder-value', - * // Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. + * // Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. * zone: 'placeholder-value', * }); * console.log(res.data); @@ -17794,11 +17908,11 @@ export namespace container_v1beta1 { */ operationId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. */ zone?: string; @@ -17818,11 +17932,11 @@ export namespace container_v1beta1 { */ operationId?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string; } @@ -17833,11 +17947,11 @@ export namespace container_v1beta1 { */ parent?: string; /** - * Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain\}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + * Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. */ projectId?: string; /** - * Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain\}/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. + * Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. */ zone?: string; } diff --git a/src/apis/dataform/index.ts b/src/apis/dataform/index.ts index 4ffcbde2f2..498a30b2b1 100644 --- a/src/apis/dataform/index.ts +++ b/src/apis/dataform/index.ts @@ -14,25 +14,34 @@ /*! THIS FILE IS AUTO-GENERATED */ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; +import {dataform_v1} from './v1'; import {dataform_v1beta1} from './v1beta1'; export const VERSIONS = { + v1: dataform_v1.Dataform, v1beta1: dataform_v1beta1.Dataform, }; +export function dataform(version: 'v1'): dataform_v1.Dataform; +export function dataform(options: dataform_v1.Options): dataform_v1.Dataform; export function dataform(version: 'v1beta1'): dataform_v1beta1.Dataform; export function dataform( options: dataform_v1beta1.Options ): dataform_v1beta1.Dataform; -export function dataform( +export function dataform( this: GoogleConfigurable, - versionOrOptions: 'v1beta1' | dataform_v1beta1.Options + versionOrOptions: + | 'v1' + | dataform_v1.Options + | 'v1beta1' + | dataform_v1beta1.Options ) { return getAPI('dataform', versionOrOptions, VERSIONS, this); } const auth = new AuthPlus(); export {auth}; +export {dataform_v1}; export {dataform_v1beta1}; export { AuthPlus, diff --git a/src/apis/dataform/v1.ts b/src/apis/dataform/v1.ts new file mode 100644 index 0000000000..f61db64ebf --- /dev/null +++ b/src/apis/dataform/v1.ts @@ -0,0 +1,13911 @@ +// Copyright 2020 Google LLC +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/* eslint-disable @typescript-eslint/no-explicit-any */ +/* eslint-disable @typescript-eslint/no-unused-vars */ +/* eslint-disable @typescript-eslint/no-empty-interface */ +/* eslint-disable @typescript-eslint/no-namespace */ +/* eslint-disable no-irregular-whitespace */ + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, + BaseExternalAccountClient, + GaxiosResponseWithHTTP2, + GoogleConfigurable, + createAPIRequest, + MethodOptions, + StreamMethodOptions, + GlobalOptions, + GoogleAuth, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {Readable} from 'stream'; + +export namespace dataform_v1 { + export interface Options extends GlobalOptions { + version: 'v1'; + } + + interface StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: + | string + | OAuth2Client + | JWT + | Compute + | UserRefreshClient + | BaseExternalAccountClient + | GoogleAuth; + + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + + /** + * Dataform API + * + * Service to develop, version control, and operationalize SQL pipelines in BigQuery. + * + * @example + * ```js + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * ``` + */ + export class Dataform { + context: APIRequestContext; + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.projects = new Resource$Projects(this.context); + } + } + + /** + * Error table information, used to write error data into a BigQuery table. + */ + export interface Schema$ActionErrorTable { + /** + * Error table partition expiration in days. Only positive values are allowed. + */ + retentionDays?: number | null; + /** + * Error Table target. + */ + target?: Schema$Target; + } + /** + * Load definition for incremental load modes + */ + export interface Schema$ActionIncrementalLoadMode { + /** + * Column name for incremental load modes + */ + column?: string | null; + } + /** + * Simplified load configuration for actions + */ + export interface Schema$ActionLoadConfig { + /** + * Append into destination table + */ + append?: Schema$ActionSimpleLoadMode; + /** + * Insert records where the value exceeds the previous maximum value for a column in the destination table + */ + maximum?: Schema$ActionIncrementalLoadMode; + /** + * Replace destination table + */ + replace?: Schema$ActionSimpleLoadMode; + /** + * Insert records where the value of a column is not already present in the destination table + */ + unique?: Schema$ActionIncrementalLoadMode; + } + /** + * Simple load definition + */ + export interface Schema$ActionSimpleLoadMode {} + /** + * Definition of a SQL Data Preparation + */ + export interface Schema$ActionSqlDefinition { + /** + * Error table configuration, + */ + errorTable?: Schema$ActionErrorTable; + /** + * Load configuration. + */ + loadConfig?: Schema$ActionLoadConfig; + /** + * The SQL query representing the data preparation steps. Formatted as a Pipe SQL query statement. + */ + query?: string | null; + } + /** + * Represents an assertion upon a SQL query which is required return zero rows. + */ + export interface Schema$Assertion { + /** + * A list of actions that this action depends on. + */ + dependencyTargets?: Schema$Target[]; + /** + * Whether this action is disabled (i.e. should not be run). + */ + disabled?: boolean | null; + /** + * The parent action of this assertion. Only set if this assertion was automatically generated. + */ + parentAction?: Schema$Target; + /** + * Descriptor for the assertion's automatically-generated view and its columns. + */ + relationDescriptor?: Schema$RelationDescriptor; + /** + * The SELECT query which must return zero rows in order for this assertion to succeed. + */ + selectQuery?: string | null; + /** + * Arbitrary, user-defined tags on this action. + */ + tags?: string[] | null; + } + /** + * Represents a workflow action that will run against BigQuery. + */ + export interface Schema$BigQueryAction { + /** + * Output only. The ID of the BigQuery job that executed the SQL in sql_script. Only set once the job has started to run. + */ + jobId?: string | null; + /** + * Output only. The generated BigQuery SQL script that will be executed. + */ + sqlScript?: string | null; + } + /** + * Associates `members`, or principals, with a `role`. + */ + export interface Schema$Binding { + /** + * The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + */ + condition?: Schema$Expr; + /** + * Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid\}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid\}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid\}.svc.id.goog[{namespace\}/{kubernetes-sa\}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid\}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain\}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/group/{group_id\}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/x`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/group/{group_id\}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/x`: All identities in a workload identity pool. * `deleted:user:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid\}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid\}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid\}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + */ + members?: string[] | null; + /** + * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). + */ + role?: string | null; + } + /** + * The request message for Operations.CancelOperation. + */ + export interface Schema$CancelOperationRequest {} + /** + * `CancelWorkflowInvocation` request message. + */ + export interface Schema$CancelWorkflowInvocationRequest {} + /** + * `CancelWorkflowInvocation` response message. + */ + export interface Schema$CancelWorkflowInvocationResponse {} + /** + * Configures various aspects of Dataform code compilation. + */ + export interface Schema$CodeCompilationConfig { + /** + * Optional. The default schema (BigQuery dataset ID) for assertions. + */ + assertionSchema?: string | null; + /** + * Optional. The prefix to prepend to built-in assertion names. + */ + builtinAssertionNamePrefix?: string | null; + /** + * Optional. The suffix that should be appended to all database (Google Cloud project ID) names. + */ + databaseSuffix?: string | null; + /** + * Optional. The default database (Google Cloud project ID). + */ + defaultDatabase?: string | null; + /** + * Optional. The default BigQuery location to use. Defaults to "US". See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations. + */ + defaultLocation?: string | null; + /** + * Optional. The default notebook runtime options. + */ + defaultNotebookRuntimeOptions?: Schema$NotebookRuntimeOptions; + /** + * Optional. The default schema (BigQuery dataset ID). + */ + defaultSchema?: string | null; + /** + * Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names. + */ + schemaSuffix?: string | null; + /** + * Optional. The prefix that should be prepended to all table names. + */ + tablePrefix?: string | null; + /** + * Optional. User-defined variables that are made available to project code during compilation. + */ + vars?: {[key: string]: string} | null; + } + /** + * Describes a column. + */ + export interface Schema$ColumnDescriptor { + /** + * A list of BigQuery policy tags that will be applied to the column. + */ + bigqueryPolicyTags?: string[] | null; + /** + * A textual description of the column. + */ + description?: string | null; + /** + * The identifier for the column. Each entry in `path` represents one level of nesting. + */ + path?: string[] | null; + } + /** + * Represents the author of a Git commit. + */ + export interface Schema$CommitAuthor { + /** + * Required. The commit author's email address. + */ + emailAddress?: string | null; + /** + * Required. The commit author's name. + */ + name?: string | null; + } + /** + * Represents a single commit log. + */ + export interface Schema$CommitLogEntry { + /** + * The commit author for this commit log entry. + */ + author?: Schema$CommitAuthor; + /** + * The commit message for this commit log entry. + */ + commitMessage?: string | null; + /** + * The commit SHA for this commit log entry. + */ + commitSha?: string | null; + /** + * Commit timestamp. + */ + commitTime?: string | null; + } + /** + * Represents a Dataform Git commit. + */ + export interface Schema$CommitMetadata { + /** + * Required. The commit's author. + */ + author?: Schema$CommitAuthor; + /** + * Optional. The commit's message. + */ + commitMessage?: string | null; + } + /** + * `CommitRepositoryChanges` request message. + */ + export interface Schema$CommitRepositoryChangesRequest { + /** + * Required. The changes to commit to the repository. + */ + commitMetadata?: Schema$CommitMetadata; + /** + * Optional. A map to the path of the file to the operation. The path is the full file path including filename, from repository root. + */ + fileOperations?: {[key: string]: Schema$FileOperation} | null; + /** + * Optional. The commit SHA which must be the repository's current HEAD before applying this commit; otherwise this request will fail. If unset, no validation on the current HEAD commit SHA is performed. + */ + requiredHeadCommitSha?: string | null; + } + /** + * `CommitRepositoryChanges` response message. + */ + export interface Schema$CommitRepositoryChangesResponse { + /** + * The commit SHA of the current commit. + */ + commitSha?: string | null; + } + /** + * `CommitWorkspaceChanges` request message. + */ + export interface Schema$CommitWorkspaceChangesRequest { + /** + * Required. The commit's author. + */ + author?: Schema$CommitAuthor; + /** + * Optional. The commit's message. + */ + commitMessage?: string | null; + /** + * Optional. Full file paths to commit including filename, rooted at workspace root. If left empty, all files will be committed. + */ + paths?: string[] | null; + } + /** + * `CommitWorkspaceChanges` response message. + */ + export interface Schema$CommitWorkspaceChangesResponse {} + /** + * An error encountered when attempting to compile a Dataform project. + */ + export interface Schema$CompilationError { + /** + * Output only. The identifier of the action where this error occurred, if available. + */ + actionTarget?: Schema$Target; + /** + * Output only. The error's top level message. + */ + message?: string | null; + /** + * Output only. The path of the file where this error occurred, if available, relative to the project root. + */ + path?: string | null; + /** + * Output only. The error's full stack trace. + */ + stack?: string | null; + } + /** + * Represents the result of compiling a Dataform project. + */ + export interface Schema$CompilationResult { + /** + * Immutable. If set, fields of `code_compilation_config` override the default compilation settings that are specified in dataform.json. + */ + codeCompilationConfig?: Schema$CodeCompilationConfig; + /** + * Output only. Errors encountered during project compilation. + */ + compilationErrors?: Schema$CompilationError[]; + /** + * Output only. The timestamp of when the compilation result was created. + */ + createTime?: string | null; + /** + * Output only. Only set if the repository has a KMS Key. + */ + dataEncryptionState?: Schema$DataEncryptionState; + /** + * Output only. The version of `@dataform/core` that was used for compilation. + */ + dataformCoreVersion?: string | null; + /** + * Immutable. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1` + */ + gitCommitish?: string | null; + /** + * Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. + */ + internalMetadata?: string | null; + /** + * Output only. The compilation result's name. + */ + name?: string | null; + /** + * Immutable. The name of the release config to compile. Must be in the format `projects/x/locations/x/repositories/x/releaseConfigs/x`. + */ + releaseConfig?: string | null; + /** + * Output only. The fully resolved Git commit SHA of the code that was compiled. Not set for compilation results whose source is a workspace. + */ + resolvedGitCommitSha?: string | null; + /** + * Immutable. The name of the workspace to compile. Must be in the format `projects/x/locations/x/repositories/x/workspaces/x`. + */ + workspace?: string | null; + } + /** + * Represents a single Dataform action in a compilation result. + */ + export interface Schema$CompilationResultAction { + /** + * The assertion executed by this action. + */ + assertion?: Schema$Assertion; + /** + * The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result. + */ + canonicalTarget?: Schema$Target; + /** + * The data preparation executed by this action. + */ + dataPreparation?: Schema$DataPreparation; + /** + * The declaration declared by this action. + */ + declaration?: Schema$Declaration; + /** + * The full path including filename in which this action is located, relative to the workspace root. + */ + filePath?: string | null; + /** + * Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. + */ + internalMetadata?: string | null; + /** + * The notebook executed by this action. + */ + notebook?: Schema$Notebook; + /** + * The database operations executed by this action. + */ + operations?: Schema$Operations; + /** + * The database relation created/updated by this action. + */ + relation?: Schema$Relation; + /** + * This action's identifier. Unique within the compilation result. + */ + target?: Schema$Target; + } + /** + * `ComputeRepositoryAccessTokenStatus` response message. + */ + export interface Schema$ComputeRepositoryAccessTokenStatusResponse { + /** + * Indicates the status of the Git access token. + */ + tokenStatus?: string | null; + } + /** + * Config for all repositories in a given project and location. + */ + export interface Schema$Config { + /** + * Optional. The default KMS key that is used if no encryption key is provided when a repository is created. + */ + defaultKmsKeyName?: string | null; + /** + * Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. + */ + internalMetadata?: string | null; + /** + * Identifier. The config name. + */ + name?: string | null; + } + /** + * Describes encryption state of a resource. + */ + export interface Schema$DataEncryptionState { + /** + * Required. The KMS key version name with which data of a resource is encrypted. + */ + kmsKeyVersionName?: string | null; + } + /** + * Defines a compiled Data Preparation entity + */ + export interface Schema$DataPreparation { + /** + * SQL definition for a Data Preparation. Contains a SQL query and additional context information. + */ + contentsSql?: Schema$SqlDefinition; + /** + * The data preparation definition, stored as a YAML string. + */ + contentsYaml?: string | null; + /** + * A list of actions that this action depends on. + */ + dependencyTargets?: Schema$Target[]; + /** + * Whether this action is disabled (i.e. should not be run). + */ + disabled?: boolean | null; + /** + * Arbitrary, user-defined tags on this action. + */ + tags?: string[] | null; + } + /** + * Represents a workflow action that will run a Data Preparation. + */ + export interface Schema$DataPreparationAction { + /** + * SQL definition for a Data Preparation. Contains a SQL query and additional context information. + */ + contentsSql?: Schema$ActionSqlDefinition; + /** + * Output only. YAML representing the contents of the data preparation. Can be used to show the customer what the input was to their workflow. + */ + contentsYaml?: string | null; + /** + * Output only. The generated BigQuery SQL script that will be executed. For reference only. + */ + generatedSql?: string | null; + /** + * Output only. The ID of the BigQuery job that executed the SQL in sql_script. Only set once the job has started to run. + */ + jobId?: string | null; + } + /** + * Represents a relation which is not managed by Dataform but which may be referenced by Dataform actions. + */ + export interface Schema$Declaration { + /** + * Descriptor for the relation and its columns. Used as documentation only, i.e. values here will result in no changes to the relation's metadata. + */ + relationDescriptor?: Schema$RelationDescriptor; + } + /** + * Represents the delete file operation. + */ + export interface Schema$DeleteFile {} + /** + * Represents a single entry in a directory. + */ + export interface Schema$DirectoryEntry { + /** + * A child directory in the directory. + */ + directory?: string | null; + /** + * A file in the directory. + */ + file?: string | null; + } + /** + * Client-facing representation of a directory entry in search results. + */ + export interface Schema$DirectorySearchResult { + /** + * File system path relative to the workspace root. + */ + path?: string | null; + } + /** + * 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); \} + */ + export interface Schema$Empty {} + /** + * Error table information, used to write error data into a BigQuery table. + */ + export interface Schema$ErrorTable { + /** + * Error table partition expiration in days. Only positive values are allowed. + */ + retentionDays?: number | null; + /** + * Error Table target. + */ + target?: Schema$Target; + } + /** + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. + */ + export interface Schema$Expr { + /** + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + */ + description?: string | null; + /** + * Textual representation of an expression in Common Expression Language syntax. + */ + expression?: string | null; + /** + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + */ + location?: string | null; + /** + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + */ + title?: string | null; + } + /** + * `FetchFileDiff` response message. + */ + export interface Schema$FetchFileDiffResponse { + /** + * The raw formatted Git diff for the file. + */ + formattedDiff?: string | null; + } + /** + * `FetchFileGitStatuses` response message. + */ + export interface Schema$FetchFileGitStatusesResponse { + /** + * A list of all files which have uncommitted Git changes. There will only be a single entry for any given file. + */ + uncommittedFileChanges?: Schema$UncommittedFileChange[]; + } + /** + * `FetchGitAheadBehind` response message. + */ + export interface Schema$FetchGitAheadBehindResponse { + /** + * The number of commits in the remote branch that are not in the workspace. + */ + commitsAhead?: number | null; + /** + * The number of commits in the workspace that are not in the remote branch. + */ + commitsBehind?: number | null; + } + /** + * `FetchRemoteBranches` response message. + */ + export interface Schema$FetchRemoteBranchesResponse { + /** + * The remote repository's branch names. + */ + branches?: string[] | null; + } + /** + * `FetchRepositoryHistory` response message. + */ + export interface Schema$FetchRepositoryHistoryResponse { + /** + * A list of commit logs, ordered by 'git log' default order. + */ + commits?: Schema$CommitLogEntry[]; + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } + /** + * Represents a single file operation to the repository. + */ + export interface Schema$FileOperation { + /** + * Represents the delete operation. + */ + deleteFile?: Schema$DeleteFile; + /** + * Represents the write operation. + */ + writeFile?: Schema$WriteFile; + } + /** + * Client-facing representation of a file entry in search results. + */ + export interface Schema$FileSearchResult { + /** + * File system path relative to the workspace root. + */ + path?: string | null; + } + /** + * Controls Git remote configuration for a repository. + */ + export interface Schema$GitRemoteSettings { + /** + * Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/x/secrets/x/versions/x`. + */ + authenticationTokenSecretVersion?: string | null; + /** + * Required. The Git remote's default branch name. + */ + defaultBranch?: string | null; + /** + * Optional. Authentication fields for remote uris using SSH protocol. + */ + sshAuthenticationConfig?: Schema$SshAuthenticationConfig; + /** + * Output only. Deprecated: The field does not contain any token status information. + */ + tokenStatus?: string | null; + /** + * Required. The Git remote's URL. + */ + url?: string | null; + } + /** + * Contains metadata about the IAM policy override for a given Dataform resource. If is_active is true, this the policy encoded in iam_policy_name is the source of truth for this resource. Will be provided in internal ESV2 views for: Workspaces, Repositories, Folders, TeamFolders. + */ + export interface Schema$IamPolicyOverrideView { + /** + * The IAM policy name for the resource. + */ + iamPolicyName?: Schema$PolicyName; + /** + * Whether the IAM policy encoded in this view is active. + */ + isActive?: boolean | null; + } + /** + * Load definition for incremental load modes + */ + export interface Schema$IncrementalLoadMode { + /** + * Column name for incremental load modes + */ + column?: string | null; + } + /** + * Contains settings for relations of type `INCREMENTAL_TABLE`. + */ + export interface Schema$IncrementalTableConfig { + /** + * SQL statements to be executed after inserting new rows into the relation. + */ + incrementalPostOperations?: string[] | null; + /** + * SQL statements to be executed before inserting new rows into the relation. + */ + incrementalPreOperations?: string[] | null; + /** + * The SELECT query which returns rows which should be inserted into the relation if it already exists and is not being refreshed. + */ + incrementalSelectQuery?: string | null; + /** + * Whether this table should be protected from being refreshed. + */ + refreshDisabled?: boolean | null; + /** + * A set of columns or SQL expressions used to define row uniqueness. If any duplicates are discovered (as defined by `unique_key_parts`), only the newly selected rows (as defined by `incremental_select_query`) will be included in the relation. + */ + uniqueKeyParts?: string[] | null; + /** + * A SQL expression conditional used to limit the set of existing rows considered for a merge operation (see `unique_key_parts` for more information). + */ + updatePartitionFilter?: string | null; + } + /** + * `InstallNpmPackages` request message. + */ + export interface Schema$InstallNpmPackagesRequest {} + /** + * `InstallNpmPackages` response message. + */ + export interface Schema$InstallNpmPackagesResponse {} + /** + * Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. + */ + export interface Schema$Interval { + /** + * Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end. + */ + endTime?: string | null; + /** + * Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start. + */ + startTime?: string | null; + } + /** + * Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. + */ + export interface Schema$InvocationConfig { + /** + * Optional. When set to true, any incremental tables will be fully refreshed. + */ + fullyRefreshIncrementalTablesEnabled?: boolean | null; + /** + * Optional. The set of tags to include. + */ + includedTags?: string[] | null; + /** + * Optional. The set of action identifiers to include. + */ + includedTargets?: Schema$Target[]; + /** + * Optional. Specifies the priority for query execution in BigQuery. More information can be found at https://cloud.google.com/bigquery/docs/running-queries#queries. + */ + queryPriority?: string | null; + /** + * Optional. The service account to run workflow invocations under. + */ + serviceAccount?: string | null; + /** + * Optional. When set to true, transitive dependencies of included actions will be executed. + */ + transitiveDependenciesIncluded?: boolean | null; + /** + * Optional. When set to true, transitive dependents of included actions will be executed. + */ + transitiveDependentsIncluded?: boolean | null; + } + /** + * `ListCompilationResults` response message. + */ + export interface Schema$ListCompilationResultsResponse { + /** + * List of compilation results. + */ + compilationResults?: Schema$CompilationResult[]; + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * Locations which could not be reached. + */ + unreachable?: string[] | null; + } + /** + * The response message for Locations.ListLocations. + */ + export interface Schema$ListLocationsResponse { + /** + * A list of locations that matches the specified filter in the request. + */ + locations?: Schema$Location[]; + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + } + /** + * The response message for Operations.ListOperations. + */ + export interface Schema$ListOperationsResponse { + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + /** + * A list of operations that matches the specified filter in the request. + */ + operations?: Schema$Operation[]; + /** + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; + } + /** + * `ListReleaseConfigs` response message. + */ + export interface Schema$ListReleaseConfigsResponse { + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * List of release configs. + */ + releaseConfigs?: Schema$ReleaseConfig[]; + /** + * Locations which could not be reached. + */ + unreachable?: string[] | null; + } + /** + * `ListRepositories` response message. + */ + export interface Schema$ListRepositoriesResponse { + /** + * A token which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * List of repositories. + */ + repositories?: Schema$Repository[]; + /** + * Locations which could not be reached. + */ + unreachable?: string[] | null; + } + /** + * `ListWorkflowConfigs` response message. + */ + export interface Schema$ListWorkflowConfigsResponse { + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * Locations which could not be reached. + */ + unreachable?: string[] | null; + /** + * List of workflow configs. + */ + workflowConfigs?: Schema$WorkflowConfig[]; + } + /** + * `ListWorkflowInvocations` response message. + */ + export interface Schema$ListWorkflowInvocationsResponse { + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * Locations which could not be reached. + */ + unreachable?: string[] | null; + /** + * List of workflow invocations. + */ + workflowInvocations?: Schema$WorkflowInvocation[]; + } + /** + * `ListWorkspaces` response message. + */ + export interface Schema$ListWorkspacesResponse { + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * Locations which could not be reached. + */ + unreachable?: string[] | null; + /** + * List of workspaces. + */ + workspaces?: Schema$Workspace[]; + } + /** + * Simplified load configuration for actions + */ + export interface Schema$LoadConfig { + /** + * Append into destination table + */ + append?: Schema$SimpleLoadMode; + /** + * Insert records where the value exceeds the previous maximum value for a column in the destination table + */ + maximum?: Schema$IncrementalLoadMode; + /** + * Replace destination table + */ + replace?: Schema$SimpleLoadMode; + /** + * Insert records where the value of a column is not already present in the destination table + */ + unique?: Schema$IncrementalLoadMode; + } + /** + * A resource that represents a Google Cloud location. + */ + export interface Schema$Location { + /** + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". + */ + displayName?: string | null; + /** + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"\} + */ + labels?: {[key: string]: string} | null; + /** + * The canonical id for this location. For example: `"us-east1"`. + */ + locationId?: string | null; + /** + * Service-specific metadata. For example the available capacity at the given location. + */ + metadata?: {[key: string]: any} | null; + /** + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` + */ + name?: string | null; + } + /** + * `MakeDirectory` request message. + */ + export interface Schema$MakeDirectoryRequest { + /** + * Required. The directory's full path including directory name, relative to the workspace root. + */ + path?: string | null; + } + /** + * `MakeDirectory` response message. + */ + export interface Schema$MakeDirectoryResponse {} + /** + * `MoveDirectory` request message. + */ + export interface Schema$MoveDirectoryRequest { + /** + * Required. The new path for the directory including directory name, rooted at workspace root. + */ + newPath?: string | null; + /** + * Required. The directory's full path including directory name, relative to the workspace root. + */ + path?: string | null; + } + /** + * `MoveDirectory` response message. + */ + export interface Schema$MoveDirectoryResponse {} + /** + * `MoveFile` request message. + */ + export interface Schema$MoveFileRequest { + /** + * Required. The file's new path including filename, relative to the workspace root. + */ + newPath?: string | null; + /** + * Required. The file's full path including filename, relative to the workspace root. + */ + path?: string | null; + } + /** + * `MoveFile` response message. + */ + export interface Schema$MoveFileResponse {} + /** + * Represents a notebook. + */ + export interface Schema$Notebook { + /** + * The contents of the notebook. + */ + contents?: string | null; + /** + * A list of actions that this action depends on. + */ + dependencyTargets?: Schema$Target[]; + /** + * Whether this action is disabled (i.e. should not be run). + */ + disabled?: boolean | null; + /** + * Arbitrary, user-defined tags on this action. + */ + tags?: string[] | null; + } + /** + * Represents a workflow action that will run against a Notebook runtime. + */ + export interface Schema$NotebookAction { + /** + * Output only. The code contents of a Notebook to be run. + */ + contents?: string | null; + /** + * Output only. The ID of the Vertex job that executed the notebook in contents and also the ID used for the outputs created in Google Cloud Storage buckets. Only set once the job has started to run. + */ + jobId?: string | null; + } + /** + * Configures various aspects of Dataform notebook runtime. + */ + export interface Schema$NotebookRuntimeOptions { + /** + * Optional. The resource name of the [Colab runtime template] (https://cloud.google.com/colab/docs/runtimes), from which a runtime is created for notebook executions. If not specified, a runtime is created with Colab's default specifications. + */ + aiPlatformNotebookRuntimeTemplate?: string | null; + /** + * Optional. The Google Cloud Storage location to upload the result to. Format: `gs://bucket-name`. + */ + gcsOutputBucket?: string | null; + } + /** + * This resource represents a long-running operation that is the result of a network API call. + */ + export interface Schema$Operation { + /** + * 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. + */ + done?: boolean | null; + /** + * The error result of the operation in case of failure or cancellation. + */ + error?: Schema$Status; + /** + * 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. + */ + metadata?: {[key: string]: any} | null; + /** + * 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\}`. + */ + name?: string | null; + /** + * 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`. + */ + response?: {[key: string]: any} | null; + } + /** + * Represents the metadata of the long-running operation. + */ + export interface Schema$OperationMetadata { + /** + * Output only. API version used to start the operation. + */ + apiVersion?: string | null; + /** + * Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have google.longrunning.Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + */ + cancelRequested?: boolean | null; + /** + * Output only. The time the operation was created. + */ + createTime?: string | null; + /** + * Output only. The time the operation finished running. + */ + endTime?: string | null; + /** + * Output only. Human-readable status of the operation, if any. + */ + statusDetail?: string | null; + /** + * Output only. Server-defined resource path for the target of the operation. + */ + target?: string | null; + /** + * Output only. Name of the verb executed by the operation. + */ + verb?: string | null; + } + /** + * Represents a list of arbitrary database operations. + */ + export interface Schema$Operations { + /** + * A list of actions that this action depends on. + */ + dependencyTargets?: Schema$Target[]; + /** + * Whether this action is disabled (i.e. should not be run). + */ + disabled?: boolean | null; + /** + * Whether these operations produce an output relation. + */ + hasOutput?: boolean | null; + /** + * A list of arbitrary SQL statements that will be executed without alteration. + */ + queries?: string[] | null; + /** + * Descriptor for any output relation and its columns. Only set if `has_output` is true. + */ + relationDescriptor?: Schema$RelationDescriptor; + /** + * Arbitrary, user-defined tags on this action. + */ + tags?: string[] | null; + } + /** + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] \}, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", \} \} ], "etag": "BwWWja0YfJA=", "version": 3 \} ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + */ + export interface Schema$Policy { + /** + * Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. + */ + bindings?: Schema$Binding[]; + /** + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. + */ + etag?: string | null; + /** + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + */ + version?: number | null; + } + /** + * An internal name for an IAM policy, based on the resource to which the policy applies. Not to be confused with a resource's external full resource name. For more information on this distinction, see go/iam-full-resource-names. + */ + export interface Schema$PolicyName { + /** + * Identifies an instance of the type. ID format varies by type. The ID format is defined in the IAM .service file that defines the type, either in path_mapping or in a comment. + */ + id?: string | null; + /** + * For Cloud IAM: The location of the Policy. Must be empty or "global" for Policies owned by global IAM. Must name a region from prodspec/cloud-iam-cloudspec for Regional IAM Policies, see go/iam-faq#where-is-iam-currently-deployed. For Local IAM: This field should be set to "local". + */ + region?: string | null; + /** + * Resource type. Types are defined in IAM's .service files. Valid values for type might be 'storage_buckets', 'compute_instances', 'resourcemanager_customers', 'billing_accounts', etc. + */ + type?: string | null; + } + /** + * `PullGitCommits` request message. + */ + export interface Schema$PullGitCommitsRequest { + /** + * Required. The author of any merge commit which may be created as a result of merging fetched Git commits into this workspace. + */ + author?: Schema$CommitAuthor; + /** + * Optional. The name of the branch in the Git remote from which to pull commits. If left unset, the repository's default branch name will be used. + */ + remoteBranch?: string | null; + } + /** + * `PullGitCommits` response message. + */ + export interface Schema$PullGitCommitsResponse {} + /** + * `PushGitCommits` request message. + */ + export interface Schema$PushGitCommitsRequest { + /** + * Optional. The name of the branch in the Git remote to which commits should be pushed. If left unset, the repository's default branch name will be used. + */ + remoteBranch?: string | null; + } + /** + * `PushGitCommits` response message. + */ + export interface Schema$PushGitCommitsResponse {} + /** + * `QueryCompilationResultActions` response message. + */ + export interface Schema$QueryCompilationResultActionsResponse { + /** + * List of compilation result actions. + */ + compilationResultActions?: Schema$CompilationResultAction[]; + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } + /** + * `QueryDirectoryContents` response message. + */ + export interface Schema$QueryDirectoryContentsResponse { + /** + * List of entries in the directory. + */ + directoryEntries?: Schema$DirectoryEntry[]; + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } + /** + * `QueryRepositoryDirectoryContents` response message. + */ + export interface Schema$QueryRepositoryDirectoryContentsResponse { + /** + * List of entries in the directory. + */ + directoryEntries?: Schema$DirectoryEntry[]; + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } + /** + * `QueryWorkflowInvocationActions` response message. + */ + export interface Schema$QueryWorkflowInvocationActionsResponse { + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * List of workflow invocation actions. + */ + workflowInvocationActions?: Schema$WorkflowInvocationAction[]; + } + /** + * `ReadFile` response message. + */ + export interface Schema$ReadFileResponse { + /** + * The file's contents. + */ + fileContents?: string | null; + } + /** + * `ReadRepositoryFile` response message. + */ + export interface Schema$ReadRepositoryFileResponse { + /** + * The file's contents. + */ + contents?: string | null; + } + /** + * Represents a database relation. + */ + export interface Schema$Relation { + /** + * Additional options that will be provided as key/value pairs into the options clause of a create table/view statement. See https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language for more information on which options are supported. + */ + additionalOptions?: {[key: string]: string} | null; + /** + * A list of columns or SQL expressions used to cluster the table. + */ + clusterExpressions?: string[] | null; + /** + * A list of actions that this action depends on. + */ + dependencyTargets?: Schema$Target[]; + /** + * Whether this action is disabled (i.e. should not be run). + */ + disabled?: boolean | null; + /** + * Configures `INCREMENTAL_TABLE` settings for this relation. Only set if `relation_type` is `INCREMENTAL_TABLE`. + */ + incrementalTableConfig?: Schema$IncrementalTableConfig; + /** + * Sets the partition expiration in days. + */ + partitionExpirationDays?: number | null; + /** + * The SQL expression used to partition the relation. + */ + partitionExpression?: string | null; + /** + * SQL statements to be executed after creating the relation. + */ + postOperations?: string[] | null; + /** + * SQL statements to be executed before creating the relation. + */ + preOperations?: string[] | null; + /** + * Descriptor for the relation and its columns. + */ + relationDescriptor?: Schema$RelationDescriptor; + /** + * The type of this relation. + */ + relationType?: string | null; + /** + * Specifies whether queries on this table must include a predicate filter that filters on the partitioning column. + */ + requirePartitionFilter?: boolean | null; + /** + * The SELECT query which returns rows which this relation should contain. + */ + selectQuery?: string | null; + /** + * Arbitrary, user-defined tags on this action. + */ + tags?: string[] | null; + } + /** + * Describes a relation and its columns. + */ + export interface Schema$RelationDescriptor { + /** + * A set of BigQuery labels that should be applied to the relation. + */ + bigqueryLabels?: {[key: string]: string} | null; + /** + * A list of descriptions of columns within the relation. + */ + columns?: Schema$ColumnDescriptor[]; + /** + * A text description of the relation. + */ + description?: string | null; + } + /** + * Represents a Dataform release configuration. + */ + export interface Schema$ReleaseConfig { + /** + * Optional. If set, fields of `code_compilation_config` override the default compilation settings that are specified in dataform.json. + */ + codeCompilationConfig?: Schema$CodeCompilationConfig; + /** + * Optional. Optional schedule (in cron format) for automatic creation of compilation results. + */ + cronSchedule?: string | null; + /** + * Optional. Disables automatic creation of compilation results. + */ + disabled?: boolean | null; + /** + * Required. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1` + */ + gitCommitish?: string | null; + /** + * Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. + */ + internalMetadata?: string | null; + /** + * Identifier. The release config's name. + */ + name?: string | null; + /** + * Output only. Records of the 10 most recent scheduled release attempts, ordered in descending order of `release_time`. Updated whenever automatic creation of a compilation result is triggered by cron_schedule. + */ + recentScheduledReleaseRecords?: Schema$ScheduledReleaseRecord[]; + /** + * Optional. The name of the currently released compilation result for this release config. This value is updated when a compilation result is automatically created from this release config (using cron_schedule), or when this resource is updated by API call (perhaps to roll back to an earlier release). The compilation result must have been created using this release config. Must be in the format `projects/x/locations/x/repositories/x/compilationResults/x`. + */ + releaseCompilationResult?: string | null; + /** + * Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC. + */ + timeZone?: string | null; + } + /** + * `RemoveDirectory` request message. + */ + export interface Schema$RemoveDirectoryRequest { + /** + * Required. The directory's full path including directory name, relative to the workspace root. + */ + path?: string | null; + } + /** + * `RemoveDirectory` response message. + */ + export interface Schema$RemoveDirectoryResponse {} + /** + * `RemoveFile` request message. + */ + export interface Schema$RemoveFileRequest { + /** + * Required. The file's full path including filename, relative to the workspace root. + */ + path?: string | null; + } + /** + * `RemoveFile` response message. + */ + export interface Schema$RemoveFileResponse {} + /** + * Represents a Dataform Git repository. + */ + export interface Schema$Repository { + /** + * Output only. The timestamp of when the repository was created. + */ + createTime?: string | null; + /** + * Output only. A data encryption state of a Git repository if this Repository is protected by a KMS key. + */ + dataEncryptionState?: Schema$DataEncryptionState; + /** + * Optional. The repository's user-friendly name. + */ + displayName?: string | null; + /** + * Optional. If set, configures this repository to be linked to a Git remote. + */ + gitRemoteSettings?: Schema$GitRemoteSettings; + /** + * Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. + */ + internalMetadata?: string | null; + /** + * Optional. The reference to a KMS encryption key. If provided, it will be used to encrypt user data in the repository and all child resources. It is not possible to add or update the encryption key after the repository is created. Example: `projects/{kms_project\}/locations/{location\}/keyRings/{key_location\}/cryptoKeys/{key\}` + */ + kmsKeyName?: string | null; + /** + * Optional. Repository user labels. + */ + labels?: {[key: string]: string} | null; + /** + * Identifier. The repository's name. + */ + name?: string | null; + /** + * Optional. The name of the Secret Manager secret version to be used to interpolate variables into the .npmrc file for package installation operations. Must be in the format `projects/x/secrets/x/versions/x`. The file itself must be in a JSON format. + */ + npmrcEnvironmentVariablesSecretVersion?: string | null; + /** + * Optional. The service account to run workflow invocations under. + */ + serviceAccount?: string | null; + /** + * Optional. Input only. If set to true, the authenticated user will be granted the roles/dataform.admin role on the created repository. + */ + setAuthenticatedUserAdmin?: boolean | null; + /** + * Optional. If set, fields of `workspace_compilation_overrides` override the default compilation settings that are specified in dataform.json when creating workspace-scoped compilation results. See documentation for `WorkspaceCompilationOverrides` for more information. + */ + workspaceCompilationOverrides?: Schema$WorkspaceCompilationOverrides; + } + /** + * `ResetWorkspaceChanges` request message. + */ + export interface Schema$ResetWorkspaceChangesRequest { + /** + * Optional. If set to true, untracked files will be deleted. + */ + clean?: boolean | null; + /** + * Optional. Full file paths to reset back to their committed state including filename, rooted at workspace root. If left empty, all files will be reset. + */ + paths?: string[] | null; + } + /** + * `ResetWorkspaceChanges` response message. + */ + export interface Schema$ResetWorkspaceChangesResponse {} + /** + * A record of an attempt to create a workflow invocation for this workflow config. + */ + export interface Schema$ScheduledExecutionRecord { + /** + * The error status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful. + */ + errorStatus?: Schema$Status; + /** + * Output only. The timestamp of this execution attempt. + */ + executionTime?: string | null; + /** + * The name of the created workflow invocation, if one was successfully created. Must be in the format `projects/x/locations/x/repositories/x/workflowInvocations/x`. + */ + workflowInvocation?: string | null; + } + /** + * A record of an attempt to create a compilation result for this release config. + */ + export interface Schema$ScheduledReleaseRecord { + /** + * The name of the created compilation result, if one was successfully created. Must be in the format `projects/x/locations/x/repositories/x/compilationResults/x`. + */ + compilationResult?: string | null; + /** + * The error status encountered upon this attempt to create the compilation result, if the attempt was unsuccessful. + */ + errorStatus?: Schema$Status; + /** + * Output only. The timestamp of this release attempt. + */ + releaseTime?: string | null; + } + /** + * Client-facing representation of a file search response. + */ + export interface Schema$SearchFilesResponse { + /** + * Optional. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * List of matched results. + */ + searchResults?: Schema$SearchResult[]; + } + /** + * Client-facing representation of a search result entry. + */ + export interface Schema$SearchResult { + /** + * Details when search result is a directory. + */ + directory?: Schema$DirectorySearchResult; + /** + * Details when search result is a file. + */ + file?: Schema$FileSearchResult; + } + /** + * Request message for `SetIamPolicy` method. + */ + export interface Schema$SetIamPolicyRequest { + /** + * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them. + */ + policy?: Schema$Policy; + } + /** + * Simple load definition + */ + export interface Schema$SimpleLoadMode {} + /** + * Definition of a SQL Data Preparation + */ + export interface Schema$SqlDefinition { + /** + * Error table configuration, + */ + errorTable?: Schema$ErrorTable; + /** + * Load configuration. + */ + load?: Schema$LoadConfig; + /** + * The SQL query representing the data preparation steps. Formatted as a Pipe SQL query statement. + */ + query?: string | null; + } + /** + * Configures fields for performing SSH authentication. + */ + export interface Schema$SshAuthenticationConfig { + /** + * Required. Content of a public SSH key to verify an identity of a remote Git host. + */ + hostPublicKey?: string | null; + /** + * Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/x/secrets/x/versions/x`. + */ + userPrivateKeySecretVersion?: string | null; + } + /** + * 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). + */ + export interface Schema$Status { + /** + * The status code, which should be an enum value of google.rpc.Code. + */ + code?: number | null; + /** + * A list of messages that carry the error details. There is a common set of message types for APIs to use. + */ + details?: Array<{[key: string]: any}> | null; + /** + * 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. + */ + message?: string | null; + } + /** + * Represents an action identifier. If the action writes output, the output will be written to the referenced database object. + */ + export interface Schema$Target { + /** + * Optional. The action's database (Google Cloud project ID) . + */ + database?: string | null; + /** + * Optional. The action's name, within `database` and `schema`. + */ + name?: string | null; + /** + * Optional. The action's schema (BigQuery dataset ID), within `database`. + */ + schema?: string | null; + } + /** + * Request message for `TestIamPermissions` method. + */ + export interface Schema$TestIamPermissionsRequest { + /** + * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + */ + permissions?: string[] | null; + } + /** + * Response message for `TestIamPermissions` method. + */ + export interface Schema$TestIamPermissionsResponse { + /** + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. + */ + permissions?: string[] | null; + } + /** + * Represents the Git state of a file with uncommitted changes. + */ + export interface Schema$UncommittedFileChange { + /** + * The file's full path including filename, relative to the workspace root. + */ + path?: string | null; + /** + * Output only. Indicates the status of the file. + */ + state?: string | null; + } + /** + * Represents a Dataform workflow configuration. + */ + export interface Schema$WorkflowConfig { + /** + * Output only. The timestamp of when the WorkflowConfig was created. + */ + createTime?: string | null; + /** + * Optional. Optional schedule (in cron format) for automatic execution of this workflow config. + */ + cronSchedule?: string | null; + /** + * Optional. Disables automatic creation of workflow invocations. + */ + disabled?: boolean | null; + /** + * Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. + */ + internalMetadata?: string | null; + /** + * Optional. If left unset, a default InvocationConfig will be used. + */ + invocationConfig?: Schema$InvocationConfig; + /** + * Identifier. The workflow config's name. + */ + name?: string | null; + /** + * Output only. Records of the 10 most recent scheduled execution attempts, ordered in descending order of `execution_time`. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule. + */ + recentScheduledExecutionRecords?: Schema$ScheduledExecutionRecord[]; + /** + * Required. The name of the release config whose release_compilation_result should be executed. Must be in the format `projects/x/locations/x/repositories/x/releaseConfigs/x`. + */ + releaseConfig?: string | null; + /** + * Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC. + */ + timeZone?: string | null; + /** + * Output only. The timestamp of when the WorkflowConfig was last updated. + */ + updateTime?: string | null; + } + /** + * Represents a single invocation of a compilation result. + */ + export interface Schema$WorkflowInvocation { + /** + * Immutable. The name of the compilation result to use for this invocation. Must be in the format `projects/x/locations/x/repositories/x/compilationResults/x`. + */ + compilationResult?: string | null; + /** + * Output only. Only set if the repository has a KMS Key. + */ + dataEncryptionState?: Schema$DataEncryptionState; + /** + * Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. + */ + internalMetadata?: string | null; + /** + * Immutable. If left unset, a default InvocationConfig will be used. + */ + invocationConfig?: Schema$InvocationConfig; + /** + * Output only. This workflow invocation's timing details. + */ + invocationTiming?: Schema$Interval; + /** + * Output only. The workflow invocation's name. + */ + name?: string | null; + /** + * Output only. The resolved compilation result that was used to create this invocation. Will be in the format `projects/x/locations/x/repositories/x/compilationResults/x`. + */ + resolvedCompilationResult?: string | null; + /** + * Output only. This workflow invocation's current state. + */ + state?: string | null; + /** + * Immutable. The name of the workflow config to invoke. Must be in the format `projects/x/locations/x/repositories/x/workflowConfigs/x`. + */ + workflowConfig?: string | null; + } + /** + * Represents a single action in a workflow invocation. + */ + export interface Schema$WorkflowInvocationAction { + /** + * Output only. The workflow action's bigquery action details. + */ + bigqueryAction?: Schema$BigQueryAction; + /** + * Output only. The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result. + */ + canonicalTarget?: Schema$Target; + /** + * Output only. The workflow action's data preparation action details. + */ + dataPreparationAction?: Schema$DataPreparationAction; + /** + * Output only. If and only if action's state is FAILED a failure reason is set. + */ + failureReason?: string | null; + /** + * Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. + */ + internalMetadata?: string | null; + /** + * Output only. This action's timing details. `start_time` will be set if the action is in [RUNNING, SUCCEEDED, CANCELLED, FAILED] state. `end_time` will be set if the action is in [SUCCEEDED, CANCELLED, FAILED] state. + */ + invocationTiming?: Schema$Interval; + /** + * Output only. The workflow action's notebook action details. + */ + notebookAction?: Schema$NotebookAction; + /** + * Output only. This action's current state. + */ + state?: string | null; + /** + * Output only. This action's identifier. Unique within the workflow invocation. + */ + target?: Schema$Target; + } + /** + * Represents a Dataform Git workspace. + */ + export interface Schema$Workspace { + /** + * Output only. The timestamp of when the workspace was created. + */ + createTime?: string | null; + /** + * Output only. A data encryption state of a Git repository if this Workspace is protected by a KMS key. + */ + dataEncryptionState?: Schema$DataEncryptionState; + /** + * Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. + */ + internalMetadata?: string | null; + /** + * Identifier. The workspace's name. + */ + name?: string | null; + } + /** + * Configures workspace compilation overrides for a repository. + */ + export interface Schema$WorkspaceCompilationOverrides { + /** + * Optional. The default database (Google Cloud project ID). + */ + defaultDatabase?: string | null; + /** + * Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names. + */ + schemaSuffix?: string | null; + /** + * Optional. The prefix that should be prepended to all table names. + */ + tablePrefix?: string | null; + } + /** + * Represents the write file operation (for files added or modified). + */ + export interface Schema$WriteFile { + /** + * The file's contents. + */ + contents?: string | null; + } + /** + * `WriteFile` request message. + */ + export interface Schema$WriteFileRequest { + /** + * Required. The file's contents. + */ + contents?: string | null; + /** + * Required. The file. + */ + path?: string | null; + } + /** + * `WriteFile` response message. + */ + export interface Schema$WriteFileResponse {} + + export class Resource$Projects { + context: APIRequestContext; + locations: Resource$Projects$Locations; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Projects$Locations(this.context); + } + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + folders: Resource$Projects$Locations$Folders; + operations: Resource$Projects$Locations$Operations; + repositories: Resource$Projects$Locations$Repositories; + teamFolders: Resource$Projects$Locations$Teamfolders; + constructor(context: APIRequestContext) { + this.context = context; + this.folders = new Resource$Projects$Locations$Folders(this.context); + this.operations = new Resource$Projects$Locations$Operations( + this.context + ); + this.repositories = new Resource$Projects$Locations$Repositories( + this.context + ); + this.teamFolders = new Resource$Projects$Locations$Teamfolders( + this.context + ); + } + + /** + * Gets information about a location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await dataform.projects.locations.get({ + * // Resource name for the location. + * name: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "displayName": "my_displayName", + * // "labels": {}, + * // "locationId": "my_locationId", + * // "metadata": {}, + * // "name": "my_name" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Get default config for a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await dataform.projects.locations.getConfig({ + * // Required. The config name. + * name: 'projects/my-project/locations/my-location/config', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "defaultKmsKeyName": "my_defaultKmsKeyName", + * // "internalMetadata": "my_internalMetadata", + * // "name": "my_name" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getConfig( + params: Params$Resource$Projects$Locations$Getconfig, + options: StreamMethodOptions + ): Promise>; + getConfig( + params?: Params$Resource$Projects$Locations$Getconfig, + options?: MethodOptions + ): Promise>; + getConfig( + params: Params$Resource$Projects$Locations$Getconfig, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getConfig( + params: Params$Resource$Projects$Locations$Getconfig, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getConfig( + params: Params$Resource$Projects$Locations$Getconfig, + callback: BodyResponseCallback + ): void; + getConfig(callback: BodyResponseCallback): void; + getConfig( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Getconfig + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Getconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Getconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists information about the supported locations for this service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await dataform.projects.locations.list({ + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * extraLocationTypes: 'placeholder-value', + * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). + * filter: 'placeholder-value', + * // The resource that owns the locations collection, if applicable. + * name: 'projects/my-project', + * // The maximum number of results to return. If not set, the service selects a default. + * pageSize: 'placeholder-value', + * // A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. + * pageToken: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "locations": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Projects$Locations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/locations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Update default config for a given project and location. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.* + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await dataform.projects.locations.updateConfig({ + * // Identifier. The config name. + * name: 'projects/my-project/locations/my-location/config', + * // Optional. Specifies the fields to be updated in the config. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "defaultKmsKeyName": "my_defaultKmsKeyName", + * // "internalMetadata": "my_internalMetadata", + * // "name": "my_name" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "defaultKmsKeyName": "my_defaultKmsKeyName", + * // "internalMetadata": "my_internalMetadata", + * // "name": "my_name" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + updateConfig( + params: Params$Resource$Projects$Locations$Updateconfig, + options: StreamMethodOptions + ): Promise>; + updateConfig( + params?: Params$Resource$Projects$Locations$Updateconfig, + options?: MethodOptions + ): Promise>; + updateConfig( + params: Params$Resource$Projects$Locations$Updateconfig, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateConfig( + params: Params$Resource$Projects$Locations$Updateconfig, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateConfig( + params: Params$Resource$Projects$Locations$Updateconfig, + callback: BodyResponseCallback + ): void; + updateConfig(callback: BodyResponseCallback): void; + updateConfig( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Updateconfig + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Updateconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Updateconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Get + extends StandardParameters { + /** + * Resource name for the location. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Getconfig + extends StandardParameters { + /** + * Required. The config name. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$List + extends StandardParameters { + /** + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + */ + extraLocationTypes?: string[]; + /** + * A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). + */ + filter?: string; + /** + * The resource that owns the locations collection, if applicable. + */ + name?: string; + /** + * The maximum number of results to return. If not set, the service selects a default. + */ + pageSize?: number; + /** + * A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. + */ + pageToken?: string; + } + export interface Params$Resource$Projects$Locations$Updateconfig + extends StandardParameters { + /** + * Identifier. The config name. + */ + name?: string; + /** + * Optional. Specifies the fields to be updated in the config. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Config; + } + + export class Resource$Projects$Locations$Folders { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await dataform.projects.locations.folders.getIamPolicy({ + * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + * 'options.requestedPolicyVersion': 'placeholder-value', + * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: 'projects/my-project/locations/my-location/folders/my-folder', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Projects$Locations$Folders$Getiampolicy, + options: StreamMethodOptions + ): Promise>; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Folders$Getiampolicy, + options?: MethodOptions + ): Promise>; + getIamPolicy( + params: Params$Resource$Projects$Locations$Folders$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Folders$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Folders$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Folders$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Folders$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Folders$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await dataform.projects.locations.folders.setIamPolicy({ + * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: 'projects/my-project/locations/my-location/folders/my-folder', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "policy": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Locations$Folders$Setiampolicy, + options: StreamMethodOptions + ): Promise>; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Folders$Setiampolicy, + options?: MethodOptions + ): Promise>; + setIamPolicy( + params: Params$Resource$Projects$Locations$Folders$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Folders$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Folders$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Folders$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Folders$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Folders$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await dataform.projects.locations.folders.testIamPermissions({ + * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: 'projects/my-project/locations/my-location/folders/my-folder', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "permissions": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + testIamPermissions( + params: Params$Resource$Projects$Locations$Folders$Testiampermissions, + options: StreamMethodOptions + ): Promise>; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Folders$Testiampermissions, + options?: MethodOptions + ): Promise>; + testIamPermissions( + params: Params$Resource$Projects$Locations$Folders$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Folders$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Folders$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Folders$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Folders$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Folders$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Folders$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Folders$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Folders$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + + export class Resource$Projects$Locations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await dataform.projects.locations.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/operations/my-operation', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Projects$Locations$Operations$Cancel, + options?: MethodOptions + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await dataform.projects.locations.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Operations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await dataform.projects.locations.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Operations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Operations$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Operations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Operations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await dataform.projects.locations.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Operations$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Operations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CancelOperationRequest; + } + export interface Params$Resource$Projects$Locations$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + + export class Resource$Projects$Locations$Repositories { + context: APIRequestContext; + compilationResults: Resource$Projects$Locations$Repositories$Compilationresults; + releaseConfigs: Resource$Projects$Locations$Repositories$Releaseconfigs; + workflowConfigs: Resource$Projects$Locations$Repositories$Workflowconfigs; + workflowInvocations: Resource$Projects$Locations$Repositories$Workflowinvocations; + workspaces: Resource$Projects$Locations$Repositories$Workspaces; + constructor(context: APIRequestContext) { + this.context = context; + this.compilationResults = + new Resource$Projects$Locations$Repositories$Compilationresults( + this.context + ); + this.releaseConfigs = + new Resource$Projects$Locations$Repositories$Releaseconfigs( + this.context + ); + this.workflowConfigs = + new Resource$Projects$Locations$Repositories$Workflowconfigs( + this.context + ); + this.workflowInvocations = + new Resource$Projects$Locations$Repositories$Workflowinvocations( + this.context + ); + this.workspaces = new Resource$Projects$Locations$Repositories$Workspaces( + this.context + ); + } + + /** + * Applies a Git commit to a Repository. The Repository must not have a value for `git_remote_settings.url`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await dataform.projects.locations.repositories.commit({ + * // Required. The repository's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "commitMetadata": {}, + * // "fileOperations": {}, + * // "requiredHeadCommitSha": "my_requiredHeadCommitSha" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "commitSha": "my_commitSha" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + commit( + params: Params$Resource$Projects$Locations$Repositories$Commit, + options: StreamMethodOptions + ): Promise>; + commit( + params?: Params$Resource$Projects$Locations$Repositories$Commit, + options?: MethodOptions + ): Promise>; + commit( + params: Params$Resource$Projects$Locations$Repositories$Commit, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + commit( + params: Params$Resource$Projects$Locations$Repositories$Commit, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + commit( + params: Params$Resource$Projects$Locations$Repositories$Commit, + callback: BodyResponseCallback + ): void; + commit( + callback: BodyResponseCallback + ): void; + commit( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Commit + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Commit; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Repositories$Commit; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:commit').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Computes a Repository's Git access token status. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.computeAccessTokenStatus({ + * // Required. The repository's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "tokenStatus": "my_tokenStatus" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + computeAccessTokenStatus( + params: Params$Resource$Projects$Locations$Repositories$Computeaccesstokenstatus, + options: StreamMethodOptions + ): Promise>; + computeAccessTokenStatus( + params?: Params$Resource$Projects$Locations$Repositories$Computeaccesstokenstatus, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + computeAccessTokenStatus( + params: Params$Resource$Projects$Locations$Repositories$Computeaccesstokenstatus, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + computeAccessTokenStatus( + params: Params$Resource$Projects$Locations$Repositories$Computeaccesstokenstatus, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + computeAccessTokenStatus( + params: Params$Resource$Projects$Locations$Repositories$Computeaccesstokenstatus, + callback: BodyResponseCallback + ): void; + computeAccessTokenStatus( + callback: BodyResponseCallback + ): void; + computeAccessTokenStatus( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Computeaccesstokenstatus + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Computeaccesstokenstatus; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Computeaccesstokenstatus; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:computeAccessTokenStatus').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Creates a new Repository in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await dataform.projects.locations.repositories.create({ + * // Required. The location in which to create the repository. Must be in the format `projects/x/locations/x`. + * parent: 'projects/my-project/locations/my-location', + * // Required. The ID to use for the repository, which will become the final component of the repository's resource name. + * repositoryId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "dataEncryptionState": {}, + * // "displayName": "my_displayName", + * // "gitRemoteSettings": {}, + * // "internalMetadata": "my_internalMetadata", + * // "kmsKeyName": "my_kmsKeyName", + * // "labels": {}, + * // "name": "my_name", + * // "npmrcEnvironmentVariablesSecretVersion": "my_npmrcEnvironmentVariablesSecretVersion", + * // "serviceAccount": "my_serviceAccount", + * // "setAuthenticatedUserAdmin": false, + * // "workspaceCompilationOverrides": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "dataEncryptionState": {}, + * // "displayName": "my_displayName", + * // "gitRemoteSettings": {}, + * // "internalMetadata": "my_internalMetadata", + * // "kmsKeyName": "my_kmsKeyName", + * // "labels": {}, + * // "name": "my_name", + * // "npmrcEnvironmentVariablesSecretVersion": "my_npmrcEnvironmentVariablesSecretVersion", + * // "serviceAccount": "my_serviceAccount", + * // "setAuthenticatedUserAdmin": false, + * // "workspaceCompilationOverrides": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Repositories$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Repositories$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Repositories$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Repositories$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Repositories$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Repositories$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/repositories').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single Repository. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await dataform.projects.locations.repositories.delete({ + * // Optional. If set to true, child resources of this repository (compilation results and workflow invocations) will also be deleted. Otherwise, the request will only succeed if the repository has no child resources. **Note:** *This flag doesn't support deletion of workspaces, release configs or workflow configs. If any of such resources exists in the repository, the request will fail.*. + * force: 'placeholder-value', + * // Required. The repository's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Repositories$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Repositories$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Repositories$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Repositories$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Repositories$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Repositories$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Fetches a Repository's history of commits. The Repository must not have a value for `git_remote_settings.url`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await dataform.projects.locations.repositories.fetchHistory({ + * // Required. The repository's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie', + * // Optional. Maximum number of commits to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. + * pageSize: 'placeholder-value', + * // Optional. Page token received from a previous `FetchRepositoryHistory` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchRepositoryHistory`, with the exception of `page_size`, must match the call that provided the page token. + * pageToken: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "commits": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + fetchHistory( + params: Params$Resource$Projects$Locations$Repositories$Fetchhistory, + options: StreamMethodOptions + ): Promise>; + fetchHistory( + params?: Params$Resource$Projects$Locations$Repositories$Fetchhistory, + options?: MethodOptions + ): Promise>; + fetchHistory( + params: Params$Resource$Projects$Locations$Repositories$Fetchhistory, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchHistory( + params: Params$Resource$Projects$Locations$Repositories$Fetchhistory, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchHistory( + params: Params$Resource$Projects$Locations$Repositories$Fetchhistory, + callback: BodyResponseCallback + ): void; + fetchHistory( + callback: BodyResponseCallback + ): void; + fetchHistory( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Fetchhistory + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Fetchhistory; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Fetchhistory; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:fetchHistory').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Fetches a Repository's remote branches. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.fetchRemoteBranches({ + * // Required. The repository's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "branches": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + fetchRemoteBranches( + params: Params$Resource$Projects$Locations$Repositories$Fetchremotebranches, + options: StreamMethodOptions + ): Promise>; + fetchRemoteBranches( + params?: Params$Resource$Projects$Locations$Repositories$Fetchremotebranches, + options?: MethodOptions + ): Promise>; + fetchRemoteBranches( + params: Params$Resource$Projects$Locations$Repositories$Fetchremotebranches, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchRemoteBranches( + params: Params$Resource$Projects$Locations$Repositories$Fetchremotebranches, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchRemoteBranches( + params: Params$Resource$Projects$Locations$Repositories$Fetchremotebranches, + callback: BodyResponseCallback + ): void; + fetchRemoteBranches( + callback: BodyResponseCallback + ): void; + fetchRemoteBranches( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Fetchremotebranches + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Fetchremotebranches; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Fetchremotebranches; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:fetchRemoteBranches').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Fetches a single Repository. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await dataform.projects.locations.repositories.get({ + * // Required. The repository's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "dataEncryptionState": {}, + * // "displayName": "my_displayName", + * // "gitRemoteSettings": {}, + * // "internalMetadata": "my_internalMetadata", + * // "kmsKeyName": "my_kmsKeyName", + * // "labels": {}, + * // "name": "my_name", + * // "npmrcEnvironmentVariablesSecretVersion": "my_npmrcEnvironmentVariablesSecretVersion", + * // "serviceAccount": "my_serviceAccount", + * // "setAuthenticatedUserAdmin": false, + * // "workspaceCompilationOverrides": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Repositories$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Repositories$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Repositories$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Repositories$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Repositories$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Repositories$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await dataform.projects.locations.repositories.getIamPolicy({ + * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + * 'options.requestedPolicyVersion': 'placeholder-value', + * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/repositories/my-repositorie', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Projects$Locations$Repositories$Getiampolicy, + options: StreamMethodOptions + ): Promise>; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Repositories$Getiampolicy, + options?: MethodOptions + ): Promise>; + getIamPolicy( + params: Params$Resource$Projects$Locations$Repositories$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Repositories$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Repositories$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists Repositories in a given project and location. **Note:** *This method can return repositories not shown in the [Dataform UI](https://console.cloud.google.com/bigquery/dataform)*. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await dataform.projects.locations.repositories.list({ + * // Optional. Filter for the returned list. + * filter: 'placeholder-value', + * // Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field. + * orderBy: 'placeholder-value', + * // Optional. Maximum number of repositories to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. + * pageSize: 'placeholder-value', + * // Optional. Page token received from a previous `ListRepositories` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRepositories`, with the exception of `page_size`, must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The location in which to list repositories. Must be in the format `projects/x/locations/x`. + * parent: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "repositories": [], + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Repositories$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Repositories$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Repositories$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Repositories$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Repositories$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Repositories$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/repositories').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates a single Repository. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.* + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await dataform.projects.locations.repositories.patch({ + * // Identifier. The repository's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie', + * // Optional. Specifies the fields to be updated in the repository. If left unset, all fields will be updated. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "dataEncryptionState": {}, + * // "displayName": "my_displayName", + * // "gitRemoteSettings": {}, + * // "internalMetadata": "my_internalMetadata", + * // "kmsKeyName": "my_kmsKeyName", + * // "labels": {}, + * // "name": "my_name", + * // "npmrcEnvironmentVariablesSecretVersion": "my_npmrcEnvironmentVariablesSecretVersion", + * // "serviceAccount": "my_serviceAccount", + * // "setAuthenticatedUserAdmin": false, + * // "workspaceCompilationOverrides": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "dataEncryptionState": {}, + * // "displayName": "my_displayName", + * // "gitRemoteSettings": {}, + * // "internalMetadata": "my_internalMetadata", + * // "kmsKeyName": "my_kmsKeyName", + * // "labels": {}, + * // "name": "my_name", + * // "npmrcEnvironmentVariablesSecretVersion": "my_npmrcEnvironmentVariablesSecretVersion", + * // "serviceAccount": "my_serviceAccount", + * // "setAuthenticatedUserAdmin": false, + * // "workspaceCompilationOverrides": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Repositories$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Repositories$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Repositories$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Repositories$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Repositories$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Repositories$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns the contents of a given Repository directory. The Repository must not have a value for `git_remote_settings.url`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.queryDirectoryContents({ + * // Optional. The Commit SHA for the commit to query from. If unset, the directory will be queried from HEAD. + * commitSha: 'placeholder-value', + * // Required. The repository's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie', + * // Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. + * pageSize: 'placeholder-value', + * // Optional. Page token received from a previous `QueryRepositoryDirectoryContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryRepositoryDirectoryContents`, with the exception of `page_size`, must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Optional. The directory's full path including directory name, relative to root. If left unset, the root is used. + * path: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "directoryEntries": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + queryDirectoryContents( + params: Params$Resource$Projects$Locations$Repositories$Querydirectorycontents, + options: StreamMethodOptions + ): Promise>; + queryDirectoryContents( + params?: Params$Resource$Projects$Locations$Repositories$Querydirectorycontents, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + queryDirectoryContents( + params: Params$Resource$Projects$Locations$Repositories$Querydirectorycontents, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + queryDirectoryContents( + params: Params$Resource$Projects$Locations$Repositories$Querydirectorycontents, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + queryDirectoryContents( + params: Params$Resource$Projects$Locations$Repositories$Querydirectorycontents, + callback: BodyResponseCallback + ): void; + queryDirectoryContents( + callback: BodyResponseCallback + ): void; + queryDirectoryContents( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Querydirectorycontents + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Querydirectorycontents; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Querydirectorycontents; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:queryDirectoryContents').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Returns the contents of a file (inside a Repository). The Repository must not have a value for `git_remote_settings.url`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await dataform.projects.locations.repositories.readFile({ + * // Optional. The commit SHA for the commit to read from. If unset, the file will be read from HEAD. + * commitSha: 'placeholder-value', + * // Required. The repository's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie', + * // Required. Full file path to read including filename, from repository root. + * path: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "contents": "my_contents" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + readFile( + params: Params$Resource$Projects$Locations$Repositories$Readfile, + options: StreamMethodOptions + ): Promise>; + readFile( + params?: Params$Resource$Projects$Locations$Repositories$Readfile, + options?: MethodOptions + ): Promise>; + readFile( + params: Params$Resource$Projects$Locations$Repositories$Readfile, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + readFile( + params: Params$Resource$Projects$Locations$Repositories$Readfile, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + readFile( + params: Params$Resource$Projects$Locations$Repositories$Readfile, + callback: BodyResponseCallback + ): void; + readFile( + callback: BodyResponseCallback + ): void; + readFile( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Readfile + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Readfile; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Repositories$Readfile; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:readFile').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await dataform.projects.locations.repositories.setIamPolicy({ + * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/repositories/my-repositorie', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "policy": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Locations$Repositories$Setiampolicy, + options: StreamMethodOptions + ): Promise>; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Repositories$Setiampolicy, + options?: MethodOptions + ): Promise>; + setIamPolicy( + params: Params$Resource$Projects$Locations$Repositories$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Repositories$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Repositories$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await dataform.projects.locations.repositories.testIamPermissions( + * { + * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/repositories/my-repositorie', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "permissions": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + testIamPermissions( + params: Params$Resource$Projects$Locations$Repositories$Testiampermissions, + options: StreamMethodOptions + ): Promise>; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Repositories$Testiampermissions, + options?: MethodOptions + ): Promise>; + testIamPermissions( + params: Params$Resource$Projects$Locations$Repositories$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Repositories$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Repositories$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Repositories$Commit + extends StandardParameters { + /** + * Required. The repository's name. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CommitRepositoryChangesRequest; + } + export interface Params$Resource$Projects$Locations$Repositories$Computeaccesstokenstatus + extends StandardParameters { + /** + * Required. The repository's name. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Create + extends StandardParameters { + /** + * Required. The location in which to create the repository. Must be in the format `projects/x/locations/x`. + */ + parent?: string; + /** + * Required. The ID to use for the repository, which will become the final component of the repository's resource name. + */ + repositoryId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Repository; + } + export interface Params$Resource$Projects$Locations$Repositories$Delete + extends StandardParameters { + /** + * Optional. If set to true, child resources of this repository (compilation results and workflow invocations) will also be deleted. Otherwise, the request will only succeed if the repository has no child resources. **Note:** *This flag doesn't support deletion of workspaces, release configs or workflow configs. If any of such resources exists in the repository, the request will fail.*. + */ + force?: boolean; + /** + * Required. The repository's name. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Fetchhistory + extends StandardParameters { + /** + * Required. The repository's name. + */ + name?: string; + /** + * Optional. Maximum number of commits to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous `FetchRepositoryHistory` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchRepositoryHistory`, with the exception of `page_size`, must match the call that provided the page token. + */ + pageToken?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Fetchremotebranches + extends StandardParameters { + /** + * Required. The repository's name. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Get + extends StandardParameters { + /** + * Required. The repository's name. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$List + extends StandardParameters { + /** + * Optional. Filter for the returned list. + */ + filter?: string; + /** + * Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field. + */ + orderBy?: string; + /** + * Optional. Maximum number of repositories to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous `ListRepositories` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRepositories`, with the exception of `page_size`, must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The location in which to list repositories. Must be in the format `projects/x/locations/x`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Patch + extends StandardParameters { + /** + * Identifier. The repository's name. + */ + name?: string; + /** + * Optional. Specifies the fields to be updated in the repository. If left unset, all fields will be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Repository; + } + export interface Params$Resource$Projects$Locations$Repositories$Querydirectorycontents + extends StandardParameters { + /** + * Optional. The Commit SHA for the commit to query from. If unset, the directory will be queried from HEAD. + */ + commitSha?: string; + /** + * Required. The repository's name. + */ + name?: string; + /** + * Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous `QueryRepositoryDirectoryContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryRepositoryDirectoryContents`, with the exception of `page_size`, must match the call that provided the page token. + */ + pageToken?: string; + /** + * Optional. The directory's full path including directory name, relative to root. If left unset, the root is used. + */ + path?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Readfile + extends StandardParameters { + /** + * Optional. The commit SHA for the commit to read from. If unset, the file will be read from HEAD. + */ + commitSha?: string; + /** + * Required. The repository's name. + */ + name?: string; + /** + * Required. Full file path to read including filename, from repository root. + */ + path?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Repositories$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + + export class Resource$Projects$Locations$Repositories$Compilationresults { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new CompilationResult in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.compilationResults.create({ + * // Required. The repository in which to create the compilation result. Must be in the format `projects/x/locations/x/repositories/x`. + * parent: + * 'projects/my-project/locations/my-location/repositories/my-repositorie', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "codeCompilationConfig": {}, + * // "compilationErrors": [], + * // "createTime": "my_createTime", + * // "dataEncryptionState": {}, + * // "dataformCoreVersion": "my_dataformCoreVersion", + * // "gitCommitish": "my_gitCommitish", + * // "internalMetadata": "my_internalMetadata", + * // "name": "my_name", + * // "releaseConfig": "my_releaseConfig", + * // "resolvedGitCommitSha": "my_resolvedGitCommitSha", + * // "workspace": "my_workspace" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "codeCompilationConfig": {}, + * // "compilationErrors": [], + * // "createTime": "my_createTime", + * // "dataEncryptionState": {}, + * // "dataformCoreVersion": "my_dataformCoreVersion", + * // "gitCommitish": "my_gitCommitish", + * // "internalMetadata": "my_internalMetadata", + * // "name": "my_name", + * // "releaseConfig": "my_releaseConfig", + * // "resolvedGitCommitSha": "my_resolvedGitCommitSha", + * // "workspace": "my_workspace" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Repositories$Compilationresults$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Repositories$Compilationresults$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Repositories$Compilationresults$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Repositories$Compilationresults$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Repositories$Compilationresults$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Compilationresults$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Compilationresults$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Compilationresults$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/compilationResults').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Fetches a single CompilationResult. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.compilationResults.get({ + * // Required. The compilation result's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/compilationResults/my-compilationResult', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "codeCompilationConfig": {}, + * // "compilationErrors": [], + * // "createTime": "my_createTime", + * // "dataEncryptionState": {}, + * // "dataformCoreVersion": "my_dataformCoreVersion", + * // "gitCommitish": "my_gitCommitish", + * // "internalMetadata": "my_internalMetadata", + * // "name": "my_name", + * // "releaseConfig": "my_releaseConfig", + * // "resolvedGitCommitSha": "my_resolvedGitCommitSha", + * // "workspace": "my_workspace" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Repositories$Compilationresults$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Repositories$Compilationresults$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Repositories$Compilationresults$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Repositories$Compilationresults$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Repositories$Compilationresults$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Compilationresults$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Compilationresults$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Compilationresults$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists CompilationResults in a given Repository. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.compilationResults.list({ + * // Optional. Filter for the returned list. + * filter: 'placeholder-value', + * // Optional. This field only supports ordering by `name` and `create_time`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field. + * orderBy: 'placeholder-value', + * // Optional. Maximum number of compilation results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. + * pageSize: 'placeholder-value', + * // Optional. Page token received from a previous `ListCompilationResults` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCompilationResults`, with the exception of `page_size`, must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The repository in which to list compilation results. Must be in the format `projects/x/locations/x/repositories/x`. + * parent: + * 'projects/my-project/locations/my-location/repositories/my-repositorie', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "compilationResults": [], + * // "nextPageToken": "my_nextPageToken", + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Repositories$Compilationresults$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Repositories$Compilationresults$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Repositories$Compilationresults$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Repositories$Compilationresults$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Repositories$Compilationresults$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Compilationresults$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Compilationresults$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Compilationresults$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/compilationResults').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Returns CompilationResultActions in a given CompilationResult. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.compilationResults.query({ + * // Optional. Optional filter for the returned list. Filtering is only currently supported on the `file_path` field. + * filter: 'placeholder-value', + * // Required. The compilation result's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/compilationResults/my-compilationResult', + * // Optional. Maximum number of compilation results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. + * pageSize: 'placeholder-value', + * // Optional. Page token received from a previous `QueryCompilationResultActions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryCompilationResultActions`, with the exception of `page_size`, must match the call that provided the page token. + * pageToken: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "compilationResultActions": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + query( + params: Params$Resource$Projects$Locations$Repositories$Compilationresults$Query, + options: StreamMethodOptions + ): Promise>; + query( + params?: Params$Resource$Projects$Locations$Repositories$Compilationresults$Query, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + query( + params: Params$Resource$Projects$Locations$Repositories$Compilationresults$Query, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + query( + params: Params$Resource$Projects$Locations$Repositories$Compilationresults$Query, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + query( + params: Params$Resource$Projects$Locations$Repositories$Compilationresults$Query, + callback: BodyResponseCallback + ): void; + query( + callback: BodyResponseCallback + ): void; + query( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Compilationresults$Query + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Compilationresults$Query; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Compilationresults$Query; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:query').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Repositories$Compilationresults$Create + extends StandardParameters { + /** + * Required. The repository in which to create the compilation result. Must be in the format `projects/x/locations/x/repositories/x`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CompilationResult; + } + export interface Params$Resource$Projects$Locations$Repositories$Compilationresults$Get + extends StandardParameters { + /** + * Required. The compilation result's name. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Compilationresults$List + extends StandardParameters { + /** + * Optional. Filter for the returned list. + */ + filter?: string; + /** + * Optional. This field only supports ordering by `name` and `create_time`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field. + */ + orderBy?: string; + /** + * Optional. Maximum number of compilation results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous `ListCompilationResults` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCompilationResults`, with the exception of `page_size`, must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The repository in which to list compilation results. Must be in the format `projects/x/locations/x/repositories/x`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Compilationresults$Query + extends StandardParameters { + /** + * Optional. Optional filter for the returned list. Filtering is only currently supported on the `file_path` field. + */ + filter?: string; + /** + * Required. The compilation result's name. + */ + name?: string; + /** + * Optional. Maximum number of compilation results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous `QueryCompilationResultActions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryCompilationResultActions`, with the exception of `page_size`, must match the call that provided the page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Repositories$Releaseconfigs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new ReleaseConfig in a given Repository. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.releaseConfigs.create({ + * // Required. The repository in which to create the release config. Must be in the format `projects/x/locations/x/repositories/x`. + * parent: + * 'projects/my-project/locations/my-location/repositories/my-repositorie', + * // Required. The ID to use for the release config, which will become the final component of the release config's resource name. + * releaseConfigId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "codeCompilationConfig": {}, + * // "cronSchedule": "my_cronSchedule", + * // "disabled": false, + * // "gitCommitish": "my_gitCommitish", + * // "internalMetadata": "my_internalMetadata", + * // "name": "my_name", + * // "recentScheduledReleaseRecords": [], + * // "releaseCompilationResult": "my_releaseCompilationResult", + * // "timeZone": "my_timeZone" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "codeCompilationConfig": {}, + * // "cronSchedule": "my_cronSchedule", + * // "disabled": false, + * // "gitCommitish": "my_gitCommitish", + * // "internalMetadata": "my_internalMetadata", + * // "name": "my_name", + * // "recentScheduledReleaseRecords": [], + * // "releaseCompilationResult": "my_releaseCompilationResult", + * // "timeZone": "my_timeZone" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/releaseConfigs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single ReleaseConfig. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.releaseConfigs.delete({ + * // Required. The release config's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/releaseConfigs/my-releaseConfig', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Fetches a single ReleaseConfig. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await dataform.projects.locations.repositories.releaseConfigs.get( + * { + * // Required. The release config's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/releaseConfigs/my-releaseConfig', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "codeCompilationConfig": {}, + * // "cronSchedule": "my_cronSchedule", + * // "disabled": false, + * // "gitCommitish": "my_gitCommitish", + * // "internalMetadata": "my_internalMetadata", + * // "name": "my_name", + * // "recentScheduledReleaseRecords": [], + * // "releaseCompilationResult": "my_releaseCompilationResult", + * // "timeZone": "my_timeZone" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists ReleaseConfigs in a given Repository. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.releaseConfigs.list({ + * // Optional. Maximum number of release configs to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. + * pageSize: 'placeholder-value', + * // Optional. Page token received from a previous `ListReleaseConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReleaseConfigs`, with the exception of `page_size`, must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The repository in which to list release configs. Must be in the format `projects/x/locations/x/repositories/x`. + * parent: + * 'projects/my-project/locations/my-location/repositories/my-repositorie', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "releaseConfigs": [], + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Releaseconfigs$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Releaseconfigs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Releaseconfigs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/releaseConfigs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates a single ReleaseConfig. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.* + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.releaseConfigs.patch({ + * // Identifier. The release config's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/releaseConfigs/my-releaseConfig', + * // Optional. Specifies the fields to be updated in the release config. If left unset, all fields will be updated. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "codeCompilationConfig": {}, + * // "cronSchedule": "my_cronSchedule", + * // "disabled": false, + * // "gitCommitish": "my_gitCommitish", + * // "internalMetadata": "my_internalMetadata", + * // "name": "my_name", + * // "recentScheduledReleaseRecords": [], + * // "releaseCompilationResult": "my_releaseCompilationResult", + * // "timeZone": "my_timeZone" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "codeCompilationConfig": {}, + * // "cronSchedule": "my_cronSchedule", + * // "disabled": false, + * // "gitCommitish": "my_gitCommitish", + * // "internalMetadata": "my_internalMetadata", + * // "name": "my_name", + * // "recentScheduledReleaseRecords": [], + * // "releaseCompilationResult": "my_releaseCompilationResult", + * // "timeZone": "my_timeZone" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Create + extends StandardParameters { + /** + * Required. The repository in which to create the release config. Must be in the format `projects/x/locations/x/repositories/x`. + */ + parent?: string; + /** + * Required. The ID to use for the release config, which will become the final component of the release config's resource name. + */ + releaseConfigId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ReleaseConfig; + } + export interface Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Delete + extends StandardParameters { + /** + * Required. The release config's name. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Get + extends StandardParameters { + /** + * Required. The release config's name. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Releaseconfigs$List + extends StandardParameters { + /** + * Optional. Maximum number of release configs to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous `ListReleaseConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReleaseConfigs`, with the exception of `page_size`, must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The repository in which to list release configs. Must be in the format `projects/x/locations/x/repositories/x`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Patch + extends StandardParameters { + /** + * Identifier. The release config's name. + */ + name?: string; + /** + * Optional. Specifies the fields to be updated in the release config. If left unset, all fields will be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ReleaseConfig; + } + + export class Resource$Projects$Locations$Repositories$Workflowconfigs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new WorkflowConfig in a given Repository. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.workflowConfigs.create({ + * // Required. The repository in which to create the workflow config. Must be in the format `projects/x/locations/x/repositories/x`. + * parent: + * 'projects/my-project/locations/my-location/repositories/my-repositorie', + * // Required. The ID to use for the workflow config, which will become the final component of the workflow config's resource name. + * workflowConfigId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "cronSchedule": "my_cronSchedule", + * // "disabled": false, + * // "internalMetadata": "my_internalMetadata", + * // "invocationConfig": {}, + * // "name": "my_name", + * // "recentScheduledExecutionRecords": [], + * // "releaseConfig": "my_releaseConfig", + * // "timeZone": "my_timeZone", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "cronSchedule": "my_cronSchedule", + * // "disabled": false, + * // "internalMetadata": "my_internalMetadata", + * // "invocationConfig": {}, + * // "name": "my_name", + * // "recentScheduledExecutionRecords": [], + * // "releaseConfig": "my_releaseConfig", + * // "timeZone": "my_timeZone", + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/workflowConfigs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single WorkflowConfig. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.workflowConfigs.delete({ + * // Required. The workflow config's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowConfigs/my-workflowConfig', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Fetches a single WorkflowConfig. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.workflowConfigs.get({ + * // Required. The workflow config's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowConfigs/my-workflowConfig', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "cronSchedule": "my_cronSchedule", + * // "disabled": false, + * // "internalMetadata": "my_internalMetadata", + * // "invocationConfig": {}, + * // "name": "my_name", + * // "recentScheduledExecutionRecords": [], + * // "releaseConfig": "my_releaseConfig", + * // "timeZone": "my_timeZone", + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists WorkflowConfigs in a given Repository. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.workflowConfigs.list({ + * // Optional. Maximum number of workflow configs to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. + * pageSize: 'placeholder-value', + * // Optional. Page token received from a previous `ListWorkflowConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkflowConfigs`, with the exception of `page_size`, must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The repository in which to list workflow configs. Must be in the format `projects/x/locations/x/repositories/x`. + * parent: + * 'projects/my-project/locations/my-location/repositories/my-repositorie', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "unreachable": [], + * // "workflowConfigs": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Workflowconfigs$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Workflowconfigs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Workflowconfigs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/workflowConfigs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates a single WorkflowConfig. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.* + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.workflowConfigs.patch({ + * // Identifier. The workflow config's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowConfigs/my-workflowConfig', + * // Optional. Specifies the fields to be updated in the workflow config. If left unset, all fields will be updated. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "cronSchedule": "my_cronSchedule", + * // "disabled": false, + * // "internalMetadata": "my_internalMetadata", + * // "invocationConfig": {}, + * // "name": "my_name", + * // "recentScheduledExecutionRecords": [], + * // "releaseConfig": "my_releaseConfig", + * // "timeZone": "my_timeZone", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "cronSchedule": "my_cronSchedule", + * // "disabled": false, + * // "internalMetadata": "my_internalMetadata", + * // "invocationConfig": {}, + * // "name": "my_name", + * // "recentScheduledExecutionRecords": [], + * // "releaseConfig": "my_releaseConfig", + * // "timeZone": "my_timeZone", + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Create + extends StandardParameters { + /** + * Required. The repository in which to create the workflow config. Must be in the format `projects/x/locations/x/repositories/x`. + */ + parent?: string; + /** + * Required. The ID to use for the workflow config, which will become the final component of the workflow config's resource name. + */ + workflowConfigId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$WorkflowConfig; + } + export interface Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Delete + extends StandardParameters { + /** + * Required. The workflow config's name. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Get + extends StandardParameters { + /** + * Required. The workflow config's name. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Workflowconfigs$List + extends StandardParameters { + /** + * Optional. Maximum number of workflow configs to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous `ListWorkflowConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkflowConfigs`, with the exception of `page_size`, must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The repository in which to list workflow configs. Must be in the format `projects/x/locations/x/repositories/x`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Workflowconfigs$Patch + extends StandardParameters { + /** + * Identifier. The workflow config's name. + */ + name?: string; + /** + * Optional. Specifies the fields to be updated in the workflow config. If left unset, all fields will be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$WorkflowConfig; + } + + export class Resource$Projects$Locations$Repositories$Workflowinvocations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Requests cancellation of a running WorkflowInvocation. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.workflowInvocations.cancel({ + * // Required. The workflow invocation resource's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowInvocations/my-workflowInvocation', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Cancel, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + cancel( + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Cancel, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Cancel, + callback: BodyResponseCallback + ): void; + cancel( + callback: BodyResponseCallback + ): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Creates a new WorkflowInvocation in a given Repository. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.workflowInvocations.create({ + * // Required. The repository in which to create the workflow invocation. Must be in the format `projects/x/locations/x/repositories/x`. + * parent: + * 'projects/my-project/locations/my-location/repositories/my-repositorie', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "compilationResult": "my_compilationResult", + * // "dataEncryptionState": {}, + * // "internalMetadata": "my_internalMetadata", + * // "invocationConfig": {}, + * // "invocationTiming": {}, + * // "name": "my_name", + * // "resolvedCompilationResult": "my_resolvedCompilationResult", + * // "state": "my_state", + * // "workflowConfig": "my_workflowConfig" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "compilationResult": "my_compilationResult", + * // "dataEncryptionState": {}, + * // "internalMetadata": "my_internalMetadata", + * // "invocationConfig": {}, + * // "invocationTiming": {}, + * // "name": "my_name", + * // "resolvedCompilationResult": "my_resolvedCompilationResult", + * // "state": "my_state", + * // "workflowConfig": "my_workflowConfig" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/workflowInvocations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single WorkflowInvocation. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.workflowInvocations.delete({ + * // Required. The workflow invocation resource's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowInvocations/my-workflowInvocation', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Fetches a single WorkflowInvocation. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.workflowInvocations.get({ + * // Required. The workflow invocation resource's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowInvocations/my-workflowInvocation', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "compilationResult": "my_compilationResult", + * // "dataEncryptionState": {}, + * // "internalMetadata": "my_internalMetadata", + * // "invocationConfig": {}, + * // "invocationTiming": {}, + * // "name": "my_name", + * // "resolvedCompilationResult": "my_resolvedCompilationResult", + * // "state": "my_state", + * // "workflowConfig": "my_workflowConfig" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists WorkflowInvocations in a given Repository. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.workflowInvocations.list({ + * // Optional. Filter for the returned list. + * filter: 'placeholder-value', + * // Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field. + * orderBy: 'placeholder-value', + * // Optional. Maximum number of workflow invocations to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. + * pageSize: 'placeholder-value', + * // Optional. Page token received from a previous `ListWorkflowInvocations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkflowInvocations`, with the exception of `page_size`, must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The parent resource of the WorkflowInvocation type. Must be in the format `projects/x/locations/x/repositories/x`. + * parent: + * 'projects/my-project/locations/my-location/repositories/my-repositorie', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "unreachable": [], + * // "workflowInvocations": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Workflowinvocations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Workflowinvocations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Workflowinvocations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/workflowInvocations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Returns WorkflowInvocationActions in a given WorkflowInvocation. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.workflowInvocations.query({ + * // Required. The workflow invocation's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workflowInvocations/my-workflowInvocation', + * // Optional. Maximum number of workflow invocations to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. + * pageSize: 'placeholder-value', + * // Optional. Page token received from a previous `QueryWorkflowInvocationActions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryWorkflowInvocationActions`, with the exception of `page_size`, must match the call that provided the page token. + * pageToken: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "workflowInvocationActions": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + query( + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Query, + options: StreamMethodOptions + ): Promise>; + query( + params?: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Query, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + query( + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Query, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + query( + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Query, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + query( + params: Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Query, + callback: BodyResponseCallback + ): void; + query( + callback: BodyResponseCallback + ): void; + query( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Query + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Query; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Query; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:query').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Cancel + extends StandardParameters { + /** + * Required. The workflow invocation resource's name. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CancelWorkflowInvocationRequest; + } + export interface Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Create + extends StandardParameters { + /** + * Required. The repository in which to create the workflow invocation. Must be in the format `projects/x/locations/x/repositories/x`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$WorkflowInvocation; + } + export interface Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Delete + extends StandardParameters { + /** + * Required. The workflow invocation resource's name. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Get + extends StandardParameters { + /** + * Required. The workflow invocation resource's name. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Workflowinvocations$List + extends StandardParameters { + /** + * Optional. Filter for the returned list. + */ + filter?: string; + /** + * Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field. + */ + orderBy?: string; + /** + * Optional. Maximum number of workflow invocations to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous `ListWorkflowInvocations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkflowInvocations`, with the exception of `page_size`, must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent resource of the WorkflowInvocation type. Must be in the format `projects/x/locations/x/repositories/x`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Workflowinvocations$Query + extends StandardParameters { + /** + * Required. The workflow invocation's name. + */ + name?: string; + /** + * Optional. Maximum number of workflow invocations to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous `QueryWorkflowInvocationActions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryWorkflowInvocationActions`, with the exception of `page_size`, must match the call that provided the page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Repositories$Workspaces { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Applies a Git commit for uncommitted files in a Workspace. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await dataform.projects.locations.repositories.workspaces.commit({ + * // Required. The workspace's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "author": {}, + * // "commitMessage": "my_commitMessage", + * // "paths": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + commit( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Commit, + options: StreamMethodOptions + ): Promise>; + commit( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Commit, + options?: MethodOptions + ): Promise>; + commit( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Commit, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + commit( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Commit, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + commit( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Commit, + callback: BodyResponseCallback + ): void; + commit( + callback: BodyResponseCallback + ): void; + commit( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Workspaces$Commit + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Commit; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Commit; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:commit').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Creates a new Workspace in a given Repository. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await dataform.projects.locations.repositories.workspaces.create({ + * // Required. The repository in which to create the workspace. Must be in the format `projects/x/locations/x/repositories/x`. + * parent: + * 'projects/my-project/locations/my-location/repositories/my-repositorie', + * // Required. The ID to use for the workspace, which will become the final component of the workspace's resource name. + * workspaceId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "dataEncryptionState": {}, + * // "internalMetadata": "my_internalMetadata", + * // "name": "my_name" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "dataEncryptionState": {}, + * // "internalMetadata": "my_internalMetadata", + * // "name": "my_name" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Workspaces$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/workspaces').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single Workspace. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await dataform.projects.locations.repositories.workspaces.delete({ + * // Required. The workspace resource's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Workspaces$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Fetches Git diff for an uncommitted file in a Workspace. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.workspaces.fetchFileDiff({ + * // Required. The file's full path including filename, relative to the workspace root. + * path: 'placeholder-value', + * // Required. The workspace's name. + * workspace: + * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "formattedDiff": "my_formattedDiff" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + fetchFileDiff( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff, + options: StreamMethodOptions + ): Promise>; + fetchFileDiff( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff, + options?: MethodOptions + ): Promise>; + fetchFileDiff( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchFileDiff( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchFileDiff( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff, + callback: BodyResponseCallback + ): void; + fetchFileDiff( + callback: BodyResponseCallback + ): void; + fetchFileDiff( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+workspace}:fetchFileDiff').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['workspace'], + pathParams: ['workspace'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Fetches Git statuses for the files in a Workspace. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.workspaces.fetchFileGitStatuses( + * { + * // Required. The workspace's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "uncommittedFileChanges": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + fetchFileGitStatuses( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilegitstatuses, + options: StreamMethodOptions + ): Promise>; + fetchFileGitStatuses( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilegitstatuses, + options?: MethodOptions + ): Promise>; + fetchFileGitStatuses( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilegitstatuses, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchFileGitStatuses( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilegitstatuses, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchFileGitStatuses( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilegitstatuses, + callback: BodyResponseCallback + ): void; + fetchFileGitStatuses( + callback: BodyResponseCallback + ): void; + fetchFileGitStatuses( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilegitstatuses + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilegitstatuses; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilegitstatuses; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:fetchFileGitStatuses').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Fetches Git ahead/behind against a remote branch. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.workspaces.fetchGitAheadBehind( + * { + * // Required. The workspace's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * // Optional. The name of the branch in the Git remote against which this workspace should be compared. If left unset, the repository's default branch name will be used. + * remoteBranch: 'placeholder-value', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "commitsAhead": 0, + * // "commitsBehind": 0 + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + fetchGitAheadBehind( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchgitaheadbehind, + options: StreamMethodOptions + ): Promise>; + fetchGitAheadBehind( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchgitaheadbehind, + options?: MethodOptions + ): Promise>; + fetchGitAheadBehind( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchgitaheadbehind, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchGitAheadBehind( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchgitaheadbehind, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchGitAheadBehind( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchgitaheadbehind, + callback: BodyResponseCallback + ): void; + fetchGitAheadBehind( + callback: BodyResponseCallback + ): void; + fetchGitAheadBehind( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchgitaheadbehind + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchgitaheadbehind; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchgitaheadbehind; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:fetchGitAheadBehind').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Fetches a single Workspace. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await dataform.projects.locations.repositories.workspaces.get({ + * // Required. The workspace's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "dataEncryptionState": {}, + * // "internalMetadata": "my_internalMetadata", + * // "name": "my_name" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Workspaces$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.workspaces.getIamPolicy({ + * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + * 'options.requestedPolicyVersion': 'placeholder-value', + * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Getiampolicy, + options: StreamMethodOptions + ): Promise>; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Getiampolicy, + options?: MethodOptions + ): Promise>; + getIamPolicy( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Workspaces$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Installs dependency NPM packages (inside a Workspace). + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.workspaces.installNpmPackages( + * { + * // Required. The workspace's name. + * workspace: + * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + installNpmPackages( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Installnpmpackages, + options: StreamMethodOptions + ): Promise>; + installNpmPackages( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Installnpmpackages, + options?: MethodOptions + ): Promise>; + installNpmPackages( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Installnpmpackages, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + installNpmPackages( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Installnpmpackages, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + installNpmPackages( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Installnpmpackages, + callback: BodyResponseCallback + ): void; + installNpmPackages( + callback: BodyResponseCallback + ): void; + installNpmPackages( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Workspaces$Installnpmpackages + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Installnpmpackages; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Installnpmpackages; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+workspace}:installNpmPackages').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['workspace'], + pathParams: ['workspace'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists Workspaces in a given Repository. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await dataform.projects.locations.repositories.workspaces.list({ + * // Optional. Filter for the returned list. + * filter: 'placeholder-value', + * // Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field. + * orderBy: 'placeholder-value', + * // Optional. Maximum number of workspaces to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. + * pageSize: 'placeholder-value', + * // Optional. Page token received from a previous `ListWorkspaces` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkspaces`, with the exception of `page_size`, must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The repository in which to list workspaces. Must be in the format `projects/x/locations/x/repositories/x`. + * parent: + * 'projects/my-project/locations/my-location/repositories/my-repositorie', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "unreachable": [], + * // "workspaces": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Workspaces$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/workspaces').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a directory inside a Workspace. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.workspaces.makeDirectory({ + * // Required. The workspace's name. + * workspace: + * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "path": "my_path" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + makeDirectory( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Makedirectory, + options: StreamMethodOptions + ): Promise>; + makeDirectory( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Makedirectory, + options?: MethodOptions + ): Promise>; + makeDirectory( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Makedirectory, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + makeDirectory( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Makedirectory, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + makeDirectory( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Makedirectory, + callback: BodyResponseCallback + ): void; + makeDirectory( + callback: BodyResponseCallback + ): void; + makeDirectory( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Workspaces$Makedirectory + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Makedirectory; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Makedirectory; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+workspace}:makeDirectory').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['workspace'], + pathParams: ['workspace'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Moves a directory (inside a Workspace), and all of its contents, to a new location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.workspaces.moveDirectory({ + * // Required. The workspace's name. + * workspace: + * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "newPath": "my_newPath", + * // "path": "my_path" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + moveDirectory( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Movedirectory, + options: StreamMethodOptions + ): Promise>; + moveDirectory( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Movedirectory, + options?: MethodOptions + ): Promise>; + moveDirectory( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Movedirectory, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + moveDirectory( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Movedirectory, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + moveDirectory( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Movedirectory, + callback: BodyResponseCallback + ): void; + moveDirectory( + callback: BodyResponseCallback + ): void; + moveDirectory( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Workspaces$Movedirectory + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Movedirectory; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Movedirectory; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+workspace}:moveDirectory').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['workspace'], + pathParams: ['workspace'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Moves a file (inside a Workspace) to a new location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.workspaces.moveFile({ + * // Required. The workspace's name. + * workspace: + * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "newPath": "my_newPath", + * // "path": "my_path" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + moveFile( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Movefile, + options: StreamMethodOptions + ): Promise>; + moveFile( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Movefile, + options?: MethodOptions + ): Promise>; + moveFile( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Movefile, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + moveFile( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Movefile, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + moveFile( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Movefile, + callback: BodyResponseCallback + ): void; + moveFile(callback: BodyResponseCallback): void; + moveFile( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Workspaces$Movefile + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Movefile; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Movefile; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+workspace}:moveFile').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['workspace'], + pathParams: ['workspace'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Pulls Git commits from the Repository's remote into a Workspace. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await dataform.projects.locations.repositories.workspaces.pull({ + * // Required. The workspace's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "author": {}, + * // "remoteBranch": "my_remoteBranch" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + pull( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Pull, + options: StreamMethodOptions + ): Promise>; + pull( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Pull, + options?: MethodOptions + ): Promise>; + pull( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Pull, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + pull( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Pull, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + pull( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Pull, + callback: BodyResponseCallback + ): void; + pull(callback: BodyResponseCallback): void; + pull( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Workspaces$Pull + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Pull; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Pull; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:pull').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Pushes Git commits from a Workspace to the Repository's remote. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await dataform.projects.locations.repositories.workspaces.push({ + * // Required. The workspace's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "remoteBranch": "my_remoteBranch" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + push( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Push, + options: StreamMethodOptions + ): Promise>; + push( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Push, + options?: MethodOptions + ): Promise>; + push( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Push, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + push( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Push, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + push( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Push, + callback: BodyResponseCallback + ): void; + push(callback: BodyResponseCallback): void; + push( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Workspaces$Push + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Push; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Push; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:push').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns the contents of a given Workspace directory. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.workspaces.queryDirectoryContents( + * { + * // Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. + * pageSize: 'placeholder-value', + * // Optional. Page token received from a previous `QueryDirectoryContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryDirectoryContents`, with the exception of `page_size`, must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Optional. The directory's full path including directory name, relative to the workspace root. If left unset, the workspace root is used. + * path: 'placeholder-value', + * // Required. The workspace's name. + * workspace: + * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "directoryEntries": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + queryDirectoryContents( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Querydirectorycontents, + options: StreamMethodOptions + ): Promise>; + queryDirectoryContents( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Querydirectorycontents, + options?: MethodOptions + ): Promise>; + queryDirectoryContents( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Querydirectorycontents, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + queryDirectoryContents( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Querydirectorycontents, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + queryDirectoryContents( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Querydirectorycontents, + callback: BodyResponseCallback + ): void; + queryDirectoryContents( + callback: BodyResponseCallback + ): void; + queryDirectoryContents( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Workspaces$Querydirectorycontents + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Querydirectorycontents; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Querydirectorycontents; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+workspace}:queryDirectoryContents').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['workspace'], + pathParams: ['workspace'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Returns the contents of a file (inside a Workspace). + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.workspaces.readFile({ + * // Required. The file's full path including filename, relative to the workspace root. + * path: 'placeholder-value', + * // Optional. The Git revision of the file to return. If left empty, the current contents of `path` will be returned. + * revision: 'placeholder-value', + * // Required. The workspace's name. + * workspace: + * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "fileContents": "my_fileContents" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + readFile( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Readfile, + options: StreamMethodOptions + ): Promise>; + readFile( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Readfile, + options?: MethodOptions + ): Promise>; + readFile( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Readfile, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + readFile( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Readfile, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + readFile( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Readfile, + callback: BodyResponseCallback + ): void; + readFile(callback: BodyResponseCallback): void; + readFile( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Workspaces$Readfile + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Readfile; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Readfile; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+workspace}:readFile').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['workspace'], + pathParams: ['workspace'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a directory (inside a Workspace) and all of its contents. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.workspaces.removeDirectory({ + * // Required. The workspace's name. + * workspace: + * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "path": "my_path" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + removeDirectory( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Removedirectory, + options: StreamMethodOptions + ): Promise>; + removeDirectory( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Removedirectory, + options?: MethodOptions + ): Promise>; + removeDirectory( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Removedirectory, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeDirectory( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Removedirectory, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeDirectory( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Removedirectory, + callback: BodyResponseCallback + ): void; + removeDirectory( + callback: BodyResponseCallback + ): void; + removeDirectory( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Workspaces$Removedirectory + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Removedirectory; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Removedirectory; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+workspace}:removeDirectory').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['workspace'], + pathParams: ['workspace'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a file (inside a Workspace). + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.workspaces.removeFile({ + * // Required. The workspace's name. + * workspace: + * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "path": "my_path" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + removeFile( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Removefile, + options: StreamMethodOptions + ): Promise>; + removeFile( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Removefile, + options?: MethodOptions + ): Promise>; + removeFile( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Removefile, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeFile( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Removefile, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeFile( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Removefile, + callback: BodyResponseCallback + ): void; + removeFile(callback: BodyResponseCallback): void; + removeFile( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Workspaces$Removefile + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Removefile; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Removefile; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+workspace}:removeFile').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['workspace'], + pathParams: ['workspace'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Performs a Git reset for uncommitted files in a Workspace. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await dataform.projects.locations.repositories.workspaces.reset({ + * // Required. The workspace's name. + * name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "clean": false, + * // "paths": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + reset( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Reset, + options: StreamMethodOptions + ): Promise>; + reset( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Reset, + options?: MethodOptions + ): Promise>; + reset( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Reset, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + reset( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Reset, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + reset( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Reset, + callback: BodyResponseCallback + ): void; + reset( + callback: BodyResponseCallback + ): void; + reset( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Workspaces$Reset + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Reset; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Reset; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:reset').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Finds the contents of a given Workspace directory by filter. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.workspaces.searchFiles({ + * // Optional. Optional filter for the returned list in filtering format. Filtering is only currently supported on the `path` field. See https://google.aip.dev/160 for details. + * filter: 'placeholder-value', + * // Optional. Maximum number of search results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. + * pageSize: 'placeholder-value', + * // Optional. Page token received from a previous `SearchFilesRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchFilesRequest`, with the exception of `page_size`, must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The workspace's name. + * workspace: + * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "searchResults": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + searchFiles( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Searchfiles, + options: StreamMethodOptions + ): Promise>; + searchFiles( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Searchfiles, + options?: MethodOptions + ): Promise>; + searchFiles( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Searchfiles, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchFiles( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Searchfiles, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchFiles( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Searchfiles, + callback: BodyResponseCallback + ): void; + searchFiles( + callback: BodyResponseCallback + ): void; + searchFiles( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Workspaces$Searchfiles + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Searchfiles; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Searchfiles; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+workspace}:searchFiles').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['workspace'], + pathParams: ['workspace'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.workspaces.setIamPolicy({ + * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "policy": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Setiampolicy, + options: StreamMethodOptions + ): Promise>; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Setiampolicy, + options?: MethodOptions + ): Promise>; + setIamPolicy( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Workspaces$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.workspaces.testIamPermissions( + * { + * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "permissions": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + testIamPermissions( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Testiampermissions, + options: StreamMethodOptions + ): Promise>; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Testiampermissions, + options?: MethodOptions + ): Promise>; + testIamPermissions( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Workspaces$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Writes to a file (inside a Workspace). + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await dataform.projects.locations.repositories.workspaces.writeFile({ + * // Required. The workspace's name. + * workspace: + * 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "contents": "my_contents", + * // "path": "my_path" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + writeFile( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Writefile, + options: StreamMethodOptions + ): Promise>; + writeFile( + params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Writefile, + options?: MethodOptions + ): Promise>; + writeFile( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Writefile, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + writeFile( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Writefile, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + writeFile( + params: Params$Resource$Projects$Locations$Repositories$Workspaces$Writefile, + callback: BodyResponseCallback + ): void; + writeFile(callback: BodyResponseCallback): void; + writeFile( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Workspaces$Writefile + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Workspaces$Writefile; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Workspaces$Writefile; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+workspace}:writeFile').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['workspace'], + pathParams: ['workspace'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Commit + extends StandardParameters { + /** + * Required. The workspace's name. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CommitWorkspaceChangesRequest; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Create + extends StandardParameters { + /** + * Required. The repository in which to create the workspace. Must be in the format `projects/x/locations/x/repositories/x`. + */ + parent?: string; + /** + * Required. The ID to use for the workspace, which will become the final component of the workspace's resource name. + */ + workspaceId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Workspace; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Delete + extends StandardParameters { + /** + * Required. The workspace resource's name. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff + extends StandardParameters { + /** + * Required. The file's full path including filename, relative to the workspace root. + */ + path?: string; + /** + * Required. The workspace's name. + */ + workspace?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilegitstatuses + extends StandardParameters { + /** + * Required. The workspace's name. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchgitaheadbehind + extends StandardParameters { + /** + * Required. The workspace's name. + */ + name?: string; + /** + * Optional. The name of the branch in the Git remote against which this workspace should be compared. If left unset, the repository's default branch name will be used. + */ + remoteBranch?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Get + extends StandardParameters { + /** + * Required. The workspace's name. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Installnpmpackages + extends StandardParameters { + /** + * Required. The workspace's name. + */ + workspace?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstallNpmPackagesRequest; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$List + extends StandardParameters { + /** + * Optional. Filter for the returned list. + */ + filter?: string; + /** + * Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field. + */ + orderBy?: string; + /** + * Optional. Maximum number of workspaces to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous `ListWorkspaces` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkspaces`, with the exception of `page_size`, must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The repository in which to list workspaces. Must be in the format `projects/x/locations/x/repositories/x`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Makedirectory + extends StandardParameters { + /** + * Required. The workspace's name. + */ + workspace?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$MakeDirectoryRequest; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Movedirectory + extends StandardParameters { + /** + * Required. The workspace's name. + */ + workspace?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$MoveDirectoryRequest; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Movefile + extends StandardParameters { + /** + * Required. The workspace's name. + */ + workspace?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$MoveFileRequest; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Pull + extends StandardParameters { + /** + * Required. The workspace's name. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PullGitCommitsRequest; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Push + extends StandardParameters { + /** + * Required. The workspace's name. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PushGitCommitsRequest; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Querydirectorycontents + extends StandardParameters { + /** + * Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous `QueryDirectoryContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryDirectoryContents`, with the exception of `page_size`, must match the call that provided the page token. + */ + pageToken?: string; + /** + * Optional. The directory's full path including directory name, relative to the workspace root. If left unset, the workspace root is used. + */ + path?: string; + /** + * Required. The workspace's name. + */ + workspace?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Readfile + extends StandardParameters { + /** + * Required. The file's full path including filename, relative to the workspace root. + */ + path?: string; + /** + * Optional. The Git revision of the file to return. If left empty, the current contents of `path` will be returned. + */ + revision?: string; + /** + * Required. The workspace's name. + */ + workspace?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Removedirectory + extends StandardParameters { + /** + * Required. The workspace's name. + */ + workspace?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RemoveDirectoryRequest; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Removefile + extends StandardParameters { + /** + * Required. The workspace's name. + */ + workspace?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RemoveFileRequest; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Reset + extends StandardParameters { + /** + * Required. The workspace's name. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ResetWorkspaceChangesRequest; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Searchfiles + extends StandardParameters { + /** + * Optional. Optional filter for the returned list in filtering format. Filtering is only currently supported on the `path` field. See https://google.aip.dev/160 for details. + */ + filter?: string; + /** + * Optional. Maximum number of search results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous `SearchFilesRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchFilesRequest`, with the exception of `page_size`, must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The workspace's name. + */ + workspace?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Writefile + extends StandardParameters { + /** + * Required. The workspace's name. + */ + workspace?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$WriteFileRequest; + } + + export class Resource$Projects$Locations$Teamfolders { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await dataform.projects.locations.teamFolders.getIamPolicy({ + * // Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + * 'options.requestedPolicyVersion': 'placeholder-value', + * // REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/teamFolders/my-teamFolder', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Projects$Locations$Teamfolders$Getiampolicy, + options: StreamMethodOptions + ): Promise>; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Teamfolders$Getiampolicy, + options?: MethodOptions + ): Promise>; + getIamPolicy( + params: Params$Resource$Projects$Locations$Teamfolders$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Teamfolders$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Teamfolders$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Teamfolders$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Teamfolders$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Teamfolders$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await dataform.projects.locations.teamFolders.setIamPolicy({ + * // REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/teamFolders/my-teamFolder', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "policy": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Locations$Teamfolders$Setiampolicy, + options: StreamMethodOptions + ): Promise>; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Teamfolders$Setiampolicy, + options?: MethodOptions + ): Promise>; + setIamPolicy( + params: Params$Resource$Projects$Locations$Teamfolders$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Teamfolders$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Teamfolders$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Teamfolders$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Teamfolders$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Teamfolders$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/dataform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const dataform = google.dataform('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/bigquery', + * 'https://www.googleapis.com/auth/cloud-platform', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await dataform.projects.locations.teamFolders.testIamPermissions({ + * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/teamFolders/my-teamFolder', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "permissions": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "permissions": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + testIamPermissions( + params: Params$Resource$Projects$Locations$Teamfolders$Testiampermissions, + options: StreamMethodOptions + ): Promise>; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Teamfolders$Testiampermissions, + options?: MethodOptions + ): Promise>; + testIamPermissions( + params: Params$Resource$Projects$Locations$Teamfolders$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Teamfolders$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Teamfolders$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Teamfolders$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Teamfolders$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Teamfolders$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Teamfolders$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Teamfolders$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Teamfolders$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } +} diff --git a/src/apis/dataplex/v1.ts b/src/apis/dataplex/v1.ts index 17e455ee7e..ad924842df 100644 --- a/src/apis/dataplex/v1.ts +++ b/src/apis/dataplex/v1.ts @@ -1463,6 +1463,10 @@ export namespace dataplex_v1 { * The output of a DataQualityScan. */ export interface Schema$GoogleCloudDataplexV1DataQualityResult { + /** + * Output only. The generated assets for anomaly detection. + */ + anomalyDetectionGeneratedAssets?: Schema$GoogleCloudDataplexV1DataQualityResultAnomalyDetectionGeneratedAssets; /** * Output only. The status of publishing the data scan as Dataplex Universal Catalog metadata. */ @@ -1500,6 +1504,27 @@ export namespace dataplex_v1 { */ score?: number | null; } + /** + * The assets generated by Anomaly Detection Data Scan. + */ + export interface Schema$GoogleCloudDataplexV1DataQualityResultAnomalyDetectionGeneratedAssets { + /** + * Output only. The intermediate table for data anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID + */ + dataIntermediateTable?: string | null; + /** + * Output only. The intermediate table for freshness anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID + */ + freshnessIntermediateTable?: string | null; + /** + * Output only. The result table for anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID If the result table is set at AnomalyDetectionAssets, the result table here would be the same as the one set in the AnomalyDetectionAssets.result_table. + */ + resultTable?: string | null; + /** + * Output only. The intermediate table for volume anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID + */ + volumeIntermediateTable?: string | null; + } /** * The result of post scan actions of DataQualityScan job. */ @@ -7188,7 +7213,7 @@ export namespace dataplex_v1 { * * // Do the magic * const res = await dataplex.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160). * filter: 'placeholder-value', @@ -7642,7 +7667,7 @@ export namespace dataplex_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/dataproc/v1.ts b/src/apis/dataproc/v1.ts index 226162c452..7c78ede211 100644 --- a/src/apis/dataproc/v1.ts +++ b/src/apis/dataproc/v1.ts @@ -2733,7 +2733,7 @@ export namespace dataproc_v1 { */ export interface Schema$PySparkJob { /** - * Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip. + * Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.Note: Spark applications must be deployed in cluster mode (https://spark.apache.org/docs/latest/cluster-overview.html) for correct environment propagation. */ archiveUris?: string[] | null; /** diff --git a/src/apis/datastream/v1.ts b/src/apis/datastream/v1.ts index 0bbb80d6a0..ba408c187b 100644 --- a/src/apis/datastream/v1.ts +++ b/src/apis/datastream/v1.ts @@ -525,6 +525,15 @@ export namespace datastream_v1 { */ reason?: string | null; } + /** + * Represents a filter for included data on a stream object. + */ + export interface Schema$EventFilter { + /** + * An SQL-query Where clause selecting which data should be included, not including the "WHERE" keyword. E.g., "t.key1 = 'value1' AND t.key2 = 'value2'". + */ + sqlWhereClause?: string | null; + } /** * Response message for a 'FetchStaticIps' response. */ @@ -673,6 +682,10 @@ export namespace datastream_v1 { * A list of operations that matches the specified filter in the request. */ operations?: Schema$Operation[]; + /** + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; } /** * Response containing a list of private connection configurations. @@ -798,7 +811,7 @@ export namespace datastream_v1 { */ export interface Schema$MongodbChangeStreamPosition { /** - * Required. The timestamp (in epoch seconds) to start change stream from. + * Required. The timestamp to start change stream from. */ startTime?: string | null; } @@ -2156,7 +2169,12 @@ export namespace datastream_v1 { /** * Request for manually initiating a backfill job for a specific stream object. */ - export interface Schema$StartBackfillJobRequest {} + export interface Schema$StartBackfillJobRequest { + /** + * Optional. Optional event filter. If not set, or empty, the backfill will be performed on the entire object. This is currently used for partial backfill and only supported for SQL Server sources. + */ + eventFilter?: Schema$EventFilter; + } /** * Response for manually initiating a backfill job for a specific stream object. */ @@ -4431,13 +4449,16 @@ export namespace datastream_v1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -4583,6 +4604,10 @@ export namespace datastream_v1 { * The standard list page token. */ pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Privateconnections { @@ -7471,7 +7496,9 @@ export namespace datastream_v1 { * // Request body metadata * requestBody: { * // request body parameters - * // {} + * // { + * // "eventFilter": {} + * // } * }, * }); * console.log(res.data); diff --git a/src/apis/datastream/v1alpha1.ts b/src/apis/datastream/v1alpha1.ts index 5407ae0649..18099711ba 100644 --- a/src/apis/datastream/v1alpha1.ts +++ b/src/apis/datastream/v1alpha1.ts @@ -454,6 +454,10 @@ export namespace datastream_v1alpha1 { * A list of operations that matches the specified filter in the request. */ operations?: Schema$Operation[]; + /** + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; } export interface Schema$ListPrivateConnectionsResponse { /** @@ -3175,13 +3179,16 @@ export namespace datastream_v1alpha1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -3327,6 +3334,10 @@ export namespace datastream_v1alpha1 { * The standard list page token. */ pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Privateconnections { diff --git a/src/apis/developerconnect/v1.ts b/src/apis/developerconnect/v1.ts index 97439e6274..ee8e452639 100644 --- a/src/apis/developerconnect/v1.ts +++ b/src/apis/developerconnect/v1.ts @@ -161,6 +161,23 @@ export namespace developerconnect_v1 { */ updateTime?: string | null; } + /** + * AppHubService represents the App Hub Service. + */ + export interface Schema$AppHubService { + /** + * Required. Output only. Immutable. The name of the App Hub Service. Format: `projects/{project\}/locations/{location\}/applications/{application\}/services/{service\}`. + */ + apphubService?: string | null; + /** + * Output only. The criticality of the App Hub Service. + */ + criticality?: string | null; + /** + * Output only. The environment of the App Hub Service. + */ + environment?: string | null; + } /** * AppHubWorkload represents the App Hub Workload. */ @@ -675,6 +692,15 @@ export namespace developerconnect_v1 { */ projectId?: string | null; } + /** + * GoogleCloudRun represents the Cloud Run runtime. + */ + export interface Schema$GoogleCloudRun { + /** + * Required. Immutable. The name of the Cloud Run service. Format: `projects/{project\}/locations/{location\}/services/{service\}`. + */ + serviceUri?: string | null; + } /** * 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. */ @@ -1057,6 +1083,10 @@ export namespace developerconnect_v1 { * RuntimeConfig represents the runtimes where the application is deployed. */ export interface Schema$RuntimeConfig { + /** + * Output only. App Hub Service. + */ + appHubService?: Schema$AppHubService; /** * Output only. App Hub Workload. */ @@ -1065,6 +1095,10 @@ export namespace developerconnect_v1 { * Output only. Google Kubernetes Engine runtime. */ gkeWorkload?: Schema$GKEWorkload; + /** + * Output only. Cloud Run runtime. + */ + googleCloudRun?: Schema$GoogleCloudRun; /** * Output only. The state of the Runtime. */ diff --git a/src/apis/dialogflow/v2.ts b/src/apis/dialogflow/v2.ts index a413e9fca7..609c830bd9 100644 --- a/src/apis/dialogflow/v2.ts +++ b/src/apis/dialogflow/v2.ts @@ -1834,6 +1834,10 @@ export namespace dialogflow_v2 { key: string ]: Schema$GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceSecretVersionHeaderValue; } | null; + /** + * Optional. Configuration for service account authentication. + */ + serviceAccountAuthConfig?: Schema$GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceServiceAccountAuthConfig; /** * Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header. */ @@ -1885,6 +1889,15 @@ export namespace dialogflow_v2 { */ secretVersion?: string | null; } + /** + * Configuration for authentication using a service account. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceServiceAccountAuthConfig { + /** + * Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). + */ + serviceAccount?: string | null; + } /** * The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored. */ @@ -3523,6 +3536,10 @@ export namespace dialogflow_v2 { key: string ]: Schema$GoogleCloudDialogflowCxV3WebhookGenericWebServiceSecretVersionHeaderValue; } | null; + /** + * Optional. Configuration for service account authentication. + */ + serviceAccountAuthConfig?: Schema$GoogleCloudDialogflowCxV3WebhookGenericWebServiceServiceAccountAuthConfig; /** * Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header. */ @@ -3574,6 +3591,15 @@ export namespace dialogflow_v2 { */ secretVersion?: string | null; } + /** + * Configuration for authentication using a service account. + */ + export interface Schema$GoogleCloudDialogflowCxV3WebhookGenericWebServiceServiceAccountAuthConfig { + /** + * Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). + */ + serviceAccount?: string | null; + } /** * The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored. */ @@ -11542,7 +11568,7 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2ToolTLSConfigCACert { /** - * Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + * Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` */ cert?: string | null; /** @@ -34496,7 +34522,7 @@ export namespace dialogflow_v2 { * * // Do the magic * const res = await dialogflow.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -34831,7 +34857,7 @@ export namespace dialogflow_v2 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/dialogflow/v2beta1.ts b/src/apis/dialogflow/v2beta1.ts index 29c667bd0f..99688e3510 100644 --- a/src/apis/dialogflow/v2beta1.ts +++ b/src/apis/dialogflow/v2beta1.ts @@ -1834,6 +1834,10 @@ export namespace dialogflow_v2beta1 { key: string ]: Schema$GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceSecretVersionHeaderValue; } | null; + /** + * Optional. Configuration for service account authentication. + */ + serviceAccountAuthConfig?: Schema$GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceServiceAccountAuthConfig; /** * Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header. */ @@ -1885,6 +1889,15 @@ export namespace dialogflow_v2beta1 { */ secretVersion?: string | null; } + /** + * Configuration for authentication using a service account. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceServiceAccountAuthConfig { + /** + * Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). + */ + serviceAccount?: string | null; + } /** * The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored. */ @@ -3523,6 +3536,10 @@ export namespace dialogflow_v2beta1 { key: string ]: Schema$GoogleCloudDialogflowCxV3WebhookGenericWebServiceSecretVersionHeaderValue; } | null; + /** + * Optional. Configuration for service account authentication. + */ + serviceAccountAuthConfig?: Schema$GoogleCloudDialogflowCxV3WebhookGenericWebServiceServiceAccountAuthConfig; /** * Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header. */ @@ -3574,6 +3591,15 @@ export namespace dialogflow_v2beta1 { */ secretVersion?: string | null; } + /** + * Configuration for authentication using a service account. + */ + export interface Schema$GoogleCloudDialogflowCxV3WebhookGenericWebServiceServiceAccountAuthConfig { + /** + * Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). + */ + serviceAccount?: string | null; + } /** * The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored. */ @@ -9802,7 +9828,7 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2beta1ToolTLSConfigCACert { /** - * Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") + * Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ``` */ cert?: string | null; /** @@ -33284,7 +33310,7 @@ export namespace dialogflow_v2beta1 { * * // Do the magic * const res = await dialogflow.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -33623,7 +33649,7 @@ export namespace dialogflow_v2beta1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/dialogflow/v3.ts b/src/apis/dialogflow/v3.ts index 5476a0a6b7..3c272c615c 100644 --- a/src/apis/dialogflow/v3.ts +++ b/src/apis/dialogflow/v3.ts @@ -2120,6 +2120,10 @@ export namespace dialogflow_v3 { key: string ]: Schema$GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceSecretVersionHeaderValue; } | null; + /** + * Optional. Configuration for service account authentication. + */ + serviceAccountAuthConfig?: Schema$GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceServiceAccountAuthConfig; /** * Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header. */ @@ -2171,6 +2175,15 @@ export namespace dialogflow_v3 { */ secretVersion?: string | null; } + /** + * Configuration for authentication using a service account. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceServiceAccountAuthConfig { + /** + * Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). + */ + serviceAccount?: string | null; + } /** * The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored. */ @@ -2482,6 +2495,15 @@ export namespace dialogflow_v3 { */ userEmail?: string | null; } + /** + * Represents a code block. + */ + export interface Schema$GoogleCloudDialogflowCxV3CodeBlock { + /** + * Optional. Source code of the block in Python. + */ + code?: string | null; + } /** * The request message for Versions.CompareVersions. */ @@ -5030,6 +5052,10 @@ export namespace dialogflow_v3 { * Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result. */ export interface Schema$GoogleCloudDialogflowCxV3Playbook { + /** + * Optional. The playbook's scoped code block, which may implement handlers and actions. + */ + codeBlock?: Schema$GoogleCloudDialogflowCxV3CodeBlock; /** * Output only. The timestamp of initial playbook creation. */ @@ -5046,6 +5072,10 @@ export namespace dialogflow_v3 { * Optional. A list of registered handlers to execuate based on the specified triggers. */ handlers?: Schema$GoogleCloudDialogflowCxV3Handler[]; + /** + * Optional. Output only. Names of inline actions scoped to this playbook. These actions are in addition to those belonging to referenced tools, child playbooks, and flows, e.g. actions that are defined in the playbook's code block. + */ + inlineActions?: string[] | null; /** * Optional. Defined structured input parameters for this playbook. */ @@ -6159,6 +6189,10 @@ export namespace dialogflow_v3 { * Config for OAuth. */ oauthConfig?: Schema$GoogleCloudDialogflowCxV3ToolAuthenticationOAuthConfig; + /** + * Configuration for service account authentication. + */ + serviceAccountAuthConfig?: Schema$GoogleCloudDialogflowCxV3ToolAuthenticationServiceAccountAuthConfig; /** * Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth. */ @@ -6227,6 +6261,15 @@ export namespace dialogflow_v3 { */ tokenEndpoint?: string | null; } + /** + * Configuration for authentication using a service account. + */ + export interface Schema$GoogleCloudDialogflowCxV3ToolAuthenticationServiceAccountAuthConfig { + /** + * Required. The email address of the service account used to authenticate the tool call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the tool request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). + */ + serviceAccount?: string | null; + } /** * Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). */ @@ -6844,6 +6887,10 @@ export namespace dialogflow_v3 { key: string ]: Schema$GoogleCloudDialogflowCxV3WebhookGenericWebServiceSecretVersionHeaderValue; } | null; + /** + * Optional. Configuration for service account authentication. + */ + serviceAccountAuthConfig?: Schema$GoogleCloudDialogflowCxV3WebhookGenericWebServiceServiceAccountAuthConfig; /** * Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header. */ @@ -6895,6 +6942,15 @@ export namespace dialogflow_v3 { */ secretVersion?: string | null; } + /** + * Configuration for authentication using a service account. + */ + export interface Schema$GoogleCloudDialogflowCxV3WebhookGenericWebServiceServiceAccountAuthConfig { + /** + * Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). + */ + serviceAccount?: string | null; + } /** * The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored. */ @@ -11683,7 +11739,7 @@ export namespace dialogflow_v3 { * * // Do the magic * const res = await dialogflow.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -11819,7 +11875,7 @@ export namespace dialogflow_v3 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** @@ -26984,10 +27040,12 @@ export namespace dialogflow_v3 { * requestBody: { * // request body parameters * // { + * // "codeBlock": {}, * // "createTime": "my_createTime", * // "displayName": "my_displayName", * // "goal": "my_goal", * // "handlers": [], + * // "inlineActions": [], * // "inputParameterDefinitions": [], * // "instruction": {}, * // "llmModelSettings": {}, @@ -27006,10 +27064,12 @@ export namespace dialogflow_v3 { * * // Example response * // { + * // "codeBlock": {}, * // "createTime": "my_createTime", * // "displayName": "my_displayName", * // "goal": "my_goal", * // "handlers": [], + * // "inlineActions": [], * // "inputParameterDefinitions": [], * // "instruction": {}, * // "llmModelSettings": {}, @@ -27462,10 +27522,12 @@ export namespace dialogflow_v3 { * * // Example response * // { + * // "codeBlock": {}, * // "createTime": "my_createTime", * // "displayName": "my_displayName", * // "goal": "my_goal", * // "handlers": [], + * // "inlineActions": [], * // "inputParameterDefinitions": [], * // "instruction": {}, * // "llmModelSettings": {}, @@ -27939,10 +28001,12 @@ export namespace dialogflow_v3 { * requestBody: { * // request body parameters * // { + * // "codeBlock": {}, * // "createTime": "my_createTime", * // "displayName": "my_displayName", * // "goal": "my_goal", * // "handlers": [], + * // "inlineActions": [], * // "inputParameterDefinitions": [], * // "instruction": {}, * // "llmModelSettings": {}, @@ -27961,10 +28025,12 @@ export namespace dialogflow_v3 { * * // Example response * // { + * // "codeBlock": {}, * // "createTime": "my_createTime", * // "displayName": "my_displayName", * // "goal": "my_goal", * // "handlers": [], + * // "inlineActions": [], * // "inputParameterDefinitions": [], * // "instruction": {}, * // "llmModelSettings": {}, diff --git a/src/apis/dialogflow/v3beta1.ts b/src/apis/dialogflow/v3beta1.ts index 1f254b65ba..829a515fc0 100644 --- a/src/apis/dialogflow/v3beta1.ts +++ b/src/apis/dialogflow/v3beta1.ts @@ -980,6 +980,15 @@ export namespace dialogflow_v3beta1 { */ userEmail?: string | null; } + /** + * Represents a code block. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1CodeBlock { + /** + * Optional. Source code of the block in Python. + */ + code?: string | null; + } /** * The request message for Versions.CompareVersions. */ @@ -3933,6 +3942,10 @@ export namespace dialogflow_v3beta1 { * Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result. */ export interface Schema$GoogleCloudDialogflowCxV3beta1Playbook { + /** + * Optional. The playbook's scoped code block, which may implement handlers and actions. + */ + codeBlock?: Schema$GoogleCloudDialogflowCxV3beta1CodeBlock; /** * Output only. The timestamp of initial playbook creation. */ @@ -3949,6 +3962,10 @@ export namespace dialogflow_v3beta1 { * Optional. A list of registered handlers to execute based on the specified triggers. */ handlers?: Schema$GoogleCloudDialogflowCxV3beta1Handler[]; + /** + * Optional. Output only. Names of inline actions scoped to this playbook. These actions are in addition to those belonging to referenced tools, child playbooks, and flows, e.g. actions that are defined in the playbook's code block. + */ + inlineActions?: string[] | null; /** * Optional. Defined structured input parameters for this playbook. */ @@ -5146,6 +5163,10 @@ export namespace dialogflow_v3beta1 { * Config for OAuth. */ oauthConfig?: Schema$GoogleCloudDialogflowCxV3beta1ToolAuthenticationOAuthConfig; + /** + * Configuration for service account authentication. + */ + serviceAccountAuthConfig?: Schema$GoogleCloudDialogflowCxV3beta1ToolAuthenticationServiceAccountAuthConfig; /** * Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth. */ @@ -5214,6 +5235,15 @@ export namespace dialogflow_v3beta1 { */ tokenEndpoint?: string | null; } + /** + * Configuration for authentication using a service account. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ToolAuthenticationServiceAccountAuthConfig { + /** + * Required. The email address of the service account used to authenticate the tool call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the tool request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). + */ + serviceAccount?: string | null; + } /** * Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). */ @@ -5968,6 +5998,10 @@ export namespace dialogflow_v3beta1 { key: string ]: Schema$GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceSecretVersionHeaderValue; } | null; + /** + * Optional. Configuration for service account authentication. + */ + serviceAccountAuthConfig?: Schema$GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceServiceAccountAuthConfig; /** * Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header. */ @@ -6019,6 +6053,15 @@ export namespace dialogflow_v3beta1 { */ secretVersion?: string | null; } + /** + * Configuration for authentication using a service account. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceServiceAccountAuthConfig { + /** + * Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). + */ + serviceAccount?: string | null; + } /** * The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored. */ @@ -7657,6 +7700,10 @@ export namespace dialogflow_v3beta1 { key: string ]: Schema$GoogleCloudDialogflowCxV3WebhookGenericWebServiceSecretVersionHeaderValue; } | null; + /** + * Optional. Configuration for service account authentication. + */ + serviceAccountAuthConfig?: Schema$GoogleCloudDialogflowCxV3WebhookGenericWebServiceServiceAccountAuthConfig; /** * Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header. */ @@ -7708,6 +7755,15 @@ export namespace dialogflow_v3beta1 { */ secretVersion?: string | null; } + /** + * Configuration for authentication using a service account. + */ + export interface Schema$GoogleCloudDialogflowCxV3WebhookGenericWebServiceServiceAccountAuthConfig { + /** + * Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). + */ + serviceAccount?: string | null; + } /** * The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored. */ @@ -12496,7 +12552,7 @@ export namespace dialogflow_v3beta1 { * * // Do the magic * const res = await dialogflow.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -12632,7 +12688,7 @@ export namespace dialogflow_v3beta1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** @@ -28366,10 +28422,12 @@ export namespace dialogflow_v3beta1 { * requestBody: { * // request body parameters * // { + * // "codeBlock": {}, * // "createTime": "my_createTime", * // "displayName": "my_displayName", * // "goal": "my_goal", * // "handlers": [], + * // "inlineActions": [], * // "inputParameterDefinitions": [], * // "instruction": {}, * // "llmModelSettings": {}, @@ -28389,10 +28447,12 @@ export namespace dialogflow_v3beta1 { * * // Example response * // { + * // "codeBlock": {}, * // "createTime": "my_createTime", * // "displayName": "my_displayName", * // "goal": "my_goal", * // "handlers": [], + * // "inlineActions": [], * // "inputParameterDefinitions": [], * // "instruction": {}, * // "llmModelSettings": {}, @@ -28849,10 +28909,12 @@ export namespace dialogflow_v3beta1 { * * // Example response * // { + * // "codeBlock": {}, * // "createTime": "my_createTime", * // "displayName": "my_displayName", * // "goal": "my_goal", * // "handlers": [], + * // "inlineActions": [], * // "inputParameterDefinitions": [], * // "instruction": {}, * // "llmModelSettings": {}, @@ -29327,10 +29389,12 @@ export namespace dialogflow_v3beta1 { * requestBody: { * // request body parameters * // { + * // "codeBlock": {}, * // "createTime": "my_createTime", * // "displayName": "my_displayName", * // "goal": "my_goal", * // "handlers": [], + * // "inlineActions": [], * // "inputParameterDefinitions": [], * // "instruction": {}, * // "llmModelSettings": {}, @@ -29350,10 +29414,12 @@ export namespace dialogflow_v3beta1 { * * // Example response * // { + * // "codeBlock": {}, * // "createTime": "my_createTime", * // "displayName": "my_displayName", * // "goal": "my_goal", * // "handlers": [], + * // "inlineActions": [], * // "inputParameterDefinitions": [], * // "instruction": {}, * // "llmModelSettings": {}, diff --git a/src/apis/discoveryengine/v1.ts b/src/apis/discoveryengine/v1.ts index 494cb2e65a..a98cf45284 100644 --- a/src/apis/discoveryengine/v1.ts +++ b/src/apis/discoveryengine/v1.ts @@ -2724,6 +2724,10 @@ export namespace discoveryengine_v1 { * Optional. Configuration for configurable billing approach. See */ configurableBillingApproach?: string | null; + /** + * Output only. The timestamp when configurable_billing_approach was last updated. + */ + configurableBillingApproachUpdateTime?: string | null; /** * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */ @@ -2969,6 +2973,19 @@ export namespace discoveryengine_v1 { */ updateTime?: string | null; } + /** + * Metadata related to the progress of the UserStoreService.DeleteUserStore operation. This will be returned by the google.longrunning.Operation.metadata field. Delete UserStore will delete all the end users under the user store, return the number of end users successfully deleted or failed to delete in the metadata. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaDeleteUserStoreMetadata { + /** + * The number of end users under the user store that failed to be deleted. + */ + failureCount?: string | null; + /** + * The number of end users under the user store that were successfully deleted. + */ + successCount?: string | null; + } /** * Defines target endpoints used to connect to third-party sources. */ @@ -4009,6 +4026,10 @@ export namespace discoveryengine_v1 { * Metadata and configurations for a Google Cloud project in the service. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaProject { + /** + * Output only. The current status of the project's configurable billing. + */ + configurableBillingStatus?: Schema$GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus; /** * Output only. The timestamp when this project is created. */ @@ -4034,6 +4055,23 @@ export namespace discoveryengine_v1 { ]: Schema$GoogleCloudDiscoveryengineV1alphaProjectServiceTerms; } | null; } + /** + * Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month). + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus { + /** + * Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations. + */ + effectiveIndexingCoreThreshold?: string | null; + /** + * Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations. + */ + effectiveSearchQpmThreshold?: string | null; + /** + * Optional. The start time of the currently active billing subscription. + */ + startTime?: string | null; + } /** * Customer provided configurations. */ @@ -4051,6 +4089,10 @@ export namespace discoveryengine_v1 { * Model Armor configuration to be used for sanitizing user prompts and LLM responses. */ modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig; + /** + * Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified. + */ + optOutNotebookSharing?: boolean | null; } /** * Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses. @@ -7276,6 +7318,10 @@ export namespace discoveryengine_v1 { * Optional. Configuration for configurable billing approach. See */ configurableBillingApproach?: string | null; + /** + * Output only. The timestamp when configurable_billing_approach was last updated. + */ + configurableBillingApproachUpdateTime?: string | null; /** * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */ @@ -8282,6 +8328,10 @@ export namespace discoveryengine_v1 { * Metadata and configurations for a Google Cloud project in the service. */ export interface Schema$GoogleCloudDiscoveryengineV1betaProject { + /** + * Output only. The current status of the project's configurable billing. + */ + configurableBillingStatus?: Schema$GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus; /** * Output only. The timestamp when this project is created. */ @@ -8305,6 +8355,23 @@ export namespace discoveryengine_v1 { [key: string]: Schema$GoogleCloudDiscoveryengineV1betaProjectServiceTerms; } | null; } + /** + * Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month). + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus { + /** + * Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations. + */ + effectiveIndexingCoreThreshold?: string | null; + /** + * Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations. + */ + effectiveSearchQpmThreshold?: string | null; + /** + * Optional. The start time of the currently active billing subscription. + */ + startTime?: string | null; + } /** * Customer provided configurations. */ @@ -8322,6 +8389,10 @@ export namespace discoveryengine_v1 { * Model Armor configuration to be used for sanitizing user prompts and LLM responses. */ modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig; + /** + * Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified. + */ + optOutNotebookSharing?: boolean | null; } /** * Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses. @@ -9382,6 +9453,31 @@ export namespace discoveryengine_v1 { */ userProfile?: string | null; } + /** + * Configures metadata that is used for End User entities. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaUserStore { + /** + * Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured. + */ + defaultLicenseConfig?: string | null; + /** + * The display name of the User Store. + */ + displayName?: string | null; + /** + * Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left. + */ + enableExpiredLicenseAutoUpdate?: boolean | null; + /** + * Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left. + */ + enableLicenseAutoRegister?: boolean | null; + /** + * Immutable. The full resource name of the User Store, in the format of `projects/{project\}/locations/{location\}/userStores/{user_store\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string | null; + } /** * Config to store data store type configuration for workspace data */ @@ -10642,6 +10738,10 @@ export namespace discoveryengine_v1 { * Optional. Configuration for configurable billing approach. See */ configurableBillingApproach?: string | null; + /** + * Output only. The timestamp when configurable_billing_approach was last updated. + */ + configurableBillingApproachUpdateTime?: string | null; /** * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */ @@ -12271,6 +12371,10 @@ export namespace discoveryengine_v1 { * Metadata and configurations for a Google Cloud project in the service. */ export interface Schema$GoogleCloudDiscoveryengineV1Project { + /** + * Output only. The current status of the project's configurable billing. + */ + configurableBillingStatus?: Schema$GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus; /** * Output only. The timestamp when this project is created. */ @@ -12294,6 +12398,23 @@ export namespace discoveryengine_v1 { [key: string]: Schema$GoogleCloudDiscoveryengineV1ProjectServiceTerms; } | null; } + /** + * Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month). + */ + export interface Schema$GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus { + /** + * Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations. + */ + effectiveIndexingCoreThreshold?: string | null; + /** + * Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations. + */ + effectiveSearchQpmThreshold?: string | null; + /** + * Optional. The start time of the currently active billing subscription. + */ + startTime?: string | null; + } /** * Customer provided configurations. */ @@ -12311,6 +12432,10 @@ export namespace discoveryengine_v1 { * Model Armor configuration to be used for sanitizing user prompts and LLM responses. */ modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig; + /** + * Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified. + */ + optOutNotebookSharing?: boolean | null; } /** * Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses. @@ -14410,6 +14535,31 @@ export namespace discoveryengine_v1 { */ userProfile?: string | null; } + /** + * Configures metadata that is used for End User entities. + */ + export interface Schema$GoogleCloudDiscoveryengineV1UserStore { + /** + * Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured. + */ + defaultLicenseConfig?: string | null; + /** + * The display name of the User Store. + */ + displayName?: string | null; + /** + * Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left. + */ + enableExpiredLicenseAutoUpdate?: boolean | null; + /** + * Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left. + */ + enableLicenseAutoRegister?: boolean | null; + /** + * Immutable. The full resource name of the User Store, in the format of `projects/{project\}/locations/{location\}/userStores/{user_store\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string | null; + } /** * Config to store data store type configuration for workspace data */ @@ -18095,6 +18245,7 @@ export namespace discoveryengine_v1 { * // "billingEstimation": {}, * // "cmekConfig": {}, * // "configurableBillingApproach": "my_configurableBillingApproach", + * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -18421,6 +18572,7 @@ export namespace discoveryengine_v1 { * // "billingEstimation": {}, * // "cmekConfig": {}, * // "configurableBillingApproach": "my_configurableBillingApproach", + * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -18905,6 +19057,7 @@ export namespace discoveryengine_v1 { * // "billingEstimation": {}, * // "cmekConfig": {}, * // "configurableBillingApproach": "my_configurableBillingApproach", + * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -18932,6 +19085,7 @@ export namespace discoveryengine_v1 { * // "billingEstimation": {}, * // "cmekConfig": {}, * // "configurableBillingApproach": "my_configurableBillingApproach", + * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -39642,6 +39796,7 @@ export namespace discoveryengine_v1 { * // "billingEstimation": {}, * // "cmekConfig": {}, * // "configurableBillingApproach": "my_configurableBillingApproach", + * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -39964,6 +40119,7 @@ export namespace discoveryengine_v1 { * // "billingEstimation": {}, * // "cmekConfig": {}, * // "configurableBillingApproach": "my_configurableBillingApproach", + * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -40441,6 +40597,7 @@ export namespace discoveryengine_v1 { * // "billingEstimation": {}, * // "cmekConfig": {}, * // "configurableBillingApproach": "my_configurableBillingApproach", + * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -40468,6 +40625,7 @@ export namespace discoveryengine_v1 { * // "billingEstimation": {}, * // "cmekConfig": {}, * // "configurableBillingApproach": "my_configurableBillingApproach", + * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -55993,6 +56151,639 @@ export namespace discoveryengine_v1 { return createAPIRequest(parameters); } } + + /** + * Creates a new User Store. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await discoveryengine.projects.locations.userStores.create({ + * // Required. The parent collection resource name, such as `projects/{project\}/locations/{location\}`. + * parent: 'projects/my-project/locations/my-location', + * // Required. The ID of the User Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters. + * userStoreId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "defaultLicenseConfig": "my_defaultLicenseConfig", + * // "displayName": "my_displayName", + * // "enableExpiredLicenseAutoUpdate": false, + * // "enableLicenseAutoRegister": false, + * // "name": "my_name" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "defaultLicenseConfig": "my_defaultLicenseConfig", + * // "displayName": "my_displayName", + * // "enableExpiredLicenseAutoUpdate": false, + * // "enableLicenseAutoRegister": false, + * // "name": "my_name" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Userstores$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Userstores$Create, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Userstores$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Userstores$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Userstores$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Userstores$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Userstores$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Userstores$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/userStores').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Deletes the User Store. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await discoveryengine.projects.locations.userStores.delete({ + * // Required. The name of the User Store to delete. Format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}` + * name: 'projects/my-project/locations/my-location/userStores/my-userStore', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Userstores$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Userstores$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Userstores$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Userstores$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Userstores$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Userstores$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Userstores$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Userstores$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the User Store. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await discoveryengine.projects.locations.userStores.get({ + * // Required. The name of the User Store to get. Format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}` + * name: 'projects/my-project/locations/my-location/userStores/my-userStore', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "defaultLicenseConfig": "my_defaultLicenseConfig", + * // "displayName": "my_displayName", + * // "enableExpiredLicenseAutoUpdate": false, + * // "enableLicenseAutoRegister": false, + * // "name": "my_name" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Userstores$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Userstores$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Userstores$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Userstores$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Userstores$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Userstores$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Userstores$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Userstores$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates the User Store. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await discoveryengine.projects.locations.userStores.patch({ + * // Immutable. The full resource name of the User Store, in the format of `projects/{project\}/locations/{location\}/userStores/{user_store\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * name: 'projects/my-project/locations/my-location/userStores/my-userStore', + * // Optional. The list of fields to update. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "defaultLicenseConfig": "my_defaultLicenseConfig", + * // "displayName": "my_displayName", + * // "enableExpiredLicenseAutoUpdate": false, + * // "enableLicenseAutoRegister": false, + * // "name": "my_name" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "defaultLicenseConfig": "my_defaultLicenseConfig", + * // "displayName": "my_displayName", + * // "enableExpiredLicenseAutoUpdate": false, + * // "enableLicenseAutoRegister": false, + * // "name": "my_name" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Userstores$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Userstores$Patch, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + patch( + params: Params$Resource$Projects$Locations$Userstores$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Userstores$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Userstores$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Userstores$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Userstores$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Userstores$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } } export interface Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses @@ -56007,6 +56798,52 @@ export namespace discoveryengine_v1 { */ requestBody?: Schema$GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequest; } + export interface Params$Resource$Projects$Locations$Userstores$Create + extends StandardParameters { + /** + * Required. The parent collection resource name, such as `projects/{project\}/locations/{location\}`. + */ + parent?: string; + /** + * Required. The ID of the User Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters. + */ + userStoreId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1UserStore; + } + export interface Params$Resource$Projects$Locations$Userstores$Delete + extends StandardParameters { + /** + * Required. The name of the User Store to delete. Format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Userstores$Get + extends StandardParameters { + /** + * Required. The name of the User Store to get. Format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Userstores$Patch + extends StandardParameters { + /** + * Immutable. The full resource name of the User Store, in the format of `projects/{project\}/locations/{location\}/userStores/{user_store\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string; + /** + * Optional. The list of fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1UserStore; + } export class Resource$Projects$Locations$Userstores$Userlicenses { context: APIRequestContext; diff --git a/src/apis/discoveryengine/v1alpha.ts b/src/apis/discoveryengine/v1alpha.ts index c9e6f3c012..8ab9193656 100644 --- a/src/apis/discoveryengine/v1alpha.ts +++ b/src/apis/discoveryengine/v1alpha.ts @@ -112,6 +112,7 @@ export namespace discoveryengine_v1alpha { */ export class Discoveryengine { context: APIRequestContext; + billingAccounts: Resource$Billingaccounts; media: Resource$Media; projects: Resource$Projects; @@ -121,6 +122,7 @@ export namespace discoveryengine_v1alpha { google, }; + this.billingAccounts = new Resource$Billingaccounts(this.context); this.media = new Resource$Media(this.context); this.projects = new Resource$Projects(this.context); } @@ -2607,6 +2609,48 @@ export namespace discoveryengine_v1alpha { */ timeZone?: string | null; } + /** + * Discovery Engine Authorization resource. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaAuthorization { + /** + * Required. The display name of the authorization. It must be a UTF-8 encoded string with a length limit of 128 characters. + */ + displayName?: string | null; + /** + * Identifier. Resource name of the authorization. Format: `projects/{project\}/locations/{location\}/authorizations/{authorization\}` It must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string | null; + /** + * Server-side OAuth2 configuration. + */ + serverSideOauth2?: Schema$GoogleCloudDiscoveryengineV1alphaAuthorizationServerSideOAuth2; + } + /** + * OAuth2 configuration. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaAuthorizationServerSideOAuth2 { + /** + * Required. The URI the user is directed to when they need to authorize. Should include everything required for a successful authorization: OAuth ID, extra flags, etc. Example: `https://accounts.google.com/o/oauth2/v2/auth?client_id=OAUTH_ID&scope=https://www.googleapis.com/auth/calendar.events&response_type=code&access_type=offline&prompt=consent` The `redirect_uri` parameter will be overwritten by the Vertex AI Search frontend. + */ + authorizationUri?: string | null; + /** + * Required. The OAuth2 client ID. + */ + clientId?: string | null; + /** + * Required. The OAuth2 client secret. Encrypted at rest. + */ + clientSecret?: string | null; + /** + * Required. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events` + */ + scopes?: string[] | null; + /** + * Required. The HTTP endpoint that exchanges a client authorization for an access token. + */ + tokenUri?: string | null; + } /** * The configuration for the BAP connector. */ @@ -2914,6 +2958,78 @@ export namespace discoveryengine_v1alpha { */ documentCounts?: {[key: string]: string} | null; } + /** + * Canned query resource of Assistant. It represents a short-cut to a predefined conversation start. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaCannedQuery { + /** + * Required. The default (non-localized) values for the text attributes. + */ + defaultTexts?: Schema$GoogleCloudDiscoveryengineV1alphaCannedQueryCannedQueryTexts; + /** + * The display name of the canned query. It must be a UTF-8 encoded string with a length limit of 128 characters. + */ + displayName?: string | null; + /** + * Whether this canned query is enabled. + */ + enabled?: boolean | null; + /** + * Output only. Whether this is a Google-defined, read-only canned query. + */ + googleDefined?: boolean | null; + /** + * Optional. The translations of the text attributes. The keys should be BCP-47 language codes. + */ + localizedTexts?: { + [ + key: string + ]: Schema$GoogleCloudDiscoveryengineV1alphaCannedQueryCannedQueryTexts; + } | null; + /** + * Immutable. Resource name of the canned query. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/cannedQueries/{canned_query\}` It must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string | null; + /** + * Optional. The capabilities the Assistant needs to have to use this canned query. + */ + requiredCapabilities?: Schema$GoogleCloudDiscoveryengineV1alphaCannedQueryAssistantCapability[]; + } + /** + * Capability of an assistant needed to use this canned query. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaCannedQueryAssistantCapability { + /** + * The name of the action that the Assistant needs to have set up to use this canned query. + */ + actionName?: string | null; + } + /** + * The text pieces for the canned query, which can be localized. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaCannedQueryCannedQueryTexts { + /** + * Optional. The prefix that `suggested_prompts` should start with. + */ + prefix?: string | null; + /** + * Required. The prompts the canned query will offer to the user. + */ + suggestedPrompts?: Schema$GoogleCloudDiscoveryengineV1alphaCannedQuerySuggestedPrompt[]; + /** + * Required. The title that is for the end user. + */ + title?: string | null; + } + /** + * A suggested prompt for the canned query. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaCannedQuerySuggestedPrompt { + /** + * Required. The text of the suggested prompt. + */ + promptText?: string | null; + } /** * Request message for GroundedGenerationService.CheckGrounding method. */ @@ -4313,6 +4429,10 @@ export namespace discoveryengine_v1alpha { * Optional. Configuration for configurable billing approach. See */ configurableBillingApproach?: string | null; + /** + * Output only. The timestamp when configurable_billing_approach was last updated. + */ + configurableBillingApproachUpdateTime?: string | null; /** * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */ @@ -4558,6 +4678,19 @@ export namespace discoveryengine_v1alpha { */ updateTime?: string | null; } + /** + * Metadata related to the progress of the UserStoreService.DeleteUserStore operation. This will be returned by the google.longrunning.Operation.metadata field. Delete UserStore will delete all the end users under the user store, return the number of end users successfully deleted or failed to delete in the metadata. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaDeleteUserStoreMetadata { + /** + * The number of end users under the user store that failed to be deleted. + */ + failureCount?: string | null; + /** + * The number of end users under the user store that were successfully deleted. + */ + successCount?: string | null; + } /** * Defines target endpoints used to connect to third-party sources. */ @@ -4613,6 +4746,36 @@ export namespace discoveryengine_v1alpha { * Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse {} + /** + * Request message for LicenseConfigService.DistributeLicenseConfig method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigRequest { + /** + * Optional. Distribute seats to this license config instead of creating a new one. If not specified, a new license config will be created from the billing account license config. + */ + licenseConfigId?: string | null; + /** + * Required. The number of licenses to distribute. + */ + licenseCount?: string | null; + /** + * Required. The target GCP project region to distribute the license config to. + */ + location?: string | null; + /** + * Required. The target GCP project number to distribute the license config to. + */ + projectNumber?: string | null; + } + /** + * Response message for LicenseConfigService.DistributeLicenseConfig method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigResponse { + /** + * The updated or created LicenseConfig. + */ + licenseConfig?: Schema$GoogleCloudDiscoveryengineV1alphaLicenseConfig; + } /** * Document captures all raw metadata information of items to be recommended or searched. */ @@ -6284,6 +6447,19 @@ export namespace discoveryengine_v1alpha { */ subscriptionTier?: string | null; } + /** + * Response message for the AuthorizationService.ListAuthorizations method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaListAuthorizationsResponse { + /** + * All the customer's Authorizations. + */ + authorizations?: Schema$GoogleCloudDiscoveryengineV1alphaAuthorization[]; + /** + * A token that can be sent as ListAuthorizationsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } /** * Response for BranchService.ListBranches method. */ @@ -6293,6 +6469,19 @@ export namespace discoveryengine_v1alpha { */ branches?: Schema$GoogleCloudDiscoveryengineV1alphaBranch[]; } + /** + * Response message for the CannedQueryService.ListCannedQueries method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaListCannedQueriesResponse { + /** + * The list of CannedQuerys matching the request. + */ + cannedQueries?: Schema$GoogleCloudDiscoveryengineV1alphaCannedQuery[]; + /** + * A token that can be sent as ListCannedQueriesRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } /** * Response message for ChunkService.ListChunks method. */ @@ -6771,6 +6960,10 @@ export namespace discoveryengine_v1alpha { * Metadata and configurations for a Google Cloud project in the service. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaProject { + /** + * Output only. The current status of the project's configurable billing. + */ + configurableBillingStatus?: Schema$GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus; /** * Output only. The timestamp when this project is created. */ @@ -6796,6 +6989,23 @@ export namespace discoveryengine_v1alpha { ]: Schema$GoogleCloudDiscoveryengineV1alphaProjectServiceTerms; } | null; } + /** + * Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month). + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus { + /** + * Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations. + */ + effectiveIndexingCoreThreshold?: string | null; + /** + * Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations. + */ + effectiveSearchQpmThreshold?: string | null; + /** + * Optional. The start time of the currently active billing subscription. + */ + startTime?: string | null; + } /** * Customer provided configurations. */ @@ -6813,6 +7023,10 @@ export namespace discoveryengine_v1alpha { * Model Armor configuration to be used for sanitizing user prompts and LLM responses. */ modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig; + /** + * Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified. + */ + optOutNotebookSharing?: boolean | null; } /** * Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses. @@ -7631,6 +7845,32 @@ export namespace discoveryengine_v1alpha { * Request for resuming training of an engine. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaResumeEngineRequest {} + /** + * Request message for LicenseConfigService.RetractLicenseConfig method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigRequest { + /** + * Optional. If set to true, retract the entire license config. Otherwise, retract the specified license count. + */ + fullRetract?: boolean | null; + /** + * Required. Full resource name of LicenseConfig. Format: `projects/{project\}/locations/{location\}/licenseConfigs/{license_config_id\}`. + */ + licenseConfig?: string | null; + /** + * Optional. The number of licenses to retract. Only used when full_retract is false. + */ + licenseCount?: string | null; + } + /** + * Response message for LicenseConfigService.RetractLicenseConfig method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigResponse { + /** + * The updated LicenseConfig. + */ + licenseConfig?: Schema$GoogleCloudDiscoveryengineV1alphaLicenseConfig; + } /** * Safety rating corresponding to the generated content. */ @@ -9911,6 +10151,31 @@ export namespace discoveryengine_v1alpha { */ userProfile?: string | null; } + /** + * Configures metadata that is used for End User entities. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaUserStore { + /** + * Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured. + */ + defaultLicenseConfig?: string | null; + /** + * The display name of the User Store. + */ + displayName?: string | null; + /** + * Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left. + */ + enableExpiredLicenseAutoUpdate?: boolean | null; + /** + * Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left. + */ + enableLicenseAutoRegister?: boolean | null; + /** + * Immutable. The full resource name of the User Store, in the format of `projects/{project\}/locations/{location\}/userStores/{user_store\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string | null; + } /** * Standard characteristics of a video media view. */ @@ -10060,6 +10325,10 @@ export namespace discoveryengine_v1alpha { key: string ]: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField; } | null; + /** + * Output only. Whether the subscription is gemini bundle or not. + */ + geminiBundle?: boolean | null; /** * Optional. Describes the homepage settings of the widget. */ @@ -10265,7 +10534,7 @@ export namespace discoveryengine_v1alpha { */ export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSetting { /** - * Optional. The shortcuts to display on the homepage. LINT.IfChange(max_shortcuts_number) LINT.ThenChange(//depot/google3/cloud/console/web/ai/unified_cloud_search/components/widget_preview/widget_homepage_shortcut_config_form.ts:max_shortcuts_number) + * Optional. The shortcuts to display on the homepage. LINT.IfChange(max_shortcuts_number) LINT.ThenChange( //depot/google3/cloud/console/web/ai/unified_cloud_search/components/widget_preview/widget_homepage_shortcut_config_form.ts:max_shortcuts_number ) */ shortcuts?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSettingShortcut[]; } @@ -11106,6 +11375,10 @@ export namespace discoveryengine_v1alpha { * Optional. Configuration for configurable billing approach. See */ configurableBillingApproach?: string | null; + /** + * Output only. The timestamp when configurable_billing_approach was last updated. + */ + configurableBillingApproachUpdateTime?: string | null; /** * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */ @@ -12112,6 +12385,10 @@ export namespace discoveryengine_v1alpha { * Metadata and configurations for a Google Cloud project in the service. */ export interface Schema$GoogleCloudDiscoveryengineV1betaProject { + /** + * Output only. The current status of the project's configurable billing. + */ + configurableBillingStatus?: Schema$GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus; /** * Output only. The timestamp when this project is created. */ @@ -12135,6 +12412,23 @@ export namespace discoveryengine_v1alpha { [key: string]: Schema$GoogleCloudDiscoveryengineV1betaProjectServiceTerms; } | null; } + /** + * Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month). + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus { + /** + * Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations. + */ + effectiveIndexingCoreThreshold?: string | null; + /** + * Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations. + */ + effectiveSearchQpmThreshold?: string | null; + /** + * Optional. The start time of the currently active billing subscription. + */ + startTime?: string | null; + } /** * Customer provided configurations. */ @@ -12152,6 +12446,10 @@ export namespace discoveryengine_v1alpha { * Model Armor configuration to be used for sanitizing user prompts and LLM responses. */ modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig; + /** + * Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified. + */ + optOutNotebookSharing?: boolean | null; } /** * Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses. @@ -13212,6 +13510,31 @@ export namespace discoveryengine_v1alpha { */ userProfile?: string | null; } + /** + * Configures metadata that is used for End User entities. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaUserStore { + /** + * Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured. + */ + defaultLicenseConfig?: string | null; + /** + * The display name of the User Store. + */ + displayName?: string | null; + /** + * Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left. + */ + enableExpiredLicenseAutoUpdate?: boolean | null; + /** + * Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left. + */ + enableLicenseAutoRegister?: boolean | null; + /** + * Immutable. The full resource name of the User Store, in the format of `projects/{project\}/locations/{location\}/userStores/{user_store\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string | null; + } /** * Config to store data store type configuration for workspace data */ @@ -13833,6 +14156,10 @@ export namespace discoveryengine_v1alpha { * Optional. Configuration for configurable billing approach. See */ configurableBillingApproach?: string | null; + /** + * Output only. The timestamp when configurable_billing_approach was last updated. + */ + configurableBillingApproachUpdateTime?: string | null; /** * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */ @@ -14701,6 +15028,10 @@ export namespace discoveryengine_v1alpha { * Metadata and configurations for a Google Cloud project in the service. */ export interface Schema$GoogleCloudDiscoveryengineV1Project { + /** + * Output only. The current status of the project's configurable billing. + */ + configurableBillingStatus?: Schema$GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus; /** * Output only. The timestamp when this project is created. */ @@ -14724,6 +15055,23 @@ export namespace discoveryengine_v1alpha { [key: string]: Schema$GoogleCloudDiscoveryengineV1ProjectServiceTerms; } | null; } + /** + * Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month). + */ + export interface Schema$GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus { + /** + * Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations. + */ + effectiveIndexingCoreThreshold?: string | null; + /** + * Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations. + */ + effectiveSearchQpmThreshold?: string | null; + /** + * Optional. The start time of the currently active billing subscription. + */ + startTime?: string | null; + } /** * Customer provided configurations. */ @@ -14741,6 +15089,10 @@ export namespace discoveryengine_v1alpha { * Model Armor configuration to be used for sanitizing user prompts and LLM responses. */ modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig; + /** + * Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified. + */ + optOutNotebookSharing?: boolean | null; } /** * Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses. @@ -15415,6 +15767,31 @@ export namespace discoveryengine_v1alpha { */ userProfile?: string | null; } + /** + * Configures metadata that is used for End User entities. + */ + export interface Schema$GoogleCloudDiscoveryengineV1UserStore { + /** + * Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured. + */ + defaultLicenseConfig?: string | null; + /** + * The display name of the User Store. + */ + displayName?: string | null; + /** + * Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left. + */ + enableExpiredLicenseAutoUpdate?: boolean | null; + /** + * Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left. + */ + enableLicenseAutoRegister?: boolean | null; + /** + * Immutable. The full resource name of the User Store, in the format of `projects/{project\}/locations/{location\}/userStores/{user_store\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string | null; + } /** * Config to store data store type configuration for workspace data */ @@ -16279,14 +16656,24 @@ export namespace discoveryengine_v1alpha { version?: string | null; } - export class Resource$Media { + export class Resource$Billingaccounts { + context: APIRequestContext; + billingAccountLicenseConfigs: Resource$Billingaccounts$Billingaccountlicenseconfigs; + constructor(context: APIRequestContext) { + this.context = context; + this.billingAccountLicenseConfigs = + new Resource$Billingaccounts$Billingaccountlicenseconfigs(this.context); + } + } + + export class Resource$Billingaccounts$Billingaccountlicenseconfigs { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Downloads a file from the session. + * Distributes a LicenseConfig from billing account level to project level. * @example * ```js * // Before running the sample: @@ -16309,7 +16696,6 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -16319,48 +16705,30 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.media.download({ - * // Required. The ID of the file to be downloaded. - * fileId: 'placeholder-value', - * // Required. The resource name of the Session. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}` - * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session', - * // Optional. The ID of the view to be downloaded. - * viewId: 'placeholder-value', - * }); + * const res = + * await discoveryengine.billingAccounts.billingAccountLicenseConfigs.distributeLicenseConfig( + * { + * // Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account\}/billingAccountLicenseConfigs/{billing_account_license_config_id\}`. + * billingAccountLicenseConfig: + * 'billingAccounts/my-billingAccount/billingAccountLicenseConfigs/my-billingAccountLicenseConfig', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "licenseConfigId": "my_licenseConfigId", + * // "licenseCount": "my_licenseCount", + * // "location": "my_location", + * // "projectNumber": "my_projectNumber" + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "algorithm": "my_algorithm", - * // "bigstoreObjectRef": "my_bigstoreObjectRef", - * // "blobRef": "my_blobRef", - * // "blobstore2Info": {}, - * // "compositeMedia": [], - * // "contentType": "my_contentType", - * // "contentTypeInfo": {}, - * // "cosmoBinaryReference": "my_cosmoBinaryReference", - * // "crc32cHash": 0, - * // "diffChecksumsResponse": {}, - * // "diffDownloadResponse": {}, - * // "diffUploadRequest": {}, - * // "diffUploadResponse": {}, - * // "diffVersionResponse": {}, - * // "downloadParameters": {}, - * // "filename": "my_filename", - * // "hash": "my_hash", - * // "hashVerified": false, - * // "inline": "my_inline", - * // "isPotentialRetry": false, - * // "length": "my_length", - * // "md5Hash": "my_md5Hash", - * // "mediaId": "my_mediaId", - * // "objectId": {}, - * // "path": "my_path", - * // "referenceType": "my_referenceType", - * // "sha1Hash": "my_sha1Hash", - * // "sha256Hash": "my_sha256Hash", - * // "timestamp": "my_timestamp", - * // "token": "my_token" + * // "licenseConfig": {} * // } * } * @@ -16376,52 +16744,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - download( - params: Params$Resource$Media$Download, + distributeLicenseConfig( + params: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Distributelicenseconfig, options: StreamMethodOptions ): Promise>; - download( - params?: Params$Resource$Media$Download, + distributeLicenseConfig( + params?: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Distributelicenseconfig, options?: MethodOptions - ): Promise>; - download( - params: Params$Resource$Media$Download, + ): Promise< + GaxiosResponseWithHTTP2 + >; + distributeLicenseConfig( + params: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Distributelicenseconfig, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - download( - params: Params$Resource$Media$Download, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + distributeLicenseConfig( + params: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Distributelicenseconfig, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - download( - params: Params$Resource$Media$Download, - callback: BodyResponseCallback + distributeLicenseConfig( + params: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Distributelicenseconfig, + callback: BodyResponseCallback ): void; - download(callback: BodyResponseCallback): void; - download( + distributeLicenseConfig( + callback: BodyResponseCallback + ): void; + distributeLicenseConfig( paramsOrCallback?: - | Params$Resource$Media$Download - | BodyResponseCallback + | Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Distributelicenseconfig + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Media$Download; + let params = (paramsOrCallback || + {}) as Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Distributelicenseconfig; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Media$Download; + params = + {} as Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Distributelicenseconfig; options = {}; } @@ -16435,58 +16813,432 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}:downloadFile').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: ( + rootUrl + + '/v1alpha/{+billingAccountLicenseConfig}:distributeLicenseConfig' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['billingAccountLicenseConfig'], + pathParams: ['billingAccountLicenseConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Media$Download extends StandardParameters { - /** - * Required. The ID of the file to be downloaded. - */ - fileId?: string; - /** - * Required. The resource name of the Session. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}` - */ - name?: string; - /** - * Optional. The ID of the view to be downloaded. - */ - viewId?: string; - } - - export class Resource$Projects { - context: APIRequestContext; - locations: Resource$Projects$Locations; - operations: Resource$Projects$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.locations = new Resource$Projects$Locations(this.context); - this.operations = new Resource$Projects$Operations(this.context); - } /** - * Gets a Project. Returns NOT_FOUND when the project is not yet created. + * This method is called from the billing account side to retract the LicenseConfig from the given project back to the billing account. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await discoveryengine.billingAccounts.billingAccountLicenseConfigs.retractLicenseConfig( + * { + * // Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account\}/billingAccountLicenseConfigs/{billing_account_license_config_id\}`. + * billingAccountLicenseConfig: + * 'billingAccounts/my-billingAccount/billingAccountLicenseConfigs/my-billingAccountLicenseConfig', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "fullRetract": false, + * // "licenseConfig": "my_licenseConfig", + * // "licenseCount": "my_licenseCount" + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "licenseConfig": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + retractLicenseConfig( + params: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Retractlicenseconfig, + options: StreamMethodOptions + ): Promise>; + retractLicenseConfig( + params?: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Retractlicenseconfig, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + retractLicenseConfig( + params: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Retractlicenseconfig, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + retractLicenseConfig( + params: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Retractlicenseconfig, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + retractLicenseConfig( + params: Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Retractlicenseconfig, + callback: BodyResponseCallback + ): void; + retractLicenseConfig( + callback: BodyResponseCallback + ): void; + retractLicenseConfig( + paramsOrCallback?: + | Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Retractlicenseconfig + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Retractlicenseconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Retractlicenseconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1alpha/{+billingAccountLicenseConfig}:retractLicenseConfig' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['billingAccountLicenseConfig'], + pathParams: ['billingAccountLicenseConfig'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Distributelicenseconfig + extends StandardParameters { + /** + * Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account\}/billingAccountLicenseConfigs/{billing_account_license_config_id\}`. + */ + billingAccountLicenseConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigRequest; + } + export interface Params$Resource$Billingaccounts$Billingaccountlicenseconfigs$Retractlicenseconfig + extends StandardParameters { + /** + * Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account\}/billingAccountLicenseConfigs/{billing_account_license_config_id\}`. + */ + billingAccountLicenseConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigRequest; + } + + export class Resource$Media { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Downloads a file from the session. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await discoveryengine.media.download({ + * // Required. The ID of the file to be downloaded. + * fileId: 'placeholder-value', + * // Required. The resource name of the Session. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}` + * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session', + * // Optional. The ID of the view to be downloaded. + * viewId: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "algorithm": "my_algorithm", + * // "bigstoreObjectRef": "my_bigstoreObjectRef", + * // "blobRef": "my_blobRef", + * // "blobstore2Info": {}, + * // "compositeMedia": [], + * // "contentType": "my_contentType", + * // "contentTypeInfo": {}, + * // "cosmoBinaryReference": "my_cosmoBinaryReference", + * // "crc32cHash": 0, + * // "diffChecksumsResponse": {}, + * // "diffDownloadResponse": {}, + * // "diffUploadRequest": {}, + * // "diffUploadResponse": {}, + * // "diffVersionResponse": {}, + * // "downloadParameters": {}, + * // "filename": "my_filename", + * // "hash": "my_hash", + * // "hashVerified": false, + * // "inline": "my_inline", + * // "isPotentialRetry": false, + * // "length": "my_length", + * // "md5Hash": "my_md5Hash", + * // "mediaId": "my_mediaId", + * // "objectId": {}, + * // "path": "my_path", + * // "referenceType": "my_referenceType", + * // "sha1Hash": "my_sha1Hash", + * // "sha256Hash": "my_sha256Hash", + * // "timestamp": "my_timestamp", + * // "token": "my_token" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + download( + params: Params$Resource$Media$Download, + options: StreamMethodOptions + ): Promise>; + download( + params?: Params$Resource$Media$Download, + options?: MethodOptions + ): Promise>; + download( + params: Params$Resource$Media$Download, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + download( + params: Params$Resource$Media$Download, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + download( + params: Params$Resource$Media$Download, + callback: BodyResponseCallback + ): void; + download(callback: BodyResponseCallback): void; + download( + paramsOrCallback?: + | Params$Resource$Media$Download + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Media$Download; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Media$Download; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:downloadFile').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Media$Download extends StandardParameters { + /** + * Required. The ID of the file to be downloaded. + */ + fileId?: string; + /** + * Required. The resource name of the Session. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}` + */ + name?: string; + /** + * Optional. The ID of the view to be downloaded. + */ + viewId?: string; + } + + export class Resource$Projects { + context: APIRequestContext; + locations: Resource$Projects$Locations; + operations: Resource$Projects$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Projects$Locations(this.context); + this.operations = new Resource$Projects$Operations(this.context); + } + + /** + * Gets a Project. Returns NOT_FOUND when the project is not yet created. * @example * ```js * // Before running the sample: @@ -16526,6 +17278,7 @@ export namespace discoveryengine_v1alpha { * * // Example response * // { + * // "configurableBillingStatus": {}, * // "createTime": "my_createTime", * // "customerProvidedConfig": {}, * // "name": "my_name", @@ -16679,6 +17432,7 @@ export namespace discoveryengine_v1alpha { * requestBody: { * // request body parameters * // { + * // "configurableBillingStatus": {}, * // "createTime": "my_createTime", * // "customerProvidedConfig": {}, * // "name": "my_name", @@ -16691,6 +17445,7 @@ export namespace discoveryengine_v1alpha { * * // Example response * // { + * // "configurableBillingStatus": {}, * // "createTime": "my_createTime", * // "customerProvidedConfig": {}, * // "name": "my_name", @@ -17011,6 +17766,7 @@ export namespace discoveryengine_v1alpha { * * // Example response * // { + * // "configurableBillingStatus": {}, * // "createTime": "my_createTime", * // "customerProvidedConfig": {}, * // "name": "my_name", @@ -17174,6 +17930,7 @@ export namespace discoveryengine_v1alpha { export class Resource$Projects$Locations { context: APIRequestContext; + authorizations: Resource$Projects$Locations$Authorizations; cmekConfigs: Resource$Projects$Locations$Cmekconfigs; collections: Resource$Projects$Locations$Collections; dataStores: Resource$Projects$Locations$Datastores; @@ -17191,6 +17948,9 @@ export namespace discoveryengine_v1alpha { userStores: Resource$Projects$Locations$Userstores; constructor(context: APIRequestContext) { this.context = context; + this.authorizations = new Resource$Projects$Locations$Authorizations( + this.context + ); this.cmekConfigs = new Resource$Projects$Locations$Cmekconfigs( this.context ); @@ -19180,14 +19940,14 @@ export namespace discoveryengine_v1alpha { requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaCmekConfig; } - export class Resource$Projects$Locations$Cmekconfigs { + export class Resource$Projects$Locations$Authorizations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * De-provisions a CmekConfig. + * Creates an Authorization. * @example * ```js * // Before running the sample: @@ -19219,19 +19979,29 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.cmekConfigs.delete({ - * // Required. The resource name of the CmekConfig to delete, such as `projects/{project\}/locations/{location\}/cmekConfigs/{cmek_config\}`. - * name: 'projects/my-project/locations/my-location/cmekConfigs/my-cmekConfig', + * const res = await discoveryengine.projects.locations.authorizations.create({ + * // Required. The ID to use for the authorization, which will become the final component of the resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters. + * authorizationId: 'placeholder-value', + * // Required. The parent resource name. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "displayName": "my_displayName", + * // "name": "my_name", + * // "serverSideOauth2": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "displayName": "my_displayName", * // "name": "my_name", - * // "response": {} + * // "serverSideOauth2": {} * // } * } * @@ -19247,57 +20017,202 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Cmekconfigs$Delete, + create( + params: Params$Resource$Projects$Locations$Authorizations$Create, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Cmekconfigs$Delete, + create( + params?: Params$Resource$Projects$Locations$Authorizations$Create, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Cmekconfigs$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Authorizations$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Cmekconfigs$Delete, + create( + params: Params$Resource$Projects$Locations$Authorizations$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Authorizations$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Authorizations$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Authorizations$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Authorizations$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/authorizations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Deletes an Authorization. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await discoveryengine.projects.locations.authorizations.delete({ + * // Required. Resource name of Authorization. Format: `projects/{project\}/locations/{location\}/authorizations/{authorization\}` If the caller does not have permission to delete the authorization, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the authorization to delete does not exist, a `NOT_FOUND` error is returned. + * name: 'projects/my-project/locations/my-location/authorizations/my-authorization', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Authorizations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Authorizations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Authorizations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Cmekconfigs$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Authorizations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Authorizations$Delete, + callback: BodyResponseCallback ): void; + delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Cmekconfigs$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Cmekconfigs$Delete; + {}) as Params$Resource$Projects$Locations$Authorizations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Cmekconfigs$Delete; + params = {} as Params$Resource$Projects$Locations$Authorizations$Delete; options = {}; } @@ -19323,17 +20238,17 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the CmekConfig. + * Gets an Authorization. * @example * ```js * // Before running the sample: @@ -19365,22 +20280,17 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.cmekConfigs.get({ - * // Required. Resource name of CmekConfig, such as `projects/x/locations/x/cmekConfig` or `projects/x/locations/x/cmekConfigs/x`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. - * name: 'projects/my-project/locations/my-location/cmekConfigs/my-cmekConfig', + * const res = await discoveryengine.projects.locations.authorizations.get({ + * // Required. Resource name of Authorization. Format: `projects/{project\}/locations/{location\}/authorizations/{authorization\}` + * name: 'projects/my-project/locations/my-location/authorizations/my-authorization', * }); * console.log(res.data); * * // Example response * // { - * // "isDefault": false, - * // "kmsKey": "my_kmsKey", - * // "kmsKeyVersion": "my_kmsKeyVersion", - * // "lastRotationTimestampMicros": "my_lastRotationTimestampMicros", + * // "displayName": "my_displayName", * // "name": "my_name", - * // "notebooklmState": "my_notebooklmState", - * // "singleRegionKeys": [], - * // "state": "my_state" + * // "serverSideOauth2": {} * // } * } * @@ -19397,60 +20307,60 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Cmekconfigs$Get, + params: Params$Resource$Projects$Locations$Authorizations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Cmekconfigs$Get, + params?: Params$Resource$Projects$Locations$Authorizations$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; get( - params: Params$Resource$Projects$Locations$Cmekconfigs$Get, + params: Params$Resource$Projects$Locations$Authorizations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Cmekconfigs$Get, + params: Params$Resource$Projects$Locations$Authorizations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Cmekconfigs$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Authorizations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Cmekconfigs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Cmekconfigs$Get; + {}) as Params$Resource$Projects$Locations$Authorizations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Cmekconfigs$Get; + params = {} as Params$Resource$Projects$Locations$Authorizations$Get; options = {}; } @@ -19476,19 +20386,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists all the CmekConfigs with the project. + * Lists all Authorizations under an Engine. * @example * ```js * // Before running the sample: @@ -19520,15 +20430,20 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.cmekConfigs.list({ - * // Required. The parent location resource name, such as `projects/{project\}/locations/{location\}`. If the caller does not have permission to list CmekConfigs under this location, regardless of whether or not a CmekConfig exists, a PERMISSION_DENIED error is returned. + * const res = await discoveryengine.projects.locations.authorizations.list({ + * // Maximum number of Authorizations to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000. + * pageSize: 'placeholder-value', + * // A page token ListAuthorizationsResponse.next_page_token, received from a previous AuthorizationService.ListAuthorizations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAuthorizations must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The parent resource name. Format: `projects/{project\}/locations/{location\}` * parent: 'projects/my-project/locations/my-location', * }); * console.log(res.data); * * // Example response * // { - * // "cmekConfigs": [] + * // "authorizations": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -19545,60 +20460,60 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Cmekconfigs$List, + params: Params$Resource$Projects$Locations$Authorizations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Cmekconfigs$List, + params?: Params$Resource$Projects$Locations$Authorizations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Cmekconfigs$List, + params: Params$Resource$Projects$Locations$Authorizations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Cmekconfigs$List, + params: Params$Resource$Projects$Locations$Authorizations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Cmekconfigs$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Authorizations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Cmekconfigs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Cmekconfigs$List; + {}) as Params$Resource$Projects$Locations$Authorizations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Cmekconfigs$List; + params = {} as Params$Resource$Projects$Locations$Authorizations$List; options = {}; } @@ -19612,7 +20527,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/cmekConfigs').replace( + url: (rootUrl + '/v1alpha/{+parent}/authorizations').replace( /([^:]\/)\/+/g, '$1' ), @@ -19627,19 +20542,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location. + * Updates an Authorization * @example * ```js * // Before running the sample: @@ -19671,24 +20586,19 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.cmekConfigs.patch({ - * // Required. The name of the CmekConfig of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmek_config\}`. - * name: 'projects/my-project/locations/my-location/cmekConfigs/my-cmekConfig', - * // Set the following CmekConfig as the default to be used for child resources if one is not specified. - * setDefault: 'placeholder-value', + * const res = await discoveryengine.projects.locations.authorizations.patch({ + * // Identifier. Resource name of the authorization. Format: `projects/{project\}/locations/{location\}/authorizations/{authorization\}` It must be a UTF-8 encoded string with a length limit of 1024 characters. + * name: 'projects/my-project/locations/my-location/authorizations/my-authorization', + * // The list of fields to update. + * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "isDefault": false, - * // "kmsKey": "my_kmsKey", - * // "kmsKeyVersion": "my_kmsKeyVersion", - * // "lastRotationTimestampMicros": "my_lastRotationTimestampMicros", + * // "displayName": "my_displayName", * // "name": "my_name", - * // "notebooklmState": "my_notebooklmState", - * // "singleRegionKeys": [], - * // "state": "my_state" + * // "serverSideOauth2": {} * // } * }, * }); @@ -19696,11 +20606,9 @@ export namespace discoveryengine_v1alpha { * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "displayName": "my_displayName", * // "name": "my_name", - * // "response": {} + * // "serverSideOauth2": {} * // } * } * @@ -19717,56 +20625,60 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Cmekconfigs$Patch, + params: Params$Resource$Projects$Locations$Authorizations$Patch, options: StreamMethodOptions ): Promise>; patch( - params?: Params$Resource$Projects$Locations$Cmekconfigs$Patch, + params?: Params$Resource$Projects$Locations$Authorizations$Patch, options?: MethodOptions - ): Promise>; + ): Promise< + GaxiosResponseWithHTTP2 + >; patch( - params: Params$Resource$Projects$Locations$Cmekconfigs$Patch, + params: Params$Resource$Projects$Locations$Authorizations$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Cmekconfigs$Patch, + params: Params$Resource$Projects$Locations$Authorizations$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Cmekconfigs$Patch, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Authorizations$Patch, + callback: BodyResponseCallback ): void; patch( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Cmekconfigs$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authorizations$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Cmekconfigs$Patch; + {}) as Params$Resource$Projects$Locations$Authorizations$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Cmekconfigs$Patch; + params = {} as Params$Resource$Projects$Locations$Authorizations$Patch; options = {}; } @@ -19792,77 +20704,88 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Cmekconfigs$Delete + export interface Params$Resource$Projects$Locations$Authorizations$Create extends StandardParameters { /** - * Required. The resource name of the CmekConfig to delete, such as `projects/{project\}/locations/{location\}/cmekConfigs/{cmek_config\}`. + * Required. The ID to use for the authorization, which will become the final component of the resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters. + */ + authorizationId?: string; + /** + * Required. The parent resource name. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAuthorization; + } + export interface Params$Resource$Projects$Locations$Authorizations$Delete + extends StandardParameters { + /** + * Required. Resource name of Authorization. Format: `projects/{project\}/locations/{location\}/authorizations/{authorization\}` If the caller does not have permission to delete the authorization, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the authorization to delete does not exist, a `NOT_FOUND` error is returned. */ name?: string; } - export interface Params$Resource$Projects$Locations$Cmekconfigs$Get + export interface Params$Resource$Projects$Locations$Authorizations$Get extends StandardParameters { /** - * Required. Resource name of CmekConfig, such as `projects/x/locations/x/cmekConfig` or `projects/x/locations/x/cmekConfigs/x`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. + * Required. Resource name of Authorization. Format: `projects/{project\}/locations/{location\}/authorizations/{authorization\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Cmekconfigs$List + export interface Params$Resource$Projects$Locations$Authorizations$List extends StandardParameters { /** - * Required. The parent location resource name, such as `projects/{project\}/locations/{location\}`. If the caller does not have permission to list CmekConfigs under this location, regardless of whether or not a CmekConfig exists, a PERMISSION_DENIED error is returned. + * Maximum number of Authorizations to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000. + */ + pageSize?: number; + /** + * A page token ListAuthorizationsResponse.next_page_token, received from a previous AuthorizationService.ListAuthorizations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAuthorizations must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent resource name. Format: `projects/{project\}/locations/{location\}` */ parent?: string; } - export interface Params$Resource$Projects$Locations$Cmekconfigs$Patch + export interface Params$Resource$Projects$Locations$Authorizations$Patch extends StandardParameters { /** - * Required. The name of the CmekConfig of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmek_config\}`. + * Identifier. Resource name of the authorization. Format: `projects/{project\}/locations/{location\}/authorizations/{authorization\}` It must be a UTF-8 encoded string with a length limit of 1024 characters. */ name?: string; /** - * Set the following CmekConfig as the default to be used for child resources if one is not specified. + * The list of fields to update. */ - setDefault?: boolean; + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaCmekConfig; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAuthorization; } - export class Resource$Projects$Locations$Collections { + export class Resource$Projects$Locations$Cmekconfigs { context: APIRequestContext; - dataConnector: Resource$Projects$Locations$Collections$Dataconnector; - dataStores: Resource$Projects$Locations$Collections$Datastores; - engines: Resource$Projects$Locations$Collections$Engines; - operations: Resource$Projects$Locations$Collections$Operations; constructor(context: APIRequestContext) { this.context = context; - this.dataConnector = - new Resource$Projects$Locations$Collections$Dataconnector(this.context); - this.dataStores = new Resource$Projects$Locations$Collections$Datastores( - this.context - ); - this.engines = new Resource$Projects$Locations$Collections$Engines( - this.context - ); - this.operations = new Resource$Projects$Locations$Collections$Operations( - this.context - ); } /** - * Deletes a Collection. + * De-provisions a CmekConfig. * @example * ```js * // Before running the sample: @@ -19894,9 +20817,9 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.collections.delete({ - * // Required. The full resource name of the Collection, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}`. - * name: 'projects/my-project/locations/my-location/collections/my-collection', + * const res = await discoveryengine.projects.locations.cmekConfigs.delete({ + * // Required. The resource name of the CmekConfig to delete, such as `projects/{project\}/locations/{location\}/cmekConfigs/{cmek_config\}`. + * name: 'projects/my-project/locations/my-location/cmekConfigs/my-cmekConfig', * }); * console.log(res.data); * @@ -19923,27 +20846,27 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Collections$Delete, + params: Params$Resource$Projects$Locations$Cmekconfigs$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Collections$Delete, + params?: Params$Resource$Projects$Locations$Cmekconfigs$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Collections$Delete, + params: Params$Resource$Projects$Locations$Cmekconfigs$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Collections$Delete, + params: Params$Resource$Projects$Locations$Cmekconfigs$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Collections$Delete, + params: Params$Resource$Projects$Locations$Cmekconfigs$Delete, callback: BodyResponseCallback ): void; delete( @@ -19951,7 +20874,7 @@ export namespace discoveryengine_v1alpha { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Delete + | Params$Resource$Projects$Locations$Cmekconfigs$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -19967,12 +20890,12 @@ export namespace discoveryengine_v1alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Delete; + {}) as Params$Resource$Projects$Locations$Cmekconfigs$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Collections$Delete; + params = {} as Params$Resource$Projects$Locations$Cmekconfigs$Delete; options = {}; } @@ -20008,7 +20931,7 @@ export namespace discoveryengine_v1alpha { } /** - * Gets a Collection. + * Gets the CmekConfig. * @example * ```js * // Before running the sample: @@ -20040,18 +20963,22 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.collections.get({ - * // Required. The full resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}`. - * name: 'projects/my-project/locations/my-location/collections/my-collection', + * const res = await discoveryengine.projects.locations.cmekConfigs.get({ + * // Required. Resource name of CmekConfig, such as `projects/x/locations/x/cmekConfig` or `projects/x/locations/x/cmekConfigs/x`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. + * name: 'projects/my-project/locations/my-location/cmekConfigs/my-cmekConfig', * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "dataConnector": {}, - * // "displayName": "my_displayName", - * // "name": "my_name" + * // "isDefault": false, + * // "kmsKey": "my_kmsKey", + * // "kmsKeyVersion": "my_kmsKeyVersion", + * // "lastRotationTimestampMicros": "my_lastRotationTimestampMicros", + * // "name": "my_name", + * // "notebooklmState": "my_notebooklmState", + * // "singleRegionKeys": [], + * // "state": "my_state" * // } * } * @@ -20068,60 +20995,60 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Collections$Get, + params: Params$Resource$Projects$Locations$Cmekconfigs$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Collections$Get, + params?: Params$Resource$Projects$Locations$Cmekconfigs$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; get( - params: Params$Resource$Projects$Locations$Collections$Get, + params: Params$Resource$Projects$Locations$Cmekconfigs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Get, + params: Params$Resource$Projects$Locations$Cmekconfigs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Cmekconfigs$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Cmekconfigs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Get; + {}) as Params$Resource$Projects$Locations$Cmekconfigs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Collections$Get; + params = {} as Params$Resource$Projects$Locations$Cmekconfigs$Get; options = {}; } @@ -20147,19 +21074,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets the DataConnector. DataConnector is a singleton resource for each Collection. + * Lists all the CmekConfigs with the project. * @example * ```js * // Before running the sample: @@ -20182,7 +21109,6 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -20192,54 +21118,15 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await discoveryengine.projects.locations.collections.getDataConnector({ - * // Required. Full resource name of DataConnector, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataConnector`. If the caller does not have permission to access the DataConnector, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataConnector does not exist, a NOT_FOUND error is returned. - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataConnector', - * }); + * const res = await discoveryengine.projects.locations.cmekConfigs.list({ + * // Required. The parent location resource name, such as `projects/{project\}/locations/{location\}`. If the caller does not have permission to list CmekConfigs under this location, regardless of whether or not a CmekConfig exists, a PERMISSION_DENIED error is returned. + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { - * // "aclEnabled": false, - * // "actionConfig": {}, - * // "actionState": "my_actionState", - * // "alertPolicyConfigs": [], - * // "autoRunDisabled": false, - * // "bapConfig": {}, - * // "blockingReasons": [], - * // "connectorModes": [], - * // "connectorType": "my_connectorType", - * // "createEuaSaas": false, - * // "createTime": "my_createTime", - * // "dataSource": "my_dataSource", - * // "destinationConfigs": [], - * // "endUserConfig": {}, - * // "entities": [], - * // "errors": [], - * // "federatedConfig": {}, - * // "hybridIngestionDisabled": false, - * // "identityRefreshInterval": "my_identityRefreshInterval", - * // "identityScheduleConfig": {}, - * // "incrementalRefreshInterval": "my_incrementalRefreshInterval", - * // "incrementalSyncDisabled": false, - * // "jsonParams": "my_jsonParams", - * // "kmsKeyName": "my_kmsKeyName", - * // "lastSyncTime": "my_lastSyncTime", - * // "latestPauseTime": "my_latestPauseTime", - * // "name": "my_name", - * // "nextSyncTime": {}, - * // "params": {}, - * // "privateConnectivityProjectId": "my_privateConnectivityProjectId", - * // "realtimeState": "my_realtimeState", - * // "realtimeSyncConfig": {}, - * // "refreshInterval": "my_refreshInterval", - * // "removeParamKeys": [], - * // "state": "my_state", - * // "staticIpAddresses": [], - * // "staticIpEnabled": false, - * // "syncMode": "my_syncMode", - * // "updateTime": "my_updateTime" + * // "cmekConfigs": [] * // } * } * @@ -20255,62 +21142,61 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getDataConnector( - params: Params$Resource$Projects$Locations$Collections$Getdataconnector, + list( + params: Params$Resource$Projects$Locations$Cmekconfigs$List, options: StreamMethodOptions ): Promise>; - getDataConnector( - params?: Params$Resource$Projects$Locations$Collections$Getdataconnector, + list( + params?: Params$Resource$Projects$Locations$Cmekconfigs$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - getDataConnector( - params: Params$Resource$Projects$Locations$Collections$Getdataconnector, + list( + params: Params$Resource$Projects$Locations$Cmekconfigs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getDataConnector( - params: Params$Resource$Projects$Locations$Collections$Getdataconnector, + list( + params: Params$Resource$Projects$Locations$Cmekconfigs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getDataConnector( - params: Params$Resource$Projects$Locations$Collections$Getdataconnector, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Cmekconfigs$List, + callback: BodyResponseCallback ): void; - getDataConnector( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - getDataConnector( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Getdataconnector - | BodyResponseCallback + | Params$Resource$Projects$Locations$Cmekconfigs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Getdataconnector; + {}) as Params$Resource$Projects$Locations$Cmekconfigs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Getdataconnector; + params = {} as Params$Resource$Projects$Locations$Cmekconfigs$List; options = {}; } @@ -20324,31 +21210,34 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+parent}/cmekConfigs').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets a list of Collections. + * Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location. * @example * ```js * // Before running the sample: @@ -20380,22 +21269,36 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.collections.list({ - * // Filter returned collections by associated data connector data sources. For example: `filter = 'data_source:jira confluence'`. If the filter is empty, we return all collections under a project and location. - * filter: 'placeholder-value', - * // The maximum number of Collections to return. The service may return fewer than this value. If unspecified, at most 100 Collections will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // A page token, received from a previous CollectionService.ListCollections call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to CollectionService.ListCollections must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}`. - * parent: 'projects/my-project/locations/my-location', + * const res = await discoveryengine.projects.locations.cmekConfigs.patch({ + * // Required. The name of the CmekConfig of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmek_config\}`. + * name: 'projects/my-project/locations/my-location/cmekConfigs/my-cmekConfig', + * // Set the following CmekConfig as the default to be used for child resources if one is not specified. + * setDefault: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "isDefault": false, + * // "kmsKey": "my_kmsKey", + * // "kmsKeyVersion": "my_kmsKeyVersion", + * // "lastRotationTimestampMicros": "my_lastRotationTimestampMicros", + * // "name": "my_name", + * // "notebooklmState": "my_notebooklmState", + * // "singleRegionKeys": [], + * // "state": "my_state" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "collections": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -20411,61 +21314,57 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$List, + patch( + params: Params$Resource$Projects$Locations$Cmekconfigs$Patch, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Collections$List, + patch( + params?: Params$Resource$Projects$Locations$Cmekconfigs$Patch, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Collections$List, + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Cmekconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$List, + patch( + params: Params$Resource$Projects$Locations$Cmekconfigs$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$List, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Cmekconfigs$Patch, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - list( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Cmekconfigs$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$List; + {}) as Params$Resource$Projects$Locations$Cmekconfigs$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Collections$List; + params = {} as Params$Resource$Projects$Locations$Cmekconfigs$Patch; options = {}; } @@ -20479,34 +21378,89 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/collections').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Cmekconfigs$Delete + extends StandardParameters { /** - * Updates a Collection. + * Required. The resource name of the CmekConfig to delete, such as `projects/{project\}/locations/{location\}/cmekConfigs/{cmek_config\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Cmekconfigs$Get + extends StandardParameters { + /** + * Required. Resource name of CmekConfig, such as `projects/x/locations/x/cmekConfig` or `projects/x/locations/x/cmekConfigs/x`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Cmekconfigs$List + extends StandardParameters { + /** + * Required. The parent location resource name, such as `projects/{project\}/locations/{location\}`. If the caller does not have permission to list CmekConfigs under this location, regardless of whether or not a CmekConfig exists, a PERMISSION_DENIED error is returned. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Cmekconfigs$Patch + extends StandardParameters { + /** + * Required. The name of the CmekConfig of the form `projects/{project\}/locations/{location\}/cmekConfig` or `projects/{project\}/locations/{location\}/cmekConfigs/{cmek_config\}`. + */ + name?: string; + /** + * Set the following CmekConfig as the default to be used for child resources if one is not specified. + */ + setDefault?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaCmekConfig; + } + + export class Resource$Projects$Locations$Collections { + context: APIRequestContext; + dataConnector: Resource$Projects$Locations$Collections$Dataconnector; + dataStores: Resource$Projects$Locations$Collections$Datastores; + engines: Resource$Projects$Locations$Collections$Engines; + operations: Resource$Projects$Locations$Collections$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.dataConnector = + new Resource$Projects$Locations$Collections$Dataconnector(this.context); + this.dataStores = new Resource$Projects$Locations$Collections$Datastores( + this.context + ); + this.engines = new Resource$Projects$Locations$Collections$Engines( + this.context + ); + this.operations = new Resource$Projects$Locations$Collections$Operations( + this.context + ); + } + + /** + * Deletes a Collection. * @example * ```js * // Before running the sample: @@ -20538,22 +21492,9 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.collections.patch({ - * // Immutable. The full resource name of the Collection. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * const res = await discoveryengine.projects.locations.collections.delete({ + * // Required. The full resource name of the Collection, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}`. * name: 'projects/my-project/locations/my-location/collections/my-collection', - * // Optional. The list of fields to be updated. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "dataConnector": {}, - * // "displayName": "my_displayName", - * // "name": "my_name" - * // } - * }, * }); * console.log(res.data); * @@ -20579,36 +21520,36 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Patch, + delete( + params: Params$Resource$Projects$Locations$Collections$Delete, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Collections$Patch, + delete( + params?: Params$Resource$Projects$Locations$Collections$Delete, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Collections$Patch, + delete( + params: Params$Resource$Projects$Locations$Collections$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Patch, + delete( + params: Params$Resource$Projects$Locations$Collections$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Patch, + delete( + params: Params$Resource$Projects$Locations$Collections$Delete, callback: BodyResponseCallback ): void; - patch( + delete( callback: BodyResponseCallback ): void; - patch( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Patch + | Params$Resource$Projects$Locations$Collections$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -20624,12 +21565,12 @@ export namespace discoveryengine_v1alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Collections$Patch; + params = {} as Params$Resource$Projects$Locations$Collections$Delete; options = {}; } @@ -20644,7 +21585,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options @@ -20665,7 +21606,7 @@ export namespace discoveryengine_v1alpha { } /** - * Updates a DataConnector. + * Gets a Collection. * @example * ```js * // Before running the sample: @@ -20688,7 +21629,6 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -20698,102 +21638,18 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await discoveryengine.projects.locations.collections.updateDataConnector({ - * // Output only. The full resource name of the Data Connector. Format: `projects/x/locations/x/collections/x/dataConnector`. - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataConnector', - * // Indicates which fields in the provided DataConnector to update. Supported field paths include: - refresh_interval - params - auto_run_disabled - action_config - action_config.action_params - action_config.service_name - destination_configs - blocking_reasons - sync_mode - incremental_sync_disabled - incremental_refresh_interval Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "aclEnabled": false, - * // "actionConfig": {}, - * // "actionState": "my_actionState", - * // "alertPolicyConfigs": [], - * // "autoRunDisabled": false, - * // "bapConfig": {}, - * // "blockingReasons": [], - * // "connectorModes": [], - * // "connectorType": "my_connectorType", - * // "createEuaSaas": false, - * // "createTime": "my_createTime", - * // "dataSource": "my_dataSource", - * // "destinationConfigs": [], - * // "endUserConfig": {}, - * // "entities": [], - * // "errors": [], - * // "federatedConfig": {}, - * // "hybridIngestionDisabled": false, - * // "identityRefreshInterval": "my_identityRefreshInterval", - * // "identityScheduleConfig": {}, - * // "incrementalRefreshInterval": "my_incrementalRefreshInterval", - * // "incrementalSyncDisabled": false, - * // "jsonParams": "my_jsonParams", - * // "kmsKeyName": "my_kmsKeyName", - * // "lastSyncTime": "my_lastSyncTime", - * // "latestPauseTime": "my_latestPauseTime", - * // "name": "my_name", - * // "nextSyncTime": {}, - * // "params": {}, - * // "privateConnectivityProjectId": "my_privateConnectivityProjectId", - * // "realtimeState": "my_realtimeState", - * // "realtimeSyncConfig": {}, - * // "refreshInterval": "my_refreshInterval", - * // "removeParamKeys": [], - * // "state": "my_state", - * // "staticIpAddresses": [], - * // "staticIpEnabled": false, - * // "syncMode": "my_syncMode", - * // "updateTime": "my_updateTime" - * // } - * }, - * }); - * console.log(res.data); + * const res = await discoveryengine.projects.locations.collections.get({ + * // Required. The full resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}`. + * name: 'projects/my-project/locations/my-location/collections/my-collection', + * }); + * console.log(res.data); * * // Example response * // { - * // "aclEnabled": false, - * // "actionConfig": {}, - * // "actionState": "my_actionState", - * // "alertPolicyConfigs": [], - * // "autoRunDisabled": false, - * // "bapConfig": {}, - * // "blockingReasons": [], - * // "connectorModes": [], - * // "connectorType": "my_connectorType", - * // "createEuaSaas": false, * // "createTime": "my_createTime", - * // "dataSource": "my_dataSource", - * // "destinationConfigs": [], - * // "endUserConfig": {}, - * // "entities": [], - * // "errors": [], - * // "federatedConfig": {}, - * // "hybridIngestionDisabled": false, - * // "identityRefreshInterval": "my_identityRefreshInterval", - * // "identityScheduleConfig": {}, - * // "incrementalRefreshInterval": "my_incrementalRefreshInterval", - * // "incrementalSyncDisabled": false, - * // "jsonParams": "my_jsonParams", - * // "kmsKeyName": "my_kmsKeyName", - * // "lastSyncTime": "my_lastSyncTime", - * // "latestPauseTime": "my_latestPauseTime", - * // "name": "my_name", - * // "nextSyncTime": {}, - * // "params": {}, - * // "privateConnectivityProjectId": "my_privateConnectivityProjectId", - * // "realtimeState": "my_realtimeState", - * // "realtimeSyncConfig": {}, - * // "refreshInterval": "my_refreshInterval", - * // "removeParamKeys": [], - * // "state": "my_state", - * // "staticIpAddresses": [], - * // "staticIpEnabled": false, - * // "syncMode": "my_syncMode", - * // "updateTime": "my_updateTime" + * // "dataConnector": {}, + * // "displayName": "my_displayName", + * // "name": "my_name" * // } * } * @@ -20809,62 +21665,61 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - updateDataConnector( - params: Params$Resource$Projects$Locations$Collections$Updatedataconnector, + get( + params: Params$Resource$Projects$Locations$Collections$Get, options: StreamMethodOptions ): Promise>; - updateDataConnector( - params?: Params$Resource$Projects$Locations$Collections$Updatedataconnector, + get( + params?: Params$Resource$Projects$Locations$Collections$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - updateDataConnector( - params: Params$Resource$Projects$Locations$Collections$Updatedataconnector, + get( + params: Params$Resource$Projects$Locations$Collections$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateDataConnector( - params: Params$Resource$Projects$Locations$Collections$Updatedataconnector, + get( + params: Params$Resource$Projects$Locations$Collections$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - updateDataConnector( - params: Params$Resource$Projects$Locations$Collections$Updatedataconnector, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Get, + callback: BodyResponseCallback ): void; - updateDataConnector( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - updateDataConnector( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Updatedataconnector - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Updatedataconnector; + {}) as Params$Resource$Projects$Locations$Collections$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Updatedataconnector; + params = {} as Params$Resource$Projects$Locations$Collections$Get; options = {}; } @@ -20879,7 +21734,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -20890,109 +21745,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Delete - extends StandardParameters { - /** - * Required. The full resource name of the Collection, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Get - extends StandardParameters { - /** - * Required. The full resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Getdataconnector - extends StandardParameters { - /** - * Required. Full resource name of DataConnector, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataConnector`. If the caller does not have permission to access the DataConnector, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataConnector does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$List - extends StandardParameters { - /** - * Filter returned collections by associated data connector data sources. For example: `filter = 'data_source:jira confluence'`. If the filter is empty, we return all collections under a project and location. - */ - filter?: string; - /** - * The maximum number of Collections to return. The service may return fewer than this value. If unspecified, at most 100 Collections will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous CollectionService.ListCollections call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to CollectionService.ListCollections must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Patch - extends StandardParameters { - /** - * Immutable. The full resource name of the Collection. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - */ - name?: string; - /** - * Optional. The list of fields to be updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaCollection; - } - export interface Params$Resource$Projects$Locations$Collections$Updatedataconnector - extends StandardParameters { - /** - * Output only. The full resource name of the Data Connector. Format: `projects/x/locations/x/collections/x/dataConnector`. - */ - name?: string; - /** - * Indicates which fields in the provided DataConnector to update. Supported field paths include: - refresh_interval - params - auto_run_disabled - action_config - action_config.action_params - action_config.service_name - destination_configs - blocking_reasons - sync_mode - incremental_sync_disabled - incremental_refresh_interval Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDataConnector; - } - - export class Resource$Projects$Locations$Collections$Dataconnector { - context: APIRequestContext; - connectorRuns: Resource$Projects$Locations$Collections$Dataconnector$Connectorruns; - operations: Resource$Projects$Locations$Collections$Dataconnector$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.connectorRuns = - new Resource$Projects$Locations$Collections$Dataconnector$Connectorruns( - this.context - ); - this.operations = - new Resource$Projects$Locations$Collections$Dataconnector$Operations( - this.context - ); - } /** - * Uses the per-user refresh token minted with AcquireAndStoreRefreshToken to generate and return a new access token and its details. Takes the access token from cache if available. Rotates the stored refresh token if needed. Uses the end user identity to return the user specific access token. Does *not* return the credentials configured by the administrator. Used by action execution and UI. + * Gets the DataConnector. DataConnector is a singleton resource for each Collection. * @example * ```js * // Before running the sample: @@ -21026,24 +21791,53 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataConnector.acquireAccessToken( - * { - * // Required. The resource name of the connector for which a token is queried. - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataConnector', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }, - * ); + * await discoveryengine.projects.locations.collections.getDataConnector({ + * // Required. Full resource name of DataConnector, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataConnector`. If the caller does not have permission to access the DataConnector, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataConnector does not exist, a NOT_FOUND error is returned. + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataConnector', + * }); * console.log(res.data); * * // Example response * // { - * // "accessToken": "my_accessToken", - * // "refreshTokenInfo": {} + * // "aclEnabled": false, + * // "actionConfig": {}, + * // "actionState": "my_actionState", + * // "alertPolicyConfigs": [], + * // "autoRunDisabled": false, + * // "bapConfig": {}, + * // "blockingReasons": [], + * // "connectorModes": [], + * // "connectorType": "my_connectorType", + * // "createEuaSaas": false, + * // "createTime": "my_createTime", + * // "dataSource": "my_dataSource", + * // "destinationConfigs": [], + * // "endUserConfig": {}, + * // "entities": [], + * // "errors": [], + * // "federatedConfig": {}, + * // "hybridIngestionDisabled": false, + * // "identityRefreshInterval": "my_identityRefreshInterval", + * // "identityScheduleConfig": {}, + * // "incrementalRefreshInterval": "my_incrementalRefreshInterval", + * // "incrementalSyncDisabled": false, + * // "jsonParams": "my_jsonParams", + * // "kmsKeyName": "my_kmsKeyName", + * // "lastSyncTime": "my_lastSyncTime", + * // "latestPauseTime": "my_latestPauseTime", + * // "name": "my_name", + * // "nextSyncTime": {}, + * // "params": {}, + * // "privateConnectivityProjectId": "my_privateConnectivityProjectId", + * // "realtimeState": "my_realtimeState", + * // "realtimeSyncConfig": {}, + * // "refreshInterval": "my_refreshInterval", + * // "removeParamKeys": [], + * // "state": "my_state", + * // "staticIpAddresses": [], + * // "staticIpEnabled": false, + * // "syncMode": "my_syncMode", + * // "updateTime": "my_updateTime" * // } * } * @@ -21059,62 +21853,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - acquireAccessToken( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Acquireaccesstoken, + getDataConnector( + params: Params$Resource$Projects$Locations$Collections$Getdataconnector, options: StreamMethodOptions ): Promise>; - acquireAccessToken( - params?: Params$Resource$Projects$Locations$Collections$Dataconnector$Acquireaccesstoken, + getDataConnector( + params?: Params$Resource$Projects$Locations$Collections$Getdataconnector, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - acquireAccessToken( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Acquireaccesstoken, + getDataConnector( + params: Params$Resource$Projects$Locations$Collections$Getdataconnector, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - acquireAccessToken( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Acquireaccesstoken, + getDataConnector( + params: Params$Resource$Projects$Locations$Collections$Getdataconnector, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - acquireAccessToken( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Acquireaccesstoken, - callback: BodyResponseCallback + getDataConnector( + params: Params$Resource$Projects$Locations$Collections$Getdataconnector, + callback: BodyResponseCallback ): void; - acquireAccessToken( - callback: BodyResponseCallback + getDataConnector( + callback: BodyResponseCallback ): void; - acquireAccessToken( + getDataConnector( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Dataconnector$Acquireaccesstoken - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Getdataconnector + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Dataconnector$Acquireaccesstoken; + {}) as Params$Resource$Projects$Locations$Collections$Getdataconnector; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Dataconnector$Acquireaccesstoken; + {} as Params$Resource$Projects$Locations$Collections$Getdataconnector; options = {}; } @@ -21128,11 +21922,8 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}:acquireAccessToken').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -21143,19 +21934,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deprecated: Checks the existence of a refresh token for the EUC user for a given connection and returns its details. Use AcquireAccessToken instead and then check the validity of the returned token by asking the 3rd party system. There's no way to know for sure if a refresh token is valid without asking the 3rd party system. + * Gets a list of Collections. * @example * ```js * // Before running the sample: @@ -21178,7 +21969,6 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -21188,18 +21978,22 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await discoveryengine.projects.locations.collections.dataConnector.checkRefreshToken( - * { - * // Required. The resource name of the connector for which a token is queried. - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataConnector', - * }, - * ); + * const res = await discoveryengine.projects.locations.collections.list({ + * // Filter returned collections by associated data connector data sources. For example: `filter = 'data_source:jira confluence'`. If the filter is empty, we return all collections under a project and location. + * filter: 'placeholder-value', + * // The maximum number of Collections to return. The service may return fewer than this value. If unspecified, at most 100 Collections will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // A page token, received from a previous CollectionService.ListCollections call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to CollectionService.ListCollections must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}`. + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { - * // "refreshTokenInfo": {} + * // "collections": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -21215,62 +22009,61 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - checkRefreshToken( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Checkrefreshtoken, + list( + params: Params$Resource$Projects$Locations$Collections$List, options: StreamMethodOptions ): Promise>; - checkRefreshToken( - params?: Params$Resource$Projects$Locations$Collections$Dataconnector$Checkrefreshtoken, + list( + params?: Params$Resource$Projects$Locations$Collections$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - checkRefreshToken( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Checkrefreshtoken, + list( + params: Params$Resource$Projects$Locations$Collections$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - checkRefreshToken( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Checkrefreshtoken, + list( + params: Params$Resource$Projects$Locations$Collections$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - checkRefreshToken( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Checkrefreshtoken, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$List, + callback: BodyResponseCallback ): void; - checkRefreshToken( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - checkRefreshToken( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Dataconnector$Checkrefreshtoken - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Dataconnector$Checkrefreshtoken; + {}) as Params$Resource$Projects$Locations$Collections$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Dataconnector$Checkrefreshtoken; + params = {} as Params$Resource$Projects$Locations$Collections$List; options = {}; } @@ -21284,7 +22077,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}:checkRefreshToken').replace( + url: (rootUrl + '/v1alpha/{+parent}/collections').replace( /([^:]\/)\/+/g, '$1' ), @@ -21294,24 +22087,24 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Get the secret for the associated connector. + * Updates a Collection. * @example * ```js * // Before running the sample: @@ -21334,7 +22127,6 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -21344,23 +22136,32 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await discoveryengine.projects.locations.collections.dataConnector.getConnectorSecret( - * { - * // Required. The full resource name of the associated data connector. - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataConnector', - * }, - * ); + * const res = await discoveryengine.projects.locations.collections.patch({ + * // Immutable. The full resource name of the Collection. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * name: 'projects/my-project/locations/my-location/collections/my-collection', + * // Optional. The list of fields to be updated. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "dataConnector": {}, + * // "displayName": "my_displayName", + * // "name": "my_name" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "app": "my_app", - * // "authorizationUri": "my_authorizationUri", - * // "clientId": "my_clientId", - * // "instance": "my_instance", - * // "redirectUri": "my_redirectUri", - * // "tenantId": "my_tenantId" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -21376,62 +22177,57 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getConnectorSecret( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Getconnectorsecret, + patch( + params: Params$Resource$Projects$Locations$Collections$Patch, options: StreamMethodOptions ): Promise>; - getConnectorSecret( - params?: Params$Resource$Projects$Locations$Collections$Dataconnector$Getconnectorsecret, + patch( + params?: Params$Resource$Projects$Locations$Collections$Patch, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - getConnectorSecret( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Getconnectorsecret, + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Collections$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getConnectorSecret( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Getconnectorsecret, + patch( + params: Params$Resource$Projects$Locations$Collections$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getConnectorSecret( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Getconnectorsecret, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Patch, + callback: BodyResponseCallback ): void; - getConnectorSecret( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - getConnectorSecret( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Dataconnector$Getconnectorsecret - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Dataconnector$Getconnectorsecret; + {}) as Params$Resource$Projects$Locations$Collections$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Dataconnector$Getconnectorsecret; + params = {} as Params$Resource$Projects$Locations$Collections$Patch; options = {}; } @@ -21445,11 +22241,8 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}:getConnectorSecret').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -21460,19 +22253,17 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Starts an immediate synchronization process for a DataConnector. Third Party Connector Users must specify which entities should be synced. FHIR Connectors must provide a timestamp to indicate the point in time from which data should be synced. + * Updates a DataConnector. * @example * ```js * // Before running the sample: @@ -21506,38 +22297,101 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataConnector.startConnectorRun( - * { - * // Required. Connector name of the form projects/{project\}/locations/{location\}/collections/ {collection_id\}/dataConnector - * parent: - * 'projects/my-project/locations/my-location/collections/my-collection/dataConnector', + * await discoveryengine.projects.locations.collections.updateDataConnector({ + * // Output only. The full resource name of the Data Connector. Format: `projects/x/locations/x/collections/x/dataConnector`. + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataConnector', + * // Indicates which fields in the provided DataConnector to update. Supported field paths include: - refresh_interval - params - auto_run_disabled - action_config - action_config.action_params - action_config.service_name - destination_configs - blocking_reasons - sync_mode - incremental_sync_disabled - incremental_refresh_interval Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error. + * updateMask: 'placeholder-value', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "entities": [], - * // "forceRefreshContent": false, - * // "healthcareFhirResourceTypes": [], - * // "syncIdentity": false, - * // "syncSinceTimestamp": "my_syncSinceTimestamp" - * // } - * }, + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "aclEnabled": false, + * // "actionConfig": {}, + * // "actionState": "my_actionState", + * // "alertPolicyConfigs": [], + * // "autoRunDisabled": false, + * // "bapConfig": {}, + * // "blockingReasons": [], + * // "connectorModes": [], + * // "connectorType": "my_connectorType", + * // "createEuaSaas": false, + * // "createTime": "my_createTime", + * // "dataSource": "my_dataSource", + * // "destinationConfigs": [], + * // "endUserConfig": {}, + * // "entities": [], + * // "errors": [], + * // "federatedConfig": {}, + * // "hybridIngestionDisabled": false, + * // "identityRefreshInterval": "my_identityRefreshInterval", + * // "identityScheduleConfig": {}, + * // "incrementalRefreshInterval": "my_incrementalRefreshInterval", + * // "incrementalSyncDisabled": false, + * // "jsonParams": "my_jsonParams", + * // "kmsKeyName": "my_kmsKeyName", + * // "lastSyncTime": "my_lastSyncTime", + * // "latestPauseTime": "my_latestPauseTime", + * // "name": "my_name", + * // "nextSyncTime": {}, + * // "params": {}, + * // "privateConnectivityProjectId": "my_privateConnectivityProjectId", + * // "realtimeState": "my_realtimeState", + * // "realtimeSyncConfig": {}, + * // "refreshInterval": "my_refreshInterval", + * // "removeParamKeys": [], + * // "state": "my_state", + * // "staticIpAddresses": [], + * // "staticIpEnabled": false, + * // "syncMode": "my_syncMode", + * // "updateTime": "my_updateTime" + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response * // { - * // "endTime": "my_endTime", - * // "entityRuns": [], + * // "aclEnabled": false, + * // "actionConfig": {}, + * // "actionState": "my_actionState", + * // "alertPolicyConfigs": [], + * // "autoRunDisabled": false, + * // "bapConfig": {}, + * // "blockingReasons": [], + * // "connectorModes": [], + * // "connectorType": "my_connectorType", + * // "createEuaSaas": false, + * // "createTime": "my_createTime", + * // "dataSource": "my_dataSource", + * // "destinationConfigs": [], + * // "endUserConfig": {}, + * // "entities": [], * // "errors": [], + * // "federatedConfig": {}, + * // "hybridIngestionDisabled": false, + * // "identityRefreshInterval": "my_identityRefreshInterval", + * // "identityScheduleConfig": {}, + * // "incrementalRefreshInterval": "my_incrementalRefreshInterval", + * // "incrementalSyncDisabled": false, + * // "jsonParams": "my_jsonParams", + * // "kmsKeyName": "my_kmsKeyName", + * // "lastSyncTime": "my_lastSyncTime", * // "latestPauseTime": "my_latestPauseTime", * // "name": "my_name", - * // "startTime": "my_startTime", + * // "nextSyncTime": {}, + * // "params": {}, + * // "privateConnectivityProjectId": "my_privateConnectivityProjectId", + * // "realtimeState": "my_realtimeState", + * // "realtimeSyncConfig": {}, + * // "refreshInterval": "my_refreshInterval", + * // "removeParamKeys": [], * // "state": "my_state", - * // "stateUpdateTime": "my_stateUpdateTime", - * // "trigger": "my_trigger" + * // "staticIpAddresses": [], + * // "staticIpEnabled": false, + * // "syncMode": "my_syncMode", + * // "updateTime": "my_updateTime" * // } * } * @@ -21553,62 +22407,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - startConnectorRun( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Startconnectorrun, + updateDataConnector( + params: Params$Resource$Projects$Locations$Collections$Updatedataconnector, options: StreamMethodOptions ): Promise>; - startConnectorRun( - params?: Params$Resource$Projects$Locations$Collections$Dataconnector$Startconnectorrun, + updateDataConnector( + params?: Params$Resource$Projects$Locations$Collections$Updatedataconnector, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - startConnectorRun( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Startconnectorrun, + updateDataConnector( + params: Params$Resource$Projects$Locations$Collections$Updatedataconnector, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - startConnectorRun( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Startconnectorrun, + updateDataConnector( + params: Params$Resource$Projects$Locations$Collections$Updatedataconnector, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - startConnectorRun( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Startconnectorrun, - callback: BodyResponseCallback + updateDataConnector( + params: Params$Resource$Projects$Locations$Collections$Updatedataconnector, + callback: BodyResponseCallback ): void; - startConnectorRun( - callback: BodyResponseCallback + updateDataConnector( + callback: BodyResponseCallback ): void; - startConnectorRun( + updateDataConnector( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Dataconnector$Startconnectorrun - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Updatedataconnector + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Dataconnector$Startconnectorrun; + {}) as Params$Resource$Projects$Locations$Collections$Updatedataconnector; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Dataconnector$Startconnectorrun; + {} as Params$Resource$Projects$Locations$Collections$Updatedataconnector; options = {}; } @@ -21622,80 +22476,121 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}:startConnectorRun').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Collections$Dataconnector$Acquireaccesstoken + export interface Params$Resource$Projects$Locations$Collections$Delete extends StandardParameters { /** - * Required. The resource name of the connector for which a token is queried. + * Required. The full resource name of the Collection, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}`. */ name?: string; - + } + export interface Params$Resource$Projects$Locations$Collections$Get + extends StandardParameters { /** - * Request body metadata + * Required. The full resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}`. */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAcquireAccessTokenRequest; + name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Dataconnector$Checkrefreshtoken + export interface Params$Resource$Projects$Locations$Collections$Getdataconnector extends StandardParameters { /** - * Required. The resource name of the connector for which a token is queried. + * Required. Full resource name of DataConnector, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataConnector`. If the caller does not have permission to access the DataConnector, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataConnector does not exist, a NOT_FOUND error is returned. */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Dataconnector$Getconnectorsecret + export interface Params$Resource$Projects$Locations$Collections$List extends StandardParameters { /** - * Required. The full resource name of the associated data connector. + * Filter returned collections by associated data connector data sources. For example: `filter = 'data_source:jira confluence'`. If the filter is empty, we return all collections under a project and location. + */ + filter?: string; + /** + * The maximum number of Collections to return. The service may return fewer than this value. If unspecified, at most 100 Collections will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous CollectionService.ListCollections call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to CollectionService.ListCollections must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Patch + extends StandardParameters { + /** + * Immutable. The full resource name of the Collection. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ name?: string; + /** + * Optional. The list of fields to be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaCollection; } - export interface Params$Resource$Projects$Locations$Collections$Dataconnector$Startconnectorrun + export interface Params$Resource$Projects$Locations$Collections$Updatedataconnector extends StandardParameters { /** - * Required. Connector name of the form projects/{project\}/locations/{location\}/collections/ {collection_id\}/dataConnector + * Output only. The full resource name of the Data Connector. Format: `projects/x/locations/x/collections/x/dataConnector`. */ - parent?: string; + name?: string; + /** + * Indicates which fields in the provided DataConnector to update. Supported field paths include: - refresh_interval - params - auto_run_disabled - action_config - action_config.action_params - action_config.service_name - destination_configs - blocking_reasons - sync_mode - incremental_sync_disabled - incremental_refresh_interval Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error. + */ + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaStartConnectorRunRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDataConnector; } - export class Resource$Projects$Locations$Collections$Dataconnector$Connectorruns { + export class Resource$Projects$Locations$Collections$Dataconnector { context: APIRequestContext; + connectorRuns: Resource$Projects$Locations$Collections$Dataconnector$Connectorruns; + operations: Resource$Projects$Locations$Collections$Dataconnector$Operations; constructor(context: APIRequestContext) { this.context = context; + this.connectorRuns = + new Resource$Projects$Locations$Collections$Dataconnector$Connectorruns( + this.context + ); + this.operations = + new Resource$Projects$Locations$Collections$Dataconnector$Operations( + this.context + ); } /** - * Lists the ConnectorRuns of a DataConnector. + * Uses the per-user refresh token minted with AcquireAndStoreRefreshToken to generate and return a new access token and its details. Takes the access token from cache if available. Rotates the stored refresh token if needed. Uses the end user identity to return the user specific access token. Does *not* return the credentials configured by the administrator. Used by action execution and UI. * @example * ```js * // Before running the sample: @@ -21729,23 +22624,24 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataConnector.connectorRuns.list( + * await discoveryengine.projects.locations.collections.dataConnector.acquireAccessToken( * { - * // Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT error is returned. - * pageSize: 'placeholder-value', - * // A page token, received from a previous `ListConnectorRuns` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConnectorRuns` must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The parent DataConnector resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataConnector`. If the caller does not have permission to list ConnectorRuns under this DataConnector, regardless of whether or not this DataConnector exists, a PERMISSION_DENIED error is returned. - * parent: - * 'projects/my-project/locations/my-location/collections/my-collection/dataConnector', + * // Required. The resource name of the connector for which a token is queried. + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataConnector', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, * }, * ); * console.log(res.data); * * // Example response * // { - * // "connectorRuns": [], - * // "nextPageToken": "my_nextPageToken" + * // "accessToken": "my_accessToken", + * // "refreshTokenInfo": {} * // } * } * @@ -21761,62 +22657,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Connectorruns$List, + acquireAccessToken( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Acquireaccesstoken, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Collections$Dataconnector$Connectorruns$List, + acquireAccessToken( + params?: Params$Resource$Projects$Locations$Collections$Dataconnector$Acquireaccesstoken, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Connectorruns$List, + acquireAccessToken( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Acquireaccesstoken, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Connectorruns$List, + acquireAccessToken( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Acquireaccesstoken, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Connectorruns$List, - callback: BodyResponseCallback + acquireAccessToken( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Acquireaccesstoken, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + acquireAccessToken( + callback: BodyResponseCallback ): void; - list( + acquireAccessToken( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Dataconnector$Connectorruns$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Dataconnector$Acquireaccesstoken + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Dataconnector$Connectorruns$List; + {}) as Params$Resource$Projects$Locations$Collections$Dataconnector$Acquireaccesstoken; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Dataconnector$Connectorruns$List; + {} as Params$Resource$Projects$Locations$Collections$Dataconnector$Acquireaccesstoken; options = {}; } @@ -21830,57 +22726,34 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/connectorRuns').replace( + url: (rootUrl + '/v1alpha/{+name}:acquireAccessToken').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Dataconnector$Connectorruns$List - extends StandardParameters { - /** - * Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT error is returned. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListConnectorRuns` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConnectorRuns` must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The parent DataConnector resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataConnector`. If the caller does not have permission to list ConnectorRuns under this DataConnector, regardless of whether or not this DataConnector exists, a PERMISSION_DENIED error is returned. - */ - parent?: string; - } - - export class Resource$Projects$Locations$Collections$Dataconnector$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Deprecated: Checks the existence of a refresh token for the EUC user for a given connection and returns its details. Use AcquireAccessToken instead and then check the validity of the returned token by asking the 3rd party system. There's no way to know for sure if a refresh token is valid without asking the 3rd party system. * @example * ```js * // Before running the sample: @@ -21903,6 +22776,7 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -21913,21 +22787,17 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataConnector.operations.get( + * await discoveryengine.projects.locations.collections.dataConnector.checkRefreshToken( * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataConnector/operations/my-operation', + * // Required. The resource name of the connector for which a token is queried. + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataConnector', * }, * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "refreshTokenInfo": {} * // } * } * @@ -21943,58 +22813,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, + checkRefreshToken( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Checkrefreshtoken, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, + checkRefreshToken( + params?: Params$Resource$Projects$Locations$Collections$Dataconnector$Checkrefreshtoken, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + checkRefreshToken( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Checkrefreshtoken, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, + checkRefreshToken( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Checkrefreshtoken, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, - callback: BodyResponseCallback + checkRefreshToken( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Checkrefreshtoken, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + checkRefreshToken( + callback: BodyResponseCallback ): void; - get( + checkRefreshToken( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Dataconnector$Checkrefreshtoken + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Dataconnector$Checkrefreshtoken; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get; + {} as Params$Resource$Projects$Locations$Collections$Dataconnector$Checkrefreshtoken; options = {}; } @@ -22008,7 +22882,10 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+name}:checkRefreshToken').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -22020,17 +22897,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Get the secret for the associated connector. * @example * ```js * // Before running the sample: @@ -22053,6 +22932,7 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -22063,27 +22943,22 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataConnector.operations.list( + * await discoveryengine.projects.locations.collections.dataConnector.getConnectorSecret( * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. + * // Required. The full resource name of the associated data connector. * name: 'projects/my-project/locations/my-location/collections/my-collection/dataConnector', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "app": "my_app", + * // "authorizationUri": "my_authorizationUri", + * // "clientId": "my_clientId", + * // "instance": "my_instance", + * // "redirectUri": "my_redirectUri", + * // "tenantId": "my_tenantId" * // } * } * @@ -22099,62 +22974,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, + getConnectorSecret( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Getconnectorsecret, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, + getConnectorSecret( + params?: Params$Resource$Projects$Locations$Collections$Dataconnector$Getconnectorsecret, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, + getConnectorSecret( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Getconnectorsecret, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, + getConnectorSecret( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Getconnectorsecret, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, - callback: BodyResponseCallback + getConnectorSecret( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Getconnectorsecret, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + getConnectorSecret( + callback: BodyResponseCallback ): void; - list( + getConnectorSecret( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Dataconnector$Getconnectorsecret + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List; + {}) as Params$Resource$Projects$Locations$Collections$Dataconnector$Getconnectorsecret; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List; + {} as Params$Resource$Projects$Locations$Collections$Dataconnector$Getconnectorsecret; options = {}; } @@ -22168,7 +23043,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}/operations').replace( + url: (rootUrl + '/v1alpha/{+name}:getConnectorSecret').replace( /([^:]\/)\/+/g, '$1' ), @@ -22183,132 +23058,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - export interface Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List - extends StandardParameters { /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - - export class Resource$Projects$Locations$Collections$Datastores { - context: APIRequestContext; - branches: Resource$Projects$Locations$Collections$Datastores$Branches; - completionConfig: Resource$Projects$Locations$Collections$Datastores$Completionconfig; - completionSuggestions: Resource$Projects$Locations$Collections$Datastores$Completionsuggestions; - controls: Resource$Projects$Locations$Collections$Datastores$Controls; - conversations: Resource$Projects$Locations$Collections$Datastores$Conversations; - customModels: Resource$Projects$Locations$Collections$Datastores$Custommodels; - models: Resource$Projects$Locations$Collections$Datastores$Models; - operations: Resource$Projects$Locations$Collections$Datastores$Operations; - schemas: Resource$Projects$Locations$Collections$Datastores$Schemas; - servingConfigs: Resource$Projects$Locations$Collections$Datastores$Servingconfigs; - sessions: Resource$Projects$Locations$Collections$Datastores$Sessions; - siteSearchEngine: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine; - suggestionDenyListEntries: Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries; - userEvents: Resource$Projects$Locations$Collections$Datastores$Userevents; - widgetConfigs: Resource$Projects$Locations$Collections$Datastores$Widgetconfigs; - constructor(context: APIRequestContext) { - this.context = context; - this.branches = - new Resource$Projects$Locations$Collections$Datastores$Branches( - this.context - ); - this.completionConfig = - new Resource$Projects$Locations$Collections$Datastores$Completionconfig( - this.context - ); - this.completionSuggestions = - new Resource$Projects$Locations$Collections$Datastores$Completionsuggestions( - this.context - ); - this.controls = - new Resource$Projects$Locations$Collections$Datastores$Controls( - this.context - ); - this.conversations = - new Resource$Projects$Locations$Collections$Datastores$Conversations( - this.context - ); - this.customModels = - new Resource$Projects$Locations$Collections$Datastores$Custommodels( - this.context - ); - this.models = - new Resource$Projects$Locations$Collections$Datastores$Models( - this.context - ); - this.operations = - new Resource$Projects$Locations$Collections$Datastores$Operations( - this.context - ); - this.schemas = - new Resource$Projects$Locations$Collections$Datastores$Schemas( - this.context - ); - this.servingConfigs = - new Resource$Projects$Locations$Collections$Datastores$Servingconfigs( - this.context - ); - this.sessions = - new Resource$Projects$Locations$Collections$Datastores$Sessions( - this.context - ); - this.siteSearchEngine = - new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine( - this.context - ); - this.suggestionDenyListEntries = - new Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries( - this.context - ); - this.userEvents = - new Resource$Projects$Locations$Collections$Datastores$Userevents( - this.context - ); - this.widgetConfigs = - new Resource$Projects$Locations$Collections$Datastores$Widgetconfigs( - this.context - ); - } - - /** - * Completes the specified user input with keyword suggestions. + * Starts an immediate synchronization process for a DataConnector. Third Party Connector Users must specify which entities should be synced. FHIR Connectors must provide a timestamp to indicate the point in time from which data should be synced. * @example * ```js * // Before running the sample: @@ -22342,27 +23104,38 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.completeQuery( + * await discoveryengine.projects.locations.collections.dataConnector.startConnectorRun( * { - * // Required. The parent data store resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. - * dataStore: - * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', - * // 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. - * includeTailSuggestions: 'placeholder-value', - * // Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. - * query: 'placeholder-value', - * // Specifies the autocomplete data model. 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. - * queryModel: 'placeholder-value', - * // 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 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. - * userPseudoId: 'placeholder-value', + * // Required. Connector name of the form projects/{project\}/locations/{location\}/collections/ {collection_id\}/dataConnector + * parent: + * 'projects/my-project/locations/my-location/collections/my-collection/dataConnector', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "entities": [], + * // "forceRefreshContent": false, + * // "healthcareFhirResourceTypes": [], + * // "syncIdentity": false, + * // "syncSinceTimestamp": "my_syncSinceTimestamp" + * // } + * }, * }, * ); * console.log(res.data); * * // Example response * // { - * // "querySuggestions": [], - * // "tailMatchTriggered": false + * // "endTime": "my_endTime", + * // "entityRuns": [], + * // "errors": [], + * // "latestPauseTime": "my_latestPauseTime", + * // "name": "my_name", + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "stateUpdateTime": "my_stateUpdateTime", + * // "trigger": "my_trigger" * // } * } * @@ -22378,62 +23151,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - completeQuery( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, + startConnectorRun( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Startconnectorrun, options: StreamMethodOptions ): Promise>; - completeQuery( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, + startConnectorRun( + params?: Params$Resource$Projects$Locations$Collections$Dataconnector$Startconnectorrun, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - completeQuery( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, + startConnectorRun( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Startconnectorrun, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - completeQuery( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, + startConnectorRun( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Startconnectorrun, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - completeQuery( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, - callback: BodyResponseCallback + startConnectorRun( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Startconnectorrun, + callback: BodyResponseCallback ): void; - completeQuery( - callback: BodyResponseCallback + startConnectorRun( + callback: BodyResponseCallback ): void; - completeQuery( + startConnectorRun( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Completequery - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Dataconnector$Startconnectorrun + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Completequery; + {}) as Params$Resource$Projects$Locations$Collections$Dataconnector$Startconnectorrun; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Completequery; + {} as Params$Resource$Projects$Locations$Collections$Dataconnector$Startconnectorrun; options = {}; } @@ -22447,34 +23220,80 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+dataStore}:completeQuery').replace( + url: (rootUrl + '/v1alpha/{+parent}:startConnectorRun').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['dataStore'], - pathParams: ['dataStore'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Dataconnector$Acquireaccesstoken + extends StandardParameters { /** - * Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately. + * Required. The resource name of the connector for which a token is queried. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAcquireAccessTokenRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Dataconnector$Checkrefreshtoken + extends StandardParameters { + /** + * Required. The resource name of the connector for which a token is queried. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Dataconnector$Getconnectorsecret + extends StandardParameters { + /** + * Required. The full resource name of the associated data connector. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Dataconnector$Startconnectorrun + extends StandardParameters { + /** + * Required. Connector name of the form projects/{project\}/locations/{location\}/collections/ {collection_id\}/dataConnector + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaStartConnectorRunRequest; + } + + export class Resource$Projects$Locations$Collections$Dataconnector$Connectorruns { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists the ConnectorRuns of a DataConnector. * @example * ```js * // Before running the sample: @@ -22497,6 +23316,7 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -22507,60 +23327,23 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.create({ - * // Resource name of the CmekConfig to use for protecting this DataStore. - * cmekConfigName: 'placeholder-value', - * // A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. - * createAdvancedSiteSearch: 'placeholder-value', - * // Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. - * dataStoreId: 'placeholder-value', - * // DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well. - * disableCmek: 'placeholder-value', - * // Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`. - * parent: - * 'projects/my-project/locations/my-location/collections/my-collection', - * // A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified. - * skipDefaultSchemaCreation: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "aclEnabled": false, - * // "advancedSiteSearchConfig": {}, - * // "billingEstimation": {}, - * // "cmekConfig": {}, - * // "configurableBillingApproach": "my_configurableBillingApproach", - * // "contentConfig": "my_contentConfig", - * // "createTime": "my_createTime", - * // "defaultSchemaId": "my_defaultSchemaId", - * // "displayName": "my_displayName", - * // "documentProcessingConfig": {}, - * // "healthcareFhirConfig": {}, - * // "identityMappingStore": "my_identityMappingStore", - * // "idpConfig": {}, - * // "industryVertical": "my_industryVertical", - * // "isInfobotFaqDataStore": false, - * // "kmsKeyName": "my_kmsKeyName", - * // "languageInfo": {}, - * // "name": "my_name", - * // "naturalLanguageQueryUnderstandingConfig": {}, - * // "servingConfigDataStore": {}, - * // "solutionTypes": [], - * // "startingSchema": {}, - * // "workspaceConfig": {} - * // } + * await discoveryengine.projects.locations.collections.dataConnector.connectorRuns.list( + * { + * // Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT error is returned. + * pageSize: 'placeholder-value', + * // A page token, received from a previous `ListConnectorRuns` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConnectorRuns` must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The parent DataConnector resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataConnector`. If the caller does not have permission to list ConnectorRuns under this DataConnector, regardless of whether or not this DataConnector exists, a PERMISSION_DENIED error is returned. + * parent: + * 'projects/my-project/locations/my-location/collections/my-collection/dataConnector', * }, - * }); + * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "connectorRuns": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -22576,58 +23359,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Create, + list( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Connectorruns$List, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Create, + list( + params?: Params$Resource$Projects$Locations$Collections$Dataconnector$Connectorruns$List, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Create, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Connectorruns$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Create, + list( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Connectorruns$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Connectorruns$List, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - create( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Dataconnector$Connectorruns$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Create; + {}) as Params$Resource$Projects$Locations$Collections$Dataconnector$Connectorruns$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Create; + {} as Params$Resource$Projects$Locations$Collections$Dataconnector$Connectorruns$List; options = {}; } @@ -22641,11 +23428,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/dataStores').replace( + url: (rootUrl + '/v1alpha/{+parent}/connectorRuns').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -22656,17 +23443,42 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Dataconnector$Connectorruns$List + extends StandardParameters { /** - * Deletes a DataStore. + * Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT error is returned. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListConnectorRuns` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConnectorRuns` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent DataConnector resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataConnector`. If the caller does not have permission to list ConnectorRuns under this DataConnector, regardless of whether or not this DataConnector exists, a PERMISSION_DENIED error is returned. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Collections$Dataconnector$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -22699,10 +23511,12 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.delete({ - * // Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error is returned. - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', - * }); + * await discoveryengine.projects.locations.collections.dataConnector.operations.get( + * { + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataConnector/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response @@ -22727,36 +23541,36 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + get( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + get( + params?: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + get( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + get( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + get( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, callback: BodyResponseCallback ): void; - delete( + get( callback: BodyResponseCallback ): void; - delete( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Delete + | Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -22772,13 +23586,13 @@ export namespace discoveryengine_v1alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Delete; + {} as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get; options = {}; } @@ -22793,7 +23607,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -22814,7 +23628,7 @@ export namespace discoveryengine_v1alpha { } /** - * Gets a DataStore. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -22847,37 +23661,27 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.get({ - * // Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', - * }); + * await discoveryengine.projects.locations.collections.dataConnector.operations.list( + * { + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataConnector', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "aclEnabled": false, - * // "advancedSiteSearchConfig": {}, - * // "billingEstimation": {}, - * // "cmekConfig": {}, - * // "configurableBillingApproach": "my_configurableBillingApproach", - * // "contentConfig": "my_contentConfig", - * // "createTime": "my_createTime", - * // "defaultSchemaId": "my_defaultSchemaId", - * // "displayName": "my_displayName", - * // "documentProcessingConfig": {}, - * // "healthcareFhirConfig": {}, - * // "identityMappingStore": "my_identityMappingStore", - * // "idpConfig": {}, - * // "industryVertical": "my_industryVertical", - * // "isInfobotFaqDataStore": false, - * // "kmsKeyName": "my_kmsKeyName", - * // "languageInfo": {}, - * // "name": "my_name", - * // "naturalLanguageQueryUnderstandingConfig": {}, - * // "servingConfigDataStore": {}, - * // "solutionTypes": [], - * // "startingSchema": {}, - * // "workspaceConfig": {} + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -22893,62 +23697,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Get, + list( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Get, + list( + params?: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Get, + list( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Get, + list( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Get, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, + callback: BodyResponseCallback ): void; - get( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Get; + {}) as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Get; + {} as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List; options = {}; } @@ -22962,7 +23766,10 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -22974,19 +23781,132 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get + extends StandardParameters { /** - * Gets a DocumentProcessingConfig. + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + + export class Resource$Projects$Locations$Collections$Datastores { + context: APIRequestContext; + branches: Resource$Projects$Locations$Collections$Datastores$Branches; + completionConfig: Resource$Projects$Locations$Collections$Datastores$Completionconfig; + completionSuggestions: Resource$Projects$Locations$Collections$Datastores$Completionsuggestions; + controls: Resource$Projects$Locations$Collections$Datastores$Controls; + conversations: Resource$Projects$Locations$Collections$Datastores$Conversations; + customModels: Resource$Projects$Locations$Collections$Datastores$Custommodels; + models: Resource$Projects$Locations$Collections$Datastores$Models; + operations: Resource$Projects$Locations$Collections$Datastores$Operations; + schemas: Resource$Projects$Locations$Collections$Datastores$Schemas; + servingConfigs: Resource$Projects$Locations$Collections$Datastores$Servingconfigs; + sessions: Resource$Projects$Locations$Collections$Datastores$Sessions; + siteSearchEngine: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine; + suggestionDenyListEntries: Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries; + userEvents: Resource$Projects$Locations$Collections$Datastores$Userevents; + widgetConfigs: Resource$Projects$Locations$Collections$Datastores$Widgetconfigs; + constructor(context: APIRequestContext) { + this.context = context; + this.branches = + new Resource$Projects$Locations$Collections$Datastores$Branches( + this.context + ); + this.completionConfig = + new Resource$Projects$Locations$Collections$Datastores$Completionconfig( + this.context + ); + this.completionSuggestions = + new Resource$Projects$Locations$Collections$Datastores$Completionsuggestions( + this.context + ); + this.controls = + new Resource$Projects$Locations$Collections$Datastores$Controls( + this.context + ); + this.conversations = + new Resource$Projects$Locations$Collections$Datastores$Conversations( + this.context + ); + this.customModels = + new Resource$Projects$Locations$Collections$Datastores$Custommodels( + this.context + ); + this.models = + new Resource$Projects$Locations$Collections$Datastores$Models( + this.context + ); + this.operations = + new Resource$Projects$Locations$Collections$Datastores$Operations( + this.context + ); + this.schemas = + new Resource$Projects$Locations$Collections$Datastores$Schemas( + this.context + ); + this.servingConfigs = + new Resource$Projects$Locations$Collections$Datastores$Servingconfigs( + this.context + ); + this.sessions = + new Resource$Projects$Locations$Collections$Datastores$Sessions( + this.context + ); + this.siteSearchEngine = + new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine( + this.context + ); + this.suggestionDenyListEntries = + new Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries( + this.context + ); + this.userEvents = + new Resource$Projects$Locations$Collections$Datastores$Userevents( + this.context + ); + this.widgetConfigs = + new Resource$Projects$Locations$Collections$Datastores$Widgetconfigs( + this.context + ); + } + + /** + * Completes the specified user input with keyword suggestions. * @example * ```js * // Before running the sample: @@ -23009,6 +23929,7 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -23019,20 +23940,27 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.getDocumentProcessingConfig( + * await discoveryengine.projects.locations.collections.dataStores.completeQuery( * { - * // Required. Full DocumentProcessingConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/documentProcessingConfig` - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/documentProcessingConfig', + * // Required. The parent data store resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. + * dataStore: + * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', + * // 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. + * includeTailSuggestions: 'placeholder-value', + * // Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. + * query: 'placeholder-value', + * // Specifies the autocomplete data model. 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. + * queryModel: 'placeholder-value', + * // 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 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + * userPseudoId: 'placeholder-value', * }, * ); * console.log(res.data); * * // Example response * // { - * // "chunkingConfig": {}, - * // "defaultParsingConfig": {}, - * // "name": "my_name", - * // "parsingConfigOverrides": {} + * // "querySuggestions": [], + * // "tailMatchTriggered": false * // } * } * @@ -23048,62 +23976,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig, + completeQuery( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, options: StreamMethodOptions ): Promise>; - getDocumentProcessingConfig( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig, + completeQuery( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - getDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig, + completeQuery( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig, + completeQuery( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig, - callback: BodyResponseCallback + completeQuery( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, + callback: BodyResponseCallback ): void; - getDocumentProcessingConfig( - callback: BodyResponseCallback + completeQuery( + callback: BodyResponseCallback ): void; - getDocumentProcessingConfig( + completeQuery( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Completequery + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Completequery; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Completequery; options = {}; } @@ -23117,31 +24045,34 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+dataStore}:completeQuery').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['dataStore'], + pathParams: ['dataStore'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets the SiteSearchEngine. + * Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately. * @example * ```js * // Before running the sample: @@ -23174,17 +24105,61 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.getSiteSearchEngine( - * { - * // Required. Resource name of SiteSearchEngine, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/siteSearchEngine', + * await discoveryengine.projects.locations.collections.dataStores.create({ + * // Resource name of the CmekConfig to use for protecting this DataStore. + * cmekConfigName: 'placeholder-value', + * // A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. + * createAdvancedSiteSearch: 'placeholder-value', + * // Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. + * dataStoreId: 'placeholder-value', + * // DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well. + * disableCmek: 'placeholder-value', + * // Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`. + * parent: + * 'projects/my-project/locations/my-location/collections/my-collection', + * // A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified. + * skipDefaultSchemaCreation: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "aclEnabled": false, + * // "advancedSiteSearchConfig": {}, + * // "billingEstimation": {}, + * // "cmekConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", + * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime", + * // "contentConfig": "my_contentConfig", + * // "createTime": "my_createTime", + * // "defaultSchemaId": "my_defaultSchemaId", + * // "displayName": "my_displayName", + * // "documentProcessingConfig": {}, + * // "healthcareFhirConfig": {}, + * // "identityMappingStore": "my_identityMappingStore", + * // "idpConfig": {}, + * // "industryVertical": "my_industryVertical", + * // "isInfobotFaqDataStore": false, + * // "kmsKeyName": "my_kmsKeyName", + * // "languageInfo": {}, + * // "name": "my_name", + * // "naturalLanguageQueryUnderstandingConfig": {}, + * // "servingConfigDataStore": {}, + * // "solutionTypes": [], + * // "startingSchema": {}, + * // "workspaceConfig": {} + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response * // { - * // "name": "my_name" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -23200,62 +24175,58 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Create, options: StreamMethodOptions ): Promise>; - getSiteSearchEngine( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, + create( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Create, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Create, + callback: BodyResponseCallback ): void; - getSiteSearchEngine( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - getSiteSearchEngine( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Create; options = {}; } @@ -23269,31 +24240,32 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+parent}/dataStores').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists all the DataStores associated with the project. + * Deletes a DataStore. * @example * ```js * // Before running the sample: @@ -23326,23 +24298,19 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.list({ - * // Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'` - * filter: 'placeholder-value', - * // Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned. - * pageSize: 'placeholder-value', - * // A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned. - * pageToken: 'placeholder-value', - * // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned. - * parent: - * 'projects/my-project/locations/my-location/collections/my-collection', + * await discoveryengine.projects.locations.collections.dataStores.delete({ + * // Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error is returned. + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', * }); * console.log(res.data); * * // Example response * // { - * // "dataStores": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -23358,62 +24326,58 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$List, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$List, + delete( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$List, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$List, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - list( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Delete; options = {}; } @@ -23427,34 +24391,29 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/dataStores').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a DataStore + * Gets a DataStore. * @example * ```js * // Before running the sample: @@ -23487,41 +24446,9 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.patch({ - * // Immutable. Identifier. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * await discoveryengine.projects.locations.collections.dataStores.get({ + * // Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', - * // Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "aclEnabled": false, - * // "advancedSiteSearchConfig": {}, - * // "billingEstimation": {}, - * // "cmekConfig": {}, - * // "configurableBillingApproach": "my_configurableBillingApproach", - * // "contentConfig": "my_contentConfig", - * // "createTime": "my_createTime", - * // "defaultSchemaId": "my_defaultSchemaId", - * // "displayName": "my_displayName", - * // "documentProcessingConfig": {}, - * // "healthcareFhirConfig": {}, - * // "identityMappingStore": "my_identityMappingStore", - * // "idpConfig": {}, - * // "industryVertical": "my_industryVertical", - * // "isInfobotFaqDataStore": false, - * // "kmsKeyName": "my_kmsKeyName", - * // "languageInfo": {}, - * // "name": "my_name", - * // "naturalLanguageQueryUnderstandingConfig": {}, - * // "servingConfigDataStore": {}, - * // "solutionTypes": [], - * // "startingSchema": {}, - * // "workspaceConfig": {} - * // } - * }, * }); * console.log(res.data); * @@ -23532,6 +24459,7 @@ export namespace discoveryengine_v1alpha { * // "billingEstimation": {}, * // "cmekConfig": {}, * // "configurableBillingApproach": "my_configurableBillingApproach", + * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -23565,38 +24493,38 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Get, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Patch, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Get, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Get, callback: BodyResponseCallback ): void; - patch( + get( callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Patch + | Params$Resource$Projects$Locations$Collections$Datastores$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -23614,13 +24542,13 @@ export namespace discoveryengine_v1alpha { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Patch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Get; options = {}; } @@ -23635,7 +24563,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -23658,7 +24586,7 @@ export namespace discoveryengine_v1alpha { } /** - * Trains a custom model. + * Gets a DocumentProcessingConfig. * @example * ```js * // Before running the sample: @@ -23691,33 +24619,20 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.trainCustomModel( + * await discoveryengine.projects.locations.collections.dataStores.getDocumentProcessingConfig( * { - * // Required. The resource name of the Data Store, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models. - * dataStore: - * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "errorConfig": {}, - * // "gcsTrainingInput": {}, - * // "modelId": "my_modelId", - * // "modelType": "my_modelType" - * // } - * }, + * // Required. Full DocumentProcessingConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/documentProcessingConfig` + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/documentProcessingConfig', * }, * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "chunkingConfig": {}, + * // "defaultParsingConfig": {}, * // "name": "my_name", - * // "response": {} + * // "parsingConfigOverrides": {} * // } * } * @@ -23733,58 +24648,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - trainCustomModel( - params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, + getDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig, options: StreamMethodOptions ): Promise>; - trainCustomModel( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, + getDocumentProcessingConfig( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig, options?: MethodOptions - ): Promise>; - trainCustomModel( - params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, + ): Promise< + GaxiosResponseWithHTTP2 + >; + getDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - trainCustomModel( - params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, + getDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - trainCustomModel( - params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, - callback: BodyResponseCallback + getDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig, + callback: BodyResponseCallback ): void; - trainCustomModel( - callback: BodyResponseCallback + getDocumentProcessingConfig( + callback: BodyResponseCallback ): void; - trainCustomModel( + getDocumentProcessingConfig( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig; options = {}; } @@ -23798,32 +24717,31 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+dataStore}:trainCustomModel').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['dataStore'], - pathParams: ['dataStore'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleon resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig. + * Gets the SiteSearchEngine. * @example * ```js * // Before running the sample: @@ -23856,33 +24774,17 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.updateDocumentProcessingConfig( + * await discoveryengine.projects.locations.collections.dataStores.getSiteSearchEngine( * { - * // The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`. - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/documentProcessingConfig', - * // Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.ocr_config If not set, all supported fields are updated. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "chunkingConfig": {}, - * // "defaultParsingConfig": {}, - * // "name": "my_name", - * // "parsingConfigOverrides": {} - * // } - * }, + * // Required. Resource name of SiteSearchEngine, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/siteSearchEngine', * }, * ); * console.log(res.data); * * // Example response * // { - * // "chunkingConfig": {}, - * // "defaultParsingConfig": {}, - * // "name": "my_name", - * // "parsingConfigOverrides": {} + * // "name": "my_name" * // } * } * @@ -23898,62 +24800,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - updateDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig, + getSiteSearchEngine( + params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, options: StreamMethodOptions ): Promise>; - updateDocumentProcessingConfig( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig, + getSiteSearchEngine( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - updateDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig, + getSiteSearchEngine( + params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig, + getSiteSearchEngine( + params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - updateDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig, - callback: BodyResponseCallback + getSiteSearchEngine( + params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, + callback: BodyResponseCallback ): void; - updateDocumentProcessingConfig( - callback: BodyResponseCallback + getSiteSearchEngine( + callback: BodyResponseCallback ): void; - updateDocumentProcessingConfig( + getSiteSearchEngine( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine; options = {}; } @@ -23968,7 +24870,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -23979,183 +24881,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Completequery - extends StandardParameters { - /** - * Required. The parent data store resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. - */ - dataStore?: string; - /** - * 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. - */ - includeTailSuggestions?: boolean; - /** - * Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. - */ - query?: string; - /** - * Specifies the autocomplete data model. 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. - */ - queryModel?: 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 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. - */ - userPseudoId?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Create - extends StandardParameters { - /** - * Resource name of the CmekConfig to use for protecting this DataStore. - */ - cmekConfigName?: string; - /** - * A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. - */ - createAdvancedSiteSearch?: boolean; - /** - * Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. - */ - dataStoreId?: string; - /** - * DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well. - */ - disableCmek?: boolean; - /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`. - */ - parent?: string; - /** - * A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified. - */ - skipDefaultSchemaCreation?: boolean; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDataStore; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Delete - extends StandardParameters { - /** - * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Get - extends StandardParameters { - /** - * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig - extends StandardParameters { - /** - * Required. Full DocumentProcessingConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/documentProcessingConfig` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine - extends StandardParameters { - /** - * Required. Resource name of SiteSearchEngine, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$List - extends StandardParameters { - /** - * Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'` - */ - filter?: string; - /** - * Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned. - */ - pageSize?: number; - /** - * A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned. - */ - pageToken?: string; - /** - * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Patch - extends StandardParameters { - /** - * Immutable. Identifier. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - */ - name?: string; - /** - * Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDataStore; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel - extends StandardParameters { - /** - * Required. The resource name of the Data Store, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models. - */ - dataStore?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig - extends StandardParameters { - /** - * The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`. - */ - name?: string; - /** - * Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.ocr_config If not set, all supported fields are updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig; - } - - export class Resource$Projects$Locations$Collections$Datastores$Branches { - context: APIRequestContext; - documents: Resource$Projects$Locations$Collections$Datastores$Branches$Documents; - operations: Resource$Projects$Locations$Collections$Datastores$Branches$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.documents = - new Resource$Projects$Locations$Collections$Datastores$Branches$Documents( - this.context - ); - this.operations = - new Resource$Projects$Locations$Collections$Datastores$Branches$Operations( - this.context - ); - } /** - * Gets index freshness metadata for Documents. Supported for website search only. + * Lists all the DataStores associated with the project. * @example * ```js * // Before running the sample: @@ -24188,22 +24926,23 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.branches.batchGetDocumentsMetadata( - * { - * // Required. The FHIR resources to match by. Format: projects/{project\}/locations/{location\}/datasets/{dataset\}/fhirStores/{fhir_store\}/fhir/{resource_type\}/{fhir_resource_id\} - * 'matcher.fhirMatcher.fhirResources': 'placeholder-value', - * // The exact URIs to match by. - * 'matcher.urisMatcher.uris': 'placeholder-value', - * // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. - * parent: - * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/branches/my-branche', - * }, - * ); + * await discoveryengine.projects.locations.collections.dataStores.list({ + * // Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'` + * filter: 'placeholder-value', + * // Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned. + * pageSize: 'placeholder-value', + * // A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned. + * pageToken: 'placeholder-value', + * // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned. + * parent: + * 'projects/my-project/locations/my-location/collections/my-collection', + * }); * console.log(res.data); * * // Example response * // { - * // "documentsMetadata": [] + * // "dataStores": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -24219,62 +24958,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchGetDocumentsMetadata( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$List, options: StreamMethodOptions ): Promise>; - batchGetDocumentsMetadata( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - batchGetDocumentsMetadata( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchGetDocumentsMetadata( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchGetDocumentsMetadata( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$List, + callback: BodyResponseCallback ): void; - batchGetDocumentsMetadata( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - batchGetDocumentsMetadata( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata; + {} as Params$Resource$Projects$Locations$Collections$Datastores$List; options = {}; } @@ -24288,9 +25027,10 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+parent}/batchGetDocumentsMetadata' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+parent}/dataStores').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -24302,19 +25042,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Retrieves a Branch. + * Updates a DataStore * @example * ```js * // Before running the sample: @@ -24347,23 +25087,71 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.branches.get( - * { - * // Required. The name of the branch to retrieve. Format: `projects/x/locations/global/dataStores/default_data_store/branches/some_branch_id`. "default_branch" can be used as a special branch_id, it returns the default branch that has been set for the document. - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/branches/my-branche', - * // The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified. - * view: 'placeholder-value', + * await discoveryengine.projects.locations.collections.dataStores.patch({ + * // Immutable. Identifier. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', + * // Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "aclEnabled": false, + * // "advancedSiteSearchConfig": {}, + * // "billingEstimation": {}, + * // "cmekConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", + * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime", + * // "contentConfig": "my_contentConfig", + * // "createTime": "my_createTime", + * // "defaultSchemaId": "my_defaultSchemaId", + * // "displayName": "my_displayName", + * // "documentProcessingConfig": {}, + * // "healthcareFhirConfig": {}, + * // "identityMappingStore": "my_identityMappingStore", + * // "idpConfig": {}, + * // "industryVertical": "my_industryVertical", + * // "isInfobotFaqDataStore": false, + * // "kmsKeyName": "my_kmsKeyName", + * // "languageInfo": {}, + * // "name": "my_name", + * // "naturalLanguageQueryUnderstandingConfig": {}, + * // "servingConfigDataStore": {}, + * // "solutionTypes": [], + * // "startingSchema": {}, + * // "workspaceConfig": {} + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response * // { - * // "branchStats": {}, + * // "aclEnabled": false, + * // "advancedSiteSearchConfig": {}, + * // "billingEstimation": {}, + * // "cmekConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", + * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime", + * // "contentConfig": "my_contentConfig", + * // "createTime": "my_createTime", + * // "defaultSchemaId": "my_defaultSchemaId", * // "displayName": "my_displayName", - * // "isDefault": false, - * // "lastDocumentImportTime": "my_lastDocumentImportTime", - * // "name": "my_name" + * // "documentProcessingConfig": {}, + * // "healthcareFhirConfig": {}, + * // "identityMappingStore": "my_identityMappingStore", + * // "idpConfig": {}, + * // "industryVertical": "my_industryVertical", + * // "isInfobotFaqDataStore": false, + * // "kmsKeyName": "my_kmsKeyName", + * // "languageInfo": {}, + * // "name": "my_name", + * // "naturalLanguageQueryUnderstandingConfig": {}, + * // "servingConfigDataStore": {}, + * // "solutionTypes": [], + * // "startingSchema": {}, + * // "workspaceConfig": {} * // } * } * @@ -24379,62 +25167,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Get, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Get, + patch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Patch, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Get, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Get, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - get( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Patch; options = {}; } @@ -24449,7 +25237,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -24460,19 +25248,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists all Branchs under the specified parent DataStore. + * Trains a custom model. * @example * ```js * // Before running the sample: @@ -24505,20 +25293,33 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.branches.list( + * await discoveryengine.projects.locations.collections.dataStores.trainCustomModel( * { - * // Required. The parent data store resource name. - * parent: + * // Required. The resource name of the Data Store, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models. + * dataStore: * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', - * // The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified. - * view: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "errorConfig": {}, + * // "gcsTrainingInput": {}, + * // "modelId": "my_modelId", + * // "modelType": "my_modelType" + * // } + * }, * }, * ); * console.log(res.data); * * // Example response * // { - * // "branches": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -24534,62 +25335,58 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$List, + trainCustomModel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$List, + trainCustomModel( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$List, + ): Promise>; + trainCustomModel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$List, + trainCustomModel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$List, - callback: BodyResponseCallback + trainCustomModel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + trainCustomModel( + callback: BodyResponseCallback ): void; - list( + trainCustomModel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel; options = {}; } @@ -24603,84 +25400,32 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/branches').replace( + url: (rootUrl + '/v1alpha/{+dataStore}:trainCustomModel').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['dataStore'], + pathParams: ['dataStore'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata - extends StandardParameters { - /** - * Required. The FHIR resources to match by. Format: projects/{project\}/locations/{location\}/datasets/{dataset\}/fhirStores/{fhir_store\}/fhir/{resource_type\}/{fhir_resource_id\} - */ - 'matcher.fhirMatcher.fhirResources'?: string[]; - /** - * The exact URIs to match by. - */ - 'matcher.urisMatcher.uris'?: string[]; - /** - * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Get - extends StandardParameters { - /** - * Required. The name of the branch to retrieve. Format: `projects/x/locations/global/dataStores/default_data_store/branches/some_branch_id`. "default_branch" can be used as a special branch_id, it returns the default branch that has been set for the document. - */ - name?: string; - /** - * The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified. - */ - view?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$List - extends StandardParameters { - /** - * Required. The parent data store resource name. - */ - parent?: string; - /** - * The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified. - */ - view?: string; - } - - export class Resource$Projects$Locations$Collections$Datastores$Branches$Documents { - context: APIRequestContext; - chunks: Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks; - constructor(context: APIRequestContext) { - this.context = context; - this.chunks = - new Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks( - this.context - ); - } /** - * Creates a Document. + * Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleon resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig. * @example * ```js * // Before running the sample: @@ -24713,29 +25458,21 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.branches.documents.create( + * await discoveryengine.projects.locations.collections.dataStores.updateDocumentProcessingConfig( * { - * // Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. - * documentId: 'placeholder-value', - * // Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. - * parent: - * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/branches/my-branche', + * // The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`. + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/documentProcessingConfig', + * // Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.ocr_config If not set, all supported fields are updated. + * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "aclInfo": {}, - * // "content": {}, - * // "derivedStructData": {}, - * // "id": "my_id", - * // "indexStatus": {}, - * // "indexTime": "my_indexTime", - * // "jsonData": "my_jsonData", + * // "chunkingConfig": {}, + * // "defaultParsingConfig": {}, * // "name": "my_name", - * // "parentDocumentId": "my_parentDocumentId", - * // "schemaId": "my_schemaId", - * // "structData": {} + * // "parsingConfigOverrides": {} * // } * }, * }, @@ -24744,17 +25481,10 @@ export namespace discoveryengine_v1alpha { * * // Example response * // { - * // "aclInfo": {}, - * // "content": {}, - * // "derivedStructData": {}, - * // "id": "my_id", - * // "indexStatus": {}, - * // "indexTime": "my_indexTime", - * // "jsonData": "my_jsonData", + * // "chunkingConfig": {}, + * // "defaultParsingConfig": {}, * // "name": "my_name", - * // "parentDocumentId": "my_parentDocumentId", - * // "schemaId": "my_schemaId", - * // "structData": {} + * // "parsingConfigOverrides": {} * // } * } * @@ -24770,62 +25500,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, + updateDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, + updateDocumentProcessingConfig( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, + updateDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, + updateDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, - callback: BodyResponseCallback + updateDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + updateDocumentProcessingConfig( + callback: BodyResponseCallback ): void; - create( + updateDocumentProcessingConfig( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig; options = {}; } @@ -24839,34 +25569,195 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/documents').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Completequery + extends StandardParameters { /** - * Deletes a Document. + * Required. The parent data store resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. + */ + dataStore?: string; + /** + * 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. + */ + includeTailSuggestions?: boolean; + /** + * Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. + */ + query?: string; + /** + * Specifies the autocomplete data model. 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. + */ + queryModel?: 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 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + userPseudoId?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Create + extends StandardParameters { + /** + * Resource name of the CmekConfig to use for protecting this DataStore. + */ + cmekConfigName?: string; + /** + * A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. + */ + createAdvancedSiteSearch?: boolean; + /** + * Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. + */ + dataStoreId?: string; + /** + * DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well. + */ + disableCmek?: boolean; + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`. + */ + parent?: string; + /** + * A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified. + */ + skipDefaultSchemaCreation?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDataStore; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Delete + extends StandardParameters { + /** + * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Get + extends StandardParameters { + /** + * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig + extends StandardParameters { + /** + * Required. Full DocumentProcessingConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/documentProcessingConfig` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine + extends StandardParameters { + /** + * Required. Resource name of SiteSearchEngine, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$List + extends StandardParameters { + /** + * Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'` + */ + filter?: string; + /** + * Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned. + */ + pageSize?: number; + /** + * A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned. + */ + pageToken?: string; + /** + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Patch + extends StandardParameters { + /** + * Immutable. Identifier. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string; + /** + * Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDataStore; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel + extends StandardParameters { + /** + * Required. The resource name of the Data Store, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models. + */ + dataStore?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig + extends StandardParameters { + /** + * The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`. + */ + name?: string; + /** + * Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.ocr_config If not set, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig; + } + + export class Resource$Projects$Locations$Collections$Datastores$Branches { + context: APIRequestContext; + documents: Resource$Projects$Locations$Collections$Datastores$Branches$Documents; + operations: Resource$Projects$Locations$Collections$Datastores$Branches$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.documents = + new Resource$Projects$Locations$Collections$Datastores$Branches$Documents( + this.context + ); + this.operations = + new Resource$Projects$Locations$Collections$Datastores$Branches$Operations( + this.context + ); + } + + /** + * Gets index freshness metadata for Documents. Supported for website search only. * @example * ```js * // Before running the sample: @@ -24899,16 +25790,23 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.branches.documents.delete( + * await discoveryengine.projects.locations.collections.dataStores.branches.batchGetDocumentsMetadata( * { - * // Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned. - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/branches/my-branche/documents/my-document', + * // Required. The FHIR resources to match by. Format: projects/{project\}/locations/{location\}/datasets/{dataset\}/fhirStores/{fhir_store\}/fhir/{resource_type\}/{fhir_resource_id\} + * 'matcher.fhirMatcher.fhirResources': 'placeholder-value', + * // The exact URIs to match by. + * 'matcher.urisMatcher.uris': 'placeholder-value', + * // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + * parent: + * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/branches/my-branche', * }, * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "documentsMetadata": [] + * // } * } * * main().catch(e => { @@ -24923,54 +25821,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, + batchGetDocumentsMetadata( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, + batchGetDocumentsMetadata( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + batchGetDocumentsMetadata( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + batchGetDocumentsMetadata( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, - callback: BodyResponseCallback + batchGetDocumentsMetadata( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + batchGetDocumentsMetadata( + callback: BodyResponseCallback + ): void; + batchGetDocumentsMetadata( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata; options = {}; } @@ -24984,29 +25890,33 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: ( + rootUrl + '/v1alpha/{+parent}/batchGetDocumentsMetadata' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a Document. + * Retrieves a Branch. * @example * ```js * // Before running the sample: @@ -25039,27 +25949,23 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.branches.documents.get( + * await discoveryengine.projects.locations.collections.dataStores.branches.get( * { - * // Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/branches/my-branche/documents/my-document', + * // Required. The name of the branch to retrieve. Format: `projects/x/locations/global/dataStores/default_data_store/branches/some_branch_id`. "default_branch" can be used as a special branch_id, it returns the default branch that has been set for the document. + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/branches/my-branche', + * // The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified. + * view: 'placeholder-value', * }, * ); * console.log(res.data); * * // Example response * // { - * // "aclInfo": {}, - * // "content": {}, - * // "derivedStructData": {}, - * // "id": "my_id", - * // "indexStatus": {}, - * // "indexTime": "my_indexTime", - * // "jsonData": "my_jsonData", - * // "name": "my_name", - * // "parentDocumentId": "my_parentDocumentId", - * // "schemaId": "my_schemaId", - * // "structData": {} + * // "branchStats": {}, + * // "displayName": "my_displayName", + * // "isDefault": false, + * // "lastDocumentImportTime": "my_lastDocumentImportTime", + * // "name": "my_name" * // } * } * @@ -25076,61 +25982,61 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Get; options = {}; } @@ -25156,19 +26062,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets the parsed layout information for a Document. + * Lists all Branchs under the specified parent DataStore. * @example * ```js * // Before running the sample: @@ -25201,24 +26107,20 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.branches.documents.getProcessedDocument( + * await discoveryengine.projects.locations.collections.dataStores.branches.list( * { - * // Optional. Specifies config for IMAGE_BYTES. - * imageId: 'placeholder-value', - * // Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/branches/my-branche/documents/my-document', - * // What format output should be. If unspecified, defaults to JSON. - * processedDocumentFormat: 'placeholder-value', - * // Required. What type of processing to return. - * processedDocumentType: 'placeholder-value', + * // Required. The parent data store resource name. + * parent: + * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', + * // The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified. + * view: 'placeholder-value', * }, * ); * console.log(res.data); * * // Example response * // { - * // "document": "my_document", - * // "jsonData": "my_jsonData" + * // "branches": [] * // } * } * @@ -25234,62 +26136,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getProcessedDocument( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$List, options: StreamMethodOptions ): Promise>; - getProcessedDocument( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - getProcessedDocument( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getProcessedDocument( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getProcessedDocument( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$List, + callback: BodyResponseCallback ): void; - getProcessedDocument( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - getProcessedDocument( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$List; options = {}; } @@ -25303,7 +26205,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}:getProcessedDocument').replace( + url: (rootUrl + '/v1alpha/{+parent}/branches').replace( /([^:]\/)\/+/g, '$1' ), @@ -25313,24 +26215,74 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata + extends StandardParameters { /** - * Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents to be successfully updated. + * Required. The FHIR resources to match by. Format: projects/{project\}/locations/{location\}/datasets/{dataset\}/fhirStores/{fhir_store\}/fhir/{resource_type\}/{fhir_resource_id\} + */ + 'matcher.fhirMatcher.fhirResources'?: string[]; + /** + * The exact URIs to match by. + */ + 'matcher.urisMatcher.uris'?: string[]; + /** + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Get + extends StandardParameters { + /** + * Required. The name of the branch to retrieve. Format: `projects/x/locations/global/dataStores/default_data_store/branches/some_branch_id`. "default_branch" can be used as a special branch_id, it returns the default branch that has been set for the document. + */ + name?: string; + /** + * The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified. + */ + view?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$List + extends StandardParameters { + /** + * Required. The parent data store resource name. + */ + parent?: string; + /** + * The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified. + */ + view?: string; + } + + export class Resource$Projects$Locations$Collections$Datastores$Branches$Documents { + context: APIRequestContext; + chunks: Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks; + constructor(context: APIRequestContext) { + this.context = context; + this.chunks = + new Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks( + this.context + ); + } + + /** + * Creates a Document. * @example * ```js * // Before running the sample: @@ -25363,9 +26315,11 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.branches.documents.import( + * await discoveryengine.projects.locations.collections.dataStores.branches.documents.create( * { - * // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Requires create/update permission. + * // Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + * documentId: 'placeholder-value', + * // Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. * parent: * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/branches/my-branche', * @@ -25373,21 +26327,17 @@ export namespace discoveryengine_v1alpha { * requestBody: { * // request body parameters * // { - * // "alloyDbSource": {}, - * // "autoGenerateIds": false, - * // "bigquerySource": {}, - * // "bigtableSource": {}, - * // "cloudSqlSource": {}, - * // "errorConfig": {}, - * // "fhirStoreSource": {}, - * // "firestoreSource": {}, - * // "forceRefreshContent": false, - * // "gcsSource": {}, - * // "idField": "my_idField", - * // "inlineSource": {}, - * // "reconciliationMode": "my_reconciliationMode", - * // "spannerSource": {}, - * // "updateMask": "my_updateMask" + * // "aclInfo": {}, + * // "content": {}, + * // "derivedStructData": {}, + * // "id": "my_id", + * // "indexStatus": {}, + * // "indexTime": "my_indexTime", + * // "jsonData": "my_jsonData", + * // "name": "my_name", + * // "parentDocumentId": "my_parentDocumentId", + * // "schemaId": "my_schemaId", + * // "structData": {} * // } * }, * }, @@ -25396,11 +26346,17 @@ export namespace discoveryengine_v1alpha { * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "aclInfo": {}, + * // "content": {}, + * // "derivedStructData": {}, + * // "id": "my_id", + * // "indexStatus": {}, + * // "indexTime": "my_indexTime", + * // "jsonData": "my_jsonData", * // "name": "my_name", - * // "response": {} + * // "parentDocumentId": "my_parentDocumentId", + * // "schemaId": "my_schemaId", + * // "structData": {} * // } * } * @@ -25416,58 +26372,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, options: StreamMethodOptions ): Promise>; - import( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, + create( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, options?: MethodOptions - ): Promise>; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - import( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create; options = {}; } @@ -25481,7 +26441,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/documents:import').replace( + url: (rootUrl + '/v1alpha/{+parent}/documents').replace( /([^:]\/)\/+/g, '$1' ), @@ -25496,17 +26456,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a list of Documents. + * Deletes a Document. * @example * ```js * // Before running the sample: @@ -25539,24 +26501,16 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.branches.documents.list( + * await discoveryengine.projects.locations.collections.dataStores.branches.documents.delete( * { - * // Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. - * pageSize: 'placeholder-value', - * // A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. - * pageToken: 'placeholder-value', - * // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned. - * parent: - * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/branches/my-branche', + * // Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned. + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/branches/my-branche/documents/my-document', * }, * ); * console.log(res.data); * * // Example response - * // { - * // "documents": [], - * // "nextPageToken": "my_nextPageToken" - * // } + * // {} * } * * main().catch(e => { @@ -25571,62 +26525,54 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, + delete( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete; options = {}; } @@ -25640,34 +26586,29 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/documents').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a Document. + * Gets a Document. * @example * ```js * // Before running the sample: @@ -25700,32 +26641,10 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.branches.documents.patch( + * await discoveryengine.projects.locations.collections.dataStores.branches.documents.get( * { - * // If set to `true` and the Document is not found, a new Document is be created. - * allowMissing: 'placeholder-value', - * // 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. + * // Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/branches/my-branche/documents/my-document', - * // Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "aclInfo": {}, - * // "content": {}, - * // "derivedStructData": {}, - * // "id": "my_id", - * // "indexStatus": {}, - * // "indexTime": "my_indexTime", - * // "jsonData": "my_jsonData", - * // "name": "my_name", - * // "parentDocumentId": "my_parentDocumentId", - * // "schemaId": "my_schemaId", - * // "structData": {} - * // } - * }, * }, * ); * console.log(res.data); @@ -25758,38 +26677,38 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, callback: BodyResponseCallback ): void; - patch( + get( callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -25807,13 +26726,13 @@ export namespace discoveryengine_v1alpha { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get; options = {}; } @@ -25828,7 +26747,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -25851,7 +26770,7 @@ export namespace discoveryengine_v1alpha { } /** - * Permanently deletes all selected Documents in a branch. This process is asynchronous. Depending on the number of Documents to be deleted, this operation can take hours to complete. Before the delete operation completes, some Documents might still be returned by DocumentService.GetDocument or DocumentService.ListDocuments. To get a list of the Documents to be deleted, set PurgeDocumentsRequest.force to false. + * Gets the parsed layout information for a Document. * @example * ```js * // Before running the sample: @@ -25884,34 +26803,24 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.branches.documents.purge( + * await discoveryengine.projects.locations.collections.dataStores.branches.documents.getProcessedDocument( * { - * // Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. - * parent: - * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/branches/my-branche', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "errorConfig": {}, - * // "filter": "my_filter", - * // "force": false, - * // "gcsSource": {}, - * // "inlineSource": {} - * // } - * }, + * // Optional. Specifies config for IMAGE_BYTES. + * imageId: 'placeholder-value', + * // Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/branches/my-branche/documents/my-document', + * // What format output should be. If unspecified, defaults to JSON. + * processedDocumentFormat: 'placeholder-value', + * // Required. What type of processing to return. + * processedDocumentType: 'placeholder-value', * }, * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "document": "my_document", + * // "jsonData": "my_jsonData" * // } * } * @@ -25927,58 +26836,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, + getProcessedDocument( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, options: StreamMethodOptions ): Promise>; - purge( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, + getProcessedDocument( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, options?: MethodOptions - ): Promise>; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, + ): Promise< + GaxiosResponseWithHTTP2 + >; + getProcessedDocument( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, + getProcessedDocument( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, - callback: BodyResponseCallback + getProcessedDocument( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, + callback: BodyResponseCallback ): void; - purge( - callback: BodyResponseCallback + getProcessedDocument( + callback: BodyResponseCallback ): void; - purge( + getProcessedDocument( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument; options = {}; } @@ -25992,148 +26905,34 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/documents:purge').replace( + url: (rootUrl + '/v1alpha/{+name}:getProcessedDocument').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create - extends StandardParameters { - /** - * Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. - */ - documentId?: string; - /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocument; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete - extends StandardParameters { - /** - * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get - extends StandardParameters { - /** - * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument - extends StandardParameters { - /** - * Optional. Specifies config for IMAGE_BYTES. - */ - imageId?: string; - /** - * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. - */ - name?: string; - /** - * What format output should be. If unspecified, defaults to JSON. - */ - processedDocumentFormat?: string; - /** - * Required. What type of processing to return. - */ - processedDocumentType?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import - extends StandardParameters { - /** - * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Requires create/update permission. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List - extends StandardParameters { - /** - * Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. - */ - pageSize?: number; - /** - * A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. - */ - pageToken?: string; - /** - * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch - extends StandardParameters { - /** - * If set to `true` and the Document is not found, a new Document is be created. - */ - allowMissing?: boolean; - /** - * 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. - */ - name?: string; - /** - * Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocument; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge - extends StandardParameters { - /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest; - } - - export class Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Gets a Document. + * Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents to be successfully updated. * @example * ```js * // Before running the sample: @@ -26166,27 +26965,44 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.branches.documents.chunks.get( + * await discoveryengine.projects.locations.collections.dataStores.branches.documents.import( * { - * // Required. Full resource name of Chunk, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}/chunks/{chunk\}`. If the caller does not have permission to access the Chunk, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Chunk does not exist, a `NOT_FOUND` error is returned. - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/branches/my-branche/documents/my-document/chunks/my-chunk', + * // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Requires create/update permission. + * parent: + * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/branches/my-branche', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "alloyDbSource": {}, + * // "autoGenerateIds": false, + * // "bigquerySource": {}, + * // "bigtableSource": {}, + * // "cloudSqlSource": {}, + * // "errorConfig": {}, + * // "fhirStoreSource": {}, + * // "firestoreSource": {}, + * // "forceRefreshContent": false, + * // "gcsSource": {}, + * // "idField": "my_idField", + * // "inlineSource": {}, + * // "reconciliationMode": "my_reconciliationMode", + * // "spannerSource": {}, + * // "updateMask": "my_updateMask" + * // } + * }, * }, * ); * console.log(res.data); * * // Example response * // { - * // "annotationContents": [], - * // "annotationMetadata": [], - * // "chunkMetadata": {}, - * // "content": "my_content", - * // "dataUrls": [], - * // "derivedStructData": {}, - * // "documentMetadata": {}, - * // "id": "my_id", + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "pageSpan": {}, - * // "relevanceScore": {} + * // "response": {} * // } * } * @@ -26202,62 +27018,58 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, + import( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, + ): Promise>; + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, - callback: BodyResponseCallback + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + import( + callback: BodyResponseCallback ): void; - get( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import; options = {}; } @@ -26271,31 +27083,32 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+parent}/documents:import').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets a list of Chunks. + * Gets a list of Documents. * @example * ```js * // Before running the sample: @@ -26328,22 +27141,22 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.branches.documents.chunks.list( + * await discoveryengine.projects.locations.collections.dataStores.branches.documents.list( * { - * // Maximum number of Chunks to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + * // Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. * pageSize: 'placeholder-value', - * // A page token ListChunksResponse.next_page_token, received from a previous ChunkService.ListChunks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ChunkService.ListChunks must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + * // A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. * pageToken: 'placeholder-value', - * // Required. The parent document resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to list Chunks under this document, regardless of whether or not this document exists, a `PERMISSION_DENIED` error is returned. + * // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned. * parent: - * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/branches/my-branche/documents/my-document', + * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/branches/my-branche', * }, * ); * console.log(res.data); * * // Example response * // { - * // "chunks": [], + * // "documents": [], * // "nextPageToken": "my_nextPageToken" * // } * } @@ -26361,61 +27174,61 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List; options = {}; } @@ -26429,7 +27242,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/chunks').replace( + url: (rootUrl + '/v1alpha/{+parent}/documents').replace( /([^:]\/)\/+/g, '$1' ), @@ -26444,49 +27257,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get - extends StandardParameters { - /** - * Required. Full resource name of Chunk, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}/chunks/{chunk\}`. If the caller does not have permission to access the Chunk, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Chunk does not exist, a `NOT_FOUND` error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List - extends StandardParameters { - /** - * Maximum number of Chunks to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. - */ - pageSize?: number; - /** - * A page token ListChunksResponse.next_page_token, received from a previous ChunkService.ListChunks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ChunkService.ListChunks must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. - */ - pageToken?: string; - /** - * Required. The parent document resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to list Chunks under this document, regardless of whether or not this document exists, a `PERMISSION_DENIED` error is returned. - */ - parent?: string; - } - - export class Resource$Projects$Locations$Collections$Datastores$Branches$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Updates a Document. * @example * ```js * // Before running the sample: @@ -26519,22 +27302,50 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.branches.operations.cancel( + * await discoveryengine.projects.locations.collections.dataStores.branches.documents.patch( * { - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/branches/my-branche/operations/my-operation', + * // If set to `true` and the Document is not found, a new Document is be created. + * allowMissing: 'placeholder-value', + * // 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. + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/branches/my-branche/documents/my-document', + * // Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. + * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters - * // {} + * // { + * // "aclInfo": {}, + * // "content": {}, + * // "derivedStructData": {}, + * // "id": "my_id", + * // "indexStatus": {}, + * // "indexTime": "my_indexTime", + * // "jsonData": "my_jsonData", + * // "name": "my_name", + * // "parentDocumentId": "my_parentDocumentId", + * // "schemaId": "my_schemaId", + * // "structData": {} + * // } * }, * }, * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "aclInfo": {}, + * // "content": {}, + * // "derivedStructData": {}, + * // "id": "my_id", + * // "indexStatus": {}, + * // "indexTime": "my_indexTime", + * // "jsonData": "my_jsonData", + * // "name": "my_name", + * // "parentDocumentId": "my_parentDocumentId", + * // "schemaId": "my_schemaId", + * // "structData": {} + * // } * } * * main().catch(e => { @@ -26549,54 +27360,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, + patch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, + ): Promise< + GaxiosResponseWithHTTP2 + >; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + patch( + callback: BodyResponseCallback + ): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch; options = {}; } @@ -26610,11 +27429,8 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}:cancel').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -26625,17 +27441,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Permanently deletes all selected Documents in a branch. This process is asynchronous. Depending on the number of Documents to be deleted, this operation can take hours to complete. Before the delete operation completes, some Documents might still be returned by DocumentService.GetDocument or DocumentService.ListDocuments. To get a list of the Documents to be deleted, set PurgeDocumentsRequest.force to false. * @example * ```js * // Before running the sample: @@ -26668,10 +27486,23 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.branches.operations.get( + * await discoveryengine.projects.locations.collections.dataStores.branches.documents.purge( * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/branches/my-branche/operations/my-operation', + * // Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + * parent: + * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/branches/my-branche', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "errorConfig": {}, + * // "filter": "my_filter", + * // "force": false, + * // "gcsSource": {}, + * // "inlineSource": {} + * // } + * }, * }, * ); * console.log(res.data); @@ -26698,36 +27529,36 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, + purge( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, options?: MethodOptions ): Promise>; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, callback: BodyResponseCallback ): void; - get( + purge( callback: BodyResponseCallback ): void; - get( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -26743,13 +27574,13 @@ export namespace discoveryengine_v1alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge; options = {}; } @@ -26763,15 +27594,18 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+parent}/documents:purge').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -26783,9 +27617,125 @@ export namespace discoveryengine_v1alpha { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create + extends StandardParameters { /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + documentId?: string; + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocument; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete + extends StandardParameters { + /** + * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get + extends StandardParameters { + /** + * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument + extends StandardParameters { + /** + * Optional. Specifies config for IMAGE_BYTES. + */ + imageId?: string; + /** + * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. + */ + name?: string; + /** + * What format output should be. If unspecified, defaults to JSON. + */ + processedDocumentFormat?: string; + /** + * Required. What type of processing to return. + */ + processedDocumentType?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import + extends StandardParameters { + /** + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Requires create/update permission. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List + extends StandardParameters { + /** + * Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + */ + pageSize?: number; + /** + * A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + pageToken?: string; + /** + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch + extends StandardParameters { + /** + * If set to `true` and the Document is not found, a new Document is be created. + */ + allowMissing?: boolean; + /** + * 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. + */ + name?: string; + /** + * Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocument; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge + extends StandardParameters { + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest; + } + + export class Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a Document. * @example * ```js * // Before running the sample: @@ -26818,27 +27768,27 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.branches.operations.list( + * await discoveryengine.projects.locations.collections.dataStores.branches.documents.chunks.get( * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/branches/my-branche', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', + * // Required. Full resource name of Chunk, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}/chunks/{chunk\}`. If the caller does not have permission to access the Chunk, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Chunk does not exist, a `NOT_FOUND` error is returned. + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/branches/my-branche/documents/my-document/chunks/my-chunk', * }, * ); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "annotationContents": [], + * // "annotationMetadata": [], + * // "chunkMetadata": {}, + * // "content": "my_content", + * // "dataUrls": [], + * // "derivedStructData": {}, + * // "documentMetadata": {}, + * // "id": "my_id", + * // "name": "my_name", + * // "pageSpan": {}, + * // "relevanceScore": {} * // } * } * @@ -26854,62 +27804,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get; options = {}; } @@ -26923,10 +27873,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -26938,69 +27885,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel - extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleLongrunningCancelOperationRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - - export class Resource$Projects$Locations$Collections$Datastores$Completionconfig { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Completes the user input with advanced keyword suggestions. + * Gets a list of Chunks. * @example * ```js * // Before running the sample: @@ -27023,8 +27920,6 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud_search.query', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -27035,38 +27930,23 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.completionConfig.completeQuery( + * await discoveryengine.projects.locations.collections.dataStores.branches.documents.chunks.list( * { - * // Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/x/completionConfig` `projects/x/locations/global/collections/default_collection/engines/x/completionConfig`. - * completionConfig: - * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/completionConfig', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "boostSpec": {}, - * // "experimentIds": [], - * // "includeTailSuggestions": false, - * // "query": "my_query", - * // "queryModel": "my_queryModel", - * // "suggestionTypeSpecs": [], - * // "suggestionTypes": [], - * // "userInfo": {}, - * // "userPseudoId": "my_userPseudoId" - * // } - * }, + * // Maximum number of Chunks to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + * pageSize: 'placeholder-value', + * // A page token ListChunksResponse.next_page_token, received from a previous ChunkService.ListChunks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ChunkService.ListChunks must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + * pageToken: 'placeholder-value', + * // Required. The parent document resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to list Chunks under this document, regardless of whether or not this document exists, a `PERMISSION_DENIED` error is returned. + * parent: + * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/branches/my-branche/documents/my-document', * }, * ); * console.log(res.data); * * // Example response * // { - * // "contentSuggestions": [], - * // "peopleSuggestions": [], - * // "querySuggestions": [], - * // "recentSearchSuggestions": [], - * // "tailMatchTriggered": false + * // "chunks": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -27082,62 +27962,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - completeQuery( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionconfig$Completequery, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, options: StreamMethodOptions ): Promise>; - completeQuery( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Completionconfig$Completequery, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - completeQuery( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionconfig$Completequery, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - completeQuery( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionconfig$Completequery, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - completeQuery( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionconfig$Completequery, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, + callback: BodyResponseCallback ): void; - completeQuery( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - completeQuery( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Completionconfig$Completequery - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Completionconfig$Completequery; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Completionconfig$Completequery; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List; options = {}; } @@ -27151,53 +28031,64 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+completionConfig}:completeQuery' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1alpha/{+parent}/chunks').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['completionConfig'], - pathParams: ['completionConfig'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Completionconfig$Completequery + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get extends StandardParameters { /** - * Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/x/completionConfig` `projects/x/locations/global/collections/default_collection/engines/x/completionConfig`. + * Required. Full resource name of Chunk, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}/chunks/{chunk\}`. If the caller does not have permission to access the Chunk, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Chunk does not exist, a `NOT_FOUND` error is returned. */ - completionConfig?: string; - + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List + extends StandardParameters { /** - * Request body metadata + * Maximum number of Chunks to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest; + pageSize?: number; + /** + * A page token ListChunksResponse.next_page_token, received from a previous ChunkService.ListChunks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ChunkService.ListChunks must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + pageToken?: string; + /** + * Required. The parent document resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to list Chunks under this document, regardless of whether or not this document exists, a `PERMISSION_DENIED` error is returned. + */ + parent?: string; } - export class Resource$Projects$Locations$Collections$Datastores$Completionsuggestions { + export class Resource$Projects$Locations$Collections$Datastores$Branches$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Imports CompletionSuggestions for a DataStore. + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -27220,7 +28111,6 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -27231,34 +28121,22 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.completionSuggestions.import( + * await discoveryengine.projects.locations.collections.dataStores.branches.operations.cancel( * { - * // Required. The parent data store resource name for which to import customer autocomplete suggestions. Follows pattern `projects/x/locations/x/collections/x/dataStores/x` - * parent: - * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/branches/my-branche/operations/my-operation', * * // Request body metadata * requestBody: { * // request body parameters - * // { - * // "bigquerySource": {}, - * // "errorConfig": {}, - * // "gcsSource": {}, - * // "inlineSource": {} - * // } + * // {} * }, * }, * ); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -27273,58 +28151,54 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, + cancel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, options: StreamMethodOptions ): Promise>; - import( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, + cancel( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, options?: MethodOptions - ): Promise>; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, + callback: BodyResponseCallback ): void; - import( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel; options = {}; } @@ -27338,31 +28212,32 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+parent}/completionSuggestions:import' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+name}:cancel').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Permanently deletes all CompletionSuggestions for a DataStore. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -27385,7 +28260,6 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -27396,17 +28270,10 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.completionSuggestions.purge( + * await discoveryengine.projects.locations.collections.dataStores.branches.operations.get( * { - * // Required. The parent data store resource name for which to purge completion suggestions. Follows pattern projects/x/locations/x/collections/x/dataStores/x. - * parent: - * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/branches/my-branche/operations/my-operation', * }, * ); * console.log(res.data); @@ -27433,36 +28300,36 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, options: StreamMethodOptions ): Promise>; - purge( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, options?: MethodOptions ): Promise>; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, callback: BodyResponseCallback ): void; - purge( + get( callback: BodyResponseCallback ): void; - purge( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -27478,13 +28345,13 @@ export namespace discoveryengine_v1alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get; options = {}; } @@ -27498,17 +28365,15 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+parent}/completionSuggestions:purge' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -27520,41 +28385,9 @@ export namespace discoveryengine_v1alpha { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import - extends StandardParameters { - /** - * Required. The parent data store resource name for which to import customer autocomplete suggestions. Follows pattern `projects/x/locations/x/collections/x/dataStores/x` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge - extends StandardParameters { - /** - * Required. The parent data store resource name for which to purge completion suggestions. Follows pattern projects/x/locations/x/collections/x/dataStores/x. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsRequest; - } - - export class Resource$Projects$Locations$Collections$Datastores$Controls { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -27587,48 +28420,27 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.controls.create( + * await discoveryengine.projects.locations.collections.dataStores.branches.operations.list( * { - * // Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. - * controlId: 'placeholder-value', - * // Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. - * parent: - * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "associatedServingConfigIds": [], - * // "boostAction": {}, - * // "conditions": [], - * // "displayName": "my_displayName", - * // "filterAction": {}, - * // "name": "my_name", - * // "promoteAction": {}, - * // "redirectAction": {}, - * // "solutionType": "my_solutionType", - * // "synonymsAction": {}, - * // "useCases": [] - * // } - * }, + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/branches/my-branche', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); * * // Example response * // { - * // "associatedServingConfigIds": [], - * // "boostAction": {}, - * // "conditions": [], - * // "displayName": "my_displayName", - * // "filterAction": {}, - * // "name": "my_name", - * // "promoteAction": {}, - * // "redirectAction": {}, - * // "solutionType": "my_solutionType", - * // "synonymsAction": {}, - * // "useCases": [] + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -27644,62 +28456,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - create( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List; options = {}; } @@ -27713,34 +28525,84 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/controls').replace( + url: (rootUrl + '/v1alpha/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel + extends StandardParameters { /** - * Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. + * The name of the operation resource to be cancelled. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleLongrunningCancelOperationRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + + export class Resource$Projects$Locations$Collections$Datastores$Completionconfig { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Completes the user input with advanced keyword suggestions. * @example * ```js * // Before running the sample: @@ -27763,6 +28625,8 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud_search.query', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -27773,16 +28637,39 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.controls.delete( + * await discoveryengine.projects.locations.collections.dataStores.completionConfig.completeQuery( * { - * // Required. The resource name of the Control to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/controls/my-control', + * // Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/x/completionConfig` `projects/x/locations/global/collections/default_collection/engines/x/completionConfig`. + * completionConfig: + * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/completionConfig', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "boostSpec": {}, + * // "experimentIds": [], + * // "includeTailSuggestions": false, + * // "query": "my_query", + * // "queryModel": "my_queryModel", + * // "suggestionTypeSpecs": [], + * // "suggestionTypes": [], + * // "userInfo": {}, + * // "userPseudoId": "my_userPseudoId" + * // } + * }, * }, * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "contentSuggestions": [], + * // "peopleSuggestions": [], + * // "querySuggestions": [], + * // "recentSearchSuggestions": [], + * // "tailMatchTriggered": false + * // } * } * * main().catch(e => { @@ -27797,54 +28684,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, + completeQuery( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionconfig$Completequery, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, + completeQuery( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Completionconfig$Completequery, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + completeQuery( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionconfig$Completequery, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + completeQuery( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionconfig$Completequery, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, - callback: BodyResponseCallback + completeQuery( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionconfig$Completequery, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + completeQuery( + callback: BodyResponseCallback + ): void; + completeQuery( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Completionconfig$Completequery + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Completionconfig$Completequery; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Completionconfig$Completequery; options = {}; } @@ -27858,29 +28753,53 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: ( + rootUrl + '/v1alpha/{+completionConfig}:completeQuery' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['completionConfig'], + pathParams: ['completionConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + + export interface Params$Resource$Projects$Locations$Collections$Datastores$Completionconfig$Completequery + extends StandardParameters { + /** + * Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/x/completionConfig` `projects/x/locations/global/collections/default_collection/engines/x/completionConfig`. + */ + completionConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest; + } + + export class Resource$Projects$Locations$Collections$Datastores$Completionsuggestions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Gets a Control. + * Imports CompletionSuggestions for a DataStore. * @example * ```js * // Before running the sample: @@ -27903,6 +28822,7 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -27913,27 +28833,33 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.controls.get( + * await discoveryengine.projects.locations.collections.dataStores.completionSuggestions.import( * { - * // Required. The resource name of the Control to get. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/controls/my-control', + * // Required. The parent data store resource name for which to import customer autocomplete suggestions. Follows pattern `projects/x/locations/x/collections/x/dataStores/x` + * parent: + * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bigquerySource": {}, + * // "errorConfig": {}, + * // "gcsSource": {}, + * // "inlineSource": {} + * // } + * }, * }, * ); * console.log(res.data); * * // Example response * // { - * // "associatedServingConfigIds": [], - * // "boostAction": {}, - * // "conditions": [], - * // "displayName": "my_displayName", - * // "filterAction": {}, + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "promoteAction": {}, - * // "redirectAction": {}, - * // "solutionType": "my_solutionType", - * // "synonymsAction": {}, - * // "useCases": [] + * // "response": {} * // } * } * @@ -27949,62 +28875,58 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, + import( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, + ): Promise>; + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, - callback: BodyResponseCallback + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + import( + callback: BodyResponseCallback ): void; - get( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import; options = {}; } @@ -28018,31 +28940,31 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: ( + rootUrl + '/v1alpha/{+parent}/completionSuggestions:import' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists all Controls by their parent DataStore. + * Permanently deletes all CompletionSuggestions for a DataStore. * @example * ```js * // Before running the sample: @@ -28065,6 +28987,7 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -28075,25 +28998,28 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.controls.list( + * await discoveryengine.projects.locations.collections.dataStores.completionSuggestions.purge( * { - * // Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. - * filter: 'placeholder-value', - * // Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. - * pageSize: 'placeholder-value', - * // Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. - * pageToken: 'placeholder-value', - * // Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. + * // Required. The parent data store resource name for which to purge completion suggestions. Follows pattern projects/x/locations/x/collections/x/dataStores/x. * parent: * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, * }, * ); * console.log(res.data); * * // Example response * // { - * // "controls": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -28109,62 +29035,58 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, + purge( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, - options: StreamMethodOptions | BodyResponseCallback, + ): Promise>; + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, + options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, - callback: BodyResponseCallback + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + purge( + callback: BodyResponseCallback ): void; - list( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Controls$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge; options = {}; } @@ -28178,11 +29100,10 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/controls').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: ( + rootUrl + '/v1alpha/{+parent}/completionSuggestions:purge' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -28193,19 +29114,49 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import + extends StandardParameters { /** - * Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. + * Required. The parent data store resource name for which to import customer autocomplete suggestions. Follows pattern `projects/x/locations/x/collections/x/dataStores/x` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge + extends StandardParameters { + /** + * Required. The parent data store resource name for which to purge completion suggestions. Follows pattern projects/x/locations/x/collections/x/dataStores/x. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsRequest; + } + + export class Resource$Projects$Locations$Collections$Datastores$Controls { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned. * @example * ```js * // Before running the sample: @@ -28238,12 +29189,13 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.controls.patch( + * await discoveryengine.projects.locations.collections.dataStores.controls.create( * { - * // Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/controls/my-control', - * // Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. - * updateMask: 'placeholder-value', + * // Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. + * controlId: 'placeholder-value', + * // Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. + * parent: + * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', * * // Request body metadata * requestBody: { @@ -28294,38 +29246,38 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, + create( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, callback: BodyResponseCallback ): void; - patch( + create( callback: BodyResponseCallback ): void; - patch( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch + | Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -28343,13 +29295,13 @@ export namespace discoveryengine_v1alpha { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create; options = {}; } @@ -28363,15 +29315,18 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1alpha/{+parent}/controls').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -28385,82 +29340,9 @@ export namespace discoveryengine_v1alpha { ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create - extends StandardParameters { - /** - * Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. - */ - controlId?: string; - /** - * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaControl; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete - extends StandardParameters { - /** - * Required. The resource name of the Control to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get - extends StandardParameters { - /** - * Required. The resource name of the Control to get. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$List - extends StandardParameters { - /** - * Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. - */ - filter?: string; - /** - * Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. - */ - pageSize?: number; - /** - * Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch - extends StandardParameters { - /** - * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` - */ - name?: string; - /** - * Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaControl; - } - - export class Resource$Projects$Locations$Collections$Datastores$Conversations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Converses a conversation. + * Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. * @example * ```js * // Before running the sample: @@ -28493,36 +29375,16 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.conversations.converse( + * await discoveryengine.projects.locations.collections.dataStores.controls.delete( * { - * // Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/conversations/my-conversation', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "boostSpec": {}, - * // "conversation": {}, - * // "filter": "my_filter", - * // "query": {}, - * // "safeSearch": false, - * // "servingConfig": "my_servingConfig", - * // "summarySpec": {}, - * // "userLabels": {} - * // } - * }, + * // Required. The resource name of the Control to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/controls/my-control', * }, * ); * console.log(res.data); * * // Example response - * // { - * // "conversation": {}, - * // "relatedQuestions": [], - * // "reply": {}, - * // "searchResults": [] - * // } + * // {} * } * * main().catch(e => { @@ -28537,62 +29399,54 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - converse( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, options: StreamMethodOptions ): Promise>; - converse( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, + delete( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - converse( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - converse( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - converse( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - converse( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, + callback: BodyResponseCallback ): void; - converse( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete; options = {}; } @@ -28606,11 +29460,8 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}:converse').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -28621,19 +29472,17 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. + * Gets a Control. * @example * ```js * // Before running the sample: @@ -28666,36 +29515,27 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.conversations.create( + * await discoveryengine.projects.locations.collections.dataStores.controls.get( * { - * // Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` - * parent: - * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "endTime": "my_endTime", - * // "messages": [], - * // "name": "my_name", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "userPseudoId": "my_userPseudoId" - * // } - * }, + * // Required. The resource name of the Control to get. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/controls/my-control', * }, * ); * console.log(res.data); * * // Example response * // { - * // "endTime": "my_endTime", - * // "messages": [], + * // "associatedServingConfigIds": [], + * // "boostAction": {}, + * // "conditions": [], + * // "displayName": "my_displayName", + * // "filterAction": {}, * // "name": "my_name", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "userPseudoId": "my_userPseudoId" + * // "promoteAction": {}, + * // "redirectAction": {}, + * // "solutionType": "my_solutionType", + * // "synonymsAction": {}, + * // "useCases": [] * // } * } * @@ -28711,62 +29551,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - create( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get; options = {}; } @@ -28780,34 +29620,31 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/conversations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. + * Lists all Controls by their parent DataStore. * @example * ```js * // Before running the sample: @@ -28840,16 +29677,26 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.conversations.delete( + * await discoveryengine.projects.locations.collections.dataStores.controls.list( * { - * // Required. The resource name of the Conversation to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/conversations/my-conversation', + * // Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. + * filter: 'placeholder-value', + * // Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + * pageSize: 'placeholder-value', + * // Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. + * pageToken: 'placeholder-value', + * // Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. + * parent: + * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', * }, * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "controls": [], + * // "nextPageToken": "my_nextPageToken" + * // } * } * * main().catch(e => { @@ -28864,54 +29711,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Controls$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$List; options = {}; } @@ -28925,29 +29780,34 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1alpha/{+parent}/controls').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a Conversation. + * Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. * @example * ```js * // Before running the sample: @@ -28980,22 +29840,47 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.conversations.get( + * await discoveryengine.projects.locations.collections.dataStores.controls.patch( * { - * // Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/conversations/my-conversation', - * }, - * ); - * console.log(res.data); - * + * // Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/controls/my-control', + * // Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "associatedServingConfigIds": [], + * // "boostAction": {}, + * // "conditions": [], + * // "displayName": "my_displayName", + * // "filterAction": {}, + * // "name": "my_name", + * // "promoteAction": {}, + * // "redirectAction": {}, + * // "solutionType": "my_solutionType", + * // "synonymsAction": {}, + * // "useCases": [] + * // } + * }, + * }, + * ); + * console.log(res.data); + * * // Example response * // { - * // "endTime": "my_endTime", - * // "messages": [], + * // "associatedServingConfigIds": [], + * // "boostAction": {}, + * // "conditions": [], + * // "displayName": "my_displayName", + * // "filterAction": {}, * // "name": "my_name", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "userPseudoId": "my_userPseudoId" + * // "promoteAction": {}, + * // "redirectAction": {}, + * // "solutionType": "my_solutionType", + * // "synonymsAction": {}, + * // "useCases": [] * // } * } * @@ -29011,62 +29896,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, + patch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - get( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch; options = {}; } @@ -29081,7 +29966,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -29092,19 +29977,92 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create + extends StandardParameters { /** - * Lists all Conversations by their parent DataStore. + * Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. + */ + controlId?: string; + /** + * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaControl; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete + extends StandardParameters { + /** + * Required. The resource name of the Control to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get + extends StandardParameters { + /** + * Required. The resource name of the Control to get. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$List + extends StandardParameters { + /** + * Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. + */ + filter?: string; + /** + * Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` + */ + name?: string; + /** + * Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaControl; + } + + export class Resource$Projects$Locations$Collections$Datastores$Conversations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Converses a conversation. * @example * ```js * // Before running the sample: @@ -29137,27 +30095,35 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.conversations.list( + * await discoveryengine.projects.locations.collections.dataStores.conversations.converse( * { - * // A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" - * filter: 'placeholder-value', - * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: "update_time desc" "create_time" - * orderBy: 'placeholder-value', - * // Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. - * pageSize: 'placeholder-value', - * // A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. - * pageToken: 'placeholder-value', - * // Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` - * parent: - * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', + * // Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/conversations/my-conversation', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "boostSpec": {}, + * // "conversation": {}, + * // "filter": "my_filter", + * // "query": {}, + * // "safeSearch": false, + * // "servingConfig": "my_servingConfig", + * // "summarySpec": {}, + * // "userLabels": {} + * // } + * }, * }, * ); * console.log(res.data); * * // Example response * // { - * // "conversations": [], - * // "nextPageToken": "my_nextPageToken" + * // "conversation": {}, + * // "relatedQuestions": [], + * // "reply": {}, + * // "searchResults": [] * // } * } * @@ -29173,62 +30139,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, + converse( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, + converse( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, + converse( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, + converse( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, - callback: BodyResponseCallback + converse( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + converse( + callback: BodyResponseCallback ): void; - list( + converse( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse; options = {}; } @@ -29242,34 +30208,34 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/conversations').replace( + url: (rootUrl + '/v1alpha/{+name}:converse').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned. + * Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. * @example * ```js * // Before running the sample: @@ -29302,12 +30268,11 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.conversations.patch( + * await discoveryengine.projects.locations.collections.dataStores.conversations.create( * { - * // Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`. - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/conversations/my-conversation', - * // Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. - * updateMask: 'placeholder-value', + * // Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` + * parent: + * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', * * // Request body metadata * requestBody: { @@ -29348,38 +30313,38 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, + create( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, callback: BodyResponseCallback ): void; - patch( + create( callback: BodyResponseCallback ): void; - patch( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch + | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -29397,13 +30362,13 @@ export namespace discoveryengine_v1alpha { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create; options = {}; } @@ -29417,15 +30382,18 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1alpha/{+parent}/conversations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -29439,94 +30407,9 @@ export namespace discoveryengine_v1alpha { ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse - extends StandardParameters { - /** - * Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConverseConversationRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create - extends StandardParameters { - /** - * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete - extends StandardParameters { - /** - * Required. The resource name of the Conversation to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get - extends StandardParameters { - /** - * Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List - extends StandardParameters { - /** - * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" - */ - filter?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: "update_time desc" "create_time" - */ - orderBy?: string; - /** - * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch - extends StandardParameters { - /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`. - */ - name?: string; - /** - * Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation; - } - - export class Resource$Projects$Locations$Collections$Datastores$Custommodels { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Gets a list of all the custom models. + * Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. * @example * ```js * // Before running the sample: @@ -29559,19 +30442,16 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.customModels.list( + * await discoveryengine.projects.locations.collections.dataStores.conversations.delete( * { - * // Required. The resource name of the parent Data Store, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to fetch the models from. - * dataStore: - * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', + * // Required. The resource name of the Conversation to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/conversations/my-conversation', * }, * ); * console.log(res.data); * * // Example response - * // { - * // "models": [] - * // } + * // {} * } * * main().catch(e => { @@ -29586,62 +30466,54 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, + delete( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete; options = {}; } @@ -29655,61 +30527,29 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+dataStore}/customModels').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['dataStore'], - pathParams: ['dataStore'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List - extends StandardParameters { /** - * Required. The resource name of the parent Data Store, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to fetch the models from. - */ - dataStore?: string; - } - - export class Resource$Projects$Locations$Collections$Datastores$Models { - context: APIRequestContext; - operations: Resource$Projects$Locations$Collections$Datastores$Models$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Collections$Datastores$Models$Operations( - this.context - ); - } - } - - export class Resource$Projects$Locations$Collections$Datastores$Models$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Gets a Conversation. * @example * ```js * // Before running the sample: @@ -29742,21 +30582,22 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.models.operations.get( + * await discoveryengine.projects.locations.collections.dataStores.conversations.get( * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/models/my-model/operations/my-operation', + * // Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/conversations/my-conversation', * }, * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "endTime": "my_endTime", + * // "messages": [], * // "name": "my_name", - * // "response": {} + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "userPseudoId": "my_userPseudoId" * // } * } * @@ -29773,57 +30614,61 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, options?: MethodOptions - ): Promise>; + ): Promise< + GaxiosResponseWithHTTP2 + >; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get; options = {}; } @@ -29849,17 +30694,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Lists all Conversations by their parent DataStore. * @example * ```js * // Before running the sample: @@ -29892,27 +30739,27 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.models.operations.list( + * await discoveryengine.projects.locations.collections.dataStores.conversations.list( * { - * // The standard list filter. + * // A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/models/my-model', - * // The standard list page size. + * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: "update_time desc" "create_time" + * orderBy: 'placeholder-value', + * // Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. * pageSize: 'placeholder-value', - * // The standard list page token. + * // A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', + * // Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` + * parent: + * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', * }, * ); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "conversations": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -29929,61 +30776,61 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List; options = {}; } @@ -29997,7 +30844,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}/operations').replace( + url: (rootUrl + '/v1alpha/{+parent}/conversations').replace( /([^:]\/)\/+/g, '$1' ), @@ -30007,62 +30854,24 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - - export class Resource$Projects$Locations$Collections$Datastores$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned. * @example * ```js * // Before running the sample: @@ -30095,21 +30904,37 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.operations.get( + * await discoveryengine.projects.locations.collections.dataStores.conversations.patch( * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/operations/my-operation', + * // Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`. + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/conversations/my-conversation', + * // Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "endTime": "my_endTime", + * // "messages": [], + * // "name": "my_name", + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "userPseudoId": "my_userPseudoId" + * // } + * }, * }, * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "endTime": "my_endTime", + * // "messages": [], * // "name": "my_name", - * // "response": {} + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "userPseudoId": "my_userPseudoId" * // } * } * @@ -30125,58 +30950,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, + patch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - get( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch; options = {}; } @@ -30191,7 +31020,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -30202,17 +31031,104 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + + export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse + extends StandardParameters { + /** + * Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. + */ + name?: string; /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConverseConversationRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create + extends StandardParameters { + /** + * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete + extends StandardParameters { + /** + * Required. The resource name of the Conversation to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get + extends StandardParameters { + /** + * Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List + extends StandardParameters { + /** + * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" + */ + filter?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: "update_time desc" "create_time" + */ + orderBy?: string; + /** + * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`. + */ + name?: string; + /** + * Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation; + } + + export class Resource$Projects$Locations$Collections$Datastores$Custommodels { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a list of all the custom models. * @example * ```js * // Before running the sample: @@ -30245,27 +31161,18 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.operations.list( + * await discoveryengine.projects.locations.collections.dataStores.customModels.list( * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', + * // Required. The resource name of the parent Data Store, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to fetch the models from. + * dataStore: + * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', * }, * ); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "models": [] * // } * } * @@ -30282,61 +31189,61 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Operations$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Operations$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List; options = {}; } @@ -30350,7 +31257,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}/operations').replace( + url: (rootUrl + '/v1alpha/{+dataStore}/customModels').replace( /([^:]\/)\/+/g, '$1' ), @@ -30360,67 +31267,51 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['dataStore'], + pathParams: ['dataStore'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Operations$List + export interface Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List extends StandardParameters { /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * Required. The resource name of the parent Data Store, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to fetch the models from. */ - returnPartialSuccess?: boolean; + dataStore?: string; } - export class Resource$Projects$Locations$Collections$Datastores$Schemas { + export class Resource$Projects$Locations$Collections$Datastores$Models { context: APIRequestContext; - operations: Resource$Projects$Locations$Collections$Datastores$Schemas$Operations; + operations: Resource$Projects$Locations$Collections$Datastores$Models$Operations; constructor(context: APIRequestContext) { this.context = context; this.operations = - new Resource$Projects$Locations$Collections$Datastores$Schemas$Operations( + new Resource$Projects$Locations$Collections$Datastores$Models$Operations( this.context ); } + } + + export class Resource$Projects$Locations$Collections$Datastores$Models$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Creates a Schema. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -30453,24 +31344,10 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.schemas.create( + * await discoveryengine.projects.locations.collections.dataStores.models.operations.get( * { - * // Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. - * parent: - * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', - * // Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. - * schemaId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "fieldConfigs": [], - * // "jsonSchema": "my_jsonSchema", - * // "name": "my_name", - * // "structSchema": {} - * // } - * }, + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/models/my-model/operations/my-operation', * }, * ); * console.log(res.data); @@ -30497,36 +31374,36 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, options?: MethodOptions ): Promise>; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, callback: BodyResponseCallback ): void; - create( + get( callback: BodyResponseCallback ): void; - create( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create + | Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -30542,13 +31419,13 @@ export namespace discoveryengine_v1alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get; options = {}; } @@ -30562,18 +31439,15 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/schemas').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -30587,7 +31461,7 @@ export namespace discoveryengine_v1alpha { } /** - * Deletes a Schema. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -30620,21 +31494,27 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.schemas.delete( + * await discoveryengine.projects.locations.collections.dataStores.models.operations.list( * { - * // Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/schemas/my-schema', + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/models/my-model', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -30650,58 +31530,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - delete( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List; options = {}; } @@ -30715,8 +31599,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1alpha/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -30727,17 +31614,57 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get + extends StandardParameters { /** - * Gets a Schema. + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + + export class Resource$Projects$Locations$Collections$Datastores$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -30770,20 +31697,21 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.schemas.get( + * await discoveryengine.projects.locations.collections.dataStores.operations.get( * { - * // Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/schemas/my-schema', + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/operations/my-operation', * }, * ); * console.log(res.data); * * // Example response * // { - * // "fieldConfigs": [], - * // "jsonSchema": "my_jsonSchema", + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "structSchema": {} + * // "response": {} * // } * } * @@ -30800,61 +31728,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; + ): Promise>; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get; options = {}; } @@ -30880,19 +31804,17 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets a list of Schemas. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -30925,15 +31847,18 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.schemas.list( + * await discoveryengine.projects.locations.collections.dataStores.operations.list( * { - * // The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000. + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', + * // The standard list page size. * pageSize: 'placeholder-value', - * // A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token. + * // The standard list page token. * pageToken: 'placeholder-value', - * // Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. - * parent: - * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); @@ -30941,7 +31866,8 @@ export namespace discoveryengine_v1alpha { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "schemas": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -30958,61 +31884,61 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Operations$List; options = {}; } @@ -31026,7 +31952,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/schemas').replace( + url: (rootUrl + '/v1alpha/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -31036,24 +31962,67 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + + export interface Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + + export class Resource$Projects$Locations$Collections$Datastores$Schemas { + context: APIRequestContext; + operations: Resource$Projects$Locations$Collections$Datastores$Schemas$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Collections$Datastores$Schemas$Operations( + this.context + ); + } /** - * Updates a Schema. + * Creates a Schema. * @example * ```js * // Before running the sample: @@ -31086,12 +32055,13 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.schemas.patch( + * await discoveryengine.projects.locations.collections.dataStores.schemas.create( * { - * // If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. - * allowMissing: 'placeholder-value', - * // Immutable. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/schemas/my-schema', + * // Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. + * parent: + * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', + * // Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + * schemaId: 'placeholder-value', * * // Request body metadata * requestBody: { @@ -31129,36 +32099,36 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, + create( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, callback: BodyResponseCallback ): void; - patch( + create( callback: BodyResponseCallback ): void; - patch( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch + | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -31174,13 +32144,13 @@ export namespace discoveryengine_v1alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create; options = {}; } @@ -31194,15 +32164,18 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1alpha/{+parent}/schemas').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -31214,78 +32187,9 @@ export namespace discoveryengine_v1alpha { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create - extends StandardParameters { - /** - * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. - */ - parent?: string; - /** - * Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. - */ - schemaId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSchema; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete - extends StandardParameters { - /** - * Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get - extends StandardParameters { - /** - * Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List - extends StandardParameters { - /** - * The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch - extends StandardParameters { - /** - * If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. - */ - allowMissing?: boolean; - /** - * Immutable. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSchema; - } - - export class Resource$Projects$Locations$Collections$Datastores$Schemas$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Deletes a Schema. * @example * ```js * // Before running the sample: @@ -31318,10 +32222,10 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.schemas.operations.get( + * await discoveryengine.projects.locations.collections.dataStores.schemas.delete( * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/schemas/my-schema/operations/my-operation', + * // Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/schemas/my-schema', * }, * ); * console.log(res.data); @@ -31348,36 +32252,36 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, + delete( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, options?: MethodOptions ): Promise>; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, callback: BodyResponseCallback ): void; - get( + delete( callback: BodyResponseCallback ): void; - get( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get + | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -31393,13 +32297,13 @@ export namespace discoveryengine_v1alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete; options = {}; } @@ -31414,7 +32318,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -31435,7 +32339,7 @@ export namespace discoveryengine_v1alpha { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Gets a Schema. * @example * ```js * // Before running the sample: @@ -31468,27 +32372,20 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.schemas.operations.list( + * await discoveryengine.projects.locations.collections.dataStores.schemas.get( * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. + * // Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/schemas/my-schema', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "fieldConfigs": [], + * // "jsonSchema": "my_jsonSchema", + * // "name": "my_name", + * // "structSchema": {} * // } * } * @@ -31504,62 +32401,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, + callback: BodyResponseCallback ): void; - list( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get; options = {}; } @@ -31573,10 +32470,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -31588,57 +32482,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - - export class Resource$Projects$Locations$Collections$Datastores$Servingconfigs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Answer query method. + * Gets a list of Schemas. * @example * ```js * // Before running the sample: @@ -31671,39 +32527,23 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.servingConfigs.answer( + * await discoveryengine.projects.locations.collections.dataStores.schemas.list( * { - * // Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - * servingConfig: - * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/servingConfigs/my-servingConfig', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "answerGenerationSpec": {}, - * // "asynchronousMode": false, - * // "endUserSpec": {}, - * // "groundingSpec": {}, - * // "query": {}, - * // "queryUnderstandingSpec": {}, - * // "relatedQuestionsSpec": {}, - * // "safetySpec": {}, - * // "searchSpec": {}, - * // "session": "my_session", - * // "userLabels": {}, - * // "userPseudoId": "my_userPseudoId" - * // } - * }, + * // The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000. + * pageSize: 'placeholder-value', + * // A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. + * parent: + * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', * }, * ); * console.log(res.data); * * // Example response * // { - * // "answer": {}, - * // "answerQueryToken": "my_answerQueryToken", - * // "session": {} + * // "nextPageToken": "my_nextPageToken", + * // "schemas": [] * // } * } * @@ -31719,62 +32559,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - answer( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, options: StreamMethodOptions ): Promise>; - answer( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - answer( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - answer( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - answer( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, + callback: BodyResponseCallback ): void; - answer( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - answer( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List; options = {}; } @@ -31788,34 +32628,34 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+servingConfig}:answer').replace( + url: (rootUrl + '/v1alpha/{+parent}/schemas').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. + * Updates a Schema. * @example * ```js * // Before running the sample: @@ -31848,40 +32688,34 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.servingConfigs.get( + * await discoveryengine.projects.locations.collections.dataStores.schemas.patch( * { - * // Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/servingConfigs/my-servingConfig', + * // If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. + * allowMissing: 'placeholder-value', + * // Immutable. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/schemas/my-schema', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "fieldConfigs": [], + * // "jsonSchema": "my_jsonSchema", + * // "name": "my_name", + * // "structSchema": {} + * // } + * }, * }, * ); * console.log(res.data); * * // Example response * // { - * // "answerGenerationSpec": {}, - * // "boostControlIds": [], - * // "createTime": "my_createTime", - * // "customFineTuningSpec": {}, - * // "displayName": "my_displayName", - * // "dissociateControlIds": [], - * // "diversityLevel": "my_diversityLevel", - * // "embeddingConfig": {}, - * // "filterControlIds": [], - * // "genericConfig": {}, - * // "guidedSearchSpec": {}, - * // "ignoreControlIds": [], - * // "mediaConfig": {}, - * // "modelId": "my_modelId", + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "onewaySynonymsControlIds": [], - * // "personalizationSpec": {}, - * // "promoteControlIds": [], - * // "rankingExpression": "my_rankingExpression", - * // "redirectControlIds": [], - * // "replacementControlIds": [], - * // "solutionType": "my_solutionType", - * // "synonymsControlIds": [], - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -31897,62 +32731,58 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, + patch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - get( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch; options = {}; } @@ -31967,7 +32797,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -31978,19 +32808,86 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create + extends StandardParameters { /** - * Lists all ServingConfigs linked to this dataStore. + * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. + */ + parent?: string; + /** + * Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + */ + schemaId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSchema; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete + extends StandardParameters { + /** + * Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get + extends StandardParameters { + /** + * Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List + extends StandardParameters { + /** + * The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch + extends StandardParameters { + /** + * If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. + */ + allowMissing?: boolean; + /** + * Immutable. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSchema; + } + + export class Resource$Projects$Locations$Collections$Datastores$Schemas$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -32023,23 +32920,21 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.servingConfigs.list( + * await discoveryengine.projects.locations.collections.dataStores.schemas.operations.get( * { - * // Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. - * pageSize: 'placeholder-value', - * // Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. - * pageToken: 'placeholder-value', - * // Required. Full resource name of the parent resource. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` - * parent: - * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/schemas/my-schema/operations/my-operation', * }, * ); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "servingConfigs": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -32055,62 +32950,58 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get; options = {}; } @@ -32124,34 +33015,29 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/servingConfigs').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -32184,73 +33070,27 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.servingConfigs.patch( + * await discoveryengine.projects.locations.collections.dataStores.schemas.operations.list( * { - * // Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/servingConfigs/my-servingConfig', - * // Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "answerGenerationSpec": {}, - * // "boostControlIds": [], - * // "createTime": "my_createTime", - * // "customFineTuningSpec": {}, - * // "displayName": "my_displayName", - * // "dissociateControlIds": [], - * // "diversityLevel": "my_diversityLevel", - * // "embeddingConfig": {}, - * // "filterControlIds": [], - * // "genericConfig": {}, - * // "guidedSearchSpec": {}, - * // "ignoreControlIds": [], - * // "mediaConfig": {}, - * // "modelId": "my_modelId", - * // "name": "my_name", - * // "onewaySynonymsControlIds": [], - * // "personalizationSpec": {}, - * // "promoteControlIds": [], - * // "rankingExpression": "my_rankingExpression", - * // "redirectControlIds": [], - * // "replacementControlIds": [], - * // "solutionType": "my_solutionType", - * // "synonymsControlIds": [], - * // "updateTime": "my_updateTime" - * // } - * }, + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/schemas/my-schema', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); * * // Example response * // { - * // "answerGenerationSpec": {}, - * // "boostControlIds": [], - * // "createTime": "my_createTime", - * // "customFineTuningSpec": {}, - * // "displayName": "my_displayName", - * // "dissociateControlIds": [], - * // "diversityLevel": "my_diversityLevel", - * // "embeddingConfig": {}, - * // "filterControlIds": [], - * // "genericConfig": {}, - * // "guidedSearchSpec": {}, - * // "ignoreControlIds": [], - * // "mediaConfig": {}, - * // "modelId": "my_modelId", - * // "name": "my_name", - * // "onewaySynonymsControlIds": [], - * // "personalizationSpec": {}, - * // "promoteControlIds": [], - * // "rankingExpression": "my_rankingExpression", - * // "redirectControlIds": [], - * // "replacementControlIds": [], - * // "solutionType": "my_solutionType", - * // "synonymsControlIds": [], - * // "updateTime": "my_updateTime" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -32266,62 +33106,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - patch( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List; options = {}; } @@ -32335,8 +33175,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1alpha/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -32347,19 +33190,57 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get + extends StandardParameters { /** - * Makes a recommendation, which requires a contextual user event. + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + + export class Resource$Projects$Locations$Collections$Datastores$Servingconfigs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Answer query method. * @example * ```js * // Before running the sample: @@ -32392,9 +33273,9 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.servingConfigs.recommend( + * await discoveryengine.projects.locations.collections.dataStores.servingConfigs.answer( * { - * // Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. + * // Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. * servingConfig: * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/servingConfigs/my-servingConfig', * @@ -32402,12 +33283,18 @@ export namespace discoveryengine_v1alpha { * requestBody: { * // request body parameters * // { - * // "filter": "my_filter", - * // "pageSize": 0, - * // "params": {}, - * // "userEvent": {}, + * // "answerGenerationSpec": {}, + * // "asynchronousMode": false, + * // "endUserSpec": {}, + * // "groundingSpec": {}, + * // "query": {}, + * // "queryUnderstandingSpec": {}, + * // "relatedQuestionsSpec": {}, + * // "safetySpec": {}, + * // "searchSpec": {}, + * // "session": "my_session", * // "userLabels": {}, - * // "validateOnly": false + * // "userPseudoId": "my_userPseudoId" * // } * }, * }, @@ -32416,10 +33303,9 @@ export namespace discoveryengine_v1alpha { * * // Example response * // { - * // "attributionToken": "my_attributionToken", - * // "missingIds": [], - * // "results": [], - * // "validateOnly": false + * // "answer": {}, + * // "answerQueryToken": "my_answerQueryToken", + * // "session": {} * // } * } * @@ -32435,62 +33321,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - recommend( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + answer( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, options: StreamMethodOptions ): Promise>; - recommend( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + answer( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - recommend( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + answer( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recommend( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + answer( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - recommend( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, - callback: BodyResponseCallback + answer( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, + callback: BodyResponseCallback ): void; - recommend( - callback: BodyResponseCallback + answer( + callback: BodyResponseCallback ): void; - recommend( + answer( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer; options = {}; } @@ -32504,7 +33390,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+servingConfig}:recommend').replace( + url: (rootUrl + '/v1alpha/{+servingConfig}:answer').replace( /([^:]\/)\/+/g, '$1' ), @@ -32519,19 +33405,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Performs a search. + * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. * @example * ```js * // Before running the sample: @@ -32554,7 +33440,6 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -32565,79 +33450,40 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.servingConfigs.search( + * await discoveryengine.projects.locations.collections.dataStores.servingConfigs.get( * { - * // Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. - * servingConfig: - * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/servingConfigs/my-servingConfig', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "boostSpec": {}, - * // "branch": "my_branch", - * // "canonicalFilter": "my_canonicalFilter", - * // "contentSearchSpec": {}, - * // "customFineTuningSpec": {}, - * // "dataStoreSpecs": [], - * // "displaySpec": {}, - * // "embeddingSpec": {}, - * // "facetSpecs": [], - * // "filter": "my_filter", - * // "imageQuery": {}, - * // "languageCode": "my_languageCode", - * // "naturalLanguageQueryUnderstandingSpec": {}, - * // "offset": 0, - * // "oneBoxPageSize": 0, - * // "orderBy": "my_orderBy", - * // "pageSize": 0, - * // "pageToken": "my_pageToken", - * // "params": {}, - * // "personalizationSpec": {}, - * // "query": "my_query", - * // "queryExpansionSpec": {}, - * // "rankingExpression": "my_rankingExpression", - * // "rankingExpressionBackend": "my_rankingExpressionBackend", - * // "regionCode": "my_regionCode", - * // "relevanceScoreSpec": {}, - * // "relevanceThreshold": "my_relevanceThreshold", - * // "safeSearch": false, - * // "searchAddonSpec": {}, - * // "searchAsYouTypeSpec": {}, - * // "servingConfig": "my_servingConfig", - * // "session": "my_session", - * // "sessionSpec": {}, - * // "spellCorrectionSpec": {}, - * // "useLatestData": false, - * // "userInfo": {}, - * // "userLabels": {}, - * // "userPseudoId": "my_userPseudoId" - * // } - * }, + * // Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/servingConfigs/my-servingConfig', * }, * ); * console.log(res.data); * * // Example response * // { - * // "appliedControls": [], - * // "attributionToken": "my_attributionToken", - * // "correctedQuery": "my_correctedQuery", - * // "facets": [], - * // "geoSearchDebugInfo": [], - * // "guidedSearchResult": {}, - * // "naturalLanguageQueryUnderstandingInfo": {}, - * // "nextPageToken": "my_nextPageToken", - * // "oneBoxResults": [], - * // "queryExpansionInfo": {}, - * // "redirectUri": "my_redirectUri", - * // "results": [], - * // "searchLinkPromotions": [], - * // "sessionInfo": {}, - * // "suggestedQuery": "my_suggestedQuery", - * // "summary": {}, - * // "totalSize": 0 + * // "answerGenerationSpec": {}, + * // "boostControlIds": [], + * // "createTime": "my_createTime", + * // "customFineTuningSpec": {}, + * // "displayName": "my_displayName", + * // "dissociateControlIds": [], + * // "diversityLevel": "my_diversityLevel", + * // "embeddingConfig": {}, + * // "filterControlIds": [], + * // "genericConfig": {}, + * // "guidedSearchSpec": {}, + * // "ignoreControlIds": [], + * // "mediaConfig": {}, + * // "modelId": "my_modelId", + * // "name": "my_name", + * // "onewaySynonymsControlIds": [], + * // "personalizationSpec": {}, + * // "promoteControlIds": [], + * // "rankingExpression": "my_rankingExpression", + * // "redirectControlIds": [], + * // "replacementControlIds": [], + * // "solutionType": "my_solutionType", + * // "synonymsControlIds": [], + * // "updateTime": "my_updateTime" * // } * } * @@ -32653,62 +33499,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - search( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: StreamMethodOptions ): Promise>; - search( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - search( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - search( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - search( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, + callback: BodyResponseCallback ): void; - search( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - search( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get; options = {}; } @@ -32722,34 +33568,31 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+servingConfig}:search').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Performs a search. Similar to the SearchService.Search method, but a lite version that allows API key for authentication, where OAuth and IAM checks are not required. Only public website search is supported by this method. If data stores and engines not associated with public website search are specified, a `FAILED_PRECONDITION` error is returned. This method can be used for easy onboarding without having to implement an authentication backend. However, it is strongly recommended to use SearchService.Search instead with required OAuth and IAM checks to provide better data security. + * Lists all ServingConfigs linked to this dataStore. * @example * ```js * // Before running the sample: @@ -32772,7 +33615,6 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -32783,79 +33625,23 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.servingConfigs.searchLite( + * await discoveryengine.projects.locations.collections.dataStores.servingConfigs.list( * { - * // Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. - * servingConfig: - * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/servingConfigs/my-servingConfig', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "boostSpec": {}, - * // "branch": "my_branch", - * // "canonicalFilter": "my_canonicalFilter", - * // "contentSearchSpec": {}, - * // "customFineTuningSpec": {}, - * // "dataStoreSpecs": [], - * // "displaySpec": {}, - * // "embeddingSpec": {}, - * // "facetSpecs": [], - * // "filter": "my_filter", - * // "imageQuery": {}, - * // "languageCode": "my_languageCode", - * // "naturalLanguageQueryUnderstandingSpec": {}, - * // "offset": 0, - * // "oneBoxPageSize": 0, - * // "orderBy": "my_orderBy", - * // "pageSize": 0, - * // "pageToken": "my_pageToken", - * // "params": {}, - * // "personalizationSpec": {}, - * // "query": "my_query", - * // "queryExpansionSpec": {}, - * // "rankingExpression": "my_rankingExpression", - * // "rankingExpressionBackend": "my_rankingExpressionBackend", - * // "regionCode": "my_regionCode", - * // "relevanceScoreSpec": {}, - * // "relevanceThreshold": "my_relevanceThreshold", - * // "safeSearch": false, - * // "searchAddonSpec": {}, - * // "searchAsYouTypeSpec": {}, - * // "servingConfig": "my_servingConfig", - * // "session": "my_session", - * // "sessionSpec": {}, - * // "spellCorrectionSpec": {}, - * // "useLatestData": false, - * // "userInfo": {}, - * // "userLabels": {}, - * // "userPseudoId": "my_userPseudoId" - * // } - * }, + * // Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. + * pageSize: 'placeholder-value', + * // Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. + * pageToken: 'placeholder-value', + * // Required. Full resource name of the parent resource. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` + * parent: + * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', * }, * ); * console.log(res.data); * * // Example response * // { - * // "appliedControls": [], - * // "attributionToken": "my_attributionToken", - * // "correctedQuery": "my_correctedQuery", - * // "facets": [], - * // "geoSearchDebugInfo": [], - * // "guidedSearchResult": {}, - * // "naturalLanguageQueryUnderstandingInfo": {}, * // "nextPageToken": "my_nextPageToken", - * // "oneBoxResults": [], - * // "queryExpansionInfo": {}, - * // "redirectUri": "my_redirectUri", - * // "results": [], - * // "searchLinkPromotions": [], - * // "sessionInfo": {}, - * // "suggestedQuery": "my_suggestedQuery", - * // "summary": {}, - * // "totalSize": 0 + * // "servingConfigs": [] * // } * } * @@ -32871,62 +33657,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - searchLite( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Searchlite, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: StreamMethodOptions ): Promise>; - searchLite( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Searchlite, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - searchLite( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Searchlite, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - searchLite( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Searchlite, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - searchLite( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Searchlite, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, + callback: BodyResponseCallback ): void; - searchLite( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - searchLite( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Searchlite - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Searchlite; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Searchlite; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List; options = {}; } @@ -32940,34 +33726,34 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+servingConfig}:searchLite').replace( + url: (rootUrl + '/v1alpha/{+parent}/servingConfigs').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream. + * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. * @example * ```js * // Before running the sample: @@ -33000,110 +33786,144 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.servingConfigs.streamAnswer( + * await discoveryengine.projects.locations.collections.dataStores.servingConfigs.patch( * { - * // Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - * servingConfig: - * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/servingConfigs/my-servingConfig', + * // Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/servingConfigs/my-servingConfig', + * // Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. + * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { * // "answerGenerationSpec": {}, - * // "asynchronousMode": false, - * // "endUserSpec": {}, - * // "groundingSpec": {}, - * // "query": {}, - * // "queryUnderstandingSpec": {}, - * // "relatedQuestionsSpec": {}, - * // "safetySpec": {}, - * // "searchSpec": {}, - * // "session": "my_session", - * // "userLabels": {}, - * // "userPseudoId": "my_userPseudoId" - * // } - * }, - * }, - * ); - * console.log(res.data); - * - * // Example response - * // { - * // "answer": {}, - * // "answerQueryToken": "my_answerQueryToken", - * // "session": {} - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request + * // "boostControlIds": [], + * // "createTime": "my_createTime", + * // "customFineTuningSpec": {}, + * // "displayName": "my_displayName", + * // "dissociateControlIds": [], + * // "diversityLevel": "my_diversityLevel", + * // "embeddingConfig": {}, + * // "filterControlIds": [], + * // "genericConfig": {}, + * // "guidedSearchSpec": {}, + * // "ignoreControlIds": [], + * // "mediaConfig": {}, + * // "modelId": "my_modelId", + * // "name": "my_name", + * // "onewaySynonymsControlIds": [], + * // "personalizationSpec": {}, + * // "promoteControlIds": [], + * // "rankingExpression": "my_rankingExpression", + * // "redirectControlIds": [], + * // "replacementControlIds": [], + * // "solutionType": "my_solutionType", + * // "synonymsControlIds": [], + * // "updateTime": "my_updateTime" + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "answerGenerationSpec": {}, + * // "boostControlIds": [], + * // "createTime": "my_createTime", + * // "customFineTuningSpec": {}, + * // "displayName": "my_displayName", + * // "dissociateControlIds": [], + * // "diversityLevel": "my_diversityLevel", + * // "embeddingConfig": {}, + * // "filterControlIds": [], + * // "genericConfig": {}, + * // "guidedSearchSpec": {}, + * // "ignoreControlIds": [], + * // "mediaConfig": {}, + * // "modelId": "my_modelId", + * // "name": "my_name", + * // "onewaySynonymsControlIds": [], + * // "personalizationSpec": {}, + * // "promoteControlIds": [], + * // "rankingExpression": "my_rankingExpression", + * // "redirectControlIds": [], + * // "replacementControlIds": [], + * // "solutionType": "my_solutionType", + * // "synonymsControlIds": [], + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - streamAnswer( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Streamanswer, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: StreamMethodOptions ): Promise>; - streamAnswer( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Streamanswer, + patch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - streamAnswer( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Streamanswer, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - streamAnswer( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Streamanswer, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - streamAnswer( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Streamanswer, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, + callback: BodyResponseCallback ): void; - streamAnswer( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - streamAnswer( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Streamanswer - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Streamanswer; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Streamanswer; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch; options = {}; } @@ -33117,145 +33937,31 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+servingConfig}:streamAnswer').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer - extends StandardParameters { - /** - * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - */ - servingConfig?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get - extends StandardParameters { - /** - * Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List - extends StandardParameters { - /** - * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. - */ - pageSize?: number; - /** - * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. Full resource name of the parent resource. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch - extends StandardParameters { - /** - * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` - */ - name?: string; - /** - * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend - extends StandardParameters { - /** - * Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. - */ - servingConfig?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecommendRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search - extends StandardParameters { - /** - * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. - */ - servingConfig?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Searchlite - extends StandardParameters { - /** - * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. - */ - servingConfig?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Streamanswer - extends StandardParameters { - /** - * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - */ - servingConfig?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest; - } - - export class Resource$Projects$Locations$Collections$Datastores$Sessions { - context: APIRequestContext; - answers: Resource$Projects$Locations$Collections$Datastores$Sessions$Answers; - constructor(context: APIRequestContext) { - this.context = context; - this.answers = - new Resource$Projects$Locations$Collections$Datastores$Sessions$Answers( - this.context - ); - } /** - * Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. + * Makes a recommendation, which requires a contextual user event. * @example * ```js * // Before running the sample: @@ -33278,7 +33984,6 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -33289,25 +33994,22 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.sessions.create( + * await discoveryengine.projects.locations.collections.dataStores.servingConfigs.recommend( * { - * // Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` - * parent: - * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', + * // Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. + * servingConfig: + * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/servingConfigs/my-servingConfig', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "displayName": "my_displayName", - * // "endTime": "my_endTime", - * // "isPinned": false, - * // "labels": [], - * // "name": "my_name", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "turns": [], - * // "userPseudoId": "my_userPseudoId" + * // "filter": "my_filter", + * // "pageSize": 0, + * // "params": {}, + * // "userEvent": {}, + * // "userLabels": {}, + * // "validateOnly": false * // } * }, * }, @@ -33316,15 +34018,10 @@ export namespace discoveryengine_v1alpha { * * // Example response * // { - * // "displayName": "my_displayName", - * // "endTime": "my_endTime", - * // "isPinned": false, - * // "labels": [], - * // "name": "my_name", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "turns": [], - * // "userPseudoId": "my_userPseudoId" + * // "attributionToken": "my_attributionToken", + * // "missingIds": [], + * // "results": [], + * // "validateOnly": false * // } * } * @@ -33340,62 +34037,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, + recommend( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, + recommend( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, + recommend( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, + recommend( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, - callback: BodyResponseCallback + recommend( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + recommend( + callback: BodyResponseCallback ): void; - create( + recommend( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend; options = {}; } @@ -33409,7 +34106,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/sessions').replace( + url: (rootUrl + '/v1alpha/{+servingConfig}:recommend').replace( /([^:]\/)\/+/g, '$1' ), @@ -33419,24 +34116,24 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. + * Performs a search. * @example * ```js * // Before running the sample: @@ -33470,16 +34167,80 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.sessions.delete( + * await discoveryengine.projects.locations.collections.dataStores.servingConfigs.search( * { - * // Required. The resource name of the Session to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/sessions/my-session', + * // Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. + * servingConfig: + * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/servingConfigs/my-servingConfig', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "boostSpec": {}, + * // "branch": "my_branch", + * // "canonicalFilter": "my_canonicalFilter", + * // "contentSearchSpec": {}, + * // "customFineTuningSpec": {}, + * // "dataStoreSpecs": [], + * // "displaySpec": {}, + * // "embeddingSpec": {}, + * // "facetSpecs": [], + * // "filter": "my_filter", + * // "imageQuery": {}, + * // "languageCode": "my_languageCode", + * // "naturalLanguageQueryUnderstandingSpec": {}, + * // "offset": 0, + * // "oneBoxPageSize": 0, + * // "orderBy": "my_orderBy", + * // "pageSize": 0, + * // "pageToken": "my_pageToken", + * // "params": {}, + * // "personalizationSpec": {}, + * // "query": "my_query", + * // "queryExpansionSpec": {}, + * // "rankingExpression": "my_rankingExpression", + * // "rankingExpressionBackend": "my_rankingExpressionBackend", + * // "regionCode": "my_regionCode", + * // "relevanceScoreSpec": {}, + * // "relevanceThreshold": "my_relevanceThreshold", + * // "safeSearch": false, + * // "searchAddonSpec": {}, + * // "searchAsYouTypeSpec": {}, + * // "servingConfig": "my_servingConfig", + * // "session": "my_session", + * // "sessionSpec": {}, + * // "spellCorrectionSpec": {}, + * // "useLatestData": false, + * // "userInfo": {}, + * // "userLabels": {}, + * // "userPseudoId": "my_userPseudoId" + * // } + * }, * }, * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "appliedControls": [], + * // "attributionToken": "my_attributionToken", + * // "correctedQuery": "my_correctedQuery", + * // "facets": [], + * // "geoSearchDebugInfo": [], + * // "guidedSearchResult": {}, + * // "naturalLanguageQueryUnderstandingInfo": {}, + * // "nextPageToken": "my_nextPageToken", + * // "oneBoxResults": [], + * // "queryExpansionInfo": {}, + * // "redirectUri": "my_redirectUri", + * // "results": [], + * // "searchLinkPromotions": [], + * // "sessionInfo": {}, + * // "suggestedQuery": "my_suggestedQuery", + * // "summary": {}, + * // "totalSize": 0 + * // } * } * * main().catch(e => { @@ -33494,54 +34255,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, + search( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, + search( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + search( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + search( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, - callback: BodyResponseCallback + search( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + search( + callback: BodyResponseCallback + ): void; + search( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search; options = {}; } @@ -33555,29 +34324,34 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1alpha/{+servingConfig}:search').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a Session. + * Performs a search. Similar to the SearchService.Search method, but a lite version that allows API key for authentication, where OAuth and IAM checks are not required. Only public website search is supported by this method. If data stores and engines not associated with public website search are specified, a `FAILED_PRECONDITION` error is returned. This method can be used for easy onboarding without having to implement an authentication backend. However, it is strongly recommended to use SearchService.Search instead with required OAuth and IAM checks to provide better data security. * @example * ```js * // Before running the sample: @@ -33611,32 +34385,84 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.sessions.get( + * await discoveryengine.projects.locations.collections.dataStores.servingConfigs.searchLite( * { - * // Optional. If set to true, the full session including all answer details will be returned. - * includeAnswerDetails: 'placeholder-value', - * // Required. The resource name of the Session to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/sessions/my-session', - * }, - * ); - * console.log(res.data); - * - * // Example response - * // { - * // "displayName": "my_displayName", - * // "endTime": "my_endTime", - * // "isPinned": false, - * // "labels": [], - * // "name": "my_name", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "turns": [], - * // "userPseudoId": "my_userPseudoId" - * // } - * } + * // Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. + * servingConfig: + * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/servingConfigs/my-servingConfig', * - * main().catch(e => { - * console.error(e); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "boostSpec": {}, + * // "branch": "my_branch", + * // "canonicalFilter": "my_canonicalFilter", + * // "contentSearchSpec": {}, + * // "customFineTuningSpec": {}, + * // "dataStoreSpecs": [], + * // "displaySpec": {}, + * // "embeddingSpec": {}, + * // "facetSpecs": [], + * // "filter": "my_filter", + * // "imageQuery": {}, + * // "languageCode": "my_languageCode", + * // "naturalLanguageQueryUnderstandingSpec": {}, + * // "offset": 0, + * // "oneBoxPageSize": 0, + * // "orderBy": "my_orderBy", + * // "pageSize": 0, + * // "pageToken": "my_pageToken", + * // "params": {}, + * // "personalizationSpec": {}, + * // "query": "my_query", + * // "queryExpansionSpec": {}, + * // "rankingExpression": "my_rankingExpression", + * // "rankingExpressionBackend": "my_rankingExpressionBackend", + * // "regionCode": "my_regionCode", + * // "relevanceScoreSpec": {}, + * // "relevanceThreshold": "my_relevanceThreshold", + * // "safeSearch": false, + * // "searchAddonSpec": {}, + * // "searchAsYouTypeSpec": {}, + * // "servingConfig": "my_servingConfig", + * // "session": "my_session", + * // "sessionSpec": {}, + * // "spellCorrectionSpec": {}, + * // "useLatestData": false, + * // "userInfo": {}, + * // "userLabels": {}, + * // "userPseudoId": "my_userPseudoId" + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "appliedControls": [], + * // "attributionToken": "my_attributionToken", + * // "correctedQuery": "my_correctedQuery", + * // "facets": [], + * // "geoSearchDebugInfo": [], + * // "guidedSearchResult": {}, + * // "naturalLanguageQueryUnderstandingInfo": {}, + * // "nextPageToken": "my_nextPageToken", + * // "oneBoxResults": [], + * // "queryExpansionInfo": {}, + * // "redirectUri": "my_redirectUri", + * // "results": [], + * // "searchLinkPromotions": [], + * // "sessionInfo": {}, + * // "suggestedQuery": "my_suggestedQuery", + * // "summary": {}, + * // "totalSize": 0 + * // } + * } + * + * main().catch(e => { + * console.error(e); * throw e; * }); * @@ -33647,62 +34473,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, + searchLite( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Searchlite, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, + searchLite( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Searchlite, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, + searchLite( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Searchlite, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, + searchLite( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Searchlite, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, - callback: BodyResponseCallback + searchLite( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Searchlite, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + searchLite( + callback: BodyResponseCallback ): void; - get( + searchLite( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Searchlite + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Searchlite; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Searchlite; options = {}; } @@ -33716,31 +34542,34 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+servingConfig}:searchLite').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists all Sessions by their parent DataStore. + * Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream. * @example * ```js * // Before running the sample: @@ -33763,7 +34592,6 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -33774,27 +34602,39 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.sessions.list( + * await discoveryengine.projects.locations.collections.dataStores.servingConfigs.streamAnswer( * { - * // A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time \> "1970-01-01T12:00:00Z"` - * filter: 'placeholder-value', - * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. - * orderBy: 'placeholder-value', - * // Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. - * pageSize: 'placeholder-value', - * // A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. - * pageToken: 'placeholder-value', - * // Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` - * parent: - * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', + * // Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + * servingConfig: + * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/servingConfigs/my-servingConfig', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "answerGenerationSpec": {}, + * // "asynchronousMode": false, + * // "endUserSpec": {}, + * // "groundingSpec": {}, + * // "query": {}, + * // "queryUnderstandingSpec": {}, + * // "relatedQuestionsSpec": {}, + * // "safetySpec": {}, + * // "searchSpec": {}, + * // "session": "my_session", + * // "userLabels": {}, + * // "userPseudoId": "my_userPseudoId" + * // } + * }, * }, * ); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "sessions": [] + * // "answer": {}, + * // "answerQueryToken": "my_answerQueryToken", + * // "session": {} * // } * } * @@ -33810,62 +34650,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, + streamAnswer( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Streamanswer, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, + streamAnswer( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Streamanswer, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, + streamAnswer( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Streamanswer, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, + streamAnswer( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Streamanswer, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, - callback: BodyResponseCallback + streamAnswer( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Streamanswer, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + streamAnswer( + callback: BodyResponseCallback ): void; - list( + streamAnswer( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Streamanswer + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Streamanswer; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Streamanswer; options = {}; } @@ -33879,34 +34719,145 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/sessions').replace( + url: (rootUrl + '/v1alpha/{+servingConfig}:streamAnswer').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + + export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer + extends StandardParameters { + /** + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + */ + servingConfig?: string; /** - * Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get + extends StandardParameters { + /** + * Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List + extends StandardParameters { + /** + * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. Full resource name of the parent resource. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` + */ + name?: string; + /** + * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend + extends StandardParameters { + /** + * Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. + */ + servingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecommendRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search + extends StandardParameters { + /** + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. + */ + servingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Searchlite + extends StandardParameters { + /** + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. + */ + servingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Streamanswer + extends StandardParameters { + /** + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + */ + servingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest; + } + + export class Resource$Projects$Locations$Collections$Datastores$Sessions { + context: APIRequestContext; + answers: Resource$Projects$Locations$Collections$Datastores$Sessions$Answers; + constructor(context: APIRequestContext) { + this.context = context; + this.answers = + new Resource$Projects$Locations$Collections$Datastores$Sessions$Answers( + this.context + ); + } + + /** + * Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. * @example * ```js * // Before running the sample: @@ -33940,12 +34891,11 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.sessions.patch( + * await discoveryengine.projects.locations.collections.dataStores.sessions.create( * { - * // Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/sessions/my-session', - * // Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated. - * updateMask: 'placeholder-value', + * // Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` + * parent: + * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', * * // Request body metadata * requestBody: { @@ -33992,38 +34942,38 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, + create( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, callback: BodyResponseCallback ): void; - patch( + create( callback: BodyResponseCallback ): void; - patch( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch + | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -34041,13 +34991,13 @@ export namespace discoveryengine_v1alpha { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create; options = {}; } @@ -34061,15 +35011,18 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1alpha/{+parent}/sessions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -34083,86 +35036,9 @@ export namespace discoveryengine_v1alpha { ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create - extends StandardParameters { - /** - * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete - extends StandardParameters { - /** - * Required. The resource name of the Session to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get - extends StandardParameters { - /** - * Optional. If set to true, the full session including all answer details will be returned. - */ - includeAnswerDetails?: boolean; - /** - * Required. The resource name of the Session to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List - extends StandardParameters { - /** - * A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time \> "1970-01-01T12:00:00Z"` - */ - filter?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. - */ - orderBy?: string; - /** - * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch - extends StandardParameters { - /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` - */ - name?: string; - /** - * Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession; - } - - export class Resource$Projects$Locations$Collections$Datastores$Sessions$Answers { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Gets a Answer. + * Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. * @example * ```js * // Before running the sample: @@ -34185,6 +35061,7 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -34195,32 +35072,16 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.sessions.answers.get( + * await discoveryengine.projects.locations.collections.dataStores.sessions.delete( * { - * // Required. The resource name of the Answer to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/sessions/my-session/answers/my-answer', + * // Required. The resource name of the Session to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/sessions/my-session', * }, * ); * console.log(res.data); * * // Example response - * // { - * // "answerSkippedReasons": [], - * // "answerText": "my_answerText", - * // "blobAttachments": [], - * // "citations": [], - * // "completeTime": "my_completeTime", - * // "createTime": "my_createTime", - * // "groundingScore": {}, - * // "groundingSupports": [], - * // "name": "my_name", - * // "queryUnderstandingInfo": {}, - * // "references": [], - * // "relatedQuestions": [], - * // "safetyRatings": [], - * // "state": "my_state", - * // "steps": [] - * // } + * // {} * } * * main().catch(e => { @@ -34235,62 +35096,54 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, + delete( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, + callback: BodyResponseCallback ): void; - get( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete; options = {}; } @@ -34305,7 +35158,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -34316,49 +35169,17 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get - extends StandardParameters { - /** - * Required. The resource name of the Answer to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` - */ - name?: string; - } - - export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine { - context: APIRequestContext; - operations: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations; - sitemaps: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps; - targetSites: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations( - this.context - ); - this.sitemaps = - new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps( - this.context - ); - this.targetSites = - new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites( - this.context - ); - } /** - * Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification. + * Gets a Session. * @example * ```js * // Before running the sample: @@ -34381,6 +35202,7 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -34391,28 +35213,27 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.batchVerifyTargetSites( + * await discoveryengine.projects.locations.collections.dataStores.sessions.get( * { - * // Required. The parent resource shared by all TargetSites being verified. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. - * parent: - * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/siteSearchEngine', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, + * // Optional. If set to true, the full session including all answer details will be returned. + * includeAnswerDetails: 'placeholder-value', + * // Required. The resource name of the Session to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/sessions/my-session', * }, * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "displayName": "my_displayName", + * // "endTime": "my_endTime", + * // "isPinned": false, + * // "labels": [], * // "name": "my_name", - * // "response": {} + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "turns": [], + * // "userPseudoId": "my_userPseudoId" * // } * } * @@ -34428,58 +35249,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchVerifyTargetSites( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, options: StreamMethodOptions ): Promise>; - batchVerifyTargetSites( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, options?: MethodOptions - ): Promise>; - batchVerifyTargetSites( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchVerifyTargetSites( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchVerifyTargetSites( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, + callback: BodyResponseCallback ): void; - batchVerifyTargetSites( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - batchVerifyTargetSites( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get; options = {}; } @@ -34493,31 +35318,31 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+parent}:batchVerifyTargetSites' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Downgrade from advanced site search to basic site search. + * Lists all Sessions by their parent DataStore. * @example * ```js * // Before running the sample: @@ -34540,6 +35365,7 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -34550,28 +35376,27 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.disableAdvancedSiteSearch( + * await discoveryengine.projects.locations.collections.dataStores.sessions.list( * { - * // Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. - * siteSearchEngine: - * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/siteSearchEngine', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, + * // A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time \> "1970-01-01T12:00:00Z"` + * filter: 'placeholder-value', + * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. + * orderBy: 'placeholder-value', + * // Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + * pageSize: 'placeholder-value', + * // A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. + * pageToken: 'placeholder-value', + * // Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` + * parent: + * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', * }, * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "sessions": [] * // } * } * @@ -34587,58 +35412,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, options: StreamMethodOptions ): Promise>; - disableAdvancedSiteSearch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, options?: MethodOptions - ): Promise>; - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, + callback: BodyResponseCallback ): void; - disableAdvancedSiteSearch( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - disableAdvancedSiteSearch( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List; options = {}; } @@ -34652,31 +35481,34 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+siteSearchEngine}:disableAdvancedSiteSearch' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1alpha/{+parent}/sessions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['siteSearchEngine'], - pathParams: ['siteSearchEngine'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Upgrade from basic site search to advanced site search. + * Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. * @example * ```js * // Before running the sample: @@ -34699,6 +35531,7 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -34709,16 +35542,27 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.enableAdvancedSiteSearch( + * await discoveryengine.projects.locations.collections.dataStores.sessions.patch( * { - * // Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. - * siteSearchEngine: - * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/siteSearchEngine', + * // Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/sessions/my-session', + * // Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated. + * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters - * // {} + * // { + * // "displayName": "my_displayName", + * // "endTime": "my_endTime", + * // "isPinned": false, + * // "labels": [], + * // "name": "my_name", + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "turns": [], + * // "userPseudoId": "my_userPseudoId" + * // } * }, * }, * ); @@ -34726,11 +35570,15 @@ export namespace discoveryengine_v1alpha { * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "displayName": "my_displayName", + * // "endTime": "my_endTime", + * // "isPinned": false, + * // "labels": [], * // "name": "my_name", - * // "response": {} + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "turns": [], + * // "userPseudoId": "my_userPseudoId" * // } * } * @@ -34746,58 +35594,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, options: StreamMethodOptions ): Promise>; - enableAdvancedSiteSearch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, + patch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, options?: MethodOptions - ): Promise>; - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, + ): Promise< + GaxiosResponseWithHTTP2 + >; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, + callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch; options = {}; } @@ -34811,31 +35663,108 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+siteSearchEngine}:enableAdvancedSiteSearch' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['siteSearchEngine'], - pathParams: ['siteSearchEngine'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create + extends StandardParameters { /** - * Returns list of target sites with its domain verification status. This method can only be called under data store with BASIC_SITE_SEARCH state at the moment. + * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete + extends StandardParameters { + /** + * Required. The resource name of the Session to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get + extends StandardParameters { + /** + * Optional. If set to true, the full session including all answer details will be returned. + */ + includeAnswerDetails?: boolean; + /** + * Required. The resource name of the Session to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List + extends StandardParameters { + /** + * A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time \> "1970-01-01T12:00:00Z"` + */ + filter?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. + */ + orderBy?: string; + /** + * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` + */ + name?: string; + /** + * Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession; + } + + export class Resource$Projects$Locations$Collections$Datastores$Sessions$Answers { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a Answer. * @example * ```js * // Before running the sample: @@ -34868,24 +35797,31 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.fetchDomainVerificationStatus( + * await discoveryengine.projects.locations.collections.dataStores.sessions.answers.get( * { - * // Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. - * pageSize: 'placeholder-value', - * // A page token, received from a previous `FetchDomainVerificationStatus` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchDomainVerificationStatus` must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The site search engine resource under which we fetch all the domain verification status. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. - * siteSearchEngine: - * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/siteSearchEngine', + * // Required. The resource name of the Answer to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/sessions/my-session/answers/my-answer', * }, * ); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "targetSites": [], - * // "totalSize": 0 + * // "answerSkippedReasons": [], + * // "answerText": "my_answerText", + * // "blobAttachments": [], + * // "citations": [], + * // "completeTime": "my_completeTime", + * // "createTime": "my_createTime", + * // "groundingScore": {}, + * // "groundingSupports": [], + * // "name": "my_name", + * // "queryUnderstandingInfo": {}, + * // "references": [], + * // "relatedQuestions": [], + * // "safetyRatings": [], + * // "state": "my_state", + * // "steps": [] * // } * } * @@ -34901,62 +35837,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - fetchDomainVerificationStatus( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, options: StreamMethodOptions ): Promise>; - fetchDomainVerificationStatus( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - fetchDomainVerificationStatus( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - fetchDomainVerificationStatus( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - fetchDomainVerificationStatus( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, + callback: BodyResponseCallback ): void; - fetchDomainVerificationStatus( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - fetchDomainVerificationStatus( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get; options = {}; } @@ -34970,34 +35906,61 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + - '/v1alpha/{+siteSearchEngine}:fetchDomainVerificationStatus' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['siteSearchEngine'], - pathParams: ['siteSearchEngine'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get + extends StandardParameters { /** - * Gets the URI Pattern to Document data mapping for an Advanced Site Search DataStore. + * Required. The resource name of the Answer to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` + */ + name?: string; + } + + export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine { + context: APIRequestContext; + operations: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations; + sitemaps: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps; + targetSites: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations( + this.context + ); + this.sitemaps = + new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps( + this.context + ); + this.targetSites = + new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites( + this.context + ); + } + + /** + * Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification. * @example * ```js * // Before running the sample: @@ -35030,18 +35993,28 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.getUriPatternDocumentData( + * await discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.batchVerifyTargetSites( * { - * // Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. - * siteSearchEngine: + * // Required. The parent resource shared by all TargetSites being verified. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. + * parent: * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/siteSearchEngine', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, * }, * ); * console.log(res.data); * * // Example response * // { - * // "documentDataMap": {} + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -35057,62 +36030,58 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getUriPatternDocumentData( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Geturipatterndocumentdata, + batchVerifyTargetSites( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, options: StreamMethodOptions ): Promise>; - getUriPatternDocumentData( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Geturipatterndocumentdata, + batchVerifyTargetSites( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - getUriPatternDocumentData( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Geturipatterndocumentdata, + ): Promise>; + batchVerifyTargetSites( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getUriPatternDocumentData( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Geturipatterndocumentdata, + batchVerifyTargetSites( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getUriPatternDocumentData( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Geturipatterndocumentdata, - callback: BodyResponseCallback + batchVerifyTargetSites( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + callback: BodyResponseCallback ): void; - getUriPatternDocumentData( - callback: BodyResponseCallback + batchVerifyTargetSites( + callback: BodyResponseCallback ): void; - getUriPatternDocumentData( + batchVerifyTargetSites( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Geturipatterndocumentdata - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Geturipatterndocumentdata; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Geturipatterndocumentdata; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites; options = {}; } @@ -35127,32 +36096,30 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: ( - rootUrl + '/v1alpha/{+siteSearchEngine}:getUriPatternDocumentData' + rootUrl + '/v1alpha/{+parent}:batchVerifyTargetSites' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['siteSearchEngine'], - pathParams: ['siteSearchEngine'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Request on-demand recrawl for a list of URIs. + * Downgrade from advanced site search to basic site search. * @example * ```js * // Before running the sample: @@ -35185,19 +36152,16 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.recrawlUris( + * await discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.disableAdvancedSiteSearch( * { - * // Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. + * // Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. * siteSearchEngine: * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/siteSearchEngine', * * // Request body metadata * requestBody: { * // request body parameters - * // { - * // "siteCredential": "my_siteCredential", - * // "uris": [] - * // } + * // {} * }, * }, * ); @@ -35225,36 +36189,36 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - recrawlUris( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: StreamMethodOptions ): Promise>; - recrawlUris( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, + disableAdvancedSiteSearch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, options?: MethodOptions ): Promise>; - recrawlUris( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recrawlUris( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recrawlUris( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, callback: BodyResponseCallback ): void; - recrawlUris( + disableAdvancedSiteSearch( callback: BodyResponseCallback ): void; - recrawlUris( + disableAdvancedSiteSearch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -35270,13 +36234,13 @@ export namespace discoveryengine_v1alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch; options = {}; } @@ -35290,10 +36254,9 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+siteSearchEngine}:recrawlUris').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1alpha/{+siteSearchEngine}:disableAdvancedSiteSearch' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -35315,7 +36278,7 @@ export namespace discoveryengine_v1alpha { } /** - * Sets the URI Pattern to Document data mapping for an Advanced Site Search DataStore. + * Upgrade from basic site search to advanced site search. * @example * ```js * // Before running the sample: @@ -35348,20 +36311,16 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.setUriPatternDocumentData( + * await discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.enableAdvancedSiteSearch( * { - * // Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. + * // Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. * siteSearchEngine: * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/siteSearchEngine', * * // Request body metadata * requestBody: { * // request body parameters - * // { - * // "documentDataMap": {}, - * // "emptyDocumentDataMap": false, - * // "schema": {} - * // } + * // {} * }, * }, * ); @@ -35389,36 +36348,36 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setUriPatternDocumentData( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Seturipatterndocumentdata, + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: StreamMethodOptions ): Promise>; - setUriPatternDocumentData( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Seturipatterndocumentdata, + enableAdvancedSiteSearch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, options?: MethodOptions ): Promise>; - setUriPatternDocumentData( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Seturipatterndocumentdata, + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setUriPatternDocumentData( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Seturipatterndocumentdata, + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setUriPatternDocumentData( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Seturipatterndocumentdata, + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, callback: BodyResponseCallback ): void; - setUriPatternDocumentData( + enableAdvancedSiteSearch( callback: BodyResponseCallback ): void; - setUriPatternDocumentData( + enableAdvancedSiteSearch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Seturipatterndocumentdata + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -35434,13 +36393,13 @@ export namespace discoveryengine_v1alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Seturipatterndocumentdata; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Seturipatterndocumentdata; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch; options = {}; } @@ -35455,7 +36414,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: ( - rootUrl + '/v1alpha/{+siteSearchEngine}:setUriPatternDocumentData' + rootUrl + '/v1alpha/{+siteSearchEngine}:enableAdvancedSiteSearch' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -35476,99 +36435,9 @@ export namespace discoveryengine_v1alpha { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites - extends StandardParameters { - /** - * Required. The parent resource shared by all TargetSites being verified. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch - extends StandardParameters { - /** - * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. - */ - siteSearchEngine?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch - extends StandardParameters { - /** - * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. - */ - siteSearchEngine?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus - extends StandardParameters { - /** - * Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. - */ - pageSize?: number; - /** - * A page token, received from a previous `FetchDomainVerificationStatus` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchDomainVerificationStatus` must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The site search engine resource under which we fetch all the domain verification status. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. - */ - siteSearchEngine?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Geturipatterndocumentdata - extends StandardParameters { - /** - * Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. - */ - siteSearchEngine?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris - extends StandardParameters { - /** - * Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. - */ - siteSearchEngine?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Seturipatterndocumentdata - extends StandardParameters { - /** - * Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. - */ - siteSearchEngine?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataRequest; - } - - export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Returns list of target sites with its domain verification status. This method can only be called under data store with BASIC_SITE_SEARCH state at the moment. * @example * ```js * // Before running the sample: @@ -35601,21 +36470,24 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.operations.get( + * await discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.fetchDomainVerificationStatus( * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/siteSearchEngine/operations/my-operation', + * // Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. + * pageSize: 'placeholder-value', + * // A page token, received from a previous `FetchDomainVerificationStatus` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchDomainVerificationStatus` must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The site search engine resource under which we fetch all the domain verification status. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. + * siteSearchEngine: + * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/siteSearchEngine', * }, * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "targetSites": [], + * // "totalSize": 0 * // } * } * @@ -35631,58 +36503,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, + fetchDomainVerificationStatus( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, + fetchDomainVerificationStatus( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + fetchDomainVerificationStatus( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, + fetchDomainVerificationStatus( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, - callback: BodyResponseCallback + fetchDomainVerificationStatus( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + fetchDomainVerificationStatus( + callback: BodyResponseCallback ): void; - get( + fetchDomainVerificationStatus( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus; options = {}; } @@ -35696,29 +36572,34 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: ( + rootUrl + + '/v1alpha/{+siteSearchEngine}:fetchDomainVerificationStatus' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Gets the URI Pattern to Document data mapping for an Advanced Site Search DataStore. * @example * ```js * // Before running the sample: @@ -35751,27 +36632,18 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.operations.list( + * await discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.getUriPatternDocumentData( * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/siteSearchEngine', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', + * // Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. + * siteSearchEngine: + * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/siteSearchEngine', * }, * ); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "documentDataMap": {} * // } * } * @@ -35787,62 +36659,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, + getUriPatternDocumentData( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Geturipatterndocumentdata, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, + getUriPatternDocumentData( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Geturipatterndocumentdata, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, + getUriPatternDocumentData( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Geturipatterndocumentdata, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, + getUriPatternDocumentData( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Geturipatterndocumentdata, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, - callback: BodyResponseCallback + getUriPatternDocumentData( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Geturipatterndocumentdata, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + getUriPatternDocumentData( + callback: BodyResponseCallback ): void; - list( + getUriPatternDocumentData( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Geturipatterndocumentdata + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Geturipatterndocumentdata; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Geturipatterndocumentdata; options = {}; } @@ -35856,72 +36728,33 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1alpha/{+siteSearchEngine}:getUriPatternDocumentData' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - - export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Creates a Sitemap. + * Request on-demand recrawl for a list of URIs. * @example * ```js * // Before running the sample: @@ -35954,19 +36787,18 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.create( + * await discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.recrawlUris( * { - * // Required. Parent resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. - * parent: + * // Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. + * siteSearchEngine: * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/siteSearchEngine', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "createTime": "my_createTime", - * // "name": "my_name", - * // "uri": "my_uri" + * // "siteCredential": "my_siteCredential", + * // "uris": [] * // } * }, * }, @@ -35995,36 +36827,36 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Create, + recrawlUris( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Create, + recrawlUris( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, options?: MethodOptions ): Promise>; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Create, + recrawlUris( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Create, + recrawlUris( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Create, + recrawlUris( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, callback: BodyResponseCallback ): void; - create( + recrawlUris( callback: BodyResponseCallback ): void; - create( + recrawlUris( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Create + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -36040,13 +36872,13 @@ export namespace discoveryengine_v1alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Create; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Create; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris; options = {}; } @@ -36060,7 +36892,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/sitemaps').replace( + url: (rootUrl + '/v1alpha/{+siteSearchEngine}:recrawlUris').replace( /([^:]\/)\/+/g, '$1' ), @@ -36070,8 +36902,8 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], context: this.context, }; if (callback) { @@ -36085,7 +36917,7 @@ export namespace discoveryengine_v1alpha { } /** - * Deletes a Sitemap. + * Sets the URI Pattern to Document data mapping for an Advanced Site Search DataStore. * @example * ```js * // Before running the sample: @@ -36118,10 +36950,21 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.delete( + * await discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.setUriPatternDocumentData( * { - * // Required. Full resource name of Sitemap, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/sitemaps/{sitemap\}`. If the caller does not have permission to access the Sitemap, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Sitemap does not exist, a NOT_FOUND error is returned. - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/siteSearchEngine/sitemaps/my-sitemap', + * // Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. + * siteSearchEngine: + * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/siteSearchEngine', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "documentDataMap": {}, + * // "emptyDocumentDataMap": false, + * // "schema": {} + * // } + * }, * }, * ); * console.log(res.data); @@ -36148,36 +36991,36 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Delete, + setUriPatternDocumentData( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Seturipatterndocumentdata, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Delete, + setUriPatternDocumentData( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Seturipatterndocumentdata, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Delete, + setUriPatternDocumentData( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Seturipatterndocumentdata, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Delete, + setUriPatternDocumentData( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Seturipatterndocumentdata, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Delete, + setUriPatternDocumentData( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Seturipatterndocumentdata, callback: BodyResponseCallback ): void; - delete( + setUriPatternDocumentData( callback: BodyResponseCallback ): void; - delete( + setUriPatternDocumentData( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Delete + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Seturipatterndocumentdata | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -36193,13 +37036,13 @@ export namespace discoveryengine_v1alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Seturipatterndocumentdata; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Delete; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Seturipatterndocumentdata; options = {}; } @@ -36213,15 +37056,17 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: ( + rootUrl + '/v1alpha/{+siteSearchEngine}:setUriPatternDocumentData' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], context: this.context, }; if (callback) { @@ -36233,9 +37078,99 @@ export namespace discoveryengine_v1alpha { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites + extends StandardParameters { /** - * Fetch Sitemaps in a DataStore. + * Required. The parent resource shared by all TargetSites being verified. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch + extends StandardParameters { + /** + * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. + */ + siteSearchEngine?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch + extends StandardParameters { + /** + * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. + */ + siteSearchEngine?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus + extends StandardParameters { + /** + * Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. + */ + pageSize?: number; + /** + * A page token, received from a previous `FetchDomainVerificationStatus` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchDomainVerificationStatus` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The site search engine resource under which we fetch all the domain verification status. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. + */ + siteSearchEngine?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Geturipatterndocumentdata + extends StandardParameters { + /** + * Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. + */ + siteSearchEngine?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris + extends StandardParameters { + /** + * Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. + */ + siteSearchEngine?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Seturipatterndocumentdata + extends StandardParameters { + /** + * Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. + */ + siteSearchEngine?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataRequest; + } + + export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -36268,20 +37203,21 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.fetch( + * await discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.operations.get( * { - * // The Sitemap uris. - * 'matcher.urisMatcher.uris': 'placeholder-value', - * // Required. Parent resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. - * parent: - * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/siteSearchEngine', + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/siteSearchEngine/operations/my-operation', * }, * ); * console.log(res.data); * * // Example response * // { - * // "sitemapsMetadata": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -36297,62 +37233,58 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - fetch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, options: StreamMethodOptions ): Promise>; - fetch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - fetch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - fetch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - fetch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, + callback: BodyResponseCallback ): void; - fetch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - fetch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get; options = {}; } @@ -36366,77 +37298,29 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/sitemaps:fetch').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Create - extends StandardParameters { - /** - * Required. Parent resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSitemap; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Delete - extends StandardParameters { - /** - * Required. Full resource name of Sitemap, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/sitemaps/{sitemap\}`. If the caller does not have permission to access the Sitemap, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Sitemap does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch - extends StandardParameters { - /** - * The Sitemap uris. - */ - 'matcher.urisMatcher.uris'?: string[]; - /** - * Required. Parent resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. - */ - parent?: string; - } - - export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites { - context: APIRequestContext; - operations: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations( - this.context - ); - } /** - * Creates TargetSite in a batch. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -36469,30 +37353,27 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.batchCreate( + * await discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.operations.list( * { - * // Required. The parent resource shared by all TargetSites being created. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. The parent field in the CreateBookRequest messages must either be empty or match this field. - * parent: - * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/siteSearchEngine', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "requests": [] - * // } - * }, + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/siteSearchEngine', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -36508,58 +37389,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchCreate( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, options: StreamMethodOptions ): Promise>; - batchCreate( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, options?: MethodOptions - ): Promise>; - batchCreate( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, + callback: BodyResponseCallback ): void; - batchCreate( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - batchCreate( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List; options = {}; } @@ -36573,66 +37458,107 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+parent}/targetSites:batchCreate' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get + extends StandardParameters { /** - * Creates a TargetSite. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const discoveryengine = google.discoveryengine('v1alpha'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.readwrite', - * ], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.create( - * { - * // Required. Parent resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + + export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a Sitemap. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.create( + * { + * // Required. Parent resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. * parent: * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/siteSearchEngine', * @@ -36640,16 +37566,9 @@ export namespace discoveryengine_v1alpha { * requestBody: { * // request body parameters * // { - * // "exactMatch": false, - * // "failureReason": {}, - * // "generatedUriPattern": "my_generatedUriPattern", - * // "indexingStatus": "my_indexingStatus", + * // "createTime": "my_createTime", * // "name": "my_name", - * // "providedUriPattern": "my_providedUriPattern", - * // "rootDomainUri": "my_rootDomainUri", - * // "siteVerificationInfo": {}, - * // "type": "my_type", - * // "updateTime": "my_updateTime" + * // "uri": "my_uri" * // } * }, * }, @@ -36679,27 +37598,27 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Create, options: StreamMethodOptions ): Promise>; create( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Create, options?: MethodOptions ): Promise>; create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Create, callback: BodyResponseCallback ): void; create( @@ -36707,7 +37626,7 @@ export namespace discoveryengine_v1alpha { ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -36723,13 +37642,13 @@ export namespace discoveryengine_v1alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Create; options = {}; } @@ -36743,7 +37662,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/targetSites').replace( + url: (rootUrl + '/v1alpha/{+parent}/sitemaps').replace( /([^:]\/)\/+/g, '$1' ), @@ -36768,7 +37687,7 @@ export namespace discoveryengine_v1alpha { } /** - * Deletes a TargetSite. + * Deletes a Sitemap. * @example * ```js * // Before running the sample: @@ -36801,10 +37720,10 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.delete( + * await discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.delete( * { - * // Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/siteSearchEngine/targetSites/my-targetSite', + * // Required. Full resource name of Sitemap, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/sitemaps/{sitemap\}`. If the caller does not have permission to access the Sitemap, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Sitemap does not exist, a NOT_FOUND error is returned. + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/siteSearchEngine/sitemaps/my-sitemap', * }, * ); * console.log(res.data); @@ -36832,27 +37751,27 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Delete, callback: BodyResponseCallback ): void; delete( @@ -36860,7 +37779,7 @@ export namespace discoveryengine_v1alpha { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -36876,13 +37795,13 @@ export namespace discoveryengine_v1alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Delete; options = {}; } @@ -36918,7 +37837,7 @@ export namespace discoveryengine_v1alpha { } /** - * Gets a TargetSite. + * Fetch Sitemaps in a DataStore. * @example * ```js * // Before running the sample: @@ -36951,26 +37870,20 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.get( + * await discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.fetch( * { - * // Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/siteSearchEngine/targetSites/my-targetSite', + * // The Sitemap uris. + * 'matcher.urisMatcher.uris': 'placeholder-value', + * // Required. Parent resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. + * parent: + * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/siteSearchEngine', * }, * ); * console.log(res.data); * * // Example response * // { - * // "exactMatch": false, - * // "failureReason": {}, - * // "generatedUriPattern": "my_generatedUriPattern", - * // "indexingStatus": "my_indexingStatus", - * // "name": "my_name", - * // "providedUriPattern": "my_providedUriPattern", - * // "rootDomainUri": "my_rootDomainUri", - * // "siteVerificationInfo": {}, - * // "type": "my_type", - * // "updateTime": "my_updateTime" + * // "sitemapsMetadata": [] * // } * } * @@ -36986,62 +37899,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, + fetch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, + fetch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, + fetch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, + fetch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, - callback: BodyResponseCallback + fetch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + fetch( + callback: BodyResponseCallback ): void; - get( + fetch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch; options = {}; } @@ -37055,31 +37968,77 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+parent}/sitemaps:fetch').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Create + extends StandardParameters { /** - * Gets a list of TargetSites. + * Required. Parent resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSitemap; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Delete + extends StandardParameters { + /** + * Required. Full resource name of Sitemap, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/sitemaps/{sitemap\}`. If the caller does not have permission to access the Sitemap, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Sitemap does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Sitemaps$Fetch + extends StandardParameters { + /** + * The Sitemap uris. + */ + 'matcher.urisMatcher.uris'?: string[]; + /** + * Required. Parent resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites { + context: APIRequestContext; + operations: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations( + this.context + ); + } + + /** + * Creates TargetSite in a batch. * @example * ```js * // Before running the sample: @@ -37112,24 +38071,30 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.list( + * await discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.batchCreate( * { - * // Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. - * pageSize: 'placeholder-value', - * // A page token, received from a previous `ListTargetSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTargetSites` must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The parent site search engine resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned. + * // Required. The parent resource shared by all TargetSites being created. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. The parent field in the CreateBookRequest messages must either be empty or match this field. * parent: * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/siteSearchEngine', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "requests": [] + * // } + * }, * }, * ); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "targetSites": [], - * // "totalSize": 0 + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -37145,62 +38110,58 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, + batchCreate( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, + batchCreate( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, + ): Promise>; + batchCreate( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, + batchCreate( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, - callback: BodyResponseCallback + batchCreate( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + batchCreate( + callback: BodyResponseCallback ): void; - list( + batchCreate( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate; options = {}; } @@ -37214,11 +38175,10 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/targetSites').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: ( + rootUrl + '/v1alpha/{+parent}/targetSites:batchCreate' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -37229,19 +38189,17 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a TargetSite. + * Creates a TargetSite. * @example * ```js * // Before running the sample: @@ -37274,10 +38232,11 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.patch( + * await discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.create( * { - * // Output only. The fully qualified resource name of the target site. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}` The `target_site_id` is system-generated. - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/siteSearchEngine/targetSites/my-targetSite', + * // Required. Parent resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. + * parent: + * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/siteSearchEngine', * * // Request body metadata * requestBody: { @@ -37321,36 +38280,36 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, + create( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, callback: BodyResponseCallback ): void; - patch( + create( callback: BodyResponseCallback ): void; - patch( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -37366,13 +38325,13 @@ export namespace discoveryengine_v1alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create; options = {}; } @@ -37386,15 +38345,18 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1alpha/{+parent}/targetSites').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -37406,82 +38368,9 @@ export namespace discoveryengine_v1alpha { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate - extends StandardParameters { - /** - * Required. The parent resource shared by all TargetSites being created. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. The parent field in the CreateBookRequest messages must either be empty or match this field. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create - extends StandardParameters { - /** - * Required. Parent resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. - */ - parent?: string; /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete - extends StandardParameters { - /** - * Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get - extends StandardParameters { - /** - * Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List - extends StandardParameters { - /** - * Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListTargetSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTargetSites` must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The parent site search engine resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch - extends StandardParameters { - /** - * Output only. The fully qualified resource name of the target site. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}` The `target_site_id` is system-generated. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite; - } - - export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Deletes a TargetSite. * @example * ```js * // Before running the sample: @@ -37514,10 +38403,10 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.operations.get( + * await discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.delete( * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/siteSearchEngine/targetSites/operations/my-operation', + * // Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/siteSearchEngine/targetSites/my-targetSite', * }, * ); * console.log(res.data); @@ -37544,36 +38433,36 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, + delete( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, options?: MethodOptions ): Promise>; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, callback: BodyResponseCallback ): void; - get( + delete( callback: BodyResponseCallback ): void; - get( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -37589,13 +38478,13 @@ export namespace discoveryengine_v1alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete; options = {}; } @@ -37610,7 +38499,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -37631,7 +38520,7 @@ export namespace discoveryengine_v1alpha { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Gets a TargetSite. * @example * ```js * // Before running the sample: @@ -37664,27 +38553,26 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.operations.list( + * await discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.get( * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/siteSearchEngine/targetSites', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', + * // Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/siteSearchEngine/targetSites/my-targetSite', * }, * ); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "exactMatch": false, + * // "failureReason": {}, + * // "generatedUriPattern": "my_generatedUriPattern", + * // "indexingStatus": "my_indexingStatus", + * // "name": "my_name", + * // "providedUriPattern": "my_providedUriPattern", + * // "rootDomainUri": "my_rootDomainUri", + * // "siteVerificationInfo": {}, + * // "type": "my_type", + * // "updateTime": "my_updateTime" * // } * } * @@ -37700,62 +38588,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get; options = {}; } @@ -37769,10 +38657,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -37784,57 +38669,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - - export class Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Imports all SuggestionDenyListEntry for a DataStore. + * Gets a list of TargetSites. * @example * ```js * // Before running the sample: @@ -37857,7 +38704,6 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -37868,31 +38714,24 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.suggestionDenyListEntries.import( + * await discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.list( * { - * // Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. + * // Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. + * pageSize: 'placeholder-value', + * // A page token, received from a previous `ListTargetSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTargetSites` must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The parent site search engine resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned. * parent: - * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "gcsSource": {}, - * // "inlineSource": {} - * // } - * }, + * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/siteSearchEngine', * }, * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "targetSites": [], + * // "totalSize": 0 * // } * } * @@ -37908,58 +38747,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, options: StreamMethodOptions ): Promise>; - import( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, options?: MethodOptions - ): Promise>; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - import( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List; options = {}; } @@ -37973,10 +38816,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+parent}/suggestionDenyListEntries:import' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1alpha/{+parent}/targetSites').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -37987,17 +38831,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Permanently deletes all SuggestionDenyListEntry for a DataStore. + * Updates a TargetSite. * @example * ```js * // Before running the sample: @@ -38020,7 +38866,6 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -38031,16 +38876,26 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.suggestionDenyListEntries.purge( + * await discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.patch( * { - * // Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. - * parent: - * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', + * // Output only. The fully qualified resource name of the target site. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}` The `target_site_id` is system-generated. + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/siteSearchEngine/targetSites/my-targetSite', * * // Request body metadata * requestBody: { * // request body parameters - * // {} + * // { + * // "exactMatch": false, + * // "failureReason": {}, + * // "generatedUriPattern": "my_generatedUriPattern", + * // "indexingStatus": "my_indexingStatus", + * // "name": "my_name", + * // "providedUriPattern": "my_providedUriPattern", + * // "rootDomainUri": "my_rootDomainUri", + * // "siteVerificationInfo": {}, + * // "type": "my_type", + * // "updateTime": "my_updateTime" + * // } * }, * }, * ); @@ -38068,36 +38923,36 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, options: StreamMethodOptions ): Promise>; - purge( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, + patch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, options?: MethodOptions ): Promise>; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, callback: BodyResponseCallback ): void; - purge( + patch( callback: BodyResponseCallback ): void; - purge( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -38113,13 +38968,13 @@ export namespace discoveryengine_v1alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch; options = {}; } @@ -38133,17 +38988,15 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+parent}/suggestionDenyListEntries:purge' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -38157,39 +39010,80 @@ export namespace discoveryengine_v1alpha { } } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate extends StandardParameters { /** - * Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. + * Required. The parent resource shared by all TargetSites being created. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. The parent field in the CreateBookRequest messages must either be empty or match this field. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create extends StandardParameters { /** - * Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. + * Required. Parent resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete + extends StandardParameters { + /** + * Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get + extends StandardParameters { + /** + * Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List + extends StandardParameters { + /** + * Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListTargetSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTargetSites` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent site search engine resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch + extends StandardParameters { + /** + * Output only. The fully qualified resource name of the target site. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}` The `target_site_id` is system-generated. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite; } - export class Resource$Projects$Locations$Collections$Datastores$Userevents { + export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -38212,7 +39106,6 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -38223,26 +39116,21 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.userEvents.collect( + * await discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.operations.get( * { - * // The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. - * ets: 'placeholder-value', - * // Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`. - * parent: - * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', - * // The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests. - * uri: 'placeholder-value', - * // Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. - * userEvent: 'placeholder-value', + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/siteSearchEngine/targetSites/operations/my-operation', * }, * ); * console.log(res.data); * * // Example response * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -38258,54 +39146,58 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - collect( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, options: StreamMethodOptions ): Promise>; - collect( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, options?: MethodOptions - ): Promise>; - collect( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - collect( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - collect( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, + callback: BodyResponseCallback ): void; - collect(callback: BodyResponseCallback): void; - collect( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get; options = {}; } @@ -38319,32 +39211,29 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/userEvents:collect').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -38367,7 +39256,6 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -38378,33 +39266,27 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.userEvents.import( + * await discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.targetSites.operations.list( * { - * // Required. Parent DataStore resource name, of the form `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}` - * parent: - * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "bigquerySource": {}, - * // "errorConfig": {}, - * // "gcsSource": {}, - * // "inlineSource": {} - * // } - * }, + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/siteSearchEngine/targetSites', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -38420,58 +39302,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, options: StreamMethodOptions ): Promise>; - import( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, options?: MethodOptions - ): Promise>; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - import( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List; options = {}; } @@ -38485,32 +39371,72 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/userEvents:import').replace( + url: (rootUrl + '/v1alpha/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get + extends StandardParameters { /** - * Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first. + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + + export class Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Imports all SuggestionDenyListEntry for a DataStore. * @example * ```js * // Before running the sample: @@ -38544,9 +39470,9 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.userEvents.purge( + * await discoveryengine.projects.locations.collections.dataStores.suggestionDenyListEntries.import( * { - * // Required. The resource name of the catalog under which the events are created. The format is `projects/{project\}/locations/global/collections/{collection\}/dataStores/{dataStore\}`. + * // Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. * parent: * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', * @@ -38554,8 +39480,8 @@ export namespace discoveryengine_v1alpha { * requestBody: { * // request body parameters * // { - * // "filter": "my_filter", - * // "force": false + * // "gcsSource": {}, + * // "inlineSource": {} * // } * }, * }, @@ -38584,36 +39510,36 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, options: StreamMethodOptions ): Promise>; - purge( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, + import( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, options?: MethodOptions ): Promise>; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, callback: BodyResponseCallback ): void; - purge( + import( callback: BodyResponseCallback ): void; - purge( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge + | Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -38629,13 +39555,13 @@ export namespace discoveryengine_v1alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import; options = {}; } @@ -38649,10 +39575,9 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/userEvents:purge').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1alpha/{+parent}/suggestionDenyListEntries:import' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -38674,7 +39599,7 @@ export namespace discoveryengine_v1alpha { } /** - * Writes a single user event. + * Permanently deletes all SuggestionDenyListEntry for a DataStore. * @example * ```js * // Before running the sample: @@ -38708,41 +39633,16 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.userEvents.write( + * await discoveryengine.projects.locations.collections.dataStores.suggestionDenyListEntries.purge( * { - * // Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`. + * // Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. * parent: * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', - * // If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. - * writeAsync: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters - * // { - * // "attributes": {}, - * // "attributionToken": "my_attributionToken", - * // "completionInfo": {}, - * // "conversionType": "my_conversionType", - * // "dataStore": "my_dataStore", - * // "directUserRequest": false, - * // "documents": [], - * // "engine": "my_engine", - * // "eventTime": "my_eventTime", - * // "eventType": "my_eventType", - * // "filter": "my_filter", - * // "mediaInfo": {}, - * // "pageInfo": {}, - * // "panel": {}, - * // "panels": [], - * // "promotionIds": [], - * // "searchInfo": {}, - * // "sessionId": "my_sessionId", - * // "tagIds": [], - * // "transactionInfo": {}, - * // "userInfo": {}, - * // "userPseudoId": "my_userPseudoId" - * // } + * // {} * }, * }, * ); @@ -38750,28 +39650,11 @@ export namespace discoveryengine_v1alpha { * * // Example response * // { - * // "attributes": {}, - * // "attributionToken": "my_attributionToken", - * // "completionInfo": {}, - * // "conversionType": "my_conversionType", - * // "dataStore": "my_dataStore", - * // "directUserRequest": false, - * // "documents": [], - * // "engine": "my_engine", - * // "eventTime": "my_eventTime", - * // "eventType": "my_eventType", - * // "filter": "my_filter", - * // "mediaInfo": {}, - * // "pageInfo": {}, - * // "panel": {}, - * // "panels": [], - * // "promotionIds": [], - * // "searchInfo": {}, - * // "sessionId": "my_sessionId", - * // "tagIds": [], - * // "transactionInfo": {}, - * // "userInfo": {}, - * // "userPseudoId": "my_userPseudoId" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -38787,62 +39670,58 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - write( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, options: StreamMethodOptions ): Promise>; - write( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, + purge( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - write( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, + ): Promise>; + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - write( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - write( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, - callback: BodyResponseCallback + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, + callback: BodyResponseCallback ): void; - write( - callback: BodyResponseCallback + purge( + callback: BodyResponseCallback ): void; - write( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge; options = {}; } @@ -38856,10 +39735,9 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/userEvents:write').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1alpha/{+parent}/suggestionDenyListEntries:purge' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -38871,86 +39749,49 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect - extends StandardParameters { - /** - * The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. - */ - ets?: string; - /** - * Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`. - */ - parent?: string; - /** - * The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests. - */ - uri?: string; - /** - * Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. - */ - userEvent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import - extends StandardParameters { - /** - * Required. Parent DataStore resource name, of the form `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge + export interface Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import extends StandardParameters { /** - * Required. The resource name of the catalog under which the events are created. The format is `projects/{project\}/locations/global/collections/{collection\}/dataStores/{dataStore\}`. + * Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write + export interface Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge extends StandardParameters { /** - * Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`. + * Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. */ parent?: string; - /** - * If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. - */ - writeAsync?: boolean; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaUserEvent; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest; } - export class Resource$Projects$Locations$Collections$Datastores$Widgetconfigs { + export class Resource$Projects$Locations$Collections$Datastores$Userevents { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Gets a WidgetConfig. + * Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly. * @example * ```js * // Before running the sample: @@ -38984,57 +39825,26 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.dataStores.widgetConfigs.get( + * await discoveryengine.projects.locations.collections.dataStores.userEvents.collect( * { - * // Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development. - * acceptCache: 'placeholder-value', - * // Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission. - * 'getWidgetConfigRequestOption.turnOffCollectionComponents': - * 'placeholder-value', - * // Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}` - * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/widgetConfigs/my-widgetConfig', + * // The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. + * ets: 'placeholder-value', + * // Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`. + * parent: + * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', + * // The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests. + * uri: 'placeholder-value', + * // Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. + * userEvent: 'placeholder-value', * }, * ); * console.log(res.data); * * // Example response * // { - * // "accessSettings": {}, - * // "allowPublicAccess": false, - * // "allowlistedDomains": [], - * // "assistantSettings": {}, - * // "collectionComponents": [], - * // "configId": "my_configId", - * // "contentSearchSpec": {}, - * // "createTime": "my_createTime", - * // "customerProvidedConfig": {}, - * // "dataStoreType": "my_dataStoreType", - * // "dataStoreUiConfigs": [], - * // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy", - * // "displayName": "my_displayName", - * // "enableAutocomplete": false, - * // "enableConversationalSearch": false, - * // "enablePrivateKnowledgeGraph": false, - * // "enableQualityFeedback": false, - * // "enableResultScore": false, - * // "enableSafeSearch": false, - * // "enableSearchAsYouType": false, - * // "enableSnippetResultSummary": false, - * // "enableSummarization": false, - * // "enableWebApp": false, - * // "experimentalFeatures": {}, - * // "facetField": [], - * // "fieldsUiComponentsMap": {}, - * // "homepageSetting": {}, - * // "industryVertical": "my_industryVertical", - * // "llmEnabled": false, - * // "minimumDataTermAccepted": false, - * // "name": "my_name", - * // "resultDisplayType": "my_resultDisplayType", - * // "solutionType": "my_solutionType", - * // "uiBranding": {}, - * // "uiSettings": {}, - * // "updateTime": "my_updateTime" + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] * // } * } * @@ -39050,62 +39860,54 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get, + collect( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get, + collect( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get, + ): Promise>; + collect( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get, - callback: BodyResponseCallback + collect( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + collect( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, + callback: BodyResponseCallback ): void; - get( + collect(callback: BodyResponseCallback): void; + collect( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect; options = {}; } @@ -39119,99 +39921,32 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+parent}/userEvents:collect').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get - extends StandardParameters { - /** - * Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development. - */ - acceptCache?: boolean; - /** - * Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission. - */ - 'getWidgetConfigRequestOption.turnOffCollectionComponents'?: boolean; - /** - * Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}` - */ - name?: string; - } - - export class Resource$Projects$Locations$Collections$Engines { - context: APIRequestContext; - analytics: Resource$Projects$Locations$Collections$Engines$Analytics; - assistants: Resource$Projects$Locations$Collections$Engines$Assistants; - completionConfig: Resource$Projects$Locations$Collections$Engines$Completionconfig; - controls: Resource$Projects$Locations$Collections$Engines$Controls; - conversations: Resource$Projects$Locations$Collections$Engines$Conversations; - operations: Resource$Projects$Locations$Collections$Engines$Operations; - servingConfigs: Resource$Projects$Locations$Collections$Engines$Servingconfigs; - sessions: Resource$Projects$Locations$Collections$Engines$Sessions; - widgetConfigs: Resource$Projects$Locations$Collections$Engines$Widgetconfigs; - constructor(context: APIRequestContext) { - this.context = context; - this.analytics = - new Resource$Projects$Locations$Collections$Engines$Analytics( - this.context - ); - this.assistants = - new Resource$Projects$Locations$Collections$Engines$Assistants( - this.context - ); - this.completionConfig = - new Resource$Projects$Locations$Collections$Engines$Completionconfig( - this.context - ); - this.controls = - new Resource$Projects$Locations$Collections$Engines$Controls( - this.context - ); - this.conversations = - new Resource$Projects$Locations$Collections$Engines$Conversations( - this.context - ); - this.operations = - new Resource$Projects$Locations$Collections$Engines$Operations( - this.context - ); - this.servingConfigs = - new Resource$Projects$Locations$Collections$Engines$Servingconfigs( - this.context - ); - this.sessions = - new Resource$Projects$Locations$Collections$Engines$Sessions( - this.context - ); - this.widgetConfigs = - new Resource$Projects$Locations$Collections$Engines$Widgetconfigs( - this.context - ); - } /** - * Creates a Engine. + * Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata. * @example * ```js * // Before running the sample: @@ -39234,6 +39969,7 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -39244,41 +39980,27 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.engines.create({ - * // Required. The ID to use for the Engine, which will become the final component of the Engine's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. - * engineId: 'placeholder-value', - * // Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`. - * parent: - * 'projects/my-project/locations/my-location/collections/my-collection', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "appType": "my_appType", - * // "chatEngineConfig": {}, - * // "chatEngineMetadata": {}, - * // "commonConfig": {}, - * // "configurableBillingApproach": "my_configurableBillingApproach", - * // "createTime": "my_createTime", - * // "dataStoreIds": [], - * // "disableAnalytics": false, - * // "displayName": "my_displayName", - * // "features": {}, - * // "industryVertical": "my_industryVertical", - * // "mediaRecommendationEngineConfig": {}, - * // "name": "my_name", - * // "recommendationMetadata": {}, - * // "searchEngineConfig": {}, - * // "similarDocumentsConfig": {}, - * // "solutionType": "my_solutionType", - * // "updateTime": "my_updateTime" - * // } - * }, - * }); - * console.log(res.data); + * await discoveryengine.projects.locations.collections.dataStores.userEvents.import( + * { + * // Required. Parent DataStore resource name, of the form `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}` + * parent: + * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', * - * // Example response + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bigquerySource": {}, + * // "errorConfig": {}, + * // "gcsSource": {}, + * // "inlineSource": {} + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response * // { * // "done": false, * // "error": {}, @@ -39300,36 +40022,36 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Create, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Collections$Engines$Create, + import( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, options?: MethodOptions ): Promise>; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Create, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Create, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Create, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, callback: BodyResponseCallback ): void; - create( + import( callback: BodyResponseCallback ): void; - create( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Create + | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -39345,13 +40067,13 @@ export namespace discoveryengine_v1alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Create; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Create; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import; options = {}; } @@ -39365,7 +40087,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/engines').replace( + url: (rootUrl + '/v1alpha/{+parent}/userEvents:import').replace( /([^:]\/)\/+/g, '$1' ), @@ -39390,7 +40112,7 @@ export namespace discoveryengine_v1alpha { } /** - * Deletes a Engine. + * Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first. * @example * ```js * // Before running the sample: @@ -39413,6 +40135,7 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -39423,10 +40146,22 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.engines.delete({ - * // Required. Full resource name of Engine, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. If the caller does not have permission to delete the Engine, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Engine to delete does not exist, a NOT_FOUND error is returned. - * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine', - * }); + * await discoveryengine.projects.locations.collections.dataStores.userEvents.purge( + * { + * // Required. The resource name of the catalog under which the events are created. The format is `projects/{project\}/locations/global/collections/{collection\}/dataStores/{dataStore\}`. + * parent: + * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "filter": "my_filter", + * // "force": false + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response @@ -39451,36 +40186,36 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Delete, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Collections$Engines$Delete, + purge( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Delete, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Delete, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Delete, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, callback: BodyResponseCallback ): void; - delete( + purge( callback: BodyResponseCallback ): void; - delete( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Delete + | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -39496,13 +40231,13 @@ export namespace discoveryengine_v1alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Delete; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge; options = {}; } @@ -39516,15 +40251,18 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1alpha/{+parent}/userEvents:purge').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -39538,7 +40276,7 @@ export namespace discoveryengine_v1alpha { } /** - * Gets a Engine. + * Writes a single user event. * @example * ```js * // Before running the sample: @@ -39561,6 +40299,7 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -39570,32 +40309,71 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.collections.engines.get({ - * // Required. Full resource name of Engine, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. - * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine', - * }); + * const res = + * await discoveryengine.projects.locations.collections.dataStores.userEvents.write( + * { + * // Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`. + * parent: + * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore', + * // If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. + * writeAsync: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "attributes": {}, + * // "attributionToken": "my_attributionToken", + * // "completionInfo": {}, + * // "conversionType": "my_conversionType", + * // "dataStore": "my_dataStore", + * // "directUserRequest": false, + * // "documents": [], + * // "engine": "my_engine", + * // "eventTime": "my_eventTime", + * // "eventType": "my_eventType", + * // "filter": "my_filter", + * // "mediaInfo": {}, + * // "pageInfo": {}, + * // "panel": {}, + * // "panels": [], + * // "promotionIds": [], + * // "searchInfo": {}, + * // "sessionId": "my_sessionId", + * // "tagIds": [], + * // "transactionInfo": {}, + * // "userInfo": {}, + * // "userPseudoId": "my_userPseudoId" + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "appType": "my_appType", - * // "chatEngineConfig": {}, - * // "chatEngineMetadata": {}, - * // "commonConfig": {}, - * // "configurableBillingApproach": "my_configurableBillingApproach", - * // "createTime": "my_createTime", - * // "dataStoreIds": [], - * // "disableAnalytics": false, - * // "displayName": "my_displayName", - * // "features": {}, - * // "industryVertical": "my_industryVertical", - * // "mediaRecommendationEngineConfig": {}, - * // "name": "my_name", - * // "recommendationMetadata": {}, - * // "searchEngineConfig": {}, - * // "similarDocumentsConfig": {}, - * // "solutionType": "my_solutionType", - * // "updateTime": "my_updateTime" + * // "attributes": {}, + * // "attributionToken": "my_attributionToken", + * // "completionInfo": {}, + * // "conversionType": "my_conversionType", + * // "dataStore": "my_dataStore", + * // "directUserRequest": false, + * // "documents": [], + * // "engine": "my_engine", + * // "eventTime": "my_eventTime", + * // "eventType": "my_eventType", + * // "filter": "my_filter", + * // "mediaInfo": {}, + * // "pageInfo": {}, + * // "panel": {}, + * // "panels": [], + * // "promotionIds": [], + * // "searchInfo": {}, + * // "sessionId": "my_sessionId", + * // "tagIds": [], + * // "transactionInfo": {}, + * // "userInfo": {}, + * // "userPseudoId": "my_userPseudoId" * // } * } * @@ -39611,62 +40389,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Get, + write( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Get, + write( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Get, + write( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Get, + write( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Get, - callback: BodyResponseCallback + write( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + write( + callback: BodyResponseCallback ): void; - get( + write( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write; options = {}; } @@ -39680,31 +40458,101 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+parent}/userEvents:write').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect + extends StandardParameters { /** - * Get Workspace settings for the end user. + * The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. + */ + ets?: string; + /** + * Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`. + */ + parent?: string; + /** + * The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests. + */ + uri?: string; + /** + * Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. + */ + userEvent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import + extends StandardParameters { + /** + * Required. Parent DataStore resource name, of the form `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge + extends StandardParameters { + /** + * Required. The resource name of the catalog under which the events are created. The format is `projects/{project\}/locations/global/collections/{collection\}/dataStores/{dataStore\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write + extends StandardParameters { + /** + * Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`. + */ + parent?: string; + /** + * If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. + */ + writeAsync?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaUserEvent; + } + + export class Resource$Projects$Locations$Collections$Datastores$Widgetconfigs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a WidgetConfig. * @example * ```js * // Before running the sample: @@ -39727,6 +40575,7 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -39737,17 +40586,58 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.engines.getWorkspaceSettings( + * await discoveryengine.projects.locations.collections.dataStores.widgetConfigs.get( * { - * // Required. Full Engine resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}` - * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine', + * // Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development. + * acceptCache: 'placeholder-value', + * // Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission. + * 'getWidgetConfigRequestOption.turnOffCollectionComponents': + * 'placeholder-value', + * // Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}` + * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/widgetConfigs/my-widgetConfig', * }, * ); * console.log(res.data); * * // Example response * // { - * // "workspaceAccessEnabled": false + * // "accessSettings": {}, + * // "allowPublicAccess": false, + * // "allowlistedDomains": [], + * // "assistantSettings": {}, + * // "collectionComponents": [], + * // "configId": "my_configId", + * // "contentSearchSpec": {}, + * // "createTime": "my_createTime", + * // "customerProvidedConfig": {}, + * // "dataStoreType": "my_dataStoreType", + * // "dataStoreUiConfigs": [], + * // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy", + * // "displayName": "my_displayName", + * // "enableAutocomplete": false, + * // "enableConversationalSearch": false, + * // "enablePrivateKnowledgeGraph": false, + * // "enableQualityFeedback": false, + * // "enableResultScore": false, + * // "enableSafeSearch": false, + * // "enableSearchAsYouType": false, + * // "enableSnippetResultSummary": false, + * // "enableSummarization": false, + * // "enableWebApp": false, + * // "experimentalFeatures": {}, + * // "facetField": [], + * // "fieldsUiComponentsMap": {}, + * // "geminiBundle": false, + * // "homepageSetting": {}, + * // "industryVertical": "my_industryVertical", + * // "llmEnabled": false, + * // "minimumDataTermAccepted": false, + * // "name": "my_name", + * // "resultDisplayType": "my_resultDisplayType", + * // "solutionType": "my_solutionType", + * // "uiBranding": {}, + * // "uiSettings": {}, + * // "updateTime": "my_updateTime" * // } * } * @@ -39763,62 +40653,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getWorkspaceSettings( - params: Params$Resource$Projects$Locations$Collections$Engines$Getworkspacesettings, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get, options: StreamMethodOptions ): Promise>; - getWorkspaceSettings( - params?: Params$Resource$Projects$Locations$Collections$Engines$Getworkspacesettings, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - getWorkspaceSettings( - params: Params$Resource$Projects$Locations$Collections$Engines$Getworkspacesettings, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getWorkspaceSettings( - params: Params$Resource$Projects$Locations$Collections$Engines$Getworkspacesettings, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getWorkspaceSettings( - params: Params$Resource$Projects$Locations$Collections$Engines$Getworkspacesettings, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get, + callback: BodyResponseCallback ): void; - getWorkspaceSettings( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - getWorkspaceSettings( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Getworkspacesettings - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Getworkspacesettings; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Getworkspacesettings; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get; options = {}; } @@ -39832,10 +40722,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}:getWorkspaceSettings').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -39847,19 +40734,87 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get + extends StandardParameters { /** - * Lists all the Engines associated with the project. + * Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development. + */ + acceptCache?: boolean; + /** + * Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission. + */ + 'getWidgetConfigRequestOption.turnOffCollectionComponents'?: boolean; + /** + * Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}` + */ + name?: string; + } + + export class Resource$Projects$Locations$Collections$Engines { + context: APIRequestContext; + analytics: Resource$Projects$Locations$Collections$Engines$Analytics; + assistants: Resource$Projects$Locations$Collections$Engines$Assistants; + completionConfig: Resource$Projects$Locations$Collections$Engines$Completionconfig; + controls: Resource$Projects$Locations$Collections$Engines$Controls; + conversations: Resource$Projects$Locations$Collections$Engines$Conversations; + operations: Resource$Projects$Locations$Collections$Engines$Operations; + servingConfigs: Resource$Projects$Locations$Collections$Engines$Servingconfigs; + sessions: Resource$Projects$Locations$Collections$Engines$Sessions; + widgetConfigs: Resource$Projects$Locations$Collections$Engines$Widgetconfigs; + constructor(context: APIRequestContext) { + this.context = context; + this.analytics = + new Resource$Projects$Locations$Collections$Engines$Analytics( + this.context + ); + this.assistants = + new Resource$Projects$Locations$Collections$Engines$Assistants( + this.context + ); + this.completionConfig = + new Resource$Projects$Locations$Collections$Engines$Completionconfig( + this.context + ); + this.controls = + new Resource$Projects$Locations$Collections$Engines$Controls( + this.context + ); + this.conversations = + new Resource$Projects$Locations$Collections$Engines$Conversations( + this.context + ); + this.operations = + new Resource$Projects$Locations$Collections$Engines$Operations( + this.context + ); + this.servingConfigs = + new Resource$Projects$Locations$Collections$Engines$Servingconfigs( + this.context + ); + this.sessions = + new Resource$Projects$Locations$Collections$Engines$Sessions( + this.context + ); + this.widgetConfigs = + new Resource$Projects$Locations$Collections$Engines$Widgetconfigs( + this.context + ); + } + + /** + * Creates a Engine. * @example * ```js * // Before running the sample: @@ -39891,25 +40846,48 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.collections.engines.list( - * { - * // Optional. Filter by solution type. For example: solution_type=SOLUTION_TYPE_SEARCH - * filter: 'placeholder-value', - * // Optional. Not supported. - * pageSize: 'placeholder-value', - * // Optional. Not supported. - * pageToken: 'placeholder-value', - * // Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. + * const res = + * await discoveryengine.projects.locations.collections.engines.create({ + * // Required. The ID to use for the Engine, which will become the final component of the Engine's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. + * engineId: 'placeholder-value', + * // Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`. * parent: * 'projects/my-project/locations/my-location/collections/my-collection', - * }, - * ); + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "appType": "my_appType", + * // "chatEngineConfig": {}, + * // "chatEngineMetadata": {}, + * // "commonConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", + * // "createTime": "my_createTime", + * // "dataStoreIds": [], + * // "disableAnalytics": false, + * // "displayName": "my_displayName", + * // "features": {}, + * // "industryVertical": "my_industryVertical", + * // "mediaRecommendationEngineConfig": {}, + * // "name": "my_name", + * // "recommendationMetadata": {}, + * // "searchEngineConfig": {}, + * // "similarDocumentsConfig": {}, + * // "solutionType": "my_solutionType", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "engines": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -39925,62 +40903,58 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Engines$List, + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Create, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Collections$Engines$List, + create( + params?: Params$Resource$Projects$Locations$Collections$Engines$Create, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$List, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$List, + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Create, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - list( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$List; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$List; + {} as Params$Resource$Projects$Locations$Collections$Engines$Create; options = {}; } @@ -39998,7 +40972,7 @@ export namespace discoveryengine_v1alpha { /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -40009,19 +40983,17 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates an Engine + * Deletes a Engine. * @example * ```js * // Before running the sample: @@ -40054,59 +41026,19 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.engines.patch({ - * // Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + * await discoveryengine.projects.locations.collections.engines.delete({ + * // Required. Full resource name of Engine, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. If the caller does not have permission to delete the Engine, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Engine to delete does not exist, a NOT_FOUND error is returned. * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine', - * // Indicates which fields in the provided Engine to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "appType": "my_appType", - * // "chatEngineConfig": {}, - * // "chatEngineMetadata": {}, - * // "commonConfig": {}, - * // "configurableBillingApproach": "my_configurableBillingApproach", - * // "createTime": "my_createTime", - * // "dataStoreIds": [], - * // "disableAnalytics": false, - * // "displayName": "my_displayName", - * // "features": {}, - * // "industryVertical": "my_industryVertical", - * // "mediaRecommendationEngineConfig": {}, - * // "name": "my_name", - * // "recommendationMetadata": {}, - * // "searchEngineConfig": {}, - * // "similarDocumentsConfig": {}, - * // "solutionType": "my_solutionType", - * // "updateTime": "my_updateTime" - * // } - * }, * }); * console.log(res.data); * * // Example response * // { - * // "appType": "my_appType", - * // "chatEngineConfig": {}, - * // "chatEngineMetadata": {}, - * // "commonConfig": {}, - * // "configurableBillingApproach": "my_configurableBillingApproach", - * // "createTime": "my_createTime", - * // "dataStoreIds": [], - * // "disableAnalytics": false, - * // "displayName": "my_displayName", - * // "features": {}, - * // "industryVertical": "my_industryVertical", - * // "mediaRecommendationEngineConfig": {}, + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "recommendationMetadata": {}, - * // "searchEngineConfig": {}, - * // "similarDocumentsConfig": {}, - * // "solutionType": "my_solutionType", - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -40122,62 +41054,58 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Patch, + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Delete, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Collections$Engines$Patch, + delete( + params?: Params$Resource$Projects$Locations$Collections$Engines$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Patch, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Patch, + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Patch, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Delete, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - patch( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Patch; + {} as Params$Resource$Projects$Locations$Collections$Engines$Delete; options = {}; } @@ -40192,7 +41120,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options @@ -40203,19 +41131,17 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Pauses the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. + * Gets a Engine. * @example * ```js * // Before running the sample: @@ -40247,17 +41173,10 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await discoveryengine.projects.locations.collections.engines.pause({ - * // Required. The name of the engine to pause. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}` - * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }); + * const res = await discoveryengine.projects.locations.collections.engines.get({ + * // Required. Full resource name of Engine, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. + * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine', + * }); * console.log(res.data); * * // Example response @@ -40295,38 +41214,38 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - pause( - params: Params$Resource$Projects$Locations$Collections$Engines$Pause, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Get, options: StreamMethodOptions ): Promise>; - pause( - params?: Params$Resource$Projects$Locations$Collections$Engines$Pause, + get( + params?: Params$Resource$Projects$Locations$Collections$Engines$Get, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; - pause( - params: Params$Resource$Projects$Locations$Collections$Engines$Pause, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - pause( - params: Params$Resource$Projects$Locations$Collections$Engines$Pause, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - pause( - params: Params$Resource$Projects$Locations$Collections$Engines$Pause, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Get, callback: BodyResponseCallback ): void; - pause( + get( callback: BodyResponseCallback ): void; - pause( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Pause + | Params$Resource$Projects$Locations$Collections$Engines$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -40344,13 +41263,13 @@ export namespace discoveryengine_v1alpha { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Pause; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Pause; + {} as Params$Resource$Projects$Locations$Collections$Engines$Get; options = {}; } @@ -40364,11 +41283,8 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}:pause').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -40391,7 +41307,7 @@ export namespace discoveryengine_v1alpha { } /** - * Resumes the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. + * Get Workspace settings for the end user. * @example * ```js * // Before running the sample: @@ -40424,38 +41340,17 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.engines.resume({ - * // Required. The name of the engine to resume. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}` - * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} + * await discoveryengine.projects.locations.collections.engines.getWorkspaceSettings( + * { + * // Required. Full Engine resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}` + * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine', * }, - * }); + * ); * console.log(res.data); * * // Example response * // { - * // "appType": "my_appType", - * // "chatEngineConfig": {}, - * // "chatEngineMetadata": {}, - * // "commonConfig": {}, - * // "configurableBillingApproach": "my_configurableBillingApproach", - * // "createTime": "my_createTime", - * // "dataStoreIds": [], - * // "disableAnalytics": false, - * // "displayName": "my_displayName", - * // "features": {}, - * // "industryVertical": "my_industryVertical", - * // "mediaRecommendationEngineConfig": {}, - * // "name": "my_name", - * // "recommendationMetadata": {}, - * // "searchEngineConfig": {}, - * // "similarDocumentsConfig": {}, - * // "solutionType": "my_solutionType", - * // "updateTime": "my_updateTime" + * // "workspaceAccessEnabled": false * // } * } * @@ -40471,62 +41366,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - resume( - params: Params$Resource$Projects$Locations$Collections$Engines$Resume, + getWorkspaceSettings( + params: Params$Resource$Projects$Locations$Collections$Engines$Getworkspacesettings, options: StreamMethodOptions ): Promise>; - resume( - params?: Params$Resource$Projects$Locations$Collections$Engines$Resume, + getWorkspaceSettings( + params?: Params$Resource$Projects$Locations$Collections$Engines$Getworkspacesettings, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - resume( - params: Params$Resource$Projects$Locations$Collections$Engines$Resume, + getWorkspaceSettings( + params: Params$Resource$Projects$Locations$Collections$Engines$Getworkspacesettings, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - resume( - params: Params$Resource$Projects$Locations$Collections$Engines$Resume, + getWorkspaceSettings( + params: Params$Resource$Projects$Locations$Collections$Engines$Getworkspacesettings, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - resume( - params: Params$Resource$Projects$Locations$Collections$Engines$Resume, - callback: BodyResponseCallback + getWorkspaceSettings( + params: Params$Resource$Projects$Locations$Collections$Engines$Getworkspacesettings, + callback: BodyResponseCallback ): void; - resume( - callback: BodyResponseCallback + getWorkspaceSettings( + callback: BodyResponseCallback ): void; - resume( + getWorkspaceSettings( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Resume - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Getworkspacesettings + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Resume; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Getworkspacesettings; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Resume; + {} as Params$Resource$Projects$Locations$Collections$Engines$Getworkspacesettings; options = {}; } @@ -40540,11 +41435,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}:resume').replace( + url: (rootUrl + '/v1alpha/{+name}:getWorkspaceSettings').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -40555,19 +41450,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Tunes an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. + * Lists all the Engines associated with the project. * @example * ```js * // Before running the sample: @@ -40599,27 +41494,25 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.collections.engines.tune( + * const res = await discoveryengine.projects.locations.collections.engines.list( * { - * // Required. The resource name of the engine to tune. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}` - * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, + * // Optional. Filter by solution type. For example: solution_type=SOLUTION_TYPE_SEARCH + * filter: 'placeholder-value', + * // Optional. Not supported. + * pageSize: 'placeholder-value', + * // Optional. Not supported. + * pageToken: 'placeholder-value', + * // Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. + * parent: + * 'projects/my-project/locations/my-location/collections/my-collection', * }, * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "engines": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -40635,58 +41528,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - tune( - params: Params$Resource$Projects$Locations$Collections$Engines$Tune, + list( + params: Params$Resource$Projects$Locations$Collections$Engines$List, options: StreamMethodOptions ): Promise>; - tune( - params?: Params$Resource$Projects$Locations$Collections$Engines$Tune, + list( + params?: Params$Resource$Projects$Locations$Collections$Engines$List, options?: MethodOptions - ): Promise>; - tune( - params: Params$Resource$Projects$Locations$Collections$Engines$Tune, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - tune( - params: Params$Resource$Projects$Locations$Collections$Engines$Tune, + list( + params: Params$Resource$Projects$Locations$Collections$Engines$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - tune( - params: Params$Resource$Projects$Locations$Collections$Engines$Tune, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Engines$List, + callback: BodyResponseCallback ): void; - tune( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - tune( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Tune - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Tune; + {}) as Params$Resource$Projects$Locations$Collections$Engines$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Tune; + {} as Params$Resource$Projects$Locations$Collections$Engines$List; options = {}; } @@ -40700,148 +41597,34 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}:tune').replace( + url: (rootUrl + '/v1alpha/{+parent}/engines').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Engines$Create - extends StandardParameters { - /** - * Required. The ID to use for the Engine, which will become the final component of the Engine's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. - */ - engineId?: string; - /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`. - */ - parent?: string; /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEngine; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Delete - extends StandardParameters { - /** - * Required. Full resource name of Engine, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. If the caller does not have permission to delete the Engine, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Engine to delete does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Get - extends StandardParameters { - /** - * Required. Full resource name of Engine, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Getworkspacesettings - extends StandardParameters { - /** - * Required. Full Engine resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$List - extends StandardParameters { - /** - * Optional. Filter by solution type. For example: solution_type=SOLUTION_TYPE_SEARCH - */ - filter?: string; - /** - * Optional. Not supported. - */ - pageSize?: number; - /** - * Optional. Not supported. - */ - pageToken?: string; - /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Patch - extends StandardParameters { - /** - * Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. - */ - name?: string; - /** - * Indicates which fields in the provided Engine to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEngine; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Pause - extends StandardParameters { - /** - * Required. The name of the engine to pause. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPauseEngineRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Resume - extends StandardParameters { - /** - * Required. The name of the engine to resume. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaResumeEngineRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Tune - extends StandardParameters { - /** - * Required. The resource name of the engine to tune. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTuneEngineRequest; - } - - export class Resource$Projects$Locations$Collections$Engines$Analytics { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Exports metrics. + * Updates an Engine * @example * ```js * // Before running the sample: @@ -40874,30 +41657,59 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.engines.analytics.exportMetrics( - * { - * // Required. The analytics resource name under the engine where the metrics are created. The format is `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/analytics`. - * analytics: - * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/analytics', + * await discoveryengine.projects.locations.collections.engines.patch({ + * // Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine', + * // Indicates which fields in the provided Engine to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. + * updateMask: 'placeholder-value', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "outputConfig": {} - * // } - * }, + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "appType": "my_appType", + * // "chatEngineConfig": {}, + * // "chatEngineMetadata": {}, + * // "commonConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", + * // "createTime": "my_createTime", + * // "dataStoreIds": [], + * // "disableAnalytics": false, + * // "displayName": "my_displayName", + * // "features": {}, + * // "industryVertical": "my_industryVertical", + * // "mediaRecommendationEngineConfig": {}, + * // "name": "my_name", + * // "recommendationMetadata": {}, + * // "searchEngineConfig": {}, + * // "similarDocumentsConfig": {}, + * // "solutionType": "my_solutionType", + * // "updateTime": "my_updateTime" + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "appType": "my_appType", + * // "chatEngineConfig": {}, + * // "chatEngineMetadata": {}, + * // "commonConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", + * // "createTime": "my_createTime", + * // "dataStoreIds": [], + * // "disableAnalytics": false, + * // "displayName": "my_displayName", + * // "features": {}, + * // "industryVertical": "my_industryVertical", + * // "mediaRecommendationEngineConfig": {}, * // "name": "my_name", - * // "response": {} + * // "recommendationMetadata": {}, + * // "searchEngineConfig": {}, + * // "similarDocumentsConfig": {}, + * // "solutionType": "my_solutionType", + * // "updateTime": "my_updateTime" * // } * } * @@ -40913,58 +41725,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - exportMetrics( - params: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Exportmetrics, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Patch, options: StreamMethodOptions ): Promise>; - exportMetrics( - params?: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Exportmetrics, + patch( + params?: Params$Resource$Projects$Locations$Collections$Engines$Patch, options?: MethodOptions - ): Promise>; - exportMetrics( - params: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Exportmetrics, + ): Promise< + GaxiosResponseWithHTTP2 + >; + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - exportMetrics( - params: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Exportmetrics, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - exportMetrics( - params: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Exportmetrics, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Patch, + callback: BodyResponseCallback ): void; - exportMetrics( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - exportMetrics( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Analytics$Exportmetrics - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Analytics$Exportmetrics; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Analytics$Exportmetrics; + {} as Params$Resource$Projects$Locations$Collections$Engines$Patch; options = {}; } @@ -40978,52 +41794,31 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+analytics}:exportMetrics').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['analytics'], - pathParams: ['analytics'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Engines$Analytics$Exportmetrics - extends StandardParameters { - /** - * Required. The analytics resource name under the engine where the metrics are created. The format is `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/analytics`. - */ - analytics?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaExportMetricsRequest; - } - - export class Resource$Projects$Locations$Collections$Engines$Assistants { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Gets an Assistant. + * Pauses the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. * @example * ```js * // Before running the sample: @@ -41046,7 +41841,6 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -41057,21 +41851,38 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.engines.assistants.get( - * { - * // Required. Resource name of Assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}` - * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant', + * await discoveryengine.projects.locations.collections.engines.pause({ + * // Required. The name of the engine to pause. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}` + * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} * }, - * ); + * }); * console.log(res.data); * * // Example response * // { - * // "customerPolicy": {}, - * // "enabledTools": {}, - * // "generationConfig": {}, + * // "appType": "my_appType", + * // "chatEngineConfig": {}, + * // "chatEngineMetadata": {}, + * // "commonConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", + * // "createTime": "my_createTime", + * // "dataStoreIds": [], + * // "disableAnalytics": false, + * // "displayName": "my_displayName", + * // "features": {}, + * // "industryVertical": "my_industryVertical", + * // "mediaRecommendationEngineConfig": {}, * // "name": "my_name", - * // "webGroundingType": "my_webGroundingType" + * // "recommendationMetadata": {}, + * // "searchEngineConfig": {}, + * // "similarDocumentsConfig": {}, + * // "solutionType": "my_solutionType", + * // "updateTime": "my_updateTime" * // } * } * @@ -41087,62 +41898,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get, + pause( + params: Params$Resource$Projects$Locations$Collections$Engines$Pause, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get, + pause( + params?: Params$Resource$Projects$Locations$Collections$Engines$Pause, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get, + pause( + params: Params$Resource$Projects$Locations$Collections$Engines$Pause, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get, + pause( + params: Params$Resource$Projects$Locations$Collections$Engines$Pause, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get, - callback: BodyResponseCallback + pause( + params: Params$Resource$Projects$Locations$Collections$Engines$Pause, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + pause( + callback: BodyResponseCallback ): void; - get( + pause( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Pause + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Pause; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get; + {} as Params$Resource$Projects$Locations$Collections$Engines$Pause; options = {}; } @@ -41156,8 +41967,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+name}:pause').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -41168,19 +41982,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates an Assistant + * Resumes the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. * @example * ```js * // Before running the sample: @@ -41203,7 +42017,6 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -41214,35 +42027,38 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.engines.assistants.patch( - * { - * // Immutable. Resource name of the assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}` It must be a UTF-8 encoded string with a length limit of 1024 characters. - * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant', - * // The list of fields to update. - * updateMask: 'placeholder-value', + * await discoveryengine.projects.locations.collections.engines.resume({ + * // Required. The name of the engine to resume. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}` + * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "customerPolicy": {}, - * // "enabledTools": {}, - * // "generationConfig": {}, - * // "name": "my_name", - * // "webGroundingType": "my_webGroundingType" - * // } - * }, + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} * }, - * ); + * }); * console.log(res.data); * * // Example response * // { - * // "customerPolicy": {}, - * // "enabledTools": {}, - * // "generationConfig": {}, + * // "appType": "my_appType", + * // "chatEngineConfig": {}, + * // "chatEngineMetadata": {}, + * // "commonConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", + * // "createTime": "my_createTime", + * // "dataStoreIds": [], + * // "disableAnalytics": false, + * // "displayName": "my_displayName", + * // "features": {}, + * // "industryVertical": "my_industryVertical", + * // "mediaRecommendationEngineConfig": {}, * // "name": "my_name", - * // "webGroundingType": "my_webGroundingType" + * // "recommendationMetadata": {}, + * // "searchEngineConfig": {}, + * // "similarDocumentsConfig": {}, + * // "solutionType": "my_solutionType", + * // "updateTime": "my_updateTime" * // } * } * @@ -41258,62 +42074,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch, + resume( + params: Params$Resource$Projects$Locations$Collections$Engines$Resume, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch, + resume( + params?: Params$Resource$Projects$Locations$Collections$Engines$Resume, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch, + resume( + params: Params$Resource$Projects$Locations$Collections$Engines$Resume, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch, + resume( + params: Params$Resource$Projects$Locations$Collections$Engines$Resume, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch, - callback: BodyResponseCallback + resume( + params: Params$Resource$Projects$Locations$Collections$Engines$Resume, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + resume( + callback: BodyResponseCallback ): void; - patch( + resume( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Resume + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Resume; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch; + {} as Params$Resource$Projects$Locations$Collections$Engines$Resume; options = {}; } @@ -41327,8 +42143,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1alpha/{+name}:resume').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -41339,19 +42158,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Assists the user with a query in a streaming fashion. + * Tunes an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. * @example * ```js * // Before running the sample: @@ -41374,7 +42193,6 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -41384,32 +42202,27 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await discoveryengine.projects.locations.collections.engines.assistants.streamAssist( - * { - * // Required. The resource name of the Assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}` - * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant', + * const res = await discoveryengine.projects.locations.collections.engines.tune( + * { + * // Required. The resource name of the engine to tune. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}` + * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "generationSpec": {}, - * // "query": {}, - * // "session": "my_session", - * // "toolsSpec": {}, - * // "userMetadata": {} - * // } - * }, + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} * }, - * ); + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "answer": {}, - * // "assistToken": "my_assistToken", - * // "sessionInfo": {} + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -41425,62 +42238,58 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - streamAssist( - params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist, + tune( + params: Params$Resource$Projects$Locations$Collections$Engines$Tune, options: StreamMethodOptions ): Promise>; - streamAssist( - params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist, + tune( + params?: Params$Resource$Projects$Locations$Collections$Engines$Tune, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - streamAssist( - params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist, + ): Promise>; + tune( + params: Params$Resource$Projects$Locations$Collections$Engines$Tune, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - streamAssist( - params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist, + tune( + params: Params$Resource$Projects$Locations$Collections$Engines$Tune, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - streamAssist( - params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist, - callback: BodyResponseCallback + tune( + params: Params$Resource$Projects$Locations$Collections$Engines$Tune, + callback: BodyResponseCallback ): void; - streamAssist( - callback: BodyResponseCallback + tune( + callback: BodyResponseCallback ): void; - streamAssist( + tune( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Tune + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Tune; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist; + {} as Params$Resource$Projects$Locations$Collections$Engines$Tune; options = {}; } @@ -41494,7 +42303,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}:streamAssist').replace( + url: (rootUrl + '/v1alpha/{+name}:tune').replace( /([^:]\/)\/+/g, '$1' ), @@ -41509,62 +42318,133 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get + export interface Params$Resource$Projects$Locations$Collections$Engines$Create extends StandardParameters { /** - * Required. Resource name of Assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}` + * Required. The ID to use for the Engine, which will become the final component of the Engine's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. + */ + engineId?: string; + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEngine; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Delete + extends StandardParameters { + /** + * Required. Full resource name of Engine, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. If the caller does not have permission to delete the Engine, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Engine to delete does not exist, a NOT_FOUND error is returned. */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch + export interface Params$Resource$Projects$Locations$Collections$Engines$Get extends StandardParameters { /** - * Immutable. Resource name of the assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}` It must be a UTF-8 encoded string with a length limit of 1024 characters. + * Required. Full resource name of Engine, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Getworkspacesettings + extends StandardParameters { + /** + * Required. Full Engine resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}` */ name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$List + extends StandardParameters { /** - * The list of fields to update. + * Optional. Filter by solution type. For example: solution_type=SOLUTION_TYPE_SEARCH + */ + filter?: string; + /** + * Optional. Not supported. + */ + pageSize?: number; + /** + * Optional. Not supported. + */ + pageToken?: string; + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Patch + extends StandardParameters { + /** + * Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + */ + name?: string; + /** + * Indicates which fields in the provided Engine to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAssistant; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEngine; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist + export interface Params$Resource$Projects$Locations$Collections$Engines$Pause extends StandardParameters { /** - * Required. The resource name of the Assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}` + * Required. The name of the engine to pause. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}` */ name?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaStreamAssistRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPauseEngineRequest; } + export interface Params$Resource$Projects$Locations$Collections$Engines$Resume + extends StandardParameters { + /** + * Required. The name of the engine to resume. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}` + */ + name?: string; - export class Resource$Projects$Locations$Collections$Engines$Completionconfig { + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaResumeEngineRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Tune + extends StandardParameters { + /** + * Required. The resource name of the engine to tune. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTuneEngineRequest; + } + + export class Resource$Projects$Locations$Collections$Engines$Analytics { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Completes the user input with advanced keyword suggestions. + * Exports metrics. * @example * ```js * // Before running the sample: @@ -41587,8 +42467,6 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud_search.query', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -41599,25 +42477,17 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.engines.completionConfig.completeQuery( + * await discoveryengine.projects.locations.collections.engines.analytics.exportMetrics( * { - * // Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/x/completionConfig` `projects/x/locations/global/collections/default_collection/engines/x/completionConfig`. - * completionConfig: - * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/completionConfig', + * // Required. The analytics resource name under the engine where the metrics are created. The format is `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/analytics`. + * analytics: + * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/analytics', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "boostSpec": {}, - * // "experimentIds": [], - * // "includeTailSuggestions": false, - * // "query": "my_query", - * // "queryModel": "my_queryModel", - * // "suggestionTypeSpecs": [], - * // "suggestionTypes": [], - * // "userInfo": {}, - * // "userPseudoId": "my_userPseudoId" + * // "outputConfig": {} * // } * }, * }, @@ -41626,11 +42496,11 @@ export namespace discoveryengine_v1alpha { * * // Example response * // { - * // "contentSuggestions": [], - * // "peopleSuggestions": [], - * // "querySuggestions": [], - * // "recentSearchSuggestions": [], - * // "tailMatchTriggered": false + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -41646,62 +42516,58 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - completeQuery( - params: Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Completequery, + exportMetrics( + params: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Exportmetrics, options: StreamMethodOptions ): Promise>; - completeQuery( - params?: Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Completequery, + exportMetrics( + params?: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Exportmetrics, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - completeQuery( - params: Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Completequery, + ): Promise>; + exportMetrics( + params: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Exportmetrics, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - completeQuery( - params: Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Completequery, + exportMetrics( + params: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Exportmetrics, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - completeQuery( - params: Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Completequery, - callback: BodyResponseCallback + exportMetrics( + params: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Exportmetrics, + callback: BodyResponseCallback ): void; - completeQuery( - callback: BodyResponseCallback + exportMetrics( + callback: BodyResponseCallback ): void; - completeQuery( + exportMetrics( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Completequery - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Analytics$Exportmetrics + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Completequery; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Analytics$Exportmetrics; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Completequery; + {} as Params$Resource$Projects$Locations$Collections$Engines$Analytics$Exportmetrics; options = {}; } @@ -41715,33 +42581,57 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+completionConfig}:completeQuery' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+analytics}:exportMetrics').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['completionConfig'], - pathParams: ['completionConfig'], + requiredParams: ['analytics'], + pathParams: ['analytics'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Analytics$Exportmetrics + extends StandardParameters { /** - * Removes the search history suggestion in an engine for a user. This will remove the suggestion from being returned in the AdvancedCompleteQueryResponse.recent_search_suggestions for this user. If the user searches the same suggestion again, the new history will override and suggest this suggestion again. + * Required. The analytics resource name under the engine where the metrics are created. The format is `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/analytics`. + */ + analytics?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaExportMetricsRequest; + } + + export class Resource$Projects$Locations$Collections$Engines$Assistants { + context: APIRequestContext; + cannedQueries: Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries; + constructor(context: APIRequestContext) { + this.context = context; + this.cannedQueries = + new Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries( + this.context + ); + } + + /** + * Gets an Assistant. * @example * ```js * // Before running the sample: @@ -41775,29 +42665,22 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.engines.completionConfig.removeSuggestion( + * await discoveryengine.projects.locations.collections.engines.assistants.get( * { - * // Required. The completion_config of the parent engine resource name for which the search history suggestion is to be removed, such as `projects/x/locations/global/collections/default_collection/engines/x/completionConfig`. - * completionConfig: - * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/completionConfig', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "removeAllSearchHistorySuggestions": false, - * // "removeTime": "my_removeTime", - * // "searchHistorySuggestion": "my_searchHistorySuggestion", - * // "userInfo": {}, - * // "userPseudoId": "my_userPseudoId" - * // } - * }, + * // Required. Resource name of Assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}` + * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant', * }, * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "customerPolicy": {}, + * // "enabledTools": {}, + * // "generationConfig": {}, + * // "name": "my_name", + * // "webGroundingType": "my_webGroundingType" + * // } * } * * main().catch(e => { @@ -41812,62 +42695,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - removeSuggestion( - params: Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Removesuggestion, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get, options: StreamMethodOptions ): Promise>; - removeSuggestion( - params?: Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Removesuggestion, + get( + params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - removeSuggestion( - params: Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Removesuggestion, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - removeSuggestion( - params: Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Removesuggestion, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - removeSuggestion( - params: Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Removesuggestion, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get, + callback: BodyResponseCallback ): void; - removeSuggestion( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - removeSuggestion( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Removesuggestion - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Removesuggestion; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Removesuggestion; + {} as Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get; options = {}; } @@ -41881,65 +42764,31 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+completionConfig}:removeSuggestion' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['completionConfig'], - pathParams: ['completionConfig'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Completequery - extends StandardParameters { - /** - * Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/x/completionConfig` `projects/x/locations/global/collections/default_collection/engines/x/completionConfig`. - */ - completionConfig?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Removesuggestion - extends StandardParameters { - /** - * Required. The completion_config of the parent engine resource name for which the search history suggestion is to be removed, such as `projects/x/locations/global/collections/default_collection/engines/x/completionConfig`. - */ - completionConfig?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRemoveSuggestionRequest; - } - - export class Resource$Projects$Locations$Collections$Engines$Controls { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned. + * Updates an Assistant * @example * ```js * // Before running the sample: @@ -41962,6 +42811,7 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -41972,29 +42822,22 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.engines.controls.create( + * await discoveryengine.projects.locations.collections.engines.assistants.patch( * { - * // Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. - * controlId: 'placeholder-value', - * // Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. - * parent: - * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine', + * // Immutable. Resource name of the assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}` It must be a UTF-8 encoded string with a length limit of 1024 characters. + * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant', + * // The list of fields to update. + * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "associatedServingConfigIds": [], - * // "boostAction": {}, - * // "conditions": [], - * // "displayName": "my_displayName", - * // "filterAction": {}, + * // "customerPolicy": {}, + * // "enabledTools": {}, + * // "generationConfig": {}, * // "name": "my_name", - * // "promoteAction": {}, - * // "redirectAction": {}, - * // "solutionType": "my_solutionType", - * // "synonymsAction": {}, - * // "useCases": [] + * // "webGroundingType": "my_webGroundingType" * // } * }, * }, @@ -42003,17 +42846,11 @@ export namespace discoveryengine_v1alpha { * * // Example response * // { - * // "associatedServingConfigIds": [], - * // "boostAction": {}, - * // "conditions": [], - * // "displayName": "my_displayName", - * // "filterAction": {}, + * // "customerPolicy": {}, + * // "enabledTools": {}, + * // "generationConfig": {}, * // "name": "my_name", - * // "promoteAction": {}, - * // "redirectAction": {}, - * // "solutionType": "my_solutionType", - * // "synonymsAction": {}, - * // "useCases": [] + * // "webGroundingType": "my_webGroundingType" * // } * } * @@ -42029,62 +42866,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, + patch( + params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - create( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Controls$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$Create; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$Create; + {} as Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch; options = {}; } @@ -42098,34 +42935,31 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/controls').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. + * Assists the user with a query in a streaming fashion. * @example * ```js * // Before running the sample: @@ -42148,6 +42982,7 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -42158,16 +42993,32 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.engines.controls.delete( + * await discoveryengine.projects.locations.collections.engines.assistants.streamAssist( * { - * // Required. The resource name of the Control to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` - * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/controls/my-control', + * // Required. The resource name of the Assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}` + * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "generationSpec": {}, + * // "query": {}, + * // "session": "my_session", + * // "toolsSpec": {}, + * // "userMetadata": {} + * // } + * }, * }, * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "answer": {}, + * // "assistToken": "my_assistToken", + * // "sessionInfo": {} + * // } * } * * main().catch(e => { @@ -42182,54 +43033,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, + streamAssist( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, + streamAssist( + params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + streamAssist( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + streamAssist( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, - callback: BodyResponseCallback + streamAssist( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete - | BodyResponseCallback + streamAssist( + callback: BodyResponseCallback + ): void; + streamAssist( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete; + {} as Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist; options = {}; } @@ -42243,8 +43102,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1alpha/{+name}:streamAssist').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -42255,17 +43117,62 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Get + extends StandardParameters { /** - * Gets a Control. + * Required. Resource name of Assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Patch + extends StandardParameters { + /** + * Immutable. Resource name of the assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}` It must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string; + /** + * The list of fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAssistant; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Streamassist + extends StandardParameters { + /** + * Required. The resource name of the Assistant. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaStreamAssistRequest; + } + + export class Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a CannedQuery. * @example * ```js * // Before running the sample: @@ -42288,6 +43195,7 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -42298,25 +43206,40 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.engines.controls.get({ - * // Required. The resource name of the Control to get. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` - * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/controls/my-control', - * }); + * await discoveryengine.projects.locations.collections.engines.assistants.cannedQueries.create( + * { + * // Required. The ID to use for the canned query, which will become the final component of the canned query's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters. + * cannedQueryId: 'placeholder-value', + * // Required. The parent resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}` + * parent: + * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "defaultTexts": {}, + * // "displayName": "my_displayName", + * // "enabled": false, + * // "googleDefined": false, + * // "localizedTexts": {}, + * // "name": "my_name", + * // "requiredCapabilities": [] + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "associatedServingConfigIds": [], - * // "boostAction": {}, - * // "conditions": [], + * // "defaultTexts": {}, * // "displayName": "my_displayName", - * // "filterAction": {}, + * // "enabled": false, + * // "googleDefined": false, + * // "localizedTexts": {}, * // "name": "my_name", - * // "promoteAction": {}, - * // "redirectAction": {}, - * // "solutionType": "my_solutionType", - * // "synonymsAction": {}, - * // "useCases": [] + * // "requiredCapabilities": [] * // } * } * @@ -42332,62 +43255,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Create, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, + create( + params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Create, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Create, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Controls$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$Get; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$Get; + {} as Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Create; options = {}; } @@ -42401,31 +43324,34 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+parent}/cannedQueries').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists all Controls by their parent DataStore. + * Deletes a CannedQuery. * @example * ```js * // Before running the sample: @@ -42448,6 +43374,7 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -42458,24 +43385,16 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.engines.controls.list({ - * // Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. - * filter: 'placeholder-value', - * // Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. - * pageSize: 'placeholder-value', - * // Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. - * pageToken: 'placeholder-value', - * // Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. - * parent: - * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine', - * }); + * await discoveryengine.projects.locations.collections.engines.assistants.cannedQueries.delete( + * { + * // Required. Resource name of CannedQuery. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/cannedQueries/{canned_query\}` If the caller does not have permission to delete the canned query, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the canned query to delete does not exist, a `NOT_FOUND` error is returned. + * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant/cannedQueries/my-cannedQuerie', + * }, + * ); * console.log(res.data); * * // Example response - * // { - * // "controls": [], - * // "nextPageToken": "my_nextPageToken" - * // } + * // {} * } * * main().catch(e => { @@ -42490,62 +43409,54 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, + delete( + params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Controls$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$List; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$List; + {} as Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Delete; options = {}; } @@ -42559,34 +43470,29 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/controls').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. + * Gets a CannedQuery. * @example * ```js * // Before running the sample: @@ -42609,6 +43515,7 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -42619,47 +43526,23 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.engines.controls.patch( + * await discoveryengine.projects.locations.collections.engines.assistants.cannedQueries.get( * { - * // Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` - * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/controls/my-control', - * // Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "associatedServingConfigIds": [], - * // "boostAction": {}, - * // "conditions": [], - * // "displayName": "my_displayName", - * // "filterAction": {}, - * // "name": "my_name", - * // "promoteAction": {}, - * // "redirectAction": {}, - * // "solutionType": "my_solutionType", - * // "synonymsAction": {}, - * // "useCases": [] - * // } - * }, + * // Required. Resource name of CannedQuery. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/cannedQueries/{canned_query\}` + * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant/cannedQueries/my-cannedQuerie', * }, * ); * console.log(res.data); * * // Example response * // { - * // "associatedServingConfigIds": [], - * // "boostAction": {}, - * // "conditions": [], + * // "defaultTexts": {}, * // "displayName": "my_displayName", - * // "filterAction": {}, + * // "enabled": false, + * // "googleDefined": false, + * // "localizedTexts": {}, * // "name": "my_name", - * // "promoteAction": {}, - * // "redirectAction": {}, - * // "solutionType": "my_solutionType", - * // "synonymsAction": {}, - * // "useCases": [] + * // "requiredCapabilities": [] * // } * } * @@ -42675,62 +43558,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Get, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, + get( + params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch; + {} as Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Get; options = {}; } @@ -42745,7 +43628,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -42756,92 +43639,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Create - extends StandardParameters { - /** - * Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. - */ - controlId?: string; - /** - * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaControl; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete - extends StandardParameters { - /** - * Required. The resource name of the Control to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Get - extends StandardParameters { - /** - * Required. The resource name of the Control to get. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$List - extends StandardParameters { - /** - * Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. - */ - filter?: string; - /** - * Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. - */ - pageSize?: number; - /** - * Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch - extends StandardParameters { - /** - * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` - */ - name?: string; - /** - * Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaControl; - } - - export class Resource$Projects$Locations$Collections$Engines$Conversations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Converses a conversation. + * Lists all CannedQuerys under an Assistant. * @example * ```js * // Before running the sample: @@ -42864,6 +43674,7 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -42874,35 +43685,25 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.engines.conversations.converse( + * await discoveryengine.projects.locations.collections.engines.assistants.cannedQueries.list( * { - * // Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. - * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/conversations/my-conversation', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "boostSpec": {}, - * // "conversation": {}, - * // "filter": "my_filter", - * // "query": {}, - * // "safeSearch": false, - * // "servingConfig": "my_servingConfig", - * // "summarySpec": {}, - * // "userLabels": {} - * // } - * }, + * // Optional. The filter expression. Supported fields: * `enabled` * `google_defined` Examples: * `enabled=true` * `google_defined=true` * `enabled=true AND google_defined=true` + * filter: 'placeholder-value', + * // Maximum number of canned queries to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000. + * pageSize: 'placeholder-value', + * // A page token received from a previous CannedQueryService.ListCannedQueries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to CannedQueryService.ListCannedQueries must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The parent resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}` + * parent: + * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant', * }, * ); * console.log(res.data); * * // Example response * // { - * // "conversation": {}, - * // "relatedQuestions": [], - * // "reply": {}, - * // "searchResults": [] + * // "cannedQueries": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -42918,62 +43719,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - converse( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$List, options: StreamMethodOptions ): Promise>; - converse( - params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, + list( + params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - converse( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - converse( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - converse( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$List, + callback: BodyResponseCallback ): void; - converse( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - converse( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse; + {} as Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$List; options = {}; } @@ -42987,34 +43788,34 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}:converse').replace( + url: (rootUrl + '/v1alpha/{+parent}/cannedQueries').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. + * Updates a CannedQuery. * @example * ```js * // Before running the sample: @@ -43037,6 +43838,7 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -43047,22 +43849,24 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.engines.conversations.create( + * await discoveryengine.projects.locations.collections.engines.assistants.cannedQueries.patch( * { - * // Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` - * parent: - * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine', + * // Immutable. Resource name of the canned query. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/cannedQueries/{canned_query\}` It must be a UTF-8 encoded string with a length limit of 1024 characters. + * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant/cannedQueries/my-cannedQuerie', + * // The list of fields to update. + * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "endTime": "my_endTime", - * // "messages": [], + * // "defaultTexts": {}, + * // "displayName": "my_displayName", + * // "enabled": false, + * // "googleDefined": false, + * // "localizedTexts": {}, * // "name": "my_name", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "userPseudoId": "my_userPseudoId" + * // "requiredCapabilities": [] * // } * }, * }, @@ -43071,12 +43875,13 @@ export namespace discoveryengine_v1alpha { * * // Example response * // { - * // "endTime": "my_endTime", - * // "messages": [], + * // "defaultTexts": {}, + * // "displayName": "my_displayName", + * // "enabled": false, + * // "googleDefined": false, + * // "localizedTexts": {}, * // "name": "my_name", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "userPseudoId": "my_userPseudoId" + * // "requiredCapabilities": [] * // } * } * @@ -43092,62 +43897,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Patch, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, + patch( + params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Patch, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Patch, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - create( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create; + {} as Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Patch; options = {}; } @@ -43161,37 +43966,107 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/conversations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Create + extends StandardParameters { /** - * Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. - * @example - * ```js - * // Before running the sample: + * Required. The ID to use for the canned query, which will become the final component of the canned query's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters. + */ + cannedQueryId?: string; + /** + * Required. The parent resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaCannedQuery; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Delete + extends StandardParameters { + /** + * Required. Resource name of CannedQuery. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/cannedQueries/{canned_query\}` If the caller does not have permission to delete the canned query, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the canned query to delete does not exist, a `NOT_FOUND` error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Get + extends StandardParameters { + /** + * Required. Resource name of CannedQuery. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/cannedQueries/{canned_query\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$List + extends StandardParameters { + /** + * Optional. The filter expression. Supported fields: * `enabled` * `google_defined` Examples: * `enabled=true` * `google_defined=true` * `enabled=true AND google_defined=true` + */ + filter?: string; + /** + * Maximum number of canned queries to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000. + */ + pageSize?: number; + /** + * A page token received from a previous CannedQueryService.ListCannedQueries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to CannedQueryService.ListCannedQueries must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries$Patch + extends StandardParameters { + /** + * Immutable. Resource name of the canned query. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/cannedQueries/{canned_query\}` It must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string; + /** + * The list of fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaCannedQuery; + } + + export class Resource$Projects$Locations$Collections$Engines$Completionconfig { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Completes the user input with advanced keyword suggestions. + * @example + * ```js + * // Before running the sample: * // - Enable the API at: * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com * // - Login into gcloud by running: @@ -43211,6 +44086,8 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud_search.query', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -43221,16 +44098,39 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.engines.conversations.delete( + * await discoveryengine.projects.locations.collections.engines.completionConfig.completeQuery( * { - * // Required. The resource name of the Conversation to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` - * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/conversations/my-conversation', + * // Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/x/completionConfig` `projects/x/locations/global/collections/default_collection/engines/x/completionConfig`. + * completionConfig: + * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/completionConfig', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "boostSpec": {}, + * // "experimentIds": [], + * // "includeTailSuggestions": false, + * // "query": "my_query", + * // "queryModel": "my_queryModel", + * // "suggestionTypeSpecs": [], + * // "suggestionTypes": [], + * // "userInfo": {}, + * // "userPseudoId": "my_userPseudoId" + * // } + * }, * }, * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "contentSuggestions": [], + * // "peopleSuggestions": [], + * // "querySuggestions": [], + * // "recentSearchSuggestions": [], + * // "tailMatchTriggered": false + * // } * } * * main().catch(e => { @@ -43245,54 +44145,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, + completeQuery( + params: Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Completequery, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, + completeQuery( + params?: Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Completequery, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + completeQuery( + params: Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Completequery, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + completeQuery( + params: Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Completequery, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, - callback: BodyResponseCallback + completeQuery( + params: Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Completequery, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + completeQuery( + callback: BodyResponseCallback + ): void; + completeQuery( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Completequery + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Completequery; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete; + {} as Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Completequery; options = {}; } @@ -43306,29 +44214,33 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: ( + rootUrl + '/v1alpha/{+completionConfig}:completeQuery' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['completionConfig'], + pathParams: ['completionConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a Conversation. + * Removes the search history suggestion in an engine for a user. This will remove the suggestion from being returned in the AdvancedCompleteQueryResponse.recent_search_suggestions for this user. If the user searches the same suggestion again, the new history will override and suggest this suggestion again. * @example * ```js * // Before running the sample: @@ -43351,6 +44263,7 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -43361,23 +44274,29 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.engines.conversations.get( + * await discoveryengine.projects.locations.collections.engines.completionConfig.removeSuggestion( * { - * // Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` - * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/conversations/my-conversation', + * // Required. The completion_config of the parent engine resource name for which the search history suggestion is to be removed, such as `projects/x/locations/global/collections/default_collection/engines/x/completionConfig`. + * completionConfig: + * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/completionConfig', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "removeAllSearchHistorySuggestions": false, + * // "removeTime": "my_removeTime", + * // "searchHistorySuggestion": "my_searchHistorySuggestion", + * // "userInfo": {}, + * // "userPseudoId": "my_userPseudoId" + * // } + * }, * }, * ); * console.log(res.data); * * // Example response - * // { - * // "endTime": "my_endTime", - * // "messages": [], - * // "name": "my_name", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "userPseudoId": "my_userPseudoId" - * // } + * // {} * } * * main().catch(e => { @@ -43392,62 +44311,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, + removeSuggestion( + params: Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Removesuggestion, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, + removeSuggestion( + params?: Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Removesuggestion, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, + removeSuggestion( + params: Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Removesuggestion, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, + removeSuggestion( + params: Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Removesuggestion, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, - callback: BodyResponseCallback + removeSuggestion( + params: Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Removesuggestion, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + removeSuggestion( + callback: BodyResponseCallback ): void; - get( + removeSuggestion( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Removesuggestion + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Removesuggestion; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get; + {} as Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Removesuggestion; options = {}; } @@ -43461,31 +44380,65 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: ( + rootUrl + '/v1alpha/{+completionConfig}:removeSuggestion' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['completionConfig'], + pathParams: ['completionConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + + export interface Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Completequery + extends StandardParameters { + /** + * Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/x/completionConfig` `projects/x/locations/global/collections/default_collection/engines/x/completionConfig`. + */ + completionConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Completionconfig$Removesuggestion + extends StandardParameters { + /** + * Required. The completion_config of the parent engine resource name for which the search history suggestion is to be removed, such as `projects/x/locations/global/collections/default_collection/engines/x/completionConfig`. + */ + completionConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRemoveSuggestionRequest; + } + + export class Resource$Projects$Locations$Collections$Engines$Controls { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Lists all Conversations by their parent DataStore. + * Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned. * @example * ```js * // Before running the sample: @@ -43518,27 +44471,48 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.engines.conversations.list( + * await discoveryengine.projects.locations.collections.engines.controls.create( * { - * // A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" - * filter: 'placeholder-value', - * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: "update_time desc" "create_time" - * orderBy: 'placeholder-value', - * // Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. - * pageSize: 'placeholder-value', - * // A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. - * pageToken: 'placeholder-value', - * // Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` + * // Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. + * controlId: 'placeholder-value', + * // Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. * parent: * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "associatedServingConfigIds": [], + * // "boostAction": {}, + * // "conditions": [], + * // "displayName": "my_displayName", + * // "filterAction": {}, + * // "name": "my_name", + * // "promoteAction": {}, + * // "redirectAction": {}, + * // "solutionType": "my_solutionType", + * // "synonymsAction": {}, + * // "useCases": [] + * // } + * }, * }, * ); * console.log(res.data); * * // Example response * // { - * // "conversations": [], - * // "nextPageToken": "my_nextPageToken" + * // "associatedServingConfigIds": [], + * // "boostAction": {}, + * // "conditions": [], + * // "displayName": "my_displayName", + * // "filterAction": {}, + * // "name": "my_name", + * // "promoteAction": {}, + * // "redirectAction": {}, + * // "solutionType": "my_solutionType", + * // "synonymsAction": {}, + * // "useCases": [] * // } * } * @@ -43554,62 +44528,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, + create( + params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - list( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Conversations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Controls$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$List; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$List; + {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$Create; options = {}; } @@ -43623,11 +44597,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/conversations').replace( + url: (rootUrl + '/v1alpha/{+parent}/controls').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -43638,19 +44612,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned. + * Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. * @example * ```js * // Before running the sample: @@ -43683,38 +44657,16 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.engines.conversations.patch( + * await discoveryengine.projects.locations.collections.engines.controls.delete( * { - * // Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`. - * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/conversations/my-conversation', - * // Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "endTime": "my_endTime", - * // "messages": [], - * // "name": "my_name", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "userPseudoId": "my_userPseudoId" - * // } - * }, + * // Required. The resource name of the Control to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/controls/my-control', * }, * ); * console.log(res.data); * * // Example response - * // { - * // "endTime": "my_endTime", - * // "messages": [], - * // "name": "my_name", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "userPseudoId": "my_userPseudoId" - * // } + * // {} * } * * main().catch(e => { @@ -43729,62 +44681,54 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, + delete( + params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, + callback: BodyResponseCallback ): void; - patch( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch; + {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete; options = {}; } @@ -43799,7 +44743,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options @@ -43810,104 +44754,17 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse - extends StandardParameters { - /** - * Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConverseConversationRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create - extends StandardParameters { - /** - * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete - extends StandardParameters { - /** - * Required. The resource name of the Conversation to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get - extends StandardParameters { - /** - * Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$List - extends StandardParameters { - /** - * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" - */ - filter?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: "update_time desc" "create_time" - */ - orderBy?: string; - /** - * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch - extends StandardParameters { - /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`. - */ - name?: string; - /** - * Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation; - } - - export class Resource$Projects$Locations$Collections$Engines$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Gets a Control. * @example * ```js * // Before running the sample: @@ -43940,21 +44797,25 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.engines.operations.get( - * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/operations/my-operation', - * }, - * ); + * await discoveryengine.projects.locations.collections.engines.controls.get({ + * // Required. The resource name of the Control to get. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/controls/my-control', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "associatedServingConfigIds": [], + * // "boostAction": {}, + * // "conditions": [], + * // "displayName": "my_displayName", + * // "filterAction": {}, * // "name": "my_name", - * // "response": {} + * // "promoteAction": {}, + * // "redirectAction": {}, + * // "solutionType": "my_solutionType", + * // "synonymsAction": {}, + * // "useCases": [] * // } * } * @@ -43971,57 +44832,61 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, + params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, options?: MethodOptions - ): Promise>; + ): Promise< + GaxiosResponseWithHTTP2 + >; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Controls$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Operations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Operations$Get; + {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$Get; options = {}; } @@ -44047,17 +44912,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Lists all Controls by their parent DataStore. * @example * ```js * // Before running the sample: @@ -44090,27 +44957,23 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.engines.operations.list( - * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }, - * ); + * await discoveryengine.projects.locations.collections.engines.controls.list({ + * // Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. + * filter: 'placeholder-value', + * // Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + * pageSize: 'placeholder-value', + * // Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. + * pageToken: 'placeholder-value', + * // Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. + * parent: + * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine', + * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "controls": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -44127,61 +44990,61 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Controls$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Operations$List; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Operations$List; + {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$List; options = {}; } @@ -44195,7 +45058,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}/operations').replace( + url: (rootUrl + '/v1alpha/{+parent}/controls').replace( /([^:]\/)\/+/g, '$1' ), @@ -44205,62 +45068,24 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Engines$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - - export class Resource$Projects$Locations$Collections$Engines$Servingconfigs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Answer query method. + * Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. * @example * ```js * // Before running the sample: @@ -44293,28 +45118,28 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.engines.servingConfigs.answer( + * await discoveryengine.projects.locations.collections.engines.controls.patch( * { - * // Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - * servingConfig: - * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/servingConfigs/my-servingConfig', + * // Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` + * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/controls/my-control', + * // Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. + * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "answerGenerationSpec": {}, - * // "asynchronousMode": false, - * // "endUserSpec": {}, - * // "groundingSpec": {}, - * // "query": {}, - * // "queryUnderstandingSpec": {}, - * // "relatedQuestionsSpec": {}, - * // "safetySpec": {}, - * // "searchSpec": {}, - * // "session": "my_session", - * // "userLabels": {}, - * // "userPseudoId": "my_userPseudoId" + * // "associatedServingConfigIds": [], + * // "boostAction": {}, + * // "conditions": [], + * // "displayName": "my_displayName", + * // "filterAction": {}, + * // "name": "my_name", + * // "promoteAction": {}, + * // "redirectAction": {}, + * // "solutionType": "my_solutionType", + * // "synonymsAction": {}, + * // "useCases": [] * // } * }, * }, @@ -44323,9 +45148,17 @@ export namespace discoveryengine_v1alpha { * * // Example response * // { - * // "answer": {}, - * // "answerQueryToken": "my_answerQueryToken", - * // "session": {} + * // "associatedServingConfigIds": [], + * // "boostAction": {}, + * // "conditions": [], + * // "displayName": "my_displayName", + * // "filterAction": {}, + * // "name": "my_name", + * // "promoteAction": {}, + * // "redirectAction": {}, + * // "solutionType": "my_solutionType", + * // "synonymsAction": {}, + * // "useCases": [] * // } * } * @@ -44341,62 +45174,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - answer( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, options: StreamMethodOptions ): Promise>; - answer( - params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, + patch( + params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - answer( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - answer( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - answer( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, + callback: BodyResponseCallback ): void; - answer( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - answer( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer; + {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch; options = {}; } @@ -44410,34 +45243,104 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+servingConfig}:answer').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Create + extends StandardParameters { /** - * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. + * Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. + */ + controlId?: string; + /** + * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaControl; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete + extends StandardParameters { + /** + * Required. The resource name of the Control to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Get + extends StandardParameters { + /** + * Required. The resource name of the Control to get. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$List + extends StandardParameters { + /** + * Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. + */ + filter?: string; + /** + * Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` + */ + name?: string; + /** + * Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaControl; + } + + export class Resource$Projects$Locations$Collections$Engines$Conversations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Converses a conversation. * @example * ```js * // Before running the sample: @@ -44470,40 +45373,35 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.engines.servingConfigs.get( + * await discoveryengine.projects.locations.collections.engines.conversations.converse( * { - * // Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` - * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/servingConfigs/my-servingConfig', + * // Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. + * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/conversations/my-conversation', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "boostSpec": {}, + * // "conversation": {}, + * // "filter": "my_filter", + * // "query": {}, + * // "safeSearch": false, + * // "servingConfig": "my_servingConfig", + * // "summarySpec": {}, + * // "userLabels": {} + * // } + * }, * }, * ); * console.log(res.data); * * // Example response * // { - * // "answerGenerationSpec": {}, - * // "boostControlIds": [], - * // "createTime": "my_createTime", - * // "customFineTuningSpec": {}, - * // "displayName": "my_displayName", - * // "dissociateControlIds": [], - * // "diversityLevel": "my_diversityLevel", - * // "embeddingConfig": {}, - * // "filterControlIds": [], - * // "genericConfig": {}, - * // "guidedSearchSpec": {}, - * // "ignoreControlIds": [], - * // "mediaConfig": {}, - * // "modelId": "my_modelId", - * // "name": "my_name", - * // "onewaySynonymsControlIds": [], - * // "personalizationSpec": {}, - * // "promoteControlIds": [], - * // "rankingExpression": "my_rankingExpression", - * // "redirectControlIds": [], - * // "replacementControlIds": [], - * // "solutionType": "my_solutionType", - * // "synonymsControlIds": [], - * // "updateTime": "my_updateTime" + * // "conversation": {}, + * // "relatedQuestions": [], + * // "reply": {}, + * // "searchResults": [] * // } * } * @@ -44519,62 +45417,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + converse( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + converse( + params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + converse( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + converse( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, - callback: BodyResponseCallback + converse( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + converse( + callback: BodyResponseCallback ): void; - get( + converse( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get - | BodyResponseCallback - | BodyResponseCallback, + | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse + | BodyResponseCallback + | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get; + {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse; options = {}; } @@ -44588,8 +45486,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+name}:converse').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -44600,19 +45501,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists all ServingConfigs linked to this dataStore. + * Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. * @example * ```js * // Before running the sample: @@ -44645,23 +45546,36 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.engines.servingConfigs.list( + * await discoveryengine.projects.locations.collections.engines.conversations.create( * { - * // Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. - * pageSize: 'placeholder-value', - * // Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. - * pageToken: 'placeholder-value', - * // Required. Full resource name of the parent resource. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` + * // Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` * parent: * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "endTime": "my_endTime", + * // "messages": [], + * // "name": "my_name", + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "userPseudoId": "my_userPseudoId" + * // } + * }, * }, * ); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "servingConfigs": [] + * // "endTime": "my_endTime", + * // "messages": [], + * // "name": "my_name", + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "userPseudoId": "my_userPseudoId" * // } * } * @@ -44677,62 +45591,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, + create( + params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - list( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List; + {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create; options = {}; } @@ -44746,11 +45660,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/servingConfigs').replace( + url: (rootUrl + '/v1alpha/{+parent}/conversations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -44761,19 +45675,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. + * Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. * @example * ```js * // Before running the sample: @@ -44806,74 +45720,16 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.engines.servingConfigs.patch( + * await discoveryengine.projects.locations.collections.engines.conversations.delete( * { - * // Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` - * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/servingConfigs/my-servingConfig', - * // Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "answerGenerationSpec": {}, - * // "boostControlIds": [], - * // "createTime": "my_createTime", - * // "customFineTuningSpec": {}, - * // "displayName": "my_displayName", - * // "dissociateControlIds": [], - * // "diversityLevel": "my_diversityLevel", - * // "embeddingConfig": {}, - * // "filterControlIds": [], - * // "genericConfig": {}, - * // "guidedSearchSpec": {}, - * // "ignoreControlIds": [], - * // "mediaConfig": {}, - * // "modelId": "my_modelId", - * // "name": "my_name", - * // "onewaySynonymsControlIds": [], - * // "personalizationSpec": {}, - * // "promoteControlIds": [], - * // "rankingExpression": "my_rankingExpression", - * // "redirectControlIds": [], - * // "replacementControlIds": [], - * // "solutionType": "my_solutionType", - * // "synonymsControlIds": [], - * // "updateTime": "my_updateTime" - * // } - * }, + * // Required. The resource name of the Conversation to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/conversations/my-conversation', * }, * ); * console.log(res.data); * * // Example response - * // { - * // "answerGenerationSpec": {}, - * // "boostControlIds": [], - * // "createTime": "my_createTime", - * // "customFineTuningSpec": {}, - * // "displayName": "my_displayName", - * // "dissociateControlIds": [], - * // "diversityLevel": "my_diversityLevel", - * // "embeddingConfig": {}, - * // "filterControlIds": [], - * // "genericConfig": {}, - * // "guidedSearchSpec": {}, - * // "ignoreControlIds": [], - * // "mediaConfig": {}, - * // "modelId": "my_modelId", - * // "name": "my_name", - * // "onewaySynonymsControlIds": [], - * // "personalizationSpec": {}, - * // "promoteControlIds": [], - * // "rankingExpression": "my_rankingExpression", - * // "redirectControlIds": [], - * // "replacementControlIds": [], - * // "solutionType": "my_solutionType", - * // "synonymsControlIds": [], - * // "updateTime": "my_updateTime" - * // } + * // {} * } * * main().catch(e => { @@ -44888,62 +45744,54 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, + delete( + params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, + callback: BodyResponseCallback ): void; - patch( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch; + {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete; options = {}; } @@ -44958,7 +45806,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options @@ -44969,19 +45817,17 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Makes a recommendation, which requires a contextual user event. + * Gets a Conversation. * @example * ```js * // Before running the sample: @@ -45014,34 +45860,22 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.engines.servingConfigs.recommend( + * await discoveryengine.projects.locations.collections.engines.conversations.get( * { - * // Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. - * servingConfig: - * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/servingConfigs/my-servingConfig', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "filter": "my_filter", - * // "pageSize": 0, - * // "params": {}, - * // "userEvent": {}, - * // "userLabels": {}, - * // "validateOnly": false - * // } - * }, + * // Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/conversations/my-conversation', * }, * ); * console.log(res.data); * * // Example response * // { - * // "attributionToken": "my_attributionToken", - * // "missingIds": [], - * // "results": [], - * // "validateOnly": false + * // "endTime": "my_endTime", + * // "messages": [], + * // "name": "my_name", + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "userPseudoId": "my_userPseudoId" * // } * } * @@ -45057,62 +45891,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - recommend( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, options: StreamMethodOptions ): Promise>; - recommend( - params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + get( + params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - recommend( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recommend( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - recommend( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, + callback: BodyResponseCallback ): void; - recommend( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - recommend( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend; + {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get; options = {}; } @@ -45126,34 +45960,31 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+servingConfig}:recommend').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Performs a search. + * Lists all Conversations by their parent DataStore. * @example * ```js * // Before running the sample: @@ -45176,7 +46007,6 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -45187,79 +46017,27 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.engines.servingConfigs.search( + * await discoveryengine.projects.locations.collections.engines.conversations.list( * { - * // Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. - * servingConfig: - * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/servingConfigs/my-servingConfig', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "boostSpec": {}, - * // "branch": "my_branch", - * // "canonicalFilter": "my_canonicalFilter", - * // "contentSearchSpec": {}, - * // "customFineTuningSpec": {}, - * // "dataStoreSpecs": [], - * // "displaySpec": {}, - * // "embeddingSpec": {}, - * // "facetSpecs": [], - * // "filter": "my_filter", - * // "imageQuery": {}, - * // "languageCode": "my_languageCode", - * // "naturalLanguageQueryUnderstandingSpec": {}, - * // "offset": 0, - * // "oneBoxPageSize": 0, - * // "orderBy": "my_orderBy", - * // "pageSize": 0, - * // "pageToken": "my_pageToken", - * // "params": {}, - * // "personalizationSpec": {}, - * // "query": "my_query", - * // "queryExpansionSpec": {}, - * // "rankingExpression": "my_rankingExpression", - * // "rankingExpressionBackend": "my_rankingExpressionBackend", - * // "regionCode": "my_regionCode", - * // "relevanceScoreSpec": {}, - * // "relevanceThreshold": "my_relevanceThreshold", - * // "safeSearch": false, - * // "searchAddonSpec": {}, - * // "searchAsYouTypeSpec": {}, - * // "servingConfig": "my_servingConfig", - * // "session": "my_session", - * // "sessionSpec": {}, - * // "spellCorrectionSpec": {}, - * // "useLatestData": false, - * // "userInfo": {}, - * // "userLabels": {}, - * // "userPseudoId": "my_userPseudoId" - * // } - * }, + * // A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" + * filter: 'placeholder-value', + * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: "update_time desc" "create_time" + * orderBy: 'placeholder-value', + * // Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + * pageSize: 'placeholder-value', + * // A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. + * pageToken: 'placeholder-value', + * // Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` + * parent: + * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine', * }, * ); * console.log(res.data); * * // Example response * // { - * // "appliedControls": [], - * // "attributionToken": "my_attributionToken", - * // "correctedQuery": "my_correctedQuery", - * // "facets": [], - * // "geoSearchDebugInfo": [], - * // "guidedSearchResult": {}, - * // "naturalLanguageQueryUnderstandingInfo": {}, - * // "nextPageToken": "my_nextPageToken", - * // "oneBoxResults": [], - * // "queryExpansionInfo": {}, - * // "redirectUri": "my_redirectUri", - * // "results": [], - * // "searchLinkPromotions": [], - * // "sessionInfo": {}, - * // "suggestedQuery": "my_suggestedQuery", - * // "summary": {}, - * // "totalSize": 0 + * // "conversations": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -45275,62 +46053,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - search( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, options: StreamMethodOptions ): Promise>; - search( - params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, + list( + params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - search( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - search( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - search( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, + callback: BodyResponseCallback ): void; - search( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - search( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Conversations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search; + {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$List; options = {}; } @@ -45344,34 +46122,34 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+servingConfig}:search').replace( + url: (rootUrl + '/v1alpha/{+parent}/conversations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Performs a search. Similar to the SearchService.Search method, but a lite version that allows API key for authentication, where OAuth and IAM checks are not required. Only public website search is supported by this method. If data stores and engines not associated with public website search are specified, a `FAILED_PRECONDITION` error is returned. This method can be used for easy onboarding without having to implement an authentication backend. However, it is strongly recommended to use SearchService.Search instead with required OAuth and IAM checks to provide better data security. + * Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned. * @example * ```js * // Before running the sample: @@ -45394,7 +46172,6 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -45405,37 +46182,1759 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.engines.servingConfigs.searchLite( + * await discoveryengine.projects.locations.collections.engines.conversations.patch( * { - * // Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. - * servingConfig: - * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/servingConfigs/my-servingConfig', + * // Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`. + * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/conversations/my-conversation', + * // Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. + * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "boostSpec": {}, - * // "branch": "my_branch", - * // "canonicalFilter": "my_canonicalFilter", - * // "contentSearchSpec": {}, - * // "customFineTuningSpec": {}, - * // "dataStoreSpecs": [], - * // "displaySpec": {}, - * // "embeddingSpec": {}, - * // "facetSpecs": [], - * // "filter": "my_filter", - * // "imageQuery": {}, - * // "languageCode": "my_languageCode", - * // "naturalLanguageQueryUnderstandingSpec": {}, - * // "offset": 0, - * // "oneBoxPageSize": 0, - * // "orderBy": "my_orderBy", - * // "pageSize": 0, - * // "pageToken": "my_pageToken", - * // "params": {}, - * // "personalizationSpec": {}, - * // "query": "my_query", + * // "endTime": "my_endTime", + * // "messages": [], + * // "name": "my_name", + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "userPseudoId": "my_userPseudoId" + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "endTime": "my_endTime", + * // "messages": [], + * // "name": "my_name", + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "userPseudoId": "my_userPseudoId" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse + extends StandardParameters { + /** + * Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConverseConversationRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create + extends StandardParameters { + /** + * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete + extends StandardParameters { + /** + * Required. The resource name of the Conversation to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get + extends StandardParameters { + /** + * Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$List + extends StandardParameters { + /** + * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" + */ + filter?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: "update_time desc" "create_time" + */ + orderBy?: string; + /** + * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`. + */ + name?: string; + /** + * Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation; + } + + export class Resource$Projects$Locations$Collections$Engines$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await discoveryengine.projects.locations.collections.engines.operations.get( + * { + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/operations/my-operation', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await discoveryengine.projects.locations.collections.engines.operations.list( + * { + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Collections$Engines$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + + export class Resource$Projects$Locations$Collections$Engines$Servingconfigs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Answer query method. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await discoveryengine.projects.locations.collections.engines.servingConfigs.answer( + * { + * // Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + * servingConfig: + * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/servingConfigs/my-servingConfig', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "answerGenerationSpec": {}, + * // "asynchronousMode": false, + * // "endUserSpec": {}, + * // "groundingSpec": {}, + * // "query": {}, + * // "queryUnderstandingSpec": {}, + * // "relatedQuestionsSpec": {}, + * // "safetySpec": {}, + * // "searchSpec": {}, + * // "session": "my_session", + * // "userLabels": {}, + * // "userPseudoId": "my_userPseudoId" + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "answer": {}, + * // "answerQueryToken": "my_answerQueryToken", + * // "session": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + answer( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, + options: StreamMethodOptions + ): Promise>; + answer( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + answer( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + answer( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + answer( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, + callback: BodyResponseCallback + ): void; + answer( + callback: BodyResponseCallback + ): void; + answer( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+servingConfig}:answer').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await discoveryengine.projects.locations.collections.engines.servingConfigs.get( + * { + * // Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` + * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/servingConfigs/my-servingConfig', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "answerGenerationSpec": {}, + * // "boostControlIds": [], + * // "createTime": "my_createTime", + * // "customFineTuningSpec": {}, + * // "displayName": "my_displayName", + * // "dissociateControlIds": [], + * // "diversityLevel": "my_diversityLevel", + * // "embeddingConfig": {}, + * // "filterControlIds": [], + * // "genericConfig": {}, + * // "guidedSearchSpec": {}, + * // "ignoreControlIds": [], + * // "mediaConfig": {}, + * // "modelId": "my_modelId", + * // "name": "my_name", + * // "onewaySynonymsControlIds": [], + * // "personalizationSpec": {}, + * // "promoteControlIds": [], + * // "rankingExpression": "my_rankingExpression", + * // "redirectControlIds": [], + * // "replacementControlIds": [], + * // "solutionType": "my_solutionType", + * // "synonymsControlIds": [], + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists all ServingConfigs linked to this dataStore. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await discoveryengine.projects.locations.collections.engines.servingConfigs.list( + * { + * // Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. + * pageSize: 'placeholder-value', + * // Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. + * pageToken: 'placeholder-value', + * // Required. Full resource name of the parent resource. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` + * parent: + * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "servingConfigs": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/servingConfigs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await discoveryengine.projects.locations.collections.engines.servingConfigs.patch( + * { + * // Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` + * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/servingConfigs/my-servingConfig', + * // Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "answerGenerationSpec": {}, + * // "boostControlIds": [], + * // "createTime": "my_createTime", + * // "customFineTuningSpec": {}, + * // "displayName": "my_displayName", + * // "dissociateControlIds": [], + * // "diversityLevel": "my_diversityLevel", + * // "embeddingConfig": {}, + * // "filterControlIds": [], + * // "genericConfig": {}, + * // "guidedSearchSpec": {}, + * // "ignoreControlIds": [], + * // "mediaConfig": {}, + * // "modelId": "my_modelId", + * // "name": "my_name", + * // "onewaySynonymsControlIds": [], + * // "personalizationSpec": {}, + * // "promoteControlIds": [], + * // "rankingExpression": "my_rankingExpression", + * // "redirectControlIds": [], + * // "replacementControlIds": [], + * // "solutionType": "my_solutionType", + * // "synonymsControlIds": [], + * // "updateTime": "my_updateTime" + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "answerGenerationSpec": {}, + * // "boostControlIds": [], + * // "createTime": "my_createTime", + * // "customFineTuningSpec": {}, + * // "displayName": "my_displayName", + * // "dissociateControlIds": [], + * // "diversityLevel": "my_diversityLevel", + * // "embeddingConfig": {}, + * // "filterControlIds": [], + * // "genericConfig": {}, + * // "guidedSearchSpec": {}, + * // "ignoreControlIds": [], + * // "mediaConfig": {}, + * // "modelId": "my_modelId", + * // "name": "my_name", + * // "onewaySynonymsControlIds": [], + * // "personalizationSpec": {}, + * // "promoteControlIds": [], + * // "rankingExpression": "my_rankingExpression", + * // "redirectControlIds": [], + * // "replacementControlIds": [], + * // "solutionType": "my_solutionType", + * // "synonymsControlIds": [], + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Makes a recommendation, which requires a contextual user event. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await discoveryengine.projects.locations.collections.engines.servingConfigs.recommend( + * { + * // Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. + * servingConfig: + * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/servingConfigs/my-servingConfig', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "filter": "my_filter", + * // "pageSize": 0, + * // "params": {}, + * // "userEvent": {}, + * // "userLabels": {}, + * // "validateOnly": false + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "attributionToken": "my_attributionToken", + * // "missingIds": [], + * // "results": [], + * // "validateOnly": false + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + recommend( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + options: StreamMethodOptions + ): Promise>; + recommend( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + recommend( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + recommend( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + recommend( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + callback: BodyResponseCallback + ): void; + recommend( + callback: BodyResponseCallback + ): void; + recommend( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+servingConfig}:recommend').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Performs a search. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await discoveryengine.projects.locations.collections.engines.servingConfigs.search( + * { + * // Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. + * servingConfig: + * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/servingConfigs/my-servingConfig', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "boostSpec": {}, + * // "branch": "my_branch", + * // "canonicalFilter": "my_canonicalFilter", + * // "contentSearchSpec": {}, + * // "customFineTuningSpec": {}, + * // "dataStoreSpecs": [], + * // "displaySpec": {}, + * // "embeddingSpec": {}, + * // "facetSpecs": [], + * // "filter": "my_filter", + * // "imageQuery": {}, + * // "languageCode": "my_languageCode", + * // "naturalLanguageQueryUnderstandingSpec": {}, + * // "offset": 0, + * // "oneBoxPageSize": 0, + * // "orderBy": "my_orderBy", + * // "pageSize": 0, + * // "pageToken": "my_pageToken", + * // "params": {}, + * // "personalizationSpec": {}, + * // "query": "my_query", + * // "queryExpansionSpec": {}, + * // "rankingExpression": "my_rankingExpression", + * // "rankingExpressionBackend": "my_rankingExpressionBackend", + * // "regionCode": "my_regionCode", + * // "relevanceScoreSpec": {}, + * // "relevanceThreshold": "my_relevanceThreshold", + * // "safeSearch": false, + * // "searchAddonSpec": {}, + * // "searchAsYouTypeSpec": {}, + * // "servingConfig": "my_servingConfig", + * // "session": "my_session", + * // "sessionSpec": {}, + * // "spellCorrectionSpec": {}, + * // "useLatestData": false, + * // "userInfo": {}, + * // "userLabels": {}, + * // "userPseudoId": "my_userPseudoId" + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "appliedControls": [], + * // "attributionToken": "my_attributionToken", + * // "correctedQuery": "my_correctedQuery", + * // "facets": [], + * // "geoSearchDebugInfo": [], + * // "guidedSearchResult": {}, + * // "naturalLanguageQueryUnderstandingInfo": {}, + * // "nextPageToken": "my_nextPageToken", + * // "oneBoxResults": [], + * // "queryExpansionInfo": {}, + * // "redirectUri": "my_redirectUri", + * // "results": [], + * // "searchLinkPromotions": [], + * // "sessionInfo": {}, + * // "suggestedQuery": "my_suggestedQuery", + * // "summary": {}, + * // "totalSize": 0 + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + search( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, + options: StreamMethodOptions + ): Promise>; + search( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + search( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + search( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + search( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, + callback: BodyResponseCallback + ): void; + search( + callback: BodyResponseCallback + ): void; + search( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+servingConfig}:search').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Performs a search. Similar to the SearchService.Search method, but a lite version that allows API key for authentication, where OAuth and IAM checks are not required. Only public website search is supported by this method. If data stores and engines not associated with public website search are specified, a `FAILED_PRECONDITION` error is returned. This method can be used for easy onboarding without having to implement an authentication backend. However, it is strongly recommended to use SearchService.Search instead with required OAuth and IAM checks to provide better data security. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await discoveryengine.projects.locations.collections.engines.servingConfigs.searchLite( + * { + * // Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. + * servingConfig: + * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/servingConfigs/my-servingConfig', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "boostSpec": {}, + * // "branch": "my_branch", + * // "canonicalFilter": "my_canonicalFilter", + * // "contentSearchSpec": {}, + * // "customFineTuningSpec": {}, + * // "dataStoreSpecs": [], + * // "displaySpec": {}, + * // "embeddingSpec": {}, + * // "facetSpecs": [], + * // "filter": "my_filter", + * // "imageQuery": {}, + * // "languageCode": "my_languageCode", + * // "naturalLanguageQueryUnderstandingSpec": {}, + * // "offset": 0, + * // "oneBoxPageSize": 0, + * // "orderBy": "my_orderBy", + * // "pageSize": 0, + * // "pageToken": "my_pageToken", + * // "params": {}, + * // "personalizationSpec": {}, + * // "query": "my_query", * // "queryExpansionSpec": {}, * // "rankingExpression": "my_rankingExpression", * // "rankingExpressionBackend": "my_rankingExpressionBackend", @@ -45461,23 +47960,963 @@ export namespace discoveryengine_v1alpha { * * // Example response * // { - * // "appliedControls": [], - * // "attributionToken": "my_attributionToken", - * // "correctedQuery": "my_correctedQuery", - * // "facets": [], - * // "geoSearchDebugInfo": [], - * // "guidedSearchResult": {}, - * // "naturalLanguageQueryUnderstandingInfo": {}, + * // "appliedControls": [], + * // "attributionToken": "my_attributionToken", + * // "correctedQuery": "my_correctedQuery", + * // "facets": [], + * // "geoSearchDebugInfo": [], + * // "guidedSearchResult": {}, + * // "naturalLanguageQueryUnderstandingInfo": {}, + * // "nextPageToken": "my_nextPageToken", + * // "oneBoxResults": [], + * // "queryExpansionInfo": {}, + * // "redirectUri": "my_redirectUri", + * // "results": [], + * // "searchLinkPromotions": [], + * // "sessionInfo": {}, + * // "suggestedQuery": "my_suggestedQuery", + * // "summary": {}, + * // "totalSize": 0 + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + searchLite( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Searchlite, + options: StreamMethodOptions + ): Promise>; + searchLite( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Searchlite, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + searchLite( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Searchlite, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchLite( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Searchlite, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchLite( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Searchlite, + callback: BodyResponseCallback + ): void; + searchLite( + callback: BodyResponseCallback + ): void; + searchLite( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Searchlite + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Searchlite; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Searchlite; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+servingConfig}:searchLite').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await discoveryengine.projects.locations.collections.engines.servingConfigs.streamAnswer( + * { + * // Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + * servingConfig: + * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/servingConfigs/my-servingConfig', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "answerGenerationSpec": {}, + * // "asynchronousMode": false, + * // "endUserSpec": {}, + * // "groundingSpec": {}, + * // "query": {}, + * // "queryUnderstandingSpec": {}, + * // "relatedQuestionsSpec": {}, + * // "safetySpec": {}, + * // "searchSpec": {}, + * // "session": "my_session", + * // "userLabels": {}, + * // "userPseudoId": "my_userPseudoId" + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "answer": {}, + * // "answerQueryToken": "my_answerQueryToken", + * // "session": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + streamAnswer( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Streamanswer, + options: StreamMethodOptions + ): Promise>; + streamAnswer( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Streamanswer, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + streamAnswer( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Streamanswer, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + streamAnswer( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Streamanswer, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + streamAnswer( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Streamanswer, + callback: BodyResponseCallback + ): void; + streamAnswer( + callback: BodyResponseCallback + ): void; + streamAnswer( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Streamanswer + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Streamanswer; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Streamanswer; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+servingConfig}:streamAnswer').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer + extends StandardParameters { + /** + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + */ + servingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get + extends StandardParameters { + /** + * Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List + extends StandardParameters { + /** + * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. Full resource name of the parent resource. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` + */ + name?: string; + /** + * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend + extends StandardParameters { + /** + * Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. + */ + servingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecommendRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search + extends StandardParameters { + /** + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. + */ + servingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Searchlite + extends StandardParameters { + /** + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. + */ + servingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Streamanswer + extends StandardParameters { + /** + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + */ + servingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest; + } + + export class Resource$Projects$Locations$Collections$Engines$Sessions { + context: APIRequestContext; + answers: Resource$Projects$Locations$Collections$Engines$Sessions$Answers; + files: Resource$Projects$Locations$Collections$Engines$Sessions$Files; + constructor(context: APIRequestContext) { + this.context = context; + this.answers = + new Resource$Projects$Locations$Collections$Engines$Sessions$Answers( + this.context + ); + this.files = + new Resource$Projects$Locations$Collections$Engines$Sessions$Files( + this.context + ); + } + + /** + * Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await discoveryengine.projects.locations.collections.engines.sessions.create( + * { + * // Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` + * parent: + * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "displayName": "my_displayName", + * // "endTime": "my_endTime", + * // "isPinned": false, + * // "labels": [], + * // "name": "my_name", + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "turns": [], + * // "userPseudoId": "my_userPseudoId" + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "displayName": "my_displayName", + * // "endTime": "my_endTime", + * // "isPinned": false, + * // "labels": [], + * // "name": "my_name", + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "turns": [], + * // "userPseudoId": "my_userPseudoId" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/sessions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await discoveryengine.projects.locations.collections.engines.sessions.delete( + * { + * // Required. The resource name of the Session to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a Session. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await discoveryengine.projects.locations.collections.engines.sessions.get({ + * // Optional. If set to true, the full session including all answer details will be returned. + * includeAnswerDetails: 'placeholder-value', + * // Required. The resource name of the Session to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "displayName": "my_displayName", + * // "endTime": "my_endTime", + * // "isPinned": false, + * // "labels": [], + * // "name": "my_name", + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "turns": [], + * // "userPseudoId": "my_userPseudoId" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists all Sessions by their parent DataStore. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await discoveryengine.projects.locations.collections.engines.sessions.list({ + * // A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time \> "1970-01-01T12:00:00Z"` + * filter: 'placeholder-value', + * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. + * orderBy: 'placeholder-value', + * // Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + * pageSize: 'placeholder-value', + * // A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. + * pageToken: 'placeholder-value', + * // Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` + * parent: + * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine', + * }); + * console.log(res.data); + * + * // Example response + * // { * // "nextPageToken": "my_nextPageToken", - * // "oneBoxResults": [], - * // "queryExpansionInfo": {}, - * // "redirectUri": "my_redirectUri", - * // "results": [], - * // "searchLinkPromotions": [], - * // "sessionInfo": {}, - * // "suggestedQuery": "my_suggestedQuery", - * // "summary": {}, - * // "totalSize": 0 + * // "sessions": [] * // } * } * @@ -45493,62 +48932,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - searchLite( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Searchlite, + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, options: StreamMethodOptions ): Promise>; - searchLite( - params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Searchlite, + list( + params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - searchLite( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Searchlite, + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - searchLite( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Searchlite, + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - searchLite( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Searchlite, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, + callback: BodyResponseCallback ): void; - searchLite( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - searchLite( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Searchlite - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Sessions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Searchlite; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Searchlite; + {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$List; options = {}; } @@ -45562,34 +49001,34 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+servingConfig}:searchLite').replace( + url: (rootUrl + '/v1alpha/{+parent}/sessions').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream. + * Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. * @example * ```js * // Before running the sample: @@ -45612,6 +49051,7 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -45622,27 +49062,25 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.engines.servingConfigs.streamAnswer( + * await discoveryengine.projects.locations.collections.engines.sessions.patch( * { - * // Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - * servingConfig: - * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/servingConfigs/my-servingConfig', + * // Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` + * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session', + * // Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated. + * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "answerGenerationSpec": {}, - * // "asynchronousMode": false, - * // "endUserSpec": {}, - * // "groundingSpec": {}, - * // "query": {}, - * // "queryUnderstandingSpec": {}, - * // "relatedQuestionsSpec": {}, - * // "safetySpec": {}, - * // "searchSpec": {}, - * // "session": "my_session", - * // "userLabels": {}, + * // "displayName": "my_displayName", + * // "endTime": "my_endTime", + * // "isPinned": false, + * // "labels": [], + * // "name": "my_name", + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "turns": [], * // "userPseudoId": "my_userPseudoId" * // } * }, @@ -45652,9 +49090,15 @@ export namespace discoveryengine_v1alpha { * * // Example response * // { - * // "answer": {}, - * // "answerQueryToken": "my_answerQueryToken", - * // "session": {} + * // "displayName": "my_displayName", + * // "endTime": "my_endTime", + * // "isPinned": false, + * // "labels": [], + * // "name": "my_name", + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "turns": [], + * // "userPseudoId": "my_userPseudoId" * // } * } * @@ -45670,62 +49114,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - streamAnswer( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Streamanswer, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, options: StreamMethodOptions ): Promise>; - streamAnswer( - params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Streamanswer, + patch( + params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - streamAnswer( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Streamanswer, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - streamAnswer( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Streamanswer, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - streamAnswer( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Streamanswer, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, + callback: BodyResponseCallback ): void; - streamAnswer( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - streamAnswer( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Streamanswer - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Streamanswer; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Streamanswer; + {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch; options = {}; } @@ -45739,150 +49183,289 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+servingConfig}:streamAnswer').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer + export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create extends StandardParameters { /** - * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` */ - servingConfig?: string; + parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get + export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete extends StandardParameters { /** - * Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` + * Required. The resource name of the Session to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List + export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get extends StandardParameters { /** - * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. - */ - pageSize?: number; - /** - * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. + * Optional. If set to true, the full session including all answer details will be returned. */ - pageToken?: string; + includeAnswerDetails?: boolean; /** - * Required. Full resource name of the parent resource. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` + * Required. The resource name of the Session to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` */ - parent?: string; + name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch + export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$List extends StandardParameters { /** - * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` + * A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time \> "1970-01-01T12:00:00Z"` */ - name?: string; + filter?: string; /** - * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. */ - updateMask?: string; - + orderBy?: string; /** - * Request body metadata + * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend - extends StandardParameters { + pageSize?: number; /** - * Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. + * A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. */ - servingConfig?: string; - + pageToken?: string; /** - * Request body metadata + * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecommendRequest; + parent?: string; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search + export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch extends StandardParameters { /** - * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. - */ - servingConfig?: string; - - /** - * Request body metadata + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Searchlite - extends StandardParameters { + name?: string; /** - * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. + * Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated. */ - servingConfig?: string; + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Streamanswer - extends StandardParameters { + + export class Resource$Projects$Locations$Collections$Engines$Sessions$Answers { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + /** - * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + * Gets a Answer. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await discoveryengine.projects.locations.collections.engines.sessions.answers.get( + * { + * // Required. The resource name of the Answer to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` + * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session/answers/my-answer', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "answerSkippedReasons": [], + * // "answerText": "my_answerText", + * // "blobAttachments": [], + * // "citations": [], + * // "completeTime": "my_completeTime", + * // "createTime": "my_createTime", + * // "groundingScore": {}, + * // "groundingSupports": [], + * // "name": "my_name", + * // "queryUnderstandingInfo": {}, + * // "references": [], + * // "relatedQuestions": [], + * // "safetyRatings": [], + * // "state": "my_state", + * // "steps": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. */ - servingConfig?: string; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get + extends StandardParameters { /** - * Request body metadata + * Required. The resource name of the Answer to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest; + name?: string; } - export class Resource$Projects$Locations$Collections$Engines$Sessions { + export class Resource$Projects$Locations$Collections$Engines$Sessions$Files { context: APIRequestContext; - answers: Resource$Projects$Locations$Collections$Engines$Sessions$Answers; - files: Resource$Projects$Locations$Collections$Engines$Sessions$Files; constructor(context: APIRequestContext) { this.context = context; - this.answers = - new Resource$Projects$Locations$Collections$Engines$Sessions$Answers( - this.context - ); - this.files = - new Resource$Projects$Locations$Collections$Engines$Sessions$Files( - this.context - ); } /** - * Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. + * Lists metadata for all files in the current session. * @example * ```js * // Before running the sample: @@ -45916,42 +49499,27 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.engines.sessions.create( + * await discoveryengine.projects.locations.collections.engines.sessions.files.list( * { - * // Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` + * // Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the files being filtered. Filter expression is case-sensitive. Currently supported field names are: * upload_time * last_add_time * last_use_time * file_name * mime_type Some examples of filters would be: * "file_name = 'file_1'" * "file_name = 'file_1' AND mime_type = 'text/plain'" * "last_use_time \> '2025-06-14T12:00:00Z'" For a full description of the filter format, please see https://google.aip.dev/160. + * filter: 'placeholder-value', + * // Optional. Specifies the order in which files are returned. The value is a comma-separated string of fields to sort by. For ascending order - just the field name is used. For descending order - the field name is suffixed with ` desc`. Sorting is stable and applied sequentially according to the order of fields provided in the string. Supported fields for ordering: * `upload_time`: The time the file was uploaded. * `file_name`: The name of the file. * `mime_type`: The MIME type of the file. * `session_name`: The name of the session the file belongs to. Default Behavior: If the `order_by` field is not specified, files will be returned sorted by creation time in descending order. Examples: 1. Sort by file name in ascending order: `file_name` 2. Sort by upload time in descending order: `upload_time desc` 3. Sort by file name (ascending), then by content type (MIME type) (descending), and finally by upload time (ascending): `file_name, mime_type desc, upload_time` + * orderBy: 'placeholder-value', + * // Optional. The maximum number of files to return. The service may return fewer than this value. If unspecified, at most 100 files will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. If user specifies a value less than or equal to 0 - the request will be rejected with an INVALID_ARGUMENT error. + * pageSize: 'placeholder-value', + * // Optional. A page token received from a previous `ListFiles` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListFiles` must match the call that provided the page token (except `page_size`, which may differ). + * pageToken: 'placeholder-value', + * // Required. The resource name of the Session. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}` Name of the session resource to which the file belong. * parent: - * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "displayName": "my_displayName", - * // "endTime": "my_endTime", - * // "isPinned": false, - * // "labels": [], - * // "name": "my_name", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "turns": [], - * // "userPseudoId": "my_userPseudoId" - * // } - * }, + * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session', * }, * ); * console.log(res.data); * * // Example response * // { - * // "displayName": "my_displayName", - * // "endTime": "my_endTime", - * // "isPinned": false, - * // "labels": [], - * // "name": "my_name", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "turns": [], - * // "userPseudoId": "my_userPseudoId" + * // "files": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -45967,62 +49535,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Files$List, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, + list( + params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Files$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Files$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Files$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Files$List, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - create( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Files$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Files$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create; + {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Files$List; options = {}; } @@ -46036,11 +49604,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/sessions').replace( + url: (rootUrl + '/v1alpha/{+parent}/files').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -46051,19 +49619,50 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + + export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Files$List + extends StandardParameters { + /** + * Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the files being filtered. Filter expression is case-sensitive. Currently supported field names are: * upload_time * last_add_time * last_use_time * file_name * mime_type Some examples of filters would be: * "file_name = 'file_1'" * "file_name = 'file_1' AND mime_type = 'text/plain'" * "last_use_time \> '2025-06-14T12:00:00Z'" For a full description of the filter format, please see https://google.aip.dev/160. + */ + filter?: string; + /** + * Optional. Specifies the order in which files are returned. The value is a comma-separated string of fields to sort by. For ascending order - just the field name is used. For descending order - the field name is suffixed with ` desc`. Sorting is stable and applied sequentially according to the order of fields provided in the string. Supported fields for ordering: * `upload_time`: The time the file was uploaded. * `file_name`: The name of the file. * `mime_type`: The MIME type of the file. * `session_name`: The name of the session the file belongs to. Default Behavior: If the `order_by` field is not specified, files will be returned sorted by creation time in descending order. Examples: 1. Sort by file name in ascending order: `file_name` 2. Sort by upload time in descending order: `upload_time desc` 3. Sort by file name (ascending), then by content type (MIME type) (descending), and finally by upload time (ascending): `file_name, mime_type desc, upload_time` + */ + orderBy?: string; + /** + * Optional. The maximum number of files to return. The service may return fewer than this value. If unspecified, at most 100 files will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. If user specifies a value less than or equal to 0 - the request will be rejected with an INVALID_ARGUMENT error. + */ + pageSize?: number; + /** + * Optional. A page token received from a previous `ListFiles` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListFiles` must match the call that provided the page token (except `page_size`, which may differ). + */ + pageToken?: string; + /** + * Required. The resource name of the Session. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}` Name of the session resource to which the file belong. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Collections$Engines$Widgetconfigs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. + * Gets a WidgetConfig. * @example * ```js * // Before running the sample: @@ -46097,16 +49696,59 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.engines.sessions.delete( + * await discoveryengine.projects.locations.collections.engines.widgetConfigs.get( * { - * // Required. The resource name of the Session to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` - * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session', + * // Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development. + * acceptCache: 'placeholder-value', + * // Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission. + * 'getWidgetConfigRequestOption.turnOffCollectionComponents': + * 'placeholder-value', + * // Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}` + * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/widgetConfigs/my-widgetConfig', * }, * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "accessSettings": {}, + * // "allowPublicAccess": false, + * // "allowlistedDomains": [], + * // "assistantSettings": {}, + * // "collectionComponents": [], + * // "configId": "my_configId", + * // "contentSearchSpec": {}, + * // "createTime": "my_createTime", + * // "customerProvidedConfig": {}, + * // "dataStoreType": "my_dataStoreType", + * // "dataStoreUiConfigs": [], + * // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy", + * // "displayName": "my_displayName", + * // "enableAutocomplete": false, + * // "enableConversationalSearch": false, + * // "enablePrivateKnowledgeGraph": false, + * // "enableQualityFeedback": false, + * // "enableResultScore": false, + * // "enableSafeSearch": false, + * // "enableSearchAsYouType": false, + * // "enableSnippetResultSummary": false, + * // "enableSummarization": false, + * // "enableWebApp": false, + * // "experimentalFeatures": {}, + * // "facetField": [], + * // "fieldsUiComponentsMap": {}, + * // "geminiBundle": false, + * // "homepageSetting": {}, + * // "industryVertical": "my_industryVertical", + * // "llmEnabled": false, + * // "minimumDataTermAccepted": false, + * // "name": "my_name", + * // "resultDisplayType": "my_resultDisplayType", + * // "solutionType": "my_solutionType", + * // "uiBranding": {}, + * // "uiSettings": {}, + * // "updateTime": "my_updateTime" + * // } * } * * main().catch(e => { @@ -46121,54 +49763,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, + get( + params?: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete; + {} as Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get; options = {}; } @@ -46183,7 +49833,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -46194,17 +49844,42 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get + extends StandardParameters { /** - * Gets a Session. + * Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development. + */ + acceptCache?: boolean; + /** + * Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission. + */ + 'getWidgetConfigRequestOption.turnOffCollectionComponents'?: boolean; + /** + * Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}` + */ + name?: string; + } + + export class Resource$Projects$Locations$Collections$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -46227,7 +49902,6 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -46238,25 +49912,19 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.engines.sessions.get({ - * // Optional. If set to true, the full session including all answer details will be returned. - * includeAnswerDetails: 'placeholder-value', - * // Required. The resource name of the Session to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` - * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session', + * await discoveryengine.projects.locations.collections.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/collections/my-collection/operations/my-operation', * }); * console.log(res.data); * * // Example response * // { - * // "displayName": "my_displayName", - * // "endTime": "my_endTime", - * // "isPinned": false, - * // "labels": [], + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "turns": [], - * // "userPseudoId": "my_userPseudoId" + * // "response": {} * // } * } * @@ -46273,61 +49941,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, + params: Params$Resource$Projects$Locations$Collections$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, + params?: Params$Resource$Projects$Locations$Collections$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; + ): Promise>; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, + params: Params$Resource$Projects$Locations$Collections$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, + params: Params$Resource$Projects$Locations$Collections$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Operations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get; + {}) as Params$Resource$Projects$Locations$Collections$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get; + {} as Params$Resource$Projects$Locations$Collections$Operations$Get; options = {}; } @@ -46353,19 +50017,17 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists all Sessions by their parent DataStore. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -46388,7 +50050,6 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -46399,25 +50060,25 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.engines.sessions.list({ - * // A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time \> "1970-01-01T12:00:00Z"` + * await discoveryengine.projects.locations.collections.operations.list({ + * // The standard list filter. * filter: 'placeholder-value', - * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. - * orderBy: 'placeholder-value', - * // Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/collections/my-collection', + * // The standard list page size. * pageSize: 'placeholder-value', - * // A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. + * // The standard list page token. * pageToken: 'placeholder-value', - * // Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` - * parent: - * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "sessions": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -46434,61 +50095,61 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, + params: Params$Resource$Projects$Locations$Collections$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, + params?: Params$Resource$Projects$Locations$Collections$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, + params: Params$Resource$Projects$Locations$Collections$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, + params: Params$Resource$Projects$Locations$Collections$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Operations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Sessions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$List; + {}) as Params$Resource$Projects$Locations$Collections$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$List; + {} as Params$Resource$Projects$Locations$Collections$Operations$List; options = {}; } @@ -46502,7 +50163,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/sessions').replace( + url: (rootUrl + '/v1alpha/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -46512,24 +50173,119 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Operations$Get + extends StandardParameters { /** - * Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + + export class Resource$Projects$Locations$Datastores { + context: APIRequestContext; + branches: Resource$Projects$Locations$Datastores$Branches; + completionConfig: Resource$Projects$Locations$Datastores$Completionconfig; + completionSuggestions: Resource$Projects$Locations$Datastores$Completionsuggestions; + controls: Resource$Projects$Locations$Datastores$Controls; + conversations: Resource$Projects$Locations$Datastores$Conversations; + models: Resource$Projects$Locations$Datastores$Models; + operations: Resource$Projects$Locations$Datastores$Operations; + schemas: Resource$Projects$Locations$Datastores$Schemas; + servingConfigs: Resource$Projects$Locations$Datastores$Servingconfigs; + sessions: Resource$Projects$Locations$Datastores$Sessions; + siteSearchEngine: Resource$Projects$Locations$Datastores$Sitesearchengine; + suggestionDenyListEntries: Resource$Projects$Locations$Datastores$Suggestiondenylistentries; + userEvents: Resource$Projects$Locations$Datastores$Userevents; + widgetConfigs: Resource$Projects$Locations$Datastores$Widgetconfigs; + constructor(context: APIRequestContext) { + this.context = context; + this.branches = new Resource$Projects$Locations$Datastores$Branches( + this.context + ); + this.completionConfig = + new Resource$Projects$Locations$Datastores$Completionconfig( + this.context + ); + this.completionSuggestions = + new Resource$Projects$Locations$Datastores$Completionsuggestions( + this.context + ); + this.controls = new Resource$Projects$Locations$Datastores$Controls( + this.context + ); + this.conversations = + new Resource$Projects$Locations$Datastores$Conversations(this.context); + this.models = new Resource$Projects$Locations$Datastores$Models( + this.context + ); + this.operations = new Resource$Projects$Locations$Datastores$Operations( + this.context + ); + this.schemas = new Resource$Projects$Locations$Datastores$Schemas( + this.context + ); + this.servingConfigs = + new Resource$Projects$Locations$Datastores$Servingconfigs(this.context); + this.sessions = new Resource$Projects$Locations$Datastores$Sessions( + this.context + ); + this.siteSearchEngine = + new Resource$Projects$Locations$Datastores$Sitesearchengine( + this.context + ); + this.suggestionDenyListEntries = + new Resource$Projects$Locations$Datastores$Suggestiondenylistentries( + this.context + ); + this.userEvents = new Resource$Projects$Locations$Datastores$Userevents( + this.context + ); + this.widgetConfigs = + new Resource$Projects$Locations$Datastores$Widgetconfigs(this.context); + } + + /** + * Completes the specified user input with keyword suggestions. * @example * ```js * // Before running the sample: @@ -46562,44 +50318,27 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await discoveryengine.projects.locations.collections.engines.sessions.patch( - * { - * // Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` - * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session', - * // Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "displayName": "my_displayName", - * // "endTime": "my_endTime", - * // "isPinned": false, - * // "labels": [], - * // "name": "my_name", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "turns": [], - * // "userPseudoId": "my_userPseudoId" - * // } - * }, - * }, - * ); + * const res = await discoveryengine.projects.locations.dataStores.completeQuery( + * { + * // Required. The parent data store resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. + * dataStore: + * 'projects/my-project/locations/my-location/dataStores/my-dataStore', + * // 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. + * includeTailSuggestions: 'placeholder-value', + * // Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. + * query: 'placeholder-value', + * // Specifies the autocomplete data model. 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. + * queryModel: 'placeholder-value', + * // 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 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + * userPseudoId: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "displayName": "my_displayName", - * // "endTime": "my_endTime", - * // "isPinned": false, - * // "labels": [], - * // "name": "my_name", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "turns": [], - * // "userPseudoId": "my_userPseudoId" + * // "querySuggestions": [], + * // "tailMatchTriggered": false * // } * } * @@ -46615,62 +50354,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, + completeQuery( + params: Params$Resource$Projects$Locations$Datastores$Completequery, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, + completeQuery( + params?: Params$Resource$Projects$Locations$Datastores$Completequery, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, + completeQuery( + params: Params$Resource$Projects$Locations$Datastores$Completequery, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, + completeQuery( + params: Params$Resource$Projects$Locations$Datastores$Completequery, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, - callback: BodyResponseCallback + completeQuery( + params: Params$Resource$Projects$Locations$Datastores$Completequery, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + completeQuery( + callback: BodyResponseCallback ): void; - patch( + completeQuery( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Completequery + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Completequery; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Completequery; options = {}; } @@ -46684,108 +50423,34 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1alpha/{+dataStore}:completeQuery').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['dataStore'], + pathParams: ['dataStore'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create - extends StandardParameters { - /** - * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete - extends StandardParameters { - /** - * Required. The resource name of the Session to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get - extends StandardParameters { - /** - * Optional. If set to true, the full session including all answer details will be returned. - */ - includeAnswerDetails?: boolean; - /** - * Required. The resource name of the Session to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$List - extends StandardParameters { - /** - * A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time \> "1970-01-01T12:00:00Z"` - */ - filter?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. - */ - orderBy?: string; - /** - * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch - extends StandardParameters { - /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` - */ - name?: string; - /** - * Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession; - } - - export class Resource$Projects$Locations$Collections$Engines$Sessions$Answers { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Gets a Answer. + * Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately. * @example * ```js * // Before running the sample: @@ -46817,32 +50482,60 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await discoveryengine.projects.locations.collections.engines.sessions.answers.get( - * { - * // Required. The resource name of the Answer to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` - * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session/answers/my-answer', - * }, - * ); + * const res = await discoveryengine.projects.locations.dataStores.create({ + * // Resource name of the CmekConfig to use for protecting this DataStore. + * cmekConfigName: 'placeholder-value', + * // A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. + * createAdvancedSiteSearch: 'placeholder-value', + * // Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. + * dataStoreId: 'placeholder-value', + * // DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well. + * disableCmek: 'placeholder-value', + * // Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`. + * parent: 'projects/my-project/locations/my-location', + * // A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified. + * skipDefaultSchemaCreation: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "aclEnabled": false, + * // "advancedSiteSearchConfig": {}, + * // "billingEstimation": {}, + * // "cmekConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", + * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime", + * // "contentConfig": "my_contentConfig", + * // "createTime": "my_createTime", + * // "defaultSchemaId": "my_defaultSchemaId", + * // "displayName": "my_displayName", + * // "documentProcessingConfig": {}, + * // "healthcareFhirConfig": {}, + * // "identityMappingStore": "my_identityMappingStore", + * // "idpConfig": {}, + * // "industryVertical": "my_industryVertical", + * // "isInfobotFaqDataStore": false, + * // "kmsKeyName": "my_kmsKeyName", + * // "languageInfo": {}, + * // "name": "my_name", + * // "naturalLanguageQueryUnderstandingConfig": {}, + * // "servingConfigDataStore": {}, + * // "solutionTypes": [], + * // "startingSchema": {}, + * // "workspaceConfig": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "answerSkippedReasons": [], - * // "answerText": "my_answerText", - * // "blobAttachments": [], - * // "citations": [], - * // "completeTime": "my_completeTime", - * // "createTime": "my_createTime", - * // "groundingScore": {}, - * // "groundingSupports": [], + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "queryUnderstandingInfo": {}, - * // "references": [], - * // "relatedQuestions": [], - * // "safetyRatings": [], - * // "state": "my_state", - * // "steps": [] + * // "response": {} * // } * } * @@ -46858,62 +50551,57 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, + create( + params: Params$Resource$Projects$Locations$Datastores$Create, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, + create( + params?: Params$Resource$Projects$Locations$Datastores$Create, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Datastores$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, + create( + params: Params$Resource$Projects$Locations$Datastores$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Datastores$Create, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get; + params = {} as Params$Resource$Projects$Locations$Datastores$Create; options = {}; } @@ -46927,46 +50615,32 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+parent}/dataStores').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get - extends StandardParameters { - /** - * Required. The resource name of the Answer to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` - */ - name?: string; - } - - export class Resource$Projects$Locations$Collections$Engines$Sessions$Files { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Lists metadata for all files in the current session. + * Deletes a DataStore. * @example * ```js * // Before running the sample: @@ -46989,7 +50663,6 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -46999,28 +50672,19 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await discoveryengine.projects.locations.collections.engines.sessions.files.list( - * { - * // Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the files being filtered. Filter expression is case-sensitive. Currently supported field names are: * upload_time * last_add_time * last_use_time * file_name * mime_type Some examples of filters would be: * "file_name = 'file_1'" * "file_name = 'file_1' AND mime_type = 'text/plain'" * "last_use_time \> '2025-06-14T12:00:00Z'" For a full description of the filter format, please see https://google.aip.dev/160. - * filter: 'placeholder-value', - * // Optional. Specifies the order in which files are returned. The value is a comma-separated string of fields to sort by. For ascending order - just the field name is used. For descending order - the field name is suffixed with ` desc`. Sorting is stable and applied sequentially according to the order of fields provided in the string. Supported fields for ordering: * `upload_time`: The time the file was uploaded. * `file_name`: The name of the file. * `mime_type`: The MIME type of the file. * `session_name`: The name of the session the file belongs to. Default Behavior: If the `order_by` field is not specified, files will be returned sorted by creation time in descending order. Examples: 1. Sort by file name in ascending order: `file_name` 2. Sort by upload time in descending order: `upload_time desc` 3. Sort by file name (ascending), then by content type (MIME type) (descending), and finally by upload time (ascending): `file_name, mime_type desc, upload_time` - * orderBy: 'placeholder-value', - * // Optional. The maximum number of files to return. The service may return fewer than this value. If unspecified, at most 100 files will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. If user specifies a value less than or equal to 0 - the request will be rejected with an INVALID_ARGUMENT error. - * pageSize: 'placeholder-value', - * // Optional. A page token received from a previous `ListFiles` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListFiles` must match the call that provided the page token (except `page_size`, which may differ). - * pageToken: 'placeholder-value', - * // Required. The resource name of the Session. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}` Name of the session resource to which the file belong. - * parent: - * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/sessions/my-session', - * }, - * ); + * const res = await discoveryengine.projects.locations.dataStores.delete({ + * // Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error is returned. + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore', + * }); * console.log(res.data); * * // Example response * // { - * // "files": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -47036,62 +50700,57 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Files$List, + delete( + params: Params$Resource$Projects$Locations$Datastores$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Files$List, + delete( + params?: Params$Resource$Projects$Locations$Datastores$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Files$List, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Datastores$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Files$List, + delete( + params: Params$Resource$Projects$Locations$Datastores$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Files$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datastores$Delete, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - list( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Files$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Files$List; + {}) as Params$Resource$Projects$Locations$Datastores$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Files$List; + params = {} as Params$Resource$Projects$Locations$Datastores$Delete; options = {}; } @@ -47105,65 +50764,29 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/files').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Files$List - extends StandardParameters { - /** - * Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the files being filtered. Filter expression is case-sensitive. Currently supported field names are: * upload_time * last_add_time * last_use_time * file_name * mime_type Some examples of filters would be: * "file_name = 'file_1'" * "file_name = 'file_1' AND mime_type = 'text/plain'" * "last_use_time \> '2025-06-14T12:00:00Z'" For a full description of the filter format, please see https://google.aip.dev/160. - */ - filter?: string; - /** - * Optional. Specifies the order in which files are returned. The value is a comma-separated string of fields to sort by. For ascending order - just the field name is used. For descending order - the field name is suffixed with ` desc`. Sorting is stable and applied sequentially according to the order of fields provided in the string. Supported fields for ordering: * `upload_time`: The time the file was uploaded. * `file_name`: The name of the file. * `mime_type`: The MIME type of the file. * `session_name`: The name of the session the file belongs to. Default Behavior: If the `order_by` field is not specified, files will be returned sorted by creation time in descending order. Examples: 1. Sort by file name in ascending order: `file_name` 2. Sort by upload time in descending order: `upload_time desc` 3. Sort by file name (ascending), then by content type (MIME type) (descending), and finally by upload time (ascending): `file_name, mime_type desc, upload_time` - */ - orderBy?: string; - /** - * Optional. The maximum number of files to return. The service may return fewer than this value. If unspecified, at most 100 files will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. If user specifies a value less than or equal to 0 - the request will be rejected with an INVALID_ARGUMENT error. - */ - pageSize?: number; - /** - * Optional. A page token received from a previous `ListFiles` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListFiles` must match the call that provided the page token (except `page_size`, which may differ). - */ - pageToken?: string; - /** - * Required. The resource name of the Session. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}` Name of the session resource to which the file belong. - */ - parent?: string; - } - - export class Resource$Projects$Locations$Collections$Engines$Widgetconfigs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Gets a WidgetConfig. + * Gets a DataStore. * @example * ```js * // Before running the sample: @@ -47186,7 +50809,6 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -47196,58 +50818,38 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await discoveryengine.projects.locations.collections.engines.widgetConfigs.get( - * { - * // Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development. - * acceptCache: 'placeholder-value', - * // Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission. - * 'getWidgetConfigRequestOption.turnOffCollectionComponents': - * 'placeholder-value', - * // Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}` - * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/widgetConfigs/my-widgetConfig', - * }, - * ); + * const res = await discoveryengine.projects.locations.dataStores.get({ + * // Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore', + * }); * console.log(res.data); * * // Example response * // { - * // "accessSettings": {}, - * // "allowPublicAccess": false, - * // "allowlistedDomains": [], - * // "assistantSettings": {}, - * // "collectionComponents": [], - * // "configId": "my_configId", - * // "contentSearchSpec": {}, + * // "aclEnabled": false, + * // "advancedSiteSearchConfig": {}, + * // "billingEstimation": {}, + * // "cmekConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", + * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime", + * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", - * // "customerProvidedConfig": {}, - * // "dataStoreType": "my_dataStoreType", - * // "dataStoreUiConfigs": [], - * // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy", + * // "defaultSchemaId": "my_defaultSchemaId", * // "displayName": "my_displayName", - * // "enableAutocomplete": false, - * // "enableConversationalSearch": false, - * // "enablePrivateKnowledgeGraph": false, - * // "enableQualityFeedback": false, - * // "enableResultScore": false, - * // "enableSafeSearch": false, - * // "enableSearchAsYouType": false, - * // "enableSnippetResultSummary": false, - * // "enableSummarization": false, - * // "enableWebApp": false, - * // "experimentalFeatures": {}, - * // "facetField": [], - * // "fieldsUiComponentsMap": {}, - * // "homepageSetting": {}, + * // "documentProcessingConfig": {}, + * // "healthcareFhirConfig": {}, + * // "identityMappingStore": "my_identityMappingStore", + * // "idpConfig": {}, * // "industryVertical": "my_industryVertical", - * // "llmEnabled": false, - * // "minimumDataTermAccepted": false, + * // "isInfobotFaqDataStore": false, + * // "kmsKeyName": "my_kmsKeyName", + * // "languageInfo": {}, * // "name": "my_name", - * // "resultDisplayType": "my_resultDisplayType", - * // "solutionType": "my_solutionType", - * // "uiBranding": {}, - * // "uiSettings": {}, - * // "updateTime": "my_updateTime" + * // "naturalLanguageQueryUnderstandingConfig": {}, + * // "servingConfigDataStore": {}, + * // "solutionTypes": [], + * // "startingSchema": {}, + * // "workspaceConfig": {} * // } * } * @@ -47264,61 +50866,60 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get, + params: Params$Resource$Projects$Locations$Datastores$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get, + params?: Params$Resource$Projects$Locations$Datastores$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get, + params: Params$Resource$Projects$Locations$Datastores$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get, + params: Params$Resource$Projects$Locations$Datastores$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get; + params = {} as Params$Resource$Projects$Locations$Datastores$Get; options = {}; } @@ -47344,42 +50945,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get - extends StandardParameters { - /** - * Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development. - */ - acceptCache?: boolean; - /** - * Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission. - */ - 'getWidgetConfigRequestOption.turnOffCollectionComponents'?: boolean; - /** - * Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}` - */ - name?: string; - } - - export class Resource$Projects$Locations$Collections$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Gets a DocumentProcessingConfig. * @example * ```js * // Before running the sample: @@ -47412,19 +50990,20 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/collections/my-collection/operations/my-operation', - * }); + * await discoveryengine.projects.locations.dataStores.getDocumentProcessingConfig( + * { + * // Required. Full DocumentProcessingConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/documentProcessingConfig` + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/documentProcessingConfig', + * }, + * ); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // { + * // "chunkingConfig": {}, + * // "defaultParsingConfig": {}, * // "name": "my_name", - * // "response": {} + * // "parsingConfigOverrides": {} * // } * } * @@ -47440,58 +51019,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Operations$Get, + getDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Collections$Operations$Get, + getDocumentProcessingConfig( + params?: Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Collections$Operations$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + getDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Operations$Get, + getDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Operations$Get, - callback: BodyResponseCallback + getDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + getDocumentProcessingConfig( + callback: BodyResponseCallback ): void; - get( + getDocumentProcessingConfig( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Operations$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Operations$Get; + {} as Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig; options = {}; } @@ -47517,17 +51100,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Gets the SiteSearchEngine. * @example * ```js * // Before running the sample: @@ -47560,25 +51145,15 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.collections.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/collections/my-collection', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', + * await discoveryengine.projects.locations.dataStores.getSiteSearchEngine({ + * // Required. Resource name of SiteSearchEngine, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/siteSearchEngine', * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "name": "my_name" * // } * } * @@ -47594,62 +51169,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Operations$List, + getSiteSearchEngine( + params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Collections$Operations$List, + getSiteSearchEngine( + params?: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Collections$Operations$List, + getSiteSearchEngine( + params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Operations$List, + getSiteSearchEngine( + params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Operations$List, - callback: BodyResponseCallback + getSiteSearchEngine( + params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + getSiteSearchEngine( + callback: BodyResponseCallback ): void; - list( + getSiteSearchEngine( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Getsitesearchengine + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Operations$List; + {}) as Params$Resource$Projects$Locations$Datastores$Getsitesearchengine; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Operations$List; + {} as Params$Resource$Projects$Locations$Datastores$Getsitesearchengine; options = {}; } @@ -47663,10 +51238,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -47678,114 +51250,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - - export class Resource$Projects$Locations$Datastores { - context: APIRequestContext; - branches: Resource$Projects$Locations$Datastores$Branches; - completionConfig: Resource$Projects$Locations$Datastores$Completionconfig; - completionSuggestions: Resource$Projects$Locations$Datastores$Completionsuggestions; - controls: Resource$Projects$Locations$Datastores$Controls; - conversations: Resource$Projects$Locations$Datastores$Conversations; - models: Resource$Projects$Locations$Datastores$Models; - operations: Resource$Projects$Locations$Datastores$Operations; - schemas: Resource$Projects$Locations$Datastores$Schemas; - servingConfigs: Resource$Projects$Locations$Datastores$Servingconfigs; - sessions: Resource$Projects$Locations$Datastores$Sessions; - siteSearchEngine: Resource$Projects$Locations$Datastores$Sitesearchengine; - suggestionDenyListEntries: Resource$Projects$Locations$Datastores$Suggestiondenylistentries; - userEvents: Resource$Projects$Locations$Datastores$Userevents; - widgetConfigs: Resource$Projects$Locations$Datastores$Widgetconfigs; - constructor(context: APIRequestContext) { - this.context = context; - this.branches = new Resource$Projects$Locations$Datastores$Branches( - this.context - ); - this.completionConfig = - new Resource$Projects$Locations$Datastores$Completionconfig( - this.context - ); - this.completionSuggestions = - new Resource$Projects$Locations$Datastores$Completionsuggestions( - this.context - ); - this.controls = new Resource$Projects$Locations$Datastores$Controls( - this.context - ); - this.conversations = - new Resource$Projects$Locations$Datastores$Conversations(this.context); - this.models = new Resource$Projects$Locations$Datastores$Models( - this.context - ); - this.operations = new Resource$Projects$Locations$Datastores$Operations( - this.context - ); - this.schemas = new Resource$Projects$Locations$Datastores$Schemas( - this.context - ); - this.servingConfigs = - new Resource$Projects$Locations$Datastores$Servingconfigs(this.context); - this.sessions = new Resource$Projects$Locations$Datastores$Sessions( - this.context - ); - this.siteSearchEngine = - new Resource$Projects$Locations$Datastores$Sitesearchengine( - this.context - ); - this.suggestionDenyListEntries = - new Resource$Projects$Locations$Datastores$Suggestiondenylistentries( - this.context - ); - this.userEvents = new Resource$Projects$Locations$Datastores$Userevents( - this.context - ); - this.widgetConfigs = - new Resource$Projects$Locations$Datastores$Widgetconfigs(this.context); - } /** - * Completes the specified user input with keyword suggestions. + * Lists all the DataStores associated with the project. * @example * ```js * // Before running the sample: @@ -47808,7 +51285,6 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -47818,27 +51294,22 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.dataStores.completeQuery( - * { - * // Required. The parent data store resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. - * dataStore: - * 'projects/my-project/locations/my-location/dataStores/my-dataStore', - * // 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. - * includeTailSuggestions: 'placeholder-value', - * // Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. - * query: 'placeholder-value', - * // Specifies the autocomplete data model. 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. - * queryModel: 'placeholder-value', - * // 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 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. - * userPseudoId: 'placeholder-value', - * }, - * ); + * const res = await discoveryengine.projects.locations.dataStores.list({ + * // Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'` + * filter: 'placeholder-value', + * // Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned. + * pageSize: 'placeholder-value', + * // A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned. + * pageToken: 'placeholder-value', + * // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned. + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { - * // "querySuggestions": [], - * // "tailMatchTriggered": false + * // "dataStores": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -47854,62 +51325,61 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - completeQuery( - params: Params$Resource$Projects$Locations$Datastores$Completequery, + list( + params: Params$Resource$Projects$Locations$Datastores$List, options: StreamMethodOptions ): Promise>; - completeQuery( - params?: Params$Resource$Projects$Locations$Datastores$Completequery, + list( + params?: Params$Resource$Projects$Locations$Datastores$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - completeQuery( - params: Params$Resource$Projects$Locations$Datastores$Completequery, + list( + params: Params$Resource$Projects$Locations$Datastores$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - completeQuery( - params: Params$Resource$Projects$Locations$Datastores$Completequery, + list( + params: Params$Resource$Projects$Locations$Datastores$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - completeQuery( - params: Params$Resource$Projects$Locations$Datastores$Completequery, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datastores$List, + callback: BodyResponseCallback ): void; - completeQuery( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - completeQuery( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Completequery - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Completequery; + {}) as Params$Resource$Projects$Locations$Datastores$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Completequery; + params = {} as Params$Resource$Projects$Locations$Datastores$List; options = {}; } @@ -47923,7 +51393,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+dataStore}:completeQuery').replace( + url: (rootUrl + '/v1alpha/{+parent}/dataStores').replace( /([^:]\/)\/+/g, '$1' ), @@ -47933,24 +51403,24 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['dataStore'], - pathParams: ['dataStore'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately. + * Updates a DataStore * @example * ```js * // Before running the sample: @@ -47982,19 +51452,11 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.dataStores.create({ - * // Resource name of the CmekConfig to use for protecting this DataStore. - * cmekConfigName: 'placeholder-value', - * // A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. - * createAdvancedSiteSearch: 'placeholder-value', - * // Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. - * dataStoreId: 'placeholder-value', - * // DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well. - * disableCmek: 'placeholder-value', - * // Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`. - * parent: 'projects/my-project/locations/my-location', - * // A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified. - * skipDefaultSchemaCreation: 'placeholder-value', + * const res = await discoveryengine.projects.locations.dataStores.patch({ + * // Immutable. Identifier. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore', + * // Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. + * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { @@ -48005,6 +51467,7 @@ export namespace discoveryengine_v1alpha { * // "billingEstimation": {}, * // "cmekConfig": {}, * // "configurableBillingApproach": "my_configurableBillingApproach", + * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -48030,11 +51493,30 @@ export namespace discoveryengine_v1alpha { * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "aclEnabled": false, + * // "advancedSiteSearchConfig": {}, + * // "billingEstimation": {}, + * // "cmekConfig": {}, + * // "configurableBillingApproach": "my_configurableBillingApproach", + * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime", + * // "contentConfig": "my_contentConfig", + * // "createTime": "my_createTime", + * // "defaultSchemaId": "my_defaultSchemaId", + * // "displayName": "my_displayName", + * // "documentProcessingConfig": {}, + * // "healthcareFhirConfig": {}, + * // "identityMappingStore": "my_identityMappingStore", + * // "idpConfig": {}, + * // "industryVertical": "my_industryVertical", + * // "isInfobotFaqDataStore": false, + * // "kmsKeyName": "my_kmsKeyName", + * // "languageInfo": {}, * // "name": "my_name", - * // "response": {} + * // "naturalLanguageQueryUnderstandingConfig": {}, + * // "servingConfigDataStore": {}, + * // "solutionTypes": [], + * // "startingSchema": {}, + * // "workspaceConfig": {} * // } * } * @@ -48050,57 +51532,61 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Datastores$Create, + patch( + params: Params$Resource$Projects$Locations$Datastores$Patch, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Datastores$Create, + patch( + params?: Params$Resource$Projects$Locations$Datastores$Patch, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Datastores$Create, + ): Promise< + GaxiosResponseWithHTTP2 + >; + patch( + params: Params$Resource$Projects$Locations$Datastores$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Create, + patch( + params: Params$Resource$Projects$Locations$Datastores$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Create, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datastores$Patch, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - create( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Create; + {}) as Params$Resource$Projects$Locations$Datastores$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datastores$Create; + params = {} as Params$Resource$Projects$Locations$Datastores$Patch; options = {}; } @@ -48114,32 +51600,31 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/dataStores').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a DataStore. + * Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleon resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig. * @example * ```js * // Before running the sample: @@ -48171,19 +51656,34 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.dataStores.delete({ - * // Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error is returned. - * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore', - * }); + * const res = + * await discoveryengine.projects.locations.dataStores.updateDocumentProcessingConfig( + * { + * // The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`. + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/documentProcessingConfig', + * // Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.ocr_config If not set, all supported fields are updated. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "chunkingConfig": {}, + * // "defaultParsingConfig": {}, + * // "name": "my_name", + * // "parsingConfigOverrides": {} + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "chunkingConfig": {}, + * // "defaultParsingConfig": {}, * // "name": "my_name", - * // "response": {} + * // "parsingConfigOverrides": {} * // } * } * @@ -48199,57 +51699,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Datastores$Delete, + updateDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Datastores$Delete, + updateDocumentProcessingConfig( + params?: Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Datastores$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + updateDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Delete, + updateDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Delete, - callback: BodyResponseCallback + updateDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + updateDocumentProcessingConfig( + callback: BodyResponseCallback ): void; - delete( + updateDocumentProcessingConfig( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Delete; + {}) as Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datastores$Delete; + params = + {} as Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig; options = {}; } @@ -48264,7 +51769,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'PATCH', apiVersion: '', }, options @@ -48275,17 +51780,171 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Datastores$Completequery + extends StandardParameters { /** - * Gets a DataStore. + * Required. The parent data store resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. + */ + dataStore?: string; + /** + * 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. + */ + includeTailSuggestions?: boolean; + /** + * Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. + */ + query?: string; + /** + * Specifies the autocomplete data model. 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. + */ + queryModel?: 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 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + userPseudoId?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Create + extends StandardParameters { + /** + * Resource name of the CmekConfig to use for protecting this DataStore. + */ + cmekConfigName?: string; + /** + * A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. + */ + createAdvancedSiteSearch?: boolean; + /** + * Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. + */ + dataStoreId?: string; + /** + * DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well. + */ + disableCmek?: boolean; + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`. + */ + parent?: string; + /** + * A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified. + */ + skipDefaultSchemaCreation?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDataStore; + } + export interface Params$Resource$Projects$Locations$Datastores$Delete + extends StandardParameters { + /** + * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Get + extends StandardParameters { + /** + * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig + extends StandardParameters { + /** + * Required. Full DocumentProcessingConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/documentProcessingConfig` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Getsitesearchengine + extends StandardParameters { + /** + * Required. Resource name of SiteSearchEngine, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$List + extends StandardParameters { + /** + * Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'` + */ + filter?: string; + /** + * Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned. + */ + pageSize?: number; + /** + * A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned. + */ + pageToken?: string; + /** + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Patch + extends StandardParameters { + /** + * Immutable. Identifier. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string; + /** + * Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDataStore; + } + export interface Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig + extends StandardParameters { + /** + * The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`. + */ + name?: string; + /** + * Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.ocr_config If not set, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig; + } + + export class Resource$Projects$Locations$Datastores$Branches { + context: APIRequestContext; + documents: Resource$Projects$Locations$Datastores$Branches$Documents; + operations: Resource$Projects$Locations$Datastores$Branches$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.documents = + new Resource$Projects$Locations$Datastores$Branches$Documents( + this.context + ); + this.operations = + new Resource$Projects$Locations$Datastores$Branches$Operations( + this.context + ); + } + + /** + * Gets index freshness metadata for Documents. Supported for website search only. * @example * ```js * // Before running the sample: @@ -48317,37 +51976,23 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.dataStores.get({ - * // Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. - * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore', - * }); + * const res = + * await discoveryengine.projects.locations.dataStores.branches.batchGetDocumentsMetadata( + * { + * // Required. The FHIR resources to match by. Format: projects/{project\}/locations/{location\}/datasets/{dataset\}/fhirStores/{fhir_store\}/fhir/{resource_type\}/{fhir_resource_id\} + * 'matcher.fhirMatcher.fhirResources': 'placeholder-value', + * // The exact URIs to match by. + * 'matcher.urisMatcher.uris': 'placeholder-value', + * // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + * parent: + * 'projects/my-project/locations/my-location/dataStores/my-dataStore/branches/my-branche', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "aclEnabled": false, - * // "advancedSiteSearchConfig": {}, - * // "billingEstimation": {}, - * // "cmekConfig": {}, - * // "configurableBillingApproach": "my_configurableBillingApproach", - * // "contentConfig": "my_contentConfig", - * // "createTime": "my_createTime", - * // "defaultSchemaId": "my_defaultSchemaId", - * // "displayName": "my_displayName", - * // "documentProcessingConfig": {}, - * // "healthcareFhirConfig": {}, - * // "identityMappingStore": "my_identityMappingStore", - * // "idpConfig": {}, - * // "industryVertical": "my_industryVertical", - * // "isInfobotFaqDataStore": false, - * // "kmsKeyName": "my_kmsKeyName", - * // "languageInfo": {}, - * // "name": "my_name", - * // "naturalLanguageQueryUnderstandingConfig": {}, - * // "servingConfigDataStore": {}, - * // "solutionTypes": [], - * // "startingSchema": {}, - * // "workspaceConfig": {} + * // "documentsMetadata": [] * // } * } * @@ -48363,61 +52008,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Get, + batchGetDocumentsMetadata( + params: Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Datastores$Get, + batchGetDocumentsMetadata( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Datastores$Get, + batchGetDocumentsMetadata( + params: Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Get, + batchGetDocumentsMetadata( + params: Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Get, - callback: BodyResponseCallback + batchGetDocumentsMetadata( + params: Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + batchGetDocumentsMetadata( + callback: BodyResponseCallback ): void; - get( + batchGetDocumentsMetadata( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datastores$Get; + params = + {} as Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata; options = {}; } @@ -48431,31 +52077,33 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: ( + rootUrl + '/v1alpha/{+parent}/batchGetDocumentsMetadata' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets a DocumentProcessingConfig. + * Retrieves a Branch. * @example * ```js * // Before running the sample: @@ -48487,21 +52135,21 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await discoveryengine.projects.locations.dataStores.getDocumentProcessingConfig( - * { - * // Required. Full DocumentProcessingConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/documentProcessingConfig` - * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/documentProcessingConfig', - * }, - * ); + * const res = await discoveryengine.projects.locations.dataStores.branches.get({ + * // Required. The name of the branch to retrieve. Format: `projects/x/locations/global/dataStores/default_data_store/branches/some_branch_id`. "default_branch" can be used as a special branch_id, it returns the default branch that has been set for the document. + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/branches/my-branche', + * // The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified. + * view: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "chunkingConfig": {}, - * // "defaultParsingConfig": {}, - * // "name": "my_name", - * // "parsingConfigOverrides": {} + * // "branchStats": {}, + * // "displayName": "my_displayName", + * // "isDefault": false, + * // "lastDocumentImportTime": "my_lastDocumentImportTime", + * // "name": "my_name" * // } * } * @@ -48517,62 +52165,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig, + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Get, options: StreamMethodOptions ): Promise>; - getDocumentProcessingConfig( - params?: Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig, + get( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - getDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig, + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig, + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Get, + callback: BodyResponseCallback ): void; - getDocumentProcessingConfig( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - getDocumentProcessingConfig( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Get; options = {}; } @@ -48598,19 +52246,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets the SiteSearchEngine. + * Lists all Branchs under the specified parent DataStore. * @example * ```js * // Before running the sample: @@ -48642,16 +52290,20 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await discoveryengine.projects.locations.dataStores.getSiteSearchEngine({ - * // Required. Resource name of SiteSearchEngine, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. - * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/siteSearchEngine', - * }); + * const res = await discoveryengine.projects.locations.dataStores.branches.list( + * { + * // Required. The parent data store resource name. + * parent: + * 'projects/my-project/locations/my-location/dataStores/my-dataStore', + * // The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified. + * view: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "name": "my_name" + * // "branches": [] * // } * } * @@ -48667,62 +52319,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$List, options: StreamMethodOptions ): Promise>; - getSiteSearchEngine( - params?: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, + list( + params?: Params$Resource$Projects$Locations$Datastores$Branches$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$List, + callback: BodyResponseCallback ): void; - getSiteSearchEngine( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - getSiteSearchEngine( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Getsitesearchengine - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Getsitesearchengine; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Getsitesearchengine; + {} as Params$Resource$Projects$Locations$Datastores$Branches$List; options = {}; } @@ -48736,31 +52388,84 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+parent}/branches').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata + extends StandardParameters { /** - * Lists all the DataStores associated with the project. + * Required. The FHIR resources to match by. Format: projects/{project\}/locations/{location\}/datasets/{dataset\}/fhirStores/{fhir_store\}/fhir/{resource_type\}/{fhir_resource_id\} + */ + 'matcher.fhirMatcher.fhirResources'?: string[]; + /** + * The exact URIs to match by. + */ + 'matcher.urisMatcher.uris'?: string[]; + /** + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Get + extends StandardParameters { + /** + * Required. The name of the branch to retrieve. Format: `projects/x/locations/global/dataStores/default_data_store/branches/some_branch_id`. "default_branch" can be used as a special branch_id, it returns the default branch that has been set for the document. + */ + name?: string; + /** + * The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified. + */ + view?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$List + extends StandardParameters { + /** + * Required. The parent data store resource name. + */ + parent?: string; + /** + * The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified. + */ + view?: string; + } + + export class Resource$Projects$Locations$Datastores$Branches$Documents { + context: APIRequestContext; + chunks: Resource$Projects$Locations$Datastores$Branches$Documents$Chunks; + constructor(context: APIRequestContext) { + this.context = context; + this.chunks = + new Resource$Projects$Locations$Datastores$Branches$Documents$Chunks( + this.context + ); + } + + /** + * Creates a Document. * @example * ```js * // Before running the sample: @@ -48792,22 +52497,49 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.dataStores.list({ - * // Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'` - * filter: 'placeholder-value', - * // Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned. - * pageSize: 'placeholder-value', - * // A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned. - * pageToken: 'placeholder-value', - * // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned. - * parent: 'projects/my-project/locations/my-location', - * }); + * const res = + * await discoveryengine.projects.locations.dataStores.branches.documents.create( + * { + * // Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + * documentId: 'placeholder-value', + * // Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + * parent: + * 'projects/my-project/locations/my-location/dataStores/my-dataStore/branches/my-branche', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "aclInfo": {}, + * // "content": {}, + * // "derivedStructData": {}, + * // "id": "my_id", + * // "indexStatus": {}, + * // "indexTime": "my_indexTime", + * // "jsonData": "my_jsonData", + * // "name": "my_name", + * // "parentDocumentId": "my_parentDocumentId", + * // "schemaId": "my_schemaId", + * // "structData": {} + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "dataStores": [], - * // "nextPageToken": "my_nextPageToken" + * // "aclInfo": {}, + * // "content": {}, + * // "derivedStructData": {}, + * // "id": "my_id", + * // "indexStatus": {}, + * // "indexTime": "my_indexTime", + * // "jsonData": "my_jsonData", + * // "name": "my_name", + * // "parentDocumentId": "my_parentDocumentId", + * // "schemaId": "my_schemaId", + * // "structData": {} * // } * } * @@ -48823,61 +52555,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datastores$List, + create( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Datastores$List, + create( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Datastores$List, + create( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$List, + create( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - list( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$List; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datastores$List; + params = + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create; options = {}; } @@ -48891,11 +52624,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/dataStores').replace( + url: (rootUrl + '/v1alpha/{+parent}/documents').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -48906,19 +52639,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a DataStore + * Deletes a Document. * @example * ```js * // Before running the sample: @@ -48950,70 +52683,17 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.dataStores.patch({ - * // Immutable. Identifier. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore', - * // Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "aclEnabled": false, - * // "advancedSiteSearchConfig": {}, - * // "billingEstimation": {}, - * // "cmekConfig": {}, - * // "configurableBillingApproach": "my_configurableBillingApproach", - * // "contentConfig": "my_contentConfig", - * // "createTime": "my_createTime", - * // "defaultSchemaId": "my_defaultSchemaId", - * // "displayName": "my_displayName", - * // "documentProcessingConfig": {}, - * // "healthcareFhirConfig": {}, - * // "identityMappingStore": "my_identityMappingStore", - * // "idpConfig": {}, - * // "industryVertical": "my_industryVertical", - * // "isInfobotFaqDataStore": false, - * // "kmsKeyName": "my_kmsKeyName", - * // "languageInfo": {}, - * // "name": "my_name", - * // "naturalLanguageQueryUnderstandingConfig": {}, - * // "servingConfigDataStore": {}, - * // "solutionTypes": [], - * // "startingSchema": {}, - * // "workspaceConfig": {} - * // } - * }, - * }); + * const res = + * await discoveryengine.projects.locations.dataStores.branches.documents.delete( + * { + * // Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned. + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/branches/my-branche/documents/my-document', + * }, + * ); * console.log(res.data); * * // Example response - * // { - * // "aclEnabled": false, - * // "advancedSiteSearchConfig": {}, - * // "billingEstimation": {}, - * // "cmekConfig": {}, - * // "configurableBillingApproach": "my_configurableBillingApproach", - * // "contentConfig": "my_contentConfig", - * // "createTime": "my_createTime", - * // "defaultSchemaId": "my_defaultSchemaId", - * // "displayName": "my_displayName", - * // "documentProcessingConfig": {}, - * // "healthcareFhirConfig": {}, - * // "identityMappingStore": "my_identityMappingStore", - * // "idpConfig": {}, - * // "industryVertical": "my_industryVertical", - * // "isInfobotFaqDataStore": false, - * // "kmsKeyName": "my_kmsKeyName", - * // "languageInfo": {}, - * // "name": "my_name", - * // "naturalLanguageQueryUnderstandingConfig": {}, - * // "servingConfigDataStore": {}, - * // "solutionTypes": [], - * // "startingSchema": {}, - * // "workspaceConfig": {} - * // } + * // {} * } * * main().catch(e => { @@ -49028,61 +52708,54 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Datastores$Patch, + delete( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Patch, + delete( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - patch( - params: Params$Resource$Projects$Locations$Datastores$Patch, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Patch, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, + callback: BodyResponseCallback ): void; - patch( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datastores$Patch; + params = + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete; options = {}; } @@ -49097,7 +52770,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options @@ -49108,19 +52781,17 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleon resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig. + * Gets a Document. * @example * ```js * // Before running the sample: @@ -49153,33 +52824,25 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.updateDocumentProcessingConfig( - * { - * // The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`. - * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/documentProcessingConfig', - * // Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.ocr_config If not set, all supported fields are updated. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "chunkingConfig": {}, - * // "defaultParsingConfig": {}, - * // "name": "my_name", - * // "parsingConfigOverrides": {} - * // } - * }, - * }, - * ); + * await discoveryengine.projects.locations.dataStores.branches.documents.get({ + * // Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/branches/my-branche/documents/my-document', + * }); * console.log(res.data); * * // Example response * // { - * // "chunkingConfig": {}, - * // "defaultParsingConfig": {}, + * // "aclInfo": {}, + * // "content": {}, + * // "derivedStructData": {}, + * // "id": "my_id", + * // "indexStatus": {}, + * // "indexTime": "my_indexTime", + * // "jsonData": "my_jsonData", * // "name": "my_name", - * // "parsingConfigOverrides": {} + * // "parentDocumentId": "my_parentDocumentId", + * // "schemaId": "my_schemaId", + * // "structData": {} * // } * } * @@ -49195,62 +52858,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - updateDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig, + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, options: StreamMethodOptions ): Promise>; - updateDocumentProcessingConfig( - params?: Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig, + get( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - updateDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig, + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig, + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - updateDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, + callback: BodyResponseCallback ): void; - updateDocumentProcessingConfig( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - updateDocumentProcessingConfig( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get; options = {}; } @@ -49265,7 +52928,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -49276,171 +52939,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Datastores$Completequery - extends StandardParameters { - /** - * Required. The parent data store resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. - */ - dataStore?: string; - /** - * 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. - */ - includeTailSuggestions?: boolean; - /** - * Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. - */ - query?: string; - /** - * Specifies the autocomplete data model. 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. - */ - queryModel?: 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 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. - */ - userPseudoId?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Create - extends StandardParameters { - /** - * Resource name of the CmekConfig to use for protecting this DataStore. - */ - cmekConfigName?: string; - /** - * A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. - */ - createAdvancedSiteSearch?: boolean; - /** - * Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. - */ - dataStoreId?: string; - /** - * DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well. - */ - disableCmek?: boolean; - /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`. - */ - parent?: string; - /** - * A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified. - */ - skipDefaultSchemaCreation?: boolean; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDataStore; - } - export interface Params$Resource$Projects$Locations$Datastores$Delete - extends StandardParameters { - /** - * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Get - extends StandardParameters { - /** - * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig - extends StandardParameters { - /** - * Required. Full DocumentProcessingConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/documentProcessingConfig` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Getsitesearchengine - extends StandardParameters { - /** - * Required. Resource name of SiteSearchEngine, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$List - extends StandardParameters { - /** - * Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'` - */ - filter?: string; - /** - * Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned. - */ - pageSize?: number; - /** - * A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned. - */ - pageToken?: string; - /** - * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Patch - extends StandardParameters { - /** - * Immutable. Identifier. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - */ - name?: string; - /** - * Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDataStore; - } - export interface Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig - extends StandardParameters { - /** - * The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`. - */ - name?: string; - /** - * Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.ocr_config If not set, all supported fields are updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig; - } - - export class Resource$Projects$Locations$Datastores$Branches { - context: APIRequestContext; - documents: Resource$Projects$Locations$Datastores$Branches$Documents; - operations: Resource$Projects$Locations$Datastores$Branches$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.documents = - new Resource$Projects$Locations$Datastores$Branches$Documents( - this.context - ); - this.operations = - new Resource$Projects$Locations$Datastores$Branches$Operations( - this.context - ); - } /** - * Gets index freshness metadata for Documents. Supported for website search only. + * Gets the parsed layout information for a Document. * @example * ```js * // Before running the sample: @@ -49473,22 +52984,24 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.branches.batchGetDocumentsMetadata( + * await discoveryengine.projects.locations.dataStores.branches.documents.getProcessedDocument( * { - * // Required. The FHIR resources to match by. Format: projects/{project\}/locations/{location\}/datasets/{dataset\}/fhirStores/{fhir_store\}/fhir/{resource_type\}/{fhir_resource_id\} - * 'matcher.fhirMatcher.fhirResources': 'placeholder-value', - * // The exact URIs to match by. - * 'matcher.urisMatcher.uris': 'placeholder-value', - * // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. - * parent: - * 'projects/my-project/locations/my-location/dataStores/my-dataStore/branches/my-branche', + * // Optional. Specifies config for IMAGE_BYTES. + * imageId: 'placeholder-value', + * // Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/branches/my-branche/documents/my-document', + * // What format output should be. If unspecified, defaults to JSON. + * processedDocumentFormat: 'placeholder-value', + * // Required. What type of processing to return. + * processedDocumentType: 'placeholder-value', * }, * ); * console.log(res.data); * * // Example response * // { - * // "documentsMetadata": [] + * // "document": "my_document", + * // "jsonData": "my_jsonData" * // } * } * @@ -49504,62 +53017,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchGetDocumentsMetadata( - params: Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata, + getProcessedDocument( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, options: StreamMethodOptions ): Promise>; - batchGetDocumentsMetadata( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata, + getProcessedDocument( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - batchGetDocumentsMetadata( - params: Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata, + getProcessedDocument( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchGetDocumentsMetadata( - params: Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata, + getProcessedDocument( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - batchGetDocumentsMetadata( - params: Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchGetDocumentsMetadata( - callback: BodyResponseCallback + getProcessedDocument( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, + callback: BodyResponseCallback ): void; - batchGetDocumentsMetadata( + getProcessedDocument( + callback: BodyResponseCallback + ): void; + getProcessedDocument( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument; options = {}; } @@ -49573,33 +53086,34 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+parent}/batchGetDocumentsMetadata' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+name}:getProcessedDocument').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Retrieves a Branch. + * Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents to be successfully updated. * @example * ```js * // Before running the sample: @@ -49631,21 +53145,45 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.dataStores.branches.get({ - * // Required. The name of the branch to retrieve. Format: `projects/x/locations/global/dataStores/default_data_store/branches/some_branch_id`. "default_branch" can be used as a special branch_id, it returns the default branch that has been set for the document. - * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/branches/my-branche', - * // The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified. - * view: 'placeholder-value', - * }); + * const res = + * await discoveryengine.projects.locations.dataStores.branches.documents.import( + * { + * // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Requires create/update permission. + * parent: + * 'projects/my-project/locations/my-location/dataStores/my-dataStore/branches/my-branche', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "alloyDbSource": {}, + * // "autoGenerateIds": false, + * // "bigquerySource": {}, + * // "bigtableSource": {}, + * // "cloudSqlSource": {}, + * // "errorConfig": {}, + * // "fhirStoreSource": {}, + * // "firestoreSource": {}, + * // "forceRefreshContent": false, + * // "gcsSource": {}, + * // "idField": "my_idField", + * // "inlineSource": {}, + * // "reconciliationMode": "my_reconciliationMode", + * // "spannerSource": {}, + * // "updateMask": "my_updateMask" + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "branchStats": {}, - * // "displayName": "my_displayName", - * // "isDefault": false, - * // "lastDocumentImportTime": "my_lastDocumentImportTime", - * // "name": "my_name" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -49661,62 +53199,58 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Get, + import( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Get, + import( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Get, + ): Promise>; + import( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Get, + import( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Get, - callback: BodyResponseCallback + import( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + import( + callback: BodyResponseCallback ): void; - get( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Get; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import; options = {}; } @@ -49730,31 +53264,32 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+parent}/documents:import').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists all Branchs under the specified parent DataStore. + * Gets a list of Documents. * @example * ```js * // Before running the sample: @@ -49786,20 +53321,24 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.dataStores.branches.list( - * { - * // Required. The parent data store resource name. - * parent: - * 'projects/my-project/locations/my-location/dataStores/my-dataStore', - * // The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified. - * view: 'placeholder-value', - * }, - * ); + * const res = + * await discoveryengine.projects.locations.dataStores.branches.documents.list( + * { + * // Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + * pageSize: 'placeholder-value', + * // A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + * pageToken: 'placeholder-value', + * // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned. + * parent: + * 'projects/my-project/locations/my-location/dataStores/my-dataStore/branches/my-branche', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "branches": [] + * // "documents": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -49816,61 +53355,61 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Datastores$Branches$List, + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Datastores$Branches$List, + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Datastores$Branches$List, + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$Branches$List, + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$Branches$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$List; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$List; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$List; options = {}; } @@ -49884,7 +53423,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/branches').replace( + url: (rootUrl + '/v1alpha/{+parent}/documents').replace( /([^:]\/)\/+/g, '$1' ), @@ -49899,69 +53438,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata - extends StandardParameters { - /** - * Required. The FHIR resources to match by. Format: projects/{project\}/locations/{location\}/datasets/{dataset\}/fhirStores/{fhir_store\}/fhir/{resource_type\}/{fhir_resource_id\} - */ - 'matcher.fhirMatcher.fhirResources'?: string[]; - /** - * The exact URIs to match by. - */ - 'matcher.urisMatcher.uris'?: string[]; - /** - * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Get - extends StandardParameters { - /** - * Required. The name of the branch to retrieve. Format: `projects/x/locations/global/dataStores/default_data_store/branches/some_branch_id`. "default_branch" can be used as a special branch_id, it returns the default branch that has been set for the document. - */ - name?: string; - /** - * The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified. - */ - view?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Branches$List - extends StandardParameters { - /** - * Required. The parent data store resource name. - */ - parent?: string; - /** - * The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified. - */ - view?: string; - } - - export class Resource$Projects$Locations$Datastores$Branches$Documents { - context: APIRequestContext; - chunks: Resource$Projects$Locations$Datastores$Branches$Documents$Chunks; - constructor(context: APIRequestContext) { - this.context = context; - this.chunks = - new Resource$Projects$Locations$Datastores$Branches$Documents$Chunks( - this.context - ); - } /** - * Creates a Document. + * Updates a Document. * @example * ```js * // Before running the sample: @@ -49994,13 +53483,14 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.branches.documents.create( + * await discoveryengine.projects.locations.dataStores.branches.documents.patch( * { - * // Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. - * documentId: 'placeholder-value', - * // Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. - * parent: - * 'projects/my-project/locations/my-location/dataStores/my-dataStore/branches/my-branche', + * // If set to `true` and the Document is not found, a new Document is be created. + * allowMissing: 'placeholder-value', + * // 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. + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/branches/my-branche/documents/my-document', + * // Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. + * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { @@ -50051,38 +53541,38 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, + patch( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, + patch( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; - create( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, + patch( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, + patch( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, + patch( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, callback: BodyResponseCallback ): void; - create( + patch( callback: BodyResponseCallback ): void; - create( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -50100,13 +53590,13 @@ export namespace discoveryengine_v1alpha { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch; options = {}; } @@ -50120,18 +53610,15 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/documents').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -50147,7 +53634,7 @@ export namespace discoveryengine_v1alpha { } /** - * Deletes a Document. + * Permanently deletes all selected Documents in a branch. This process is asynchronous. Depending on the number of Documents to be deleted, this operation can take hours to complete. Before the delete operation completes, some Documents might still be returned by DocumentService.GetDocument or DocumentService.ListDocuments. To get a list of the Documents to be deleted, set PurgeDocumentsRequest.force to false. * @example * ```js * // Before running the sample: @@ -50180,16 +53667,35 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.branches.documents.delete( + * await discoveryengine.projects.locations.dataStores.branches.documents.purge( * { - * // Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned. - * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/branches/my-branche/documents/my-document', + * // Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + * parent: + * 'projects/my-project/locations/my-location/dataStores/my-dataStore/branches/my-branche', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "errorConfig": {}, + * // "filter": "my_filter", + * // "force": false, + * // "gcsSource": {}, + * // "inlineSource": {} + * // } + * }, * }, * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -50204,86 +53710,209 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, - options: StreamMethodOptions - ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, - options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; + purge( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, + options: StreamMethodOptions + ): Promise>; + purge( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, + options?: MethodOptions + ): Promise>; + purge( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + purge( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + purge( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, + callback: BodyResponseCallback + ): void; + purge( + callback: BodyResponseCallback + ): void; + purge( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/documents:purge').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create + extends StandardParameters { + /** + * Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + documentId?: string; + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocument; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete + extends StandardParameters { + /** + * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get + extends StandardParameters { + /** + * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument + extends StandardParameters { + /** + * Optional. Specifies config for IMAGE_BYTES. + */ + imageId?: string; + /** + * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. + */ + name?: string; + /** + * What format output should be. If unspecified, defaults to JSON. + */ + processedDocumentFormat?: string; + /** + * Required. What type of processing to return. + */ + processedDocumentType?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import + extends StandardParameters { + /** + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Requires create/update permission. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$List + extends StandardParameters { + /** + * Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + */ + pageSize?: number; + /** + * A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + pageToken?: string; + /** + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch + extends StandardParameters { + /** + * If set to `true` and the Document is not found, a new Document is be created. + */ + allowMissing?: boolean; + /** + * 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. + */ + name?: string; + /** + * Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. + */ + updateMask?: string; - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocument; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge + extends StandardParameters { + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + */ + parent?: string; - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest; + } - const rootUrl = - options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } + export class Resource$Projects$Locations$Datastores$Branches$Documents$Chunks { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** @@ -50320,25 +53949,27 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.branches.documents.get({ - * // Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. - * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/branches/my-branche/documents/my-document', - * }); + * await discoveryengine.projects.locations.dataStores.branches.documents.chunks.get( + * { + * // Required. Full resource name of Chunk, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}/chunks/{chunk\}`. If the caller does not have permission to access the Chunk, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Chunk does not exist, a `NOT_FOUND` error is returned. + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/branches/my-branche/documents/my-document/chunks/my-chunk', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "aclInfo": {}, - * // "content": {}, + * // "annotationContents": [], + * // "annotationMetadata": [], + * // "chunkMetadata": {}, + * // "content": "my_content", + * // "dataUrls": [], * // "derivedStructData": {}, + * // "documentMetadata": {}, * // "id": "my_id", - * // "indexStatus": {}, - * // "indexTime": "my_indexTime", - * // "jsonData": "my_jsonData", * // "name": "my_name", - * // "parentDocumentId": "my_parentDocumentId", - * // "schemaId": "my_schemaId", - * // "structData": {} + * // "pageSpan": {}, + * // "relevanceScore": {} * // } * } * @@ -50355,61 +53986,61 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get; options = {}; } @@ -50435,19 +54066,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets the parsed layout information for a Document. + * Gets a list of Chunks. * @example * ```js * // Before running the sample: @@ -50480,24 +54111,23 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.branches.documents.getProcessedDocument( + * await discoveryengine.projects.locations.dataStores.branches.documents.chunks.list( * { - * // Optional. Specifies config for IMAGE_BYTES. - * imageId: 'placeholder-value', - * // Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. - * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/branches/my-branche/documents/my-document', - * // What format output should be. If unspecified, defaults to JSON. - * processedDocumentFormat: 'placeholder-value', - * // Required. What type of processing to return. - * processedDocumentType: 'placeholder-value', + * // Maximum number of Chunks to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + * pageSize: 'placeholder-value', + * // A page token ListChunksResponse.next_page_token, received from a previous ChunkService.ListChunks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ChunkService.ListChunks must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + * pageToken: 'placeholder-value', + * // Required. The parent document resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to list Chunks under this document, regardless of whether or not this document exists, a `PERMISSION_DENIED` error is returned. + * parent: + * 'projects/my-project/locations/my-location/dataStores/my-dataStore/branches/my-branche/documents/my-document', * }, * ); * console.log(res.data); * * // Example response * // { - * // "document": "my_document", - * // "jsonData": "my_jsonData" + * // "chunks": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -50513,62 +54143,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getProcessedDocument( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, options: StreamMethodOptions ): Promise>; - getProcessedDocument( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, + list( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - getProcessedDocument( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getProcessedDocument( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getProcessedDocument( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, + callback: BodyResponseCallback ): void; - getProcessedDocument( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - getProcessedDocument( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List; options = {}; } @@ -50582,7 +54212,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}:getProcessedDocument').replace( + url: (rootUrl + '/v1alpha/{+parent}/chunks').replace( /([^:]\/)\/+/g, '$1' ), @@ -50592,24 +54222,54 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get + extends StandardParameters { /** - * Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents to be successfully updated. + * Required. Full resource name of Chunk, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}/chunks/{chunk\}`. If the caller does not have permission to access the Chunk, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Chunk does not exist, a `NOT_FOUND` error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List + extends StandardParameters { + /** + * Maximum number of Chunks to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + */ + pageSize?: number; + /** + * A page token ListChunksResponse.next_page_token, received from a previous ChunkService.ListChunks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ChunkService.ListChunks must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + pageToken?: string; + /** + * Required. The parent document resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to list Chunks under this document, regardless of whether or not this document exists, a `PERMISSION_DENIED` error is returned. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Datastores$Branches$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -50642,45 +54302,22 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.branches.documents.import( + * await discoveryengine.projects.locations.dataStores.branches.operations.cancel( * { - * // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Requires create/update permission. - * parent: - * 'projects/my-project/locations/my-location/dataStores/my-dataStore/branches/my-branche', + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/branches/my-branche/operations/my-operation', * * // Request body metadata * requestBody: { * // request body parameters - * // { - * // "alloyDbSource": {}, - * // "autoGenerateIds": false, - * // "bigquerySource": {}, - * // "bigtableSource": {}, - * // "cloudSqlSource": {}, - * // "errorConfig": {}, - * // "fhirStoreSource": {}, - * // "firestoreSource": {}, - * // "forceRefreshContent": false, - * // "gcsSource": {}, - * // "idField": "my_idField", - * // "inlineSource": {}, - * // "reconciliationMode": "my_reconciliationMode", - * // "spannerSource": {}, - * // "updateMask": "my_updateMask" - * // } + * // {} * }, * }, * ); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -50695,58 +54332,54 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, + cancel( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, options: StreamMethodOptions ): Promise>; - import( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, + cancel( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, options?: MethodOptions - ): Promise>; - import( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, + callback: BodyResponseCallback ): void; - import( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel; options = {}; } @@ -50760,7 +54393,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/documents:import').replace( + url: (rootUrl + '/v1alpha/{+name}:cancel').replace( /([^:]\/)\/+/g, '$1' ), @@ -50770,22 +54403,22 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a list of Documents. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -50818,23 +54451,21 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.branches.documents.list( + * await discoveryengine.projects.locations.dataStores.branches.operations.get( * { - * // Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. - * pageSize: 'placeholder-value', - * // A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. - * pageToken: 'placeholder-value', - * // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned. - * parent: - * 'projects/my-project/locations/my-location/dataStores/my-dataStore/branches/my-branche', + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/branches/my-branche/operations/my-operation', * }, * ); * console.log(res.data); * * // Example response * // { - * // "documents": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -50850,62 +54481,58 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, + get( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$List; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$List; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get; options = {}; } @@ -50919,34 +54546,29 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/documents').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a Document. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -50969,59 +54591,37 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.readwrite', - * ], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await discoveryengine.projects.locations.dataStores.branches.documents.patch( - * { - * // If set to `true` and the Document is not found, a new Document is be created. - * allowMissing: 'placeholder-value', - * // 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. - * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/branches/my-branche/documents/my-document', - * // Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "aclInfo": {}, - * // "content": {}, - * // "derivedStructData": {}, - * // "id": "my_id", - * // "indexStatus": {}, - * // "indexTime": "my_indexTime", - * // "jsonData": "my_jsonData", - * // "name": "my_name", - * // "parentDocumentId": "my_parentDocumentId", - * // "schemaId": "my_schemaId", - * // "structData": {} - * // } - * }, + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await discoveryengine.projects.locations.dataStores.branches.operations.list( + * { + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/branches/my-branche', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); * * // Example response * // { - * // "aclInfo": {}, - * // "content": {}, - * // "derivedStructData": {}, - * // "id": "my_id", - * // "indexStatus": {}, - * // "indexTime": "my_indexTime", - * // "jsonData": "my_jsonData", - * // "name": "my_name", - * // "parentDocumentId": "my_parentDocumentId", - * // "schemaId": "my_schemaId", - * // "structData": {} + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -51037,62 +54637,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, + list( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - patch( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - patch( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Operations$List; options = {}; } @@ -51106,8 +54706,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1alpha/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -51118,19 +54721,69 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel + extends StandardParameters { /** - * Permanently deletes all selected Documents in a branch. This process is asynchronous. Depending on the number of Documents to be deleted, this operation can take hours to complete. Before the delete operation completes, some Documents might still be returned by DocumentService.GetDocument or DocumentService.ListDocuments. To get a list of the Documents to be deleted, set PurgeDocumentsRequest.force to false. + * The name of the operation resource to be cancelled. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleLongrunningCancelOperationRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + + export class Resource$Projects$Locations$Datastores$Completionconfig { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Completes the user input with advanced keyword suggestions. * @example * ```js * // Before running the sample: @@ -51153,6 +54806,8 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud_search.query', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -51163,21 +54818,25 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.branches.documents.purge( + * await discoveryengine.projects.locations.dataStores.completionConfig.completeQuery( * { - * // Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. - * parent: - * 'projects/my-project/locations/my-location/dataStores/my-dataStore/branches/my-branche', + * // Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/x/completionConfig` `projects/x/locations/global/collections/default_collection/engines/x/completionConfig`. + * completionConfig: + * 'projects/my-project/locations/my-location/dataStores/my-dataStore/completionConfig', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "errorConfig": {}, - * // "filter": "my_filter", - * // "force": false, - * // "gcsSource": {}, - * // "inlineSource": {} + * // "boostSpec": {}, + * // "experimentIds": [], + * // "includeTailSuggestions": false, + * // "query": "my_query", + * // "queryModel": "my_queryModel", + * // "suggestionTypeSpecs": [], + * // "suggestionTypes": [], + * // "userInfo": {}, + * // "userPseudoId": "my_userPseudoId" * // } * }, * }, @@ -51186,11 +54845,11 @@ export namespace discoveryengine_v1alpha { * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "contentSuggestions": [], + * // "peopleSuggestions": [], + * // "querySuggestions": [], + * // "recentSearchSuggestions": [], + * // "tailMatchTriggered": false * // } * } * @@ -51206,58 +54865,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, + completeQuery( + params: Params$Resource$Projects$Locations$Datastores$Completionconfig$Completequery, options: StreamMethodOptions ): Promise>; - purge( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, + completeQuery( + params?: Params$Resource$Projects$Locations$Datastores$Completionconfig$Completequery, options?: MethodOptions - ): Promise>; - purge( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, + ): Promise< + GaxiosResponseWithHTTP2 + >; + completeQuery( + params: Params$Resource$Projects$Locations$Datastores$Completionconfig$Completequery, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, + completeQuery( + params: Params$Resource$Projects$Locations$Datastores$Completionconfig$Completequery, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, - callback: BodyResponseCallback + completeQuery( + params: Params$Resource$Projects$Locations$Datastores$Completionconfig$Completequery, + callback: BodyResponseCallback ): void; - purge( - callback: BodyResponseCallback + completeQuery( + callback: BodyResponseCallback ): void; - purge( + completeQuery( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Completionconfig$Completequery + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge; + {}) as Params$Resource$Projects$Locations$Datastores$Completionconfig$Completequery; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge; + {} as Params$Resource$Projects$Locations$Datastores$Completionconfig$Completequery; options = {}; } @@ -51271,148 +54934,53 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/documents:purge').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1alpha/{+completionConfig}:completeQuery' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['completionConfig'], + pathParams: ['completionConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create - extends StandardParameters { - /** - * Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. - */ - documentId?: string; - /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocument; - } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete - extends StandardParameters { - /** - * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get - extends StandardParameters { - /** - * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument - extends StandardParameters { - /** - * Optional. Specifies config for IMAGE_BYTES. - */ - imageId?: string; - /** - * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. - */ - name?: string; - /** - * What format output should be. If unspecified, defaults to JSON. - */ - processedDocumentFormat?: string; - /** - * Required. What type of processing to return. - */ - processedDocumentType?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import - extends StandardParameters { - /** - * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Requires create/update permission. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$List - extends StandardParameters { - /** - * Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. - */ - pageSize?: number; - /** - * A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. - */ - pageToken?: string; - /** - * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch - extends StandardParameters { - /** - * If set to `true` and the Document is not found, a new Document is be created. - */ - allowMissing?: boolean; - /** - * 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. - */ - name?: string; - /** - * Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocument; - } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge + export interface Params$Resource$Projects$Locations$Datastores$Completionconfig$Completequery extends StandardParameters { /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + * Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/x/completionConfig` `projects/x/locations/global/collections/default_collection/engines/x/completionConfig`. */ - parent?: string; + completionConfig?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest; } - export class Resource$Projects$Locations$Datastores$Branches$Documents$Chunks { + export class Resource$Projects$Locations$Datastores$Completionsuggestions { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Gets a Document. + * Imports CompletionSuggestions for a DataStore. * @example * ```js * // Before running the sample: @@ -51435,6 +55003,7 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -51445,27 +55014,33 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.branches.documents.chunks.get( + * await discoveryengine.projects.locations.dataStores.completionSuggestions.import( * { - * // Required. Full resource name of Chunk, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}/chunks/{chunk\}`. If the caller does not have permission to access the Chunk, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Chunk does not exist, a `NOT_FOUND` error is returned. - * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/branches/my-branche/documents/my-document/chunks/my-chunk', + * // Required. The parent data store resource name for which to import customer autocomplete suggestions. Follows pattern `projects/x/locations/x/collections/x/dataStores/x` + * parent: + * 'projects/my-project/locations/my-location/dataStores/my-dataStore', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bigquerySource": {}, + * // "errorConfig": {}, + * // "gcsSource": {}, + * // "inlineSource": {} + * // } + * }, * }, * ); * console.log(res.data); * * // Example response * // { - * // "annotationContents": [], - * // "annotationMetadata": [], - * // "chunkMetadata": {}, - * // "content": "my_content", - * // "dataUrls": [], - * // "derivedStructData": {}, - * // "documentMetadata": {}, - * // "id": "my_id", + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "pageSpan": {}, - * // "relevanceScore": {} + * // "response": {} * // } * } * @@ -51481,62 +55056,58 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, + import( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, + import( + params?: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, + ): Promise>; + import( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, + import( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, - callback: BodyResponseCallback + import( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + import( + callback: BodyResponseCallback ): void; - get( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get; + {} as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import; options = {}; } @@ -51550,31 +55121,31 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: ( + rootUrl + '/v1alpha/{+parent}/completionSuggestions:import' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets a list of Chunks. + * Permanently deletes all CompletionSuggestions for a DataStore. * @example * ```js * // Before running the sample: @@ -51597,6 +55168,7 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -51607,23 +55179,28 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.branches.documents.chunks.list( + * await discoveryengine.projects.locations.dataStores.completionSuggestions.purge( * { - * // Maximum number of Chunks to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. - * pageSize: 'placeholder-value', - * // A page token ListChunksResponse.next_page_token, received from a previous ChunkService.ListChunks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ChunkService.ListChunks must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. - * pageToken: 'placeholder-value', - * // Required. The parent document resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to list Chunks under this document, regardless of whether or not this document exists, a `PERMISSION_DENIED` error is returned. + * // Required. The parent data store resource name for which to purge completion suggestions. Follows pattern projects/x/locations/x/collections/x/dataStores/x. * parent: - * 'projects/my-project/locations/my-location/dataStores/my-dataStore/branches/my-branche/documents/my-document', + * 'projects/my-project/locations/my-location/dataStores/my-dataStore', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, * }, * ); * console.log(res.data); * * // Example response * // { - * // "chunks": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -51639,62 +55216,58 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, + purge( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, + purge( + params?: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, + ): Promise>; + purge( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, + purge( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, - callback: BodyResponseCallback + purge( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + purge( + callback: BodyResponseCallback ): void; - list( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List; + {}) as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List; + {} as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge; options = {}; } @@ -51708,11 +55281,10 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/chunks').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: ( + rootUrl + '/v1alpha/{+parent}/completionSuggestions:purge' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -51723,49 +55295,49 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get + export interface Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import extends StandardParameters { /** - * Required. Full resource name of Chunk, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}/chunks/{chunk\}`. If the caller does not have permission to access the Chunk, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Chunk does not exist, a `NOT_FOUND` error is returned. + * Required. The parent data store resource name for which to import customer autocomplete suggestions. Follows pattern `projects/x/locations/x/collections/x/dataStores/x` */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List - extends StandardParameters { + parent?: string; + /** - * Maximum number of Chunks to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + * Request body metadata */ - pageSize?: number; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge + extends StandardParameters { /** - * A page token ListChunksResponse.next_page_token, received from a previous ChunkService.ListChunks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ChunkService.ListChunks must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + * Required. The parent data store resource name for which to purge completion suggestions. Follows pattern projects/x/locations/x/collections/x/dataStores/x. */ - pageToken?: string; + parent?: string; + /** - * Required. The parent document resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to list Chunks under this document, regardless of whether or not this document exists, a `PERMISSION_DENIED` error is returned. + * Request body metadata */ - parent?: string; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsRequest; } - export class Resource$Projects$Locations$Datastores$Branches$Operations { + export class Resource$Projects$Locations$Datastores$Controls { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned. * @example * ```js * // Before running the sample: @@ -51798,22 +55370,47 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.branches.operations.cancel( - * { - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/branches/my-branche/operations/my-operation', + * await discoveryengine.projects.locations.dataStores.controls.create({ + * // Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. + * controlId: 'placeholder-value', + * // Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. + * parent: + * 'projects/my-project/locations/my-location/dataStores/my-dataStore', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "associatedServingConfigIds": [], + * // "boostAction": {}, + * // "conditions": [], + * // "displayName": "my_displayName", + * // "filterAction": {}, + * // "name": "my_name", + * // "promoteAction": {}, + * // "redirectAction": {}, + * // "solutionType": "my_solutionType", + * // "synonymsAction": {}, + * // "useCases": [] + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "associatedServingConfigIds": [], + * // "boostAction": {}, + * // "conditions": [], + * // "displayName": "my_displayName", + * // "filterAction": {}, + * // "name": "my_name", + * // "promoteAction": {}, + * // "redirectAction": {}, + * // "solutionType": "my_solutionType", + * // "synonymsAction": {}, + * // "useCases": [] + * // } * } * * main().catch(e => { @@ -51828,54 +55425,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, + create( + params: Params$Resource$Projects$Locations$Datastores$Controls$Create, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, + create( + params?: Params$Resource$Projects$Locations$Datastores$Controls$Create, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Datastores$Controls$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Datastores$Controls$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Datastores$Controls$Create, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Controls$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Datastores$Controls$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Datastores$Controls$Create; options = {}; } @@ -51889,7 +55494,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}:cancel').replace( + url: (rootUrl + '/v1alpha/{+parent}/controls').replace( /([^:]\/)\/+/g, '$1' ), @@ -51899,22 +55504,24 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. * @example * ```js * // Before running the sample: @@ -51947,22 +55554,14 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.branches.operations.get( - * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/branches/my-branche/operations/my-operation', - * }, - * ); + * await discoveryengine.projects.locations.dataStores.controls.delete({ + * // Required. The resource name of the Control to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/controls/my-control', + * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -51977,58 +55576,54 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, + delete( + params?: Params$Resource$Projects$Locations$Datastores$Controls$Delete, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, + callback: BodyResponseCallback ): void; - get( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Controls$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Controls$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get; + {} as Params$Resource$Projects$Locations$Datastores$Controls$Delete; options = {}; } @@ -52043,7 +55638,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -52054,17 +55649,17 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Gets a Control. * @example * ```js * // Before running the sample: @@ -52096,28 +55691,25 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await discoveryengine.projects.locations.dataStores.branches.operations.list( - * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/branches/my-branche', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }, - * ); + * const res = await discoveryengine.projects.locations.dataStores.controls.get({ + * // Required. The resource name of the Control to get. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/controls/my-control', + * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "associatedServingConfigIds": [], + * // "boostAction": {}, + * // "conditions": [], + * // "displayName": "my_displayName", + * // "filterAction": {}, + * // "name": "my_name", + * // "promoteAction": {}, + * // "redirectAction": {}, + * // "solutionType": "my_solutionType", + * // "synonymsAction": {}, + * // "useCases": [] * // } * } * @@ -52133,62 +55725,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, + get( + params: Params$Resource$Projects$Locations$Datastores$Controls$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, + get( + params?: Params$Resource$Projects$Locations$Datastores$Controls$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, + get( + params: Params$Resource$Projects$Locations$Datastores$Controls$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, + get( + params: Params$Resource$Projects$Locations$Datastores$Controls$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Controls$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Controls$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Operations$List; + {}) as Params$Resource$Projects$Locations$Datastores$Controls$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Operations$List; + {} as Params$Resource$Projects$Locations$Datastores$Controls$Get; options = {}; } @@ -52202,10 +55794,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -52217,69 +55806,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel - extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleLongrunningCancelOperationRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - - export class Resource$Projects$Locations$Datastores$Completionconfig { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Completes the user input with advanced keyword suggestions. + * Lists all Controls by their parent DataStore. * @example * ```js * // Before running the sample: @@ -52302,8 +55841,6 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/cloud_search.query', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -52313,39 +55850,25 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await discoveryengine.projects.locations.dataStores.completionConfig.completeQuery( - * { - * // Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/x/completionConfig` `projects/x/locations/global/collections/default_collection/engines/x/completionConfig`. - * completionConfig: - * 'projects/my-project/locations/my-location/dataStores/my-dataStore/completionConfig', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "boostSpec": {}, - * // "experimentIds": [], - * // "includeTailSuggestions": false, - * // "query": "my_query", - * // "queryModel": "my_queryModel", - * // "suggestionTypeSpecs": [], - * // "suggestionTypes": [], - * // "userInfo": {}, - * // "userPseudoId": "my_userPseudoId" - * // } - * }, - * }, - * ); + * const res = await discoveryengine.projects.locations.dataStores.controls.list( + * { + * // Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. + * filter: 'placeholder-value', + * // Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + * pageSize: 'placeholder-value', + * // Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. + * pageToken: 'placeholder-value', + * // Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. + * parent: + * 'projects/my-project/locations/my-location/dataStores/my-dataStore', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "contentSuggestions": [], - * // "peopleSuggestions": [], - * // "querySuggestions": [], - * // "recentSearchSuggestions": [], - * // "tailMatchTriggered": false + * // "controls": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -52361,62 +55884,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - completeQuery( - params: Params$Resource$Projects$Locations$Datastores$Completionconfig$Completequery, + list( + params: Params$Resource$Projects$Locations$Datastores$Controls$List, options: StreamMethodOptions ): Promise>; - completeQuery( - params?: Params$Resource$Projects$Locations$Datastores$Completionconfig$Completequery, + list( + params?: Params$Resource$Projects$Locations$Datastores$Controls$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - completeQuery( - params: Params$Resource$Projects$Locations$Datastores$Completionconfig$Completequery, + list( + params: Params$Resource$Projects$Locations$Datastores$Controls$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - completeQuery( - params: Params$Resource$Projects$Locations$Datastores$Completionconfig$Completequery, + list( + params: Params$Resource$Projects$Locations$Datastores$Controls$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - completeQuery( - params: Params$Resource$Projects$Locations$Datastores$Completionconfig$Completequery, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datastores$Controls$List, + callback: BodyResponseCallback ): void; - completeQuery( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - completeQuery( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Completionconfig$Completequery - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Controls$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Completionconfig$Completequery; + {}) as Params$Resource$Projects$Locations$Datastores$Controls$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Completionconfig$Completequery; + {} as Params$Resource$Projects$Locations$Datastores$Controls$List; options = {}; } @@ -52430,53 +55953,34 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+completionConfig}:completeQuery' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1alpha/{+parent}/controls').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['completionConfig'], - pathParams: ['completionConfig'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Datastores$Completionconfig$Completequery - extends StandardParameters { - /** - * Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/x/completionConfig` `projects/x/locations/global/collections/default_collection/engines/x/completionConfig`. - */ - completionConfig?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest; - } - - export class Resource$Projects$Locations$Datastores$Completionsuggestions { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Imports CompletionSuggestions for a DataStore. + * Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. * @example * ```js * // Before running the sample: @@ -52499,7 +56003,6 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -52510,33 +56013,45 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.completionSuggestions.import( - * { - * // Required. The parent data store resource name for which to import customer autocomplete suggestions. Follows pattern `projects/x/locations/x/collections/x/dataStores/x` - * parent: - * 'projects/my-project/locations/my-location/dataStores/my-dataStore', + * await discoveryengine.projects.locations.dataStores.controls.patch({ + * // Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/controls/my-control', + * // Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. + * updateMask: 'placeholder-value', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "bigquerySource": {}, - * // "errorConfig": {}, - * // "gcsSource": {}, - * // "inlineSource": {} - * // } - * }, + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "associatedServingConfigIds": [], + * // "boostAction": {}, + * // "conditions": [], + * // "displayName": "my_displayName", + * // "filterAction": {}, + * // "name": "my_name", + * // "promoteAction": {}, + * // "redirectAction": {}, + * // "solutionType": "my_solutionType", + * // "synonymsAction": {}, + * // "useCases": [] + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "associatedServingConfigIds": [], + * // "boostAction": {}, + * // "conditions": [], + * // "displayName": "my_displayName", + * // "filterAction": {}, * // "name": "my_name", - * // "response": {} + * // "promoteAction": {}, + * // "redirectAction": {}, + * // "solutionType": "my_solutionType", + * // "synonymsAction": {}, + * // "useCases": [] * // } * } * @@ -52552,58 +56067,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, + patch( + params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, options: StreamMethodOptions ): Promise>; - import( - params?: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, + patch( + params?: Params$Resource$Projects$Locations$Datastores$Controls$Patch, options?: MethodOptions - ): Promise>; - import( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, + ): Promise< + GaxiosResponseWithHTTP2 + >; + patch( + params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, + patch( + params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - import( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Controls$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import; + {}) as Params$Resource$Projects$Locations$Datastores$Controls$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import; + {} as Params$Resource$Projects$Locations$Datastores$Controls$Patch; options = {}; } @@ -52617,31 +56136,104 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+parent}/completionSuggestions:import' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Datastores$Controls$Create + extends StandardParameters { /** - * Permanently deletes all CompletionSuggestions for a DataStore. + * Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. + */ + controlId?: string; + /** + * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaControl; + } + export interface Params$Resource$Projects$Locations$Datastores$Controls$Delete + extends StandardParameters { + /** + * Required. The resource name of the Control to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Controls$Get + extends StandardParameters { + /** + * Required. The resource name of the Control to get. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Controls$List + extends StandardParameters { + /** + * Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. + */ + filter?: string; + /** + * Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Controls$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` + */ + name?: string; + /** + * Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaControl; + } + + export class Resource$Projects$Locations$Datastores$Conversations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Converses a conversation. * @example * ```js * // Before running the sample: @@ -52664,7 +56256,6 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -52675,28 +56266,33 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.completionSuggestions.purge( - * { - * // Required. The parent data store resource name for which to purge completion suggestions. Follows pattern projects/x/locations/x/collections/x/dataStores/x. - * parent: - * 'projects/my-project/locations/my-location/dataStores/my-dataStore', + * await discoveryengine.projects.locations.dataStores.conversations.converse({ + * // Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/conversations/my-conversation', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "boostSpec": {}, + * // "conversation": {}, + * // "filter": "my_filter", + * // "query": {}, + * // "safeSearch": false, + * // "servingConfig": "my_servingConfig", + * // "summarySpec": {}, + * // "userLabels": {} + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "conversation": {}, + * // "relatedQuestions": [], + * // "reply": {}, + * // "searchResults": [] * // } * } * @@ -52712,58 +56308,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, + converse( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, options: StreamMethodOptions ): Promise>; - purge( - params?: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, + converse( + params?: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, options?: MethodOptions - ): Promise>; - purge( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, + ): Promise< + GaxiosResponseWithHTTP2 + >; + converse( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, + converse( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, - callback: BodyResponseCallback + converse( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, + callback: BodyResponseCallback ): void; - purge( - callback: BodyResponseCallback + converse( + callback: BodyResponseCallback ): void; - purge( + converse( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Conversations$Converse + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge; + {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Converse; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge; + {} as Params$Resource$Projects$Locations$Datastores$Conversations$Converse; options = {}; } @@ -52777,63 +56377,34 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+parent}/completionSuggestions:purge' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+name}:converse').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import - extends StandardParameters { - /** - * Required. The parent data store resource name for which to import customer autocomplete suggestions. Follows pattern `projects/x/locations/x/collections/x/dataStores/x` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge - extends StandardParameters { - /** - * Required. The parent data store resource name for which to purge completion suggestions. Follows pattern projects/x/locations/x/collections/x/dataStores/x. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsRequest; - } - - export class Resource$Projects$Locations$Datastores$Controls { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned. + * Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. * @example * ```js * // Before running the sample: @@ -52866,10 +56437,8 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.controls.create({ - * // Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. - * controlId: 'placeholder-value', - * // Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. + * await discoveryengine.projects.locations.dataStores.conversations.create({ + * // Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` * parent: * 'projects/my-project/locations/my-location/dataStores/my-dataStore', * @@ -52877,17 +56446,12 @@ export namespace discoveryengine_v1alpha { * requestBody: { * // request body parameters * // { - * // "associatedServingConfigIds": [], - * // "boostAction": {}, - * // "conditions": [], - * // "displayName": "my_displayName", - * // "filterAction": {}, + * // "endTime": "my_endTime", + * // "messages": [], * // "name": "my_name", - * // "promoteAction": {}, - * // "redirectAction": {}, - * // "solutionType": "my_solutionType", - * // "synonymsAction": {}, - * // "useCases": [] + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "userPseudoId": "my_userPseudoId" * // } * }, * }); @@ -52895,17 +56459,12 @@ export namespace discoveryengine_v1alpha { * * // Example response * // { - * // "associatedServingConfigIds": [], - * // "boostAction": {}, - * // "conditions": [], - * // "displayName": "my_displayName", - * // "filterAction": {}, + * // "endTime": "my_endTime", + * // "messages": [], * // "name": "my_name", - * // "promoteAction": {}, - * // "redirectAction": {}, - * // "solutionType": "my_solutionType", - * // "synonymsAction": {}, - * // "useCases": [] + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "userPseudoId": "my_userPseudoId" * // } * } * @@ -52922,61 +56481,61 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Datastores$Controls$Create, + params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, options: StreamMethodOptions ): Promise>; create( - params?: Params$Resource$Projects$Locations$Datastores$Controls$Create, + params?: Params$Resource$Projects$Locations$Datastores$Conversations$Create, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; create( - params: Params$Resource$Projects$Locations$Datastores$Controls$Create, + params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Datastores$Controls$Create, + params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Datastores$Controls$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Controls$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Conversations$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Controls$Create; + {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Controls$Create; + {} as Params$Resource$Projects$Locations$Datastores$Conversations$Create; options = {}; } @@ -52990,7 +56549,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/controls').replace( + url: (rootUrl + '/v1alpha/{+parent}/conversations').replace( /([^:]\/)\/+/g, '$1' ), @@ -53005,19 +56564,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. + * Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. * @example * ```js * // Before running the sample: @@ -53050,9 +56609,9 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.controls.delete({ - * // Required. The resource name of the Control to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` - * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/controls/my-control', + * await discoveryengine.projects.locations.dataStores.conversations.delete({ + * // Required. The resource name of the Conversation to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/conversations/my-conversation', * }); * console.log(res.data); * @@ -53073,31 +56632,31 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, + params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Datastores$Controls$Delete, + params?: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, + params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, + params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, + params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Controls$Delete + | Params$Resource$Projects$Locations$Datastores$Conversations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -53113,13 +56672,13 @@ export namespace discoveryengine_v1alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Controls$Delete; + {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Controls$Delete; + {} as Params$Resource$Projects$Locations$Datastores$Conversations$Delete; options = {}; } @@ -53155,7 +56714,7 @@ export namespace discoveryengine_v1alpha { } /** - * Gets a Control. + * Gets a Conversation. * @example * ```js * // Before running the sample: @@ -53187,25 +56746,21 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.dataStores.controls.get({ - * // Required. The resource name of the Control to get. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` - * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/controls/my-control', - * }); + * const res = + * await discoveryengine.projects.locations.dataStores.conversations.get({ + * // Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/conversations/my-conversation', + * }); * console.log(res.data); * * // Example response * // { - * // "associatedServingConfigIds": [], - * // "boostAction": {}, - * // "conditions": [], - * // "displayName": "my_displayName", - * // "filterAction": {}, + * // "endTime": "my_endTime", + * // "messages": [], * // "name": "my_name", - * // "promoteAction": {}, - * // "redirectAction": {}, - * // "solutionType": "my_solutionType", - * // "synonymsAction": {}, - * // "useCases": [] + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "userPseudoId": "my_userPseudoId" * // } * } * @@ -53222,61 +56777,61 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datastores$Controls$Get, + params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Datastores$Controls$Get, + params?: Params$Resource$Projects$Locations$Datastores$Conversations$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; get( - params: Params$Resource$Projects$Locations$Datastores$Controls$Get, + params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Controls$Get, + params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Controls$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Controls$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Conversations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Controls$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Controls$Get; + {} as Params$Resource$Projects$Locations$Datastores$Conversations$Get; options = {}; } @@ -53302,19 +56857,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists all Controls by their parent DataStore. + * Lists all Conversations by their parent DataStore. * @example * ```js * // Before running the sample: @@ -53346,24 +56901,25 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.dataStores.controls.list( - * { - * // Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. + * const res = + * await discoveryengine.projects.locations.dataStores.conversations.list({ + * // A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" * filter: 'placeholder-value', - * // Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: "update_time desc" "create_time" + * orderBy: 'placeholder-value', + * // Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. * pageSize: 'placeholder-value', - * // Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. + * // A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. * pageToken: 'placeholder-value', - * // Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. + * // Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` * parent: * 'projects/my-project/locations/my-location/dataStores/my-dataStore', - * }, - * ); + * }); * console.log(res.data); * * // Example response * // { - * // "controls": [], + * // "conversations": [], * // "nextPageToken": "my_nextPageToken" * // } * } @@ -53381,61 +56937,61 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Datastores$Controls$List, + params: Params$Resource$Projects$Locations$Datastores$Conversations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Datastores$Controls$List, + params?: Params$Resource$Projects$Locations$Datastores$Conversations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Datastores$Controls$List, + params: Params$Resource$Projects$Locations$Datastores$Conversations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$Controls$List, + params: Params$Resource$Projects$Locations$Datastores$Conversations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$Controls$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Conversations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Controls$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Conversations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Controls$List; + {}) as Params$Resource$Projects$Locations$Datastores$Conversations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Controls$List; + {} as Params$Resource$Projects$Locations$Datastores$Conversations$List; options = {}; } @@ -53449,7 +57005,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/controls').replace( + url: (rootUrl + '/v1alpha/{+parent}/conversations').replace( /([^:]\/)\/+/g, '$1' ), @@ -53464,19 +57020,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. + * Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned. * @example * ```js * // Before running the sample: @@ -53509,27 +57065,22 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.controls.patch({ - * // Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` - * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/controls/my-control', - * // Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. + * await discoveryengine.projects.locations.dataStores.conversations.patch({ + * // Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`. + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/conversations/my-conversation', + * // Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "associatedServingConfigIds": [], - * // "boostAction": {}, - * // "conditions": [], - * // "displayName": "my_displayName", - * // "filterAction": {}, + * // "endTime": "my_endTime", + * // "messages": [], * // "name": "my_name", - * // "promoteAction": {}, - * // "redirectAction": {}, - * // "solutionType": "my_solutionType", - * // "synonymsAction": {}, - * // "useCases": [] + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "userPseudoId": "my_userPseudoId" * // } * }, * }); @@ -53537,17 +57088,12 @@ export namespace discoveryengine_v1alpha { * * // Example response * // { - * // "associatedServingConfigIds": [], - * // "boostAction": {}, - * // "conditions": [], - * // "displayName": "my_displayName", - * // "filterAction": {}, + * // "endTime": "my_endTime", + * // "messages": [], * // "name": "my_name", - * // "promoteAction": {}, - * // "redirectAction": {}, - * // "solutionType": "my_solutionType", - * // "synonymsAction": {}, - * // "useCases": [] + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "userPseudoId": "my_userPseudoId" * // } * } * @@ -53564,61 +57110,61 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, + params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, options: StreamMethodOptions ): Promise>; patch( - params?: Params$Resource$Projects$Locations$Datastores$Controls$Patch, + params?: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; patch( - params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, + params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, + params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, + callback: BodyResponseCallback ): void; patch( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Controls$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Conversations$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Controls$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Controls$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Conversations$Patch; options = {}; } @@ -53644,92 +57190,116 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Datastores$Controls$Create + export interface Params$Resource$Projects$Locations$Datastores$Conversations$Converse extends StandardParameters { /** - * Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. + * Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. */ - controlId?: string; + name?: string; + /** - * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConverseConversationRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Conversations$Create + extends StandardParameters { + /** + * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaControl; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation; } - export interface Params$Resource$Projects$Locations$Datastores$Controls$Delete + export interface Params$Resource$Projects$Locations$Datastores$Conversations$Delete extends StandardParameters { /** - * Required. The resource name of the Control to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + * Required. The resource name of the Conversation to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Datastores$Controls$Get + export interface Params$Resource$Projects$Locations$Datastores$Conversations$Get extends StandardParameters { /** - * Required. The resource name of the Control to get. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + * Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Datastores$Controls$List + export interface Params$Resource$Projects$Locations$Datastores$Conversations$List extends StandardParameters { /** - * Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. + * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" */ filter?: string; /** - * Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: "update_time desc" "create_time" + */ + orderBy?: string; + /** + * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */ pageSize?: number; /** - * Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. + * A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. */ pageToken?: string; /** - * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. + * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; } - export interface Params$Resource$Projects$Locations$Datastores$Controls$Patch + export interface Params$Resource$Projects$Locations$Datastores$Conversations$Patch extends StandardParameters { /** - * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`. */ name?: string; /** - * Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. + * Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaControl; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation; } - export class Resource$Projects$Locations$Datastores$Conversations { + export class Resource$Projects$Locations$Datastores$Models { + context: APIRequestContext; + operations: Resource$Projects$Locations$Datastores$Models$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Datastores$Models$Operations( + this.context + ); + } + } + + export class Resource$Projects$Locations$Datastores$Models$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Converses a conversation. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -53762,33 +57332,19 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.conversations.converse({ - * // Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. - * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/conversations/my-conversation', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "boostSpec": {}, - * // "conversation": {}, - * // "filter": "my_filter", - * // "query": {}, - * // "safeSearch": false, - * // "servingConfig": "my_servingConfig", - * // "summarySpec": {}, - * // "userLabels": {} - * // } - * }, + * await discoveryengine.projects.locations.dataStores.models.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/models/my-model/operations/my-operation', * }); * console.log(res.data); * * // Example response * // { - * // "conversation": {}, - * // "relatedQuestions": [], - * // "reply": {}, - * // "searchResults": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -53804,62 +57360,58 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - converse( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, + get( + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, options: StreamMethodOptions ): Promise>; - converse( - params?: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, + get( + params?: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - converse( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - converse( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, + get( + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - converse( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, + callback: BodyResponseCallback ): void; - converse( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - converse( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Conversations$Converse - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Models$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Converse; + {}) as Params$Resource$Projects$Locations$Datastores$Models$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Conversations$Converse; + {} as Params$Resource$Projects$Locations$Datastores$Models$Operations$Get; options = {}; } @@ -53873,11 +57425,8 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}:converse').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -53888,19 +57437,17 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -53933,34 +57480,25 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.conversations.create({ - * // Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` - * parent: - * 'projects/my-project/locations/my-location/dataStores/my-dataStore', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "endTime": "my_endTime", - * // "messages": [], - * // "name": "my_name", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "userPseudoId": "my_userPseudoId" - * // } - * }, + * await discoveryengine.projects.locations.dataStores.models.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/models/my-model', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "endTime": "my_endTime", - * // "messages": [], - * // "name": "my_name", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "userPseudoId": "my_userPseudoId" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -53976,205 +57514,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, - options: StreamMethodOptions - ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Datastores$Conversations$Create, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - create( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, - callback: BodyResponseCallback - ): void; - create( - callback: BodyResponseCallback - ): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Conversations$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Conversations$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+parent}/conversations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const discoveryengine = google.discoveryengine('v1alpha'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.readwrite', - * ], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await discoveryengine.projects.locations.dataStores.conversations.delete({ - * // Required. The resource name of the Conversation to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` - * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/conversations/my-conversation', - * }); - * console.log(res.data); - * - * // Example response - * // {} - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - delete( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, + list( + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, + list( + params?: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Conversations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Models$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Delete; + {}) as Params$Resource$Projects$Locations$Datastores$Models$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Conversations$Delete; + {} as Params$Resource$Projects$Locations$Datastores$Models$Operations$List; options = {}; } @@ -54188,8 +57583,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1alpha/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -54200,17 +57598,57 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Datastores$Models$Operations$Get + extends StandardParameters { /** - * Gets a Conversation. + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Models$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + + export class Resource$Projects$Locations$Datastores$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -54243,20 +57681,19 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.conversations.get({ - * // Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` - * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/conversations/my-conversation', + * await discoveryengine.projects.locations.dataStores.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/operations/my-operation', * }); * console.log(res.data); * * // Example response * // { - * // "endTime": "my_endTime", - * // "messages": [], + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "userPseudoId": "my_userPseudoId" + * // "response": {} * // } * } * @@ -54273,61 +57710,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, + params: Params$Resource$Projects$Locations$Datastores$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Datastores$Conversations$Get, + params?: Params$Resource$Projects$Locations$Datastores$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; + ): Promise>; get( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, + params: Params$Resource$Projects$Locations$Datastores$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, + params: Params$Resource$Projects$Locations$Datastores$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Operations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Conversations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Conversations$Get; + {} as Params$Resource$Projects$Locations$Datastores$Operations$Get; options = {}; } @@ -54353,19 +57786,17 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists all Conversations by their parent DataStore. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -54398,25 +57829,25 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.conversations.list({ - * // A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" + * await discoveryengine.projects.locations.dataStores.operations.list({ + * // The standard list filter. * filter: 'placeholder-value', - * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: "update_time desc" "create_time" - * orderBy: 'placeholder-value', - * // Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore', + * // The standard list page size. * pageSize: 'placeholder-value', - * // A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. + * // The standard list page token. * pageToken: 'placeholder-value', - * // Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` - * parent: - * 'projects/my-project/locations/my-location/dataStores/my-dataStore', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "conversations": [], - * // "nextPageToken": "my_nextPageToken" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -54433,61 +57864,61 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Datastores$Conversations$List, + params: Params$Resource$Projects$Locations$Datastores$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Datastores$Conversations$List, + params?: Params$Resource$Projects$Locations$Datastores$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Datastores$Conversations$List, + params: Params$Resource$Projects$Locations$Datastores$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$Conversations$List, + params: Params$Resource$Projects$Locations$Datastores$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$Conversations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Operations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Conversations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Conversations$List; + {}) as Params$Resource$Projects$Locations$Datastores$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Conversations$List; + {} as Params$Resource$Projects$Locations$Datastores$Operations$List; options = {}; } @@ -54501,7 +57932,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/conversations').replace( + url: (rootUrl + '/v1alpha/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -54511,24 +57942,62 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Datastores$Operations$Get + extends StandardParameters { /** - * Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned. + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + + export class Resource$Projects$Locations$Datastores$Schemas { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a Schema. * @example * ```js * // Before running the sample: @@ -54561,22 +58030,21 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.conversations.patch({ - * // Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`. - * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/conversations/my-conversation', - * // Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. - * updateMask: 'placeholder-value', + * await discoveryengine.projects.locations.dataStores.schemas.create({ + * // Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. + * parent: + * 'projects/my-project/locations/my-location/dataStores/my-dataStore', + * // Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + * schemaId: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "endTime": "my_endTime", - * // "messages": [], + * // "fieldConfigs": [], + * // "jsonSchema": "my_jsonSchema", * // "name": "my_name", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "userPseudoId": "my_userPseudoId" + * // "structSchema": {} * // } * }, * }); @@ -54584,12 +58052,11 @@ export namespace discoveryengine_v1alpha { * * // Example response * // { - * // "endTime": "my_endTime", - * // "messages": [], + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "userPseudoId": "my_userPseudoId" + * // "response": {} * // } * } * @@ -54605,62 +58072,58 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, + create( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, + create( + params?: Params$Resource$Projects$Locations$Datastores$Schemas$Create, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - patch( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, + create( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - patch( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Conversations$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Schemas$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Schemas$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Conversations$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Schemas$Create; options = {}; } @@ -54674,128 +58137,32 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1alpha/{+parent}/schemas').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Datastores$Conversations$Converse - extends StandardParameters { - /** - * Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConverseConversationRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Conversations$Create - extends StandardParameters { - /** - * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation; - } - export interface Params$Resource$Projects$Locations$Datastores$Conversations$Delete - extends StandardParameters { - /** - * Required. The resource name of the Conversation to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Conversations$Get - extends StandardParameters { - /** - * Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Conversations$List - extends StandardParameters { - /** - * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" - */ - filter?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: "update_time desc" "create_time" - */ - orderBy?: string; - /** - * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Conversations$Patch - extends StandardParameters { - /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`. - */ - name?: string; - /** - * Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation; - } - - export class Resource$Projects$Locations$Datastores$Models { - context: APIRequestContext; - operations: Resource$Projects$Locations$Datastores$Models$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Datastores$Models$Operations( - this.context - ); - } - } - - export class Resource$Projects$Locations$Datastores$Models$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Deletes a Schema. * @example * ```js * // Before running the sample: @@ -54828,9 +58195,9 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.models.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/models/my-model/operations/my-operation', + * await discoveryengine.projects.locations.dataStores.schemas.delete({ + * // Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/schemas/my-schema', * }); * console.log(res.data); * @@ -54856,36 +58223,36 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, + delete( + params?: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, options?: MethodOptions ): Promise>; - get( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, callback: BodyResponseCallback ): void; - get( + delete( callback: BodyResponseCallback ): void; - get( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Models$Operations$Get + | Params$Resource$Projects$Locations$Datastores$Schemas$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -54901,13 +58268,13 @@ export namespace discoveryengine_v1alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Models$Operations$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Schemas$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Models$Operations$Get; + {} as Params$Resource$Projects$Locations$Datastores$Schemas$Delete; options = {}; } @@ -54922,7 +58289,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -54943,7 +58310,7 @@ export namespace discoveryengine_v1alpha { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Gets a Schema. * @example * ```js * // Before running the sample: @@ -54975,26 +58342,18 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await discoveryengine.projects.locations.dataStores.models.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/models/my-model', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * const res = await discoveryengine.projects.locations.dataStores.schemas.get({ + * // Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/schemas/my-schema', + * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "fieldConfigs": [], + * // "jsonSchema": "my_jsonSchema", + * // "name": "my_name", + * // "structSchema": {} * // } * } * @@ -55010,62 +58369,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, + get( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, + get( + params?: Params$Resource$Projects$Locations$Datastores$Schemas$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, + get( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, + get( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Models$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Schemas$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Models$Operations$List; + {}) as Params$Resource$Projects$Locations$Datastores$Schemas$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Models$Operations$List; + {} as Params$Resource$Projects$Locations$Datastores$Schemas$Get; options = {}; } @@ -55079,10 +58438,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -55094,57 +58450,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Datastores$Models$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Models$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - - export class Resource$Projects$Locations$Datastores$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Gets a list of Schemas. * @example * ```js * // Before running the sample: @@ -55176,20 +58494,20 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await discoveryengine.projects.locations.dataStores.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/operations/my-operation', - * }); + * const res = await discoveryengine.projects.locations.dataStores.schemas.list({ + * // The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000. + * pageSize: 'placeholder-value', + * // A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. + * parent: 'projects/my-project/locations/my-location/dataStores/my-dataStore', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "schemas": [] * // } * } * @@ -55205,58 +58523,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Operations$Get, + list( + params: Params$Resource$Projects$Locations$Datastores$Schemas$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Datastores$Operations$Get, + list( + params?: Params$Resource$Projects$Locations$Datastores$Schemas$List, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Datastores$Operations$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Datastores$Schemas$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Operations$Get, + list( + params: Params$Resource$Projects$Locations$Datastores$Schemas$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Operations$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datastores$Schemas$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Schemas$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Operations$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Schemas$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Operations$Get; + {} as Params$Resource$Projects$Locations$Datastores$Schemas$List; options = {}; } @@ -55270,29 +58592,34 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+parent}/schemas').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Updates a Schema. * @example * ```js * // Before running the sample: @@ -55324,26 +58651,34 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await discoveryengine.projects.locations.dataStores.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * const res = await discoveryengine.projects.locations.dataStores.schemas.patch( + * { + * // If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. + * allowMissing: 'placeholder-value', + * // Immutable. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/schemas/my-schema', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "fieldConfigs": [], + * // "jsonSchema": "my_jsonSchema", + * // "name": "my_name", + * // "structSchema": {} + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -55359,62 +58694,58 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datastores$Operations$List, + patch( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Datastores$Operations$List, + patch( + params?: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Datastores$Operations$List, + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Operations$List, + patch( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Operations$List, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - list( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Schemas$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Operations$List; + {}) as Params$Resource$Projects$Locations$Datastores$Schemas$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Operations$List; + {} as Params$Resource$Projects$Locations$Datastores$Schemas$Patch; options = {}; } @@ -55428,11 +58759,8 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -55443,57 +58771,86 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Datastores$Operations$Get + export interface Params$Resource$Projects$Locations$Datastores$Schemas$Create extends StandardParameters { /** - * The name of the operation resource. + * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. */ - name?: string; + parent?: string; + /** + * Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + */ + schemaId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSchema; } - export interface Params$Resource$Projects$Locations$Datastores$Operations$List + export interface Params$Resource$Projects$Locations$Datastores$Schemas$Delete extends StandardParameters { /** - * The standard list filter. + * Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. */ - filter?: string; + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Schemas$Get + extends StandardParameters { /** - * The name of the operation's parent resource. + * Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. */ name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Schemas$List + extends StandardParameters { /** - * The standard list page size. + * The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000. */ pageSize?: number; /** - * The standard list page token. + * A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token. */ pageToken?: string; /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. */ - returnPartialSuccess?: boolean; + parent?: string; } + export interface Params$Resource$Projects$Locations$Datastores$Schemas$Patch + extends StandardParameters { + /** + * If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. + */ + allowMissing?: boolean; + /** + * Immutable. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string; - export class Resource$Projects$Locations$Datastores$Schemas { + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSchema; + } + + export class Resource$Projects$Locations$Datastores$Servingconfigs { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates a Schema. + * Answer query method. * @example * ```js * // Before running the sample: @@ -55526,21 +58883,27 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.schemas.create({ - * // Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. - * parent: - * 'projects/my-project/locations/my-location/dataStores/my-dataStore', - * // Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. - * schemaId: 'placeholder-value', + * await discoveryengine.projects.locations.dataStores.servingConfigs.answer({ + * // Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + * servingConfig: + * 'projects/my-project/locations/my-location/dataStores/my-dataStore/servingConfigs/my-servingConfig', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "fieldConfigs": [], - * // "jsonSchema": "my_jsonSchema", - * // "name": "my_name", - * // "structSchema": {} + * // "answerGenerationSpec": {}, + * // "asynchronousMode": false, + * // "endUserSpec": {}, + * // "groundingSpec": {}, + * // "query": {}, + * // "queryUnderstandingSpec": {}, + * // "relatedQuestionsSpec": {}, + * // "safetySpec": {}, + * // "searchSpec": {}, + * // "session": "my_session", + * // "userLabels": {}, + * // "userPseudoId": "my_userPseudoId" * // } * }, * }); @@ -55548,11 +58911,9 @@ export namespace discoveryengine_v1alpha { * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "answer": {}, + * // "answerQueryToken": "my_answerQueryToken", + * // "session": {} * // } * } * @@ -55568,58 +58929,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, + answer( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Datastores$Schemas$Create, + answer( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, + ): Promise< + GaxiosResponseWithHTTP2 + >; + answer( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, + answer( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, - callback: BodyResponseCallback + answer( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + answer( + callback: BodyResponseCallback ): void; - create( + answer( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Schemas$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Schemas$Create; + {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Schemas$Create; + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer; options = {}; } @@ -55633,7 +58998,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/schemas').replace( + url: (rootUrl + '/v1alpha/{+servingConfig}:answer').replace( /([^:]\/)\/+/g, '$1' ), @@ -55643,22 +59008,24 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a Schema. + * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. * @example * ```js * // Before running the sample: @@ -55691,19 +59058,38 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.schemas.delete({ - * // Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. - * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/schemas/my-schema', + * await discoveryengine.projects.locations.dataStores.servingConfigs.get({ + * // Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/servingConfigs/my-servingConfig', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "answerGenerationSpec": {}, + * // "boostControlIds": [], + * // "createTime": "my_createTime", + * // "customFineTuningSpec": {}, + * // "displayName": "my_displayName", + * // "dissociateControlIds": [], + * // "diversityLevel": "my_diversityLevel", + * // "embeddingConfig": {}, + * // "filterControlIds": [], + * // "genericConfig": {}, + * // "guidedSearchSpec": {}, + * // "ignoreControlIds": [], + * // "mediaConfig": {}, + * // "modelId": "my_modelId", * // "name": "my_name", - * // "response": {} + * // "onewaySynonymsControlIds": [], + * // "personalizationSpec": {}, + * // "promoteControlIds": [], + * // "rankingExpression": "my_rankingExpression", + * // "redirectControlIds": [], + * // "replacementControlIds": [], + * // "solutionType": "my_solutionType", + * // "synonymsControlIds": [], + * // "updateTime": "my_updateTime" * // } * } * @@ -55719,58 +59105,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, + get( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, + get( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, + get( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - delete( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Schemas$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Schemas$Delete; + {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Schemas$Delete; + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get; options = {}; } @@ -55785,7 +59175,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -55796,17 +59186,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a Schema. + * Lists all ServingConfigs linked to this dataStore. * @example * ```js * // Before running the sample: @@ -55838,18 +59230,22 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.dataStores.schemas.get({ - * // Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. - * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/schemas/my-schema', - * }); + * const res = + * await discoveryengine.projects.locations.dataStores.servingConfigs.list({ + * // Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. + * pageSize: 'placeholder-value', + * // Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. + * pageToken: 'placeholder-value', + * // Required. Full resource name of the parent resource. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` + * parent: + * 'projects/my-project/locations/my-location/dataStores/my-dataStore', + * }); * console.log(res.data); * * // Example response * // { - * // "fieldConfigs": [], - * // "jsonSchema": "my_jsonSchema", - * // "name": "my_name", - * // "structSchema": {} + * // "nextPageToken": "my_nextPageToken", + * // "servingConfigs": [] * // } * } * @@ -55865,62 +59261,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, + list( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Datastores$Schemas$Get, + list( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, + list( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, + list( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Schemas$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Schemas$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Schemas$Get; + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$List; options = {}; } @@ -55934,31 +59330,34 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+parent}/servingConfigs').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets a list of Schemas. + * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. * @example * ```js * // Before running the sample: @@ -55990,20 +59389,72 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.dataStores.schemas.list({ - * // The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000. - * pageSize: 'placeholder-value', - * // A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. - * parent: 'projects/my-project/locations/my-location/dataStores/my-dataStore', - * }); + * const res = + * await discoveryengine.projects.locations.dataStores.servingConfigs.patch({ + * // Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/servingConfigs/my-servingConfig', + * // Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "answerGenerationSpec": {}, + * // "boostControlIds": [], + * // "createTime": "my_createTime", + * // "customFineTuningSpec": {}, + * // "displayName": "my_displayName", + * // "dissociateControlIds": [], + * // "diversityLevel": "my_diversityLevel", + * // "embeddingConfig": {}, + * // "filterControlIds": [], + * // "genericConfig": {}, + * // "guidedSearchSpec": {}, + * // "ignoreControlIds": [], + * // "mediaConfig": {}, + * // "modelId": "my_modelId", + * // "name": "my_name", + * // "onewaySynonymsControlIds": [], + * // "personalizationSpec": {}, + * // "promoteControlIds": [], + * // "rankingExpression": "my_rankingExpression", + * // "redirectControlIds": [], + * // "replacementControlIds": [], + * // "solutionType": "my_solutionType", + * // "synonymsControlIds": [], + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "schemas": [] + * // "answerGenerationSpec": {}, + * // "boostControlIds": [], + * // "createTime": "my_createTime", + * // "customFineTuningSpec": {}, + * // "displayName": "my_displayName", + * // "dissociateControlIds": [], + * // "diversityLevel": "my_diversityLevel", + * // "embeddingConfig": {}, + * // "filterControlIds": [], + * // "genericConfig": {}, + * // "guidedSearchSpec": {}, + * // "ignoreControlIds": [], + * // "mediaConfig": {}, + * // "modelId": "my_modelId", + * // "name": "my_name", + * // "onewaySynonymsControlIds": [], + * // "personalizationSpec": {}, + * // "promoteControlIds": [], + * // "rankingExpression": "my_rankingExpression", + * // "redirectControlIds": [], + * // "replacementControlIds": [], + * // "solutionType": "my_solutionType", + * // "synonymsControlIds": [], + * // "updateTime": "my_updateTime" * // } * } * @@ -56019,62 +59470,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datastores$Schemas$List, + patch( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Datastores$Schemas$List, + patch( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Datastores$Schemas$List, + patch( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Schemas$List, + patch( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Schemas$List, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - list( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Schemas$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Schemas$List; + {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Schemas$List; + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch; options = {}; } @@ -56088,34 +59539,31 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/schemas').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a Schema. + * Makes a recommendation, which requires a contextual user event. * @example * ```js * // Before running the sample: @@ -56147,34 +59595,35 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.dataStores.schemas.patch( - * { - * // If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. - * allowMissing: 'placeholder-value', - * // Immutable. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/schemas/my-schema', + * const res = + * await discoveryengine.projects.locations.dataStores.servingConfigs.recommend( + * { + * // Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. + * servingConfig: + * 'projects/my-project/locations/my-location/dataStores/my-dataStore/servingConfigs/my-servingConfig', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "fieldConfigs": [], - * // "jsonSchema": "my_jsonSchema", - * // "name": "my_name", - * // "structSchema": {} - * // } + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "filter": "my_filter", + * // "pageSize": 0, + * // "params": {}, + * // "userEvent": {}, + * // "userLabels": {}, + * // "validateOnly": false + * // } + * }, * }, - * }, - * ); + * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "attributionToken": "my_attributionToken", + * // "missingIds": [], + * // "results": [], + * // "validateOnly": false * // } * } * @@ -56190,58 +59639,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, + recommend( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, + recommend( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, + ): Promise< + GaxiosResponseWithHTTP2 + >; + recommend( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, + recommend( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, - callback: BodyResponseCallback + recommend( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + recommend( + callback: BodyResponseCallback ): void; - patch( + recommend( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Schemas$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Schemas$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Schemas$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend; options = {}; } @@ -56255,98 +59708,34 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1alpha/{+servingConfig}:recommend').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Projects$Locations$Datastores$Schemas$Create - extends StandardParameters { - /** - * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. - */ - parent?: string; - /** - * Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. - */ - schemaId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSchema; - } - export interface Params$Resource$Projects$Locations$Datastores$Schemas$Delete - extends StandardParameters { - /** - * Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Schemas$Get - extends StandardParameters { - /** - * Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Schemas$List - extends StandardParameters { - /** - * The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Schemas$Patch - extends StandardParameters { - /** - * If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. - */ - allowMissing?: boolean; - /** - * Immutable. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSchema; - } - - export class Resource$Projects$Locations$Datastores$Servingconfigs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Answer query method. + * Performs a search. * @example * ```js * // Before running the sample: @@ -56369,6 +59758,7 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -56379,8 +59769,8 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.servingConfigs.answer({ - * // Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + * await discoveryengine.projects.locations.dataStores.servingConfigs.search({ + * // Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. * servingConfig: * 'projects/my-project/locations/my-location/dataStores/my-dataStore/servingConfigs/my-servingConfig', * @@ -56388,16 +59778,42 @@ export namespace discoveryengine_v1alpha { * requestBody: { * // request body parameters * // { - * // "answerGenerationSpec": {}, - * // "asynchronousMode": false, - * // "endUserSpec": {}, - * // "groundingSpec": {}, - * // "query": {}, - * // "queryUnderstandingSpec": {}, - * // "relatedQuestionsSpec": {}, - * // "safetySpec": {}, - * // "searchSpec": {}, + * // "boostSpec": {}, + * // "branch": "my_branch", + * // "canonicalFilter": "my_canonicalFilter", + * // "contentSearchSpec": {}, + * // "customFineTuningSpec": {}, + * // "dataStoreSpecs": [], + * // "displaySpec": {}, + * // "embeddingSpec": {}, + * // "facetSpecs": [], + * // "filter": "my_filter", + * // "imageQuery": {}, + * // "languageCode": "my_languageCode", + * // "naturalLanguageQueryUnderstandingSpec": {}, + * // "offset": 0, + * // "oneBoxPageSize": 0, + * // "orderBy": "my_orderBy", + * // "pageSize": 0, + * // "pageToken": "my_pageToken", + * // "params": {}, + * // "personalizationSpec": {}, + * // "query": "my_query", + * // "queryExpansionSpec": {}, + * // "rankingExpression": "my_rankingExpression", + * // "rankingExpressionBackend": "my_rankingExpressionBackend", + * // "regionCode": "my_regionCode", + * // "relevanceScoreSpec": {}, + * // "relevanceThreshold": "my_relevanceThreshold", + * // "safeSearch": false, + * // "searchAddonSpec": {}, + * // "searchAsYouTypeSpec": {}, + * // "servingConfig": "my_servingConfig", * // "session": "my_session", + * // "sessionSpec": {}, + * // "spellCorrectionSpec": {}, + * // "useLatestData": false, + * // "userInfo": {}, * // "userLabels": {}, * // "userPseudoId": "my_userPseudoId" * // } @@ -56407,9 +59823,23 @@ export namespace discoveryengine_v1alpha { * * // Example response * // { - * // "answer": {}, - * // "answerQueryToken": "my_answerQueryToken", - * // "session": {} + * // "appliedControls": [], + * // "attributionToken": "my_attributionToken", + * // "correctedQuery": "my_correctedQuery", + * // "facets": [], + * // "geoSearchDebugInfo": [], + * // "guidedSearchResult": {}, + * // "naturalLanguageQueryUnderstandingInfo": {}, + * // "nextPageToken": "my_nextPageToken", + * // "oneBoxResults": [], + * // "queryExpansionInfo": {}, + * // "redirectUri": "my_redirectUri", + * // "results": [], + * // "searchLinkPromotions": [], + * // "sessionInfo": {}, + * // "suggestedQuery": "my_suggestedQuery", + * // "summary": {}, + * // "totalSize": 0 * // } * } * @@ -56425,62 +59855,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - answer( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, + search( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, options: StreamMethodOptions ): Promise>; - answer( - params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, + search( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - answer( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, + search( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - answer( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, + search( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - answer( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, - callback: BodyResponseCallback + search( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, + callback: BodyResponseCallback ): void; - answer( - callback: BodyResponseCallback + search( + callback: BodyResponseCallback ): void; - answer( + search( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer; + {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer; + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search; options = {}; } @@ -56494,7 +59924,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+servingConfig}:answer').replace( + url: (rootUrl + '/v1alpha/{+servingConfig}:search').replace( /([^:]\/)\/+/g, '$1' ), @@ -56509,19 +59939,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. + * Performs a search. Similar to the SearchService.Search method, but a lite version that allows API key for authentication, where OAuth and IAM checks are not required. Only public website search is supported by this method. If data stores and engines not associated with public website search are specified, a `FAILED_PRECONDITION` error is returned. This method can be used for easy onboarding without having to implement an authentication backend. However, it is strongly recommended to use SearchService.Search instead with required OAuth and IAM checks to provide better data security. * @example * ```js * // Before running the sample: @@ -56544,6 +59974,7 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -56554,38 +59985,79 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.servingConfigs.get({ - * // Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` - * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/servingConfigs/my-servingConfig', - * }); + * await discoveryengine.projects.locations.dataStores.servingConfigs.searchLite( + * { + * // Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. + * servingConfig: + * 'projects/my-project/locations/my-location/dataStores/my-dataStore/servingConfigs/my-servingConfig', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "boostSpec": {}, + * // "branch": "my_branch", + * // "canonicalFilter": "my_canonicalFilter", + * // "contentSearchSpec": {}, + * // "customFineTuningSpec": {}, + * // "dataStoreSpecs": [], + * // "displaySpec": {}, + * // "embeddingSpec": {}, + * // "facetSpecs": [], + * // "filter": "my_filter", + * // "imageQuery": {}, + * // "languageCode": "my_languageCode", + * // "naturalLanguageQueryUnderstandingSpec": {}, + * // "offset": 0, + * // "oneBoxPageSize": 0, + * // "orderBy": "my_orderBy", + * // "pageSize": 0, + * // "pageToken": "my_pageToken", + * // "params": {}, + * // "personalizationSpec": {}, + * // "query": "my_query", + * // "queryExpansionSpec": {}, + * // "rankingExpression": "my_rankingExpression", + * // "rankingExpressionBackend": "my_rankingExpressionBackend", + * // "regionCode": "my_regionCode", + * // "relevanceScoreSpec": {}, + * // "relevanceThreshold": "my_relevanceThreshold", + * // "safeSearch": false, + * // "searchAddonSpec": {}, + * // "searchAsYouTypeSpec": {}, + * // "servingConfig": "my_servingConfig", + * // "session": "my_session", + * // "sessionSpec": {}, + * // "spellCorrectionSpec": {}, + * // "useLatestData": false, + * // "userInfo": {}, + * // "userLabels": {}, + * // "userPseudoId": "my_userPseudoId" + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "answerGenerationSpec": {}, - * // "boostControlIds": [], - * // "createTime": "my_createTime", - * // "customFineTuningSpec": {}, - * // "displayName": "my_displayName", - * // "dissociateControlIds": [], - * // "diversityLevel": "my_diversityLevel", - * // "embeddingConfig": {}, - * // "filterControlIds": [], - * // "genericConfig": {}, - * // "guidedSearchSpec": {}, - * // "ignoreControlIds": [], - * // "mediaConfig": {}, - * // "modelId": "my_modelId", - * // "name": "my_name", - * // "onewaySynonymsControlIds": [], - * // "personalizationSpec": {}, - * // "promoteControlIds": [], - * // "rankingExpression": "my_rankingExpression", - * // "redirectControlIds": [], - * // "replacementControlIds": [], - * // "solutionType": "my_solutionType", - * // "synonymsControlIds": [], - * // "updateTime": "my_updateTime" + * // "appliedControls": [], + * // "attributionToken": "my_attributionToken", + * // "correctedQuery": "my_correctedQuery", + * // "facets": [], + * // "geoSearchDebugInfo": [], + * // "guidedSearchResult": {}, + * // "naturalLanguageQueryUnderstandingInfo": {}, + * // "nextPageToken": "my_nextPageToken", + * // "oneBoxResults": [], + * // "queryExpansionInfo": {}, + * // "redirectUri": "my_redirectUri", + * // "results": [], + * // "searchLinkPromotions": [], + * // "sessionInfo": {}, + * // "suggestedQuery": "my_suggestedQuery", + * // "summary": {}, + * // "totalSize": 0 * // } * } * @@ -56601,62 +60073,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, + searchLite( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Searchlite, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, + searchLite( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Searchlite, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, + searchLite( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Searchlite, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, + searchLite( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Searchlite, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, - callback: BodyResponseCallback + searchLite( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Searchlite, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + searchLite( + callback: BodyResponseCallback ): void; - get( + searchLite( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Searchlite + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Searchlite; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get; + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Searchlite; options = {}; } @@ -56670,31 +60142,34 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+servingConfig}:searchLite').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists all ServingConfigs linked to this dataStore. + * Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream. * @example * ```js * // Before running the sample: @@ -56727,21 +60202,39 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.servingConfigs.list({ - * // Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. - * pageSize: 'placeholder-value', - * // Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. - * pageToken: 'placeholder-value', - * // Required. Full resource name of the parent resource. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` - * parent: - * 'projects/my-project/locations/my-location/dataStores/my-dataStore', - * }); + * await discoveryengine.projects.locations.dataStores.servingConfigs.streamAnswer( + * { + * // Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + * servingConfig: + * 'projects/my-project/locations/my-location/dataStores/my-dataStore/servingConfigs/my-servingConfig', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "answerGenerationSpec": {}, + * // "asynchronousMode": false, + * // "endUserSpec": {}, + * // "groundingSpec": {}, + * // "query": {}, + * // "queryUnderstandingSpec": {}, + * // "relatedQuestionsSpec": {}, + * // "safetySpec": {}, + * // "searchSpec": {}, + * // "session": "my_session", + * // "userLabels": {}, + * // "userPseudoId": "my_userPseudoId" + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "servingConfigs": [] + * // "answer": {}, + * // "answerQueryToken": "my_answerQueryToken", + * // "session": {} * // } * } * @@ -56757,62 +60250,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, + streamAnswer( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Streamanswer, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, + streamAnswer( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Streamanswer, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, + streamAnswer( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Streamanswer, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, + streamAnswer( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Streamanswer, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, - callback: BodyResponseCallback + streamAnswer( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Streamanswer, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + streamAnswer( + callback: BodyResponseCallback ): void; - list( + streamAnswer( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Servingconfigs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Streamanswer + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$List; + {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Streamanswer; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$List; + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Streamanswer; options = {}; } @@ -56826,240 +60319,145 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/servingConfigs').replace( + url: (rootUrl + '/v1alpha/{+servingConfig}:streamAnswer').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer + extends StandardParameters { /** - * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const discoveryengine = google.discoveryengine('v1alpha'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.readwrite', - * ], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await discoveryengine.projects.locations.dataStores.servingConfigs.patch({ - * // Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` - * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/servingConfigs/my-servingConfig', - * // Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "answerGenerationSpec": {}, - * // "boostControlIds": [], - * // "createTime": "my_createTime", - * // "customFineTuningSpec": {}, - * // "displayName": "my_displayName", - * // "dissociateControlIds": [], - * // "diversityLevel": "my_diversityLevel", - * // "embeddingConfig": {}, - * // "filterControlIds": [], - * // "genericConfig": {}, - * // "guidedSearchSpec": {}, - * // "ignoreControlIds": [], - * // "mediaConfig": {}, - * // "modelId": "my_modelId", - * // "name": "my_name", - * // "onewaySynonymsControlIds": [], - * // "personalizationSpec": {}, - * // "promoteControlIds": [], - * // "rankingExpression": "my_rankingExpression", - * // "redirectControlIds": [], - * // "replacementControlIds": [], - * // "solutionType": "my_solutionType", - * // "synonymsControlIds": [], - * // "updateTime": "my_updateTime" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "answerGenerationSpec": {}, - * // "boostControlIds": [], - * // "createTime": "my_createTime", - * // "customFineTuningSpec": {}, - * // "displayName": "my_displayName", - * // "dissociateControlIds": [], - * // "diversityLevel": "my_diversityLevel", - * // "embeddingConfig": {}, - * // "filterControlIds": [], - * // "genericConfig": {}, - * // "guidedSearchSpec": {}, - * // "ignoreControlIds": [], - * // "mediaConfig": {}, - * // "modelId": "my_modelId", - * // "name": "my_name", - * // "onewaySynonymsControlIds": [], - * // "personalizationSpec": {}, - * // "promoteControlIds": [], - * // "rankingExpression": "my_rankingExpression", - * // "redirectControlIds": [], - * // "replacementControlIds": [], - * // "solutionType": "my_solutionType", - * // "synonymsControlIds": [], - * // "updateTime": "my_updateTime" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + */ + servingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get + extends StandardParameters { + /** + * Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$List + extends StandardParameters { + /** + * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. Full resource name of the parent resource. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` + */ + name?: string; + /** + * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig; + } + export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend + extends StandardParameters { + /** + * Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. + */ + servingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecommendRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search + extends StandardParameters { + /** + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. + */ + servingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Searchlite + extends StandardParameters { + /** + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. */ - patch( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, - options: StreamMethodOptions - ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - patch( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, - callback: BodyResponseCallback - ): void; - patch( - callback: BodyResponseCallback - ): void; - patch( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; + servingConfig?: string; - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Streamanswer + extends StandardParameters { + /** + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + */ + servingConfig?: string; - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest; + } - const rootUrl = - options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters + export class Resource$Projects$Locations$Datastores$Sessions { + context: APIRequestContext; + answers: Resource$Projects$Locations$Datastores$Sessions$Answers; + constructor(context: APIRequestContext) { + this.context = context; + this.answers = + new Resource$Projects$Locations$Datastores$Sessions$Answers( + this.context ); - } } /** - * Makes a recommendation, which requires a contextual user event. + * Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. * @example * ```js * // Before running the sample: @@ -57082,6 +60480,7 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -57092,34 +60491,40 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.servingConfigs.recommend( - * { - * // Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. - * servingConfig: - * 'projects/my-project/locations/my-location/dataStores/my-dataStore/servingConfigs/my-servingConfig', + * await discoveryengine.projects.locations.dataStores.sessions.create({ + * // Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` + * parent: + * 'projects/my-project/locations/my-location/dataStores/my-dataStore', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "filter": "my_filter", - * // "pageSize": 0, - * // "params": {}, - * // "userEvent": {}, - * // "userLabels": {}, - * // "validateOnly": false - * // } - * }, + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "displayName": "my_displayName", + * // "endTime": "my_endTime", + * // "isPinned": false, + * // "labels": [], + * // "name": "my_name", + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "turns": [], + * // "userPseudoId": "my_userPseudoId" + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response * // { - * // "attributionToken": "my_attributionToken", - * // "missingIds": [], - * // "results": [], - * // "validateOnly": false + * // "displayName": "my_displayName", + * // "endTime": "my_endTime", + * // "isPinned": false, + * // "labels": [], + * // "name": "my_name", + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "turns": [], + * // "userPseudoId": "my_userPseudoId" * // } * } * @@ -57135,62 +60540,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - recommend( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, + create( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, options: StreamMethodOptions ): Promise>; - recommend( - params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, + create( + params?: Params$Resource$Projects$Locations$Datastores$Sessions$Create, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - recommend( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, + create( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recommend( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, + create( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - recommend( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, + callback: BodyResponseCallback ): void; - recommend( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - recommend( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sessions$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend; + {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend; + {} as Params$Resource$Projects$Locations$Datastores$Sessions$Create; options = {}; } @@ -57204,7 +60609,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+servingConfig}:recommend').replace( + url: (rootUrl + '/v1alpha/{+parent}/sessions').replace( /([^:]\/)\/+/g, '$1' ), @@ -57214,24 +60619,24 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Performs a search. + * Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. * @example * ```js * // Before running the sample: @@ -57265,78 +60670,14 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.servingConfigs.search({ - * // Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. - * servingConfig: - * 'projects/my-project/locations/my-location/dataStores/my-dataStore/servingConfigs/my-servingConfig', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "boostSpec": {}, - * // "branch": "my_branch", - * // "canonicalFilter": "my_canonicalFilter", - * // "contentSearchSpec": {}, - * // "customFineTuningSpec": {}, - * // "dataStoreSpecs": [], - * // "displaySpec": {}, - * // "embeddingSpec": {}, - * // "facetSpecs": [], - * // "filter": "my_filter", - * // "imageQuery": {}, - * // "languageCode": "my_languageCode", - * // "naturalLanguageQueryUnderstandingSpec": {}, - * // "offset": 0, - * // "oneBoxPageSize": 0, - * // "orderBy": "my_orderBy", - * // "pageSize": 0, - * // "pageToken": "my_pageToken", - * // "params": {}, - * // "personalizationSpec": {}, - * // "query": "my_query", - * // "queryExpansionSpec": {}, - * // "rankingExpression": "my_rankingExpression", - * // "rankingExpressionBackend": "my_rankingExpressionBackend", - * // "regionCode": "my_regionCode", - * // "relevanceScoreSpec": {}, - * // "relevanceThreshold": "my_relevanceThreshold", - * // "safeSearch": false, - * // "searchAddonSpec": {}, - * // "searchAsYouTypeSpec": {}, - * // "servingConfig": "my_servingConfig", - * // "session": "my_session", - * // "sessionSpec": {}, - * // "spellCorrectionSpec": {}, - * // "useLatestData": false, - * // "userInfo": {}, - * // "userLabels": {}, - * // "userPseudoId": "my_userPseudoId" - * // } - * }, + * await discoveryengine.projects.locations.dataStores.sessions.delete({ + * // Required. The resource name of the Session to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/sessions/my-session', * }); * console.log(res.data); * * // Example response - * // { - * // "appliedControls": [], - * // "attributionToken": "my_attributionToken", - * // "correctedQuery": "my_correctedQuery", - * // "facets": [], - * // "geoSearchDebugInfo": [], - * // "guidedSearchResult": {}, - * // "naturalLanguageQueryUnderstandingInfo": {}, - * // "nextPageToken": "my_nextPageToken", - * // "oneBoxResults": [], - * // "queryExpansionInfo": {}, - * // "redirectUri": "my_redirectUri", - * // "results": [], - * // "searchLinkPromotions": [], - * // "sessionInfo": {}, - * // "suggestedQuery": "my_suggestedQuery", - * // "summary": {}, - * // "totalSize": 0 - * // } + * // {} * } * * main().catch(e => { @@ -57351,62 +60692,54 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - search( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, + delete( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, options: StreamMethodOptions ): Promise>; - search( - params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, + delete( + params?: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - search( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - search( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - search( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - search( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, + callback: BodyResponseCallback ): void; - search( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sessions$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search; + {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search; + {} as Params$Resource$Projects$Locations$Datastores$Sessions$Delete; options = {}; } @@ -57420,34 +60753,29 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+servingConfig}:search').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Performs a search. Similar to the SearchService.Search method, but a lite version that allows API key for authentication, where OAuth and IAM checks are not required. Only public website search is supported by this method. If data stores and engines not associated with public website search are specified, a `FAILED_PRECONDITION` error is returned. This method can be used for easy onboarding without having to implement an authentication backend. However, it is strongly recommended to use SearchService.Search instead with required OAuth and IAM checks to provide better data security. + * Gets a Session. * @example * ```js * // Before running the sample: @@ -57480,80 +60808,25 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await discoveryengine.projects.locations.dataStores.servingConfigs.searchLite( - * { - * // Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. - * servingConfig: - * 'projects/my-project/locations/my-location/dataStores/my-dataStore/servingConfigs/my-servingConfig', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "boostSpec": {}, - * // "branch": "my_branch", - * // "canonicalFilter": "my_canonicalFilter", - * // "contentSearchSpec": {}, - * // "customFineTuningSpec": {}, - * // "dataStoreSpecs": [], - * // "displaySpec": {}, - * // "embeddingSpec": {}, - * // "facetSpecs": [], - * // "filter": "my_filter", - * // "imageQuery": {}, - * // "languageCode": "my_languageCode", - * // "naturalLanguageQueryUnderstandingSpec": {}, - * // "offset": 0, - * // "oneBoxPageSize": 0, - * // "orderBy": "my_orderBy", - * // "pageSize": 0, - * // "pageToken": "my_pageToken", - * // "params": {}, - * // "personalizationSpec": {}, - * // "query": "my_query", - * // "queryExpansionSpec": {}, - * // "rankingExpression": "my_rankingExpression", - * // "rankingExpressionBackend": "my_rankingExpressionBackend", - * // "regionCode": "my_regionCode", - * // "relevanceScoreSpec": {}, - * // "relevanceThreshold": "my_relevanceThreshold", - * // "safeSearch": false, - * // "searchAddonSpec": {}, - * // "searchAsYouTypeSpec": {}, - * // "servingConfig": "my_servingConfig", - * // "session": "my_session", - * // "sessionSpec": {}, - * // "spellCorrectionSpec": {}, - * // "useLatestData": false, - * // "userInfo": {}, - * // "userLabels": {}, - * // "userPseudoId": "my_userPseudoId" - * // } - * }, - * }, - * ); + * const res = await discoveryengine.projects.locations.dataStores.sessions.get({ + * // Optional. If set to true, the full session including all answer details will be returned. + * includeAnswerDetails: 'placeholder-value', + * // Required. The resource name of the Session to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/sessions/my-session', + * }); * console.log(res.data); * * // Example response * // { - * // "appliedControls": [], - * // "attributionToken": "my_attributionToken", - * // "correctedQuery": "my_correctedQuery", - * // "facets": [], - * // "geoSearchDebugInfo": [], - * // "guidedSearchResult": {}, - * // "naturalLanguageQueryUnderstandingInfo": {}, - * // "nextPageToken": "my_nextPageToken", - * // "oneBoxResults": [], - * // "queryExpansionInfo": {}, - * // "redirectUri": "my_redirectUri", - * // "results": [], - * // "searchLinkPromotions": [], - * // "sessionInfo": {}, - * // "suggestedQuery": "my_suggestedQuery", - * // "summary": {}, - * // "totalSize": 0 + * // "displayName": "my_displayName", + * // "endTime": "my_endTime", + * // "isPinned": false, + * // "labels": [], + * // "name": "my_name", + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "turns": [], + * // "userPseudoId": "my_userPseudoId" * // } * } * @@ -57569,62 +60842,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - searchLite( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Searchlite, + get( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, options: StreamMethodOptions ): Promise>; - searchLite( - params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Searchlite, + get( + params?: Params$Resource$Projects$Locations$Datastores$Sessions$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - searchLite( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Searchlite, + get( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - searchLite( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Searchlite, + get( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - searchLite( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Searchlite, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, + callback: BodyResponseCallback ): void; - searchLite( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - searchLite( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Searchlite - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sessions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Searchlite; + {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Searchlite; + {} as Params$Resource$Projects$Locations$Datastores$Sessions$Get; options = {}; } @@ -57634,38 +60907,35 @@ export namespace discoveryengine_v1alpha { } const rootUrl = - options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+servingConfig}:searchLite').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream. + * Lists all Sessions by their parent DataStore. * @example * ```js * // Before running the sample: @@ -57688,6 +60958,7 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -57697,40 +60968,27 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await discoveryengine.projects.locations.dataStores.servingConfigs.streamAnswer( - * { - * // Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - * servingConfig: - * 'projects/my-project/locations/my-location/dataStores/my-dataStore/servingConfigs/my-servingConfig', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "answerGenerationSpec": {}, - * // "asynchronousMode": false, - * // "endUserSpec": {}, - * // "groundingSpec": {}, - * // "query": {}, - * // "queryUnderstandingSpec": {}, - * // "relatedQuestionsSpec": {}, - * // "safetySpec": {}, - * // "searchSpec": {}, - * // "session": "my_session", - * // "userLabels": {}, - * // "userPseudoId": "my_userPseudoId" - * // } - * }, - * }, - * ); + * const res = await discoveryengine.projects.locations.dataStores.sessions.list( + * { + * // A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time \> "1970-01-01T12:00:00Z"` + * filter: 'placeholder-value', + * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. + * orderBy: 'placeholder-value', + * // Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + * pageSize: 'placeholder-value', + * // A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. + * pageToken: 'placeholder-value', + * // Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` + * parent: + * 'projects/my-project/locations/my-location/dataStores/my-dataStore', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "answer": {}, - * // "answerQueryToken": "my_answerQueryToken", - * // "session": {} + * // "nextPageToken": "my_nextPageToken", + * // "sessions": [] * // } * } * @@ -57746,62 +61004,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - streamAnswer( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Streamanswer, + list( + params: Params$Resource$Projects$Locations$Datastores$Sessions$List, options: StreamMethodOptions ): Promise>; - streamAnswer( - params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Streamanswer, + list( + params?: Params$Resource$Projects$Locations$Datastores$Sessions$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - streamAnswer( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Streamanswer, + list( + params: Params$Resource$Projects$Locations$Datastores$Sessions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - streamAnswer( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Streamanswer, + list( + params: Params$Resource$Projects$Locations$Datastores$Sessions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - streamAnswer( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Streamanswer, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datastores$Sessions$List, + callback: BodyResponseCallback ): void; - streamAnswer( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - streamAnswer( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Streamanswer - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sessions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Streamanswer; + {}) as Params$Resource$Projects$Locations$Datastores$Sessions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Streamanswer; + {} as Params$Resource$Projects$Locations$Datastores$Sessions$List; options = {}; } @@ -57815,145 +61073,34 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+servingConfig}:streamAnswer').replace( + url: (rootUrl + '/v1alpha/{+parent}/sessions').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer - extends StandardParameters { - /** - * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - */ - servingConfig?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get - extends StandardParameters { - /** - * Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$List - extends StandardParameters { - /** - * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. - */ - pageSize?: number; - /** - * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. Full resource name of the parent resource. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch - extends StandardParameters { - /** - * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` - */ - name?: string; - /** - * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig; - } - export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend - extends StandardParameters { - /** - * Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. - */ - servingConfig?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecommendRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search - extends StandardParameters { - /** - * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. - */ - servingConfig?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Searchlite - extends StandardParameters { - /** - * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/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. - */ - servingConfig?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Streamanswer - extends StandardParameters { - /** - * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - */ - servingConfig?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest; - } - - export class Resource$Projects$Locations$Datastores$Sessions { - context: APIRequestContext; - answers: Resource$Projects$Locations$Datastores$Sessions$Answers; - constructor(context: APIRequestContext) { - this.context = context; - this.answers = - new Resource$Projects$Locations$Datastores$Sessions$Answers( - this.context - ); - } /** - * Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. + * Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. * @example * ```js * // Before running the sample: @@ -57987,10 +61134,11 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.sessions.create({ - * // Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` - * parent: - * 'projects/my-project/locations/my-location/dataStores/my-dataStore', + * await discoveryengine.projects.locations.dataStores.sessions.patch({ + * // Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/sessions/my-session', + * // Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated. + * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { @@ -58036,38 +61184,38 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, + patch( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Datastores$Sessions$Create, + patch( + params?: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; - create( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, + patch( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, + patch( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, + patch( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, callback: BodyResponseCallback ): void; - create( + patch( callback: BodyResponseCallback ): void; - create( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sessions$Create + | Params$Resource$Projects$Locations$Datastores$Sessions$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -58085,13 +61233,13 @@ export namespace discoveryengine_v1alpha { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Create; + {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sessions$Create; + {} as Params$Resource$Projects$Locations$Datastores$Sessions$Patch; options = {}; } @@ -58105,18 +61253,15 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/sessions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -58130,9 +61275,86 @@ export namespace discoveryengine_v1alpha { ); } } + } + export interface Params$Resource$Projects$Locations$Datastores$Sessions$Create + extends StandardParameters { /** - * Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. + * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession; + } + export interface Params$Resource$Projects$Locations$Datastores$Sessions$Delete + extends StandardParameters { + /** + * Required. The resource name of the Session to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Sessions$Get + extends StandardParameters { + /** + * Optional. If set to true, the full session including all answer details will be returned. + */ + includeAnswerDetails?: boolean; + /** + * Required. The resource name of the Session to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Sessions$List + extends StandardParameters { + /** + * A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time \> "1970-01-01T12:00:00Z"` + */ + filter?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. + */ + orderBy?: string; + /** + * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Sessions$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` + */ + name?: string; + /** + * Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession; + } + + export class Resource$Projects$Locations$Datastores$Sessions$Answers { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a Answer. * @example * ```js * // Before running the sample: @@ -58155,7 +61377,6 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -58166,14 +61387,30 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.sessions.delete({ - * // Required. The resource name of the Session to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` - * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/sessions/my-session', + * await discoveryengine.projects.locations.dataStores.sessions.answers.get({ + * // Required. The resource name of the Answer to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/sessions/my-session/answers/my-answer', * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "answerSkippedReasons": [], + * // "answerText": "my_answerText", + * // "blobAttachments": [], + * // "citations": [], + * // "completeTime": "my_completeTime", + * // "createTime": "my_createTime", + * // "groundingScore": {}, + * // "groundingSupports": [], + * // "name": "my_name", + * // "queryUnderstandingInfo": {}, + * // "references": [], + * // "relatedQuestions": [], + * // "safetyRatings": [], + * // "state": "my_state", + * // "steps": [] + * // } * } * * main().catch(e => { @@ -58188,54 +61425,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, + get( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, + get( + params?: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sessions$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Delete; + {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sessions$Delete; + {} as Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get; options = {}; } @@ -58250,7 +61495,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -58261,17 +61506,44 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get + extends StandardParameters { /** - * Gets a Session. + * Required. The resource name of the Answer to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` + */ + name?: string; + } + + export class Resource$Projects$Locations$Datastores$Sitesearchengine { + context: APIRequestContext; + sitemaps: Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps; + targetSites: Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites; + constructor(context: APIRequestContext) { + this.context = context; + this.sitemaps = + new Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps( + this.context + ); + this.targetSites = + new Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites( + this.context + ); + } + + /** + * Downgrade from advanced site search to basic site search. * @example * ```js * // Before running the sample: @@ -58294,7 +61566,6 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -58304,25 +61575,29 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.dataStores.sessions.get({ - * // Optional. If set to true, the full session including all answer details will be returned. - * includeAnswerDetails: 'placeholder-value', - * // Required. The resource name of the Session to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` - * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/sessions/my-session', - * }); + * const res = + * await discoveryengine.projects.locations.dataStores.siteSearchEngine.disableAdvancedSiteSearch( + * { + * // Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. + * siteSearchEngine: + * 'projects/my-project/locations/my-location/dataStores/my-dataStore/siteSearchEngine', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "displayName": "my_displayName", - * // "endTime": "my_endTime", - * // "isPinned": false, - * // "labels": [], - * // "name": "my_name", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "turns": [], - * // "userPseudoId": "my_userPseudoId" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -58338,62 +61613,58 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Datastores$Sessions$Get, + disableAdvancedSiteSearch( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, + ): Promise>; + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, - callback: BodyResponseCallback + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + disableAdvancedSiteSearch( + callback: BodyResponseCallback ): void; - get( + disableAdvancedSiteSearch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sessions$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sessions$Get; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch; options = {}; } @@ -58407,31 +61678,31 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: ( + rootUrl + '/v1alpha/{+siteSearchEngine}:disableAdvancedSiteSearch' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists all Sessions by their parent DataStore. + * Upgrade from basic site search to advanced site search. * @example * ```js * // Before running the sample: @@ -58454,7 +61725,6 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -58464,27 +61734,29 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.dataStores.sessions.list( - * { - * // A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time \> "1970-01-01T12:00:00Z"` - * filter: 'placeholder-value', - * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. - * orderBy: 'placeholder-value', - * // Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. - * pageSize: 'placeholder-value', - * // A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. - * pageToken: 'placeholder-value', - * // Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` - * parent: - * 'projects/my-project/locations/my-location/dataStores/my-dataStore', - * }, - * ); + * const res = + * await discoveryengine.projects.locations.dataStores.siteSearchEngine.enableAdvancedSiteSearch( + * { + * // Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. + * siteSearchEngine: + * 'projects/my-project/locations/my-location/dataStores/my-dataStore/siteSearchEngine', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "sessions": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -58500,62 +61772,58 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datastores$Sessions$List, + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Datastores$Sessions$List, + enableAdvancedSiteSearch( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Datastores$Sessions$List, + ): Promise>; + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Sessions$List, + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Sessions$List, - callback: BodyResponseCallback + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + enableAdvancedSiteSearch( + callback: BodyResponseCallback ): void; - list( + enableAdvancedSiteSearch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sessions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sessions$List; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sessions$List; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch; options = {}; } @@ -58569,34 +61837,31 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/sessions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: ( + rootUrl + '/v1alpha/{+siteSearchEngine}:enableAdvancedSiteSearch' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. + * Request on-demand recrawl for a list of URIs. * @example * ```js * // Before running the sample: @@ -58619,7 +61884,6 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -58630,41 +61894,31 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.sessions.patch({ - * // Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` - * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/sessions/my-session', - * // Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated. - * updateMask: 'placeholder-value', + * await discoveryengine.projects.locations.dataStores.siteSearchEngine.recrawlUris( + * { + * // Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. + * siteSearchEngine: + * 'projects/my-project/locations/my-location/dataStores/my-dataStore/siteSearchEngine', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "displayName": "my_displayName", - * // "endTime": "my_endTime", - * // "isPinned": false, - * // "labels": [], - * // "name": "my_name", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "turns": [], - * // "userPseudoId": "my_userPseudoId" - * // } + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "siteCredential": "my_siteCredential", + * // "uris": [] + * // } + * }, * }, - * }); + * ); * console.log(res.data); * * // Example response * // { - * // "displayName": "my_displayName", - * // "endTime": "my_endTime", - * // "isPinned": false, - * // "labels": [], + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "turns": [], - * // "userPseudoId": "my_userPseudoId" + * // "response": {} * // } * } * @@ -58680,62 +61934,58 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, + recrawlUris( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, + recrawlUris( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - patch( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, + ): Promise>; + recrawlUris( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, + recrawlUris( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, - callback: BodyResponseCallback + recrawlUris( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + recrawlUris( + callback: BodyResponseCallback ): void; - patch( + recrawlUris( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sessions$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sessions$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris; options = {}; } @@ -58749,108 +61999,76 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1alpha/{+siteSearchEngine}:recrawlUris').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Datastores$Sessions$Create + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch extends StandardParameters { /** - * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. */ - parent?: string; + siteSearchEngine?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession; - } - export interface Params$Resource$Projects$Locations$Datastores$Sessions$Delete - extends StandardParameters { - /** - * Required. The resource name of the Session to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Sessions$Get - extends StandardParameters { - /** - * Optional. If set to true, the full session including all answer details will be returned. - */ - includeAnswerDetails?: boolean; - /** - * Required. The resource name of the Session to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` - */ - name?: string; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest; } - export interface Params$Resource$Projects$Locations$Datastores$Sessions$List + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch extends StandardParameters { /** - * A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time \> "1970-01-01T12:00:00Z"` - */ - filter?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. - */ - orderBy?: string; - /** - * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. + * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. */ - pageToken?: string; + siteSearchEngine?: string; + /** - * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` + * Request body metadata */ - parent?: string; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest; } - export interface Params$Resource$Projects$Locations$Datastores$Sessions$Patch + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris extends StandardParameters { /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` - */ - name?: string; - /** - * Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated. + * Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. */ - updateMask?: string; + siteSearchEngine?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest; } - export class Resource$Projects$Locations$Datastores$Sessions$Answers { + export class Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Gets a Answer. + * Creates a Sitemap. * @example * ```js * // Before running the sample: @@ -58883,29 +62101,32 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.sessions.answers.get({ - * // Required. The resource name of the Answer to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` - * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/sessions/my-session/answers/my-answer', - * }); + * await discoveryengine.projects.locations.dataStores.siteSearchEngine.sitemaps.create( + * { + * // Required. Parent resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. + * parent: + * 'projects/my-project/locations/my-location/dataStores/my-dataStore/siteSearchEngine', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "name": "my_name", + * // "uri": "my_uri" + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "answerSkippedReasons": [], - * // "answerText": "my_answerText", - * // "blobAttachments": [], - * // "citations": [], - * // "completeTime": "my_completeTime", - * // "createTime": "my_createTime", - * // "groundingScore": {}, - * // "groundingSupports": [], + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "queryUnderstandingInfo": {}, - * // "references": [], - * // "relatedQuestions": [], - * // "safetyRatings": [], - * // "state": "my_state", - * // "steps": [] + * // "response": {} * // } * } * @@ -58921,62 +62142,58 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, + create( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Create, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, + create( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Create, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, + create( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Create, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Create; options = {}; } @@ -58990,56 +62207,32 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+parent}/sitemaps').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get - extends StandardParameters { - /** - * Required. The resource name of the Answer to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` - */ - name?: string; - } - - export class Resource$Projects$Locations$Datastores$Sitesearchengine { - context: APIRequestContext; - sitemaps: Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps; - targetSites: Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites; - constructor(context: APIRequestContext) { - this.context = context; - this.sitemaps = - new Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps( - this.context - ); - this.targetSites = - new Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites( - this.context - ); - } /** - * Downgrade from advanced site search to basic site search. + * Deletes a Sitemap. * @example * ```js * // Before running the sample: @@ -59072,17 +62265,10 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.siteSearchEngine.disableAdvancedSiteSearch( + * await discoveryengine.projects.locations.dataStores.siteSearchEngine.sitemaps.delete( * { - * // Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. - * siteSearchEngine: - * 'projects/my-project/locations/my-location/dataStores/my-dataStore/siteSearchEngine', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, + * // Required. Full resource name of Sitemap, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/sitemaps/{sitemap\}`. If the caller does not have permission to access the Sitemap, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Sitemap does not exist, a NOT_FOUND error is returned. + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/siteSearchEngine/sitemaps/my-sitemap', * }, * ); * console.log(res.data); @@ -59109,36 +62295,36 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, + delete( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Delete, options: StreamMethodOptions ): Promise>; - disableAdvancedSiteSearch( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, + delete( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Delete, options?: MethodOptions ): Promise>; - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, + delete( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, + delete( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, + delete( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Delete, callback: BodyResponseCallback ): void; - disableAdvancedSiteSearch( + delete( callback: BodyResponseCallback ): void; - disableAdvancedSiteSearch( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -59154,13 +62340,13 @@ export namespace discoveryengine_v1alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Delete; options = {}; } @@ -59174,17 +62360,15 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+siteSearchEngine}:disableAdvancedSiteSearch' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['siteSearchEngine'], - pathParams: ['siteSearchEngine'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -59198,7 +62382,7 @@ export namespace discoveryengine_v1alpha { } /** - * Upgrade from basic site search to advanced site search. + * Fetch Sitemaps in a DataStore. * @example * ```js * // Before running the sample: @@ -59231,28 +62415,20 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.siteSearchEngine.enableAdvancedSiteSearch( + * await discoveryengine.projects.locations.dataStores.siteSearchEngine.sitemaps.fetch( * { - * // Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. - * siteSearchEngine: + * // The Sitemap uris. + * 'matcher.urisMatcher.uris': 'placeholder-value', + * // Required. Parent resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. + * parent: * 'projects/my-project/locations/my-location/dataStores/my-dataStore/siteSearchEngine', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, * }, * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "sitemapsMetadata": [] * // } * } * @@ -59268,58 +62444,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, + fetch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Fetch, options: StreamMethodOptions ): Promise>; - enableAdvancedSiteSearch( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, + fetch( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Fetch, options?: MethodOptions - ): Promise>; - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, + ): Promise< + GaxiosResponseWithHTTP2 + >; + fetch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Fetch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, + fetch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Fetch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, - callback: BodyResponseCallback + fetch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Fetch, + callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( - callback: BodyResponseCallback + fetch( + callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( + fetch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Fetch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Fetch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Fetch; options = {}; } @@ -59333,31 +62513,72 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+siteSearchEngine}:enableAdvancedSiteSearch' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1alpha/{+parent}/sitemaps:fetch').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['siteSearchEngine'], - pathParams: ['siteSearchEngine'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Create + extends StandardParameters { /** - * Request on-demand recrawl for a list of URIs. + * Required. Parent resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSitemap; + } + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Delete + extends StandardParameters { + /** + * Required. Full resource name of Sitemap, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/sitemaps/{sitemap\}`. If the caller does not have permission to access the Sitemap, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Sitemap does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Fetch + extends StandardParameters { + /** + * The Sitemap uris. + */ + 'matcher.urisMatcher.uris'?: string[]; + /** + * Required. Parent resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates TargetSite in a batch. * @example * ```js * // Before running the sample: @@ -59390,18 +62611,17 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.siteSearchEngine.recrawlUris( + * await discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.batchCreate( * { - * // Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. - * siteSearchEngine: + * // Required. The parent resource shared by all TargetSites being created. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. The parent field in the CreateBookRequest messages must either be empty or match this field. + * parent: * 'projects/my-project/locations/my-location/dataStores/my-dataStore/siteSearchEngine', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "siteCredential": "my_siteCredential", - * // "uris": [] + * // "requests": [] * // } * }, * }, @@ -59430,36 +62650,36 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - recrawlUris( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, + batchCreate( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: StreamMethodOptions ): Promise>; - recrawlUris( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, + batchCreate( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, options?: MethodOptions ): Promise>; - recrawlUris( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, + batchCreate( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recrawlUris( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, + batchCreate( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recrawlUris( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, + batchCreate( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, callback: BodyResponseCallback ): void; - recrawlUris( + batchCreate( callback: BodyResponseCallback ): void; - recrawlUris( + batchCreate( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -59475,13 +62695,13 @@ export namespace discoveryengine_v1alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate; options = {}; } @@ -59495,18 +62715,17 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+siteSearchEngine}:recrawlUris').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1alpha/{+parent}/targetSites:batchCreate' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['siteSearchEngine'], - pathParams: ['siteSearchEngine'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -59518,53 +62737,9 @@ export namespace discoveryengine_v1alpha { return createAPIRequest(parameters); } } - } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch - extends StandardParameters { /** - * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. - */ - siteSearchEngine?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch - extends StandardParameters { - /** - * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. - */ - siteSearchEngine?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris - extends StandardParameters { - /** - * Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. - */ - siteSearchEngine?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest; - } - - export class Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Creates a Sitemap. + * Creates a TargetSite. * @example * ```js * // Before running the sample: @@ -59597,9 +62772,9 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.siteSearchEngine.sitemaps.create( + * await discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.create( * { - * // Required. Parent resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. + * // Required. Parent resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. * parent: * 'projects/my-project/locations/my-location/dataStores/my-dataStore/siteSearchEngine', * @@ -59607,9 +62782,16 @@ export namespace discoveryengine_v1alpha { * requestBody: { * // request body parameters * // { - * // "createTime": "my_createTime", + * // "exactMatch": false, + * // "failureReason": {}, + * // "generatedUriPattern": "my_generatedUriPattern", + * // "indexingStatus": "my_indexingStatus", * // "name": "my_name", - * // "uri": "my_uri" + * // "providedUriPattern": "my_providedUriPattern", + * // "rootDomainUri": "my_rootDomainUri", + * // "siteVerificationInfo": {}, + * // "type": "my_type", + * // "updateTime": "my_updateTime" * // } * }, * }, @@ -59639,27 +62821,27 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Create, + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, options: StreamMethodOptions ): Promise>; create( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Create, + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, options?: MethodOptions ): Promise>; create( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Create, + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Create, + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Create, + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, callback: BodyResponseCallback ): void; create( @@ -59667,7 +62849,7 @@ export namespace discoveryengine_v1alpha { ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Create + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -59683,13 +62865,13 @@ export namespace discoveryengine_v1alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Create; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Create; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create; options = {}; } @@ -59703,7 +62885,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/sitemaps').replace( + url: (rootUrl + '/v1alpha/{+parent}/targetSites').replace( /([^:]\/)\/+/g, '$1' ), @@ -59728,7 +62910,7 @@ export namespace discoveryengine_v1alpha { } /** - * Deletes a Sitemap. + * Deletes a TargetSite. * @example * ```js * // Before running the sample: @@ -59761,10 +62943,10 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.siteSearchEngine.sitemaps.delete( + * await discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.delete( * { - * // Required. Full resource name of Sitemap, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/sitemaps/{sitemap\}`. If the caller does not have permission to access the Sitemap, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Sitemap does not exist, a NOT_FOUND error is returned. - * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/siteSearchEngine/sitemaps/my-sitemap', + * // Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/siteSearchEngine/targetSites/my-targetSite', * }, * ); * console.log(res.data); @@ -59792,27 +62974,27 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Delete, + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Delete, + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Delete, + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Delete, + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Delete, + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, callback: BodyResponseCallback ): void; delete( @@ -59820,7 +63002,7 @@ export namespace discoveryengine_v1alpha { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Delete + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -59836,13 +63018,13 @@ export namespace discoveryengine_v1alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Delete; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Delete; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete; options = {}; } @@ -59878,7 +63060,7 @@ export namespace discoveryengine_v1alpha { } /** - * Fetch Sitemaps in a DataStore. + * Gets a TargetSite. * @example * ```js * // Before running the sample: @@ -59911,20 +63093,26 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.siteSearchEngine.sitemaps.fetch( + * await discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.get( * { - * // The Sitemap uris. - * 'matcher.urisMatcher.uris': 'placeholder-value', - * // Required. Parent resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. - * parent: - * 'projects/my-project/locations/my-location/dataStores/my-dataStore/siteSearchEngine', + * // Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/siteSearchEngine/targetSites/my-targetSite', * }, * ); * console.log(res.data); * * // Example response * // { - * // "sitemapsMetadata": [] + * // "exactMatch": false, + * // "failureReason": {}, + * // "generatedUriPattern": "my_generatedUriPattern", + * // "indexingStatus": "my_indexingStatus", + * // "name": "my_name", + * // "providedUriPattern": "my_providedUriPattern", + * // "rootDomainUri": "my_rootDomainUri", + * // "siteVerificationInfo": {}, + * // "type": "my_type", + * // "updateTime": "my_updateTime" * // } * } * @@ -59940,62 +63128,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - fetch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Fetch, + get( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, options: StreamMethodOptions ): Promise>; - fetch( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Fetch, + get( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - fetch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Fetch, + get( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - fetch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Fetch, + get( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - fetch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Fetch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, + callback: BodyResponseCallback ): void; - fetch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - fetch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Fetch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Fetch; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Fetch; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get; options = {}; } @@ -60009,72 +63197,31 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/sitemaps:fetch').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Create - extends StandardParameters { - /** - * Required. Parent resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSitemap; - } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Delete - extends StandardParameters { - /** - * Required. Full resource name of Sitemap, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/sitemaps/{sitemap\}`. If the caller does not have permission to access the Sitemap, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Sitemap does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Sitemaps$Fetch - extends StandardParameters { - /** - * The Sitemap uris. - */ - 'matcher.urisMatcher.uris'?: string[]; - /** - * Required. Parent resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. - */ - parent?: string; - } - - export class Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Creates TargetSite in a batch. + * Gets a list of TargetSites. * @example * ```js * // Before running the sample: @@ -60107,30 +63254,24 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.batchCreate( + * await discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.list( * { - * // Required. The parent resource shared by all TargetSites being created. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. The parent field in the CreateBookRequest messages must either be empty or match this field. + * // Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. + * pageSize: 'placeholder-value', + * // A page token, received from a previous `ListTargetSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTargetSites` must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The parent site search engine resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned. * parent: * 'projects/my-project/locations/my-location/dataStores/my-dataStore/siteSearchEngine', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "requests": [] - * // } - * }, * }, * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "targetSites": [], + * // "totalSize": 0 * // } * } * @@ -60146,58 +63287,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchCreate( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, + list( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, options: StreamMethodOptions ): Promise>; - batchCreate( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, + list( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, options?: MethodOptions - ): Promise>; - batchCreate( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, + list( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, + callback: BodyResponseCallback ): void; - batchCreate( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - batchCreate( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List; options = {}; } @@ -60211,10 +63356,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+parent}/targetSites:batchCreate' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1alpha/{+parent}/targetSites').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -60225,17 +63371,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Creates a TargetSite. + * Updates a TargetSite. * @example * ```js * // Before running the sample: @@ -60268,11 +63416,10 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.create( + * await discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.patch( * { - * // Required. Parent resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. - * parent: - * 'projects/my-project/locations/my-location/dataStores/my-dataStore/siteSearchEngine', + * // Output only. The fully qualified resource name of the target site. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}` The `target_site_id` is system-generated. + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/siteSearchEngine/targetSites/my-targetSite', * * // Request body metadata * requestBody: { @@ -60316,36 +63463,36 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, + patch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, + patch( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, options?: MethodOptions ): Promise>; - create( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, + patch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, + patch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, + patch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, callback: BodyResponseCallback ): void; - create( + patch( callback: BodyResponseCallback ): void; - create( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -60361,13 +63508,13 @@ export namespace discoveryengine_v1alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch; options = {}; } @@ -60381,18 +63528,15 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/targetSites').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -60404,9 +63548,82 @@ export namespace discoveryengine_v1alpha { return createAPIRequest(parameters); } } + } + + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate + extends StandardParameters { + /** + * Required. The parent resource shared by all TargetSites being created. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. The parent field in the CreateBookRequest messages must either be empty or match this field. + */ + parent?: string; /** - * Deletes a TargetSite. + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create + extends StandardParameters { + /** + * Required. Parent resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite; + } + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete + extends StandardParameters { + /** + * Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get + extends StandardParameters { + /** + * Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List + extends StandardParameters { + /** + * Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListTargetSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTargetSites` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent site search engine resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch + extends StandardParameters { + /** + * Output only. The fully qualified resource name of the target site. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}` The `target_site_id` is system-generated. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite; + } + + export class Resource$Projects$Locations$Datastores$Suggestiondenylistentries { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Imports all SuggestionDenyListEntry for a DataStore. * @example * ```js * // Before running the sample: @@ -60429,6 +63646,7 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -60439,10 +63657,20 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.delete( + * await discoveryengine.projects.locations.dataStores.suggestionDenyListEntries.import( * { - * // Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. - * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/siteSearchEngine/targetSites/my-targetSite', + * // Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. + * parent: + * 'projects/my-project/locations/my-location/dataStores/my-dataStore', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "gcsSource": {}, + * // "inlineSource": {} + * // } + * }, * }, * ); * console.log(res.data); @@ -60469,36 +63697,36 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, + import( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, + import( + params?: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, + import( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, + import( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, + import( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, callback: BodyResponseCallback ): void; - delete( + import( callback: BodyResponseCallback ): void; - delete( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete + | Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -60514,13 +63742,13 @@ export namespace discoveryengine_v1alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete; + {}) as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete; + {} as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import; options = {}; } @@ -60534,15 +63762,17 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: ( + rootUrl + '/v1alpha/{+parent}/suggestionDenyListEntries:import' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -60556,7 +63786,7 @@ export namespace discoveryengine_v1alpha { } /** - * Gets a TargetSite. + * Permanently deletes all SuggestionDenyListEntry for a DataStore. * @example * ```js * // Before running the sample: @@ -60579,6 +63809,7 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -60589,26 +63820,27 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.get( + * await discoveryengine.projects.locations.dataStores.suggestionDenyListEntries.purge( * { - * // Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. - * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/siteSearchEngine/targetSites/my-targetSite', + * // Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. + * parent: 'projects/my-project/locations/my-location/dataStores/.*', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, * }, * ); * console.log(res.data); * * // Example response * // { - * // "exactMatch": false, - * // "failureReason": {}, - * // "generatedUriPattern": "my_generatedUriPattern", - * // "indexingStatus": "my_indexingStatus", + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "providedUriPattern": "my_providedUriPattern", - * // "rootDomainUri": "my_rootDomainUri", - * // "siteVerificationInfo": {}, - * // "type": "my_type", - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -60624,62 +63856,58 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, + purge( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, + purge( + params?: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, + ): Promise>; + purge( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, + purge( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, - callback: BodyResponseCallback + purge( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + purge( + callback: BodyResponseCallback ): void; - get( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get; + {} as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge; options = {}; } @@ -60693,31 +63921,63 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: ( + rootUrl + '/v1alpha/{+parent}/suggestionDenyListEntries:purge' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import + extends StandardParameters { /** - * Gets a list of TargetSites. + * Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge + extends StandardParameters { + /** + * Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest; + } + + export class Resource$Projects$Locations$Datastores$Userevents { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly. * @example * ```js * // Before running the sample: @@ -60740,6 +64000,7 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -60750,24 +64011,24 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.list( - * { - * // Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. - * pageSize: 'placeholder-value', - * // A page token, received from a previous `ListTargetSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTargetSites` must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The parent site search engine resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned. - * parent: - * 'projects/my-project/locations/my-location/dataStores/my-dataStore/siteSearchEngine', - * }, - * ); + * await discoveryengine.projects.locations.dataStores.userEvents.collect({ + * // The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. + * ets: 'placeholder-value', + * // Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`. + * parent: + * 'projects/my-project/locations/my-location/dataStores/my-dataStore', + * // The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests. + * uri: 'placeholder-value', + * // Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. + * userEvent: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "targetSites": [], - * // "totalSize": 0 + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] * // } * } * @@ -60783,62 +64044,54 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, + collect( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, + collect( + params?: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, + ): Promise>; + collect( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, - callback: BodyResponseCallback + collect( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + collect( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, + callback: BodyResponseCallback ): void; - list( + collect(callback: BodyResponseCallback): void; + collect( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Userevents$Collect + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List; + {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Collect; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List; + {} as Params$Resource$Projects$Locations$Datastores$Userevents$Collect; options = {}; } @@ -60852,7 +64105,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/targetSites').replace( + url: (rootUrl + '/v1alpha/{+parent}/userEvents:collect').replace( /([^:]\/)\/+/g, '$1' ), @@ -60867,19 +64120,17 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a TargetSite. + * Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata. * @example * ```js * // Before running the sample: @@ -60902,6 +64153,7 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -60912,29 +64164,22 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.patch( - * { - * // Output only. The fully qualified resource name of the target site. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}` The `target_site_id` is system-generated. - * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/siteSearchEngine/targetSites/my-targetSite', + * await discoveryengine.projects.locations.dataStores.userEvents.import({ + * // Required. Parent DataStore resource name, of the form `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}` + * parent: + * 'projects/my-project/locations/my-location/dataStores/my-dataStore', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "exactMatch": false, - * // "failureReason": {}, - * // "generatedUriPattern": "my_generatedUriPattern", - * // "indexingStatus": "my_indexingStatus", - * // "name": "my_name", - * // "providedUriPattern": "my_providedUriPattern", - * // "rootDomainUri": "my_rootDomainUri", - * // "siteVerificationInfo": {}, - * // "type": "my_type", - * // "updateTime": "my_updateTime" - * // } - * }, + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bigquerySource": {}, + * // "errorConfig": {}, + * // "gcsSource": {}, + * // "inlineSource": {} + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response @@ -60959,36 +64204,36 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, + import( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, + import( + params?: Params$Resource$Projects$Locations$Datastores$Userevents$Import, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, + import( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, + import( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, + import( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, callback: BodyResponseCallback ): void; - patch( + import( callback: BodyResponseCallback ): void; - patch( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch + | Params$Resource$Projects$Locations$Datastores$Userevents$Import | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -61004,13 +64249,13 @@ export namespace discoveryengine_v1alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Userevents$Import; options = {}; } @@ -61024,15 +64269,18 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1alpha/{+parent}/userEvents:import').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -61044,82 +64292,9 @@ export namespace discoveryengine_v1alpha { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate - extends StandardParameters { - /** - * Required. The parent resource shared by all TargetSites being created. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. The parent field in the CreateBookRequest messages must either be empty or match this field. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create - extends StandardParameters { - /** - * Required. Parent resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite; - } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete - extends StandardParameters { - /** - * Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get - extends StandardParameters { - /** - * Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List - extends StandardParameters { - /** - * Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListTargetSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTargetSites` must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The parent site search engine resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch - extends StandardParameters { - /** - * Output only. The fully qualified resource name of the target site. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}` The `target_site_id` is system-generated. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite; - } - - export class Resource$Projects$Locations$Datastores$Suggestiondenylistentries { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Imports all SuggestionDenyListEntry for a DataStore. + * Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first. * @example * ```js * // Before running the sample: @@ -61153,22 +64328,20 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.suggestionDenyListEntries.import( - * { - * // Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. - * parent: - * 'projects/my-project/locations/my-location/dataStores/my-dataStore', + * await discoveryengine.projects.locations.dataStores.userEvents.purge({ + * // Required. The resource name of the catalog under which the events are created. The format is `projects/{project\}/locations/global/collections/{collection\}/dataStores/{dataStore\}`. + * parent: + * 'projects/my-project/locations/my-location/dataStores/my-dataStore', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "gcsSource": {}, - * // "inlineSource": {} - * // } - * }, + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "filter": "my_filter", + * // "force": false + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response @@ -61193,36 +64366,36 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, + purge( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, options: StreamMethodOptions ): Promise>; - import( - params?: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, + purge( + params?: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, options?: MethodOptions ): Promise>; - import( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, + purge( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, + purge( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, + purge( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, callback: BodyResponseCallback ): void; - import( + purge( callback: BodyResponseCallback ): void; - import( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import + | Params$Resource$Projects$Locations$Datastores$Userevents$Purge | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -61238,13 +64411,13 @@ export namespace discoveryengine_v1alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import; + {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import; + {} as Params$Resource$Projects$Locations$Datastores$Userevents$Purge; options = {}; } @@ -61258,9 +64431,10 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+parent}/suggestionDenyListEntries:import' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+parent}/userEvents:purge').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, @@ -61282,7 +64456,7 @@ export namespace discoveryengine_v1alpha { } /** - * Permanently deletes all SuggestionDenyListEntry for a DataStore. + * Writes a single user event. * @example * ```js * // Before running the sample: @@ -61316,27 +64490,68 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.suggestionDenyListEntries.purge( - * { - * // Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. - * parent: 'projects/my-project/locations/my-location/dataStores/.*', + * await discoveryengine.projects.locations.dataStores.userEvents.write({ + * // Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`. + * parent: + * 'projects/my-project/locations/my-location/dataStores/my-dataStore', + * // If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. + * writeAsync: 'placeholder-value', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "attributes": {}, + * // "attributionToken": "my_attributionToken", + * // "completionInfo": {}, + * // "conversionType": "my_conversionType", + * // "dataStore": "my_dataStore", + * // "directUserRequest": false, + * // "documents": [], + * // "engine": "my_engine", + * // "eventTime": "my_eventTime", + * // "eventType": "my_eventType", + * // "filter": "my_filter", + * // "mediaInfo": {}, + * // "pageInfo": {}, + * // "panel": {}, + * // "panels": [], + * // "promotionIds": [], + * // "searchInfo": {}, + * // "sessionId": "my_sessionId", + * // "tagIds": [], + * // "transactionInfo": {}, + * // "userInfo": {}, + * // "userPseudoId": "my_userPseudoId" + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "attributes": {}, + * // "attributionToken": "my_attributionToken", + * // "completionInfo": {}, + * // "conversionType": "my_conversionType", + * // "dataStore": "my_dataStore", + * // "directUserRequest": false, + * // "documents": [], + * // "engine": "my_engine", + * // "eventTime": "my_eventTime", + * // "eventType": "my_eventType", + * // "filter": "my_filter", + * // "mediaInfo": {}, + * // "pageInfo": {}, + * // "panel": {}, + * // "panels": [], + * // "promotionIds": [], + * // "searchInfo": {}, + * // "sessionId": "my_sessionId", + * // "tagIds": [], + * // "transactionInfo": {}, + * // "userInfo": {}, + * // "userPseudoId": "my_userPseudoId" * // } * } * @@ -61352,58 +64567,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, + write( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, options: StreamMethodOptions ): Promise>; - purge( - params?: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, + write( + params?: Params$Resource$Projects$Locations$Datastores$Userevents$Write, options?: MethodOptions - ): Promise>; - purge( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, + ): Promise< + GaxiosResponseWithHTTP2 + >; + write( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, + write( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purge( - callback: BodyResponseCallback + write( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, + callback: BodyResponseCallback ): void; - purge( + write( + callback: BodyResponseCallback + ): void; + write( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Userevents$Write + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge; + {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Write; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge; + {} as Params$Resource$Projects$Locations$Datastores$Userevents$Write; options = {}; } @@ -61417,9 +64636,10 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+parent}/suggestionDenyListEntries:purge' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+parent}/userEvents:write').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, @@ -61431,49 +64651,86 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import + export interface Params$Resource$Projects$Locations$Datastores$Userevents$Collect extends StandardParameters { /** - * Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. + * The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. + */ + ets?: string; + /** + * Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`. + */ + parent?: string; + /** + * The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests. + */ + uri?: string; + /** + * Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. + */ + userEvent?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Userevents$Import + extends StandardParameters { + /** + * Required. Parent DataStore resource name, of the form `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest; } - export interface Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge + export interface Params$Resource$Projects$Locations$Datastores$Userevents$Purge extends StandardParameters { /** - * Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. + * Required. The resource name of the catalog under which the events are created. The format is `projects/{project\}/locations/global/collections/{collection\}/dataStores/{dataStore\}`. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest; } + export interface Params$Resource$Projects$Locations$Datastores$Userevents$Write + extends StandardParameters { + /** + * Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`. + */ + parent?: string; + /** + * If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. + */ + writeAsync?: boolean; - export class Resource$Projects$Locations$Datastores$Userevents { + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaUserEvent; + } + + export class Resource$Projects$Locations$Datastores$Widgetconfigs { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly. + * Gets a WidgetConfig. * @example * ```js * // Before running the sample: @@ -61507,24 +64764,56 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.dataStores.userEvents.collect({ - * // The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. - * ets: 'placeholder-value', - * // Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`. - * parent: - * 'projects/my-project/locations/my-location/dataStores/my-dataStore', - * // The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests. - * uri: 'placeholder-value', - * // Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. - * userEvent: 'placeholder-value', + * await discoveryengine.projects.locations.dataStores.widgetConfigs.get({ + * // Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development. + * acceptCache: 'placeholder-value', + * // Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission. + * 'getWidgetConfigRequestOption.turnOffCollectionComponents': + * 'placeholder-value', + * // Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}` + * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/widgetConfigs/my-widgetConfig', * }); * console.log(res.data); * * // Example response * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] + * // "accessSettings": {}, + * // "allowPublicAccess": false, + * // "allowlistedDomains": [], + * // "assistantSettings": {}, + * // "collectionComponents": [], + * // "configId": "my_configId", + * // "contentSearchSpec": {}, + * // "createTime": "my_createTime", + * // "customerProvidedConfig": {}, + * // "dataStoreType": "my_dataStoreType", + * // "dataStoreUiConfigs": [], + * // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy", + * // "displayName": "my_displayName", + * // "enableAutocomplete": false, + * // "enableConversationalSearch": false, + * // "enablePrivateKnowledgeGraph": false, + * // "enableQualityFeedback": false, + * // "enableResultScore": false, + * // "enableSafeSearch": false, + * // "enableSearchAsYouType": false, + * // "enableSnippetResultSummary": false, + * // "enableSummarization": false, + * // "enableWebApp": false, + * // "experimentalFeatures": {}, + * // "facetField": [], + * // "fieldsUiComponentsMap": {}, + * // "geminiBundle": false, + * // "homepageSetting": {}, + * // "industryVertical": "my_industryVertical", + * // "llmEnabled": false, + * // "minimumDataTermAccepted": false, + * // "name": "my_name", + * // "resultDisplayType": "my_resultDisplayType", + * // "solutionType": "my_solutionType", + * // "uiBranding": {}, + * // "uiSettings": {}, + * // "updateTime": "my_updateTime" * // } * } * @@ -61540,54 +64829,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - collect( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, + get( + params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get, options: StreamMethodOptions ): Promise>; - collect( - params?: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, + get( + params?: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get, options?: MethodOptions - ): Promise>; - collect( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - collect( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - collect( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get, + callback: BodyResponseCallback ): void; - collect(callback: BodyResponseCallback): void; - collect( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Userevents$Collect - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Collect; + {}) as Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Userevents$Collect; + {} as Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get; options = {}; } @@ -61601,32 +64898,58 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/userEvents:collect').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get + extends StandardParameters { /** - * Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata. + * Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development. + */ + acceptCache?: boolean; + /** + * Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission. + */ + 'getWidgetConfigRequestOption.turnOffCollectionComponents'?: boolean; + /** + * Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}` + */ + name?: string; + } + + export class Resource$Projects$Locations$Evaluations { + context: APIRequestContext; + operations: Resource$Projects$Locations$Evaluations$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Projects$Locations$Evaluations$Operations( + this.context + ); + } + + /** + * Creates a Evaluation. Upon creation, the evaluation will be automatically triggered and begin execution. * @example * ```js * // Before running the sample: @@ -61649,7 +64972,6 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -61659,23 +64981,25 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await discoveryengine.projects.locations.dataStores.userEvents.import({ - * // Required. Parent DataStore resource name, of the form `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}` - * parent: - * 'projects/my-project/locations/my-location/dataStores/my-dataStore', + * const res = await discoveryengine.projects.locations.evaluations.create({ + * // Required. The parent resource name, such as `projects/{project\}/locations/{location\}`. + * parent: 'projects/my-project/locations/my-location', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "bigquerySource": {}, - * // "errorConfig": {}, - * // "gcsSource": {}, - * // "inlineSource": {} - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "endTime": "my_endTime", + * // "error": {}, + * // "errorSamples": [], + * // "evaluationSpec": {}, + * // "name": "my_name", + * // "qualityMetrics": {}, + * // "state": "my_state" + * // } + * }, + * }); * console.log(res.data); * * // Example response @@ -61700,36 +65024,36 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, + create( + params: Params$Resource$Projects$Locations$Evaluations$Create, options: StreamMethodOptions ): Promise>; - import( - params?: Params$Resource$Projects$Locations$Datastores$Userevents$Import, + create( + params?: Params$Resource$Projects$Locations$Evaluations$Create, options?: MethodOptions ): Promise>; - import( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, + create( + params: Params$Resource$Projects$Locations$Evaluations$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, + create( + params: Params$Resource$Projects$Locations$Evaluations$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, + create( + params: Params$Resource$Projects$Locations$Evaluations$Create, callback: BodyResponseCallback ): void; - import( + create( callback: BodyResponseCallback ): void; - import( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Userevents$Import + | Params$Resource$Projects$Locations$Evaluations$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -61745,13 +65069,12 @@ export namespace discoveryengine_v1alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Import; + {}) as Params$Resource$Projects$Locations$Evaluations$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Userevents$Import; + params = {} as Params$Resource$Projects$Locations$Evaluations$Create; options = {}; } @@ -61765,7 +65088,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/userEvents:import').replace( + url: (rootUrl + '/v1alpha/{+parent}/evaluations').replace( /([^:]\/)\/+/g, '$1' ), @@ -61790,7 +65113,7 @@ export namespace discoveryengine_v1alpha { } /** - * Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first. + * Gets a Evaluation. * @example * ```js * // Before running the sample: @@ -61813,7 +65136,6 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -61823,30 +65145,22 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await discoveryengine.projects.locations.dataStores.userEvents.purge({ - * // Required. The resource name of the catalog under which the events are created. The format is `projects/{project\}/locations/global/collections/{collection\}/dataStores/{dataStore\}`. - * parent: - * 'projects/my-project/locations/my-location/dataStores/my-dataStore', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "filter": "my_filter", - * // "force": false - * // } - * }, - * }); + * const res = await discoveryengine.projects.locations.evaluations.get({ + * // Required. Full resource name of Evaluation, such as `projects/{project\}/locations/{location\}/evaluations/{evaluation\}`. If the caller does not have permission to access the Evaluation, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Evaluation does not exist, a NOT_FOUND error is returned. + * name: 'projects/my-project/locations/my-location/evaluations/my-evaluation', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, + * // "createTime": "my_createTime", + * // "endTime": "my_endTime", * // "error": {}, - * // "metadata": {}, + * // "errorSamples": [], + * // "evaluationSpec": {}, * // "name": "my_name", - * // "response": {} + * // "qualityMetrics": {}, + * // "state": "my_state" * // } * } * @@ -61862,58 +65176,61 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, + get( + params: Params$Resource$Projects$Locations$Evaluations$Get, options: StreamMethodOptions ): Promise>; - purge( - params?: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, + get( + params?: Params$Resource$Projects$Locations$Evaluations$Get, options?: MethodOptions - ): Promise>; - purge( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Evaluations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, + get( + params: Params$Resource$Projects$Locations$Evaluations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Evaluations$Get, + callback: BodyResponseCallback ): void; - purge( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - purge( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Userevents$Purge - | BodyResponseCallback + | Params$Resource$Projects$Locations$Evaluations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Purge; + {}) as Params$Resource$Projects$Locations$Evaluations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Userevents$Purge; + params = {} as Params$Resource$Projects$Locations$Evaluations$Get; options = {}; } @@ -61927,32 +65244,31 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/userEvents:purge').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Writes a single user event. + * Gets a list of Evaluations. * @example * ```js * // Before running the sample: @@ -61975,7 +65291,6 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -61985,69 +65300,20 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await discoveryengine.projects.locations.dataStores.userEvents.write({ - * // Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`. - * parent: - * 'projects/my-project/locations/my-location/dataStores/my-dataStore', - * // If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. - * writeAsync: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "attributes": {}, - * // "attributionToken": "my_attributionToken", - * // "completionInfo": {}, - * // "conversionType": "my_conversionType", - * // "dataStore": "my_dataStore", - * // "directUserRequest": false, - * // "documents": [], - * // "engine": "my_engine", - * // "eventTime": "my_eventTime", - * // "eventType": "my_eventType", - * // "filter": "my_filter", - * // "mediaInfo": {}, - * // "pageInfo": {}, - * // "panel": {}, - * // "panels": [], - * // "promotionIds": [], - * // "searchInfo": {}, - * // "sessionId": "my_sessionId", - * // "tagIds": [], - * // "transactionInfo": {}, - * // "userInfo": {}, - * // "userPseudoId": "my_userPseudoId" - * // } - * }, - * }); + * const res = await discoveryengine.projects.locations.evaluations.list({ + * // Optional. Maximum number of Evaluations to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + * pageSize: 'placeholder-value', + * // Optional. A page token ListEvaluationsResponse.next_page_token, received from a previous EvaluationService.ListEvaluations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluations must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + * pageToken: 'placeholder-value', + * // Required. The parent location resource name, such as `projects/{project\}/locations/{location\}`. If the caller does not have permission to list Evaluations under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned. + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { - * // "attributes": {}, - * // "attributionToken": "my_attributionToken", - * // "completionInfo": {}, - * // "conversionType": "my_conversionType", - * // "dataStore": "my_dataStore", - * // "directUserRequest": false, - * // "documents": [], - * // "engine": "my_engine", - * // "eventTime": "my_eventTime", - * // "eventType": "my_eventType", - * // "filter": "my_filter", - * // "mediaInfo": {}, - * // "pageInfo": {}, - * // "panel": {}, - * // "panels": [], - * // "promotionIds": [], - * // "searchInfo": {}, - * // "sessionId": "my_sessionId", - * // "tagIds": [], - * // "transactionInfo": {}, - * // "userInfo": {}, - * // "userPseudoId": "my_userPseudoId" + * // "evaluations": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -62063,62 +65329,61 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - write( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, + list( + params: Params$Resource$Projects$Locations$Evaluations$List, options: StreamMethodOptions ): Promise>; - write( - params?: Params$Resource$Projects$Locations$Datastores$Userevents$Write, + list( + params?: Params$Resource$Projects$Locations$Evaluations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - write( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, + list( + params: Params$Resource$Projects$Locations$Evaluations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - write( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, + list( + params: Params$Resource$Projects$Locations$Evaluations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - write( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Evaluations$List, + callback: BodyResponseCallback ): void; - write( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - write( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Userevents$Write - | BodyResponseCallback + | Params$Resource$Projects$Locations$Evaluations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Write; + {}) as Params$Resource$Projects$Locations$Evaluations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Userevents$Write; + params = {} as Params$Resource$Projects$Locations$Evaluations$List; options = {}; } @@ -62132,11 +65397,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/userEvents:write').replace( + url: (rootUrl + '/v1alpha/{+parent}/evaluations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -62147,86 +65412,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Datastores$Userevents$Collect - extends StandardParameters { - /** - * The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. - */ - ets?: string; - /** - * Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`. - */ - parent?: string; - /** - * The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests. - */ - uri?: string; - /** - * Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. - */ - userEvent?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Userevents$Import - extends StandardParameters { - /** - * Required. Parent DataStore resource name, of the form `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Userevents$Purge - extends StandardParameters { - /** - * Required. The resource name of the catalog under which the events are created. The format is `projects/{project\}/locations/global/collections/{collection\}/dataStores/{dataStore\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Userevents$Write - extends StandardParameters { - /** - * Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`. - */ - parent?: string; - /** - * If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. - */ - writeAsync?: boolean; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaUserEvent; - } - - export class Resource$Projects$Locations$Datastores$Widgetconfigs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Gets a WidgetConfig. + * Gets a list of results for a given a Evaluation. * @example * ```js * // Before running the sample: @@ -62249,7 +65447,6 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -62259,56 +65456,21 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await discoveryengine.projects.locations.dataStores.widgetConfigs.get({ - * // Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development. - * acceptCache: 'placeholder-value', - * // Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission. - * 'getWidgetConfigRequestOption.turnOffCollectionComponents': - * 'placeholder-value', - * // Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}` - * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/widgetConfigs/my-widgetConfig', - * }); + * const res = await discoveryengine.projects.locations.evaluations.listResults({ + * // Required. The evaluation resource name, such as `projects/{project\}/locations/{location\}/evaluations/{evaluation\}`. If the caller does not have permission to list ListEvaluationResultsResponse.EvaluationResult under this evaluation, regardless of whether or not this evaluation set exists, a `PERMISSION_DENIED` error is returned. + * evaluation: + * 'projects/my-project/locations/my-location/evaluations/my-evaluation', + * // Optional. Maximum number of ListEvaluationResultsResponse.EvaluationResult to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + * pageSize: 'placeholder-value', + * // Optional. A page token ListEvaluationResultsResponse.next_page_token, received from a previous EvaluationService.ListEvaluationResults call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluationResults must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + * pageToken: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "accessSettings": {}, - * // "allowPublicAccess": false, - * // "allowlistedDomains": [], - * // "assistantSettings": {}, - * // "collectionComponents": [], - * // "configId": "my_configId", - * // "contentSearchSpec": {}, - * // "createTime": "my_createTime", - * // "customerProvidedConfig": {}, - * // "dataStoreType": "my_dataStoreType", - * // "dataStoreUiConfigs": [], - * // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy", - * // "displayName": "my_displayName", - * // "enableAutocomplete": false, - * // "enableConversationalSearch": false, - * // "enablePrivateKnowledgeGraph": false, - * // "enableQualityFeedback": false, - * // "enableResultScore": false, - * // "enableSafeSearch": false, - * // "enableSearchAsYouType": false, - * // "enableSnippetResultSummary": false, - * // "enableSummarization": false, - * // "enableWebApp": false, - * // "experimentalFeatures": {}, - * // "facetField": [], - * // "fieldsUiComponentsMap": {}, - * // "homepageSetting": {}, - * // "industryVertical": "my_industryVertical", - * // "llmEnabled": false, - * // "minimumDataTermAccepted": false, - * // "name": "my_name", - * // "resultDisplayType": "my_resultDisplayType", - * // "solutionType": "my_solutionType", - * // "uiBranding": {}, - * // "uiSettings": {}, - * // "updateTime": "my_updateTime" + * // "evaluationResults": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -62324,62 +65486,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get, + listResults( + params: Params$Resource$Projects$Locations$Evaluations$Listresults, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get, + listResults( + params?: Params$Resource$Projects$Locations$Evaluations$Listresults, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get, + listResults( + params: Params$Resource$Projects$Locations$Evaluations$Listresults, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get, + listResults( + params: Params$Resource$Projects$Locations$Evaluations$Listresults, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get, - callback: BodyResponseCallback + listResults( + params: Params$Resource$Projects$Locations$Evaluations$Listresults, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + listResults( + callback: BodyResponseCallback ): void; - get( + listResults( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Evaluations$Listresults + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get; + {}) as Params$Resource$Projects$Locations$Evaluations$Listresults; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get; + {} as Params$Resource$Projects$Locations$Evaluations$Listresults; options = {}; } @@ -62393,58 +65555,91 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+evaluation}:listResults').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['evaluation'], + pathParams: ['evaluation'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get + export interface Params$Resource$Projects$Locations$Evaluations$Create extends StandardParameters { /** - * Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development. + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}`. */ - acceptCache?: boolean; + parent?: string; + /** - * Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission. + * Request body metadata */ - 'getWidgetConfigRequestOption.turnOffCollectionComponents'?: boolean; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEvaluation; + } + export interface Params$Resource$Projects$Locations$Evaluations$Get + extends StandardParameters { /** - * Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}` + * Required. Full resource name of Evaluation, such as `projects/{project\}/locations/{location\}/evaluations/{evaluation\}`. If the caller does not have permission to access the Evaluation, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Evaluation does not exist, a NOT_FOUND error is returned. */ name?: string; } + export interface Params$Resource$Projects$Locations$Evaluations$List + extends StandardParameters { + /** + * Optional. Maximum number of Evaluations to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + */ + pageSize?: number; + /** + * Optional. A page token ListEvaluationsResponse.next_page_token, received from a previous EvaluationService.ListEvaluations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluations must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + pageToken?: string; + /** + * Required. The parent location resource name, such as `projects/{project\}/locations/{location\}`. If the caller does not have permission to list Evaluations under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Evaluations$Listresults + extends StandardParameters { + /** + * Required. The evaluation resource name, such as `projects/{project\}/locations/{location\}/evaluations/{evaluation\}`. If the caller does not have permission to list ListEvaluationResultsResponse.EvaluationResult under this evaluation, regardless of whether or not this evaluation set exists, a `PERMISSION_DENIED` error is returned. + */ + evaluation?: string; + /** + * Optional. Maximum number of ListEvaluationResultsResponse.EvaluationResult to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + */ + pageSize?: number; + /** + * Optional. A page token ListEvaluationResultsResponse.next_page_token, received from a previous EvaluationService.ListEvaluationResults call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluationResults must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + pageToken?: string; + } - export class Resource$Projects$Locations$Evaluations { + export class Resource$Projects$Locations$Evaluations$Operations { context: APIRequestContext; - operations: Resource$Projects$Locations$Evaluations$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = new Resource$Projects$Locations$Evaluations$Operations( - this.context - ); } /** - * Creates a Evaluation. Upon creation, the evaluation will be automatically triggered and begin execution. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -62476,25 +65671,11 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.evaluations.create({ - * // Required. The parent resource name, such as `projects/{project\}/locations/{location\}`. - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "endTime": "my_endTime", - * // "error": {}, - * // "errorSamples": [], - * // "evaluationSpec": {}, - * // "name": "my_name", - * // "qualityMetrics": {}, - * // "state": "my_state" - * // } - * }, - * }); + * const res = + * await discoveryengine.projects.locations.evaluations.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/evaluations/my-evaluation/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -62519,36 +65700,36 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Evaluations$Create, + get( + params: Params$Resource$Projects$Locations$Evaluations$Operations$Get, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Evaluations$Create, + get( + params?: Params$Resource$Projects$Locations$Evaluations$Operations$Get, options?: MethodOptions ): Promise>; - create( - params: Params$Resource$Projects$Locations$Evaluations$Create, + get( + params: Params$Resource$Projects$Locations$Evaluations$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Evaluations$Create, + get( + params: Params$Resource$Projects$Locations$Evaluations$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Evaluations$Create, + get( + params: Params$Resource$Projects$Locations$Evaluations$Operations$Get, callback: BodyResponseCallback ): void; - create( + get( callback: BodyResponseCallback ): void; - create( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Evaluations$Create + | Params$Resource$Projects$Locations$Evaluations$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -62564,12 +65745,13 @@ export namespace discoveryengine_v1alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Evaluations$Create; + {}) as Params$Resource$Projects$Locations$Evaluations$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Evaluations$Create; + params = + {} as Params$Resource$Projects$Locations$Evaluations$Operations$Get; options = {}; } @@ -62583,18 +65765,15 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/evaluations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -62606,9 +65785,24 @@ export namespace discoveryengine_v1alpha { return createAPIRequest(parameters); } } + } + + export interface Params$Resource$Projects$Locations$Evaluations$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + + export class Resource$Projects$Locations$Groundingconfigs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Gets a Evaluation. + * Performs a grounding check. * @example * ```js * // Before running the sample: @@ -62640,22 +65834,30 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.evaluations.get({ - * // Required. Full resource name of Evaluation, such as `projects/{project\}/locations/{location\}/evaluations/{evaluation\}`. If the caller does not have permission to access the Evaluation, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Evaluation does not exist, a NOT_FOUND error is returned. - * name: 'projects/my-project/locations/my-location/evaluations/my-evaluation', + * const res = await discoveryengine.projects.locations.groundingConfigs.check({ + * // Required. The resource name of the grounding config, such as `projects/x/locations/global/groundingConfigs/default_grounding_config`. + * groundingConfig: + * 'projects/my-project/locations/my-location/groundingConfigs/my-groundingConfig', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "answerCandidate": "my_answerCandidate", + * // "facts": [], + * // "groundingSpec": {}, + * // "userLabels": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "endTime": "my_endTime", - * // "error": {}, - * // "errorSamples": [], - * // "evaluationSpec": {}, - * // "name": "my_name", - * // "qualityMetrics": {}, - * // "state": "my_state" + * // "citedChunks": [], + * // "citedFacts": [], + * // "claims": [], + * // "supportScore": {} * // } * } * @@ -62671,61 +65873,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Evaluations$Get, + check( + params: Params$Resource$Projects$Locations$Groundingconfigs$Check, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Evaluations$Get, + check( + params?: Params$Resource$Projects$Locations$Groundingconfigs$Check, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Evaluations$Get, + check( + params: Params$Resource$Projects$Locations$Groundingconfigs$Check, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Evaluations$Get, + check( + params: Params$Resource$Projects$Locations$Groundingconfigs$Check, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Evaluations$Get, - callback: BodyResponseCallback + check( + params: Params$Resource$Projects$Locations$Groundingconfigs$Check, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + check( + callback: BodyResponseCallback ): void; - get( + check( paramsOrCallback?: - | Params$Resource$Projects$Locations$Evaluations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Groundingconfigs$Check + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Evaluations$Get; + {}) as Params$Resource$Projects$Locations$Groundingconfigs$Check; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Evaluations$Get; + params = + {} as Params$Resource$Projects$Locations$Groundingconfigs$Check; options = {}; } @@ -62739,31 +65942,59 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+groundingConfig}:check').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['groundingConfig'], + pathParams: ['groundingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + + export interface Params$Resource$Projects$Locations$Groundingconfigs$Check + extends StandardParameters { + /** + * Required. The resource name of the grounding config, such as `projects/x/locations/global/groundingConfigs/default_grounding_config`. + */ + groundingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest; + } + + export class Resource$Projects$Locations$Identitymappingstores { + context: APIRequestContext; + operations: Resource$Projects$Locations$Identitymappingstores$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Identitymappingstores$Operations( + this.context + ); + } /** - * Gets a list of Evaluations. + * Creates a new Identity Mapping Store. * @example * ```js * // Before running the sample: @@ -62795,20 +66026,36 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.evaluations.list({ - * // Optional. Maximum number of Evaluations to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. - * pageSize: 'placeholder-value', - * // Optional. A page token ListEvaluationsResponse.next_page_token, received from a previous EvaluationService.ListEvaluations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluations must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. - * pageToken: 'placeholder-value', - * // Required. The parent location resource name, such as `projects/{project\}/locations/{location\}`. If the caller does not have permission to list Evaluations under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned. - * parent: 'projects/my-project/locations/my-location', - * }); + * const res = + * await discoveryengine.projects.locations.identityMappingStores.create({ + * // Resource name of the CmekConfig to use for protecting this Identity Mapping Store. + * cmekConfigName: 'placeholder-value', + * // Identity Mapping Store without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well. + * disableCmek: 'placeholder-value', + * // Required. The ID of the Identity Mapping Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters. + * identityMappingStoreId: 'placeholder-value', + * // Required. The parent collection resource name, such as `projects/{project\}/locations/{location\}`. + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "cmekConfig": {}, + * // "idpConfig": {}, + * // "kmsKeyName": "my_kmsKeyName", + * // "name": "my_name" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "evaluations": [], - * // "nextPageToken": "my_nextPageToken" + * // "cmekConfig": {}, + * // "idpConfig": {}, + * // "kmsKeyName": "my_kmsKeyName", + * // "name": "my_name" * // } * } * @@ -62823,62 +66070,63 @@ export namespace discoveryengine_v1alpha { * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. - */ - list( - params: Params$Resource$Projects$Locations$Evaluations$List, + */ + create( + params: Params$Resource$Projects$Locations$Identitymappingstores$Create, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Evaluations$List, + create( + params?: Params$Resource$Projects$Locations$Identitymappingstores$Create, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Evaluations$List, + create( + params: Params$Resource$Projects$Locations$Identitymappingstores$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Evaluations$List, + create( + params: Params$Resource$Projects$Locations$Identitymappingstores$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Evaluations$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Identitymappingstores$Create, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - list( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Evaluations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Identitymappingstores$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Evaluations$List; + {}) as Params$Resource$Projects$Locations$Identitymappingstores$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Evaluations$List; + params = + {} as Params$Resource$Projects$Locations$Identitymappingstores$Create; options = {}; } @@ -62892,11 +66140,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/evaluations').replace( + url: (rootUrl + '/v1alpha/{+parent}/identityMappingStores').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -62907,19 +66155,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets a list of results for a given a Evaluation. + * Deletes the Identity Mapping Store. * @example * ```js * // Before running the sample: @@ -62951,21 +66199,20 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.evaluations.listResults({ - * // Required. The evaluation resource name, such as `projects/{project\}/locations/{location\}/evaluations/{evaluation\}`. If the caller does not have permission to list ListEvaluationResultsResponse.EvaluationResult under this evaluation, regardless of whether or not this evaluation set exists, a `PERMISSION_DENIED` error is returned. - * evaluation: - * 'projects/my-project/locations/my-location/evaluations/my-evaluation', - * // Optional. Maximum number of ListEvaluationResultsResponse.EvaluationResult to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. - * pageSize: 'placeholder-value', - * // Optional. A page token ListEvaluationResultsResponse.next_page_token, received from a previous EvaluationService.ListEvaluationResults call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluationResults must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. - * pageToken: 'placeholder-value', - * }); + * const res = + * await discoveryengine.projects.locations.identityMappingStores.delete({ + * // Required. The name of the Identity Mapping Store to delete. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}` + * name: 'projects/my-project/locations/my-location/identityMappingStores/my-identityMappingStore', + * }); * console.log(res.data); * * // Example response * // { - * // "evaluationResults": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -62981,62 +66228,58 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listResults( - params: Params$Resource$Projects$Locations$Evaluations$Listresults, + delete( + params: Params$Resource$Projects$Locations$Identitymappingstores$Delete, options: StreamMethodOptions ): Promise>; - listResults( - params?: Params$Resource$Projects$Locations$Evaluations$Listresults, + delete( + params?: Params$Resource$Projects$Locations$Identitymappingstores$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - listResults( - params: Params$Resource$Projects$Locations$Evaluations$Listresults, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Identitymappingstores$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listResults( - params: Params$Resource$Projects$Locations$Evaluations$Listresults, + delete( + params: Params$Resource$Projects$Locations$Identitymappingstores$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listResults( - params: Params$Resource$Projects$Locations$Evaluations$Listresults, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Identitymappingstores$Delete, + callback: BodyResponseCallback ): void; - listResults( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - listResults( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Evaluations$Listresults - | BodyResponseCallback + | Params$Resource$Projects$Locations$Identitymappingstores$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Evaluations$Listresults; + {}) as Params$Resource$Projects$Locations$Identitymappingstores$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Evaluations$Listresults; + {} as Params$Resource$Projects$Locations$Identitymappingstores$Delete; options = {}; } @@ -63050,91 +66293,29 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+evaluation}:listResults').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['evaluation'], - pathParams: ['evaluation'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Evaluations$Create - extends StandardParameters { - /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEvaluation; - } - export interface Params$Resource$Projects$Locations$Evaluations$Get - extends StandardParameters { - /** - * Required. Full resource name of Evaluation, such as `projects/{project\}/locations/{location\}/evaluations/{evaluation\}`. If the caller does not have permission to access the Evaluation, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Evaluation does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Evaluations$List - extends StandardParameters { - /** - * Optional. Maximum number of Evaluations to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. - */ - pageSize?: number; - /** - * Optional. A page token ListEvaluationsResponse.next_page_token, received from a previous EvaluationService.ListEvaluations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluations must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. - */ - pageToken?: string; - /** - * Required. The parent location resource name, such as `projects/{project\}/locations/{location\}`. If the caller does not have permission to list Evaluations under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Evaluations$Listresults - extends StandardParameters { - /** - * Required. The evaluation resource name, such as `projects/{project\}/locations/{location\}/evaluations/{evaluation\}`. If the caller does not have permission to list ListEvaluationResultsResponse.EvaluationResult under this evaluation, regardless of whether or not this evaluation set exists, a `PERMISSION_DENIED` error is returned. - */ - evaluation?: string; - /** - * Optional. Maximum number of ListEvaluationResultsResponse.EvaluationResult to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. - */ - pageSize?: number; - /** - * Optional. A page token ListEvaluationResultsResponse.next_page_token, received from a previous EvaluationService.ListEvaluationResults call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluationResults must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. - */ - pageToken?: string; - } - - export class Resource$Projects$Locations$Evaluations$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Gets the Identity Mapping Store. * @example * ```js * // Before running the sample: @@ -63167,19 +66348,18 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.evaluations.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/evaluations/my-evaluation/operations/my-operation', + * await discoveryengine.projects.locations.identityMappingStores.get({ + * // Required. The name of the Identity Mapping Store to get. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}` + * name: 'projects/my-project/locations/my-location/identityMappingStores/my-identityMappingStore', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "cmekConfig": {}, + * // "idpConfig": {}, + * // "kmsKeyName": "my_kmsKeyName", + * // "name": "my_name" * // } * } * @@ -63196,57 +66376,61 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Evaluations$Operations$Get, + params: Params$Resource$Projects$Locations$Identitymappingstores$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Evaluations$Operations$Get, + params?: Params$Resource$Projects$Locations$Identitymappingstores$Get, options?: MethodOptions - ): Promise>; + ): Promise< + GaxiosResponseWithHTTP2 + >; get( - params: Params$Resource$Projects$Locations$Evaluations$Operations$Get, + params: Params$Resource$Projects$Locations$Identitymappingstores$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Evaluations$Operations$Get, + params: Params$Resource$Projects$Locations$Identitymappingstores$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Evaluations$Operations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Identitymappingstores$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Evaluations$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Identitymappingstores$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Evaluations$Operations$Get; + {}) as Params$Resource$Projects$Locations$Identitymappingstores$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Evaluations$Operations$Get; + {} as Params$Resource$Projects$Locations$Identitymappingstores$Get; options = {}; } @@ -63272,32 +66456,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Projects$Locations$Evaluations$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - - export class Resource$Projects$Locations$Groundingconfigs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Performs a grounding check. + * Imports a list of Identity Mapping Entries to an Identity Mapping Store. * @example * ```js * // Before running the sample: @@ -63329,30 +66500,31 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.groundingConfigs.check({ - * // Required. The resource name of the grounding config, such as `projects/x/locations/global/groundingConfigs/default_grounding_config`. - * groundingConfig: - * 'projects/my-project/locations/my-location/groundingConfigs/my-groundingConfig', + * const res = + * await discoveryengine.projects.locations.identityMappingStores.importIdentityMappings( + * { + * // Required. The name of the Identity Mapping Store to import Identity Mapping Entries to. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}` + * identityMappingStore: + * 'projects/my-project/locations/my-location/identityMappingStores/my-identityMappingStore', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "answerCandidate": "my_answerCandidate", - * // "facts": [], - * // "groundingSpec": {}, - * // "userLabels": {} - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "inlineSource": {} + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "citedChunks": [], - * // "citedFacts": [], - * // "claims": [], - * // "supportScore": {} + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -63368,62 +66540,58 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - check( - params: Params$Resource$Projects$Locations$Groundingconfigs$Check, + importIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings, options: StreamMethodOptions ): Promise>; - check( - params?: Params$Resource$Projects$Locations$Groundingconfigs$Check, + importIdentityMappings( + params?: Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - check( - params: Params$Resource$Projects$Locations$Groundingconfigs$Check, + ): Promise>; + importIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - check( - params: Params$Resource$Projects$Locations$Groundingconfigs$Check, + importIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - check( - params: Params$Resource$Projects$Locations$Groundingconfigs$Check, - callback: BodyResponseCallback + importIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings, + callback: BodyResponseCallback ): void; - check( - callback: BodyResponseCallback + importIdentityMappings( + callback: BodyResponseCallback ): void; - check( + importIdentityMappings( paramsOrCallback?: - | Params$Resource$Projects$Locations$Groundingconfigs$Check - | BodyResponseCallback + | Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Groundingconfigs$Check; + {}) as Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Groundingconfigs$Check; + {} as Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings; options = {}; } @@ -63437,59 +66605,32 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+groundingConfig}:check').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + + '/v1alpha/{+identityMappingStore}:importIdentityMappings' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['groundingConfig'], - pathParams: ['groundingConfig'], + requiredParams: ['identityMappingStore'], + pathParams: ['identityMappingStore'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Groundingconfigs$Check - extends StandardParameters { - /** - * Required. The resource name of the grounding config, such as `projects/x/locations/global/groundingConfigs/default_grounding_config`. - */ - groundingConfig?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest; - } - - export class Resource$Projects$Locations$Identitymappingstores { - context: APIRequestContext; - operations: Resource$Projects$Locations$Identitymappingstores$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Identitymappingstores$Operations( - this.context - ); - } /** - * Creates a new Identity Mapping Store. + * Lists all Identity Mapping Stores. * @example * ```js * // Before running the sample: @@ -63522,35 +66663,20 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.identityMappingStores.create({ - * // Resource name of the CmekConfig to use for protecting this Identity Mapping Store. - * cmekConfigName: 'placeholder-value', - * // Identity Mapping Store without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well. - * disableCmek: 'placeholder-value', - * // Required. The ID of the Identity Mapping Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters. - * identityMappingStoreId: 'placeholder-value', - * // Required. The parent collection resource name, such as `projects/{project\}/locations/{location\}`. + * await discoveryengine.projects.locations.identityMappingStores.list({ + * // Maximum number of IdentityMappingStores to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // A page token, received from a previous `ListIdentityMappingStores` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdentityMappingStores` must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The parent of the Identity Mapping Stores to list. Format: `projects/{project\}/locations/{location\}`. * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "cmekConfig": {}, - * // "idpConfig": {}, - * // "kmsKeyName": "my_kmsKeyName", - * // "name": "my_name" - * // } - * }, * }); * console.log(res.data); * * // Example response * // { - * // "cmekConfig": {}, - * // "idpConfig": {}, - * // "kmsKeyName": "my_kmsKeyName", - * // "name": "my_name" + * // "identityMappingStores": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -63566,62 +66692,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Identitymappingstores$Create, + list( + params: Params$Resource$Projects$Locations$Identitymappingstores$List, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Identitymappingstores$Create, + list( + params?: Params$Resource$Projects$Locations$Identitymappingstores$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - create( - params: Params$Resource$Projects$Locations$Identitymappingstores$Create, + list( + params: Params$Resource$Projects$Locations$Identitymappingstores$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Identitymappingstores$Create, + list( + params: Params$Resource$Projects$Locations$Identitymappingstores$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Identitymappingstores$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Identitymappingstores$List, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - create( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Identitymappingstores$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Identitymappingstores$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Identitymappingstores$Create; + {}) as Params$Resource$Projects$Locations$Identitymappingstores$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Identitymappingstores$Create; + {} as Params$Resource$Projects$Locations$Identitymappingstores$List; options = {}; } @@ -63639,7 +66765,7 @@ export namespace discoveryengine_v1alpha { /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -63650,19 +66776,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes the Identity Mapping Store. + * Lists Identity Mappings in an Identity Mapping Store. * @example * ```js * // Before running the sample: @@ -63695,19 +66821,23 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.identityMappingStores.delete({ - * // Required. The name of the Identity Mapping Store to delete. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}` - * name: 'projects/my-project/locations/my-location/identityMappingStores/my-identityMappingStore', - * }); + * await discoveryengine.projects.locations.identityMappingStores.listIdentityMappings( + * { + * // Required. The name of the Identity Mapping Store to list Identity Mapping Entries in. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}` + * identityMappingStore: + * 'projects/my-project/locations/my-location/identityMappingStores/my-identityMappingStore', + * // Maximum number of IdentityMappings to return. If unspecified, defaults to 2000. The maximum allowed value is 10000. Values above 10000 will be coerced to 10000. + * pageSize: 'placeholder-value', + * // A page token, received from a previous `ListIdentityMappings` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdentityMappings` must match the call that provided the page token. + * pageToken: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "identityMappingEntries": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -63723,58 +66853,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Identitymappingstores$Delete, + listIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Identitymappingstores$Delete, + listIdentityMappings( + params?: Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Identitymappingstores$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + listIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Identitymappingstores$Delete, + listIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Identitymappingstores$Delete, - callback: BodyResponseCallback + listIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + listIdentityMappings( + callback: BodyResponseCallback ): void; - delete( + listIdentityMappings( paramsOrCallback?: - | Params$Resource$Projects$Locations$Identitymappingstores$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Identitymappingstores$Delete; + {}) as Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Identitymappingstores$Delete; + {} as Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings; options = {}; } @@ -63788,29 +66922,33 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: ( + rootUrl + '/v1alpha/{+identityMappingStore}:listIdentityMappings' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['identityMappingStore'], + pathParams: ['identityMappingStore'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the Identity Mapping Store. + * Purges specified or all Identity Mapping Entries from an Identity Mapping Store. * @example * ```js * // Before running the sample: @@ -63843,18 +66981,32 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.identityMappingStores.get({ - * // Required. The name of the Identity Mapping Store to get. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}` - * name: 'projects/my-project/locations/my-location/identityMappingStores/my-identityMappingStore', - * }); + * await discoveryengine.projects.locations.identityMappingStores.purgeIdentityMappings( + * { + * // Required. The name of the Identity Mapping Store to purge Identity Mapping Entries from. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}` + * identityMappingStore: + * 'projects/my-project/locations/my-location/identityMappingStores/my-identityMappingStore', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "filter": "my_filter", + * // "force": false, + * // "inlineSource": {} + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "cmekConfig": {}, - * // "idpConfig": {}, - * // "kmsKeyName": "my_kmsKeyName", - * // "name": "my_name" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -63870,62 +67022,58 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Identitymappingstores$Get, + purgeIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Identitymappingstores$Get, + purgeIdentityMappings( + params?: Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Identitymappingstores$Get, + ): Promise>; + purgeIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Identitymappingstores$Get, + purgeIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Identitymappingstores$Get, - callback: BodyResponseCallback + purgeIdentityMappings( + params: Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + purgeIdentityMappings( + callback: BodyResponseCallback ): void; - get( + purgeIdentityMappings( paramsOrCallback?: - | Params$Resource$Projects$Locations$Identitymappingstores$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Identitymappingstores$Get; + {}) as Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Identitymappingstores$Get; + {} as Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings; options = {}; } @@ -63939,31 +67087,131 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: ( + rootUrl + '/v1alpha/{+identityMappingStore}:purgeIdentityMappings' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['identityMappingStore'], + pathParams: ['identityMappingStore'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Identitymappingstores$Create + extends StandardParameters { /** - * Imports a list of Identity Mapping Entries to an Identity Mapping Store. + * Resource name of the CmekConfig to use for protecting this Identity Mapping Store. + */ + cmekConfigName?: string; + /** + * Identity Mapping Store without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well. + */ + disableCmek?: boolean; + /** + * Required. The ID of the Identity Mapping Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters. + */ + identityMappingStoreId?: string; + /** + * Required. The parent collection resource name, such as `projects/{project\}/locations/{location\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaIdentityMappingStore; + } + export interface Params$Resource$Projects$Locations$Identitymappingstores$Delete + extends StandardParameters { + /** + * Required. The name of the Identity Mapping Store to delete. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Identitymappingstores$Get + extends StandardParameters { + /** + * Required. The name of the Identity Mapping Store to get. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings + extends StandardParameters { + /** + * Required. The name of the Identity Mapping Store to import Identity Mapping Entries to. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}` + */ + identityMappingStore?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsRequest; + } + export interface Params$Resource$Projects$Locations$Identitymappingstores$List + extends StandardParameters { + /** + * Maximum number of IdentityMappingStores to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListIdentityMappingStores` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdentityMappingStores` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent of the Identity Mapping Stores to list. Format: `projects/{project\}/locations/{location\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings + extends StandardParameters { + /** + * Required. The name of the Identity Mapping Store to list Identity Mapping Entries in. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}` + */ + identityMappingStore?: string; + /** + * Maximum number of IdentityMappings to return. If unspecified, defaults to 2000. The maximum allowed value is 10000. Values above 10000 will be coerced to 10000. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListIdentityMappings` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdentityMappings` must match the call that provided the page token. + */ + pageToken?: string; + } + export interface Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings + extends StandardParameters { + /** + * Required. The name of the Identity Mapping Store to purge Identity Mapping Entries from. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}` + */ + identityMappingStore?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeIdentityMappingsRequest; + } + + export class Resource$Projects$Locations$Identitymappingstores$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -63996,19 +67244,10 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.identityMappingStores.importIdentityMappings( + * await discoveryengine.projects.locations.identityMappingStores.operations.get( * { - * // Required. The name of the Identity Mapping Store to import Identity Mapping Entries to. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}` - * identityMappingStore: - * 'projects/my-project/locations/my-location/identityMappingStores/my-identityMappingStore', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "inlineSource": {} - * // } - * }, + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/identityMappingStores/my-identityMappingStore/operations/my-operation', * }, * ); * console.log(res.data); @@ -64035,36 +67274,36 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - importIdentityMappings( - params: Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings, + get( + params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get, options: StreamMethodOptions ): Promise>; - importIdentityMappings( - params?: Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings, + get( + params?: Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get, options?: MethodOptions ): Promise>; - importIdentityMappings( - params: Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings, + get( + params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - importIdentityMappings( - params: Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings, + get( + params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - importIdentityMappings( - params: Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings, + get( + params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get, callback: BodyResponseCallback ): void; - importIdentityMappings( + get( callback: BodyResponseCallback ): void; - importIdentityMappings( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings + | Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -64080,13 +67319,13 @@ export namespace discoveryengine_v1alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings; + {}) as Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings; + {} as Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get; options = {}; } @@ -64100,18 +67339,15 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + - '/v1alpha/{+identityMappingStore}:importIdentityMappings' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['identityMappingStore'], - pathParams: ['identityMappingStore'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -64125,7 +67361,7 @@ export namespace discoveryengine_v1alpha { } /** - * Lists all Identity Mapping Stores. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -64158,20 +67394,27 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.identityMappingStores.list({ - * // Maximum number of IdentityMappingStores to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // A page token, received from a previous `ListIdentityMappingStores` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdentityMappingStores` must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The parent of the Identity Mapping Stores to list. Format: `projects/{project\}/locations/{location\}`. - * parent: 'projects/my-project/locations/my-location', - * }); + * await discoveryengine.projects.locations.identityMappingStores.operations.list( + * { + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/identityMappingStores/my-identityMappingStore', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "identityMappingStores": [], - * // "nextPageToken": "my_nextPageToken" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -64188,61 +67431,61 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Identitymappingstores$List, + params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Identitymappingstores$List, + params?: Params$Resource$Projects$Locations$Identitymappingstores$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Identitymappingstores$List, + params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Identitymappingstores$List, + params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Identitymappingstores$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Identitymappingstores$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Identitymappingstores$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Identitymappingstores$List; + {}) as Params$Resource$Projects$Locations$Identitymappingstores$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Identitymappingstores$List; + {} as Params$Resource$Projects$Locations$Identitymappingstores$Operations$List; options = {}; } @@ -64256,7 +67499,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/identityMappingStores').replace( + url: (rootUrl + '/v1alpha/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -64266,24 +67509,62 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get + extends StandardParameters { /** - * Lists Identity Mappings in an Identity Mapping Store. + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Identitymappingstores$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + + export class Resource$Projects$Locations$Licenseconfigs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a LicenseConfig * @example * ```js * // Before running the sample: @@ -64315,24 +67596,45 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await discoveryengine.projects.locations.identityMappingStores.listIdentityMappings( - * { - * // Required. The name of the Identity Mapping Store to list Identity Mapping Entries in. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}` - * identityMappingStore: - * 'projects/my-project/locations/my-location/identityMappingStores/my-identityMappingStore', - * // Maximum number of IdentityMappings to return. If unspecified, defaults to 2000. The maximum allowed value is 10000. Values above 10000 will be coerced to 10000. - * pageSize: 'placeholder-value', - * // A page token, received from a previous `ListIdentityMappings` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdentityMappings` must match the call that provided the page token. - * pageToken: 'placeholder-value', - * }, - * ); + * const res = await discoveryengine.projects.locations.licenseConfigs.create({ + * // Optional. The ID to use for the LicenseConfig, which will become the final component of the LicenseConfig's resource name. We are using the tier (product edition) name as the license config id such as `search` or `search_and_assistant`. + * licenseConfigId: 'placeholder-value', + * // Required. The parent resource name, such as `projects/{project\}/locations/{location\}`. + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "alertPolicyResourceConfig": {}, + * // "autoRenew": false, + * // "endDate": {}, + * // "freeTrial": false, + * // "geminiBundle": false, + * // "licenseCount": "my_licenseCount", + * // "name": "my_name", + * // "startDate": {}, + * // "state": "my_state", + * // "subscriptionTerm": "my_subscriptionTerm", + * // "subscriptionTier": "my_subscriptionTier" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "identityMappingEntries": [], - * // "nextPageToken": "my_nextPageToken" + * // "alertPolicyResourceConfig": {}, + * // "autoRenew": false, + * // "endDate": {}, + * // "freeTrial": false, + * // "geminiBundle": false, + * // "licenseCount": "my_licenseCount", + * // "name": "my_name", + * // "startDate": {}, + * // "state": "my_state", + * // "subscriptionTerm": "my_subscriptionTerm", + * // "subscriptionTier": "my_subscriptionTier" * // } * } * @@ -64348,62 +67650,61 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listIdentityMappings( - params: Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings, + create( + params: Params$Resource$Projects$Locations$Licenseconfigs$Create, options: StreamMethodOptions ): Promise>; - listIdentityMappings( - params?: Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings, + create( + params?: Params$Resource$Projects$Locations$Licenseconfigs$Create, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - listIdentityMappings( - params: Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings, + create( + params: Params$Resource$Projects$Locations$Licenseconfigs$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listIdentityMappings( - params: Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings, + create( + params: Params$Resource$Projects$Locations$Licenseconfigs$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listIdentityMappings( - params: Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Licenseconfigs$Create, + callback: BodyResponseCallback ): void; - listIdentityMappings( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - listIdentityMappings( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings - | BodyResponseCallback + | Params$Resource$Projects$Locations$Licenseconfigs$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings; + {}) as Params$Resource$Projects$Locations$Licenseconfigs$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings; + params = {} as Params$Resource$Projects$Locations$Licenseconfigs$Create; options = {}; } @@ -64417,33 +67718,34 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+identityMappingStore}:listIdentityMappings' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+parent}/licenseConfigs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['identityMappingStore'], - pathParams: ['identityMappingStore'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Purges specified or all Identity Mapping Entries from an Identity Mapping Store. + * Gets a LicenseConfig. * @example * ```js * // Before running the sample: @@ -64475,33 +67777,25 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await discoveryengine.projects.locations.identityMappingStores.purgeIdentityMappings( - * { - * // Required. The name of the Identity Mapping Store to purge Identity Mapping Entries from. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}` - * identityMappingStore: - * 'projects/my-project/locations/my-location/identityMappingStores/my-identityMappingStore', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "filter": "my_filter", - * // "force": false, - * // "inlineSource": {} - * // } - * }, - * }, - * ); + * const res = await discoveryengine.projects.locations.licenseConfigs.get({ + * // Required. Full resource name of LicenseConfig, such as `projects/{project\}/locations/{location\}/licenseConfigs/x`. If the caller does not have permission to access the LicenseConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested LicenseConfig does not exist, a NOT_FOUND error is returned. + * name: 'projects/my-project/locations/my-location/licenseConfigs/my-licenseConfig', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "alertPolicyResourceConfig": {}, + * // "autoRenew": false, + * // "endDate": {}, + * // "freeTrial": false, + * // "geminiBundle": false, + * // "licenseCount": "my_licenseCount", * // "name": "my_name", - * // "response": {} + * // "startDate": {}, + * // "state": "my_state", + * // "subscriptionTerm": "my_subscriptionTerm", + * // "subscriptionTier": "my_subscriptionTier" * // } * } * @@ -64517,58 +67811,61 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purgeIdentityMappings( - params: Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings, + get( + params: Params$Resource$Projects$Locations$Licenseconfigs$Get, options: StreamMethodOptions ): Promise>; - purgeIdentityMappings( - params?: Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings, + get( + params?: Params$Resource$Projects$Locations$Licenseconfigs$Get, options?: MethodOptions - ): Promise>; - purgeIdentityMappings( - params: Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings, + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Licenseconfigs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purgeIdentityMappings( - params: Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings, + get( + params: Params$Resource$Projects$Locations$Licenseconfigs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purgeIdentityMappings( - params: Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Licenseconfigs$Get, + callback: BodyResponseCallback ): void; - purgeIdentityMappings( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - purgeIdentityMappings( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings - | BodyResponseCallback + | Params$Resource$Projects$Locations$Licenseconfigs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings; + {}) as Params$Resource$Projects$Locations$Licenseconfigs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings; + params = {} as Params$Resource$Projects$Locations$Licenseconfigs$Get; options = {}; } @@ -64582,131 +67879,31 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+identityMappingStore}:purgeIdentityMappings' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['identityMappingStore'], - pathParams: ['identityMappingStore'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Projects$Locations$Identitymappingstores$Create - extends StandardParameters { - /** - * Resource name of the CmekConfig to use for protecting this Identity Mapping Store. - */ - cmekConfigName?: string; - /** - * Identity Mapping Store without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well. - */ - disableCmek?: boolean; - /** - * Required. The ID of the Identity Mapping Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters. - */ - identityMappingStoreId?: string; - /** - * Required. The parent collection resource name, such as `projects/{project\}/locations/{location\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaIdentityMappingStore; - } - export interface Params$Resource$Projects$Locations$Identitymappingstores$Delete - extends StandardParameters { - /** - * Required. The name of the Identity Mapping Store to delete. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Identitymappingstores$Get - extends StandardParameters { - /** - * Required. The name of the Identity Mapping Store to get. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Identitymappingstores$Importidentitymappings - extends StandardParameters { - /** - * Required. The name of the Identity Mapping Store to import Identity Mapping Entries to. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}` - */ - identityMappingStore?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportIdentityMappingsRequest; - } - export interface Params$Resource$Projects$Locations$Identitymappingstores$List - extends StandardParameters { - /** - * Maximum number of IdentityMappingStores to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListIdentityMappingStores` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdentityMappingStores` must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The parent of the Identity Mapping Stores to list. Format: `projects/{project\}/locations/{location\}`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Identitymappingstores$Listidentitymappings - extends StandardParameters { - /** - * Required. The name of the Identity Mapping Store to list Identity Mapping Entries in. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}` - */ - identityMappingStore?: string; - /** - * Maximum number of IdentityMappings to return. If unspecified, defaults to 2000. The maximum allowed value is 10000. Values above 10000 will be coerced to 10000. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListIdentityMappings` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdentityMappings` must match the call that provided the page token. - */ - pageToken?: string; - } - export interface Params$Resource$Projects$Locations$Identitymappingstores$Purgeidentitymappings - extends StandardParameters { - /** - * Required. The name of the Identity Mapping Store to purge Identity Mapping Entries from. Format: `projects/{project\}/locations/{location\}/identityMappingStores/{identityMappingStore\}` - */ - identityMappingStore?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeIdentityMappingsRequest; - } - - export class Resource$Projects$Locations$Identitymappingstores$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Updates the LicenseConfig * @example * ```js * // Before running the sample: @@ -64738,22 +67935,45 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await discoveryengine.projects.locations.identityMappingStores.operations.get( - * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/identityMappingStores/my-identityMappingStore/operations/my-operation', - * }, - * ); + * const res = await discoveryengine.projects.locations.licenseConfigs.patch({ + * // Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project\}/locations/{location\}/licenseConfigs/{license_config\}` + * name: 'projects/my-project/locations/my-location/licenseConfigs/my-licenseConfig', + * // Optional. Indicates which fields in the provided LicenseConfig to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "alertPolicyResourceConfig": {}, + * // "autoRenew": false, + * // "endDate": {}, + * // "freeTrial": false, + * // "geminiBundle": false, + * // "licenseCount": "my_licenseCount", + * // "name": "my_name", + * // "startDate": {}, + * // "state": "my_state", + * // "subscriptionTerm": "my_subscriptionTerm", + * // "subscriptionTier": "my_subscriptionTier" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "alertPolicyResourceConfig": {}, + * // "autoRenew": false, + * // "endDate": {}, + * // "freeTrial": false, + * // "geminiBundle": false, + * // "licenseCount": "my_licenseCount", * // "name": "my_name", - * // "response": {} + * // "startDate": {}, + * // "state": "my_state", + * // "subscriptionTerm": "my_subscriptionTerm", + * // "subscriptionTier": "my_subscriptionTier" * // } * } * @@ -64769,58 +67989,61 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get, + patch( + params: Params$Resource$Projects$Locations$Licenseconfigs$Patch, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get, + patch( + params?: Params$Resource$Projects$Locations$Licenseconfigs$Patch, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + patch( + params: Params$Resource$Projects$Locations$Licenseconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get, + patch( + params: Params$Resource$Projects$Locations$Licenseconfigs$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Licenseconfigs$Patch, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - get( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Licenseconfigs$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get; + {}) as Params$Resource$Projects$Locations$Licenseconfigs$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get; + params = {} as Params$Resource$Projects$Locations$Licenseconfigs$Patch; options = {}; } @@ -64835,7 +68058,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -64846,17 +68069,73 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Licenseconfigs$Create + extends StandardParameters { /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Optional. The ID to use for the LicenseConfig, which will become the final component of the LicenseConfig's resource name. We are using the tier (product edition) name as the license config id such as `search` or `search_and_assistant`. + */ + licenseConfigId?: string; + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaLicenseConfig; + } + export interface Params$Resource$Projects$Locations$Licenseconfigs$Get + extends StandardParameters { + /** + * Required. Full resource name of LicenseConfig, such as `projects/{project\}/locations/{location\}/licenseConfigs/x`. If the caller does not have permission to access the LicenseConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested LicenseConfig does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Licenseconfigs$Patch + extends StandardParameters { + /** + * Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project\}/locations/{location\}/licenseConfigs/{license_config\}` + */ + name?: string; + /** + * Optional. Indicates which fields in the provided LicenseConfig to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaLicenseConfig; + } + + export class Resource$Projects$Locations$Notebooks { + context: APIRequestContext; + audioOverviews: Resource$Projects$Locations$Notebooks$Audiooverviews; + sources: Resource$Projects$Locations$Notebooks$Sources; + constructor(context: APIRequestContext) { + this.context = context; + this.audioOverviews = + new Resource$Projects$Locations$Notebooks$Audiooverviews(this.context); + this.sources = new Resource$Projects$Locations$Notebooks$Sources( + this.context + ); + } + + /** + * Batch deletes Notebooks. * @example * ```js * // Before running the sample: @@ -64888,29 +68167,22 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await discoveryengine.projects.locations.identityMappingStores.operations.list( - * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/identityMappingStores/my-identityMappingStore', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }, - * ); + * const res = await discoveryengine.projects.locations.notebooks.batchDelete({ + * // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}`. + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "names": [] + * // } + * }, + * }); * console.log(res.data); * * // Example response - * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] - * // } + * // {} * } * * main().catch(e => { @@ -64925,62 +68197,55 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$List, + batchDelete( + params: Params$Resource$Projects$Locations$Notebooks$Batchdelete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Identitymappingstores$Operations$List, + batchDelete( + params?: Params$Resource$Projects$Locations$Notebooks$Batchdelete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$List, + ): Promise>; + batchDelete( + params: Params$Resource$Projects$Locations$Notebooks$Batchdelete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + batchDelete( + params: Params$Resource$Projects$Locations$Notebooks$Batchdelete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$List, - callback: BodyResponseCallback + batchDelete( + params: Params$Resource$Projects$Locations$Notebooks$Batchdelete, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + batchDelete( + callback: BodyResponseCallback ): void; - list( + batchDelete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Identitymappingstores$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebooks$Batchdelete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Identitymappingstores$Operations$List; + {}) as Params$Resource$Projects$Locations$Notebooks$Batchdelete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Identitymappingstores$Operations$List; + params = {} as Params$Resource$Projects$Locations$Notebooks$Batchdelete; options = {}; } @@ -64994,72 +68259,32 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}/operations').replace( + url: (rootUrl + '/v1alpha/{+parent}/notebooks:batchDelete').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Identitymappingstores$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - - export class Resource$Projects$Locations$Licenseconfigs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Creates a LicenseConfig + * Creates a notebook. * @example * ```js * // Before running the sample: @@ -65091,9 +68316,7 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.licenseConfigs.create({ - * // Optional. The ID to use for the LicenseConfig, which will become the final component of the LicenseConfig's resource name. We are using the tier (product edition) name as the license config id such as `search` or `search_and_assistant`. - * licenseConfigId: 'placeholder-value', + * const res = await discoveryengine.projects.locations.notebooks.create({ * // Required. The parent resource name, such as `projects/{project\}/locations/{location\}`. * parent: 'projects/my-project/locations/my-location', * @@ -65101,17 +68324,13 @@ export namespace discoveryengine_v1alpha { * requestBody: { * // request body parameters * // { - * // "alertPolicyResourceConfig": {}, - * // "autoRenew": false, - * // "endDate": {}, - * // "freeTrial": false, - * // "geminiBundle": false, - * // "licenseCount": "my_licenseCount", + * // "cmekConfig": {}, + * // "emoji": "my_emoji", + * // "metadata": {}, * // "name": "my_name", - * // "startDate": {}, - * // "state": "my_state", - * // "subscriptionTerm": "my_subscriptionTerm", - * // "subscriptionTier": "my_subscriptionTier" + * // "notebookId": "my_notebookId", + * // "sources": [], + * // "title": "my_title" * // } * }, * }); @@ -65119,17 +68338,13 @@ export namespace discoveryengine_v1alpha { * * // Example response * // { - * // "alertPolicyResourceConfig": {}, - * // "autoRenew": false, - * // "endDate": {}, - * // "freeTrial": false, - * // "geminiBundle": false, - * // "licenseCount": "my_licenseCount", + * // "cmekConfig": {}, + * // "emoji": "my_emoji", + * // "metadata": {}, * // "name": "my_name", - * // "startDate": {}, - * // "state": "my_state", - * // "subscriptionTerm": "my_subscriptionTerm", - * // "subscriptionTier": "my_subscriptionTier" + * // "notebookId": "my_notebookId", + * // "sources": [], + * // "title": "my_title" * // } * } * @@ -65146,60 +68361,60 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Licenseconfigs$Create, + params: Params$Resource$Projects$Locations$Notebooks$Create, options: StreamMethodOptions ): Promise>; create( - params?: Params$Resource$Projects$Locations$Licenseconfigs$Create, + params?: Params$Resource$Projects$Locations$Notebooks$Create, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; create( - params: Params$Resource$Projects$Locations$Licenseconfigs$Create, + params: Params$Resource$Projects$Locations$Notebooks$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Licenseconfigs$Create, + params: Params$Resource$Projects$Locations$Notebooks$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Licenseconfigs$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Notebooks$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Licenseconfigs$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebooks$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Licenseconfigs$Create; + {}) as Params$Resource$Projects$Locations$Notebooks$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Licenseconfigs$Create; + params = {} as Params$Resource$Projects$Locations$Notebooks$Create; options = {}; } @@ -65213,7 +68428,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/licenseConfigs').replace( + url: (rootUrl + '/v1alpha/{+parent}/notebooks').replace( /([^:]\/)\/+/g, '$1' ), @@ -65228,19 +68443,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets a LicenseConfig. + * Gets a notebook. * @example * ```js * // Before running the sample: @@ -65272,25 +68487,21 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.licenseConfigs.get({ - * // Required. Full resource name of LicenseConfig, such as `projects/{project\}/locations/{location\}/licenseConfigs/x`. If the caller does not have permission to access the LicenseConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested LicenseConfig does not exist, a NOT_FOUND error is returned. - * name: 'projects/my-project/locations/my-location/licenseConfigs/my-licenseConfig', + * const res = await discoveryengine.projects.locations.notebooks.get({ + * // Required. Full resource name of Notebook, such as `projects/{project\}/locations/{location\}/notebooks/{notebook_id\}`. + * name: 'projects/my-project/locations/my-location/notebooks/my-notebook', * }); * console.log(res.data); * * // Example response * // { - * // "alertPolicyResourceConfig": {}, - * // "autoRenew": false, - * // "endDate": {}, - * // "freeTrial": false, - * // "geminiBundle": false, - * // "licenseCount": "my_licenseCount", + * // "cmekConfig": {}, + * // "emoji": "my_emoji", + * // "metadata": {}, * // "name": "my_name", - * // "startDate": {}, - * // "state": "my_state", - * // "subscriptionTerm": "my_subscriptionTerm", - * // "subscriptionTier": "my_subscriptionTier" + * // "notebookId": "my_notebookId", + * // "sources": [], + * // "title": "my_title" * // } * } * @@ -65307,60 +68518,60 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Licenseconfigs$Get, + params: Params$Resource$Projects$Locations$Notebooks$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Licenseconfigs$Get, + params?: Params$Resource$Projects$Locations$Notebooks$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; get( - params: Params$Resource$Projects$Locations$Licenseconfigs$Get, + params: Params$Resource$Projects$Locations$Notebooks$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Licenseconfigs$Get, + params: Params$Resource$Projects$Locations$Notebooks$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Licenseconfigs$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Notebooks$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Licenseconfigs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebooks$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Licenseconfigs$Get; + {}) as Params$Resource$Projects$Locations$Notebooks$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Licenseconfigs$Get; + params = {} as Params$Resource$Projects$Locations$Notebooks$Get; options = {}; } @@ -65386,19 +68597,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates the LicenseConfig + * Lists the notebooks ordered by last view time. * @example * ```js * // Before running the sample: @@ -65430,45 +68641,21 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.licenseConfigs.patch({ - * // Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project\}/locations/{location\}/licenseConfigs/{license_config\}` - * name: 'projects/my-project/locations/my-location/licenseConfigs/my-licenseConfig', - * // Optional. Indicates which fields in the provided LicenseConfig to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "alertPolicyResourceConfig": {}, - * // "autoRenew": false, - * // "endDate": {}, - * // "freeTrial": false, - * // "geminiBundle": false, - * // "licenseCount": "my_licenseCount", - * // "name": "my_name", - * // "startDate": {}, - * // "state": "my_state", - * // "subscriptionTerm": "my_subscriptionTerm", - * // "subscriptionTier": "my_subscriptionTier" - * // } - * }, - * }); + * const res = + * await discoveryengine.projects.locations.notebooks.listRecentlyViewed({ + * // Optional. Maximum number of Notebooks to return. If unspecified, defaults to "500". The maximum allowed value is "500". If this field is negative, will use the default value. + * pageSize: 'placeholder-value', + * // Optional. The page token, provide this to retrieve the subsequent page. + * pageToken: 'placeholder-value', + * // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}`. + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { - * // "alertPolicyResourceConfig": {}, - * // "autoRenew": false, - * // "endDate": {}, - * // "freeTrial": false, - * // "geminiBundle": false, - * // "licenseCount": "my_licenseCount", - * // "name": "my_name", - * // "startDate": {}, - * // "state": "my_state", - * // "subscriptionTerm": "my_subscriptionTerm", - * // "subscriptionTier": "my_subscriptionTier" + * // "nextPageToken": "my_nextPageToken", + * // "notebooks": [] * // } * } * @@ -65484,61 +68671,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Licenseconfigs$Patch, + listRecentlyViewed( + params: Params$Resource$Projects$Locations$Notebooks$Listrecentlyviewed, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Licenseconfigs$Patch, + listRecentlyViewed( + params?: Params$Resource$Projects$Locations$Notebooks$Listrecentlyviewed, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - patch( - params: Params$Resource$Projects$Locations$Licenseconfigs$Patch, + listRecentlyViewed( + params: Params$Resource$Projects$Locations$Notebooks$Listrecentlyviewed, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Licenseconfigs$Patch, + listRecentlyViewed( + params: Params$Resource$Projects$Locations$Notebooks$Listrecentlyviewed, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Licenseconfigs$Patch, - callback: BodyResponseCallback + listRecentlyViewed( + params: Params$Resource$Projects$Locations$Notebooks$Listrecentlyviewed, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + listRecentlyViewed( + callback: BodyResponseCallback ): void; - patch( + listRecentlyViewed( paramsOrCallback?: - | Params$Resource$Projects$Locations$Licenseconfigs$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebooks$Listrecentlyviewed + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Licenseconfigs$Patch; + {}) as Params$Resource$Projects$Locations$Notebooks$Listrecentlyviewed; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Licenseconfigs$Patch; + params = + {} as Params$Resource$Projects$Locations$Notebooks$Listrecentlyviewed; options = {}; } @@ -65552,85 +68740,33 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: ( + rootUrl + '/v1alpha/{+parent}/notebooks:listRecentlyViewed' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Licenseconfigs$Create - extends StandardParameters { - /** - * Optional. The ID to use for the LicenseConfig, which will become the final component of the LicenseConfig's resource name. We are using the tier (product edition) name as the license config id such as `search` or `search_and_assistant`. - */ - licenseConfigId?: string; - /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaLicenseConfig; - } - export interface Params$Resource$Projects$Locations$Licenseconfigs$Get - extends StandardParameters { - /** - * Required. Full resource name of LicenseConfig, such as `projects/{project\}/locations/{location\}/licenseConfigs/x`. If the caller does not have permission to access the LicenseConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested LicenseConfig does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Licenseconfigs$Patch - extends StandardParameters { - /** - * Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project\}/locations/{location\}/licenseConfigs/{license_config\}` - */ - name?: string; - /** - * Optional. Indicates which fields in the provided LicenseConfig to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaLicenseConfig; - } - - export class Resource$Projects$Locations$Notebooks { - context: APIRequestContext; - audioOverviews: Resource$Projects$Locations$Notebooks$Audiooverviews; - sources: Resource$Projects$Locations$Notebooks$Sources; - constructor(context: APIRequestContext) { - this.context = context; - this.audioOverviews = - new Resource$Projects$Locations$Notebooks$Audiooverviews(this.context); - this.sources = new Resource$Projects$Locations$Notebooks$Sources( - this.context - ); - } /** - * Batch deletes Notebooks. + * Shares a notebook to other accounts. * @example * ```js * // Before running the sample: @@ -65662,15 +68798,16 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.notebooks.batchDelete({ - * // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}`. - * parent: 'projects/my-project/locations/my-location', + * const res = await discoveryengine.projects.locations.notebooks.share({ + * // Required. Full resource name of Notebook, such as `projects/{project\}/locations/{location\}/notebooks/{notebook_id\}`. + * name: 'projects/my-project/locations/my-location/notebooks/my-notebook', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "names": [] + * // "accountAndRoles": [], + * // "notifyViaEmail": false * // } * }, * }); @@ -65692,55 +68829,61 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchDelete( - params: Params$Resource$Projects$Locations$Notebooks$Batchdelete, + share( + params: Params$Resource$Projects$Locations$Notebooks$Share, options: StreamMethodOptions ): Promise>; - batchDelete( - params?: Params$Resource$Projects$Locations$Notebooks$Batchdelete, + share( + params?: Params$Resource$Projects$Locations$Notebooks$Share, options?: MethodOptions - ): Promise>; - batchDelete( - params: Params$Resource$Projects$Locations$Notebooks$Batchdelete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + share( + params: Params$Resource$Projects$Locations$Notebooks$Share, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchDelete( - params: Params$Resource$Projects$Locations$Notebooks$Batchdelete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + share( + params: Params$Resource$Projects$Locations$Notebooks$Share, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchDelete( - params: Params$Resource$Projects$Locations$Notebooks$Batchdelete, - callback: BodyResponseCallback + share( + params: Params$Resource$Projects$Locations$Notebooks$Share, + callback: BodyResponseCallback ): void; - batchDelete( - callback: BodyResponseCallback + share( + callback: BodyResponseCallback ): void; - batchDelete( + share( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebooks$Batchdelete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebooks$Share + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebooks$Batchdelete; + {}) as Params$Resource$Projects$Locations$Notebooks$Share; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Notebooks$Batchdelete; + params = {} as Params$Resource$Projects$Locations$Notebooks$Share; options = {}; } @@ -65749,37 +68892,105 @@ export namespace discoveryengine_v1alpha { options = {}; } - const rootUrl = - options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+parent}/notebooks:batchDelete').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:share').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Notebooks$Batchdelete + extends StandardParameters { + /** + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudNotebooklmV1alphaBatchDeleteNotebooksRequest; + } + export interface Params$Resource$Projects$Locations$Notebooks$Create + extends StandardParameters { + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudNotebooklmV1alphaNotebook; + } + export interface Params$Resource$Projects$Locations$Notebooks$Get + extends StandardParameters { + /** + * Required. Full resource name of Notebook, such as `projects/{project\}/locations/{location\}/notebooks/{notebook_id\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Notebooks$Listrecentlyviewed + extends StandardParameters { + /** + * Optional. Maximum number of Notebooks to return. If unspecified, defaults to "500". The maximum allowed value is "500". If this field is negative, will use the default value. + */ + pageSize?: number; + /** + * Optional. The page token, provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Notebooks$Share + extends StandardParameters { + /** + * Required. Full resource name of Notebook, such as `projects/{project\}/locations/{location\}/notebooks/{notebook_id\}`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudNotebooklmV1alphaShareNotebookRequest; + } + + export class Resource$Projects$Locations$Notebooks$Audiooverviews { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Creates a notebook. + * Generates a new audio overview. * @example * ```js * // Before running the sample: @@ -65811,35 +69022,24 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.notebooks.create({ - * // Required. The parent resource name, such as `projects/{project\}/locations/{location\}`. - * parent: 'projects/my-project/locations/my-location', + * const res = + * await discoveryengine.projects.locations.notebooks.audioOverviews.create({ + * // Required. The parent resource where this notebook will be created. Format: projects/{project\}/locations/{location\}/notebooks/{notebook\} + * parent: 'projects/my-project/locations/my-location/notebooks/my-notebook', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "cmekConfig": {}, - * // "emoji": "my_emoji", - * // "metadata": {}, - * // "name": "my_name", - * // "notebookId": "my_notebookId", - * // "sources": [], - * // "title": "my_title" - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "generationOptions": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "cmekConfig": {}, - * // "emoji": "my_emoji", - * // "metadata": {}, - * // "name": "my_name", - * // "notebookId": "my_notebookId", - * // "sources": [], - * // "title": "my_title" + * // "audioOverview": {} * // } * } * @@ -65856,60 +69056,61 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Notebooks$Create, + params: Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Create, options: StreamMethodOptions ): Promise>; create( - params?: Params$Resource$Projects$Locations$Notebooks$Create, + params?: Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Create, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; create( - params: Params$Resource$Projects$Locations$Notebooks$Create, + params: Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Notebooks$Create, + params: Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Notebooks$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebooks$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebooks$Create; + {}) as Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Notebooks$Create; + params = + {} as Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Create; options = {}; } @@ -65923,7 +69124,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/notebooks').replace( + url: (rootUrl + '/v1alpha/{+parent}/audioOverviews').replace( /([^:]\/)\/+/g, '$1' ), @@ -65938,19 +69139,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets a notebook. + * Deletes an audio overview. * @example * ```js * // Before running the sample: @@ -65982,22 +69183,15 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.notebooks.get({ - * // Required. Full resource name of Notebook, such as `projects/{project\}/locations/{location\}/notebooks/{notebook_id\}`. - * name: 'projects/my-project/locations/my-location/notebooks/my-notebook', - * }); + * const res = + * await discoveryengine.projects.locations.notebooks.audioOverviews.delete({ + * // Required. The full resource name of the AudioOverview, such as `projects/{project\}/locations/{location\}/notebooks/{notebook\}/audioOverviews/{audio_overview_id\}`. + * name: 'projects/my-project/locations/my-location/notebooks/my-notebook/audioOverviews/my-audioOverview', + * }); * console.log(res.data); * * // Example response - * // { - * // "cmekConfig": {}, - * // "emoji": "my_emoji", - * // "metadata": {}, - * // "name": "my_name", - * // "notebookId": "my_notebookId", - * // "sources": [], - * // "title": "my_title" - * // } + * // {} * } * * main().catch(e => { @@ -66012,61 +69206,54 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Notebooks$Get, + delete( + params: Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Delete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Notebooks$Get, + delete( + params?: Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Notebooks$Get, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Notebooks$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Notebooks$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Delete, + callback: BodyResponseCallback ): void; - get( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebooks$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebooks$Get; + {}) as Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Notebooks$Get; + params = + {} as Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Delete; options = {}; } @@ -66081,7 +69268,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -66092,19 +69279,44 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Create + extends StandardParameters { /** - * Lists the notebooks ordered by last view time. + * Required. The parent resource where this notebook will be created. Format: projects/{project\}/locations/{location\}/notebooks/{notebook\} + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudNotebooklmV1alphaCreateAudioOverviewRequest; + } + export interface Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Delete + extends StandardParameters { + /** + * Required. The full resource name of the AudioOverview, such as `projects/{project\}/locations/{location\}/notebooks/{notebook\}/audioOverviews/{audio_overview_id\}`. + */ + name?: string; + } + + export class Resource$Projects$Locations$Notebooks$Sources { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a list of Sources. * @example * ```js * // Before running the sample: @@ -66137,20 +69349,23 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.notebooks.listRecentlyViewed({ - * // Optional. Maximum number of Notebooks to return. If unspecified, defaults to "500". The maximum allowed value is "500". If this field is negative, will use the default value. - * pageSize: 'placeholder-value', - * // Optional. The page token, provide this to retrieve the subsequent page. - * pageToken: 'placeholder-value', - * // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}`. - * parent: 'projects/my-project/locations/my-location', + * await discoveryengine.projects.locations.notebooks.sources.batchCreate({ + * // Required. The parent resource where the sources will be created. Format: projects/{project\}/locations/{location\}/notebooks/{notebook\} + * parent: 'projects/my-project/locations/my-location/notebooks/my-notebook', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "userContents": [] + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "notebooks": [] + * // "sources": [] * // } * } * @@ -66166,62 +69381,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listRecentlyViewed( - params: Params$Resource$Projects$Locations$Notebooks$Listrecentlyviewed, + batchCreate( + params: Params$Resource$Projects$Locations$Notebooks$Sources$Batchcreate, options: StreamMethodOptions ): Promise>; - listRecentlyViewed( - params?: Params$Resource$Projects$Locations$Notebooks$Listrecentlyviewed, + batchCreate( + params?: Params$Resource$Projects$Locations$Notebooks$Sources$Batchcreate, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - listRecentlyViewed( - params: Params$Resource$Projects$Locations$Notebooks$Listrecentlyviewed, + batchCreate( + params: Params$Resource$Projects$Locations$Notebooks$Sources$Batchcreate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listRecentlyViewed( - params: Params$Resource$Projects$Locations$Notebooks$Listrecentlyviewed, + batchCreate( + params: Params$Resource$Projects$Locations$Notebooks$Sources$Batchcreate, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listRecentlyViewed( - params: Params$Resource$Projects$Locations$Notebooks$Listrecentlyviewed, - callback: BodyResponseCallback + batchCreate( + params: Params$Resource$Projects$Locations$Notebooks$Sources$Batchcreate, + callback: BodyResponseCallback ): void; - listRecentlyViewed( - callback: BodyResponseCallback + batchCreate( + callback: BodyResponseCallback ): void; - listRecentlyViewed( + batchCreate( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebooks$Listrecentlyviewed - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebooks$Sources$Batchcreate + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebooks$Listrecentlyviewed; + {}) as Params$Resource$Projects$Locations$Notebooks$Sources$Batchcreate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebooks$Listrecentlyviewed; + {} as Params$Resource$Projects$Locations$Notebooks$Sources$Batchcreate; options = {}; } @@ -66235,10 +69450,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+parent}/notebooks:listRecentlyViewed' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+parent}/sources:batchCreate').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -66249,19 +69465,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Shares a notebook to other accounts. + * Deletes multiple sources * @example * ```js * // Before running the sample: @@ -66293,19 +69509,19 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.notebooks.share({ - * // Required. Full resource name of Notebook, such as `projects/{project\}/locations/{location\}/notebooks/{notebook_id\}`. - * name: 'projects/my-project/locations/my-location/notebooks/my-notebook', + * const res = + * await discoveryengine.projects.locations.notebooks.sources.batchDelete({ + * // Required. The parent resource where the sources will be deleted. Format: projects/{project\}/locations/{location\}/notebooks/{notebook\} + * parent: 'projects/my-project/locations/my-location/notebooks/my-notebook', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "accountAndRoles": [], - * // "notifyViaEmail": false - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "names": [] + * // } + * }, + * }); * console.log(res.data); * * // Example response @@ -66324,61 +69540,56 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - share( - params: Params$Resource$Projects$Locations$Notebooks$Share, + batchDelete( + params: Params$Resource$Projects$Locations$Notebooks$Sources$Batchdelete, options: StreamMethodOptions ): Promise>; - share( - params?: Params$Resource$Projects$Locations$Notebooks$Share, + batchDelete( + params?: Params$Resource$Projects$Locations$Notebooks$Sources$Batchdelete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - share( - params: Params$Resource$Projects$Locations$Notebooks$Share, + ): Promise>; + batchDelete( + params: Params$Resource$Projects$Locations$Notebooks$Sources$Batchdelete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - share( - params: Params$Resource$Projects$Locations$Notebooks$Share, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + batchDelete( + params: Params$Resource$Projects$Locations$Notebooks$Sources$Batchdelete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - share( - params: Params$Resource$Projects$Locations$Notebooks$Share, - callback: BodyResponseCallback + batchDelete( + params: Params$Resource$Projects$Locations$Notebooks$Sources$Batchdelete, + callback: BodyResponseCallback ): void; - share( - callback: BodyResponseCallback + batchDelete( + callback: BodyResponseCallback ): void; - share( + batchDelete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebooks$Share - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebooks$Sources$Batchdelete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebooks$Share; + {}) as Params$Resource$Projects$Locations$Notebooks$Sources$Batchdelete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Notebooks$Share; + params = + {} as Params$Resource$Projects$Locations$Notebooks$Sources$Batchdelete; options = {}; } @@ -66392,7 +69603,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}:share').replace( + url: (rootUrl + '/v1alpha/{+parent}/sources:batchDelete').replace( /([^:]\/)\/+/g, '$1' ), @@ -66402,90 +69613,22 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Notebooks$Batchdelete - extends StandardParameters { - /** - * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudNotebooklmV1alphaBatchDeleteNotebooksRequest; - } - export interface Params$Resource$Projects$Locations$Notebooks$Create - extends StandardParameters { - /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudNotebooklmV1alphaNotebook; - } - export interface Params$Resource$Projects$Locations$Notebooks$Get - extends StandardParameters { - /** - * Required. Full resource name of Notebook, such as `projects/{project\}/locations/{location\}/notebooks/{notebook_id\}`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Notebooks$Listrecentlyviewed - extends StandardParameters { - /** - * Optional. Maximum number of Notebooks to return. If unspecified, defaults to "500". The maximum allowed value is "500". If this field is negative, will use the default value. - */ - pageSize?: number; - /** - * Optional. The page token, provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Notebooks$Share - extends StandardParameters { - /** - * Required. Full resource name of Notebook, such as `projects/{project\}/locations/{location\}/notebooks/{notebook_id\}`. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudNotebooklmV1alphaShareNotebookRequest; - } - - export class Resource$Projects$Locations$Notebooks$Audiooverviews { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Generates a new audio overview. + * Gets a Source. * @example * ```js * // Before running the sample: @@ -66517,24 +69660,19 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await discoveryengine.projects.locations.notebooks.audioOverviews.create({ - * // Required. The parent resource where this notebook will be created. Format: projects/{project\}/locations/{location\}/notebooks/{notebook\} - * parent: 'projects/my-project/locations/my-location/notebooks/my-notebook', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "generationOptions": {} - * // } - * }, - * }); + * const res = await discoveryengine.projects.locations.notebooks.sources.get({ + * // Required. The resource name for source Format: projects/{project\}/locations/{location\}/notebooks/{notebook\}/sources/{source\} + * name: 'projects/my-project/locations/my-location/notebooks/my-notebook/sources/my-source', + * }); * console.log(res.data); * * // Example response * // { - * // "audioOverview": {} + * // "metadata": {}, + * // "name": "my_name", + * // "settings": {}, + * // "sourceId": {}, + * // "title": "my_title" * // } * } * @@ -66550,62 +69688,61 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Create, + get( + params: Params$Resource$Projects$Locations$Notebooks$Sources$Get, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Create, + get( + params?: Params$Resource$Projects$Locations$Notebooks$Sources$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - create( - params: Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Create, + get( + params: Params$Resource$Projects$Locations$Notebooks$Sources$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Create, + get( + params: Params$Resource$Projects$Locations$Notebooks$Sources$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Notebooks$Sources$Get, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - create( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebooks$Sources$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Create; + {}) as Params$Resource$Projects$Locations$Notebooks$Sources$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Create; + params = {} as Params$Resource$Projects$Locations$Notebooks$Sources$Get; options = {}; } @@ -66619,34 +69756,31 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/audioOverviews').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes an audio overview. + * Uploads a file for Notebook LM to use. Creates a Source. * @example * ```js * // Before running the sample: @@ -66679,14 +69813,29 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.notebooks.audioOverviews.delete({ - * // Required. The full resource name of the AudioOverview, such as `projects/{project\}/locations/{location\}/notebooks/{notebook\}/audioOverviews/{audio_overview_id\}`. - * name: 'projects/my-project/locations/my-location/notebooks/my-notebook/audioOverviews/my-audioOverview', + * await discoveryengine.projects.locations.notebooks.sources.uploadFile({ + * // Required. The parent resource where the sources will be created. Format: projects/{project\}/locations/{location\}/notebooks/{notebook\} + * parent: 'projects/my-project/locations/my-location/notebooks/my-notebook', + * // The source id of the associated file. If not set, a source id will be generated and a new tentative source will be created. + * sourceId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "blob": {}, + * // "mediaRequestInfo": {}, + * // "sourceId": "my_sourceId" + * // } + * }, * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "mediaResponseInfo": {}, + * // "sourceId": {} + * // } * } * * main().catch(e => { @@ -66701,54 +69850,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Delete, + uploadFile( + params: Params$Resource$Projects$Locations$Notebooks$Sources$Uploadfile, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Delete, + uploadFile( + params?: Params$Resource$Projects$Locations$Notebooks$Sources$Uploadfile, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + uploadFile( + params: Params$Resource$Projects$Locations$Notebooks$Sources$Uploadfile, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + uploadFile( + params: Params$Resource$Projects$Locations$Notebooks$Sources$Uploadfile, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Delete, - callback: BodyResponseCallback + uploadFile( + params: Params$Resource$Projects$Locations$Notebooks$Sources$Uploadfile, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + uploadFile( + callback: BodyResponseCallback + ): void; + uploadFile( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebooks$Sources$Uploadfile + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Delete; + {}) as Params$Resource$Projects$Locations$Notebooks$Sources$Uploadfile; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Delete; + {} as Params$Resource$Projects$Locations$Notebooks$Sources$Uploadfile; options = {}; } @@ -66762,56 +69919,88 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: ( + rootUrl + '/v1alpha/{+parent}/sources/{sourceId}:uploadFile' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent', 'sourceId'], + pathParams: ['parent', 'sourceId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Create + export interface Params$Resource$Projects$Locations$Notebooks$Sources$Batchcreate extends StandardParameters { /** - * Required. The parent resource where this notebook will be created. Format: projects/{project\}/locations/{location\}/notebooks/{notebook\} + * Required. The parent resource where the sources will be created. Format: projects/{project\}/locations/{location\}/notebooks/{notebook\} */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudNotebooklmV1alphaCreateAudioOverviewRequest; + requestBody?: Schema$GoogleCloudNotebooklmV1alphaBatchCreateSourcesRequest; } - export interface Params$Resource$Projects$Locations$Notebooks$Audiooverviews$Delete + export interface Params$Resource$Projects$Locations$Notebooks$Sources$Batchdelete extends StandardParameters { /** - * Required. The full resource name of the AudioOverview, such as `projects/{project\}/locations/{location\}/notebooks/{notebook\}/audioOverviews/{audio_overview_id\}`. + * Required. The parent resource where the sources will be deleted. Format: projects/{project\}/locations/{location\}/notebooks/{notebook\} + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudNotebooklmV1alphaBatchDeleteSourcesRequest; + } + export interface Params$Resource$Projects$Locations$Notebooks$Sources$Get + extends StandardParameters { + /** + * Required. The resource name for source Format: projects/{project\}/locations/{location\}/notebooks/{notebook\}/sources/{source\} */ name?: string; } + export interface Params$Resource$Projects$Locations$Notebooks$Sources$Uploadfile + extends StandardParameters { + /** + * Required. The parent resource where the sources will be created. Format: projects/{project\}/locations/{location\}/notebooks/{notebook\} + */ + parent?: string; + /** + * The source id of the associated file. If not set, a source id will be generated and a new tentative source will be created. + */ + sourceId?: string; - export class Resource$Projects$Locations$Notebooks$Sources { + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudNotebooklmV1alphaUploadSourceFileRequest; + } + + export class Resource$Projects$Locations$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates a list of Sources. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -66843,24 +70032,19 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await discoveryengine.projects.locations.notebooks.sources.batchCreate({ - * // Required. The parent resource where the sources will be created. Format: projects/{project\}/locations/{location\}/notebooks/{notebook\} - * parent: 'projects/my-project/locations/my-location/notebooks/my-notebook', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "userContents": [] - * // } - * }, - * }); + * const res = await discoveryengine.projects.locations.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/operations/my-operation', + * }); * console.log(res.data); * * // Example response * // { - * // "sources": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -66876,62 +70060,57 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchCreate( - params: Params$Resource$Projects$Locations$Notebooks$Sources$Batchcreate, + get( + params: Params$Resource$Projects$Locations$Operations$Get, options: StreamMethodOptions ): Promise>; - batchCreate( - params?: Params$Resource$Projects$Locations$Notebooks$Sources$Batchcreate, + get( + params?: Params$Resource$Projects$Locations$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - batchCreate( - params: Params$Resource$Projects$Locations$Notebooks$Sources$Batchcreate, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Notebooks$Sources$Batchcreate, + get( + params: Params$Resource$Projects$Locations$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Notebooks$Sources$Batchcreate, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Operations$Get, + callback: BodyResponseCallback ): void; - batchCreate( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - batchCreate( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebooks$Sources$Batchcreate - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebooks$Sources$Batchcreate; + {}) as Params$Resource$Projects$Locations$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Notebooks$Sources$Batchcreate; + params = {} as Params$Resource$Projects$Locations$Operations$Get; options = {}; } @@ -66945,34 +70124,29 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/sources:batchCreate').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes multiple sources + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -67004,23 +70178,26 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await discoveryengine.projects.locations.notebooks.sources.batchDelete({ - * // Required. The parent resource where the sources will be deleted. Format: projects/{project\}/locations/{location\}/notebooks/{notebook\} - * parent: 'projects/my-project/locations/my-location/notebooks/my-notebook', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "names": [] - * // } - * }, - * }); + * const res = await discoveryengine.projects.locations.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] + * // } * } * * main().catch(e => { @@ -67035,56 +70212,61 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchDelete( - params: Params$Resource$Projects$Locations$Notebooks$Sources$Batchdelete, + list( + params: Params$Resource$Projects$Locations$Operations$List, options: StreamMethodOptions ): Promise>; - batchDelete( - params?: Params$Resource$Projects$Locations$Notebooks$Sources$Batchdelete, + list( + params?: Params$Resource$Projects$Locations$Operations$List, options?: MethodOptions - ): Promise>; - batchDelete( - params: Params$Resource$Projects$Locations$Notebooks$Sources$Batchdelete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchDelete( - params: Params$Resource$Projects$Locations$Notebooks$Sources$Batchdelete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchDelete( - params: Params$Resource$Projects$Locations$Notebooks$Sources$Batchdelete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Operations$List, + callback: BodyResponseCallback ): void; - batchDelete( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - batchDelete( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebooks$Sources$Batchdelete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebooks$Sources$Batchdelete; + {}) as Params$Resource$Projects$Locations$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Notebooks$Sources$Batchdelete; + params = {} as Params$Resource$Projects$Locations$Operations$List; options = {}; } @@ -67098,32 +70280,83 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/sources:batchDelete').replace( + url: (rootUrl + '/v1alpha/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Operations$Get + extends StandardParameters { /** - * Gets a Source. + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + + export class Resource$Projects$Locations$Podcasts { + context: APIRequestContext; + operations: Resource$Projects$Locations$Podcasts$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Projects$Locations$Podcasts$Operations( + this.context + ); + } + } + + export class Resource$Projects$Locations$Podcasts$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -67155,19 +70388,19 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.notebooks.sources.get({ - * // Required. The resource name for source Format: projects/{project\}/locations/{location\}/notebooks/{notebook\}/sources/{source\} - * name: 'projects/my-project/locations/my-location/notebooks/my-notebook/sources/my-source', + * const res = await discoveryengine.projects.locations.podcasts.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/podcasts/my-podcast/operations/my-operation', * }); * console.log(res.data); * * // Example response * // { + * // "done": false, + * // "error": {}, * // "metadata": {}, * // "name": "my_name", - * // "settings": {}, - * // "sourceId": {}, - * // "title": "my_title" + * // "response": {} * // } * } * @@ -67184,60 +70417,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Notebooks$Sources$Get, + params: Params$Resource$Projects$Locations$Podcasts$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Notebooks$Sources$Get, + params?: Params$Resource$Projects$Locations$Podcasts$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; + ): Promise>; get( - params: Params$Resource$Projects$Locations$Notebooks$Sources$Get, + params: Params$Resource$Projects$Locations$Podcasts$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Notebooks$Sources$Get, + params: Params$Resource$Projects$Locations$Podcasts$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Notebooks$Sources$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Podcasts$Operations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebooks$Sources$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Podcasts$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebooks$Sources$Get; + {}) as Params$Resource$Projects$Locations$Podcasts$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Notebooks$Sources$Get; + params = + {} as Params$Resource$Projects$Locations$Podcasts$Operations$Get; options = {}; } @@ -67263,19 +70493,32 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Podcasts$Operations$Get + extends StandardParameters { /** - * Uploads a file for Notebook LM to use. Creates a Source. + * The name of the operation resource. + */ + name?: string; + } + + export class Resource$Projects$Locations$Rankingconfigs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Ranks a list of text records based on the given input query. * @example * ```js * // Before running the sample: @@ -67306,30 +70549,30 @@ export namespace discoveryengine_v1alpha { * const authClient = await auth.getClient(); * google.options({auth: authClient}); * - * // Do the magic - * const res = - * await discoveryengine.projects.locations.notebooks.sources.uploadFile({ - * // Required. The parent resource where the sources will be created. Format: projects/{project\}/locations/{location\}/notebooks/{notebook\} - * parent: 'projects/my-project/locations/my-location/notebooks/my-notebook', - * // The source id of the associated file. If not set, a source id will be generated and a new tentative source will be created. - * sourceId: 'placeholder-value', + * // Do the magic + * const res = await discoveryengine.projects.locations.rankingConfigs.rank({ + * // Required. The resource name of the rank service config, such as `projects/{project_num\}/locations/{location\}/rankingConfigs/default_ranking_config`. + * rankingConfig: + * 'projects/my-project/locations/my-location/rankingConfigs/my-rankingConfig', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "blob": {}, - * // "mediaRequestInfo": {}, - * // "sourceId": "my_sourceId" - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "ignoreRecordDetailsInResponse": false, + * // "model": "my_model", + * // "query": "my_query", + * // "records": [], + * // "topN": 0, + * // "userLabels": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "mediaResponseInfo": {}, - * // "sourceId": {} + * // "records": [] * // } * } * @@ -67345,62 +70588,61 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - uploadFile( - params: Params$Resource$Projects$Locations$Notebooks$Sources$Uploadfile, + rank( + params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, options: StreamMethodOptions ): Promise>; - uploadFile( - params?: Params$Resource$Projects$Locations$Notebooks$Sources$Uploadfile, + rank( + params?: Params$Resource$Projects$Locations$Rankingconfigs$Rank, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - uploadFile( - params: Params$Resource$Projects$Locations$Notebooks$Sources$Uploadfile, + rank( + params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - uploadFile( - params: Params$Resource$Projects$Locations$Notebooks$Sources$Uploadfile, + rank( + params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - uploadFile( - params: Params$Resource$Projects$Locations$Notebooks$Sources$Uploadfile, - callback: BodyResponseCallback + rank( + params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, + callback: BodyResponseCallback ): void; - uploadFile( - callback: BodyResponseCallback + rank( + callback: BodyResponseCallback ): void; - uploadFile( + rank( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebooks$Sources$Uploadfile - | BodyResponseCallback + | Params$Resource$Projects$Locations$Rankingconfigs$Rank + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebooks$Sources$Uploadfile; + {}) as Params$Resource$Projects$Locations$Rankingconfigs$Rank; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Notebooks$Sources$Uploadfile; + params = {} as Params$Resource$Projects$Locations$Rankingconfigs$Rank; options = {}; } @@ -67414,88 +70656,54 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+parent}/sources/{sourceId}:uploadFile' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+rankingConfig}:rank').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent', 'sourceId'], - pathParams: ['parent', 'sourceId'], + requiredParams: ['rankingConfig'], + pathParams: ['rankingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Notebooks$Sources$Batchcreate - extends StandardParameters { - /** - * Required. The parent resource where the sources will be created. Format: projects/{project\}/locations/{location\}/notebooks/{notebook\} - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudNotebooklmV1alphaBatchCreateSourcesRequest; - } - export interface Params$Resource$Projects$Locations$Notebooks$Sources$Batchdelete - extends StandardParameters { - /** - * Required. The parent resource where the sources will be deleted. Format: projects/{project\}/locations/{location\}/notebooks/{notebook\} - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudNotebooklmV1alphaBatchDeleteSourcesRequest; - } - export interface Params$Resource$Projects$Locations$Notebooks$Sources$Get - extends StandardParameters { - /** - * Required. The resource name for source Format: projects/{project\}/locations/{location\}/notebooks/{notebook\}/sources/{source\} - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Notebooks$Sources$Uploadfile + export interface Params$Resource$Projects$Locations$Rankingconfigs$Rank extends StandardParameters { /** - * Required. The parent resource where the sources will be created. Format: projects/{project\}/locations/{location\}/notebooks/{notebook\} - */ - parent?: string; - /** - * The source id of the associated file. If not set, a source id will be generated and a new tentative source will be created. + * Required. The resource name of the rank service config, such as `projects/{project_num\}/locations/{location\}/rankingConfigs/default_ranking_config`. */ - sourceId?: string; + rankingConfig?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudNotebooklmV1alphaUploadSourceFileRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRankRequest; } - export class Resource$Projects$Locations$Operations { + export class Resource$Projects$Locations$Requirements { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Check a particular requirement. * @example * ```js * // Before running the sample: @@ -67527,19 +70735,29 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/operations/my-operation', - * }); + * const res = + * await discoveryengine.projects.locations.requirements.checkRequirement({ + * // Required. Full resource name of the location. Format `projects/{project_number_or_id\}/locations/{location\}` + * location: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "requirementType": "my_requirementType", + * // "resources": [] + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "metricResults": [], + * // "oldestMetricTimestamp": "my_oldestMetricTimestamp", + * // "requirement": {}, + * // "requirementCondition": {}, + * // "result": "my_result" * // } * } * @@ -67555,57 +70773,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Operations$Get, + checkRequirement( + params: Params$Resource$Projects$Locations$Requirements$Checkrequirement, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Operations$Get, + checkRequirement( + params?: Params$Resource$Projects$Locations$Requirements$Checkrequirement, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Operations$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + checkRequirement( + params: Params$Resource$Projects$Locations$Requirements$Checkrequirement, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Operations$Get, + checkRequirement( + params: Params$Resource$Projects$Locations$Requirements$Checkrequirement, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Operations$Get, - callback: BodyResponseCallback + checkRequirement( + params: Params$Resource$Projects$Locations$Requirements$Checkrequirement, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + checkRequirement( + callback: BodyResponseCallback ): void; - get( + checkRequirement( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Requirements$Checkrequirement + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Get; + {}) as Params$Resource$Projects$Locations$Requirements$Checkrequirement; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Get; + params = + {} as Params$Resource$Projects$Locations$Requirements$Checkrequirement; options = {}; } @@ -67619,29 +70842,63 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: ( + rootUrl + '/v1alpha/{+location}/requirements:checkRequirement' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['location'], + pathParams: ['location'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Requirements$Checkrequirement + extends StandardParameters { /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Required. Full resource name of the location. Format `projects/{project_number_or_id\}/locations/{location\}` + */ + location?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaCheckRequirementRequest; + } + + export class Resource$Projects$Locations$Samplequerysets { + context: APIRequestContext; + operations: Resource$Projects$Locations$Samplequerysets$Operations; + sampleQueries: Resource$Projects$Locations$Samplequerysets$Samplequeries; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Samplequerysets$Operations( + this.context + ); + this.sampleQueries = + new Resource$Projects$Locations$Samplequerysets$Samplequeries( + this.context + ); + } + + /** + * Creates a SampleQuerySet * @example * ```js * // Before running the sample: @@ -67673,25 +70930,31 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', + * const res = await discoveryengine.projects.locations.sampleQuerySets.create({ + * // Required. The parent resource name, such as `projects/{project\}/locations/{location\}`. + * parent: 'projects/my-project/locations/my-location', + * // Required. The ID to use for the SampleQuerySet, which will become the final component of the SampleQuerySet.name. If the caller does not have permission to create the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerySets with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + * sampleQuerySetId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "name": "my_name" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "name": "my_name" * // } * } * @@ -67707,61 +70970,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Operations$List, + create( + params: Params$Resource$Projects$Locations$Samplequerysets$Create, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Operations$List, + create( + params?: Params$Resource$Projects$Locations$Samplequerysets$Create, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Operations$List, + create( + params: Params$Resource$Projects$Locations$Samplequerysets$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Operations$List, + create( + params: Params$Resource$Projects$Locations$Samplequerysets$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Operations$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Samplequerysets$Create, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - list( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$List; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$List; + params = + {} as Params$Resource$Projects$Locations$Samplequerysets$Create; options = {}; } @@ -67775,83 +71039,34 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}/operations').replace( + url: (rootUrl + '/v1alpha/{+parent}/sampleQuerySets').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - - export class Resource$Projects$Locations$Podcasts { - context: APIRequestContext; - operations: Resource$Projects$Locations$Podcasts$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = new Resource$Projects$Locations$Podcasts$Operations( - this.context - ); - } - } - - export class Resource$Projects$Locations$Podcasts$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Deletes a SampleQuerySet. * @example * ```js * // Before running the sample: @@ -67883,20 +71098,14 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.podcasts.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/podcasts/my-podcast/operations/my-operation', + * const res = await discoveryengine.projects.locations.sampleQuerySets.delete({ + * // Required. Full resource name of SampleQuerySet, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sample_query_set\}`. If the caller does not have permission to delete the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to delete does not exist, a `NOT_FOUND` error is returned. + * name: 'projects/my-project/locations/my-location/sampleQuerySets/my-sampleQuerySet', * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -67911,58 +71120,54 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Podcasts$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Samplequerysets$Delete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Podcasts$Operations$Get, + delete( + params?: Params$Resource$Projects$Locations$Samplequerysets$Delete, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Podcasts$Operations$Get, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Samplequerysets$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Podcasts$Operations$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Podcasts$Operations$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Samplequerysets$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Samplequerysets$Delete, + callback: BodyResponseCallback ): void; - get( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Podcasts$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Podcasts$Operations$Get; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Podcasts$Operations$Get; + {} as Params$Resource$Projects$Locations$Samplequerysets$Delete; options = {}; } @@ -67977,43 +71182,28 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Podcasts$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - - export class Resource$Projects$Locations$Rankingconfigs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } } /** - * Ranks a list of text records based on the given input query. + * Gets a SampleQuerySet. * @example * ```js * // Before running the sample: @@ -68045,29 +71235,18 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.rankingConfigs.rank({ - * // Required. The resource name of the rank service config, such as `projects/{project_num\}/locations/{location\}/rankingConfigs/default_ranking_config`. - * rankingConfig: - * 'projects/my-project/locations/my-location/rankingConfigs/my-rankingConfig', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "ignoreRecordDetailsInResponse": false, - * // "model": "my_model", - * // "query": "my_query", - * // "records": [], - * // "topN": 0, - * // "userLabels": {} - * // } - * }, + * const res = await discoveryengine.projects.locations.sampleQuerySets.get({ + * // Required. Full resource name of SampleQuerySet, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sample_query_set\}`. If the caller does not have permission to access the SampleQuerySet, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuerySet does not exist, a NOT_FOUND error is returned. + * name: 'projects/my-project/locations/my-location/sampleQuerySets/my-sampleQuerySet', * }); * console.log(res.data); * * // Example response * // { - * // "records": [] + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "name": "my_name" * // } * } * @@ -68083,61 +71262,61 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - rank( - params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Get, options: StreamMethodOptions ): Promise>; - rank( - params?: Params$Resource$Projects$Locations$Rankingconfigs$Rank, + get( + params?: Params$Resource$Projects$Locations$Samplequerysets$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - rank( - params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - rank( - params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - rank( - params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Get, + callback: BodyResponseCallback ): void; - rank( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - rank( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Rankingconfigs$Rank - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Rankingconfigs$Rank; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Rankingconfigs$Rank; + params = {} as Params$Resource$Projects$Locations$Samplequerysets$Get; options = {}; } @@ -68151,54 +71330,31 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+rankingConfig}:rank').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['rankingConfig'], - pathParams: ['rankingConfig'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Rankingconfigs$Rank - extends StandardParameters { - /** - * Required. The resource name of the rank service config, such as `projects/{project_num\}/locations/{location\}/rankingConfigs/default_ranking_config`. - */ - rankingConfig?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRankRequest; - } - - export class Resource$Projects$Locations$Requirements { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Check a particular requirement. + * Gets a list of SampleQuerySets. * @example * ```js * // Before running the sample: @@ -68230,29 +71386,20 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await discoveryengine.projects.locations.requirements.checkRequirement({ - * // Required. Full resource name of the location. Format `projects/{project_number_or_id\}/locations/{location\}` - * location: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "requirementType": "my_requirementType", - * // "resources": [] - * // } - * }, - * }); + * const res = await discoveryengine.projects.locations.sampleQuerySets.list({ + * // Maximum number of SampleQuerySets to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + * pageSize: 'placeholder-value', + * // A page token ListSampleQuerySetsResponse.next_page_token, received from a previous SampleQuerySetService.ListSampleQuerySets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQuerySetService.ListSampleQuerySets must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + * pageToken: 'placeholder-value', + * // Required. The parent location resource name, such as `projects/{project\}/locations/{location\}`. If the caller does not have permission to list SampleQuerySets under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned. + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { - * // "metricResults": [], - * // "oldestMetricTimestamp": "my_oldestMetricTimestamp", - * // "requirement": {}, - * // "requirementCondition": {}, - * // "result": "my_result" + * // "nextPageToken": "my_nextPageToken", + * // "sampleQuerySets": [] * // } * } * @@ -68268,62 +71415,61 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - checkRequirement( - params: Params$Resource$Projects$Locations$Requirements$Checkrequirement, + list( + params: Params$Resource$Projects$Locations$Samplequerysets$List, options: StreamMethodOptions ): Promise>; - checkRequirement( - params?: Params$Resource$Projects$Locations$Requirements$Checkrequirement, + list( + params?: Params$Resource$Projects$Locations$Samplequerysets$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - checkRequirement( - params: Params$Resource$Projects$Locations$Requirements$Checkrequirement, + list( + params: Params$Resource$Projects$Locations$Samplequerysets$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - checkRequirement( - params: Params$Resource$Projects$Locations$Requirements$Checkrequirement, + list( + params: Params$Resource$Projects$Locations$Samplequerysets$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - checkRequirement( - params: Params$Resource$Projects$Locations$Requirements$Checkrequirement, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Samplequerysets$List, + callback: BodyResponseCallback ): void; - checkRequirement( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - checkRequirement( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Requirements$Checkrequirement - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Requirements$Checkrequirement; + {}) as Params$Resource$Projects$Locations$Samplequerysets$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Requirements$Checkrequirement; + params = {} as Params$Resource$Projects$Locations$Samplequerysets$List; options = {}; } @@ -68337,63 +71483,34 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+location}/requirements:checkRequirement' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1alpha/{+parent}/sampleQuerySets').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['location'], - pathParams: ['location'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Requirements$Checkrequirement - extends StandardParameters { - /** - * Required. Full resource name of the location. Format `projects/{project_number_or_id\}/locations/{location\}` - */ - location?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaCheckRequirementRequest; - } - - export class Resource$Projects$Locations$Samplequerysets { - context: APIRequestContext; - operations: Resource$Projects$Locations$Samplequerysets$Operations; - sampleQueries: Resource$Projects$Locations$Samplequerysets$Samplequeries; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Samplequerysets$Operations( - this.context - ); - this.sampleQueries = - new Resource$Projects$Locations$Samplequerysets$Samplequeries( - this.context - ); - } /** - * Creates a SampleQuerySet + * Updates a SampleQuerySet. * @example * ```js * // Before running the sample: @@ -68425,11 +71542,11 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.sampleQuerySets.create({ - * // Required. The parent resource name, such as `projects/{project\}/locations/{location\}`. - * parent: 'projects/my-project/locations/my-location', - * // Required. The ID to use for the SampleQuerySet, which will become the final component of the SampleQuerySet.name. If the caller does not have permission to create the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerySets with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. - * sampleQuerySetId: 'placeholder-value', + * const res = await discoveryengine.projects.locations.sampleQuerySets.patch({ + * // Identifier. The full resource name of the SampleQuerySet, in the format of `projects/{project\}/locations/{location\}/sampleQuerySets/{sample_query_set\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * name: 'projects/my-project/locations/my-location/sampleQuerySets/my-sampleQuerySet', + * // Indicates which fields in the provided imported 'sample query set' to update. If not set, will by default update all fields. + * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { @@ -68465,38 +71582,38 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Samplequerysets$Create, + patch( + params: Params$Resource$Projects$Locations$Samplequerysets$Patch, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Samplequerysets$Create, + patch( + params?: Params$Resource$Projects$Locations$Samplequerysets$Patch, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; - create( - params: Params$Resource$Projects$Locations$Samplequerysets$Create, + patch( + params: Params$Resource$Projects$Locations$Samplequerysets$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Samplequerysets$Create, + patch( + params: Params$Resource$Projects$Locations$Samplequerysets$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Samplequerysets$Create, + patch( + params: Params$Resource$Projects$Locations$Samplequerysets$Patch, callback: BodyResponseCallback ): void; - create( + patch( callback: BodyResponseCallback ): void; - create( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Samplequerysets$Create + | Params$Resource$Projects$Locations$Samplequerysets$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -68514,13 +71631,12 @@ export namespace discoveryengine_v1alpha { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Samplequerysets$Create; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Samplequerysets$Create; + params = {} as Params$Resource$Projects$Locations$Samplequerysets$Patch; options = {}; } @@ -68534,18 +71650,15 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/sampleQuerySets').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -68559,9 +71672,78 @@ export namespace discoveryengine_v1alpha { ); } } + } + export interface Params$Resource$Projects$Locations$Samplequerysets$Create + extends StandardParameters { /** - * Deletes a SampleQuerySet. + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}`. + */ + parent?: string; + /** + * Required. The ID to use for the SampleQuerySet, which will become the final component of the SampleQuerySet.name. If the caller does not have permission to create the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerySets with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + sampleQuerySetId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSampleQuerySet; + } + export interface Params$Resource$Projects$Locations$Samplequerysets$Delete + extends StandardParameters { + /** + * Required. Full resource name of SampleQuerySet, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sample_query_set\}`. If the caller does not have permission to delete the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to delete does not exist, a `NOT_FOUND` error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Samplequerysets$Get + extends StandardParameters { + /** + * Required. Full resource name of SampleQuerySet, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sample_query_set\}`. If the caller does not have permission to access the SampleQuerySet, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuerySet does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Samplequerysets$List + extends StandardParameters { + /** + * Maximum number of SampleQuerySets to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + */ + pageSize?: number; + /** + * A page token ListSampleQuerySetsResponse.next_page_token, received from a previous SampleQuerySetService.ListSampleQuerySets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQuerySetService.ListSampleQuerySets must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + pageToken?: string; + /** + * Required. The parent location resource name, such as `projects/{project\}/locations/{location\}`. If the caller does not have permission to list SampleQuerySets under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Samplequerysets$Patch + extends StandardParameters { + /** + * Identifier. The full resource name of the SampleQuerySet, in the format of `projects/{project\}/locations/{location\}/sampleQuerySets/{sample_query_set\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string; + /** + * Indicates which fields in the provided imported 'sample query set' to update. If not set, will by default update all fields. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSampleQuerySet; + } + + export class Resource$Projects$Locations$Samplequerysets$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -68593,14 +71775,21 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.sampleQuerySets.delete({ - * // Required. Full resource name of SampleQuerySet, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sample_query_set\}`. If the caller does not have permission to delete the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to delete does not exist, a `NOT_FOUND` error is returned. - * name: 'projects/my-project/locations/my-location/sampleQuerySets/my-sampleQuerySet', - * }); + * const res = + * await discoveryengine.projects.locations.sampleQuerySets.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/sampleQuerySets/my-sampleQuerySet/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -68615,54 +71804,58 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Samplequerysets$Delete, + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Samplequerysets$Delete, + get( + params?: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Samplequerysets$Delete, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Samplequerysets$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Samplequerysets$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Samplequerysets$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Samplequerysets$Delete; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Samplequerysets$Delete; + {} as Params$Resource$Projects$Locations$Samplequerysets$Operations$Get; options = {}; } @@ -68677,7 +71870,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -68688,17 +71881,32 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Samplequerysets$Operations$Get + extends StandardParameters { /** - * Gets a SampleQuerySet. + * The name of the operation resource. + */ + name?: string; + } + + export class Resource$Projects$Locations$Samplequerysets$Samplequeries { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a SampleQuery * @example * ```js * // Before running the sample: @@ -68730,18 +71938,33 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.sampleQuerySets.get({ - * // Required. Full resource name of SampleQuerySet, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sample_query_set\}`. If the caller does not have permission to access the SampleQuerySet, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuerySet does not exist, a NOT_FOUND error is returned. - * name: 'projects/my-project/locations/my-location/sampleQuerySets/my-sampleQuerySet', - * }); + * const res = + * await discoveryengine.projects.locations.sampleQuerySets.sampleQueries.create( + * { + * // Required. The parent resource name, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. + * parent: + * 'projects/my-project/locations/my-location/sampleQuerySets/my-sampleQuerySet', + * // Required. The ID to use for the SampleQuery, which will become the final component of the SampleQuery.name. If the caller does not have permission to create the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerys with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + * sampleQueryId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "name": "my_name", + * // "queryEntry": {} + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "name": "my_name" + * // "name": "my_name", + * // "queryEntry": {} * // } * } * @@ -68757,61 +71980,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Samplequerysets$Get, + create( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Samplequerysets$Get, + create( + params?: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Samplequerysets$Get, + create( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Samplequerysets$Get, + create( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Samplequerysets$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Samplequerysets$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Samplequerysets$Get; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Samplequerysets$Get; + params = + {} as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create; options = {}; } @@ -68825,31 +72049,34 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+parent}/sampleQueries').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets a list of SampleQuerySets. + * Deletes a SampleQuery. * @example * ```js * // Before running the sample: @@ -68881,21 +72108,17 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.sampleQuerySets.list({ - * // Maximum number of SampleQuerySets to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. - * pageSize: 'placeholder-value', - * // A page token ListSampleQuerySetsResponse.next_page_token, received from a previous SampleQuerySetService.ListSampleQuerySets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQuerySetService.ListSampleQuerySets must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. - * pageToken: 'placeholder-value', - * // Required. The parent location resource name, such as `projects/{project\}/locations/{location\}`. If the caller does not have permission to list SampleQuerySets under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned. - * parent: 'projects/my-project/locations/my-location', - * }); + * const res = + * await discoveryengine.projects.locations.sampleQuerySets.sampleQueries.delete( + * { + * // Required. Full resource name of SampleQuery, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sample_query_set\}/sampleQueries/{sample_query\}`. If the caller does not have permission to delete the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuery to delete does not exist, a `NOT_FOUND` error is returned. + * name: 'projects/my-project/locations/my-location/sampleQuerySets/my-sampleQuerySet/sampleQueries/my-sampleQuerie', + * }, + * ); * console.log(res.data); * * // Example response - * // { - * // "nextPageToken": "my_nextPageToken", - * // "sampleQuerySets": [] - * // } + * // {} * } * * main().catch(e => { @@ -68910,61 +72133,54 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Samplequerysets$List, + delete( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Samplequerysets$List, + delete( + params?: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Samplequerysets$List, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Samplequerysets$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Samplequerysets$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Samplequerysets$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Samplequerysets$List; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Samplequerysets$List; + params = + {} as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete; options = {}; } @@ -68978,34 +72194,29 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/sampleQuerySets').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a SampleQuerySet. + * Gets a SampleQuery. * @example * ```js * // Before running the sample: @@ -69037,31 +72248,18 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.sampleQuerySets.patch({ - * // Identifier. The full resource name of the SampleQuerySet, in the format of `projects/{project\}/locations/{location\}/sampleQuerySets/{sample_query_set\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - * name: 'projects/my-project/locations/my-location/sampleQuerySets/my-sampleQuerySet', - * // Indicates which fields in the provided imported 'sample query set' to update. If not set, will by default update all fields. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "name": "my_name" - * // } - * }, - * }); + * const res = + * await discoveryengine.projects.locations.sampleQuerySets.sampleQueries.get({ + * // Required. Full resource name of SampleQuery, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sample_query_set\}/sampleQueries/{sample_query\}`. If the caller does not have permission to access the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is returned. + * name: 'projects/my-project/locations/my-location/sampleQuerySets/my-sampleQuerySet/sampleQueries/my-sampleQuerie', + * }); * console.log(res.data); * * // Example response * // { * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "name": "my_name" + * // "name": "my_name", + * // "queryEntry": {} * // } * } * @@ -69077,61 +72275,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Samplequerysets$Patch, + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Samplequerysets$Patch, + get( + params?: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - patch( - params: Params$Resource$Projects$Locations$Samplequerysets$Patch, + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Samplequerysets$Patch, + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Samplequerysets$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Samplequerysets$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Samplequerysets$Patch; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Samplequerysets$Patch; + params = + {} as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get; options = {}; } @@ -69146,7 +72345,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -69157,88 +72356,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Samplequerysets$Create - extends StandardParameters { - /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}`. - */ - parent?: string; - /** - * Required. The ID to use for the SampleQuerySet, which will become the final component of the SampleQuerySet.name. If the caller does not have permission to create the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerySets with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. - */ - sampleQuerySetId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSampleQuerySet; - } - export interface Params$Resource$Projects$Locations$Samplequerysets$Delete - extends StandardParameters { - /** - * Required. Full resource name of SampleQuerySet, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sample_query_set\}`. If the caller does not have permission to delete the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to delete does not exist, a `NOT_FOUND` error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Samplequerysets$Get - extends StandardParameters { - /** - * Required. Full resource name of SampleQuerySet, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sample_query_set\}`. If the caller does not have permission to access the SampleQuerySet, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuerySet does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Samplequerysets$List - extends StandardParameters { - /** - * Maximum number of SampleQuerySets to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. - */ - pageSize?: number; - /** - * A page token ListSampleQuerySetsResponse.next_page_token, received from a previous SampleQuerySetService.ListSampleQuerySets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQuerySetService.ListSampleQuerySets must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. - */ - pageToken?: string; - /** - * Required. The parent location resource name, such as `projects/{project\}/locations/{location\}`. If the caller does not have permission to list SampleQuerySets under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Samplequerysets$Patch - extends StandardParameters { - /** - * Identifier. The full resource name of the SampleQuerySet, in the format of `projects/{project\}/locations/{location\}/sampleQuerySets/{sample_query_set\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - */ - name?: string; - /** - * Indicates which fields in the provided imported 'sample query set' to update. If not set, will by default update all fields. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSampleQuerySet; - } - - export class Resource$Projects$Locations$Samplequerysets$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Bulk import of multiple SampleQuerys. Sample queries that already exist may be deleted. Note: It is possible for a subset of the SampleQuerys to be successfully imported. * @example * ```js * // Before running the sample: @@ -69271,10 +72401,24 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.sampleQuerySets.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/sampleQuerySets/my-sampleQuerySet/operations/my-operation', - * }); + * await discoveryengine.projects.locations.sampleQuerySets.sampleQueries.import( + * { + * // Required. The parent sample query set resource name, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned. + * parent: + * 'projects/my-project/locations/my-location/sampleQuerySets/my-sampleQuerySet', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bigquerySource": {}, + * // "errorConfig": {}, + * // "gcsSource": {}, + * // "inlineSource": {} + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response @@ -69299,36 +72443,36 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, + import( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, + import( + params?: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import, options?: MethodOptions ): Promise>; - get( - params: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, + import( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, + import( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, + import( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import, callback: BodyResponseCallback ): void; - get( + import( callback: BodyResponseCallback ): void; - get( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Samplequerysets$Operations$Get + | Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -69344,13 +72488,13 @@ export namespace discoveryengine_v1alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Samplequerysets$Operations$Get; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Samplequerysets$Operations$Get; + {} as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import; options = {}; } @@ -69364,15 +72508,18 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+parent}/sampleQueries:import').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -69384,24 +72531,9 @@ export namespace discoveryengine_v1alpha { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Samplequerysets$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - - export class Resource$Projects$Locations$Samplequerysets$Samplequeries { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Creates a SampleQuery + * Gets a list of SampleQuerys. * @example * ```js * // Before running the sample: @@ -69434,32 +72566,23 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.sampleQuerySets.sampleQueries.create( + * await discoveryengine.projects.locations.sampleQuerySets.sampleQueries.list( * { - * // Required. The parent resource name, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. + * // Maximum number of SampleQuerys to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + * pageSize: 'placeholder-value', + * // A page token ListSampleQueriesResponse.next_page_token, received from a previous SampleQueryService.ListSampleQueries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQueryService.ListSampleQueries must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + * pageToken: 'placeholder-value', + * // Required. The parent sample query set resource name, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned. * parent: * 'projects/my-project/locations/my-location/sampleQuerySets/my-sampleQuerySet', - * // Required. The ID to use for the SampleQuery, which will become the final component of the SampleQuery.name. If the caller does not have permission to create the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerys with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. - * sampleQueryId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "name": "my_name", - * // "queryEntry": {} - * // } - * }, * }, * ); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "name": "my_name", - * // "queryEntry": {} + * // "nextPageToken": "my_nextPageToken", + * // "sampleQueries": [] * // } * } * @@ -69475,62 +72598,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create, + list( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create, + list( + params?: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - create( - params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create, + list( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create, + list( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - create( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create; + {} as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List; options = {}; } @@ -69548,7 +72671,7 @@ export namespace discoveryengine_v1alpha { /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -69559,19 +72682,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a SampleQuery. + * Updates a SampleQuery. * @example * ```js * // Before running the sample: @@ -69604,16 +72727,32 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.sampleQuerySets.sampleQueries.delete( + * await discoveryengine.projects.locations.sampleQuerySets.sampleQueries.patch( * { - * // Required. Full resource name of SampleQuery, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sample_query_set\}/sampleQueries/{sample_query\}`. If the caller does not have permission to delete the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuery to delete does not exist, a `NOT_FOUND` error is returned. + * // Identifier. The full resource name of the sample query, in the format of `projects/{project\}/locations/{location\}/sampleQuerySets/{sample_query_set\}/sampleQueries/{sample_query\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. * name: 'projects/my-project/locations/my-location/sampleQuerySets/my-sampleQuerySet/sampleQueries/my-sampleQuerie', + * // Indicates which fields in the provided imported 'simple query' to update. If not set, will by default update all fields. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "name": "my_name", + * // "queryEntry": {} + * // } + * }, * }, * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "createTime": "my_createTime", + * // "name": "my_name", + * // "queryEntry": {} + * // } * } * * main().catch(e => { @@ -69628,54 +72767,62 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete, + patch( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete, + patch( + params?: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + patch( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete; + {} as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch; options = {}; } @@ -69690,7 +72837,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'PATCH', apiVersion: '', }, options @@ -69701,17 +72848,100 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + + export interface Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create + extends StandardParameters { + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. + */ + parent?: string; + /** + * Required. The ID to use for the SampleQuery, which will become the final component of the SampleQuery.name. If the caller does not have permission to create the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerys with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + sampleQueryId?: string; /** - * Gets a SampleQuery. + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSampleQuery; + } + export interface Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete + extends StandardParameters { + /** + * Required. Full resource name of SampleQuery, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sample_query_set\}/sampleQueries/{sample_query\}`. If the caller does not have permission to delete the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuery to delete does not exist, a `NOT_FOUND` error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get + extends StandardParameters { + /** + * Required. Full resource name of SampleQuery, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sample_query_set\}/sampleQueries/{sample_query\}`. If the caller does not have permission to access the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import + extends StandardParameters { + /** + * Required. The parent sample query set resource name, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequest; + } + export interface Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List + extends StandardParameters { + /** + * Maximum number of SampleQuerys to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + */ + pageSize?: number; + /** + * A page token ListSampleQueriesResponse.next_page_token, received from a previous SampleQueryService.ListSampleQueries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQueryService.ListSampleQueries must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + pageToken?: string; + /** + * Required. The parent sample query set resource name, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch + extends StandardParameters { + /** + * Identifier. The full resource name of the sample query, in the format of `projects/{project\}/locations/{location\}/sampleQuerySets/{sample_query_set\}/sampleQueries/{sample_query\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string; + /** + * Indicates which fields in the provided imported 'simple query' to update. If not set, will by default update all fields. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSampleQuery; + } + + export class Resource$Projects$Locations$Userevents { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly. * @example * ```js * // Before running the sample: @@ -69734,6 +72964,7 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -69743,18 +72974,23 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await discoveryengine.projects.locations.sampleQuerySets.sampleQueries.get({ - * // Required. Full resource name of SampleQuery, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sample_query_set\}/sampleQueries/{sample_query\}`. If the caller does not have permission to access the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is returned. - * name: 'projects/my-project/locations/my-location/sampleQuerySets/my-sampleQuerySet/sampleQueries/my-sampleQuerie', - * }); + * const res = await discoveryengine.projects.locations.userEvents.collect({ + * // The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. + * ets: 'placeholder-value', + * // Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`. + * parent: 'projects/my-project/locations/my-location', + * // The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests. + * uri: 'placeholder-value', + * // Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. + * userEvent: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "name": "my_name", - * // "queryEntry": {} + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] * // } * } * @@ -69770,62 +73006,53 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get, + collect( + params: Params$Resource$Projects$Locations$Userevents$Collect, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get, + collect( + params?: Params$Resource$Projects$Locations$Userevents$Collect, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get, + ): Promise>; + collect( + params: Params$Resource$Projects$Locations$Userevents$Collect, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get, - callback: BodyResponseCallback + collect( + params: Params$Resource$Projects$Locations$Userevents$Collect, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + collect( + params: Params$Resource$Projects$Locations$Userevents$Collect, + callback: BodyResponseCallback ): void; - get( + collect(callback: BodyResponseCallback): void; + collect( paramsOrCallback?: - | Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Userevents$Collect + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get; + {}) as Params$Resource$Projects$Locations$Userevents$Collect; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get; + params = {} as Params$Resource$Projects$Locations$Userevents$Collect; options = {}; } @@ -69839,31 +73066,32 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+parent}/userEvents:collect').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Bulk import of multiple SampleQuerys. Sample queries that already exist may be deleted. Note: It is possible for a subset of the SampleQuerys to be successfully imported. + * Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata. * @example * ```js * // Before running the sample: @@ -69886,6 +73114,7 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -69895,25 +73124,21 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await discoveryengine.projects.locations.sampleQuerySets.sampleQueries.import( - * { - * // Required. The parent sample query set resource name, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned. - * parent: - * 'projects/my-project/locations/my-location/sampleQuerySets/my-sampleQuerySet', + * const res = await discoveryengine.projects.locations.userEvents.import({ + * // Required. Parent DataStore resource name, of the form `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}` + * parent: 'projects/my-project/locations/my-location', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "bigquerySource": {}, - * // "errorConfig": {}, - * // "gcsSource": {}, - * // "inlineSource": {} - * // } - * }, - * }, - * ); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bigquerySource": {}, + * // "errorConfig": {}, + * // "gcsSource": {}, + * // "inlineSource": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response @@ -69939,27 +73164,27 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ import( - params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import, + params: Params$Resource$Projects$Locations$Userevents$Import, options: StreamMethodOptions ): Promise>; import( - params?: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import, + params?: Params$Resource$Projects$Locations$Userevents$Import, options?: MethodOptions ): Promise>; import( - params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import, + params: Params$Resource$Projects$Locations$Userevents$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; import( - params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import, + params: Params$Resource$Projects$Locations$Userevents$Import, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; import( - params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import, + params: Params$Resource$Projects$Locations$Userevents$Import, callback: BodyResponseCallback ): void; import( @@ -69967,7 +73192,7 @@ export namespace discoveryengine_v1alpha { ): void; import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import + | Params$Resource$Projects$Locations$Userevents$Import | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -69983,13 +73208,12 @@ export namespace discoveryengine_v1alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import; + {}) as Params$Resource$Projects$Locations$Userevents$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import; + params = {} as Params$Resource$Projects$Locations$Userevents$Import; options = {}; } @@ -70003,7 +73227,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/sampleQueries:import').replace( + url: (rootUrl + '/v1alpha/{+parent}/userEvents:import').replace( /([^:]\/)\/+/g, '$1' ), @@ -70028,7 +73252,7 @@ export namespace discoveryengine_v1alpha { } /** - * Gets a list of SampleQuerys. + * Writes a single user event. * @example * ```js * // Before running the sample: @@ -70051,6 +73275,7 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -70060,24 +73285,67 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await discoveryengine.projects.locations.sampleQuerySets.sampleQueries.list( - * { - * // Maximum number of SampleQuerys to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. - * pageSize: 'placeholder-value', - * // A page token ListSampleQueriesResponse.next_page_token, received from a previous SampleQueryService.ListSampleQueries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQueryService.ListSampleQueries must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. - * pageToken: 'placeholder-value', - * // Required. The parent sample query set resource name, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned. - * parent: - * 'projects/my-project/locations/my-location/sampleQuerySets/my-sampleQuerySet', - * }, - * ); + * const res = await discoveryengine.projects.locations.userEvents.write({ + * // Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`. + * parent: 'projects/my-project/locations/my-location', + * // If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. + * writeAsync: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "attributes": {}, + * // "attributionToken": "my_attributionToken", + * // "completionInfo": {}, + * // "conversionType": "my_conversionType", + * // "dataStore": "my_dataStore", + * // "directUserRequest": false, + * // "documents": [], + * // "engine": "my_engine", + * // "eventTime": "my_eventTime", + * // "eventType": "my_eventType", + * // "filter": "my_filter", + * // "mediaInfo": {}, + * // "pageInfo": {}, + * // "panel": {}, + * // "panels": [], + * // "promotionIds": [], + * // "searchInfo": {}, + * // "sessionId": "my_sessionId", + * // "tagIds": [], + * // "transactionInfo": {}, + * // "userInfo": {}, + * // "userPseudoId": "my_userPseudoId" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "sampleQueries": [] + * // "attributes": {}, + * // "attributionToken": "my_attributionToken", + * // "completionInfo": {}, + * // "conversionType": "my_conversionType", + * // "dataStore": "my_dataStore", + * // "directUserRequest": false, + * // "documents": [], + * // "engine": "my_engine", + * // "eventTime": "my_eventTime", + * // "eventType": "my_eventType", + * // "filter": "my_filter", + * // "mediaInfo": {}, + * // "pageInfo": {}, + * // "panel": {}, + * // "panels": [], + * // "promotionIds": [], + * // "searchInfo": {}, + * // "sessionId": "my_sessionId", + * // "tagIds": [], + * // "transactionInfo": {}, + * // "userInfo": {}, + * // "userPseudoId": "my_userPseudoId" * // } * } * @@ -70093,62 +73361,61 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List, + write( + params: Params$Resource$Projects$Locations$Userevents$Write, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List, + write( + params?: Params$Resource$Projects$Locations$Userevents$Write, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List, + write( + params: Params$Resource$Projects$Locations$Userevents$Write, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List, + write( + params: Params$Resource$Projects$Locations$Userevents$Write, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List, - callback: BodyResponseCallback + write( + params: Params$Resource$Projects$Locations$Userevents$Write, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + write( + callback: BodyResponseCallback ): void; - list( + write( paramsOrCallback?: - | Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Userevents$Write + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List; + {}) as Params$Resource$Projects$Locations$Userevents$Write; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List; + params = {} as Params$Resource$Projects$Locations$Userevents$Write; options = {}; } @@ -70162,11 +73429,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/sampleQueries').replace( + url: (rootUrl + '/v1alpha/{+parent}/userEvents:write').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -70177,19 +73444,81 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Userevents$Collect + extends StandardParameters { /** - * Updates a SampleQuery. + * The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. + */ + ets?: string; + /** + * Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`. + */ + parent?: string; + /** + * The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests. + */ + uri?: string; + /** + * Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. + */ + userEvent?: string; + } + export interface Params$Resource$Projects$Locations$Userevents$Import + extends StandardParameters { + /** + * Required. Parent DataStore resource name, of the form `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest; + } + export interface Params$Resource$Projects$Locations$Userevents$Write + extends StandardParameters { + /** + * Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`. + */ + parent?: string; + /** + * If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. + */ + writeAsync?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaUserEvent; + } + + export class Resource$Projects$Locations$Userstores { + context: APIRequestContext; + operations: Resource$Projects$Locations$Userstores$Operations; + userLicenses: Resource$Projects$Locations$Userstores$Userlicenses; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Projects$Locations$Userstores$Operations( + this.context + ); + this.userLicenses = + new Resource$Projects$Locations$Userstores$Userlicenses(this.context); + } + + /** + * Updates the User License. This method is used for batch assign/unassign licenses to users. * @example * ```js * // Before running the sample: @@ -70222,20 +73551,18 @@ export namespace discoveryengine_v1alpha { * * // Do the magic * const res = - * await discoveryengine.projects.locations.sampleQuerySets.sampleQueries.patch( + * await discoveryengine.projects.locations.userStores.batchUpdateUserLicenses( * { - * // Identifier. The full resource name of the sample query, in the format of `projects/{project\}/locations/{location\}/sampleQuerySets/{sample_query_set\}/sampleQueries/{sample_query\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - * name: 'projects/my-project/locations/my-location/sampleQuerySets/my-sampleQuerySet/sampleQueries/my-sampleQuerie', - * // Indicates which fields in the provided imported 'simple query' to update. If not set, will by default update all fields. - * updateMask: 'placeholder-value', + * // Required. The parent UserStore resource name, format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`. + * parent: + * 'projects/my-project/locations/my-location/userStores/my-userStore', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "createTime": "my_createTime", - * // "name": "my_name", - * // "queryEntry": {} + * // "deleteUnassignedUserLicenses": false, + * // "inlineSource": {} * // } * }, * }, @@ -70244,9 +73571,11 @@ export namespace discoveryengine_v1alpha { * * // Example response * // { - * // "createTime": "my_createTime", + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "queryEntry": {} + * // "response": {} * // } * } * @@ -70262,62 +73591,58 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch, + batchUpdateUserLicenses( + params: Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch, + batchUpdateUserLicenses( + params?: Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - patch( - params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch, + ): Promise>; + batchUpdateUserLicenses( + params: Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch, + batchUpdateUserLicenses( + params: Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch, - callback: BodyResponseCallback + batchUpdateUserLicenses( + params: Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + batchUpdateUserLicenses( + callback: BodyResponseCallback ): void; - patch( + batchUpdateUserLicenses( paramsOrCallback?: - | Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch; + {}) as Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch; + {} as Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses; options = {}; } @@ -70331,112 +73656,31 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: ( + rootUrl + '/v1alpha/{+parent}:batchUpdateUserLicenses' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create - extends StandardParameters { - /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. - */ - parent?: string; - /** - * Required. The ID to use for the SampleQuery, which will become the final component of the SampleQuery.name. If the caller does not have permission to create the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerys with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. - */ - sampleQueryId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSampleQuery; - } - export interface Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete - extends StandardParameters { - /** - * Required. Full resource name of SampleQuery, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sample_query_set\}/sampleQueries/{sample_query\}`. If the caller does not have permission to delete the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuery to delete does not exist, a `NOT_FOUND` error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get - extends StandardParameters { - /** - * Required. Full resource name of SampleQuery, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sample_query_set\}/sampleQueries/{sample_query\}`. If the caller does not have permission to access the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import - extends StandardParameters { - /** - * Required. The parent sample query set resource name, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequest; - } - export interface Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List - extends StandardParameters { - /** - * Maximum number of SampleQuerys to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. - */ - pageSize?: number; - /** - * A page token ListSampleQueriesResponse.next_page_token, received from a previous SampleQueryService.ListSampleQueries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQueryService.ListSampleQueries must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. - */ - pageToken?: string; - /** - * Required. The parent sample query set resource name, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch - extends StandardParameters { - /** - * Identifier. The full resource name of the sample query, in the format of `projects/{project\}/locations/{location\}/sampleQuerySets/{sample_query_set\}/sampleQueries/{sample_query\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - */ - name?: string; - /** - * Indicates which fields in the provided imported 'simple query' to update. If not set, will by default update all fields. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSampleQuery; - } - - export class Resource$Projects$Locations$Userevents { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly. + * Creates a new User Store. * @example * ```js * // Before running the sample: @@ -70459,7 +73703,6 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -70469,23 +73712,33 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.userEvents.collect({ - * // The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. - * ets: 'placeholder-value', - * // Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`. + * const res = await discoveryengine.projects.locations.userStores.create({ + * // Required. The parent collection resource name, such as `projects/{project\}/locations/{location\}`. * parent: 'projects/my-project/locations/my-location', - * // The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests. - * uri: 'placeholder-value', - * // Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. - * userEvent: 'placeholder-value', + * // Required. The ID of the User Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters. + * userStoreId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "defaultLicenseConfig": "my_defaultLicenseConfig", + * // "displayName": "my_displayName", + * // "enableExpiredLicenseAutoUpdate": false, + * // "enableLicenseAutoRegister": false, + * // "name": "my_name" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] + * // "defaultLicenseConfig": "my_defaultLicenseConfig", + * // "displayName": "my_displayName", + * // "enableExpiredLicenseAutoUpdate": false, + * // "enableLicenseAutoRegister": false, + * // "name": "my_name" * // } * } * @@ -70501,53 +73754,61 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - collect( - params: Params$Resource$Projects$Locations$Userevents$Collect, + create( + params: Params$Resource$Projects$Locations$Userstores$Create, options: StreamMethodOptions ): Promise>; - collect( - params?: Params$Resource$Projects$Locations$Userevents$Collect, + create( + params?: Params$Resource$Projects$Locations$Userstores$Create, options?: MethodOptions - ): Promise>; - collect( - params: Params$Resource$Projects$Locations$Userevents$Collect, + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Userstores$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - collect( - params: Params$Resource$Projects$Locations$Userevents$Collect, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Userstores$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - collect( - params: Params$Resource$Projects$Locations$Userevents$Collect, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Userstores$Create, + callback: BodyResponseCallback ): void; - collect(callback: BodyResponseCallback): void; - collect( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Userevents$Collect - | BodyResponseCallback + | Params$Resource$Projects$Locations$Userstores$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Userevents$Collect; + {}) as Params$Resource$Projects$Locations$Userstores$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Userevents$Collect; + params = {} as Params$Resource$Projects$Locations$Userstores$Create; options = {}; } @@ -70561,11 +73822,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/userEvents:collect').replace( + url: (rootUrl + '/v1alpha/{+parent}/userStores').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -70576,17 +73837,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata. + * Deletes the User Store. * @example * ```js * // Before running the sample: @@ -70609,7 +73872,6 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -70619,20 +73881,9 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.userEvents.import({ - * // Required. Parent DataStore resource name, of the form `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "bigquerySource": {}, - * // "errorConfig": {}, - * // "gcsSource": {}, - * // "inlineSource": {} - * // } - * }, + * const res = await discoveryengine.projects.locations.userStores.delete({ + * // Required. The name of the User Store to delete. Format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}` + * name: 'projects/my-project/locations/my-location/userStores/my-userStore', * }); * console.log(res.data); * @@ -70658,36 +73909,36 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Userevents$Import, + delete( + params: Params$Resource$Projects$Locations$Userstores$Delete, options: StreamMethodOptions ): Promise>; - import( - params?: Params$Resource$Projects$Locations$Userevents$Import, + delete( + params?: Params$Resource$Projects$Locations$Userstores$Delete, options?: MethodOptions ): Promise>; - import( - params: Params$Resource$Projects$Locations$Userevents$Import, + delete( + params: Params$Resource$Projects$Locations$Userstores$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Userevents$Import, + delete( + params: Params$Resource$Projects$Locations$Userstores$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Userevents$Import, + delete( + params: Params$Resource$Projects$Locations$Userstores$Delete, callback: BodyResponseCallback ): void; - import( + delete( callback: BodyResponseCallback ): void; - import( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Userevents$Import + | Params$Resource$Projects$Locations$Userstores$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -70703,12 +73954,12 @@ export namespace discoveryengine_v1alpha { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Userevents$Import; + {}) as Params$Resource$Projects$Locations$Userstores$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Userevents$Import; + params = {} as Params$Resource$Projects$Locations$Userstores$Delete; options = {}; } @@ -70722,18 +73973,15 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/userEvents:import').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -70747,7 +73995,7 @@ export namespace discoveryengine_v1alpha { } /** - * Writes a single user event. + * Gets the User Store. * @example * ```js * // Before running the sample: @@ -70770,7 +74018,6 @@ export namespace discoveryengine_v1alpha { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: [ * 'https://www.googleapis.com/auth/cloud-platform', - * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite', * 'https://www.googleapis.com/auth/discoveryengine.readwrite', * ], * }); @@ -70780,67 +74027,19 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = await discoveryengine.projects.locations.userEvents.write({ - * // Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`. - * parent: 'projects/my-project/locations/my-location', - * // If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. - * writeAsync: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "attributes": {}, - * // "attributionToken": "my_attributionToken", - * // "completionInfo": {}, - * // "conversionType": "my_conversionType", - * // "dataStore": "my_dataStore", - * // "directUserRequest": false, - * // "documents": [], - * // "engine": "my_engine", - * // "eventTime": "my_eventTime", - * // "eventType": "my_eventType", - * // "filter": "my_filter", - * // "mediaInfo": {}, - * // "pageInfo": {}, - * // "panel": {}, - * // "panels": [], - * // "promotionIds": [], - * // "searchInfo": {}, - * // "sessionId": "my_sessionId", - * // "tagIds": [], - * // "transactionInfo": {}, - * // "userInfo": {}, - * // "userPseudoId": "my_userPseudoId" - * // } - * }, + * const res = await discoveryengine.projects.locations.userStores.get({ + * // Required. The name of the User Store to get. Format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}` + * name: 'projects/my-project/locations/my-location/userStores/my-userStore', * }); * console.log(res.data); * * // Example response * // { - * // "attributes": {}, - * // "attributionToken": "my_attributionToken", - * // "completionInfo": {}, - * // "conversionType": "my_conversionType", - * // "dataStore": "my_dataStore", - * // "directUserRequest": false, - * // "documents": [], - * // "engine": "my_engine", - * // "eventTime": "my_eventTime", - * // "eventType": "my_eventType", - * // "filter": "my_filter", - * // "mediaInfo": {}, - * // "pageInfo": {}, - * // "panel": {}, - * // "panels": [], - * // "promotionIds": [], - * // "searchInfo": {}, - * // "sessionId": "my_sessionId", - * // "tagIds": [], - * // "transactionInfo": {}, - * // "userInfo": {}, - * // "userPseudoId": "my_userPseudoId" + * // "defaultLicenseConfig": "my_defaultLicenseConfig", + * // "displayName": "my_displayName", + * // "enableExpiredLicenseAutoUpdate": false, + * // "enableLicenseAutoRegister": false, + * // "name": "my_name" * // } * } * @@ -70856,61 +74055,61 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - write( - params: Params$Resource$Projects$Locations$Userevents$Write, + get( + params: Params$Resource$Projects$Locations$Userstores$Get, options: StreamMethodOptions ): Promise>; - write( - params?: Params$Resource$Projects$Locations$Userevents$Write, + get( + params?: Params$Resource$Projects$Locations$Userstores$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - write( - params: Params$Resource$Projects$Locations$Userevents$Write, + get( + params: Params$Resource$Projects$Locations$Userstores$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - write( - params: Params$Resource$Projects$Locations$Userevents$Write, + get( + params: Params$Resource$Projects$Locations$Userstores$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - write( - params: Params$Resource$Projects$Locations$Userevents$Write, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Userstores$Get, + callback: BodyResponseCallback ): void; - write( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - write( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Userevents$Write - | BodyResponseCallback + | Params$Resource$Projects$Locations$Userstores$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Userevents$Write; + {}) as Params$Resource$Projects$Locations$Userstores$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Userevents$Write; + params = {} as Params$Resource$Projects$Locations$Userstores$Get; options = {}; } @@ -70924,96 +74123,31 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/userEvents:write').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Userevents$Collect - extends StandardParameters { - /** - * The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. - */ - ets?: string; - /** - * Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`. - */ - parent?: string; - /** - * The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests. - */ - uri?: string; - /** - * Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. - */ - userEvent?: string; - } - export interface Params$Resource$Projects$Locations$Userevents$Import - extends StandardParameters { - /** - * Required. Parent DataStore resource name, of the form `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest; - } - export interface Params$Resource$Projects$Locations$Userevents$Write - extends StandardParameters { - /** - * Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`. - */ - parent?: string; - /** - * If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. - */ - writeAsync?: boolean; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaUserEvent; - } - - export class Resource$Projects$Locations$Userstores { - context: APIRequestContext; - operations: Resource$Projects$Locations$Userstores$Operations; - userLicenses: Resource$Projects$Locations$Userstores$Userlicenses; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = new Resource$Projects$Locations$Userstores$Operations( - this.context - ); - this.userLicenses = - new Resource$Projects$Locations$Userstores$Userlicenses(this.context); - } /** - * Updates the User License. This method is used for batch assign/unassign licenses to users. + * Updates the User Store. * @example * ```js * // Before running the sample: @@ -71045,32 +74179,33 @@ export namespace discoveryengine_v1alpha { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await discoveryengine.projects.locations.userStores.batchUpdateUserLicenses( - * { - * // Required. The parent UserStore resource name, format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`. - * parent: - * 'projects/my-project/locations/my-location/userStores/my-userStore', + * const res = await discoveryengine.projects.locations.userStores.patch({ + * // Immutable. The full resource name of the User Store, in the format of `projects/{project\}/locations/{location\}/userStores/{user_store\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * name: 'projects/my-project/locations/my-location/userStores/my-userStore', + * // Optional. The list of fields to update. + * updateMask: 'placeholder-value', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "deleteUnassignedUserLicenses": false, - * // "inlineSource": {} - * // } - * }, - * }, - * ); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "defaultLicenseConfig": "my_defaultLicenseConfig", + * // "displayName": "my_displayName", + * // "enableExpiredLicenseAutoUpdate": false, + * // "enableLicenseAutoRegister": false, + * // "name": "my_name" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "defaultLicenseConfig": "my_defaultLicenseConfig", + * // "displayName": "my_displayName", + * // "enableExpiredLicenseAutoUpdate": false, + * // "enableLicenseAutoRegister": false, + * // "name": "my_name" * // } * } * @@ -71086,58 +74221,61 @@ export namespace discoveryengine_v1alpha { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchUpdateUserLicenses( - params: Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses, + patch( + params: Params$Resource$Projects$Locations$Userstores$Patch, options: StreamMethodOptions ): Promise>; - batchUpdateUserLicenses( - params?: Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses, + patch( + params?: Params$Resource$Projects$Locations$Userstores$Patch, options?: MethodOptions - ): Promise>; - batchUpdateUserLicenses( - params: Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses, + ): Promise< + GaxiosResponseWithHTTP2 + >; + patch( + params: Params$Resource$Projects$Locations$Userstores$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchUpdateUserLicenses( - params: Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses, + patch( + params: Params$Resource$Projects$Locations$Userstores$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchUpdateUserLicenses( - params: Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Userstores$Patch, + callback: BodyResponseCallback ): void; - batchUpdateUserLicenses( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - batchUpdateUserLicenses( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses - | BodyResponseCallback + | Params$Resource$Projects$Locations$Userstores$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses; + {}) as Params$Resource$Projects$Locations$Userstores$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses; + params = {} as Params$Resource$Projects$Locations$Userstores$Patch; options = {}; } @@ -71151,26 +74289,26 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+parent}:batchUpdateUserLicenses' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } @@ -71187,6 +74325,52 @@ export namespace discoveryengine_v1alpha { */ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequest; } + export interface Params$Resource$Projects$Locations$Userstores$Create + extends StandardParameters { + /** + * Required. The parent collection resource name, such as `projects/{project\}/locations/{location\}`. + */ + parent?: string; + /** + * Required. The ID of the User Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters. + */ + userStoreId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaUserStore; + } + export interface Params$Resource$Projects$Locations$Userstores$Delete + extends StandardParameters { + /** + * Required. The name of the User Store to delete. Format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Userstores$Get + extends StandardParameters { + /** + * Required. The name of the User Store to get. Format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Userstores$Patch + extends StandardParameters { + /** + * Immutable. The full resource name of the User Store, in the format of `projects/{project\}/locations/{location\}/userStores/{user_store\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string; + /** + * Optional. The list of fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaUserStore; + } export class Resource$Projects$Locations$Userstores$Operations { context: APIRequestContext; diff --git a/src/apis/discoveryengine/v1beta.ts b/src/apis/discoveryengine/v1beta.ts index 0f228378d2..0cd5cef86f 100644 --- a/src/apis/discoveryengine/v1beta.ts +++ b/src/apis/discoveryengine/v1beta.ts @@ -2490,6 +2490,10 @@ export namespace discoveryengine_v1beta { * Optional. Configuration for configurable billing approach. See */ configurableBillingApproach?: string | null; + /** + * Output only. The timestamp when configurable_billing_approach was last updated. + */ + configurableBillingApproachUpdateTime?: string | null; /** * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */ @@ -2735,6 +2739,19 @@ export namespace discoveryengine_v1beta { */ updateTime?: string | null; } + /** + * Metadata related to the progress of the UserStoreService.DeleteUserStore operation. This will be returned by the google.longrunning.Operation.metadata field. Delete UserStore will delete all the end users under the user store, return the number of end users successfully deleted or failed to delete in the metadata. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaDeleteUserStoreMetadata { + /** + * The number of end users under the user store that failed to be deleted. + */ + failureCount?: string | null; + /** + * The number of end users under the user store that were successfully deleted. + */ + successCount?: string | null; + } /** * Defines target endpoints used to connect to third-party sources. */ @@ -3775,6 +3792,10 @@ export namespace discoveryengine_v1beta { * Metadata and configurations for a Google Cloud project in the service. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaProject { + /** + * Output only. The current status of the project's configurable billing. + */ + configurableBillingStatus?: Schema$GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus; /** * Output only. The timestamp when this project is created. */ @@ -3800,6 +3821,23 @@ export namespace discoveryengine_v1beta { ]: Schema$GoogleCloudDiscoveryengineV1alphaProjectServiceTerms; } | null; } + /** + * Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month). + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus { + /** + * Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations. + */ + effectiveIndexingCoreThreshold?: string | null; + /** + * Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations. + */ + effectiveSearchQpmThreshold?: string | null; + /** + * Optional. The start time of the currently active billing subscription. + */ + startTime?: string | null; + } /** * Customer provided configurations. */ @@ -3817,6 +3855,10 @@ export namespace discoveryengine_v1beta { * Model Armor configuration to be used for sanitizing user prompts and LLM responses. */ modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig; + /** + * Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified. + */ + optOutNotebookSharing?: boolean | null; } /** * Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses. @@ -8138,6 +8180,10 @@ export namespace discoveryengine_v1beta { * Optional. Configuration for configurable billing approach. See */ configurableBillingApproach?: string | null; + /** + * Output only. The timestamp when configurable_billing_approach was last updated. + */ + configurableBillingApproachUpdateTime?: string | null; /** * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */ @@ -10014,6 +10060,10 @@ export namespace discoveryengine_v1beta { * Metadata and configurations for a Google Cloud project in the service. */ export interface Schema$GoogleCloudDiscoveryengineV1betaProject { + /** + * Output only. The current status of the project's configurable billing. + */ + configurableBillingStatus?: Schema$GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus; /** * Output only. The timestamp when this project is created. */ @@ -10037,6 +10087,23 @@ export namespace discoveryengine_v1beta { [key: string]: Schema$GoogleCloudDiscoveryengineV1betaProjectServiceTerms; } | null; } + /** + * Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month). + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus { + /** + * Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations. + */ + effectiveIndexingCoreThreshold?: string | null; + /** + * Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations. + */ + effectiveSearchQpmThreshold?: string | null; + /** + * Optional. The start time of the currently active billing subscription. + */ + startTime?: string | null; + } /** * Customer provided configurations. */ @@ -10054,6 +10121,10 @@ export namespace discoveryengine_v1beta { * Model Armor configuration to be used for sanitizing user prompts and LLM responses. */ modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig; + /** + * Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified. + */ + optOutNotebookSharing?: boolean | null; } /** * Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses. @@ -12683,6 +12754,31 @@ export namespace discoveryengine_v1beta { */ userProfile?: string | null; } + /** + * Configures metadata that is used for End User entities. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaUserStore { + /** + * Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured. + */ + defaultLicenseConfig?: string | null; + /** + * The display name of the User Store. + */ + displayName?: string | null; + /** + * Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left. + */ + enableExpiredLicenseAutoUpdate?: boolean | null; + /** + * Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left. + */ + enableLicenseAutoRegister?: boolean | null; + /** + * Immutable. The full resource name of the User Store, in the format of `projects/{project\}/locations/{location\}/userStores/{user_store\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string | null; + } /** * Config to store data store type configuration for workspace data */ @@ -13304,6 +13400,10 @@ export namespace discoveryengine_v1beta { * Optional. Configuration for configurable billing approach. See */ configurableBillingApproach?: string | null; + /** + * Output only. The timestamp when configurable_billing_approach was last updated. + */ + configurableBillingApproachUpdateTime?: string | null; /** * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */ @@ -14172,6 +14272,10 @@ export namespace discoveryengine_v1beta { * Metadata and configurations for a Google Cloud project in the service. */ export interface Schema$GoogleCloudDiscoveryengineV1Project { + /** + * Output only. The current status of the project's configurable billing. + */ + configurableBillingStatus?: Schema$GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus; /** * Output only. The timestamp when this project is created. */ @@ -14195,6 +14299,23 @@ export namespace discoveryengine_v1beta { [key: string]: Schema$GoogleCloudDiscoveryengineV1ProjectServiceTerms; } | null; } + /** + * Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month). + */ + export interface Schema$GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus { + /** + * Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations. + */ + effectiveIndexingCoreThreshold?: string | null; + /** + * Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations. + */ + effectiveSearchQpmThreshold?: string | null; + /** + * Optional. The start time of the currently active billing subscription. + */ + startTime?: string | null; + } /** * Customer provided configurations. */ @@ -14212,6 +14333,10 @@ export namespace discoveryengine_v1beta { * Model Armor configuration to be used for sanitizing user prompts and LLM responses. */ modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig; + /** + * Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified. + */ + optOutNotebookSharing?: boolean | null; } /** * Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses. @@ -14886,6 +15011,31 @@ export namespace discoveryengine_v1beta { */ userProfile?: string | null; } + /** + * Configures metadata that is used for End User entities. + */ + export interface Schema$GoogleCloudDiscoveryengineV1UserStore { + /** + * Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured. + */ + defaultLicenseConfig?: string | null; + /** + * The display name of the User Store. + */ + displayName?: string | null; + /** + * Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left. + */ + enableExpiredLicenseAutoUpdate?: boolean | null; + /** + * Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left. + */ + enableLicenseAutoRegister?: boolean | null; + /** + * Immutable. The full resource name of the User Store, in the format of `projects/{project\}/locations/{location\}/userStores/{user_store\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string | null; + } /** * Config to store data store type configuration for workspace data */ @@ -18100,6 +18250,7 @@ export namespace discoveryengine_v1beta { * // "billingEstimation": {}, * // "cmekConfig": {}, * // "configurableBillingApproach": "my_configurableBillingApproach", + * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -18428,6 +18579,7 @@ export namespace discoveryengine_v1beta { * // "billingEstimation": {}, * // "cmekConfig": {}, * // "configurableBillingApproach": "my_configurableBillingApproach", + * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -18914,6 +19066,7 @@ export namespace discoveryengine_v1beta { * // "billingEstimation": {}, * // "cmekConfig": {}, * // "configurableBillingApproach": "my_configurableBillingApproach", + * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -18943,6 +19096,7 @@ export namespace discoveryengine_v1beta { * // "billingEstimation": {}, * // "cmekConfig": {}, * // "configurableBillingApproach": "my_configurableBillingApproach", + * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -40985,6 +41139,7 @@ export namespace discoveryengine_v1beta { * // "billingEstimation": {}, * // "cmekConfig": {}, * // "configurableBillingApproach": "my_configurableBillingApproach", + * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -41309,6 +41464,7 @@ export namespace discoveryengine_v1beta { * // "billingEstimation": {}, * // "cmekConfig": {}, * // "configurableBillingApproach": "my_configurableBillingApproach", + * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -41788,6 +41944,7 @@ export namespace discoveryengine_v1beta { * // "billingEstimation": {}, * // "cmekConfig": {}, * // "configurableBillingApproach": "my_configurableBillingApproach", + * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -41817,6 +41974,7 @@ export namespace discoveryengine_v1beta { * // "billingEstimation": {}, * // "cmekConfig": {}, * // "configurableBillingApproach": "my_configurableBillingApproach", + * // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime", * // "contentConfig": "my_contentConfig", * // "createTime": "my_createTime", * // "defaultSchemaId": "my_defaultSchemaId", @@ -60633,6 +60791,639 @@ export namespace discoveryengine_v1beta { return createAPIRequest(parameters); } } + + /** + * Creates a new User Store. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1beta'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await discoveryengine.projects.locations.userStores.create({ + * // Required. The parent collection resource name, such as `projects/{project\}/locations/{location\}`. + * parent: 'projects/my-project/locations/my-location', + * // Required. The ID of the User Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters. + * userStoreId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "defaultLicenseConfig": "my_defaultLicenseConfig", + * // "displayName": "my_displayName", + * // "enableExpiredLicenseAutoUpdate": false, + * // "enableLicenseAutoRegister": false, + * // "name": "my_name" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "defaultLicenseConfig": "my_defaultLicenseConfig", + * // "displayName": "my_displayName", + * // "enableExpiredLicenseAutoUpdate": false, + * // "enableLicenseAutoRegister": false, + * // "name": "my_name" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Userstores$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Userstores$Create, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Userstores$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Userstores$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Userstores$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Userstores$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Userstores$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Userstores$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+parent}/userStores').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Deletes the User Store. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1beta'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await discoveryengine.projects.locations.userStores.delete({ + * // Required. The name of the User Store to delete. Format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}` + * name: 'projects/my-project/locations/my-location/userStores/my-userStore', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Userstores$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Userstores$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Userstores$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Userstores$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Userstores$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Userstores$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Userstores$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Userstores$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the User Store. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1beta'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await discoveryengine.projects.locations.userStores.get({ + * // Required. The name of the User Store to get. Format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}` + * name: 'projects/my-project/locations/my-location/userStores/my-userStore', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "defaultLicenseConfig": "my_defaultLicenseConfig", + * // "displayName": "my_displayName", + * // "enableExpiredLicenseAutoUpdate": false, + * // "enableLicenseAutoRegister": false, + * // "name": "my_name" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Userstores$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Userstores$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Userstores$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Userstores$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Userstores$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Userstores$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Userstores$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Userstores$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates the User Store. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const discoveryengine = google.discoveryengine('v1beta'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/discoveryengine.readwrite', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await discoveryengine.projects.locations.userStores.patch({ + * // Immutable. The full resource name of the User Store, in the format of `projects/{project\}/locations/{location\}/userStores/{user_store\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * name: 'projects/my-project/locations/my-location/userStores/my-userStore', + * // Optional. The list of fields to update. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "defaultLicenseConfig": "my_defaultLicenseConfig", + * // "displayName": "my_displayName", + * // "enableExpiredLicenseAutoUpdate": false, + * // "enableLicenseAutoRegister": false, + * // "name": "my_name" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "defaultLicenseConfig": "my_defaultLicenseConfig", + * // "displayName": "my_displayName", + * // "enableExpiredLicenseAutoUpdate": false, + * // "enableLicenseAutoRegister": false, + * // "name": "my_name" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Userstores$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Userstores$Patch, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + patch( + params: Params$Resource$Projects$Locations$Userstores$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Userstores$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Userstores$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Userstores$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Userstores$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Userstores$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } } export interface Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses @@ -60647,6 +61438,52 @@ export namespace discoveryengine_v1beta { */ requestBody?: Schema$GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesRequest; } + export interface Params$Resource$Projects$Locations$Userstores$Create + extends StandardParameters { + /** + * Required. The parent collection resource name, such as `projects/{project\}/locations/{location\}`. + */ + parent?: string; + /** + * Required. The ID of the User Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters. + */ + userStoreId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaUserStore; + } + export interface Params$Resource$Projects$Locations$Userstores$Delete + extends StandardParameters { + /** + * Required. The name of the User Store to delete. Format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Userstores$Get + extends StandardParameters { + /** + * Required. The name of the User Store to get. Format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Userstores$Patch + extends StandardParameters { + /** + * Immutable. The full resource name of the User Store, in the format of `projects/{project\}/locations/{location\}/userStores/{user_store\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string; + /** + * Optional. The list of fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaUserStore; + } export class Resource$Projects$Locations$Userstores$Userlicenses { context: APIRequestContext; diff --git a/src/apis/displayvideo/v3.ts b/src/apis/displayvideo/v3.ts index 4981b82556..723348da25 100644 --- a/src/apis/displayvideo/v3.ts +++ b/src/apis/displayvideo/v3.ts @@ -236,9 +236,13 @@ export namespace displayvideo_v3 { */ adGroupAdId?: string | null; /** - * The unique ID of the ad group that the ad belongs to. + * The unique ID of the ad group that the ad belongs to. *Caution*: Parent ad groups for Demand Gen ads are not currently retrieveable using `advertisers.adGroups.list` or `advertisers.adGroups.get`. Demand Gen ads can be identified by the absence of the `ad_details` union field. */ adGroupId?: string | null; + /** + * The policy approval status of the ad. + */ + adPolicy?: Schema$AdPolicy; /** * List of URLs used by the ad. */ @@ -376,6 +380,349 @@ export namespace displayvideo_v3 { */ videoIabViewability?: string | null; } + /** + * A single ad policy associated with an ad group ad. + */ + export interface Schema$AdPolicy { + /** + * The policy approval status of an ad, indicating the approval decision. + */ + adPolicyApprovalStatus?: string | null; + /** + * The policy review status of an ad, indicating where in the review process the ad is currently. + */ + adPolicyReviewStatus?: string | null; + /** + * The entries for each policy topic identified as relating to the ad. Each entry includes the topic, restriction level, and guidance on how to fix policy issues. + */ + adPolicyTopicEntry?: Schema$AdPolicyTopicEntry[]; + } + /** + * Represents a country restriction. + */ + export interface Schema$AdPolicyCriterionRestriction { + /** + * The country criterion id. + */ + countryCriterionId?: string | null; + /** + * Localized name for the country. May be empty. + */ + countryLabel?: string | null; + } + /** + * Information on how to appeal a policy decision. + */ + export interface Schema$AdPolicyTopicAppealInfo { + /** + * Only available when appeal_type is `APPEAL_FORM`. + */ + appealFormLink?: string | null; + /** + * Whether the decision can be appealed through a self-service appeal or an appeal form. + */ + appealType?: string | null; + } + /** + * Details on ad serving constraints. + */ + export interface Schema$AdPolicyTopicConstraint { + /** + * Countries where the resource's domain is not covered by the certificates associated with it. + */ + certificateDomainMismatchCountryList?: Schema$AdPolicyTopicConstraintAdPolicyCountryConstraintList; + /** + * Countries where a certificate is required for serving. + */ + certificateMissingCountryList?: Schema$AdPolicyTopicConstraintAdPolicyCountryConstraintList; + /** + * Countries where the ad cannot serve. + */ + countryConstraint?: Schema$AdPolicyTopicConstraintAdPolicyCountryConstraintList; + /** + * Certificate is required to serve in any country and the existing certificate does not cover the ad's domain. + */ + globalCertificateDomainMismatch?: Schema$AdPolicyTopicConstraintAdPolicyGlobalCertificateDomainMismatchConstraint; + /** + * Certificate is required to serve in any country. + */ + globalCertificateMissing?: Schema$AdPolicyTopicConstraintAdPolicyGlobalCertificateMissingConstraint; + /** + * Link to the form to request a certificate for the constraint. + */ + requestCertificateFormLink?: string | null; + /** + * Reseller constraint. + */ + resellerConstraint?: Schema$AdPolicyTopicConstraintAdPolicyResellerConstraint; + } + /** + * A list of countries where the ad cannot serve due to policy constraints. + */ + export interface Schema$AdPolicyTopicConstraintAdPolicyCountryConstraintList { + /** + * Countries where the ad cannot serve. + */ + countries?: Schema$AdPolicyCriterionRestriction[]; + } + /** + * Certificate is required to serve in any country and the existing certificate does not cover the ad's domain. + */ + export interface Schema$AdPolicyTopicConstraintAdPolicyGlobalCertificateDomainMismatchConstraint {} + /** + * Certificate is required to serve in any country. + */ + export interface Schema$AdPolicyTopicConstraintAdPolicyGlobalCertificateMissingConstraint {} + /** + * Policy topic was constrained due to disapproval of the website for reseller purposes. + */ + export interface Schema$AdPolicyTopicConstraintAdPolicyResellerConstraint {} + /** + * An entry describing how an ad has been identified as relating to an ad policy. + */ + export interface Schema$AdPolicyTopicEntry { + /** + * Information on how to appeal the policy decision. + */ + appealInfo?: Schema$AdPolicyTopicAppealInfo; + /** + * Ad policy help center link for the policy topic. + */ + helpCenterLink?: string | null; + /** + * The source of the policy decision. + */ + policyDecisionType?: string | null; + /** + * The policy enforcement means used in the policy review. + */ + policyEnforcementMeans?: string | null; + /** + * Localized label text for policy. Examples include "Trademarks in text", "Contains Alcohol", etc. + */ + policyLabel?: string | null; + /** + * The policy topic. Examples include "TRADEMARKS", "ALCOHOL", etc. + */ + policyTopic?: string | null; + /** + * The serving constraints relevant to the policy decision. + */ + policyTopicConstraints?: Schema$AdPolicyTopicConstraint[]; + /** + * A short summary description of the policy topic. + */ + policyTopicDescription?: string | null; + /** + * The evidence used in the policy decision. + */ + policyTopicEvidences?: Schema$AdPolicyTopicEvidence[]; + /** + * How ad serving will be affected due to the relation to the ad policy topic. + */ + policyTopicType?: string | null; + } + /** + * Evidence information used in the policy decision. + */ + export interface Schema$AdPolicyTopicEvidence { + /** + * Counterfeit enforcement that caused a policy violation. + */ + counterfeit?: Schema$AdPolicyTopicEvidenceCounterfeit; + /** + * A mismatch between the ad destination URLs. + */ + destinationMismatch?: Schema$AdPolicyTopicEvidenceDestinationMismatch; + /** + * Information on HTTP or DNS errors related to the ad destination. + */ + destinationNotWorking?: Schema$AdPolicyTopicEvidenceDestinationNotWorking; + /** + * The text in the destination of the ad that is causing a policy violation. + */ + destinationTextList?: Schema$AdPolicyTopicEvidenceDestinationTextList; + /** + * HTTP code returned when the final URL was crawled. + */ + httpCode?: number | null; + /** + * The language the ad was detected to be written in. This field uses IETF language tags, such as "en-US". + */ + languageCode?: string | null; + /** + * Legal related regulation enforcement that caused a policy violation. + */ + legalRemoval?: Schema$AdPolicyTopicEvidenceLegalRemoval; + /** + * T&S proactive enforcement that caused a policy violation. + */ + regionalRequirements?: Schema$AdPolicyTopicEvidenceRegionalRequirements; + /** + * List of evidence found in the text of the ad. + */ + textList?: Schema$AdPolicyTopicEvidenceTextList; + /** + * Trademark terms that caused a policy violation. + */ + trademark?: Schema$AdPolicyTopicEvidenceTrademark; + /** + * List of websites linked with the ad. + */ + websiteList?: Schema$AdPolicyTopicEvidenceWebsiteList; + } + /** + * Details on the counterfeit enforcement that caused a policy violation. + */ + export interface Schema$AdPolicyTopicEvidenceCounterfeit { + /** + * The content or product owners that made a complaint. + */ + owners?: string[] | null; + } + /** + * Details on a mismatch between destination URL types. + */ + export interface Schema$AdPolicyTopicEvidenceDestinationMismatch { + /** + * The set of URLs that do not match. The list can include single or multiple uri types. Example 1: [`DISPLAY_URL`, `FINAL_URL`] means ad display URL does not match with the ad final URL. Example 2: [`FINAL_URL`] means ad final URL did not match the crawled url, which is also considered as destination mismatch. + */ + uriTypes?: string[] | null; + } + /** + * Details for on HTTP or DNS errors related to the ad destination. + */ + export interface Schema$AdPolicyTopicEvidenceDestinationNotWorking { + /** + * The device where visiting the URL resulted in the error. + */ + device?: string | null; + /** + * The type of DNS error. + */ + dnsErrorType?: string | null; + /** + * The full URL that didn't work. + */ + expandedUri?: string | null; + /** + * The HTTP error code. + */ + httpErrorCode?: string | null; + /** + * The last time the error was seen when navigating to URL. + */ + lastCheckedTime?: string | null; + } + /** + * A list of destination text that violated the policy. + */ + export interface Schema$AdPolicyTopicEvidenceDestinationTextList { + /** + * Destination text that caused the policy finding. + */ + destinationTexts?: string[] | null; + } + /** + * Legal related regulation enforcement, either from DMCA or local legal regulation. + */ + export interface Schema$AdPolicyTopicEvidenceLegalRemoval { + /** + * The type of complaint causing the legal removal. + */ + complaintType?: string | null; + /** + * The countries restricted due to the legal removal. + */ + countryRestrictions?: Schema$AdPolicyCriterionRestriction[]; + /** + * Details on the DMCA regulation legal removal. + */ + dmca?: Schema$AdPolicyTopicEvidenceLegalRemovalDmca; + /** + * Details on the local legal regulation legal removal. + */ + localLegal?: Schema$AdPolicyTopicEvidenceLegalRemovalLocalLegal; + /** + * The urls restricted due to the legal removal. + */ + restrictedUris?: string[] | null; + } + /** + * DMCA complaint details. + */ + export interface Schema$AdPolicyTopicEvidenceLegalRemovalDmca { + /** + * The entity who made the legal complaint. + */ + complainant?: string | null; + } + /** + * Local legal regulation details. + */ + export interface Schema$AdPolicyTopicEvidenceLegalRemovalLocalLegal { + /** + * Type of law for the legal notice. + */ + lawType?: string | null; + } + /** + * Trust & Safety (T&S) proactive enforcement for policies meant to address regional requirements. This is considered a Google-owned investigation instead of a regulation notice since it's proactive T&S enforcement. + */ + export interface Schema$AdPolicyTopicEvidenceRegionalRequirements { + /** + * List of regional requirements. + */ + regionalRequirementsEntries?: Schema$AdPolicyTopicEvidenceRegionalRequirementsRegionalRequirementsEntry[]; + } + /** + * Policy level regional legal violation details. + */ + export interface Schema$AdPolicyTopicEvidenceRegionalRequirementsRegionalRequirementsEntry { + /** + * The countries restricted due to the legal policy. + */ + countryRestrictions?: Schema$AdPolicyCriterionRestriction[]; + /** + * The legal policy that is being violated. + */ + legalPolicy?: string | null; + } + /** + * A list of fragments of text that violated the policy. + */ + export interface Schema$AdPolicyTopicEvidenceTextList { + /** + * The fragments of text from the resource that caused the policy finding. + */ + texts?: string[] | null; + } + /** + * Trademark terms that caused a policy violation. + */ + export interface Schema$AdPolicyTopicEvidenceTrademark { + /** + * Countries where the policy violation is relevant. + */ + countryRestrictions?: Schema$AdPolicyCriterionRestriction[]; + /** + * The trademark content owner. + */ + owner?: string | null; + /** + * The trademark term. + */ + term?: string | null; + } + /** + * A list of websites that violated the policy. + */ + export interface Schema$AdPolicyTopicEvidenceWebsiteList { + /** + * Websites that caused the policy finding. + */ + websites?: string[] | null; + } /** * Additional URLs related to the ad, including beacons. */ @@ -7930,6 +8277,7 @@ export namespace displayvideo_v3 { * // { * // "adGroupAdId": "my_adGroupAdId", * // "adGroupId": "my_adGroupId", + * // "adPolicy": {}, * // "adUrls": [], * // "advertiserId": "my_advertiserId", * // "audioAd": {}, diff --git a/src/apis/displayvideo/v4.ts b/src/apis/displayvideo/v4.ts index ebcebcd04f..c2297b738b 100644 --- a/src/apis/displayvideo/v4.ts +++ b/src/apis/displayvideo/v4.ts @@ -184,6 +184,31 @@ export namespace displayvideo_v4 { */ minimumVolume?: string | null; } + /** + * A single ad asset. + */ + export interface Schema$AdAsset { + /** + * Output only. The ID of the ad asset. Referred to as the asset ID when assigned to an ad. + */ + adAssetId?: string | null; + /** + * Required. The type of the ad asset. + */ + adAssetType?: string | null; + /** + * Output only. The entity status of the ad asset. + */ + entityStatus?: string | null; + /** + * Identifier. The resource name of the ad asset. + */ + name?: string | null; + /** + * Youtube video asset data. + */ + youtubeVideoAsset?: Schema$YoutubeVideoAsset; + } /** * A single ad group associated with a line item. */ @@ -238,9 +263,13 @@ export namespace displayvideo_v4 { */ adGroupAdId?: string | null; /** - * The unique ID of the ad group that the ad belongs to. + * The unique ID of the ad group that the ad belongs to. *Caution*: Parent ad groups for Demand Gen ads are not currently retrieveable using `advertisers.adGroups.list` or `advertisers.adGroups.get`. Demand Gen ads can be identified by the absence of the `ad_details` union field. */ adGroupId?: string | null; + /** + * The policy approval status of the ad. + */ + adPolicy?: Schema$AdPolicy; /** * List of URLs used by the ad. */ @@ -378,6 +407,349 @@ export namespace displayvideo_v4 { */ videoIabViewability?: string | null; } + /** + * A single ad policy associated with an ad group ad. + */ + export interface Schema$AdPolicy { + /** + * The policy approval status of an ad, indicating the approval decision. + */ + adPolicyApprovalStatus?: string | null; + /** + * The policy review status of an ad, indicating where in the review process the ad is currently. + */ + adPolicyReviewStatus?: string | null; + /** + * The entries for each policy topic identified as relating to the ad. Each entry includes the topic, restriction level, and guidance on how to fix policy issues. + */ + adPolicyTopicEntry?: Schema$AdPolicyTopicEntry[]; + } + /** + * Represents a country restriction. + */ + export interface Schema$AdPolicyCriterionRestriction { + /** + * The country criterion id. + */ + countryCriterionId?: string | null; + /** + * Localized name for the country. May be empty. + */ + countryLabel?: string | null; + } + /** + * Information on how to appeal a policy decision. + */ + export interface Schema$AdPolicyTopicAppealInfo { + /** + * Only available when appeal_type is `APPEAL_FORM`. + */ + appealFormLink?: string | null; + /** + * Whether the decision can be appealed through a self-service appeal or an appeal form. + */ + appealType?: string | null; + } + /** + * Details on ad serving constraints. + */ + export interface Schema$AdPolicyTopicConstraint { + /** + * Countries where the resource's domain is not covered by the certificates associated with it. + */ + certificateDomainMismatchCountryList?: Schema$AdPolicyTopicConstraintAdPolicyCountryConstraintList; + /** + * Countries where a certificate is required for serving. + */ + certificateMissingCountryList?: Schema$AdPolicyTopicConstraintAdPolicyCountryConstraintList; + /** + * Countries where the ad cannot serve. + */ + countryConstraint?: Schema$AdPolicyTopicConstraintAdPolicyCountryConstraintList; + /** + * Certificate is required to serve in any country and the existing certificate does not cover the ad's domain. + */ + globalCertificateDomainMismatch?: Schema$AdPolicyTopicConstraintAdPolicyGlobalCertificateDomainMismatchConstraint; + /** + * Certificate is required to serve in any country. + */ + globalCertificateMissing?: Schema$AdPolicyTopicConstraintAdPolicyGlobalCertificateMissingConstraint; + /** + * Link to the form to request a certificate for the constraint. + */ + requestCertificateFormLink?: string | null; + /** + * Reseller constraint. + */ + resellerConstraint?: Schema$AdPolicyTopicConstraintAdPolicyResellerConstraint; + } + /** + * A list of countries where the ad cannot serve due to policy constraints. + */ + export interface Schema$AdPolicyTopicConstraintAdPolicyCountryConstraintList { + /** + * Countries where the ad cannot serve. + */ + countries?: Schema$AdPolicyCriterionRestriction[]; + } + /** + * Certificate is required to serve in any country and the existing certificate does not cover the ad's domain. + */ + export interface Schema$AdPolicyTopicConstraintAdPolicyGlobalCertificateDomainMismatchConstraint {} + /** + * Certificate is required to serve in any country. + */ + export interface Schema$AdPolicyTopicConstraintAdPolicyGlobalCertificateMissingConstraint {} + /** + * Policy topic was constrained due to disapproval of the website for reseller purposes. + */ + export interface Schema$AdPolicyTopicConstraintAdPolicyResellerConstraint {} + /** + * An entry describing how an ad has been identified as relating to an ad policy. + */ + export interface Schema$AdPolicyTopicEntry { + /** + * Information on how to appeal the policy decision. + */ + appealInfo?: Schema$AdPolicyTopicAppealInfo; + /** + * Ad policy help center link for the policy topic. + */ + helpCenterLink?: string | null; + /** + * The source of the policy decision. + */ + policyDecisionType?: string | null; + /** + * The policy enforcement means used in the policy review. + */ + policyEnforcementMeans?: string | null; + /** + * Localized label text for policy. Examples include "Trademarks in text", "Contains Alcohol", etc. + */ + policyLabel?: string | null; + /** + * The policy topic. Examples include "TRADEMARKS", "ALCOHOL", etc. + */ + policyTopic?: string | null; + /** + * The serving constraints relevant to the policy decision. + */ + policyTopicConstraints?: Schema$AdPolicyTopicConstraint[]; + /** + * A short summary description of the policy topic. + */ + policyTopicDescription?: string | null; + /** + * The evidence used in the policy decision. + */ + policyTopicEvidences?: Schema$AdPolicyTopicEvidence[]; + /** + * How ad serving will be affected due to the relation to the ad policy topic. + */ + policyTopicType?: string | null; + } + /** + * Evidence information used in the policy decision. + */ + export interface Schema$AdPolicyTopicEvidence { + /** + * Counterfeit enforcement that caused a policy violation. + */ + counterfeit?: Schema$AdPolicyTopicEvidenceCounterfeit; + /** + * A mismatch between the ad destination URLs. + */ + destinationMismatch?: Schema$AdPolicyTopicEvidenceDestinationMismatch; + /** + * Information on HTTP or DNS errors related to the ad destination. + */ + destinationNotWorking?: Schema$AdPolicyTopicEvidenceDestinationNotWorking; + /** + * The text in the destination of the ad that is causing a policy violation. + */ + destinationTextList?: Schema$AdPolicyTopicEvidenceDestinationTextList; + /** + * HTTP code returned when the final URL was crawled. + */ + httpCode?: number | null; + /** + * The language the ad was detected to be written in. This field uses IETF language tags, such as "en-US". + */ + languageCode?: string | null; + /** + * Legal related regulation enforcement that caused a policy violation. + */ + legalRemoval?: Schema$AdPolicyTopicEvidenceLegalRemoval; + /** + * T&S proactive enforcement that caused a policy violation. + */ + regionalRequirements?: Schema$AdPolicyTopicEvidenceRegionalRequirements; + /** + * List of evidence found in the text of the ad. + */ + textList?: Schema$AdPolicyTopicEvidenceTextList; + /** + * Trademark terms that caused a policy violation. + */ + trademark?: Schema$AdPolicyTopicEvidenceTrademark; + /** + * List of websites linked with the ad. + */ + websiteList?: Schema$AdPolicyTopicEvidenceWebsiteList; + } + /** + * Details on the counterfeit enforcement that caused a policy violation. + */ + export interface Schema$AdPolicyTopicEvidenceCounterfeit { + /** + * The content or product owners that made a complaint. + */ + owners?: string[] | null; + } + /** + * Details on a mismatch between destination URL types. + */ + export interface Schema$AdPolicyTopicEvidenceDestinationMismatch { + /** + * The set of URLs that do not match. The list can include single or multiple uri types. Example 1: [`DISPLAY_URL`, `FINAL_URL`] means ad display URL does not match with the ad final URL. Example 2: [`FINAL_URL`] means ad final URL did not match the crawled url, which is also considered as destination mismatch. + */ + uriTypes?: string[] | null; + } + /** + * Details for on HTTP or DNS errors related to the ad destination. + */ + export interface Schema$AdPolicyTopicEvidenceDestinationNotWorking { + /** + * The device where visiting the URL resulted in the error. + */ + device?: string | null; + /** + * The type of DNS error. + */ + dnsErrorType?: string | null; + /** + * The full URL that didn't work. + */ + expandedUri?: string | null; + /** + * The HTTP error code. + */ + httpErrorCode?: string | null; + /** + * The last time the error was seen when navigating to URL. + */ + lastCheckedTime?: string | null; + } + /** + * A list of destination text that violated the policy. + */ + export interface Schema$AdPolicyTopicEvidenceDestinationTextList { + /** + * Destination text that caused the policy finding. + */ + destinationTexts?: string[] | null; + } + /** + * Legal related regulation enforcement, either from DMCA or local legal regulation. + */ + export interface Schema$AdPolicyTopicEvidenceLegalRemoval { + /** + * The type of complaint causing the legal removal. + */ + complaintType?: string | null; + /** + * The countries restricted due to the legal removal. + */ + countryRestrictions?: Schema$AdPolicyCriterionRestriction[]; + /** + * Details on the DMCA regulation legal removal. + */ + dmca?: Schema$AdPolicyTopicEvidenceLegalRemovalDmca; + /** + * Details on the local legal regulation legal removal. + */ + localLegal?: Schema$AdPolicyTopicEvidenceLegalRemovalLocalLegal; + /** + * The urls restricted due to the legal removal. + */ + restrictedUris?: string[] | null; + } + /** + * DMCA complaint details. + */ + export interface Schema$AdPolicyTopicEvidenceLegalRemovalDmca { + /** + * The entity who made the legal complaint. + */ + complainant?: string | null; + } + /** + * Local legal regulation details. + */ + export interface Schema$AdPolicyTopicEvidenceLegalRemovalLocalLegal { + /** + * Type of law for the legal notice. + */ + lawType?: string | null; + } + /** + * Trust & Safety (T&S) proactive enforcement for policies meant to address regional requirements. This is considered a Google-owned investigation instead of a regulation notice since it's proactive T&S enforcement. + */ + export interface Schema$AdPolicyTopicEvidenceRegionalRequirements { + /** + * List of regional requirements. + */ + regionalRequirementsEntries?: Schema$AdPolicyTopicEvidenceRegionalRequirementsRegionalRequirementsEntry[]; + } + /** + * Policy level regional legal violation details. + */ + export interface Schema$AdPolicyTopicEvidenceRegionalRequirementsRegionalRequirementsEntry { + /** + * The countries restricted due to the legal policy. + */ + countryRestrictions?: Schema$AdPolicyCriterionRestriction[]; + /** + * The legal policy that is being violated. + */ + legalPolicy?: string | null; + } + /** + * A list of fragments of text that violated the policy. + */ + export interface Schema$AdPolicyTopicEvidenceTextList { + /** + * The fragments of text from the resource that caused the policy finding. + */ + texts?: string[] | null; + } + /** + * Trademark terms that caused a policy violation. + */ + export interface Schema$AdPolicyTopicEvidenceTrademark { + /** + * Countries where the policy violation is relevant. + */ + countryRestrictions?: Schema$AdPolicyCriterionRestriction[]; + /** + * The trademark content owner. + */ + owner?: string | null; + /** + * The trademark term. + */ + term?: string | null; + } + /** + * A list of websites that violated the policy. + */ + export interface Schema$AdPolicyTopicEvidenceWebsiteList { + /** + * Websites that caused the policy finding. + */ + websites?: string[] | null; + } /** * Additional URLs related to the ad, including beacons. */ @@ -1315,6 +1687,24 @@ export namespace displayvideo_v4 { */ totalAmountMicros?: string | null; } + /** + * A request message for BulkCreateAdAssets. + */ + export interface Schema$BulkCreateAdAssetsRequest { + /** + * Required. Ad assets to create. Only supports assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`. + */ + adAssets?: Schema$AdAsset[]; + } + /** + * A response message for BulkCreateAdAssets. + */ + export interface Schema$BulkCreateAdAssetsResponse { + /** + * The created ad assets. + */ + adAssets?: Schema$AdAsset[]; + } /** * Request message for BulkEditAdvertiserAssignedTargetingOptions. */ @@ -2205,6 +2595,15 @@ export namespace displayvideo_v4 { */ reportingName?: string | null; } + /** + * A request message for CreateAdAsset. + */ + export interface Schema$CreateAdAssetRequest { + /** + * Required. The ad asset to create. Only supports assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`. + */ + adAsset?: Schema$AdAsset; + } /** * A request message for CreateAsset. */ @@ -4368,6 +4767,19 @@ export namespace displayvideo_v4 { */ flightDateType?: string | null; } + /** + * A response message for ListAdAssets. + */ + export interface Schema$ListAdAssetsResponse { + /** + * The list of ad assets. The list will only contain assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`. This list will be absent if empty. + */ + adAssets?: Schema$AdAsset[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAdAssets` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } export interface Schema$ListAdGroupAdsResponse { /** * The list of ad group ads. This list will be absent if empty. @@ -4751,6 +5163,19 @@ export namespace displayvideo_v4 { */ users?: Schema$User[]; } + /** + * Response message for YoutubeAssetAssociationService.ListYoutubeAssetAssociations. + */ + export interface Schema$ListYoutubeAssetAssociationsResponse { + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListYoutubeAssetAssociations` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + /** + * The list of asset associations. This list will be absent if empty. + */ + youtubeAssetAssociations?: Schema$YoutubeAssetAssociation[]; + } /** * A list of locations used for targeting. */ @@ -6142,6 +6567,28 @@ export namespace displayvideo_v4 { */ registry?: string | null; } + /** + * A request message for UploadAdAsset. + */ + export interface Schema$UploadAdAssetRequest { + /** + * Required. The type of the ad asset. Only `AD_ASSET_TYPE_IMAGE` is supported. + */ + adAssetType?: string | null; + /** + * Required. The filename of the ad asset, including the file extension. The filename must be UTF-8 encoded with a maximum size of 240 bytes. + */ + filename?: string | null; + } + /** + * A response message for UploadAdAsset. + */ + export interface Schema$UploadAdAssetResponse { + /** + * The created ad asset. + */ + adAsset?: Schema$AdAsset; + } /** * Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. */ @@ -6459,28 +6906,149 @@ export namespace displayvideo_v4 { viewFrequencyCap?: Schema$FrequencyCap; } /** - * Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. + * An association between a resource and a YouTube asset. */ - export interface Schema$YoutubeChannelAssignedTargetingOptionDetails { + export interface Schema$YoutubeAssetAssociation { /** - * The YouTube uploader channel id or the channel code of a YouTube channel. + * Required. The YouTube asset associated with the resource. */ - channelId?: string | null; + linkedYoutubeAsset?: Schema$YoutubeAssetAssociationLinkedYouTubeAsset; /** - * Indicates if this option is being negatively targeted. + * Identifier. The resource name of the association. For line item-level associations: The name pattern is `advertisers/{advertiser_id\}/lineItems/{line_item_id\}/youtubeAssetTypes/{youtube_asset_type\}/youtubeAssetAssociations/{youtube_asset_association_id\}`. For ad group-level associations: The name pattern is `advertisers/{advertiser_id\}/adGroups/{ad_group_id\}/youtubeAssetTypes/{youtube_asset_type\}/youtubeAssetAssociations/{youtube_asset_association_id\}`. For `YOUTUBE_ASSET_TYPE_LOCATION` and `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION` associations: `youtube_asset_association_id` is the ID of the asset set linked, or 0 if the location_matching_type or affiliate_location_matching_type is `DISABLED`. For `YOUTUBE_ASSET_TYPE_SITELINK` associations: `youtube_asset_association_id` is be the ID of the sitelink asset linked. */ - negative?: boolean | null; + name?: string | null; + /** + * Required. The type of YouTube asset associated with the resource. + */ + youtubeAssetType?: string | null; } /** - * Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. + * An asset filter that matches eligible affiliate location assets for serving. */ - export interface Schema$YoutubeVideoAssignedTargetingOptionDetails { + export interface Schema$YoutubeAssetAssociationAffiliateLocationAssetFilter { /** - * Indicates if this option is being negatively targeted. + * Optional. The matching function that determines how the affiliate location asset filter matches affiliate location assets. This field is required and can only be set for if affiliate_location_matching_type is `SELECTED_CHAINS`. */ - negative?: boolean | null; + affiliateLocationMatchingFunction?: Schema$YoutubeAssetAssociationAffiliateLocationAssetFilterAffiliateLocationMatchingFunction; /** - * YouTube video id as it appears on the YouTube watch page. + * Required. The matching type of this affiliate location asset filter. + */ + affiliateLocationMatchingType?: string | null; + /** + * Output only. The ID of the asset set that matches the affiliate location assets eligible for serving. + */ + assetSetId?: string | null; + } + /** + * A chain of affiliate locations. + */ + export interface Schema$YoutubeAssetAssociationAffiliateLocationAssetFilterAffiliateLocationChain { + /** + * Required. ID of the affiliate location chain. + */ + chainId?: string | null; + } + /** + * The matching function for an affiliate location asset filter. + */ + export interface Schema$YoutubeAssetAssociationAffiliateLocationAssetFilterAffiliateLocationMatchingFunction { + /** + * Optional. The selected affiliate location chain IDs. This field is required if affiliate_location_matching_type is `SELECTED_CHAINS`. + */ + chains?: Schema$YoutubeAssetAssociationAffiliateLocationAssetFilterAffiliateLocationChain[]; + } + /** + * A YouTube asset linked to a resource in a YoutubeAssetAssociation. + */ + export interface Schema$YoutubeAssetAssociationLinkedYouTubeAsset { + /** + * An affiliate location asset filter. This can be set only when youtube_asset_type is `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION`. + */ + affiliateLocationAssetFilter?: Schema$YoutubeAssetAssociationAffiliateLocationAssetFilter; + /** + * A location asset filter. This can be set only when youtube_asset_type is `YOUTUBE_ASSET_TYPE_LOCATION`. + */ + locationAssetFilter?: Schema$YoutubeAssetAssociationLocationAssetFilter; + /** + * A sitelink asset. This can be set only when youtube_asset_type is `YOUTUBE_ASSET_TYPE_SITELINK`. + */ + sitelinkAsset?: Schema$YoutubeAssetAssociationSitelinkAsset; + } + /** + * An asset filter that matches eligible location assets for serving. + */ + export interface Schema$YoutubeAssetAssociationLocationAssetFilter { + /** + * Output only. The ID of the asset set that matches the location assets eligible for serving. + */ + assetSetId?: string | null; + /** + * Optional. The matching function that determines how the location asset filter matches location assets. This field is required and can only be set for if location_matching_type is `FILTER` or `SELECTED_ASSETS`. + */ + locationMatchingFunction?: Schema$YoutubeAssetAssociationLocationAssetFilterLocationMatchingFunction; + /** + * Required. The matching type of this location asset filter. + */ + locationMatchingType?: string | null; + } + /** + * The matching function for a location asset filter. + */ + export interface Schema$YoutubeAssetAssociationLocationAssetFilterLocationMatchingFunction { + /** + * Optional. The business name to match with. This field is optional and can only be set if location_matching_type is `FILTER`. + */ + business?: string | null; + /** + * Optional. The labels to match with. Labels are logically OR'ed together. This field is optional and can only be set if location_matching_type is `FILTER`. + */ + labels?: string[] | null; + /** + * Optional. The selected location asset IDs. This field is required if location_matching_type is `SELECTED_ASSETS`. + */ + locationAssetIds?: string[] | null; + } + /** + * A sitelink asset. + */ + export interface Schema$YoutubeAssetAssociationSitelinkAsset { + /** + * Required. ID of the sitelink asset. + */ + assetId?: string | null; + } + /** + * Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. + */ + export interface Schema$YoutubeChannelAssignedTargetingOptionDetails { + /** + * The YouTube uploader channel id or the channel code of a YouTube channel. + */ + channelId?: string | null; + /** + * Indicates if this option is being negatively targeted. + */ + negative?: boolean | null; + } + /** + * Data for a YouTube video ad asset. + */ + export interface Schema$YoutubeVideoAsset { + /** + * Required. The YouTube video id of the asset. This is the 11 char string value used in the YouTube video URL. + */ + youtubeVideoId?: string | null; + } + /** + * Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. + */ + export interface Schema$YoutubeVideoAssignedTargetingOptionDetails { + /** + * Indicates if this option is being negatively targeted. + */ + negative?: boolean | null; + /** + * YouTube video id as it appears on the YouTube watch page. */ videoId?: string | null; } @@ -6500,6 +7068,7 @@ export namespace displayvideo_v4 { export class Resource$Advertisers { context: APIRequestContext; + adAssets: Resource$Advertisers$Adassets; adGroupAds: Resource$Advertisers$Adgroupads; adGroups: Resource$Advertisers$Adgroups; assets: Resource$Advertisers$Assets; @@ -6514,6 +7083,7 @@ export namespace displayvideo_v4 { targetingTypes: Resource$Advertisers$Targetingtypes; constructor(context: APIRequestContext) { this.context = context; + this.adAssets = new Resource$Advertisers$Adassets(this.context); this.adGroupAds = new Resource$Advertisers$Adgroupads(this.context); this.adGroups = new Resource$Advertisers$Adgroups(this.context); this.assets = new Resource$Advertisers$Assets(this.context); @@ -7871,14 +8441,14 @@ export namespace displayvideo_v4 { requestBody?: Schema$Advertiser; } - export class Resource$Advertisers$Adgroupads { + export class Resource$Advertisers$Adassets { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Gets an ad group ad. + * Creates multiple ad assets in a single request. Returns the newly-created ad assets if successful. Only supports the creation of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`. * @example * ```js * // Before running the sample: @@ -7907,31 +8477,23 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.adGroupAds.get({ - * // Required. The ID of the ad group ad to fetch. - * adGroupAdId: '[^/]+', - * // Required. The ID of the advertiser this ad group ad belongs to. + * const res = await displayvideo.advertisers.adAssets.bulkCreate({ + * // Required. The ID of the advertiser these ad assets belong to. * advertiserId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "adAssets": [] + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "adGroupAdId": "my_adGroupAdId", - * // "adGroupId": "my_adGroupId", - * // "adUrls": [], - * // "advertiserId": "my_advertiserId", - * // "audioAd": {}, - * // "bumperAd": {}, - * // "displayName": "my_displayName", - * // "displayVideoSourceAd": {}, - * // "entityStatus": "my_entityStatus", - * // "inStreamAd": {}, - * // "mastheadAd": {}, - * // "name": "my_name", - * // "nonSkippableAd": {}, - * // "videoDiscoverAd": {}, - * // "videoPerformanceAd": {} + * // "adAssets": [] * // } * } * @@ -7947,53 +8509,57 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Advertisers$Adgroupads$Get, + bulkCreate( + params: Params$Resource$Advertisers$Adassets$Bulkcreate, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Advertisers$Adgroupads$Get, + bulkCreate( + params?: Params$Resource$Advertisers$Adassets$Bulkcreate, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Advertisers$Adgroupads$Get, + ): Promise>; + bulkCreate( + params: Params$Resource$Advertisers$Adassets$Bulkcreate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Advertisers$Adgroupads$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + bulkCreate( + params: Params$Resource$Advertisers$Adassets$Bulkcreate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Advertisers$Adgroupads$Get, - callback: BodyResponseCallback + bulkCreate( + params: Params$Resource$Advertisers$Adassets$Bulkcreate, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + bulkCreate( + callback: BodyResponseCallback + ): void; + bulkCreate( paramsOrCallback?: - | Params$Resource$Advertisers$Adgroupads$Get - | BodyResponseCallback + | Params$Resource$Advertisers$Adassets$Bulkcreate + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Adgroupads$Get; + {}) as Params$Resource$Advertisers$Adassets$Bulkcreate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Adgroupads$Get; + params = {} as Params$Resource$Advertisers$Adassets$Bulkcreate; options = {}; } @@ -8007,31 +8573,30 @@ export namespace displayvideo_v4 { options: Object.assign( { url: ( - rootUrl + - '/v4/advertisers/{+advertiserId}/adGroupAds/{+adGroupAdId}' + rootUrl + '/v4/advertisers/{+advertiserId}/adAssets:bulkCreate' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['advertiserId', 'adGroupAdId'], - pathParams: ['adGroupAdId', 'advertiserId'], + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists ad group ads. + * Creates an ad asset. Returns the newly-created ad asset if successful. Only supports the creation of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`. * @example * ```js * // Before running the sample: @@ -8060,24 +8625,27 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.adGroupAds.list({ - * // Required. The ID of the advertiser the ad groups belongs to. + * const res = await displayvideo.advertisers.adAssets.create({ + * // Required. The ID of the advertiser this ad asset belongs to. * advertiserId: '[^/]+', - * // Optional. Allows filtering by custom ad group ad fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `adGroupId` * `displayName` * `entityStatus` * `adGroupAdId` Examples: * All ad group ads under an ad group: `adGroupId="1234"` * All ad group ads under an ad group with an entityStatus of `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED`: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupId="12345"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. - * filter: 'placeholder-value', - * // Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. - * orderBy: 'placeholder-value', - * // Optional. Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - * pageSize: 'placeholder-value', - * // Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroupAds` method. If not specified, the first page of results will be returned. - * pageToken: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "adAsset": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "adGroupAds": [], - * // "nextPageToken": "my_nextPageToken" + * // "adAssetId": "my_adAssetId", + * // "adAssetType": "my_adAssetType", + * // "entityStatus": "my_entityStatus", + * // "name": "my_name", + * // "youtubeVideoAsset": {} * // } * } * @@ -8093,55 +8661,53 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Advertisers$Adgroupads$List, + create( + params: Params$Resource$Advertisers$Adassets$Create, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Advertisers$Adgroupads$List, + create( + params?: Params$Resource$Advertisers$Adassets$Create, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Advertisers$Adgroupads$List, + ): Promise>; + create( + params: Params$Resource$Advertisers$Adassets$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Advertisers$Adgroupads$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Advertisers$Adassets$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Advertisers$Adgroupads$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Advertisers$Adassets$Create, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Advertisers$Adgroupads$List - | BodyResponseCallback + | Params$Resource$Advertisers$Adassets$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Adgroupads$List; + {}) as Params$Resource$Advertisers$Adassets$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Adgroupads$List; + params = {} as Params$Resource$Advertisers$Adassets$Create; options = {}; } @@ -8154,10 +8720,11 @@ export namespace displayvideo_v4 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v4/advertisers/{+advertiserId}/adGroupAds' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v4/advertisers/{+advertiserId}/adAssets').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -8168,63 +8735,17 @@ export namespace displayvideo_v4 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Advertisers$Adgroupads$Get - extends StandardParameters { - /** - * Required. The ID of the ad group ad to fetch. - */ - adGroupAdId?: string; - /** - * Required. The ID of the advertiser this ad group ad belongs to. - */ - advertiserId?: string; - } - export interface Params$Resource$Advertisers$Adgroupads$List - extends StandardParameters { - /** - * Required. The ID of the advertiser the ad groups belongs to. - */ - advertiserId?: string; - /** - * Optional. Allows filtering by custom ad group ad fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `adGroupId` * `displayName` * `entityStatus` * `adGroupAdId` Examples: * All ad group ads under an ad group: `adGroupId="1234"` * All ad group ads under an ad group with an entityStatus of `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED`: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupId="12345"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. - */ - filter?: string; - /** - * Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. - */ - orderBy?: string; - /** - * Optional. Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - */ - pageSize?: number; - /** - * Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroupAds` method. If not specified, the first page of results will be returned. - */ - pageToken?: string; - } - - export class Resource$Advertisers$Adgroups { - context: APIRequestContext; - targetingTypes: Resource$Advertisers$Adgroups$Targetingtypes; - constructor(context: APIRequestContext) { - this.context = context; - this.targetingTypes = new Resource$Advertisers$Adgroups$Targetingtypes( - this.context - ); - } /** - * Lists assigned targeting options for multiple ad groups across targeting types. Inherited assigned targeting options are not included. + * Gets an ad asset. Only supports the retrieval of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`. * @example * ```js * // Before running the sample: @@ -8253,27 +8774,21 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await displayvideo.advertisers.adGroups.bulkListAssignedTargetingOptions({ - * // Required. The IDs of the ad groups to list assigned targeting options for. - * adGroupIds: 'placeholder-value', - * // Required. The ID of the advertiser the line items belongs to. - * advertiserId: '[^/]+', - * // Optional. Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_YOUTUBE_VIDEO` or `TARGETING_TYPE_YOUTUBE_CHANNEL`: `targetingType="TARGETING_TYPE_YOUTUBE_VIDEO" OR targetingType="TARGETING_TYPE_YOUTUBE_CHANNEL"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. - * filter: 'placeholder-value', - * // Optional. Field by which to sort the list. Acceptable values are: * `adGroupId` (default) * `assignedTargetingOption.targetingType` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`. - * orderBy: 'placeholder-value', - * // Optional. Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - * pageSize: 'placeholder-value', - * // Optional. A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to the `BulkListAdGroupAssignedTargetingOptions` method. If not specified, the first page of results will be returned. - * pageToken: 'placeholder-value', - * }); + * const res = await displayvideo.advertisers.adAssets.get({ + * // Required. The ID of the ad asset to fetch. Only supports assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO` + * adAssetId: '[^/]+', + * // Required. The ID of the advertiser this ad asset belongs to. + * advertiserId: '[^/]+', + * }); * console.log(res.data); * * // Example response * // { - * // "adGroupAssignedTargetingOptions": [], - * // "nextPageToken": "my_nextPageToken" + * // "adAssetId": "my_adAssetId", + * // "adAssetType": "my_adAssetType", + * // "entityStatus": "my_entityStatus", + * // "name": "my_name", + * // "youtubeVideoAsset": {} * // } * } * @@ -8289,62 +8804,53 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - bulkListAssignedTargetingOptions( - params: Params$Resource$Advertisers$Adgroups$Bulklistassignedtargetingoptions, + get( + params: Params$Resource$Advertisers$Adassets$Get, options: StreamMethodOptions ): Promise>; - bulkListAssignedTargetingOptions( - params?: Params$Resource$Advertisers$Adgroups$Bulklistassignedtargetingoptions, + get( + params?: Params$Resource$Advertisers$Adassets$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - bulkListAssignedTargetingOptions( - params: Params$Resource$Advertisers$Adgroups$Bulklistassignedtargetingoptions, + ): Promise>; + get( + params: Params$Resource$Advertisers$Adassets$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - bulkListAssignedTargetingOptions( - params: Params$Resource$Advertisers$Adgroups$Bulklistassignedtargetingoptions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - bulkListAssignedTargetingOptions( - params: Params$Resource$Advertisers$Adgroups$Bulklistassignedtargetingoptions, - callback: BodyResponseCallback + get( + params: Params$Resource$Advertisers$Adassets$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - bulkListAssignedTargetingOptions( - callback: BodyResponseCallback + get( + params: Params$Resource$Advertisers$Adassets$Get, + callback: BodyResponseCallback ): void; - bulkListAssignedTargetingOptions( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Advertisers$Adgroups$Bulklistassignedtargetingoptions - | BodyResponseCallback + | Params$Resource$Advertisers$Adassets$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Adgroups$Bulklistassignedtargetingoptions; + {}) as Params$Resource$Advertisers$Adassets$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Advertisers$Adgroups$Bulklistassignedtargetingoptions; + params = {} as Params$Resource$Advertisers$Adassets$Get; options = {}; } @@ -8358,8 +8864,7 @@ export namespace displayvideo_v4 { options: Object.assign( { url: ( - rootUrl + - '/v4/advertisers/{+advertiserId}/adGroups:bulkListAssignedTargetingOptions' + rootUrl + '/v4/advertisers/{+advertiserId}/adAssets/{+adAssetId}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -8367,24 +8872,22 @@ export namespace displayvideo_v4 { options ), params, - requiredParams: ['advertiserId'], - pathParams: ['advertiserId'], + requiredParams: ['advertiserId', 'adAssetId'], + pathParams: ['adAssetId', 'advertiserId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets an ad group. + * Lists ad assets under an advertiser ID. Only supports the retrieval of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`. * @example * ```js * // Before running the sample: @@ -8413,26 +8916,24 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.adGroups.get({ - * // Required. The ID of the ad group to fetch. - * adGroupId: '[^/]+', - * // Required. The ID of the advertiser this ad group belongs to. + * const res = await displayvideo.advertisers.adAssets.list({ + * // Required. The ID of the advertiser the ad assets belong to. * advertiserId: '[^/]+', + * // Optional. Allows filtering of the results by ad asset fields. Supported syntax: * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `youtubeVideoAsset.youtubeVideoId` * `entityStatus` Examples: * All active YouTube video ad assets under an advertiser: `entityStatus=ENTITY_STATUS_ACTIVE` + * filter: 'placeholder-value', + * // Optional. Field by which to sort the list. Acceptable values are: * `entityStatus` * `youtubeVideoAsset.youtubeVideoId` * `adAssetId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `adAssetId desc`. + * orderBy: 'placeholder-value', + * // Optional. Requested page size. Must be between `1` and `5000`. If unspecified will default to `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdAssets` method. If not specified, the first page of results will be returned. + * pageToken: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "adGroupFormat": "my_adGroupFormat", - * // "adGroupId": "my_adGroupId", - * // "advertiserId": "my_advertiserId", - * // "bidStrategy": {}, - * // "displayName": "my_displayName", - * // "entityStatus": "my_entityStatus", - * // "lineItemId": "my_lineItemId", - * // "name": "my_name", - * // "productFeedData": {}, - * // "targetingExpansion": {} + * // "adAssets": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -8448,53 +8949,55 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Advertisers$Adgroups$Get, + list( + params: Params$Resource$Advertisers$Adassets$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Advertisers$Adgroups$Get, + list( + params?: Params$Resource$Advertisers$Adassets$List, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Advertisers$Adgroups$Get, + ): Promise>; + list( + params: Params$Resource$Advertisers$Adassets$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Advertisers$Adgroups$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Advertisers$Adassets$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Advertisers$Adgroups$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Advertisers$Adassets$List, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Advertisers$Adgroups$Get - | BodyResponseCallback + | Params$Resource$Advertisers$Adassets$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Adgroups$Get; + {}) as Params$Resource$Advertisers$Adassets$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Adgroups$Get; + params = {} as Params$Resource$Advertisers$Adassets$List; options = {}; } @@ -8507,31 +9010,32 @@ export namespace displayvideo_v4 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v4/advertisers/{+advertiserId}/adAssets').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['advertiserId', 'adGroupId'], - pathParams: ['adGroupId', 'advertiserId'], + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists ad groups. + * Uploads and creates an ad asset. Returns the ID of the newly-created ad asset if successful. Only supports the uploading of assets with the AdAssetType `AD_ASSET_TYPE_IMAGE`. * @example * ```js * // Before running the sample: @@ -8560,24 +9064,28 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.adGroups.list({ - * // Required. The ID of the advertiser the ad groups belongs to. + * const res = await displayvideo.advertisers.adAssets.upload({ + * // Required. The ID of the advertiser this ad asset belongs to. * advertiserId: '[^/]+', - * // Optional. Allows filtering by custom ad group fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported properties: * `adGroupId` * `displayName` * `entityStatus` * `lineItemId` * `adGroupFormat` Examples: * All ad groups under an line item: `lineItemId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` `AD_GROUP_FORMAT_IN_STREAM` ad groups under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat="AD_GROUP_FORMAT_IN_STREAM"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. - * filter: 'placeholder-value', - * // Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. - * orderBy: 'placeholder-value', - * // Optional. Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - * pageSize: 'placeholder-value', - * // Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroups` method. If not specified, the first page of results will be returned. - * pageToken: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "adAssetType": "my_adAssetType", + * // "filename": "my_filename" + * // } + * }, + * media: { + * mimeType: 'placeholder-value', + * body: 'placeholder-value', + * }, * }); * console.log(res.data); * * // Example response * // { - * // "adGroups": [], - * // "nextPageToken": "my_nextPageToken" + * // "adAsset": {} * // } * } * @@ -8593,55 +9101,55 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Advertisers$Adgroups$List, + upload( + params: Params$Resource$Advertisers$Adassets$Upload, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Advertisers$Adgroups$List, + upload( + params?: Params$Resource$Advertisers$Adassets$Upload, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Advertisers$Adgroups$List, + ): Promise>; + upload( + params: Params$Resource$Advertisers$Adassets$Upload, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Advertisers$Adgroups$List, + upload( + params: Params$Resource$Advertisers$Adassets$Upload, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Advertisers$Adgroups$List, - callback: BodyResponseCallback + upload( + params: Params$Resource$Advertisers$Adassets$Upload, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + upload(callback: BodyResponseCallback): void; + upload( paramsOrCallback?: - | Params$Resource$Advertisers$Adgroups$List - | BodyResponseCallback + | Params$Resource$Advertisers$Adassets$Upload + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Adgroups$List; + {}) as Params$Resource$Advertisers$Adassets$Upload; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Adgroups$List; + params = {} as Params$Resource$Advertisers$Adassets$Upload; options = {}; } @@ -8654,113 +9162,128 @@ export namespace displayvideo_v4 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v4/advertisers/{+advertiserId}/adGroups').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: ( + rootUrl + '/v4/advertisers/{+advertiserId}/adAssets:uploadAdAsset' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, + mediaUrl: ( + rootUrl + + '/upload/v4/advertisers/{+advertiserId}/adAssets:uploadAdAsset' + ).replace(/([^:]\/)\/+/g, '$1'), requiredParams: ['advertiserId'], pathParams: ['advertiserId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Advertisers$Adgroups$Bulklistassignedtargetingoptions + export interface Params$Resource$Advertisers$Adassets$Bulkcreate extends StandardParameters { /** - * Required. The IDs of the ad groups to list assigned targeting options for. - */ - adGroupIds?: string[]; - /** - * Required. The ID of the advertiser the line items belongs to. + * Required. The ID of the advertiser these ad assets belong to. */ advertiserId?: string; + /** - * Optional. Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_YOUTUBE_VIDEO` or `TARGETING_TYPE_YOUTUBE_CHANNEL`: `targetingType="TARGETING_TYPE_YOUTUBE_VIDEO" OR targetingType="TARGETING_TYPE_YOUTUBE_CHANNEL"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. - */ - filter?: string; - /** - * Optional. Field by which to sort the list. Acceptable values are: * `adGroupId` (default) * `assignedTargetingOption.targetingType` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`. + * Request body metadata */ - orderBy?: string; + requestBody?: Schema$BulkCreateAdAssetsRequest; + } + export interface Params$Resource$Advertisers$Adassets$Create + extends StandardParameters { /** - * Optional. Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * Required. The ID of the advertiser this ad asset belongs to. */ - pageSize?: number; + advertiserId?: string; + /** - * Optional. A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to the `BulkListAdGroupAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + * Request body metadata */ - pageToken?: string; + requestBody?: Schema$CreateAdAssetRequest; } - export interface Params$Resource$Advertisers$Adgroups$Get + export interface Params$Resource$Advertisers$Adassets$Get extends StandardParameters { /** - * Required. The ID of the ad group to fetch. + * Required. The ID of the ad asset to fetch. Only supports assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO` */ - adGroupId?: string; + adAssetId?: string; /** - * Required. The ID of the advertiser this ad group belongs to. + * Required. The ID of the advertiser this ad asset belongs to. */ advertiserId?: string; } - export interface Params$Resource$Advertisers$Adgroups$List + export interface Params$Resource$Advertisers$Adassets$List extends StandardParameters { /** - * Required. The ID of the advertiser the ad groups belongs to. + * Required. The ID of the advertiser the ad assets belong to. */ advertiserId?: string; /** - * Optional. Allows filtering by custom ad group fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported properties: * `adGroupId` * `displayName` * `entityStatus` * `lineItemId` * `adGroupFormat` Examples: * All ad groups under an line item: `lineItemId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` `AD_GROUP_FORMAT_IN_STREAM` ad groups under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat="AD_GROUP_FORMAT_IN_STREAM"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + * Optional. Allows filtering of the results by ad asset fields. Supported syntax: * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `youtubeVideoAsset.youtubeVideoId` * `entityStatus` Examples: * All active YouTube video ad assets under an advertiser: `entityStatus=ENTITY_STATUS_ACTIVE` */ filter?: string; /** - * Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + * Optional. Field by which to sort the list. Acceptable values are: * `entityStatus` * `youtubeVideoAsset.youtubeVideoId` * `adAssetId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `adAssetId desc`. */ orderBy?: string; /** - * Optional. Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * Optional. Requested page size. Must be between `1` and `5000`. If unspecified will default to `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. */ pageSize?: number; /** - * Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroups` method. If not specified, the first page of results will be returned. + * Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdAssets` method. If not specified, the first page of results will be returned. */ pageToken?: string; } + export interface Params$Resource$Advertisers$Adassets$Upload + extends StandardParameters { + /** + * Required. The ID of the advertiser this ad asset belongs to. + */ + advertiserId?: string; - export class Resource$Advertisers$Adgroups$Targetingtypes { - context: APIRequestContext; - assignedTargetingOptions: Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions; - constructor(context: APIRequestContext) { - this.context = context; - this.assignedTargetingOptions = - new Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions( - this.context - ); - } + /** + * Request body metadata + */ + requestBody?: Schema$UploadAdAssetRequest; + + /** + * Media metadata + */ + media?: { + /** + * Media mime-type + */ + mimeType?: string; + + /** + * Media body contents + */ + body?: any; + }; } - export class Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions { + export class Resource$Advertisers$Adgroupads { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Gets a single targeting option assigned to an ad group. Inherited assigned targeting options are not included. + * Gets an ad group ad. * @example * ```js * // Before running the sample: @@ -8789,77 +9312,32 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.get( - * { - * // Required. The ID of the ad group the assigned targeting option belongs to. - * adGroupId: '[^/]+', - * // Required. The ID of the advertiser the ad group belongs to. - * advertiserId: '[^/]+', - * // Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested. - * assignedTargetingOptionId: '[^/]+', - * // Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO` - * targetingType: '[^/]+', - * }, - * ); + * const res = await displayvideo.advertisers.adGroupAds.get({ + * // Required. The ID of the ad group ad to fetch. + * adGroupAdId: '[^/]+', + * // Required. The ID of the advertiser this ad group ad belongs to. + * advertiserId: '[^/]+', + * }); * console.log(res.data); * * // Example response * // { - * // "ageRangeDetails": {}, - * // "appCategoryDetails": {}, - * // "appDetails": {}, - * // "assignedTargetingOptionId": "my_assignedTargetingOptionId", - * // "assignedTargetingOptionIdAlias": "my_assignedTargetingOptionIdAlias", - * // "audienceGroupDetails": {}, - * // "audioContentTypeDetails": {}, - * // "authorizedSellerStatusDetails": {}, - * // "browserDetails": {}, - * // "businessChainDetails": {}, - * // "carrierAndIspDetails": {}, - * // "categoryDetails": {}, - * // "channelDetails": {}, - * // "contentDurationDetails": {}, - * // "contentGenreDetails": {}, - * // "contentInstreamPositionDetails": {}, - * // "contentOutstreamPositionDetails": {}, - * // "contentStreamTypeDetails": {}, - * // "contentThemeExclusionDetails": {}, - * // "dayAndTimeDetails": {}, - * // "deviceMakeModelDetails": {}, - * // "deviceTypeDetails": {}, - * // "digitalContentLabelExclusionDetails": {}, - * // "environmentDetails": {}, - * // "exchangeDetails": {}, - * // "genderDetails": {}, - * // "geoRegionDetails": {}, - * // "householdIncomeDetails": {}, - * // "inheritance": "my_inheritance", - * // "inventorySourceDetails": {}, - * // "inventorySourceGroupDetails": {}, - * // "keywordDetails": {}, - * // "languageDetails": {}, + * // "adGroupAdId": "my_adGroupAdId", + * // "adGroupId": "my_adGroupId", + * // "adPolicy": {}, + * // "adUrls": [], + * // "advertiserId": "my_advertiserId", + * // "audioAd": {}, + * // "bumperAd": {}, + * // "displayName": "my_displayName", + * // "displayVideoSourceAd": {}, + * // "entityStatus": "my_entityStatus", + * // "inStreamAd": {}, + * // "mastheadAd": {}, * // "name": "my_name", - * // "nativeContentPositionDetails": {}, - * // "negativeKeywordListDetails": {}, - * // "omidDetails": {}, - * // "onScreenPositionDetails": {}, - * // "operatingSystemDetails": {}, - * // "parentalStatusDetails": {}, - * // "poiDetails": {}, - * // "proximityLocationListDetails": {}, - * // "regionalLocationListDetails": {}, - * // "sensitiveCategoryExclusionDetails": {}, - * // "sessionPositionDetails": {}, - * // "subExchangeDetails": {}, - * // "targetingType": "my_targetingType", - * // "thirdPartyVerifierDetails": {}, - * // "urlDetails": {}, - * // "userRewardedContentDetails": {}, - * // "videoPlayerSizeDetails": {}, - * // "viewabilityDetails": {}, - * // "youtubeChannelDetails": {}, - * // "youtubeVideoDetails": {} + * // "nonSkippableAd": {}, + * // "videoDiscoverAd": {}, + * // "videoPerformanceAd": {} * // } * } * @@ -8876,55 +9354,52 @@ export namespace displayvideo_v4 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$Get, + params: Params$Resource$Advertisers$Adgroupads$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$Get, + params?: Params$Resource$Advertisers$Adgroupads$Get, options?: MethodOptions - ): Promise>; + ): Promise>; get( - params: Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$Get, + params: Params$Resource$Advertisers$Adgroupads$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Advertisers$Adgroupads$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$Get, - callback: BodyResponseCallback + params: Params$Resource$Advertisers$Adgroupads$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$Get - | BodyResponseCallback + | Params$Resource$Advertisers$Adgroupads$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$Get; + {}) as Params$Resource$Advertisers$Adgroupads$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$Get; + params = {} as Params$Resource$Advertisers$Adgroupads$Get; options = {}; } @@ -8939,7 +9414,7 @@ export namespace displayvideo_v4 { { url: ( rootUrl + - '/v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' + '/v4/advertisers/{+advertiserId}/adGroupAds/{+adGroupAdId}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -8947,32 +9422,22 @@ export namespace displayvideo_v4 { options ), params, - requiredParams: [ - 'advertiserId', - 'adGroupId', - 'targetingType', - 'assignedTargetingOptionId', - ], - pathParams: [ - 'adGroupId', - 'advertiserId', - 'assignedTargetingOptionId', - 'targetingType', - ], + requiredParams: ['advertiserId', 'adGroupAdId'], + pathParams: ['adGroupAdId', 'advertiserId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists the targeting options assigned to an ad group. Inherited assigned targeting options are not included. + * Lists ad group ads. * @example * ```js * // Before running the sample: @@ -9001,30 +9466,23 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.list( - * { - * // Required. The ID of the ad group to list assigned targeting options for. - * adGroupId: '[^/]+', - * // Required. The ID of the advertiser the ad group belongs to. - * advertiserId: '[^/]+', - * // Optional. Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. - * filter: 'placeholder-value', - * // Optional. Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`. - * orderBy: 'placeholder-value', - * // Optional. Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - * pageSize: 'placeholder-value', - * // Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroupAssignedTargetingOptions` method. If not specified, the first page of results will be returned. - * pageToken: 'placeholder-value', - * // Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO` - * targetingType: '[^/]+', - * }, - * ); + * const res = await displayvideo.advertisers.adGroupAds.list({ + * // Required. The ID of the advertiser the ad groups belongs to. + * advertiserId: '[^/]+', + * // Optional. Allows filtering by custom ad group ad fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `adGroupId` * `displayName` * `entityStatus` * `adGroupAdId` Examples: * All ad group ads under an ad group: `adGroupId="1234"` * All ad group ads under an ad group with an entityStatus of `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED`: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupId="12345"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + * filter: 'placeholder-value', + * // Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + * orderBy: 'placeholder-value', + * // Optional. Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroupAds` method. If not specified, the first page of results will be returned. + * pageToken: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "assignedTargetingOptions": [], + * // "adGroupAds": [], * // "nextPageToken": "my_nextPageToken" * // } * } @@ -9042,61 +9500,54 @@ export namespace displayvideo_v4 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$List, + params: Params$Resource$Advertisers$Adgroupads$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$List, + params?: Params$Resource$Advertisers$Adgroupads$List, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; + ): Promise>; list( - params: Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$List, + params: Params$Resource$Advertisers$Adgroupads$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$List, + params: Params$Resource$Advertisers$Adgroupads$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$List, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + params: Params$Resource$Advertisers$Adgroupads$List, + callback: BodyResponseCallback ): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$List - | BodyResponseCallback + | Params$Resource$Advertisers$Adgroupads$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$List; + {}) as Params$Resource$Advertisers$Adgroupads$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$List; + params = {} as Params$Resource$Advertisers$Adgroupads$List; options = {}; } @@ -9110,8 +9561,7 @@ export namespace displayvideo_v4 { options: Object.assign( { url: ( - rootUrl + - '/v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions' + rootUrl + '/v4/advertisers/{+advertiserId}/adGroupAds' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -9119,82 +9569,71 @@ export namespace displayvideo_v4 { options ), params, - requiredParams: ['advertiserId', 'adGroupId', 'targetingType'], - pathParams: ['adGroupId', 'advertiserId', 'targetingType'], + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$Get + export interface Params$Resource$Advertisers$Adgroupads$Get extends StandardParameters { /** - * Required. The ID of the ad group the assigned targeting option belongs to. + * Required. The ID of the ad group ad to fetch. */ - adGroupId?: string; + adGroupAdId?: string; /** - * Required. The ID of the advertiser the ad group belongs to. + * Required. The ID of the advertiser this ad group ad belongs to. */ advertiserId?: string; - /** - * Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested. - */ - assignedTargetingOptionId?: string; - /** - * Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO` - */ - targetingType?: string; } - export interface Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$List + export interface Params$Resource$Advertisers$Adgroupads$List extends StandardParameters { /** - * Required. The ID of the ad group to list assigned targeting options for. + * Required. The ID of the advertiser the ad groups belongs to. */ - adGroupId?: string; + advertiserId?: string; /** - * Required. The ID of the advertiser the ad group belongs to. - */ - advertiserId?: string; - /** - * Optional. Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + * Optional. Allows filtering by custom ad group ad fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `adGroupId` * `displayName` * `entityStatus` * `adGroupAdId` Examples: * All ad group ads under an ad group: `adGroupId="1234"` * All ad group ads under an ad group with an entityStatus of `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED`: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupId="12345"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. */ filter?: string; /** - * Optional. Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`. + * Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. */ orderBy?: string; /** - * Optional. Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * Optional. Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. */ pageSize?: number; /** - * Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroupAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + * Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroupAds` method. If not specified, the first page of results will be returned. */ pageToken?: string; - /** - * Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO` - */ - targetingType?: string; } - export class Resource$Advertisers$Assets { + export class Resource$Advertisers$Adgroups { context: APIRequestContext; + targetingTypes: Resource$Advertisers$Adgroups$Targetingtypes; + youtubeAssetTypes: Resource$Advertisers$Adgroups$Youtubeassettypes; constructor(context: APIRequestContext) { this.context = context; + this.targetingTypes = new Resource$Advertisers$Adgroups$Targetingtypes( + this.context + ); + this.youtubeAssetTypes = + new Resource$Advertisers$Adgroups$Youtubeassettypes(this.context); } /** - * Uploads an asset. Returns the ID of the newly uploaded asset if successful. The asset file size should be no more than 10 MB for images, 200 MB for ZIP files, and 1 GB for videos. Must be used within the [multipart media upload process](/display-video/api/guides/how-tos/upload#multipart). Examples using provided client libraries can be found in our [Creating Creatives guide](/display-video/api/guides/creating-creatives/overview#upload_an_asset). + * Lists assigned targeting options for multiple ad groups across targeting types. Inherited assigned targeting options are not included. * @example * ```js * // Before running the sample: @@ -9223,27 +9662,27 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.assets.upload({ - * // Required. The ID of the advertiser this asset belongs to. - * advertiserId: '[^/]+', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "filename": "my_filename" - * // } - * }, - * media: { - * mimeType: 'placeholder-value', - * body: 'placeholder-value', - * }, - * }); + * const res = + * await displayvideo.advertisers.adGroups.bulkListAssignedTargetingOptions({ + * // Required. The IDs of the ad groups to list assigned targeting options for. + * adGroupIds: 'placeholder-value', + * // Required. The ID of the advertiser the line items belongs to. + * advertiserId: '[^/]+', + * // Optional. Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_YOUTUBE_VIDEO` or `TARGETING_TYPE_YOUTUBE_CHANNEL`: `targetingType="TARGETING_TYPE_YOUTUBE_VIDEO" OR targetingType="TARGETING_TYPE_YOUTUBE_CHANNEL"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + * filter: 'placeholder-value', + * // Optional. Field by which to sort the list. Acceptable values are: * `adGroupId` (default) * `assignedTargetingOption.targetingType` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`. + * orderBy: 'placeholder-value', + * // Optional. Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * pageSize: 'placeholder-value', + * // Optional. A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to the `BulkListAdGroupAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + * pageToken: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "asset": {} + * // "adGroupAssignedTargetingOptions": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -9259,53 +9698,62 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - upload( - params: Params$Resource$Advertisers$Assets$Upload, + bulkListAssignedTargetingOptions( + params: Params$Resource$Advertisers$Adgroups$Bulklistassignedtargetingoptions, options: StreamMethodOptions ): Promise>; - upload( - params?: Params$Resource$Advertisers$Assets$Upload, + bulkListAssignedTargetingOptions( + params?: Params$Resource$Advertisers$Adgroups$Bulklistassignedtargetingoptions, options?: MethodOptions - ): Promise>; - upload( - params: Params$Resource$Advertisers$Assets$Upload, + ): Promise< + GaxiosResponseWithHTTP2 + >; + bulkListAssignedTargetingOptions( + params: Params$Resource$Advertisers$Adgroups$Bulklistassignedtargetingoptions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - upload( - params: Params$Resource$Advertisers$Assets$Upload, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + bulkListAssignedTargetingOptions( + params: Params$Resource$Advertisers$Adgroups$Bulklistassignedtargetingoptions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - upload( - params: Params$Resource$Advertisers$Assets$Upload, - callback: BodyResponseCallback + bulkListAssignedTargetingOptions( + params: Params$Resource$Advertisers$Adgroups$Bulklistassignedtargetingoptions, + callback: BodyResponseCallback ): void; - upload(callback: BodyResponseCallback): void; - upload( + bulkListAssignedTargetingOptions( + callback: BodyResponseCallback + ): void; + bulkListAssignedTargetingOptions( paramsOrCallback?: - | Params$Resource$Advertisers$Assets$Upload - | BodyResponseCallback + | Params$Resource$Advertisers$Adgroups$Bulklistassignedtargetingoptions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Assets$Upload; + {}) as Params$Resource$Advertisers$Adgroups$Bulklistassignedtargetingoptions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Assets$Upload; + params = + {} as Params$Resource$Advertisers$Adgroups$Bulklistassignedtargetingoptions; options = {}; } @@ -9318,74 +9766,34 @@ export namespace displayvideo_v4 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v4/advertisers/{+advertiserId}/assets').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/adGroups:bulkListAssignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - mediaUrl: ( - rootUrl + '/upload/v4/advertisers/{+advertiserId}/assets' - ).replace(/([^:]\/)\/+/g, '$1'), requiredParams: ['advertiserId'], pathParams: ['advertiserId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Advertisers$Assets$Upload - extends StandardParameters { - /** - * Required. The ID of the advertiser this asset belongs to. - */ - advertiserId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CreateAssetRequest; - - /** - * Media metadata - */ - media?: { - /** - * Media mime-type - */ - mimeType?: string; - - /** - * Media body contents - */ - body?: any; - }; - } - - export class Resource$Advertisers$Campaigns { - context: APIRequestContext; - targetingTypes: Resource$Advertisers$Campaigns$Targetingtypes; - constructor(context: APIRequestContext) { - this.context = context; - this.targetingTypes = new Resource$Advertisers$Campaigns$Targetingtypes( - this.context - ); - } /** - * Creates a new campaign. Returns the newly created campaign if successful. + * Gets an ad group. * @example * ```js * // Before running the sample: @@ -9406,10 +9814,7 @@ export namespace displayvideo_v4 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/display-video', - * 'https://www.googleapis.com/auth/display-video-mediaplanning', - * ], + * scopes: ['https://www.googleapis.com/auth/display-video'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -9417,41 +9822,26 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.campaigns.create({ - * // Output only. The unique ID of the advertiser the campaign belongs to. + * const res = await displayvideo.advertisers.adGroups.get({ + * // Required. The ID of the ad group to fetch. + * adGroupId: '[^/]+', + * // Required. The ID of the advertiser this ad group belongs to. * advertiserId: '[^/]+', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "advertiserId": "my_advertiserId", - * // "campaignBudgets": [], - * // "campaignFlight": {}, - * // "campaignGoal": {}, - * // "campaignId": "my_campaignId", - * // "displayName": "my_displayName", - * // "entityStatus": "my_entityStatus", - * // "frequencyCap": {}, - * // "name": "my_name", - * // "updateTime": "my_updateTime" - * // } - * }, * }); * console.log(res.data); * * // Example response * // { + * // "adGroupFormat": "my_adGroupFormat", + * // "adGroupId": "my_adGroupId", * // "advertiserId": "my_advertiserId", - * // "campaignBudgets": [], - * // "campaignFlight": {}, - * // "campaignGoal": {}, - * // "campaignId": "my_campaignId", + * // "bidStrategy": {}, * // "displayName": "my_displayName", * // "entityStatus": "my_entityStatus", - * // "frequencyCap": {}, + * // "lineItemId": "my_lineItemId", * // "name": "my_name", - * // "updateTime": "my_updateTime" + * // "productFeedData": {}, + * // "targetingExpansion": {} * // } * } * @@ -9467,53 +9857,53 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Advertisers$Campaigns$Create, + get( + params: Params$Resource$Advertisers$Adgroups$Get, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Advertisers$Campaigns$Create, + get( + params?: Params$Resource$Advertisers$Adgroups$Get, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Advertisers$Campaigns$Create, + ): Promise>; + get( + params: Params$Resource$Advertisers$Adgroups$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Advertisers$Campaigns$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Advertisers$Adgroups$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Advertisers$Campaigns$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Advertisers$Adgroups$Get, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Advertisers$Campaigns$Create - | BodyResponseCallback + | Params$Resource$Advertisers$Adgroups$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Campaigns$Create; + {}) as Params$Resource$Advertisers$Adgroups$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Campaigns$Create; + params = {} as Params$Resource$Advertisers$Adgroups$Get; options = {}; } @@ -9527,30 +9917,30 @@ export namespace displayvideo_v4 { options: Object.assign( { url: ( - rootUrl + '/v4/advertisers/{+advertiserId}/campaigns' + rootUrl + '/v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['advertiserId'], - pathParams: ['advertiserId'], + requiredParams: ['advertiserId', 'adGroupId'], + pathParams: ['adGroupId', 'advertiserId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Permanently deletes a campaign. A deleted campaign cannot be recovered. The campaign should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors. + * Lists ad groups. * @example * ```js * // Before running the sample: @@ -9571,10 +9961,7 @@ export namespace displayvideo_v4 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/display-video', - * 'https://www.googleapis.com/auth/display-video-mediaplanning', - * ], + * scopes: ['https://www.googleapis.com/auth/display-video'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -9582,16 +9969,25 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.campaigns.delete({ - * // The ID of the advertiser this campaign belongs to. + * const res = await displayvideo.advertisers.adGroups.list({ + * // Required. The ID of the advertiser the ad groups belongs to. * advertiserId: '[^/]+', - * // The ID of the campaign we need to delete. - * campaignId: '[^/]+', + * // Optional. Allows filtering by custom ad group fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported properties: * `adGroupId` * `displayName` * `entityStatus` * `lineItemId` * `adGroupFormat` Examples: * All ad groups under an line item: `lineItemId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` `AD_GROUP_FORMAT_IN_STREAM` ad groups under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat="AD_GROUP_FORMAT_IN_STREAM"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + * filter: 'placeholder-value', + * // Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + * orderBy: 'placeholder-value', + * // Optional. Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroups` method. If not specified, the first page of results will be returned. + * pageToken: 'placeholder-value', * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "adGroups": [], + * // "nextPageToken": "my_nextPageToken" + * // } * } * * main().catch(e => { @@ -9606,53 +10002,55 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Advertisers$Campaigns$Delete, + list( + params: Params$Resource$Advertisers$Adgroups$List, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Advertisers$Campaigns$Delete, + list( + params?: Params$Resource$Advertisers$Adgroups$List, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Advertisers$Campaigns$Delete, + ): Promise>; + list( + params: Params$Resource$Advertisers$Adgroups$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Advertisers$Campaigns$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Advertisers$Adgroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Advertisers$Campaigns$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Advertisers$Adgroups$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Advertisers$Campaigns$Delete - | BodyResponseCallback + | Params$Resource$Advertisers$Adgroups$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Campaigns$Delete; + {}) as Params$Resource$Advertisers$Adgroups$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Campaigns$Delete; + params = {} as Params$Resource$Advertisers$Adgroups$List; options = {}; } @@ -9665,32 +10063,113 @@ export namespace displayvideo_v4 { const parameters = { options: Object.assign( { - url: ( - rootUrl + - '/v4/advertisers/{+advertiserId}/campaigns/{+campaignId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v4/advertisers/{+advertiserId}/adGroups').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['advertiserId', 'campaignId'], - pathParams: ['advertiserId', 'campaignId'], + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Advertisers$Adgroups$Bulklistassignedtargetingoptions + extends StandardParameters { /** - * Gets a campaign. + * Required. The IDs of the ad groups to list assigned targeting options for. + */ + adGroupIds?: string[]; + /** + * Required. The ID of the advertiser the line items belongs to. + */ + advertiserId?: string; + /** + * Optional. Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_YOUTUBE_VIDEO` or `TARGETING_TYPE_YOUTUBE_CHANNEL`: `targetingType="TARGETING_TYPE_YOUTUBE_VIDEO" OR targetingType="TARGETING_TYPE_YOUTUBE_CHANNEL"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Optional. Field by which to sort the list. Acceptable values are: * `adGroupId` (default) * `assignedTargetingOption.targetingType` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`. + */ + orderBy?: string; + /** + * Optional. Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * Optional. A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to the `BulkListAdGroupAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Adgroups$Get + extends StandardParameters { + /** + * Required. The ID of the ad group to fetch. + */ + adGroupId?: string; + /** + * Required. The ID of the advertiser this ad group belongs to. + */ + advertiserId?: string; + } + export interface Params$Resource$Advertisers$Adgroups$List + extends StandardParameters { + /** + * Required. The ID of the advertiser the ad groups belongs to. + */ + advertiserId?: string; + /** + * Optional. Allows filtering by custom ad group fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported properties: * `adGroupId` * `displayName` * `entityStatus` * `lineItemId` * `adGroupFormat` Examples: * All ad groups under an line item: `lineItemId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` `AD_GROUP_FORMAT_IN_STREAM` ad groups under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat="AD_GROUP_FORMAT_IN_STREAM"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + */ + orderBy?: string; + /** + * Optional. Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroups` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + + export class Resource$Advertisers$Adgroups$Targetingtypes { + context: APIRequestContext; + assignedTargetingOptions: Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions; + constructor(context: APIRequestContext) { + this.context = context; + this.assignedTargetingOptions = + new Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions( + this.context + ); + } + } + + export class Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a single targeting option assigned to an ad group. Inherited assigned targeting options are not included. * @example * ```js * // Before running the sample: @@ -9711,10 +10190,7 @@ export namespace displayvideo_v4 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/display-video', - * 'https://www.googleapis.com/auth/display-video-mediaplanning', - * ], + * scopes: ['https://www.googleapis.com/auth/display-video'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -9722,27 +10198,78 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.campaigns.get({ - * // Required. The ID of the advertiser this campaign belongs to. - * advertiserId: '[^/]+', - * // Required. The ID of the campaign to fetch. - * campaignId: '[^/]+', - * }); + * const res = + * await displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.get( + * { + * // Required. The ID of the ad group the assigned targeting option belongs to. + * adGroupId: '[^/]+', + * // Required. The ID of the advertiser the ad group belongs to. + * advertiserId: '[^/]+', + * // Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested. + * assignedTargetingOptionId: '[^/]+', + * // Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO` + * targetingType: '[^/]+', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "advertiserId": "my_advertiserId", - * // "campaignBudgets": [], - * // "campaignFlight": {}, - * // "campaignGoal": {}, - * // "campaignId": "my_campaignId", - * // "displayName": "my_displayName", - * // "entityStatus": "my_entityStatus", - * // "frequencyCap": {}, + * // "ageRangeDetails": {}, + * // "appCategoryDetails": {}, + * // "appDetails": {}, + * // "assignedTargetingOptionId": "my_assignedTargetingOptionId", + * // "assignedTargetingOptionIdAlias": "my_assignedTargetingOptionIdAlias", + * // "audienceGroupDetails": {}, + * // "audioContentTypeDetails": {}, + * // "authorizedSellerStatusDetails": {}, + * // "browserDetails": {}, + * // "businessChainDetails": {}, + * // "carrierAndIspDetails": {}, + * // "categoryDetails": {}, + * // "channelDetails": {}, + * // "contentDurationDetails": {}, + * // "contentGenreDetails": {}, + * // "contentInstreamPositionDetails": {}, + * // "contentOutstreamPositionDetails": {}, + * // "contentStreamTypeDetails": {}, + * // "contentThemeExclusionDetails": {}, + * // "dayAndTimeDetails": {}, + * // "deviceMakeModelDetails": {}, + * // "deviceTypeDetails": {}, + * // "digitalContentLabelExclusionDetails": {}, + * // "environmentDetails": {}, + * // "exchangeDetails": {}, + * // "genderDetails": {}, + * // "geoRegionDetails": {}, + * // "householdIncomeDetails": {}, + * // "inheritance": "my_inheritance", + * // "inventorySourceDetails": {}, + * // "inventorySourceGroupDetails": {}, + * // "keywordDetails": {}, + * // "languageDetails": {}, * // "name": "my_name", - * // "updateTime": "my_updateTime" - * // } + * // "nativeContentPositionDetails": {}, + * // "negativeKeywordListDetails": {}, + * // "omidDetails": {}, + * // "onScreenPositionDetails": {}, + * // "operatingSystemDetails": {}, + * // "parentalStatusDetails": {}, + * // "poiDetails": {}, + * // "proximityLocationListDetails": {}, + * // "regionalLocationListDetails": {}, + * // "sensitiveCategoryExclusionDetails": {}, + * // "sessionPositionDetails": {}, + * // "subExchangeDetails": {}, + * // "targetingType": "my_targetingType", + * // "thirdPartyVerifierDetails": {}, + * // "urlDetails": {}, + * // "userRewardedContentDetails": {}, + * // "videoPlayerSizeDetails": {}, + * // "viewabilityDetails": {}, + * // "youtubeChannelDetails": {}, + * // "youtubeVideoDetails": {} + * // } * } * * main().catch(e => { @@ -9758,52 +10285,55 @@ export namespace displayvideo_v4 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Advertisers$Campaigns$Get, + params: Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Advertisers$Campaigns$Get, + params?: Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$Get, options?: MethodOptions - ): Promise>; + ): Promise>; get( - params: Params$Resource$Advertisers$Campaigns$Get, + params: Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Advertisers$Campaigns$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Advertisers$Campaigns$Get, - callback: BodyResponseCallback + params: Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Advertisers$Campaigns$Get - | BodyResponseCallback + | Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Campaigns$Get; + {}) as Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Campaigns$Get; + params = + {} as Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$Get; options = {}; } @@ -9818,7 +10348,7 @@ export namespace displayvideo_v4 { { url: ( rootUrl + - '/v4/advertisers/{+advertiserId}/campaigns/{+campaignId}' + '/v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -9826,22 +10356,32 @@ export namespace displayvideo_v4 { options ), params, - requiredParams: ['advertiserId', 'campaignId'], - pathParams: ['advertiserId', 'campaignId'], + requiredParams: [ + 'advertiserId', + 'adGroupId', + 'targetingType', + 'assignedTargetingOptionId', + ], + pathParams: [ + 'adGroupId', + 'advertiserId', + 'assignedTargetingOptionId', + 'targetingType', + ], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists campaigns in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, campaigns with `ENTITY_STATUS_ARCHIVED` will not be included in the results. + * Lists the targeting options assigned to an ad group. Inherited assigned targeting options are not included. * @example * ```js * // Before running the sample: @@ -9862,10 +10402,7 @@ export namespace displayvideo_v4 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/display-video', - * 'https://www.googleapis.com/auth/display-video-mediaplanning', - * ], + * scopes: ['https://www.googleapis.com/auth/display-video'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -9873,23 +10410,30 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.campaigns.list({ - * // The ID of the advertiser to list campaigns for. - * advertiserId: '[^/]+', - * // Allows filtering by campaign fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` campaigns under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")` * All campaigns with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All campaigns with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. - * filter: 'placeholder-value', - * // Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. - * orderBy: 'placeholder-value', - * // Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. - * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCampaigns` method. If not specified, the first page of results will be returned. - * pageToken: 'placeholder-value', - * }); + * const res = + * await displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.list( + * { + * // Required. The ID of the ad group to list assigned targeting options for. + * adGroupId: '[^/]+', + * // Required. The ID of the advertiser the ad group belongs to. + * advertiserId: '[^/]+', + * // Optional. Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + * filter: 'placeholder-value', + * // Optional. Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`. + * orderBy: 'placeholder-value', + * // Optional. Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroupAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + * pageToken: 'placeholder-value', + * // Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO` + * targetingType: '[^/]+', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "campaigns": [], + * // "assignedTargetingOptions": [], * // "nextPageToken": "my_nextPageToken" * // } * } @@ -9907,54 +10451,61 @@ export namespace displayvideo_v4 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Advertisers$Campaigns$List, + params: Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Advertisers$Campaigns$List, + params?: Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$List, options?: MethodOptions - ): Promise>; + ): Promise< + GaxiosResponseWithHTTP2 + >; list( - params: Params$Resource$Advertisers$Campaigns$List, + params: Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Advertisers$Campaigns$List, + params: Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Advertisers$Campaigns$List, - callback: BodyResponseCallback + params: Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Advertisers$Campaigns$List - | BodyResponseCallback + | Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Campaigns$List; + {}) as Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Campaigns$List; + params = + {} as Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$List; options = {}; } @@ -9968,7 +10519,8 @@ export namespace displayvideo_v4 { options: Object.assign( { url: ( - rootUrl + '/v4/advertisers/{+advertiserId}/campaigns' + rootUrl + + '/v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -9976,22 +10528,94 @@ export namespace displayvideo_v4 { options ), params, - requiredParams: ['advertiserId'], - pathParams: ['advertiserId'], + requiredParams: ['advertiserId', 'adGroupId', 'targetingType'], + pathParams: ['adGroupId', 'advertiserId', 'targetingType'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$Get + extends StandardParameters { /** - * Lists assigned targeting options of a campaign across targeting types. + * Required. The ID of the ad group the assigned targeting option belongs to. + */ + adGroupId?: string; + /** + * Required. The ID of the advertiser the ad group belongs to. + */ + advertiserId?: string; + /** + * Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested. + */ + assignedTargetingOptionId?: string; + /** + * Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO` + */ + targetingType?: string; + } + export interface Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$List + extends StandardParameters { + /** + * Required. The ID of the ad group to list assigned targeting options for. + */ + adGroupId?: string; + /** + * Required. The ID of the advertiser the ad group belongs to. + */ + advertiserId?: string; + /** + * Optional. Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Optional. Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`. + */ + orderBy?: string; + /** + * Optional. Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroupAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO` + */ + targetingType?: string; + } + + export class Resource$Advertisers$Adgroups$Youtubeassettypes { + context: APIRequestContext; + youtubeAssetAssociations: Resource$Advertisers$Adgroups$Youtubeassettypes$Youtubeassetassociations; + constructor(context: APIRequestContext) { + this.context = context; + this.youtubeAssetAssociations = + new Resource$Advertisers$Adgroups$Youtubeassettypes$Youtubeassetassociations( + this.context + ); + } + } + + export class Resource$Advertisers$Adgroups$Youtubeassettypes$Youtubeassetassociations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new association between the identified resource and a YouTube asset. Returns the newly-created association. *Warning:* This method is only available to an informed subset of users. * @example * ```js * // Before running the sample: @@ -10021,26 +10645,35 @@ export namespace displayvideo_v4 { * * // Do the magic * const res = - * await displayvideo.advertisers.campaigns.listAssignedTargetingOptions({ - * // Required. The ID of the advertiser the campaign belongs to. - * advertiserId: '[^/]+', - * // Required. The ID of the campaign to list assigned targeting options for. - * campaignId: '[^/]+', - * // Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_LANGUAGE` or `TARGETING_TYPE_GENDER`: `targetingType="TARGETING_TYPE_LANGUAGE" OR targetingType="TARGETING_TYPE_GENDER"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. - * filter: 'placeholder-value', - * // Field by which to sort the list. Acceptable values are: * `targetingType` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`. - * orderBy: 'placeholder-value', - * // Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - * pageSize: 'placeholder-value', - * // A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to `BulkListCampaignAssignedTargetingOptions` method. If not specified, the first page of results will be returned. - * pageToken: 'placeholder-value', - * }); - * console.log(res.data); + * await displayvideo.advertisers.adGroups.youtubeAssetTypes.youtubeAssetAssociations.create( + * { + * // The ID of an ad group. + * adGroupId: '[^/]+', + * // Required. The ID of the advertiser that the linked entity belongs to. + * advertiserId: '[^/]+', + * // The ID of a line item. + * 'linkedEntity.lineItemId': 'placeholder-value', + * // Required. The type of YouTube asset associated with the resource. + * youtubeAssetType: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "linkedYoutubeAsset": {}, + * // "name": "my_name", + * // "youtubeAssetType": "my_youtubeAssetType" + * // } + * }, + * }, + * ); + * console.log(res.data); * * // Example response * // { - * // "assignedTargetingOptions": [], - * // "nextPageToken": "my_nextPageToken" + * // "linkedYoutubeAsset": {}, + * // "name": "my_name", + * // "youtubeAssetType": "my_youtubeAssetType" * // } * } * @@ -10056,62 +10689,58 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listAssignedTargetingOptions( - params: Params$Resource$Advertisers$Campaigns$Listassignedtargetingoptions, + create( + params: Params$Resource$Advertisers$Adgroups$Youtubeassettypes$Youtubeassetassociations$Create, options: StreamMethodOptions ): Promise>; - listAssignedTargetingOptions( - params?: Params$Resource$Advertisers$Campaigns$Listassignedtargetingoptions, + create( + params?: Params$Resource$Advertisers$Adgroups$Youtubeassettypes$Youtubeassetassociations$Create, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - listAssignedTargetingOptions( - params: Params$Resource$Advertisers$Campaigns$Listassignedtargetingoptions, + ): Promise>; + create( + params: Params$Resource$Advertisers$Adgroups$Youtubeassettypes$Youtubeassetassociations$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listAssignedTargetingOptions( - params: Params$Resource$Advertisers$Campaigns$Listassignedtargetingoptions, + create( + params: Params$Resource$Advertisers$Adgroups$Youtubeassettypes$Youtubeassetassociations$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listAssignedTargetingOptions( - params: Params$Resource$Advertisers$Campaigns$Listassignedtargetingoptions, - callback: BodyResponseCallback + create( + params: Params$Resource$Advertisers$Adgroups$Youtubeassettypes$Youtubeassetassociations$Create, + callback: BodyResponseCallback ): void; - listAssignedTargetingOptions( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - listAssignedTargetingOptions( + create( paramsOrCallback?: - | Params$Resource$Advertisers$Campaigns$Listassignedtargetingoptions - | BodyResponseCallback + | Params$Resource$Advertisers$Adgroups$Youtubeassettypes$Youtubeassetassociations$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Campaigns$Listassignedtargetingoptions; + {}) as Params$Resource$Advertisers$Adgroups$Youtubeassettypes$Youtubeassetassociations$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Advertisers$Campaigns$Listassignedtargetingoptions; + {} as Params$Resource$Advertisers$Adgroups$Youtubeassettypes$Youtubeassetassociations$Create; options = {}; } @@ -10126,32 +10755,30 @@ export namespace displayvideo_v4 { { url: ( rootUrl + - '/v4/advertisers/{+advertiserId}/campaigns/{+campaignId}:listAssignedTargetingOptions' + '/v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['advertiserId', 'campaignId'], - pathParams: ['advertiserId', 'campaignId'], + requiredParams: ['advertiserId', 'adGroupId', 'youtubeAssetType'], + pathParams: ['adGroupId', 'advertiserId', 'youtubeAssetType'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates an existing campaign. Returns the updated campaign if successful. + * Deletes an existing association between the identified resource and a YouTube asset. *Warning:* This method is only available to an informed subset of users. * @example * ```js * // Before running the sample: @@ -10172,10 +10799,7 @@ export namespace displayvideo_v4 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/display-video', - * 'https://www.googleapis.com/auth/display-video-mediaplanning', - * ], + * scopes: ['https://www.googleapis.com/auth/display-video'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -10183,46 +10807,25 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.campaigns.patch({ - * // Output only. The unique ID of the advertiser the campaign belongs to. - * advertiserId: '[^/]+', - * // Output only. The unique ID of the campaign. Assigned by the system. - * campaignId: '[^/]+', - * // Required. The mask to control which fields to update. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "advertiserId": "my_advertiserId", - * // "campaignBudgets": [], - * // "campaignFlight": {}, - * // "campaignGoal": {}, - * // "campaignId": "my_campaignId", - * // "displayName": "my_displayName", - * // "entityStatus": "my_entityStatus", - * // "frequencyCap": {}, - * // "name": "my_name", - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * const res = + * await displayvideo.advertisers.adGroups.youtubeAssetTypes.youtubeAssetAssociations.delete( + * { + * // The ID of an ad group. + * adGroupId: '[^/]+', + * // Required. The ID of the advertiser that the linked entity belongs to. + * advertiserId: '[^/]+', + * // The ID of a line item. + * 'linkedEntity.lineItemId': 'placeholder-value', + * // Required. The ID of the YouTube asset in the association. For `YOUTUBE_ASSET_TYPE_LOCATION` and `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION` associations: This should be the ID of the asset set linked, or 0 if the location_asset_filter or affiliate_location_asset_filter is `DISABLED`. For `YOUTUBE_ASSET_TYPE_SITELINK` associations: This should be the ID of the sitelink asset linked. + * youtubeAssetAssociationId: '[^/]+', + * // Required. The type of YouTube asset associated with the resource. + * youtubeAssetType: '[^/]+', + * }, + * ); * console.log(res.data); * * // Example response - * // { - * // "advertiserId": "my_advertiserId", - * // "campaignBudgets": [], - * // "campaignFlight": {}, - * // "campaignGoal": {}, - * // "campaignId": "my_campaignId", - * // "displayName": "my_displayName", - * // "entityStatus": "my_entityStatus", - * // "frequencyCap": {}, - * // "name": "my_name", - * // "updateTime": "my_updateTime" - * // } + * // {} * } * * main().catch(e => { @@ -10237,53 +10840,54 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Advertisers$Campaigns$Patch, + delete( + params: Params$Resource$Advertisers$Adgroups$Youtubeassettypes$Youtubeassetassociations$Delete, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Advertisers$Campaigns$Patch, + delete( + params?: Params$Resource$Advertisers$Adgroups$Youtubeassettypes$Youtubeassetassociations$Delete, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Advertisers$Campaigns$Patch, + ): Promise>; + delete( + params: Params$Resource$Advertisers$Adgroups$Youtubeassettypes$Youtubeassetassociations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Advertisers$Campaigns$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Advertisers$Adgroups$Youtubeassettypes$Youtubeassetassociations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Advertisers$Campaigns$Patch, - callback: BodyResponseCallback + delete( + params: Params$Resource$Advertisers$Adgroups$Youtubeassettypes$Youtubeassetassociations$Delete, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Advertisers$Campaigns$Patch - | BodyResponseCallback + | Params$Resource$Advertisers$Adgroups$Youtubeassettypes$Youtubeassetassociations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Campaigns$Patch; + {}) as Params$Resource$Advertisers$Adgroups$Youtubeassettypes$Youtubeassetassociations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Campaigns$Patch; + params = + {} as Params$Resource$Advertisers$Adgroups$Youtubeassettypes$Youtubeassetassociations$Delete; options = {}; } @@ -10298,154 +10902,290 @@ export namespace displayvideo_v4 { { url: ( rootUrl + - '/v4/advertisers/{+advertiserId}/campaigns/{+campaignId}' + '/v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations/{+youtubeAssetAssociationId}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['advertiserId', 'campaignId'], - pathParams: ['advertiserId', 'campaignId'], + requiredParams: [ + 'advertiserId', + 'adGroupId', + 'youtubeAssetType', + 'youtubeAssetAssociationId', + ], + pathParams: [ + 'adGroupId', + 'advertiserId', + 'youtubeAssetAssociationId', + 'youtubeAssetType', + ], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Advertisers$Campaigns$Create - extends StandardParameters { - /** - * Output only. The unique ID of the advertiser the campaign belongs to. - */ - advertiserId?: string; /** - * Request body metadata - */ - requestBody?: Schema$Campaign; - } - export interface Params$Resource$Advertisers$Campaigns$Delete - extends StandardParameters { - /** - * The ID of the advertiser this campaign belongs to. - */ - advertiserId?: string; - /** - * The ID of the campaign we need to delete. - */ - campaignId?: string; - } - export interface Params$Resource$Advertisers$Campaigns$Get - extends StandardParameters { - /** - * Required. The ID of the advertiser this campaign belongs to. - */ - advertiserId?: string; - /** - * Required. The ID of the campaign to fetch. + * Lists the YouTube asset associations linked to the given resource. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v4'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await displayvideo.advertisers.adGroups.youtubeAssetTypes.youtubeAssetAssociations.list( + * { + * // The ID of an ad group. + * adGroupId: '[^/]+', + * // Required. The ID of the advertiser that the linked entity belongs to. + * advertiserId: '[^/]+', + * // The ID of a line item. + * 'linkedEntity.lineItemId': 'placeholder-value', + * // Optional. Field by which to sort the list. The only acceptable values are: * `linkedYoutubeAsset.locationAssetFilter.assetSetId`, * `linkedYoutubeAsset.affiliateLocationAssetFilter.assetSetId`, * `linkedYoutubeAsset.sitelinkAsset.assetId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `linkedYoutubeAsset.sitelinkAsset.assetId desc`. + * orderBy: 'placeholder-value', + * // Optional. Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListYoutubeAssetAssociations` method. If not specified, the first page of results will be returned. + * pageToken: 'placeholder-value', + * // Required. The type of YouTube asset being associated with the resource. + * youtubeAssetType: '[^/]+', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "youtubeAssetAssociations": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. */ - campaignId?: string; - } - export interface Params$Resource$Advertisers$Campaigns$List - extends StandardParameters { - /** - * The ID of the advertiser to list campaigns for. + list( + params: Params$Resource$Advertisers$Adgroups$Youtubeassettypes$Youtubeassetassociations$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Advertisers$Adgroups$Youtubeassettypes$Youtubeassetassociations$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Advertisers$Adgroups$Youtubeassettypes$Youtubeassetassociations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Adgroups$Youtubeassettypes$Youtubeassetassociations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Adgroups$Youtubeassettypes$Youtubeassetassociations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Adgroups$Youtubeassettypes$Youtubeassetassociations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Adgroups$Youtubeassettypes$Youtubeassetassociations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Adgroups$Youtubeassettypes$Youtubeassetassociations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'adGroupId', 'youtubeAssetType'], + pathParams: ['adGroupId', 'advertiserId', 'youtubeAssetType'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Advertisers$Adgroups$Youtubeassettypes$Youtubeassetassociations$Create + extends StandardParameters { + /** + * The ID of an ad group. */ - advertiserId?: string; + adGroupId?: string; /** - * Allows filtering by campaign fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` campaigns under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")` * All campaigns with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All campaigns with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + * Required. The ID of the advertiser that the linked entity belongs to. */ - filter?: string; + advertiserId?: string; /** - * Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + * The ID of a line item. */ - orderBy?: string; + 'linkedEntity.lineItemId'?: string; /** - * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. + * Required. The type of YouTube asset associated with the resource. */ - pageSize?: number; + youtubeAssetType?: string; + /** - * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCampaigns` method. If not specified, the first page of results will be returned. + * Request body metadata */ - pageToken?: string; + requestBody?: Schema$YoutubeAssetAssociation; } - export interface Params$Resource$Advertisers$Campaigns$Listassignedtargetingoptions + export interface Params$Resource$Advertisers$Adgroups$Youtubeassettypes$Youtubeassetassociations$Delete extends StandardParameters { /** - * Required. The ID of the advertiser the campaign belongs to. - */ - advertiserId?: string; - /** - * Required. The ID of the campaign to list assigned targeting options for. + * The ID of an ad group. */ - campaignId?: string; + adGroupId?: string; /** - * Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_LANGUAGE` or `TARGETING_TYPE_GENDER`: `targetingType="TARGETING_TYPE_LANGUAGE" OR targetingType="TARGETING_TYPE_GENDER"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + * Required. The ID of the advertiser that the linked entity belongs to. */ - filter?: string; + advertiserId?: string; /** - * Field by which to sort the list. Acceptable values are: * `targetingType` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`. + * The ID of a line item. */ - orderBy?: string; + 'linkedEntity.lineItemId'?: string; /** - * Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * Required. The ID of the YouTube asset in the association. For `YOUTUBE_ASSET_TYPE_LOCATION` and `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION` associations: This should be the ID of the asset set linked, or 0 if the location_asset_filter or affiliate_location_asset_filter is `DISABLED`. For `YOUTUBE_ASSET_TYPE_SITELINK` associations: This should be the ID of the sitelink asset linked. */ - pageSize?: number; + youtubeAssetAssociationId?: string; /** - * A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to `BulkListCampaignAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + * Required. The type of YouTube asset associated with the resource. */ - pageToken?: string; + youtubeAssetType?: string; } - export interface Params$Resource$Advertisers$Campaigns$Patch + export interface Params$Resource$Advertisers$Adgroups$Youtubeassettypes$Youtubeassetassociations$List extends StandardParameters { /** - * Output only. The unique ID of the advertiser the campaign belongs to. + * The ID of an ad group. + */ + adGroupId?: string; + /** + * Required. The ID of the advertiser that the linked entity belongs to. */ advertiserId?: string; /** - * Output only. The unique ID of the campaign. Assigned by the system. + * The ID of a line item. */ - campaignId?: string; + 'linkedEntity.lineItemId'?: string; /** - * Required. The mask to control which fields to update. + * Optional. Field by which to sort the list. The only acceptable values are: * `linkedYoutubeAsset.locationAssetFilter.assetSetId`, * `linkedYoutubeAsset.affiliateLocationAssetFilter.assetSetId`, * `linkedYoutubeAsset.sitelinkAsset.assetId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `linkedYoutubeAsset.sitelinkAsset.assetId desc`. */ - updateMask?: string; - + orderBy?: string; /** - * Request body metadata + * Optional. Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. */ - requestBody?: Schema$Campaign; - } - - export class Resource$Advertisers$Campaigns$Targetingtypes { - context: APIRequestContext; - assignedTargetingOptions: Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions; - constructor(context: APIRequestContext) { - this.context = context; - this.assignedTargetingOptions = - new Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions( - this.context - ); - } + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListYoutubeAssetAssociations` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * Required. The type of YouTube asset being associated with the resource. + */ + youtubeAssetType?: string; } - export class Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions { + export class Resource$Advertisers$Assets { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Gets a single targeting option assigned to a campaign. + * Uploads an asset. Returns the ID of the newly uploaded asset if successful. The asset file size should be no more than 10 MB for images, 200 MB for ZIP files, and 1 GB for videos. Must be used within the [multipart media upload process](/display-video/api/guides/how-tos/upload#multipart). Examples using provided client libraries can be found in our [Creating Creatives guide](/display-video/api/guides/creating-creatives/overview#upload_an_asset). * @example * ```js * // Before running the sample: @@ -10474,77 +11214,27 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await displayvideo.advertisers.campaigns.targetingTypes.assignedTargetingOptions.get( - * { - * // Required. The ID of the advertiser the campaign belongs to. - * advertiserId: '[^/]+', - * // Required. An identifier unique to the targeting type in this campaign that identifies the assigned targeting option being requested. - * assignedTargetingOptionId: '[^/]+', - * // Required. The ID of the campaign the assigned targeting option belongs to. - * campaignId: '[^/]+', - * // Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_VIEWABILITY` - * targetingType: '[^/]+', - * }, - * ); + * const res = await displayvideo.advertisers.assets.upload({ + * // Required. The ID of the advertiser this asset belongs to. + * advertiserId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "filename": "my_filename" + * // } + * }, + * media: { + * mimeType: 'placeholder-value', + * body: 'placeholder-value', + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "ageRangeDetails": {}, - * // "appCategoryDetails": {}, - * // "appDetails": {}, - * // "assignedTargetingOptionId": "my_assignedTargetingOptionId", - * // "assignedTargetingOptionIdAlias": "my_assignedTargetingOptionIdAlias", - * // "audienceGroupDetails": {}, - * // "audioContentTypeDetails": {}, - * // "authorizedSellerStatusDetails": {}, - * // "browserDetails": {}, - * // "businessChainDetails": {}, - * // "carrierAndIspDetails": {}, - * // "categoryDetails": {}, - * // "channelDetails": {}, - * // "contentDurationDetails": {}, - * // "contentGenreDetails": {}, - * // "contentInstreamPositionDetails": {}, - * // "contentOutstreamPositionDetails": {}, - * // "contentStreamTypeDetails": {}, - * // "contentThemeExclusionDetails": {}, - * // "dayAndTimeDetails": {}, - * // "deviceMakeModelDetails": {}, - * // "deviceTypeDetails": {}, - * // "digitalContentLabelExclusionDetails": {}, - * // "environmentDetails": {}, - * // "exchangeDetails": {}, - * // "genderDetails": {}, - * // "geoRegionDetails": {}, - * // "householdIncomeDetails": {}, - * // "inheritance": "my_inheritance", - * // "inventorySourceDetails": {}, - * // "inventorySourceGroupDetails": {}, - * // "keywordDetails": {}, - * // "languageDetails": {}, - * // "name": "my_name", - * // "nativeContentPositionDetails": {}, - * // "negativeKeywordListDetails": {}, - * // "omidDetails": {}, - * // "onScreenPositionDetails": {}, - * // "operatingSystemDetails": {}, - * // "parentalStatusDetails": {}, - * // "poiDetails": {}, - * // "proximityLocationListDetails": {}, - * // "regionalLocationListDetails": {}, - * // "sensitiveCategoryExclusionDetails": {}, - * // "sessionPositionDetails": {}, - * // "subExchangeDetails": {}, - * // "targetingType": "my_targetingType", - * // "thirdPartyVerifierDetails": {}, - * // "urlDetails": {}, - * // "userRewardedContentDetails": {}, - * // "videoPlayerSizeDetails": {}, - * // "viewabilityDetails": {}, - * // "youtubeChannelDetails": {}, - * // "youtubeVideoDetails": {} + * // "asset": {} * // } * } * @@ -10560,56 +11250,53 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$Get, + upload( + params: Params$Resource$Advertisers$Assets$Upload, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$Get, + upload( + params?: Params$Resource$Advertisers$Assets$Upload, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$Get, + ): Promise>; + upload( + params: Params$Resource$Advertisers$Assets$Upload, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + upload( + params: Params$Resource$Advertisers$Assets$Upload, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$Get, - callback: BodyResponseCallback + upload( + params: Params$Resource$Advertisers$Assets$Upload, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + upload(callback: BodyResponseCallback): void; + upload( paramsOrCallback?: - | Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$Get - | BodyResponseCallback + | Params$Resource$Advertisers$Assets$Upload + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$Get; + {}) as Params$Resource$Advertisers$Assets$Upload; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$Get; + params = {} as Params$Resource$Advertisers$Assets$Upload; options = {}; } @@ -10622,42 +11309,74 @@ export namespace displayvideo_v4 { const parameters = { options: Object.assign( { - url: ( - rootUrl + - '/v4/advertisers/{+advertiserId}/campaigns/{+campaignId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v4/advertisers/{+advertiserId}/assets').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: [ - 'advertiserId', - 'campaignId', - 'targetingType', - 'assignedTargetingOptionId', - ], - pathParams: [ - 'advertiserId', - 'assignedTargetingOptionId', - 'campaignId', - 'targetingType', - ], + mediaUrl: ( + rootUrl + '/upload/v4/advertisers/{+advertiserId}/assets' + ).replace(/([^:]\/)\/+/g, '$1'), + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Advertisers$Assets$Upload + extends StandardParameters { /** - * Lists the targeting options assigned to a campaign for a specified targeting type. + * Required. The ID of the advertiser this asset belongs to. + */ + advertiserId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreateAssetRequest; + + /** + * Media metadata + */ + media?: { + /** + * Media mime-type + */ + mimeType?: string; + + /** + * Media body contents + */ + body?: any; + }; + } + + export class Resource$Advertisers$Campaigns { + context: APIRequestContext; + targetingTypes: Resource$Advertisers$Campaigns$Targetingtypes; + constructor(context: APIRequestContext) { + this.context = context; + this.targetingTypes = new Resource$Advertisers$Campaigns$Targetingtypes( + this.context + ); + } + + /** + * Creates a new campaign. Returns the newly created campaign if successful. * @example * ```js * // Before running the sample: @@ -10678,7 +11397,10 @@ export namespace displayvideo_v4 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/display-video'], + * scopes: [ + * 'https://www.googleapis.com/auth/display-video', + * 'https://www.googleapis.com/auth/display-video-mediaplanning', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -10686,31 +11408,41 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await displayvideo.advertisers.campaigns.targetingTypes.assignedTargetingOptions.list( - * { - * // Required. The ID of the advertiser the campaign belongs to. - * advertiserId: '[^/]+', - * // Required. The ID of the campaign to list assigned targeting options for. - * campaignId: '[^/]+', - * // Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `AssignedTargetingOption` resources with ID 1 or 2 `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER` `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. - * filter: 'placeholder-value', - * // Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`. - * orderBy: 'placeholder-value', - * // Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCampaignAssignedTargetingOptions` method. If not specified, the first page of results will be returned. - * pageToken: 'placeholder-value', - * // Required. Identifies the type of assigned targeting options to list. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_VIEWABILITY` - * targetingType: '[^/]+', - * }, - * ); + * const res = await displayvideo.advertisers.campaigns.create({ + * // Output only. The unique ID of the advertiser the campaign belongs to. + * advertiserId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "advertiserId": "my_advertiserId", + * // "campaignBudgets": [], + * // "campaignFlight": {}, + * // "campaignGoal": {}, + * // "campaignId": "my_campaignId", + * // "displayName": "my_displayName", + * // "entityStatus": "my_entityStatus", + * // "frequencyCap": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "assignedTargetingOptions": [], - * // "nextPageToken": "my_nextPageToken" + * // "advertiserId": "my_advertiserId", + * // "campaignBudgets": [], + * // "campaignFlight": {}, + * // "campaignGoal": {}, + * // "campaignId": "my_campaignId", + * // "displayName": "my_displayName", + * // "entityStatus": "my_entityStatus", + * // "frequencyCap": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime" * // } * } * @@ -10726,62 +11458,53 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$List, + create( + params: Params$Resource$Advertisers$Campaigns$Create, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$List, + create( + params?: Params$Resource$Advertisers$Campaigns$Create, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$List, + ): Promise>; + create( + params: Params$Resource$Advertisers$Campaigns$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Advertisers$Campaigns$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + params: Params$Resource$Advertisers$Campaigns$Create, + callback: BodyResponseCallback ): void; - list( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$List - | BodyResponseCallback + | Params$Resource$Advertisers$Campaigns$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$List; + {}) as Params$Resource$Advertisers$Campaigns$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$List; + params = {} as Params$Resource$Advertisers$Campaigns$Create; options = {}; } @@ -10795,93 +11518,30 @@ export namespace displayvideo_v4 { options: Object.assign( { url: ( - rootUrl + - '/v4/advertisers/{+advertiserId}/campaigns/{+campaignId}/targetingTypes/{+targetingType}/assignedTargetingOptions' + rootUrl + '/v4/advertisers/{+advertiserId}/campaigns' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['advertiserId', 'campaignId', 'targetingType'], - pathParams: ['advertiserId', 'campaignId', 'targetingType'], + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - export interface Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$Get - extends StandardParameters { - /** - * Required. The ID of the advertiser the campaign belongs to. - */ - advertiserId?: string; /** - * Required. An identifier unique to the targeting type in this campaign that identifies the assigned targeting option being requested. - */ - assignedTargetingOptionId?: string; - /** - * Required. The ID of the campaign the assigned targeting option belongs to. - */ - campaignId?: string; - /** - * Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_VIEWABILITY` - */ - targetingType?: string; - } - export interface Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$List - extends StandardParameters { - /** - * Required. The ID of the advertiser the campaign belongs to. - */ - advertiserId?: string; - /** - * Required. The ID of the campaign to list assigned targeting options for. - */ - campaignId?: string; - /** - * Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `AssignedTargetingOption` resources with ID 1 or 2 `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER` `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. - */ - filter?: string; - /** - * Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`. - */ - orderBy?: string; - /** - * Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - */ - pageSize?: number; - /** - * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCampaignAssignedTargetingOptions` method. If not specified, the first page of results will be returned. - */ - pageToken?: string; - /** - * Required. Identifies the type of assigned targeting options to list. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_VIEWABILITY` - */ - targetingType?: string; - } - - export class Resource$Advertisers$Channels { - context: APIRequestContext; - sites: Resource$Advertisers$Channels$Sites; - constructor(context: APIRequestContext) { - this.context = context; - this.sites = new Resource$Advertisers$Channels$Sites(this.context); - } - - /** - * Creates a new channel. Returns the newly created channel if successful. + * Permanently deletes a campaign. A deleted campaign cannot be recovered. The campaign should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors. * @example * ```js * // Before running the sample: @@ -10902,7 +11562,10 @@ export namespace displayvideo_v4 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/display-video'], + * scopes: [ + * 'https://www.googleapis.com/auth/display-video', + * 'https://www.googleapis.com/auth/display-video-mediaplanning', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -10910,38 +11573,16 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.channels.create({ - * // The ID of the advertiser that owns the created channel. + * const res = await displayvideo.advertisers.campaigns.delete({ + * // The ID of the advertiser this campaign belongs to. * advertiserId: '[^/]+', - * // The ID of the partner that owns the created channel. - * partnerId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "advertiserId": "my_advertiserId", - * // "channelId": "my_channelId", - * // "displayName": "my_displayName", - * // "name": "my_name", - * // "negativelyTargetedLineItemCount": "my_negativelyTargetedLineItemCount", - * // "partnerId": "my_partnerId", - * // "positivelyTargetedLineItemCount": "my_positivelyTargetedLineItemCount" - * // } - * }, + * // The ID of the campaign we need to delete. + * campaignId: '[^/]+', * }); * console.log(res.data); * * // Example response - * // { - * // "advertiserId": "my_advertiserId", - * // "channelId": "my_channelId", - * // "displayName": "my_displayName", - * // "name": "my_name", - * // "negativelyTargetedLineItemCount": "my_negativelyTargetedLineItemCount", - * // "partnerId": "my_partnerId", - * // "positivelyTargetedLineItemCount": "my_positivelyTargetedLineItemCount" - * // } + * // {} * } * * main().catch(e => { @@ -10956,53 +11597,53 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Advertisers$Channels$Create, + delete( + params: Params$Resource$Advertisers$Campaigns$Delete, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Advertisers$Channels$Create, + delete( + params?: Params$Resource$Advertisers$Campaigns$Delete, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Advertisers$Channels$Create, + ): Promise>; + delete( + params: Params$Resource$Advertisers$Campaigns$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Advertisers$Channels$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Advertisers$Campaigns$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Advertisers$Channels$Create, - callback: BodyResponseCallback + delete( + params: Params$Resource$Advertisers$Campaigns$Delete, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Advertisers$Channels$Create - | BodyResponseCallback + | Params$Resource$Advertisers$Campaigns$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Channels$Create; + {}) as Params$Resource$Advertisers$Campaigns$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Channels$Create; + params = {} as Params$Resource$Advertisers$Campaigns$Delete; options = {}; } @@ -11015,32 +11656,32 @@ export namespace displayvideo_v4 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v4/advertisers/{+advertiserId}/channels').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/campaigns/{+campaignId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['advertiserId'], - pathParams: ['advertiserId'], + requiredParams: ['advertiserId', 'campaignId'], + pathParams: ['advertiserId', 'campaignId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a channel for a partner or advertiser. + * Gets a campaign. * @example * ```js * // Before running the sample: @@ -11061,7 +11702,10 @@ export namespace displayvideo_v4 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/display-video'], + * scopes: [ + * 'https://www.googleapis.com/auth/display-video', + * 'https://www.googleapis.com/auth/display-video-mediaplanning', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -11069,25 +11713,26 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.channels.get({ - * // The ID of the advertiser that owns the fetched channel. + * const res = await displayvideo.advertisers.campaigns.get({ + * // Required. The ID of the advertiser this campaign belongs to. * advertiserId: '[^/]+', - * // Required. The ID of the channel to fetch. - * channelId: '[^/]+', - * // The ID of the partner that owns the fetched channel. - * partnerId: 'placeholder-value', + * // Required. The ID of the campaign to fetch. + * campaignId: '[^/]+', * }); * console.log(res.data); * * // Example response * // { * // "advertiserId": "my_advertiserId", - * // "channelId": "my_channelId", + * // "campaignBudgets": [], + * // "campaignFlight": {}, + * // "campaignGoal": {}, + * // "campaignId": "my_campaignId", * // "displayName": "my_displayName", + * // "entityStatus": "my_entityStatus", + * // "frequencyCap": {}, * // "name": "my_name", - * // "negativelyTargetedLineItemCount": "my_negativelyTargetedLineItemCount", - * // "partnerId": "my_partnerId", - * // "positivelyTargetedLineItemCount": "my_positivelyTargetedLineItemCount" + * // "updateTime": "my_updateTime" * // } * } * @@ -11104,52 +11749,52 @@ export namespace displayvideo_v4 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Advertisers$Channels$Get, + params: Params$Resource$Advertisers$Campaigns$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Advertisers$Channels$Get, + params?: Params$Resource$Advertisers$Campaigns$Get, options?: MethodOptions - ): Promise>; + ): Promise>; get( - params: Params$Resource$Advertisers$Channels$Get, + params: Params$Resource$Advertisers$Campaigns$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Advertisers$Channels$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Advertisers$Campaigns$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Advertisers$Channels$Get, - callback: BodyResponseCallback + params: Params$Resource$Advertisers$Campaigns$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Advertisers$Channels$Get - | BodyResponseCallback + | Params$Resource$Advertisers$Campaigns$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Channels$Get; + {}) as Params$Resource$Advertisers$Campaigns$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Channels$Get; + params = {} as Params$Resource$Advertisers$Campaigns$Get; options = {}; } @@ -11163,7 +11808,8 @@ export namespace displayvideo_v4 { options: Object.assign( { url: ( - rootUrl + '/v4/advertisers/{+advertiserId}/channels/{+channelId}' + rootUrl + + '/v4/advertisers/{+advertiserId}/campaigns/{+campaignId}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -11171,22 +11817,22 @@ export namespace displayvideo_v4 { options ), params, - requiredParams: ['advertiserId', 'channelId'], - pathParams: ['advertiserId', 'channelId'], + requiredParams: ['advertiserId', 'campaignId'], + pathParams: ['advertiserId', 'campaignId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists channels for a partner or advertiser. + * Lists campaigns in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, campaigns with `ENTITY_STATUS_ARCHIVED` will not be included in the results. * @example * ```js * // Before running the sample: @@ -11207,7 +11853,10 @@ export namespace displayvideo_v4 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/display-video'], + * scopes: [ + * 'https://www.googleapis.com/auth/display-video', + * 'https://www.googleapis.com/auth/display-video-mediaplanning', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -11215,25 +11864,23 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.channels.list({ - * // The ID of the advertiser that owns the channels. + * const res = await displayvideo.advertisers.campaigns.list({ + * // The ID of the advertiser to list campaigns for. * advertiserId: '[^/]+', - * // Allows filtering by channel fields. Supported syntax: * Filter expressions for channel can only contain at most one restriction. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All channels for which the display name contains "google": `displayName : "google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + * // Allows filtering by campaign fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` campaigns under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")` * All campaigns with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All campaigns with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. * filter: 'placeholder-value', - * // Field by which to sort the list. Acceptable values are: * `displayName` (default) * `channelId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `displayName desc`. + * // Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. * orderBy: 'placeholder-value', - * // Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * // Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListChannels` method. If not specified, the first page of results will be returned. + * // A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCampaigns` method. If not specified, the first page of results will be returned. * pageToken: 'placeholder-value', - * // The ID of the partner that owns the channels. - * partnerId: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "channels": [], + * // "campaigns": [], * // "nextPageToken": "my_nextPageToken" * // } * } @@ -11251,54 +11898,54 @@ export namespace displayvideo_v4 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Advertisers$Channels$List, + params: Params$Resource$Advertisers$Campaigns$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Advertisers$Channels$List, + params?: Params$Resource$Advertisers$Campaigns$List, options?: MethodOptions - ): Promise>; + ): Promise>; list( - params: Params$Resource$Advertisers$Channels$List, + params: Params$Resource$Advertisers$Campaigns$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Advertisers$Channels$List, + params: Params$Resource$Advertisers$Campaigns$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Advertisers$Channels$List, - callback: BodyResponseCallback + params: Params$Resource$Advertisers$Campaigns$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Advertisers$Channels$List - | BodyResponseCallback + | Params$Resource$Advertisers$Campaigns$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Channels$List; + {}) as Params$Resource$Advertisers$Campaigns$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Channels$List; + params = {} as Params$Resource$Advertisers$Campaigns$List; options = {}; } @@ -11311,10 +11958,9 @@ export namespace displayvideo_v4 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v4/advertisers/{+advertiserId}/channels').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v4/advertisers/{+advertiserId}/campaigns' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -11326,17 +11972,17 @@ export namespace displayvideo_v4 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates a channel. Returns the updated channel if successful. + * Lists assigned targeting options of a campaign across targeting types. * @example * ```js * // Before running the sample: @@ -11365,41 +12011,27 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.channels.patch({ - * // The ID of the advertiser that owns the created channel. - * advertiserId: '[^/]+', - * // Output only. The unique ID of the channel. Assigned by the system. - * channelId: 'placeholder-value', - * // The ID of the partner that owns the created channel. - * partnerId: 'placeholder-value', - * // Required. The mask to control which fields to update. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "advertiserId": "my_advertiserId", - * // "channelId": "my_channelId", - * // "displayName": "my_displayName", - * // "name": "my_name", - * // "negativelyTargetedLineItemCount": "my_negativelyTargetedLineItemCount", - * // "partnerId": "my_partnerId", - * // "positivelyTargetedLineItemCount": "my_positivelyTargetedLineItemCount" - * // } - * }, - * }); + * const res = + * await displayvideo.advertisers.campaigns.listAssignedTargetingOptions({ + * // Required. The ID of the advertiser the campaign belongs to. + * advertiserId: '[^/]+', + * // Required. The ID of the campaign to list assigned targeting options for. + * campaignId: '[^/]+', + * // Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_LANGUAGE` or `TARGETING_TYPE_GENDER`: `targetingType="TARGETING_TYPE_LANGUAGE" OR targetingType="TARGETING_TYPE_GENDER"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + * filter: 'placeholder-value', + * // Field by which to sort the list. Acceptable values are: * `targetingType` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`. + * orderBy: 'placeholder-value', + * // Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * pageSize: 'placeholder-value', + * // A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to `BulkListCampaignAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + * pageToken: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "advertiserId": "my_advertiserId", - * // "channelId": "my_channelId", - * // "displayName": "my_displayName", - * // "name": "my_name", - * // "negativelyTargetedLineItemCount": "my_negativelyTargetedLineItemCount", - * // "partnerId": "my_partnerId", - * // "positivelyTargetedLineItemCount": "my_positivelyTargetedLineItemCount" + * // "assignedTargetingOptions": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -11415,53 +12047,62 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Advertisers$Channels$Patch, + listAssignedTargetingOptions( + params: Params$Resource$Advertisers$Campaigns$Listassignedtargetingoptions, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Advertisers$Channels$Patch, + listAssignedTargetingOptions( + params?: Params$Resource$Advertisers$Campaigns$Listassignedtargetingoptions, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Advertisers$Channels$Patch, + ): Promise< + GaxiosResponseWithHTTP2 + >; + listAssignedTargetingOptions( + params: Params$Resource$Advertisers$Campaigns$Listassignedtargetingoptions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Advertisers$Channels$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + listAssignedTargetingOptions( + params: Params$Resource$Advertisers$Campaigns$Listassignedtargetingoptions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Advertisers$Channels$Patch, - callback: BodyResponseCallback + listAssignedTargetingOptions( + params: Params$Resource$Advertisers$Campaigns$Listassignedtargetingoptions, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + listAssignedTargetingOptions( + callback: BodyResponseCallback + ): void; + listAssignedTargetingOptions( paramsOrCallback?: - | Params$Resource$Advertisers$Channels$Patch - | BodyResponseCallback + | Params$Resource$Advertisers$Campaigns$Listassignedtargetingoptions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Channels$Patch; + {}) as Params$Resource$Advertisers$Campaigns$Listassignedtargetingoptions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Channels$Patch; + params = + {} as Params$Resource$Advertisers$Campaigns$Listassignedtargetingoptions; options = {}; } @@ -11475,120 +12116,33 @@ export namespace displayvideo_v4 { options: Object.assign( { url: ( - rootUrl + '/v4/advertisers/{+advertiserId}/channels/{channelId}' + rootUrl + + '/v4/advertisers/{+advertiserId}/campaigns/{+campaignId}:listAssignedTargetingOptions' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['advertiserId', 'channelId'], - pathParams: ['advertiserId', 'channelId'], + requiredParams: ['advertiserId', 'campaignId'], + pathParams: ['advertiserId', 'campaignId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Advertisers$Channels$Create - extends StandardParameters { - /** - * The ID of the advertiser that owns the created channel. - */ - advertiserId?: string; - /** - * The ID of the partner that owns the created channel. - */ - partnerId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Channel; - } - export interface Params$Resource$Advertisers$Channels$Get - extends StandardParameters { - /** - * The ID of the advertiser that owns the fetched channel. - */ - advertiserId?: string; - /** - * Required. The ID of the channel to fetch. - */ - channelId?: string; - /** - * The ID of the partner that owns the fetched channel. - */ - partnerId?: string; - } - export interface Params$Resource$Advertisers$Channels$List - extends StandardParameters { - /** - * The ID of the advertiser that owns the channels. - */ - advertiserId?: string; - /** - * Allows filtering by channel fields. Supported syntax: * Filter expressions for channel can only contain at most one restriction. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All channels for which the display name contains "google": `displayName : "google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. - */ - filter?: string; - /** - * Field by which to sort the list. Acceptable values are: * `displayName` (default) * `channelId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `displayName desc`. - */ - orderBy?: string; - /** - * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - */ - pageSize?: number; - /** - * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListChannels` method. If not specified, the first page of results will be returned. - */ - pageToken?: string; - /** - * The ID of the partner that owns the channels. - */ - partnerId?: string; - } - export interface Params$Resource$Advertisers$Channels$Patch - extends StandardParameters { - /** - * The ID of the advertiser that owns the created channel. - */ - advertiserId?: string; - /** - * Output only. The unique ID of the channel. Assigned by the system. - */ - channelId?: string; - /** - * The ID of the partner that owns the created channel. - */ - partnerId?: string; - /** - * Required. The mask to control which fields to update. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Channel; - } - - export class Resource$Advertisers$Channels$Sites { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Bulk edits sites under a single channel. The operation will delete the sites provided in BulkEditSitesRequest.deleted_sites and then create the sites provided in BulkEditSitesRequest.created_sites. + * Updates an existing campaign. Returns the updated campaign if successful. * @example * ```js * // Before running the sample: @@ -11609,7 +12163,10 @@ export namespace displayvideo_v4 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/display-video'], + * scopes: [ + * 'https://www.googleapis.com/auth/display-video', + * 'https://www.googleapis.com/auth/display-video-mediaplanning', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -11617,20 +12174,28 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.channels.sites.bulkEdit({ - * // The ID of the advertiser that owns the parent channel. - * advertiserId: 'placeholder-value', - * // Required. The ID of the parent channel to which the sites belong. - * channelId: '[^/]+', + * const res = await displayvideo.advertisers.campaigns.patch({ + * // Output only. The unique ID of the advertiser the campaign belongs to. + * advertiserId: '[^/]+', + * // Output only. The unique ID of the campaign. Assigned by the system. + * campaignId: '[^/]+', + * // Required. The mask to control which fields to update. + * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { * // "advertiserId": "my_advertiserId", - * // "createdSites": [], - * // "deletedSites": [], - * // "partnerId": "my_partnerId" + * // "campaignBudgets": [], + * // "campaignFlight": {}, + * // "campaignGoal": {}, + * // "campaignId": "my_campaignId", + * // "displayName": "my_displayName", + * // "entityStatus": "my_entityStatus", + * // "frequencyCap": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime" * // } * }, * }); @@ -11638,12 +12203,21 @@ export namespace displayvideo_v4 { * * // Example response * // { - * // "sites": [] - * // } - * } - * - * main().catch(e => { - * console.error(e); + * // "advertiserId": "my_advertiserId", + * // "campaignBudgets": [], + * // "campaignFlight": {}, + * // "campaignGoal": {}, + * // "campaignId": "my_campaignId", + * // "displayName": "my_displayName", + * // "entityStatus": "my_entityStatus", + * // "frequencyCap": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); * throw e; * }); * @@ -11654,57 +12228,53 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - bulkEdit( - params: Params$Resource$Advertisers$Channels$Sites$Bulkedit, + patch( + params: Params$Resource$Advertisers$Campaigns$Patch, options: StreamMethodOptions ): Promise>; - bulkEdit( - params?: Params$Resource$Advertisers$Channels$Sites$Bulkedit, + patch( + params?: Params$Resource$Advertisers$Campaigns$Patch, options?: MethodOptions - ): Promise>; - bulkEdit( - params: Params$Resource$Advertisers$Channels$Sites$Bulkedit, + ): Promise>; + patch( + params: Params$Resource$Advertisers$Campaigns$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - bulkEdit( - params: Params$Resource$Advertisers$Channels$Sites$Bulkedit, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - bulkEdit( - params: Params$Resource$Advertisers$Channels$Sites$Bulkedit, - callback: BodyResponseCallback + patch( + params: Params$Resource$Advertisers$Campaigns$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - bulkEdit( - callback: BodyResponseCallback + patch( + params: Params$Resource$Advertisers$Campaigns$Patch, + callback: BodyResponseCallback ): void; - bulkEdit( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Advertisers$Channels$Sites$Bulkedit - | BodyResponseCallback + | Params$Resource$Advertisers$Campaigns$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Channels$Sites$Bulkedit; + {}) as Params$Resource$Advertisers$Campaigns$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Channels$Sites$Bulkedit; + params = {} as Params$Resource$Advertisers$Campaigns$Patch; options = {}; } @@ -11719,30 +12289,154 @@ export namespace displayvideo_v4 { { url: ( rootUrl + - '/v4/advertisers/{advertiserId}/channels/{+channelId}/sites:bulkEdit' + '/v4/advertisers/{+advertiserId}/campaigns/{+campaignId}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['advertiserId', 'channelId'], - pathParams: ['advertiserId', 'channelId'], + requiredParams: ['advertiserId', 'campaignId'], + pathParams: ['advertiserId', 'campaignId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + + export interface Params$Resource$Advertisers$Campaigns$Create + extends StandardParameters { + /** + * Output only. The unique ID of the advertiser the campaign belongs to. + */ + advertiserId?: string; /** - * Creates a site in a channel. + * Request body metadata + */ + requestBody?: Schema$Campaign; + } + export interface Params$Resource$Advertisers$Campaigns$Delete + extends StandardParameters { + /** + * The ID of the advertiser this campaign belongs to. + */ + advertiserId?: string; + /** + * The ID of the campaign we need to delete. + */ + campaignId?: string; + } + export interface Params$Resource$Advertisers$Campaigns$Get + extends StandardParameters { + /** + * Required. The ID of the advertiser this campaign belongs to. + */ + advertiserId?: string; + /** + * Required. The ID of the campaign to fetch. + */ + campaignId?: string; + } + export interface Params$Resource$Advertisers$Campaigns$List + extends StandardParameters { + /** + * The ID of the advertiser to list campaigns for. + */ + advertiserId?: string; + /** + * Allows filtering by campaign fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` campaigns under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")` * All campaigns with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All campaigns with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCampaigns` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Campaigns$Listassignedtargetingoptions + extends StandardParameters { + /** + * Required. The ID of the advertiser the campaign belongs to. + */ + advertiserId?: string; + /** + * Required. The ID of the campaign to list assigned targeting options for. + */ + campaignId?: string; + /** + * Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_LANGUAGE` or `TARGETING_TYPE_GENDER`: `targetingType="TARGETING_TYPE_LANGUAGE" OR targetingType="TARGETING_TYPE_GENDER"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `targetingType` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`. + */ + orderBy?: string; + /** + * Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to `BulkListCampaignAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Campaigns$Patch + extends StandardParameters { + /** + * Output only. The unique ID of the advertiser the campaign belongs to. + */ + advertiserId?: string; + /** + * Output only. The unique ID of the campaign. Assigned by the system. + */ + campaignId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Campaign; + } + + export class Resource$Advertisers$Campaigns$Targetingtypes { + context: APIRequestContext; + assignedTargetingOptions: Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions; + constructor(context: APIRequestContext) { + this.context = context; + this.assignedTargetingOptions = + new Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions( + this.context + ); + } + } + + export class Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a single targeting option assigned to a campaign. * @example * ```js * // Before running the sample: @@ -11771,91 +12465,142 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.channels.sites.create({ - * // The ID of the advertiser that owns the parent channel. - * advertiserId: 'placeholder-value', - * // Required. The ID of the parent channel in which the site will be created. - * channelId: '[^/]+', - * // The ID of the partner that owns the parent channel. - * partnerId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "name": "my_name", - * // "urlOrAppId": "my_urlOrAppId" - * // } - * }, - * }); + * const res = + * await displayvideo.advertisers.campaigns.targetingTypes.assignedTargetingOptions.get( + * { + * // Required. The ID of the advertiser the campaign belongs to. + * advertiserId: '[^/]+', + * // Required. An identifier unique to the targeting type in this campaign that identifies the assigned targeting option being requested. + * assignedTargetingOptionId: '[^/]+', + * // Required. The ID of the campaign the assigned targeting option belongs to. + * campaignId: '[^/]+', + * // Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_VIEWABILITY` + * targetingType: '[^/]+', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "name": "my_name", - * // "urlOrAppId": "my_urlOrAppId" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - create( - params: Params$Resource$Advertisers$Channels$Sites$Create, - options: StreamMethodOptions - ): Promise>; - create( - params?: Params$Resource$Advertisers$Channels$Sites$Create, + * // "ageRangeDetails": {}, + * // "appCategoryDetails": {}, + * // "appDetails": {}, + * // "assignedTargetingOptionId": "my_assignedTargetingOptionId", + * // "assignedTargetingOptionIdAlias": "my_assignedTargetingOptionIdAlias", + * // "audienceGroupDetails": {}, + * // "audioContentTypeDetails": {}, + * // "authorizedSellerStatusDetails": {}, + * // "browserDetails": {}, + * // "businessChainDetails": {}, + * // "carrierAndIspDetails": {}, + * // "categoryDetails": {}, + * // "channelDetails": {}, + * // "contentDurationDetails": {}, + * // "contentGenreDetails": {}, + * // "contentInstreamPositionDetails": {}, + * // "contentOutstreamPositionDetails": {}, + * // "contentStreamTypeDetails": {}, + * // "contentThemeExclusionDetails": {}, + * // "dayAndTimeDetails": {}, + * // "deviceMakeModelDetails": {}, + * // "deviceTypeDetails": {}, + * // "digitalContentLabelExclusionDetails": {}, + * // "environmentDetails": {}, + * // "exchangeDetails": {}, + * // "genderDetails": {}, + * // "geoRegionDetails": {}, + * // "householdIncomeDetails": {}, + * // "inheritance": "my_inheritance", + * // "inventorySourceDetails": {}, + * // "inventorySourceGroupDetails": {}, + * // "keywordDetails": {}, + * // "languageDetails": {}, + * // "name": "my_name", + * // "nativeContentPositionDetails": {}, + * // "negativeKeywordListDetails": {}, + * // "omidDetails": {}, + * // "onScreenPositionDetails": {}, + * // "operatingSystemDetails": {}, + * // "parentalStatusDetails": {}, + * // "poiDetails": {}, + * // "proximityLocationListDetails": {}, + * // "regionalLocationListDetails": {}, + * // "sensitiveCategoryExclusionDetails": {}, + * // "sessionPositionDetails": {}, + * // "subExchangeDetails": {}, + * // "targetingType": "my_targetingType", + * // "thirdPartyVerifierDetails": {}, + * // "urlDetails": {}, + * // "userRewardedContentDetails": {}, + * // "videoPlayerSizeDetails": {}, + * // "viewabilityDetails": {}, + * // "youtubeChannelDetails": {}, + * // "youtubeVideoDetails": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$Get, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Advertisers$Channels$Sites$Create, + ): Promise>; + get( + params: Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Advertisers$Channels$Sites$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Advertisers$Channels$Sites$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$Get, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Advertisers$Channels$Sites$Create - | BodyResponseCallback + | Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Channels$Sites$Create; + {}) as Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Channels$Sites$Create; + params = + {} as Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$Get; options = {}; } @@ -11870,30 +12615,40 @@ export namespace displayvideo_v4 { { url: ( rootUrl + - '/v4/advertisers/{advertiserId}/channels/{+channelId}/sites' + '/v4/advertisers/{+advertiserId}/campaigns/{+campaignId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['advertiserId', 'channelId'], - pathParams: ['advertiserId', 'channelId'], + requiredParams: [ + 'advertiserId', + 'campaignId', + 'targetingType', + 'assignedTargetingOptionId', + ], + pathParams: [ + 'advertiserId', + 'assignedTargetingOptionId', + 'campaignId', + 'targetingType', + ], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a site from a channel. + * Lists the targeting options assigned to a campaign for a specified targeting type. * @example * ```js * // Before running the sample: @@ -11922,20 +12677,32 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.channels.sites.delete({ - * // The ID of the advertiser that owns the parent channel. - * advertiserId: 'placeholder-value', - * // Required. The ID of the parent channel to which the site belongs. - * channelId: '[^/]+', - * // The ID of the partner that owns the parent channel. - * partnerId: 'placeholder-value', - * // Required. The URL or app ID of the site to delete. - * urlOrAppId: '[^/]+', - * }); + * const res = + * await displayvideo.advertisers.campaigns.targetingTypes.assignedTargetingOptions.list( + * { + * // Required. The ID of the advertiser the campaign belongs to. + * advertiserId: '[^/]+', + * // Required. The ID of the campaign to list assigned targeting options for. + * campaignId: '[^/]+', + * // Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `AssignedTargetingOption` resources with ID 1 or 2 `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER` `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + * filter: 'placeholder-value', + * // Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`. + * orderBy: 'placeholder-value', + * // Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * pageSize: 'placeholder-value', + * // A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCampaignAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + * pageToken: 'placeholder-value', + * // Required. Identifies the type of assigned targeting options to list. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_VIEWABILITY` + * targetingType: '[^/]+', + * }, + * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "assignedTargetingOptions": [], + * // "nextPageToken": "my_nextPageToken" + * // } * } * * main().catch(e => { @@ -11950,53 +12717,62 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Advertisers$Channels$Sites$Delete, + list( + params: Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$List, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Advertisers$Channels$Sites$Delete, + list( + params?: Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$List, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Advertisers$Channels$Sites$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Advertisers$Channels$Sites$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Advertisers$Channels$Sites$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Advertisers$Channels$Sites$Delete - | BodyResponseCallback + | Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Channels$Sites$Delete; + {}) as Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Channels$Sites$Delete; + params = + {} as Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$List; options = {}; } @@ -12011,39 +12787,101 @@ export namespace displayvideo_v4 { { url: ( rootUrl + - '/v4/advertisers/{advertiserId}/channels/{+channelId}/sites/{+urlOrAppId}' + '/v4/advertisers/{+advertiserId}/campaigns/{+campaignId}/targetingTypes/{+targetingType}/assignedTargetingOptions' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['advertiserId', 'channelId', 'urlOrAppId'], - pathParams: ['advertiserId', 'channelId', 'urlOrAppId'], + requiredParams: ['advertiserId', 'campaignId', 'targetingType'], + pathParams: ['advertiserId', 'campaignId', 'targetingType'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$Get + extends StandardParameters { /** - * Lists sites in a channel. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` + * Required. The ID of the advertiser the campaign belongs to. + */ + advertiserId?: string; + /** + * Required. An identifier unique to the targeting type in this campaign that identifies the assigned targeting option being requested. + */ + assignedTargetingOptionId?: string; + /** + * Required. The ID of the campaign the assigned targeting option belongs to. + */ + campaignId?: string; + /** + * Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_VIEWABILITY` + */ + targetingType?: string; + } + export interface Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$List + extends StandardParameters { + /** + * Required. The ID of the advertiser the campaign belongs to. + */ + advertiserId?: string; + /** + * Required. The ID of the campaign to list assigned targeting options for. + */ + campaignId?: string; + /** + * Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `AssignedTargetingOption` resources with ID 1 or 2 `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER` `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCampaignAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * Required. Identifies the type of assigned targeting options to list. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_VIEWABILITY` + */ + targetingType?: string; + } + + export class Resource$Advertisers$Channels { + context: APIRequestContext; + sites: Resource$Advertisers$Channels$Sites; + constructor(context: APIRequestContext) { + this.context = context; + this.sites = new Resource$Advertisers$Channels$Sites(this.context); + } + + /** + * Creates a new channel. Returns the newly created channel if successful. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` * // - Install the npm module by running: * // ```sh * // $ npm install googleapis @@ -12063,28 +12901,37 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.channels.sites.list({ - * // The ID of the advertiser that owns the parent channel. + * const res = await displayvideo.advertisers.channels.create({ + * // The ID of the advertiser that owns the created channel. * advertiserId: '[^/]+', - * // Required. The ID of the parent channel to which the requested sites belong. - * channelId: '[^/]+', - * // Allows filtering by site fields. Supported syntax: * Filter expressions for site retrieval can only contain at most one restriction. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `HAS (:)` operator. Supported fields: * `urlOrAppId` Examples: * All sites for which the URL or app ID contains "google": `urlOrAppId : "google"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. - * filter: 'placeholder-value', - * // Field by which to sort the list. Acceptable values are: * `urlOrAppId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `urlOrAppId desc`. - * orderBy: 'placeholder-value', - * // Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListSites` method. If not specified, the first page of results will be returned. - * pageToken: 'placeholder-value', - * // The ID of the partner that owns the parent channel. + * // The ID of the partner that owns the created channel. * partnerId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "advertiserId": "my_advertiserId", + * // "channelId": "my_channelId", + * // "displayName": "my_displayName", + * // "name": "my_name", + * // "negativelyTargetedLineItemCount": "my_negativelyTargetedLineItemCount", + * // "partnerId": "my_partnerId", + * // "positivelyTargetedLineItemCount": "my_positivelyTargetedLineItemCount" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "sites": [] + * // "advertiserId": "my_advertiserId", + * // "channelId": "my_channelId", + * // "displayName": "my_displayName", + * // "name": "my_name", + * // "negativelyTargetedLineItemCount": "my_negativelyTargetedLineItemCount", + * // "partnerId": "my_partnerId", + * // "positivelyTargetedLineItemCount": "my_positivelyTargetedLineItemCount" * // } * } * @@ -12100,53 +12947,53 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Advertisers$Channels$Sites$List, + create( + params: Params$Resource$Advertisers$Channels$Create, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Advertisers$Channels$Sites$List, + create( + params?: Params$Resource$Advertisers$Channels$Create, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Advertisers$Channels$Sites$List, + ): Promise>; + create( + params: Params$Resource$Advertisers$Channels$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Advertisers$Channels$Sites$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Advertisers$Channels$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Advertisers$Channels$Sites$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Advertisers$Channels$Create, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Advertisers$Channels$Sites$List - | BodyResponseCallback + | Params$Resource$Advertisers$Channels$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Channels$Sites$List; + {}) as Params$Resource$Advertisers$Channels$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Channels$Sites$List; + params = {} as Params$Resource$Advertisers$Channels$Create; options = {}; } @@ -12159,32 +13006,32 @@ export namespace displayvideo_v4 { const parameters = { options: Object.assign( { - url: ( - rootUrl + - '/v4/advertisers/{+advertiserId}/channels/{+channelId}/sites' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v4/advertisers/{+advertiserId}/channels').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['advertiserId', 'channelId'], - pathParams: ['advertiserId', 'channelId'], + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Replaces all of the sites under a single channel. The operation will replace the sites under a channel with the sites provided in ReplaceSitesRequest.new_sites. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors. + * Gets a channel for a partner or advertiser. * @example * ```js * // Before running the sample: @@ -12213,27 +13060,25 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.channels.sites.replace({ - * // The ID of the advertiser that owns the parent channel. - * advertiserId: 'placeholder-value', - * // Required. The ID of the parent channel whose sites will be replaced. + * const res = await displayvideo.advertisers.channels.get({ + * // The ID of the advertiser that owns the fetched channel. + * advertiserId: '[^/]+', + * // Required. The ID of the channel to fetch. * channelId: '[^/]+', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "advertiserId": "my_advertiserId", - * // "newSites": [], - * // "partnerId": "my_partnerId" - * // } - * }, + * // The ID of the partner that owns the fetched channel. + * partnerId: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "sites": [] + * // "advertiserId": "my_advertiserId", + * // "channelId": "my_channelId", + * // "displayName": "my_displayName", + * // "name": "my_name", + * // "negativelyTargetedLineItemCount": "my_negativelyTargetedLineItemCount", + * // "partnerId": "my_partnerId", + * // "positivelyTargetedLineItemCount": "my_positivelyTargetedLineItemCount" * // } * } * @@ -12249,55 +13094,53 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - replace( - params: Params$Resource$Advertisers$Channels$Sites$Replace, + get( + params: Params$Resource$Advertisers$Channels$Get, options: StreamMethodOptions ): Promise>; - replace( - params?: Params$Resource$Advertisers$Channels$Sites$Replace, + get( + params?: Params$Resource$Advertisers$Channels$Get, options?: MethodOptions - ): Promise>; - replace( - params: Params$Resource$Advertisers$Channels$Sites$Replace, + ): Promise>; + get( + params: Params$Resource$Advertisers$Channels$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - replace( - params: Params$Resource$Advertisers$Channels$Sites$Replace, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Advertisers$Channels$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - replace( - params: Params$Resource$Advertisers$Channels$Sites$Replace, - callback: BodyResponseCallback + get( + params: Params$Resource$Advertisers$Channels$Get, + callback: BodyResponseCallback ): void; - replace(callback: BodyResponseCallback): void; - replace( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Advertisers$Channels$Sites$Replace - | BodyResponseCallback + | Params$Resource$Advertisers$Channels$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Channels$Sites$Replace; + {}) as Params$Resource$Advertisers$Channels$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Channels$Sites$Replace; + params = {} as Params$Resource$Advertisers$Channels$Get; options = {}; } @@ -12311,10 +13154,9 @@ export namespace displayvideo_v4 { options: Object.assign( { url: ( - rootUrl + - '/v4/advertisers/{advertiserId}/channels/{+channelId}/sites:replace' + rootUrl + '/v4/advertisers/{+advertiserId}/channels/{+channelId}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -12325,127 +13167,17 @@ export namespace displayvideo_v4 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Advertisers$Channels$Sites$Bulkedit - extends StandardParameters { - /** - * The ID of the advertiser that owns the parent channel. - */ - advertiserId?: string; - /** - * Required. The ID of the parent channel to which the sites belong. - */ - channelId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$BulkEditSitesRequest; - } - export interface Params$Resource$Advertisers$Channels$Sites$Create - extends StandardParameters { - /** - * The ID of the advertiser that owns the parent channel. - */ - advertiserId?: string; - /** - * Required. The ID of the parent channel in which the site will be created. - */ - channelId?: string; - /** - * The ID of the partner that owns the parent channel. - */ - partnerId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Site; - } - export interface Params$Resource$Advertisers$Channels$Sites$Delete - extends StandardParameters { - /** - * The ID of the advertiser that owns the parent channel. - */ - advertiserId?: string; - /** - * Required. The ID of the parent channel to which the site belongs. - */ - channelId?: string; - /** - * The ID of the partner that owns the parent channel. - */ - partnerId?: string; - /** - * Required. The URL or app ID of the site to delete. - */ - urlOrAppId?: string; - } - export interface Params$Resource$Advertisers$Channels$Sites$List - extends StandardParameters { - /** - * The ID of the advertiser that owns the parent channel. - */ - advertiserId?: string; - /** - * Required. The ID of the parent channel to which the requested sites belong. - */ - channelId?: string; - /** - * Allows filtering by site fields. Supported syntax: * Filter expressions for site retrieval can only contain at most one restriction. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `HAS (:)` operator. Supported fields: * `urlOrAppId` Examples: * All sites for which the URL or app ID contains "google": `urlOrAppId : "google"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. - */ - filter?: string; - /** - * Field by which to sort the list. Acceptable values are: * `urlOrAppId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `urlOrAppId desc`. - */ - orderBy?: string; - /** - * Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - */ - pageSize?: number; - /** - * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListSites` method. If not specified, the first page of results will be returned. - */ - pageToken?: string; - /** - * The ID of the partner that owns the parent channel. - */ - partnerId?: string; - } - export interface Params$Resource$Advertisers$Channels$Sites$Replace - extends StandardParameters { - /** - * The ID of the advertiser that owns the parent channel. - */ - advertiserId?: string; - /** - * Required. The ID of the parent channel whose sites will be replaced. - */ - channelId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ReplaceSitesRequest; - } - - export class Resource$Advertisers$Creatives { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Creates a new creative. Returns the newly created creative if successful. A ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request. + * Lists channels for a partner or advertiser. * @example * ```js * // Before running the sample: @@ -12474,115 +13206,26 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.creatives.create({ - * // Output only. The unique ID of the advertiser the creative belongs to. + * const res = await displayvideo.advertisers.channels.list({ + * // The ID of the advertiser that owns the channels. * advertiserId: '[^/]+', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "additionalDimensions": [], - * // "advertiserId": "my_advertiserId", - * // "appendedTag": "my_appendedTag", - * // "assets": [], - * // "cmPlacementId": "my_cmPlacementId", - * // "cmTrackingAd": {}, - * // "companionCreativeIds": [], - * // "counterEvents": [], - * // "createTime": "my_createTime", - * // "creativeAttributes": [], - * // "creativeId": "my_creativeId", - * // "creativeType": "my_creativeType", - * // "dimensions": {}, - * // "displayName": "my_displayName", - * // "dynamic": false, - * // "entityStatus": "my_entityStatus", - * // "exitEvents": [], - * // "expandOnHover": false, - * // "expandingDirection": "my_expandingDirection", - * // "hostingSource": "my_hostingSource", - * // "html5Video": false, - * // "iasCampaignMonitoring": false, - * // "integrationCode": "my_integrationCode", - * // "jsTrackerUrl": "my_jsTrackerUrl", - * // "lineItemIds": [], - * // "mediaDuration": "my_mediaDuration", - * // "mp3Audio": false, - * // "name": "my_name", - * // "notes": "my_notes", - * // "obaIcon": {}, - * // "oggAudio": false, - * // "progressOffset": {}, - * // "requireHtml5": false, - * // "requireMraid": false, - * // "requirePingForAttribution": false, - * // "reviewStatus": {}, - * // "skipOffset": {}, - * // "skippable": false, - * // "thirdPartyTag": "my_thirdPartyTag", - * // "thirdPartyUrls": [], - * // "timerEvents": [], - * // "trackerUrls": [], - * // "transcodes": [], - * // "universalAdId": {}, - * // "updateTime": "my_updateTime", - * // "vastTagUrl": "my_vastTagUrl", - * // "vpaid": false - * // } - * }, + * // Allows filtering by channel fields. Supported syntax: * Filter expressions for channel can only contain at most one restriction. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All channels for which the display name contains "google": `displayName : "google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + * filter: 'placeholder-value', + * // Field by which to sort the list. Acceptable values are: * `displayName` (default) * `channelId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `displayName desc`. + * orderBy: 'placeholder-value', + * // Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * pageSize: 'placeholder-value', + * // A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListChannels` method. If not specified, the first page of results will be returned. + * pageToken: 'placeholder-value', + * // The ID of the partner that owns the channels. + * partnerId: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "additionalDimensions": [], - * // "advertiserId": "my_advertiserId", - * // "appendedTag": "my_appendedTag", - * // "assets": [], - * // "cmPlacementId": "my_cmPlacementId", - * // "cmTrackingAd": {}, - * // "companionCreativeIds": [], - * // "counterEvents": [], - * // "createTime": "my_createTime", - * // "creativeAttributes": [], - * // "creativeId": "my_creativeId", - * // "creativeType": "my_creativeType", - * // "dimensions": {}, - * // "displayName": "my_displayName", - * // "dynamic": false, - * // "entityStatus": "my_entityStatus", - * // "exitEvents": [], - * // "expandOnHover": false, - * // "expandingDirection": "my_expandingDirection", - * // "hostingSource": "my_hostingSource", - * // "html5Video": false, - * // "iasCampaignMonitoring": false, - * // "integrationCode": "my_integrationCode", - * // "jsTrackerUrl": "my_jsTrackerUrl", - * // "lineItemIds": [], - * // "mediaDuration": "my_mediaDuration", - * // "mp3Audio": false, - * // "name": "my_name", - * // "notes": "my_notes", - * // "obaIcon": {}, - * // "oggAudio": false, - * // "progressOffset": {}, - * // "requireHtml5": false, - * // "requireMraid": false, - * // "requirePingForAttribution": false, - * // "reviewStatus": {}, - * // "skipOffset": {}, - * // "skippable": false, - * // "thirdPartyTag": "my_thirdPartyTag", - * // "thirdPartyUrls": [], - * // "timerEvents": [], - * // "trackerUrls": [], - * // "transcodes": [], - * // "universalAdId": {}, - * // "updateTime": "my_updateTime", - * // "vastTagUrl": "my_vastTagUrl", - * // "vpaid": false + * // "channels": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -12598,53 +13241,55 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Advertisers$Creatives$Create, + list( + params: Params$Resource$Advertisers$Channels$List, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Advertisers$Creatives$Create, + list( + params?: Params$Resource$Advertisers$Channels$List, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Advertisers$Creatives$Create, + ): Promise>; + list( + params: Params$Resource$Advertisers$Channels$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Advertisers$Creatives$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Advertisers$Channels$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Advertisers$Creatives$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Advertisers$Channels$List, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Advertisers$Creatives$Create - | BodyResponseCallback + | Params$Resource$Advertisers$Channels$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Creatives$Create; + {}) as Params$Resource$Advertisers$Channels$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Creatives$Create; + params = {} as Params$Resource$Advertisers$Channels$List; options = {}; } @@ -12657,10 +13302,11 @@ export namespace displayvideo_v4 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v4/advertisers/{+advertiserId}/creatives' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v4/advertisers/{+advertiserId}/channels').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -12671,17 +13317,17 @@ export namespace displayvideo_v4 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a creative. Returns error code `NOT_FOUND` if the creative does not exist. The creative should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, before it can be deleted. A ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request. + * Updates a channel. Returns the updated channel if successful. * @example * ```js * // Before running the sample: @@ -12710,16 +13356,42 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.creatives.delete({ - * // The ID of the advertiser this creative belongs to. + * const res = await displayvideo.advertisers.channels.patch({ + * // The ID of the advertiser that owns the created channel. * advertiserId: '[^/]+', - * // The ID of the creative to be deleted. - * creativeId: '[^/]+', + * // Output only. The unique ID of the channel. Assigned by the system. + * channelId: 'placeholder-value', + * // The ID of the partner that owns the created channel. + * partnerId: 'placeholder-value', + * // Required. The mask to control which fields to update. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "advertiserId": "my_advertiserId", + * // "channelId": "my_channelId", + * // "displayName": "my_displayName", + * // "name": "my_name", + * // "negativelyTargetedLineItemCount": "my_negativelyTargetedLineItemCount", + * // "partnerId": "my_partnerId", + * // "positivelyTargetedLineItemCount": "my_positivelyTargetedLineItemCount" + * // } + * }, * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "advertiserId": "my_advertiserId", + * // "channelId": "my_channelId", + * // "displayName": "my_displayName", + * // "name": "my_name", + * // "negativelyTargetedLineItemCount": "my_negativelyTargetedLineItemCount", + * // "partnerId": "my_partnerId", + * // "positivelyTargetedLineItemCount": "my_positivelyTargetedLineItemCount" + * // } * } * * main().catch(e => { @@ -12734,53 +13406,53 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Advertisers$Creatives$Delete, + patch( + params: Params$Resource$Advertisers$Channels$Patch, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Advertisers$Creatives$Delete, + patch( + params?: Params$Resource$Advertisers$Channels$Patch, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Advertisers$Creatives$Delete, + ): Promise>; + patch( + params: Params$Resource$Advertisers$Channels$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Advertisers$Creatives$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Advertisers$Channels$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Advertisers$Creatives$Delete, - callback: BodyResponseCallback + patch( + params: Params$Resource$Advertisers$Channels$Patch, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Advertisers$Creatives$Delete - | BodyResponseCallback + | Params$Resource$Advertisers$Channels$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Creatives$Delete; + {}) as Params$Resource$Advertisers$Channels$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Creatives$Delete; + params = {} as Params$Resource$Advertisers$Channels$Patch; options = {}; } @@ -12794,31 +13466,120 @@ export namespace displayvideo_v4 { options: Object.assign( { url: ( - rootUrl + - '/v4/advertisers/{+advertiserId}/creatives/{+creativeId}' + rootUrl + '/v4/advertisers/{+advertiserId}/channels/{channelId}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['advertiserId', 'creativeId'], - pathParams: ['advertiserId', 'creativeId'], + requiredParams: ['advertiserId', 'channelId'], + pathParams: ['advertiserId', 'channelId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Advertisers$Channels$Create + extends StandardParameters { /** - * Gets a creative. + * The ID of the advertiser that owns the created channel. + */ + advertiserId?: string; + /** + * The ID of the partner that owns the created channel. + */ + partnerId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Channel; + } + export interface Params$Resource$Advertisers$Channels$Get + extends StandardParameters { + /** + * The ID of the advertiser that owns the fetched channel. + */ + advertiserId?: string; + /** + * Required. The ID of the channel to fetch. + */ + channelId?: string; + /** + * The ID of the partner that owns the fetched channel. + */ + partnerId?: string; + } + export interface Params$Resource$Advertisers$Channels$List + extends StandardParameters { + /** + * The ID of the advertiser that owns the channels. + */ + advertiserId?: string; + /** + * Allows filtering by channel fields. Supported syntax: * Filter expressions for channel can only contain at most one restriction. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All channels for which the display name contains "google": `displayName : "google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `displayName` (default) * `channelId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `displayName desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListChannels` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * The ID of the partner that owns the channels. + */ + partnerId?: string; + } + export interface Params$Resource$Advertisers$Channels$Patch + extends StandardParameters { + /** + * The ID of the advertiser that owns the created channel. + */ + advertiserId?: string; + /** + * Output only. The unique ID of the channel. Assigned by the system. + */ + channelId?: string; + /** + * The ID of the partner that owns the created channel. + */ + partnerId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Channel; + } + + export class Resource$Advertisers$Channels$Sites { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Bulk edits sites under a single channel. The operation will delete the sites provided in BulkEditSitesRequest.deleted_sites and then create the sites provided in BulkEditSitesRequest.created_sites. * @example * ```js * // Before running the sample: @@ -12847,63 +13608,28 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.creatives.get({ - * // Required. The ID of the advertiser this creative belongs to. - * advertiserId: '[^/]+', - * // Required. The ID of the creative to fetch. - * creativeId: '[^/]+', + * const res = await displayvideo.advertisers.channels.sites.bulkEdit({ + * // The ID of the advertiser that owns the parent channel. + * advertiserId: 'placeholder-value', + * // Required. The ID of the parent channel to which the sites belong. + * channelId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "advertiserId": "my_advertiserId", + * // "createdSites": [], + * // "deletedSites": [], + * // "partnerId": "my_partnerId" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "additionalDimensions": [], - * // "advertiserId": "my_advertiserId", - * // "appendedTag": "my_appendedTag", - * // "assets": [], - * // "cmPlacementId": "my_cmPlacementId", - * // "cmTrackingAd": {}, - * // "companionCreativeIds": [], - * // "counterEvents": [], - * // "createTime": "my_createTime", - * // "creativeAttributes": [], - * // "creativeId": "my_creativeId", - * // "creativeType": "my_creativeType", - * // "dimensions": {}, - * // "displayName": "my_displayName", - * // "dynamic": false, - * // "entityStatus": "my_entityStatus", - * // "exitEvents": [], - * // "expandOnHover": false, - * // "expandingDirection": "my_expandingDirection", - * // "hostingSource": "my_hostingSource", - * // "html5Video": false, - * // "iasCampaignMonitoring": false, - * // "integrationCode": "my_integrationCode", - * // "jsTrackerUrl": "my_jsTrackerUrl", - * // "lineItemIds": [], - * // "mediaDuration": "my_mediaDuration", - * // "mp3Audio": false, - * // "name": "my_name", - * // "notes": "my_notes", - * // "obaIcon": {}, - * // "oggAudio": false, - * // "progressOffset": {}, - * // "requireHtml5": false, - * // "requireMraid": false, - * // "requirePingForAttribution": false, - * // "reviewStatus": {}, - * // "skipOffset": {}, - * // "skippable": false, - * // "thirdPartyTag": "my_thirdPartyTag", - * // "thirdPartyUrls": [], - * // "timerEvents": [], - * // "trackerUrls": [], - * // "transcodes": [], - * // "universalAdId": {}, - * // "updateTime": "my_updateTime", - * // "vastTagUrl": "my_vastTagUrl", - * // "vpaid": false + * // "sites": [] * // } * } * @@ -12919,53 +13645,57 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Advertisers$Creatives$Get, + bulkEdit( + params: Params$Resource$Advertisers$Channels$Sites$Bulkedit, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Advertisers$Creatives$Get, + bulkEdit( + params?: Params$Resource$Advertisers$Channels$Sites$Bulkedit, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Advertisers$Creatives$Get, + ): Promise>; + bulkEdit( + params: Params$Resource$Advertisers$Channels$Sites$Bulkedit, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Advertisers$Creatives$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + bulkEdit( + params: Params$Resource$Advertisers$Channels$Sites$Bulkedit, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Advertisers$Creatives$Get, - callback: BodyResponseCallback + bulkEdit( + params: Params$Resource$Advertisers$Channels$Sites$Bulkedit, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + bulkEdit( + callback: BodyResponseCallback + ): void; + bulkEdit( paramsOrCallback?: - | Params$Resource$Advertisers$Creatives$Get - | BodyResponseCallback + | Params$Resource$Advertisers$Channels$Sites$Bulkedit + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Creatives$Get; + {}) as Params$Resource$Advertisers$Channels$Sites$Bulkedit; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Creatives$Get; + params = {} as Params$Resource$Advertisers$Channels$Sites$Bulkedit; options = {}; } @@ -12980,30 +13710,30 @@ export namespace displayvideo_v4 { { url: ( rootUrl + - '/v4/advertisers/{+advertiserId}/creatives/{+creativeId}' + '/v4/advertisers/{advertiserId}/channels/{+channelId}/sites:bulkEdit' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['advertiserId', 'creativeId'], - pathParams: ['advertiserId', 'creativeId'], + requiredParams: ['advertiserId', 'channelId'], + pathParams: ['advertiserId', 'channelId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists creatives in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, creatives with `ENTITY_STATUS_ARCHIVED` will not be included in the results. + * Creates a site in a channel. * @example * ```js * // Before running the sample: @@ -13032,24 +13762,29 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.creatives.list({ - * // Required. The ID of the advertiser to list creatives for. - * advertiserId: '[^/]+', - * // Allows filtering by creative fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * The `lineItemIds` field must use the `HAS (:)` operator. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. * For `entityStatus`, `minDuration`, `maxDuration`, `updateTime`, and `dynamic` fields, there may be at most one restriction. Supported Fields: * `approvalStatus` * `creativeId` * `creativeType` * `dimensions` (input in the form of `{width\}x{height\}`) * `dynamic` * `entityStatus` * `exchangeReviewStatus` (input in the form of `{exchange\}-{reviewStatus\}`) * `lineItemIds` * `maxDuration` (input in the form of `{duration\}s`. Only seconds are supported) * `minDuration` (input in the form of `{duration\}s`. Only seconds are supported) * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Notes: * For `updateTime`, a creative resource's field value reflects the last time that a creative has been updated, which includes updates made by the system (e.g. creative review updates). Examples: * All native creatives: `creativeType="CREATIVE_TYPE_NATIVE"` * All active creatives with 300x400 or 50x100 dimensions: `entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100")` * All dynamic creatives that are approved by AdX or AppNexus, with a minimum duration of 5 seconds and 200ms: `dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")` * All video creatives that are associated with line item ID 1 or 2: `creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2)` * Find creatives by multiple creative IDs: `creativeId=1 OR creativeId=2` * All creatives with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. - * filter: 'placeholder-value', - * // Field by which to sort the list. Acceptable values are: * `creativeId` (default) * `createTime` * `mediaDuration` * `dimensions` (sorts by width first, then by height) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `createTime desc`. - * orderBy: 'placeholder-value', - * // Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCreatives` method. If not specified, the first page of results will be returned. - * pageToken: 'placeholder-value', + * const res = await displayvideo.advertisers.channels.sites.create({ + * // The ID of the advertiser that owns the parent channel. + * advertiserId: 'placeholder-value', + * // Required. The ID of the parent channel in which the site will be created. + * channelId: '[^/]+', + * // The ID of the partner that owns the parent channel. + * partnerId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "name": "my_name", + * // "urlOrAppId": "my_urlOrAppId" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "creatives": [], - * // "nextPageToken": "my_nextPageToken" + * // "name": "my_name", + * // "urlOrAppId": "my_urlOrAppId" * // } * } * @@ -13065,55 +13800,53 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Advertisers$Creatives$List, + create( + params: Params$Resource$Advertisers$Channels$Sites$Create, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Advertisers$Creatives$List, + create( + params?: Params$Resource$Advertisers$Channels$Sites$Create, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Advertisers$Creatives$List, + ): Promise>; + create( + params: Params$Resource$Advertisers$Channels$Sites$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Advertisers$Creatives$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Advertisers$Channels$Sites$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Advertisers$Creatives$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Advertisers$Channels$Sites$Create, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Advertisers$Creatives$List - | BodyResponseCallback + | Params$Resource$Advertisers$Channels$Sites$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Creatives$List; + {}) as Params$Resource$Advertisers$Channels$Sites$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Creatives$List; + params = {} as Params$Resource$Advertisers$Channels$Sites$Create; options = {}; } @@ -13127,30 +13860,31 @@ export namespace displayvideo_v4 { options: Object.assign( { url: ( - rootUrl + '/v4/advertisers/{+advertiserId}/creatives' + rootUrl + + '/v4/advertisers/{advertiserId}/channels/{+channelId}/sites' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['advertiserId'], - pathParams: ['advertiserId'], + requiredParams: ['advertiserId', 'channelId'], + pathParams: ['advertiserId', 'channelId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates an existing creative. Returns the updated creative if successful. A ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request. + * Deletes a site from a channel. * @example * ```js * // Before running the sample: @@ -13179,120 +13913,20 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.creatives.patch({ - * // Output only. The unique ID of the advertiser the creative belongs to. - * advertiserId: '[^/]+', - * // Output only. The unique ID of the creative. Assigned by the system. - * creativeId: '[^/]+', - * // Required. The mask to control which fields to update. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "additionalDimensions": [], - * // "advertiserId": "my_advertiserId", - * // "appendedTag": "my_appendedTag", - * // "assets": [], - * // "cmPlacementId": "my_cmPlacementId", - * // "cmTrackingAd": {}, - * // "companionCreativeIds": [], - * // "counterEvents": [], - * // "createTime": "my_createTime", - * // "creativeAttributes": [], - * // "creativeId": "my_creativeId", - * // "creativeType": "my_creativeType", - * // "dimensions": {}, - * // "displayName": "my_displayName", - * // "dynamic": false, - * // "entityStatus": "my_entityStatus", - * // "exitEvents": [], - * // "expandOnHover": false, - * // "expandingDirection": "my_expandingDirection", - * // "hostingSource": "my_hostingSource", - * // "html5Video": false, - * // "iasCampaignMonitoring": false, - * // "integrationCode": "my_integrationCode", - * // "jsTrackerUrl": "my_jsTrackerUrl", - * // "lineItemIds": [], - * // "mediaDuration": "my_mediaDuration", - * // "mp3Audio": false, - * // "name": "my_name", - * // "notes": "my_notes", - * // "obaIcon": {}, - * // "oggAudio": false, - * // "progressOffset": {}, - * // "requireHtml5": false, - * // "requireMraid": false, - * // "requirePingForAttribution": false, - * // "reviewStatus": {}, - * // "skipOffset": {}, - * // "skippable": false, - * // "thirdPartyTag": "my_thirdPartyTag", - * // "thirdPartyUrls": [], - * // "timerEvents": [], - * // "trackerUrls": [], - * // "transcodes": [], - * // "universalAdId": {}, - * // "updateTime": "my_updateTime", - * // "vastTagUrl": "my_vastTagUrl", - * // "vpaid": false - * // } - * }, - * }); - * console.log(res.data); + * const res = await displayvideo.advertisers.channels.sites.delete({ + * // The ID of the advertiser that owns the parent channel. + * advertiserId: 'placeholder-value', + * // Required. The ID of the parent channel to which the site belongs. + * channelId: '[^/]+', + * // The ID of the partner that owns the parent channel. + * partnerId: 'placeholder-value', + * // Required. The URL or app ID of the site to delete. + * urlOrAppId: '[^/]+', + * }); + * console.log(res.data); * * // Example response - * // { - * // "additionalDimensions": [], - * // "advertiserId": "my_advertiserId", - * // "appendedTag": "my_appendedTag", - * // "assets": [], - * // "cmPlacementId": "my_cmPlacementId", - * // "cmTrackingAd": {}, - * // "companionCreativeIds": [], - * // "counterEvents": [], - * // "createTime": "my_createTime", - * // "creativeAttributes": [], - * // "creativeId": "my_creativeId", - * // "creativeType": "my_creativeType", - * // "dimensions": {}, - * // "displayName": "my_displayName", - * // "dynamic": false, - * // "entityStatus": "my_entityStatus", - * // "exitEvents": [], - * // "expandOnHover": false, - * // "expandingDirection": "my_expandingDirection", - * // "hostingSource": "my_hostingSource", - * // "html5Video": false, - * // "iasCampaignMonitoring": false, - * // "integrationCode": "my_integrationCode", - * // "jsTrackerUrl": "my_jsTrackerUrl", - * // "lineItemIds": [], - * // "mediaDuration": "my_mediaDuration", - * // "mp3Audio": false, - * // "name": "my_name", - * // "notes": "my_notes", - * // "obaIcon": {}, - * // "oggAudio": false, - * // "progressOffset": {}, - * // "requireHtml5": false, - * // "requireMraid": false, - * // "requirePingForAttribution": false, - * // "reviewStatus": {}, - * // "skipOffset": {}, - * // "skippable": false, - * // "thirdPartyTag": "my_thirdPartyTag", - * // "thirdPartyUrls": [], - * // "timerEvents": [], - * // "trackerUrls": [], - * // "transcodes": [], - * // "universalAdId": {}, - * // "updateTime": "my_updateTime", - * // "vastTagUrl": "my_vastTagUrl", - * // "vpaid": false - * // } + * // {} * } * * main().catch(e => { @@ -13307,53 +13941,53 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Advertisers$Creatives$Patch, + delete( + params: Params$Resource$Advertisers$Channels$Sites$Delete, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Advertisers$Creatives$Patch, + delete( + params?: Params$Resource$Advertisers$Channels$Sites$Delete, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Advertisers$Creatives$Patch, + ): Promise>; + delete( + params: Params$Resource$Advertisers$Channels$Sites$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Advertisers$Creatives$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Advertisers$Channels$Sites$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Advertisers$Creatives$Patch, - callback: BodyResponseCallback + delete( + params: Params$Resource$Advertisers$Channels$Sites$Delete, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Advertisers$Creatives$Patch - | BodyResponseCallback + | Params$Resource$Advertisers$Channels$Sites$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Creatives$Patch; + {}) as Params$Resource$Advertisers$Channels$Sites$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Creatives$Patch; + params = {} as Params$Resource$Advertisers$Channels$Sites$Delete; options = {}; } @@ -13368,118 +14002,30 @@ export namespace displayvideo_v4 { { url: ( rootUrl + - '/v4/advertisers/{+advertiserId}/creatives/{+creativeId}' + '/v4/advertisers/{advertiserId}/channels/{+channelId}/sites/{+urlOrAppId}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['advertiserId', 'creativeId'], - pathParams: ['advertiserId', 'creativeId'], + requiredParams: ['advertiserId', 'channelId', 'urlOrAppId'], + pathParams: ['advertiserId', 'channelId', 'urlOrAppId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Advertisers$Creatives$Create - extends StandardParameters { - /** - * Output only. The unique ID of the advertiser the creative belongs to. - */ - advertiserId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Creative; - } - export interface Params$Resource$Advertisers$Creatives$Delete - extends StandardParameters { - /** - * The ID of the advertiser this creative belongs to. - */ - advertiserId?: string; - /** - * The ID of the creative to be deleted. - */ - creativeId?: string; - } - export interface Params$Resource$Advertisers$Creatives$Get - extends StandardParameters { - /** - * Required. The ID of the advertiser this creative belongs to. - */ - advertiserId?: string; - /** - * Required. The ID of the creative to fetch. - */ - creativeId?: string; - } - export interface Params$Resource$Advertisers$Creatives$List - extends StandardParameters { - /** - * Required. The ID of the advertiser to list creatives for. - */ - advertiserId?: string; - /** - * Allows filtering by creative fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * The `lineItemIds` field must use the `HAS (:)` operator. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. * For `entityStatus`, `minDuration`, `maxDuration`, `updateTime`, and `dynamic` fields, there may be at most one restriction. Supported Fields: * `approvalStatus` * `creativeId` * `creativeType` * `dimensions` (input in the form of `{width\}x{height\}`) * `dynamic` * `entityStatus` * `exchangeReviewStatus` (input in the form of `{exchange\}-{reviewStatus\}`) * `lineItemIds` * `maxDuration` (input in the form of `{duration\}s`. Only seconds are supported) * `minDuration` (input in the form of `{duration\}s`. Only seconds are supported) * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Notes: * For `updateTime`, a creative resource's field value reflects the last time that a creative has been updated, which includes updates made by the system (e.g. creative review updates). Examples: * All native creatives: `creativeType="CREATIVE_TYPE_NATIVE"` * All active creatives with 300x400 or 50x100 dimensions: `entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100")` * All dynamic creatives that are approved by AdX or AppNexus, with a minimum duration of 5 seconds and 200ms: `dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")` * All video creatives that are associated with line item ID 1 or 2: `creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2)` * Find creatives by multiple creative IDs: `creativeId=1 OR creativeId=2` * All creatives with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. - */ - filter?: string; - /** - * Field by which to sort the list. Acceptable values are: * `creativeId` (default) * `createTime` * `mediaDuration` * `dimensions` (sorts by width first, then by height) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `createTime desc`. - */ - orderBy?: string; - /** - * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - */ - pageSize?: number; - /** - * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCreatives` method. If not specified, the first page of results will be returned. - */ - pageToken?: string; - } - export interface Params$Resource$Advertisers$Creatives$Patch - extends StandardParameters { - /** - * Output only. The unique ID of the advertiser the creative belongs to. - */ - advertiserId?: string; - /** - * Output only. The unique ID of the creative. Assigned by the system. - */ - creativeId?: string; - /** - * Required. The mask to control which fields to update. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Creative; - } - - export class Resource$Advertisers$Insertionorders { - context: APIRequestContext; - targetingTypes: Resource$Advertisers$Insertionorders$Targetingtypes; - constructor(context: APIRequestContext) { - this.context = context; - this.targetingTypes = - new Resource$Advertisers$Insertionorders$Targetingtypes(this.context); - } /** - * Creates a new insertion order. Returns the newly created insertion order if successful. + * Lists sites in a channel. * @example * ```js * // Before running the sample: @@ -13508,55 +14054,28 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.insertionOrders.create({ - * // Output only. The unique ID of the advertiser the insertion order belongs to. + * const res = await displayvideo.advertisers.channels.sites.list({ + * // The ID of the advertiser that owns the parent channel. * advertiserId: '[^/]+', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "advertiserId": "my_advertiserId", - * // "bidStrategy": {}, - * // "budget": {}, - * // "campaignId": "my_campaignId", - * // "displayName": "my_displayName", - * // "entityStatus": "my_entityStatus", - * // "frequencyCap": {}, - * // "insertionOrderId": "my_insertionOrderId", - * // "insertionOrderType": "my_insertionOrderType", - * // "integrationDetails": {}, - * // "kpi": {}, - * // "name": "my_name", - * // "optimizationObjective": "my_optimizationObjective", - * // "pacing": {}, - * // "partnerCosts": [], - * // "reservationType": "my_reservationType", - * // "updateTime": "my_updateTime" - * // } - * }, + * // Required. The ID of the parent channel to which the requested sites belong. + * channelId: '[^/]+', + * // Allows filtering by site fields. Supported syntax: * Filter expressions for site retrieval can only contain at most one restriction. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `HAS (:)` operator. Supported fields: * `urlOrAppId` Examples: * All sites for which the URL or app ID contains "google": `urlOrAppId : "google"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + * filter: 'placeholder-value', + * // Field by which to sort the list. Acceptable values are: * `urlOrAppId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `urlOrAppId desc`. + * orderBy: 'placeholder-value', + * // Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * pageSize: 'placeholder-value', + * // A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListSites` method. If not specified, the first page of results will be returned. + * pageToken: 'placeholder-value', + * // The ID of the partner that owns the parent channel. + * partnerId: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "advertiserId": "my_advertiserId", - * // "bidStrategy": {}, - * // "budget": {}, - * // "campaignId": "my_campaignId", - * // "displayName": "my_displayName", - * // "entityStatus": "my_entityStatus", - * // "frequencyCap": {}, - * // "insertionOrderId": "my_insertionOrderId", - * // "insertionOrderType": "my_insertionOrderType", - * // "integrationDetails": {}, - * // "kpi": {}, - * // "name": "my_name", - * // "optimizationObjective": "my_optimizationObjective", - * // "pacing": {}, - * // "partnerCosts": [], - * // "reservationType": "my_reservationType", - * // "updateTime": "my_updateTime" + * // "nextPageToken": "my_nextPageToken", + * // "sites": [] * // } * } * @@ -13572,53 +14091,53 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Advertisers$Insertionorders$Create, + list( + params: Params$Resource$Advertisers$Channels$Sites$List, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Advertisers$Insertionorders$Create, + list( + params?: Params$Resource$Advertisers$Channels$Sites$List, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Advertisers$Insertionorders$Create, + ): Promise>; + list( + params: Params$Resource$Advertisers$Channels$Sites$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Advertisers$Insertionorders$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Advertisers$Channels$Sites$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Advertisers$Insertionorders$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Advertisers$Channels$Sites$List, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Advertisers$Insertionorders$Create - | BodyResponseCallback + | Params$Resource$Advertisers$Channels$Sites$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Insertionorders$Create; + {}) as Params$Resource$Advertisers$Channels$Sites$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Insertionorders$Create; + params = {} as Params$Resource$Advertisers$Channels$Sites$List; options = {}; } @@ -13632,30 +14151,31 @@ export namespace displayvideo_v4 { options: Object.assign( { url: ( - rootUrl + '/v4/advertisers/{+advertiserId}/insertionOrders' + rootUrl + + '/v4/advertisers/{+advertiserId}/channels/{+channelId}/sites' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['advertiserId'], - pathParams: ['advertiserId'], + requiredParams: ['advertiserId', 'channelId'], + pathParams: ['advertiserId', 'channelId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist. The insertion order should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. + * Replaces all of the sites under a single channel. The operation will replace the sites under a channel with the sites provided in ReplaceSitesRequest.new_sites. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors. * @example * ```js * // Before running the sample: @@ -13684,16 +14204,28 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.insertionOrders.delete({ - * // The ID of the advertiser this insertion order belongs to. - * advertiserId: '[^/]+', - * // The ID of the insertion order to delete. - * insertionOrderId: '[^/]+', + * const res = await displayvideo.advertisers.channels.sites.replace({ + * // The ID of the advertiser that owns the parent channel. + * advertiserId: 'placeholder-value', + * // Required. The ID of the parent channel whose sites will be replaced. + * channelId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "advertiserId": "my_advertiserId", + * // "newSites": [], + * // "partnerId": "my_partnerId" + * // } + * }, * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "sites": [] + * // } * } * * main().catch(e => { @@ -13708,53 +14240,55 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Advertisers$Insertionorders$Delete, + replace( + params: Params$Resource$Advertisers$Channels$Sites$Replace, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Advertisers$Insertionorders$Delete, + replace( + params?: Params$Resource$Advertisers$Channels$Sites$Replace, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Advertisers$Insertionorders$Delete, + ): Promise>; + replace( + params: Params$Resource$Advertisers$Channels$Sites$Replace, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Advertisers$Insertionorders$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + replace( + params: Params$Resource$Advertisers$Channels$Sites$Replace, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Advertisers$Insertionorders$Delete, - callback: BodyResponseCallback + replace( + params: Params$Resource$Advertisers$Channels$Sites$Replace, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + replace(callback: BodyResponseCallback): void; + replace( paramsOrCallback?: - | Params$Resource$Advertisers$Insertionorders$Delete - | BodyResponseCallback + | Params$Resource$Advertisers$Channels$Sites$Replace + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Insertionorders$Delete; + {}) as Params$Resource$Advertisers$Channels$Sites$Replace; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Insertionorders$Delete; + params = {} as Params$Resource$Advertisers$Channels$Sites$Replace; options = {}; } @@ -13769,185 +14303,140 @@ export namespace displayvideo_v4 { { url: ( rootUrl + - '/v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}' + '/v4/advertisers/{advertiserId}/channels/{+channelId}/sites:replace' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['advertiserId', 'insertionOrderId'], - pathParams: ['advertiserId', 'insertionOrderId'], + requiredParams: ['advertiserId', 'channelId'], + pathParams: ['advertiserId', 'channelId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Advertisers$Channels$Sites$Bulkedit + extends StandardParameters { /** - * Gets an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const displayvideo = google.displayvideo('v4'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/display-video'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await displayvideo.advertisers.insertionOrders.get({ - * // Required. The ID of the advertiser this insertion order belongs to. - * advertiserId: '[^/]+', - * // Required. The ID of the insertion order to fetch. - * insertionOrderId: '[^/]+', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "advertiserId": "my_advertiserId", - * // "bidStrategy": {}, - * // "budget": {}, - * // "campaignId": "my_campaignId", - * // "displayName": "my_displayName", - * // "entityStatus": "my_entityStatus", - * // "frequencyCap": {}, - * // "insertionOrderId": "my_insertionOrderId", - * // "insertionOrderType": "my_insertionOrderType", - * // "integrationDetails": {}, - * // "kpi": {}, - * // "name": "my_name", - * // "optimizationObjective": "my_optimizationObjective", - * // "pacing": {}, - * // "partnerCosts": [], - * // "reservationType": "my_reservationType", - * // "updateTime": "my_updateTime" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * The ID of the advertiser that owns the parent channel. */ - get( - params: Params$Resource$Advertisers$Insertionorders$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Advertisers$Insertionorders$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Advertisers$Insertionorders$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Advertisers$Insertionorders$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Advertisers$Insertionorders$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Advertisers$Insertionorders$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Insertionorders$Get; - let options = (optionsOrCallback || {}) as MethodOptions; + advertiserId?: string; + /** + * Required. The ID of the parent channel to which the sites belong. + */ + channelId?: string; - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Insertionorders$Get; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$BulkEditSitesRequest; + } + export interface Params$Resource$Advertisers$Channels$Sites$Create + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent channel. + */ + advertiserId?: string; + /** + * Required. The ID of the parent channel in which the site will be created. + */ + channelId?: string; + /** + * The ID of the partner that owns the parent channel. + */ + partnerId?: string; - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$Site; + } + export interface Params$Resource$Advertisers$Channels$Sites$Delete + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent channel. + */ + advertiserId?: string; + /** + * Required. The ID of the parent channel to which the site belongs. + */ + channelId?: string; + /** + * The ID of the partner that owns the parent channel. + */ + partnerId?: string; + /** + * Required. The URL or app ID of the site to delete. + */ + urlOrAppId?: string; + } + export interface Params$Resource$Advertisers$Channels$Sites$List + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent channel. + */ + advertiserId?: string; + /** + * Required. The ID of the parent channel to which the requested sites belong. + */ + channelId?: string; + /** + * Allows filtering by site fields. Supported syntax: * Filter expressions for site retrieval can only contain at most one restriction. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `HAS (:)` operator. Supported fields: * `urlOrAppId` Examples: * All sites for which the URL or app ID contains "google": `urlOrAppId : "google"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `urlOrAppId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `urlOrAppId desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListSites` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * The ID of the partner that owns the parent channel. + */ + partnerId?: string; + } + export interface Params$Resource$Advertisers$Channels$Sites$Replace + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent channel. + */ + advertiserId?: string; + /** + * Required. The ID of the parent channel whose sites will be replaced. + */ + channelId?: string; - const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['advertiserId', 'insertionOrderId'], - pathParams: ['advertiserId', 'insertionOrderId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } + /** + * Request body metadata + */ + requestBody?: Schema$ReplaceSitesRequest; + } + + export class Resource$Advertisers$Creatives { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Lists insertion orders in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, insertion orders with `ENTITY_STATUS_ARCHIVED` will not be included in the results. + * Creates a new creative. Returns the newly created creative if successful. A ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request. * @example * ```js * // Before running the sample: @@ -13976,90 +14465,177 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.insertionOrders.list({ - * // Required. The ID of the advertiser to list insertion orders for. + * const res = await displayvideo.advertisers.creatives.create({ + * // Output only. The unique ID of the advertiser the creative belongs to. * advertiserId: '[^/]+', - * // Allows filtering by insertion order fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All insertion orders under a campaign: `campaignId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")` * All insertion orders with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All insertion orders with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. - * filter: 'placeholder-value', - * // Field by which to sort the list. Acceptable values are: * "displayName" (default) * "entityStatus" * "updateTime" The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. - * orderBy: 'placeholder-value', - * // Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInsertionOrders` method. If not specified, the first page of results will be returned. - * pageToken: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "additionalDimensions": [], + * // "advertiserId": "my_advertiserId", + * // "appendedTag": "my_appendedTag", + * // "assets": [], + * // "cmPlacementId": "my_cmPlacementId", + * // "cmTrackingAd": {}, + * // "companionCreativeIds": [], + * // "counterEvents": [], + * // "createTime": "my_createTime", + * // "creativeAttributes": [], + * // "creativeId": "my_creativeId", + * // "creativeType": "my_creativeType", + * // "dimensions": {}, + * // "displayName": "my_displayName", + * // "dynamic": false, + * // "entityStatus": "my_entityStatus", + * // "exitEvents": [], + * // "expandOnHover": false, + * // "expandingDirection": "my_expandingDirection", + * // "hostingSource": "my_hostingSource", + * // "html5Video": false, + * // "iasCampaignMonitoring": false, + * // "integrationCode": "my_integrationCode", + * // "jsTrackerUrl": "my_jsTrackerUrl", + * // "lineItemIds": [], + * // "mediaDuration": "my_mediaDuration", + * // "mp3Audio": false, + * // "name": "my_name", + * // "notes": "my_notes", + * // "obaIcon": {}, + * // "oggAudio": false, + * // "progressOffset": {}, + * // "requireHtml5": false, + * // "requireMraid": false, + * // "requirePingForAttribution": false, + * // "reviewStatus": {}, + * // "skipOffset": {}, + * // "skippable": false, + * // "thirdPartyTag": "my_thirdPartyTag", + * // "thirdPartyUrls": [], + * // "timerEvents": [], + * // "trackerUrls": [], + * // "transcodes": [], + * // "universalAdId": {}, + * // "updateTime": "my_updateTime", + * // "vastTagUrl": "my_vastTagUrl", + * // "vpaid": false + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "insertionOrders": [], - * // "nextPageToken": "my_nextPageToken" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - list( - params: Params$Resource$Advertisers$Insertionorders$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Advertisers$Insertionorders$List, - options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Advertisers$Insertionorders$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Advertisers$Insertionorders$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + * // "additionalDimensions": [], + * // "advertiserId": "my_advertiserId", + * // "appendedTag": "my_appendedTag", + * // "assets": [], + * // "cmPlacementId": "my_cmPlacementId", + * // "cmTrackingAd": {}, + * // "companionCreativeIds": [], + * // "counterEvents": [], + * // "createTime": "my_createTime", + * // "creativeAttributes": [], + * // "creativeId": "my_creativeId", + * // "creativeType": "my_creativeType", + * // "dimensions": {}, + * // "displayName": "my_displayName", + * // "dynamic": false, + * // "entityStatus": "my_entityStatus", + * // "exitEvents": [], + * // "expandOnHover": false, + * // "expandingDirection": "my_expandingDirection", + * // "hostingSource": "my_hostingSource", + * // "html5Video": false, + * // "iasCampaignMonitoring": false, + * // "integrationCode": "my_integrationCode", + * // "jsTrackerUrl": "my_jsTrackerUrl", + * // "lineItemIds": [], + * // "mediaDuration": "my_mediaDuration", + * // "mp3Audio": false, + * // "name": "my_name", + * // "notes": "my_notes", + * // "obaIcon": {}, + * // "oggAudio": false, + * // "progressOffset": {}, + * // "requireHtml5": false, + * // "requireMraid": false, + * // "requirePingForAttribution": false, + * // "reviewStatus": {}, + * // "skipOffset": {}, + * // "skippable": false, + * // "thirdPartyTag": "my_thirdPartyTag", + * // "thirdPartyUrls": [], + * // "timerEvents": [], + * // "trackerUrls": [], + * // "transcodes": [], + * // "universalAdId": {}, + * // "updateTime": "my_updateTime", + * // "vastTagUrl": "my_vastTagUrl", + * // "vpaid": false + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Advertisers$Creatives$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Advertisers$Creatives$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Advertisers$Creatives$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Advertisers$Insertionorders$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Advertisers$Creatives$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + params: Params$Resource$Advertisers$Creatives$Create, + callback: BodyResponseCallback ): void; - list( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Advertisers$Insertionorders$List - | BodyResponseCallback + | Params$Resource$Advertisers$Creatives$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Insertionorders$List; + {}) as Params$Resource$Advertisers$Creatives$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Insertionorders$List; + params = {} as Params$Resource$Advertisers$Creatives$Create; options = {}; } @@ -14073,9 +14649,9 @@ export namespace displayvideo_v4 { options: Object.assign( { url: ( - rootUrl + '/v4/advertisers/{+advertiserId}/insertionOrders' + rootUrl + '/v4/advertisers/{+advertiserId}/creatives' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -14086,17 +14662,17 @@ export namespace displayvideo_v4 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists assigned targeting options of an insertion order across targeting types. + * Deletes a creative. Returns error code `NOT_FOUND` if the creative does not exist. The creative should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, before it can be deleted. A ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request. * @example * ```js * // Before running the sample: @@ -14125,30 +14701,16 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await displayvideo.advertisers.insertionOrders.listAssignedTargetingOptions( - * { - * // Required. The ID of the advertiser the insertion order belongs to. - * advertiserId: '[^/]+', - * // Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` or `TARGETING_TYPE_CHANNEL`: `targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="TARGETING_TYPE_CHANNEL"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. - * filter: 'placeholder-value', - * // Required. The ID of the insertion order to list assigned targeting options for. - * insertionOrderId: '[^/]+', - * // Field by which to sort the list. Acceptable values are: * `targetingType` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`. - * orderBy: 'placeholder-value', - * // Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - * pageSize: 'placeholder-value', - * // A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to `BulkListInsertionOrderAssignedTargetingOptions` method. If not specified, the first page of results will be returned. - * pageToken: 'placeholder-value', - * }, - * ); + * const res = await displayvideo.advertisers.creatives.delete({ + * // The ID of the advertiser this creative belongs to. + * advertiserId: '[^/]+', + * // The ID of the creative to be deleted. + * creativeId: '[^/]+', + * }); * console.log(res.data); * * // Example response - * // { - * // "assignedTargetingOptions": [], - * // "nextPageToken": "my_nextPageToken" - * // } + * // {} * } * * main().catch(e => { @@ -14163,62 +14725,53 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listAssignedTargetingOptions( - params: Params$Resource$Advertisers$Insertionorders$Listassignedtargetingoptions, + delete( + params: Params$Resource$Advertisers$Creatives$Delete, options: StreamMethodOptions ): Promise>; - listAssignedTargetingOptions( - params?: Params$Resource$Advertisers$Insertionorders$Listassignedtargetingoptions, + delete( + params?: Params$Resource$Advertisers$Creatives$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - listAssignedTargetingOptions( - params: Params$Resource$Advertisers$Insertionorders$Listassignedtargetingoptions, + ): Promise>; + delete( + params: Params$Resource$Advertisers$Creatives$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listAssignedTargetingOptions( - params: Params$Resource$Advertisers$Insertionorders$Listassignedtargetingoptions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - listAssignedTargetingOptions( - params: Params$Resource$Advertisers$Insertionorders$Listassignedtargetingoptions, - callback: BodyResponseCallback + delete( + params: Params$Resource$Advertisers$Creatives$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listAssignedTargetingOptions( - callback: BodyResponseCallback + delete( + params: Params$Resource$Advertisers$Creatives$Delete, + callback: BodyResponseCallback ): void; - listAssignedTargetingOptions( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Advertisers$Insertionorders$Listassignedtargetingoptions - | BodyResponseCallback + | Params$Resource$Advertisers$Creatives$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Insertionorders$Listassignedtargetingoptions; + {}) as Params$Resource$Advertisers$Creatives$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Advertisers$Insertionorders$Listassignedtargetingoptions; + params = {} as Params$Resource$Advertisers$Creatives$Delete; options = {}; } @@ -14233,32 +14786,30 @@ export namespace displayvideo_v4 { { url: ( rootUrl + - '/v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}:listAssignedTargetingOptions' + '/v4/advertisers/{+advertiserId}/creatives/{+creativeId}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['advertiserId', 'insertionOrderId'], - pathParams: ['advertiserId', 'insertionOrderId'], + requiredParams: ['advertiserId', 'creativeId'], + pathParams: ['advertiserId', 'creativeId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates an existing insertion order. Returns the updated insertion order if successful. + * Gets a creative. * @example * ```js * // Before running the sample: @@ -14287,59 +14838,63 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.insertionOrders.patch({ - * // Output only. The unique ID of the advertiser the insertion order belongs to. + * const res = await displayvideo.advertisers.creatives.get({ + * // Required. The ID of the advertiser this creative belongs to. * advertiserId: '[^/]+', - * // Output only. The unique ID of the insertion order. Assigned by the system. - * insertionOrderId: '[^/]+', - * // Required. The mask to control which fields to update. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "advertiserId": "my_advertiserId", - * // "bidStrategy": {}, - * // "budget": {}, - * // "campaignId": "my_campaignId", - * // "displayName": "my_displayName", - * // "entityStatus": "my_entityStatus", - * // "frequencyCap": {}, - * // "insertionOrderId": "my_insertionOrderId", - * // "insertionOrderType": "my_insertionOrderType", - * // "integrationDetails": {}, - * // "kpi": {}, - * // "name": "my_name", - * // "optimizationObjective": "my_optimizationObjective", - * // "pacing": {}, - * // "partnerCosts": [], - * // "reservationType": "my_reservationType", - * // "updateTime": "my_updateTime" - * // } - * }, + * // Required. The ID of the creative to fetch. + * creativeId: '[^/]+', * }); * console.log(res.data); * * // Example response * // { + * // "additionalDimensions": [], * // "advertiserId": "my_advertiserId", - * // "bidStrategy": {}, - * // "budget": {}, - * // "campaignId": "my_campaignId", - * // "displayName": "my_displayName", - * // "entityStatus": "my_entityStatus", - * // "frequencyCap": {}, - * // "insertionOrderId": "my_insertionOrderId", - * // "insertionOrderType": "my_insertionOrderType", - * // "integrationDetails": {}, - * // "kpi": {}, + * // "appendedTag": "my_appendedTag", + * // "assets": [], + * // "cmPlacementId": "my_cmPlacementId", + * // "cmTrackingAd": {}, + * // "companionCreativeIds": [], + * // "counterEvents": [], + * // "createTime": "my_createTime", + * // "creativeAttributes": [], + * // "creativeId": "my_creativeId", + * // "creativeType": "my_creativeType", + * // "dimensions": {}, + * // "displayName": "my_displayName", + * // "dynamic": false, + * // "entityStatus": "my_entityStatus", + * // "exitEvents": [], + * // "expandOnHover": false, + * // "expandingDirection": "my_expandingDirection", + * // "hostingSource": "my_hostingSource", + * // "html5Video": false, + * // "iasCampaignMonitoring": false, + * // "integrationCode": "my_integrationCode", + * // "jsTrackerUrl": "my_jsTrackerUrl", + * // "lineItemIds": [], + * // "mediaDuration": "my_mediaDuration", + * // "mp3Audio": false, * // "name": "my_name", - * // "optimizationObjective": "my_optimizationObjective", - * // "pacing": {}, - * // "partnerCosts": [], - * // "reservationType": "my_reservationType", - * // "updateTime": "my_updateTime" + * // "notes": "my_notes", + * // "obaIcon": {}, + * // "oggAudio": false, + * // "progressOffset": {}, + * // "requireHtml5": false, + * // "requireMraid": false, + * // "requirePingForAttribution": false, + * // "reviewStatus": {}, + * // "skipOffset": {}, + * // "skippable": false, + * // "thirdPartyTag": "my_thirdPartyTag", + * // "thirdPartyUrls": [], + * // "timerEvents": [], + * // "trackerUrls": [], + * // "transcodes": [], + * // "universalAdId": {}, + * // "updateTime": "my_updateTime", + * // "vastTagUrl": "my_vastTagUrl", + * // "vpaid": false * // } * } * @@ -14355,53 +14910,53 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Advertisers$Insertionorders$Patch, + get( + params: Params$Resource$Advertisers$Creatives$Get, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Advertisers$Insertionorders$Patch, + get( + params?: Params$Resource$Advertisers$Creatives$Get, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Advertisers$Insertionorders$Patch, + ): Promise>; + get( + params: Params$Resource$Advertisers$Creatives$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Advertisers$Insertionorders$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Advertisers$Creatives$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Advertisers$Insertionorders$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Advertisers$Creatives$Get, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Advertisers$Insertionorders$Patch - | BodyResponseCallback + | Params$Resource$Advertisers$Creatives$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Insertionorders$Patch; + {}) as Params$Resource$Advertisers$Creatives$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Insertionorders$Patch; + params = {} as Params$Resource$Advertisers$Creatives$Get; options = {}; } @@ -14416,154 +14971,30 @@ export namespace displayvideo_v4 { { url: ( rootUrl + - '/v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}' + '/v4/advertisers/{+advertiserId}/creatives/{+creativeId}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['advertiserId', 'insertionOrderId'], - pathParams: ['advertiserId', 'insertionOrderId'], + requiredParams: ['advertiserId', 'creativeId'], + pathParams: ['advertiserId', 'creativeId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Advertisers$Insertionorders$Create - extends StandardParameters { - /** - * Output only. The unique ID of the advertiser the insertion order belongs to. - */ - advertiserId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$InsertionOrder; - } - export interface Params$Resource$Advertisers$Insertionorders$Delete - extends StandardParameters { - /** - * The ID of the advertiser this insertion order belongs to. - */ - advertiserId?: string; - /** - * The ID of the insertion order to delete. - */ - insertionOrderId?: string; - } - export interface Params$Resource$Advertisers$Insertionorders$Get - extends StandardParameters { - /** - * Required. The ID of the advertiser this insertion order belongs to. - */ - advertiserId?: string; - /** - * Required. The ID of the insertion order to fetch. - */ - insertionOrderId?: string; - } - export interface Params$Resource$Advertisers$Insertionorders$List - extends StandardParameters { - /** - * Required. The ID of the advertiser to list insertion orders for. - */ - advertiserId?: string; - /** - * Allows filtering by insertion order fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All insertion orders under a campaign: `campaignId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")` * All insertion orders with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All insertion orders with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. - */ - filter?: string; - /** - * Field by which to sort the list. Acceptable values are: * "displayName" (default) * "entityStatus" * "updateTime" The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. - */ - orderBy?: string; - /** - * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - */ - pageSize?: number; - /** - * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInsertionOrders` method. If not specified, the first page of results will be returned. - */ - pageToken?: string; - } - export interface Params$Resource$Advertisers$Insertionorders$Listassignedtargetingoptions - extends StandardParameters { - /** - * Required. The ID of the advertiser the insertion order belongs to. - */ - advertiserId?: string; - /** - * Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` or `TARGETING_TYPE_CHANNEL`: `targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="TARGETING_TYPE_CHANNEL"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. - */ - filter?: string; - /** - * Required. The ID of the insertion order to list assigned targeting options for. - */ - insertionOrderId?: string; - /** - * Field by which to sort the list. Acceptable values are: * `targetingType` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`. - */ - orderBy?: string; - /** - * Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - */ - pageSize?: number; - /** - * A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to `BulkListInsertionOrderAssignedTargetingOptions` method. If not specified, the first page of results will be returned. - */ - pageToken?: string; - } - export interface Params$Resource$Advertisers$Insertionorders$Patch - extends StandardParameters { - /** - * Output only. The unique ID of the advertiser the insertion order belongs to. - */ - advertiserId?: string; - /** - * Output only. The unique ID of the insertion order. Assigned by the system. - */ - insertionOrderId?: string; - /** - * Required. The mask to control which fields to update. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$InsertionOrder; - } - - export class Resource$Advertisers$Insertionorders$Targetingtypes { - context: APIRequestContext; - assignedTargetingOptions: Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions; - constructor(context: APIRequestContext) { - this.context = context; - this.assignedTargetingOptions = - new Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions( - this.context - ); - } - } - - export class Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Assigns a targeting option to an insertion order. Returns the assigned targeting option if successful. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY` + * Lists creatives in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, creatives with `ENTITY_STATUS_ARCHIVED` will not be included in the results. * @example * ```js * // Before running the sample: @@ -14592,136 +15023,24 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await displayvideo.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.create( - * { - * // Required. The ID of the advertiser the insertion order belongs to. - * advertiserId: '[^/]+', - * // Required. The ID of the insertion order the assigned targeting option will belong to. - * insertionOrderId: '[^/]+', - * // Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY` - * targetingType: '[^/]+', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "ageRangeDetails": {}, - * // "appCategoryDetails": {}, - * // "appDetails": {}, - * // "assignedTargetingOptionId": "my_assignedTargetingOptionId", - * // "assignedTargetingOptionIdAlias": "my_assignedTargetingOptionIdAlias", - * // "audienceGroupDetails": {}, - * // "audioContentTypeDetails": {}, - * // "authorizedSellerStatusDetails": {}, - * // "browserDetails": {}, - * // "businessChainDetails": {}, - * // "carrierAndIspDetails": {}, - * // "categoryDetails": {}, - * // "channelDetails": {}, - * // "contentDurationDetails": {}, - * // "contentGenreDetails": {}, - * // "contentInstreamPositionDetails": {}, - * // "contentOutstreamPositionDetails": {}, - * // "contentStreamTypeDetails": {}, - * // "contentThemeExclusionDetails": {}, - * // "dayAndTimeDetails": {}, - * // "deviceMakeModelDetails": {}, - * // "deviceTypeDetails": {}, - * // "digitalContentLabelExclusionDetails": {}, - * // "environmentDetails": {}, - * // "exchangeDetails": {}, - * // "genderDetails": {}, - * // "geoRegionDetails": {}, - * // "householdIncomeDetails": {}, - * // "inheritance": "my_inheritance", - * // "inventorySourceDetails": {}, - * // "inventorySourceGroupDetails": {}, - * // "keywordDetails": {}, - * // "languageDetails": {}, - * // "name": "my_name", - * // "nativeContentPositionDetails": {}, - * // "negativeKeywordListDetails": {}, - * // "omidDetails": {}, - * // "onScreenPositionDetails": {}, - * // "operatingSystemDetails": {}, - * // "parentalStatusDetails": {}, - * // "poiDetails": {}, - * // "proximityLocationListDetails": {}, - * // "regionalLocationListDetails": {}, - * // "sensitiveCategoryExclusionDetails": {}, - * // "sessionPositionDetails": {}, - * // "subExchangeDetails": {}, - * // "targetingType": "my_targetingType", - * // "thirdPartyVerifierDetails": {}, - * // "urlDetails": {}, - * // "userRewardedContentDetails": {}, - * // "videoPlayerSizeDetails": {}, - * // "viewabilityDetails": {}, - * // "youtubeChannelDetails": {}, - * // "youtubeVideoDetails": {} - * // } - * }, - * }, - * ); + * const res = await displayvideo.advertisers.creatives.list({ + * // Required. The ID of the advertiser to list creatives for. + * advertiserId: '[^/]+', + * // Allows filtering by creative fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * The `lineItemIds` field must use the `HAS (:)` operator. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. * For `entityStatus`, `minDuration`, `maxDuration`, `updateTime`, and `dynamic` fields, there may be at most one restriction. Supported Fields: * `approvalStatus` * `creativeId` * `creativeType` * `dimensions` (input in the form of `{width\}x{height\}`) * `dynamic` * `entityStatus` * `exchangeReviewStatus` (input in the form of `{exchange\}-{reviewStatus\}`) * `lineItemIds` * `maxDuration` (input in the form of `{duration\}s`. Only seconds are supported) * `minDuration` (input in the form of `{duration\}s`. Only seconds are supported) * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Notes: * For `updateTime`, a creative resource's field value reflects the last time that a creative has been updated, which includes updates made by the system (e.g. creative review updates). Examples: * All native creatives: `creativeType="CREATIVE_TYPE_NATIVE"` * All active creatives with 300x400 or 50x100 dimensions: `entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100")` * All dynamic creatives that are approved by AdX or AppNexus, with a minimum duration of 5 seconds and 200ms: `dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")` * All video creatives that are associated with line item ID 1 or 2: `creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2)` * Find creatives by multiple creative IDs: `creativeId=1 OR creativeId=2` * All creatives with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + * filter: 'placeholder-value', + * // Field by which to sort the list. Acceptable values are: * `creativeId` (default) * `createTime` * `mediaDuration` * `dimensions` (sorts by width first, then by height) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `createTime desc`. + * orderBy: 'placeholder-value', + * // Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * pageSize: 'placeholder-value', + * // A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCreatives` method. If not specified, the first page of results will be returned. + * pageToken: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "ageRangeDetails": {}, - * // "appCategoryDetails": {}, - * // "appDetails": {}, - * // "assignedTargetingOptionId": "my_assignedTargetingOptionId", - * // "assignedTargetingOptionIdAlias": "my_assignedTargetingOptionIdAlias", - * // "audienceGroupDetails": {}, - * // "audioContentTypeDetails": {}, - * // "authorizedSellerStatusDetails": {}, - * // "browserDetails": {}, - * // "businessChainDetails": {}, - * // "carrierAndIspDetails": {}, - * // "categoryDetails": {}, - * // "channelDetails": {}, - * // "contentDurationDetails": {}, - * // "contentGenreDetails": {}, - * // "contentInstreamPositionDetails": {}, - * // "contentOutstreamPositionDetails": {}, - * // "contentStreamTypeDetails": {}, - * // "contentThemeExclusionDetails": {}, - * // "dayAndTimeDetails": {}, - * // "deviceMakeModelDetails": {}, - * // "deviceTypeDetails": {}, - * // "digitalContentLabelExclusionDetails": {}, - * // "environmentDetails": {}, - * // "exchangeDetails": {}, - * // "genderDetails": {}, - * // "geoRegionDetails": {}, - * // "householdIncomeDetails": {}, - * // "inheritance": "my_inheritance", - * // "inventorySourceDetails": {}, - * // "inventorySourceGroupDetails": {}, - * // "keywordDetails": {}, - * // "languageDetails": {}, - * // "name": "my_name", - * // "nativeContentPositionDetails": {}, - * // "negativeKeywordListDetails": {}, - * // "omidDetails": {}, - * // "onScreenPositionDetails": {}, - * // "operatingSystemDetails": {}, - * // "parentalStatusDetails": {}, - * // "poiDetails": {}, - * // "proximityLocationListDetails": {}, - * // "regionalLocationListDetails": {}, - * // "sensitiveCategoryExclusionDetails": {}, - * // "sessionPositionDetails": {}, - * // "subExchangeDetails": {}, - * // "targetingType": "my_targetingType", - * // "thirdPartyVerifierDetails": {}, - * // "urlDetails": {}, - * // "userRewardedContentDetails": {}, - * // "videoPlayerSizeDetails": {}, - * // "viewabilityDetails": {}, - * // "youtubeChannelDetails": {}, - * // "youtubeVideoDetails": {} + * // "creatives": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -14737,58 +15056,55 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Create, + list( + params: Params$Resource$Advertisers$Creatives$List, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Create, + list( + params?: Params$Resource$Advertisers$Creatives$List, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Create, + ): Promise>; + list( + params: Params$Resource$Advertisers$Creatives$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Create, + list( + params: Params$Resource$Advertisers$Creatives$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Create, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + params: Params$Resource$Advertisers$Creatives$List, + callback: BodyResponseCallback ): void; - create( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Create - | BodyResponseCallback + | Params$Resource$Advertisers$Creatives$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Create; + {}) as Params$Resource$Advertisers$Creatives$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Create; + params = {} as Params$Resource$Advertisers$Creatives$List; options = {}; } @@ -14802,31 +15118,30 @@ export namespace displayvideo_v4 { options: Object.assign( { url: ( - rootUrl + - '/v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions' + rootUrl + '/v4/advertisers/{+advertiserId}/creatives' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['advertiserId', 'insertionOrderId', 'targetingType'], - pathParams: ['advertiserId', 'insertionOrderId', 'targetingType'], + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes an assigned targeting option from an insertion order. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY` + * Updates an existing creative. Returns the updated creative if successful. A ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request. * @example * ```js * // Before running the sample: @@ -14855,85 +15170,181 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await displayvideo.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.delete( - * { - * // Required. The ID of the advertiser the insertion order belongs to. - * advertiserId: '[^/]+', - * // Required. The ID of the assigned targeting option to delete. - * assignedTargetingOptionId: '[^/]+', - * // Required. The ID of the insertion order the assigned targeting option belongs to. - * insertionOrderId: '[^/]+', - * // Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY` - * targetingType: '[^/]+', - * }, - * ); - * console.log(res.data); - * - * // Example response - * // {} - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` + * const res = await displayvideo.advertisers.creatives.patch({ + * // Output only. The unique ID of the advertiser the creative belongs to. + * advertiserId: '[^/]+', + * // Output only. The unique ID of the creative. Assigned by the system. + * creativeId: '[^/]+', + * // Required. The mask to control which fields to update. + * updateMask: 'placeholder-value', * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - delete( - params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Delete, - options: StreamMethodOptions - ): Promise>; - delete( - params?: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Delete, - options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "additionalDimensions": [], + * // "advertiserId": "my_advertiserId", + * // "appendedTag": "my_appendedTag", + * // "assets": [], + * // "cmPlacementId": "my_cmPlacementId", + * // "cmTrackingAd": {}, + * // "companionCreativeIds": [], + * // "counterEvents": [], + * // "createTime": "my_createTime", + * // "creativeAttributes": [], + * // "creativeId": "my_creativeId", + * // "creativeType": "my_creativeType", + * // "dimensions": {}, + * // "displayName": "my_displayName", + * // "dynamic": false, + * // "entityStatus": "my_entityStatus", + * // "exitEvents": [], + * // "expandOnHover": false, + * // "expandingDirection": "my_expandingDirection", + * // "hostingSource": "my_hostingSource", + * // "html5Video": false, + * // "iasCampaignMonitoring": false, + * // "integrationCode": "my_integrationCode", + * // "jsTrackerUrl": "my_jsTrackerUrl", + * // "lineItemIds": [], + * // "mediaDuration": "my_mediaDuration", + * // "mp3Audio": false, + * // "name": "my_name", + * // "notes": "my_notes", + * // "obaIcon": {}, + * // "oggAudio": false, + * // "progressOffset": {}, + * // "requireHtml5": false, + * // "requireMraid": false, + * // "requirePingForAttribution": false, + * // "reviewStatus": {}, + * // "skipOffset": {}, + * // "skippable": false, + * // "thirdPartyTag": "my_thirdPartyTag", + * // "thirdPartyUrls": [], + * // "timerEvents": [], + * // "trackerUrls": [], + * // "transcodes": [], + * // "universalAdId": {}, + * // "updateTime": "my_updateTime", + * // "vastTagUrl": "my_vastTagUrl", + * // "vpaid": false + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "additionalDimensions": [], + * // "advertiserId": "my_advertiserId", + * // "appendedTag": "my_appendedTag", + * // "assets": [], + * // "cmPlacementId": "my_cmPlacementId", + * // "cmTrackingAd": {}, + * // "companionCreativeIds": [], + * // "counterEvents": [], + * // "createTime": "my_createTime", + * // "creativeAttributes": [], + * // "creativeId": "my_creativeId", + * // "creativeType": "my_creativeType", + * // "dimensions": {}, + * // "displayName": "my_displayName", + * // "dynamic": false, + * // "entityStatus": "my_entityStatus", + * // "exitEvents": [], + * // "expandOnHover": false, + * // "expandingDirection": "my_expandingDirection", + * // "hostingSource": "my_hostingSource", + * // "html5Video": false, + * // "iasCampaignMonitoring": false, + * // "integrationCode": "my_integrationCode", + * // "jsTrackerUrl": "my_jsTrackerUrl", + * // "lineItemIds": [], + * // "mediaDuration": "my_mediaDuration", + * // "mp3Audio": false, + * // "name": "my_name", + * // "notes": "my_notes", + * // "obaIcon": {}, + * // "oggAudio": false, + * // "progressOffset": {}, + * // "requireHtml5": false, + * // "requireMraid": false, + * // "requirePingForAttribution": false, + * // "reviewStatus": {}, + * // "skipOffset": {}, + * // "skippable": false, + * // "thirdPartyTag": "my_thirdPartyTag", + * // "thirdPartyUrls": [], + * // "timerEvents": [], + * // "trackerUrls": [], + * // "transcodes": [], + * // "universalAdId": {}, + * // "updateTime": "my_updateTime", + * // "vastTagUrl": "my_vastTagUrl", + * // "vpaid": false + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Advertisers$Creatives$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Advertisers$Creatives$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Advertisers$Creatives$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Creatives$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Creatives$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Advertisers$Creatives$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Delete; + {}) as Params$Resource$Advertisers$Creatives$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Delete; + params = {} as Params$Resource$Advertisers$Creatives$Patch; options = {}; } @@ -14948,139 +15359,195 @@ export namespace displayvideo_v4 { { url: ( rootUrl + - '/v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' + '/v4/advertisers/{+advertiserId}/creatives/{+creativeId}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: [ - 'advertiserId', - 'insertionOrderId', - 'targetingType', - 'assignedTargetingOptionId', - ], - pathParams: [ - 'advertiserId', - 'assignedTargetingOptionId', - 'insertionOrderId', - 'targetingType', - ], + requiredParams: ['advertiserId', 'creativeId'], + pathParams: ['advertiserId', 'creativeId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Advertisers$Creatives$Create + extends StandardParameters { /** - * Gets a single targeting option assigned to an insertion order. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const displayvideo = google.displayvideo('v4'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/display-video'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await displayvideo.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.get( - * { - * // Required. The ID of the advertiser the insertion order belongs to. - * advertiserId: '[^/]+', - * // Required. An identifier unique to the targeting type in this insertion order that identifies the assigned targeting option being requested. - * assignedTargetingOptionId: '[^/]+', - * // Required. The ID of the insertion order the assigned targeting option belongs to. - * insertionOrderId: '[^/]+', - * // Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` - * targetingType: '[^/]+', - * }, - * ); - * console.log(res.data); - * - * // Example response - * // { - * // "ageRangeDetails": {}, - * // "appCategoryDetails": {}, - * // "appDetails": {}, - * // "assignedTargetingOptionId": "my_assignedTargetingOptionId", - * // "assignedTargetingOptionIdAlias": "my_assignedTargetingOptionIdAlias", - * // "audienceGroupDetails": {}, - * // "audioContentTypeDetails": {}, - * // "authorizedSellerStatusDetails": {}, - * // "browserDetails": {}, - * // "businessChainDetails": {}, - * // "carrierAndIspDetails": {}, - * // "categoryDetails": {}, - * // "channelDetails": {}, - * // "contentDurationDetails": {}, - * // "contentGenreDetails": {}, - * // "contentInstreamPositionDetails": {}, - * // "contentOutstreamPositionDetails": {}, - * // "contentStreamTypeDetails": {}, - * // "contentThemeExclusionDetails": {}, - * // "dayAndTimeDetails": {}, - * // "deviceMakeModelDetails": {}, - * // "deviceTypeDetails": {}, - * // "digitalContentLabelExclusionDetails": {}, - * // "environmentDetails": {}, - * // "exchangeDetails": {}, - * // "genderDetails": {}, - * // "geoRegionDetails": {}, - * // "householdIncomeDetails": {}, - * // "inheritance": "my_inheritance", - * // "inventorySourceDetails": {}, - * // "inventorySourceGroupDetails": {}, - * // "keywordDetails": {}, - * // "languageDetails": {}, + * Output only. The unique ID of the advertiser the creative belongs to. + */ + advertiserId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Creative; + } + export interface Params$Resource$Advertisers$Creatives$Delete + extends StandardParameters { + /** + * The ID of the advertiser this creative belongs to. + */ + advertiserId?: string; + /** + * The ID of the creative to be deleted. + */ + creativeId?: string; + } + export interface Params$Resource$Advertisers$Creatives$Get + extends StandardParameters { + /** + * Required. The ID of the advertiser this creative belongs to. + */ + advertiserId?: string; + /** + * Required. The ID of the creative to fetch. + */ + creativeId?: string; + } + export interface Params$Resource$Advertisers$Creatives$List + extends StandardParameters { + /** + * Required. The ID of the advertiser to list creatives for. + */ + advertiserId?: string; + /** + * Allows filtering by creative fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * The `lineItemIds` field must use the `HAS (:)` operator. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. * For `entityStatus`, `minDuration`, `maxDuration`, `updateTime`, and `dynamic` fields, there may be at most one restriction. Supported Fields: * `approvalStatus` * `creativeId` * `creativeType` * `dimensions` (input in the form of `{width\}x{height\}`) * `dynamic` * `entityStatus` * `exchangeReviewStatus` (input in the form of `{exchange\}-{reviewStatus\}`) * `lineItemIds` * `maxDuration` (input in the form of `{duration\}s`. Only seconds are supported) * `minDuration` (input in the form of `{duration\}s`. Only seconds are supported) * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Notes: * For `updateTime`, a creative resource's field value reflects the last time that a creative has been updated, which includes updates made by the system (e.g. creative review updates). Examples: * All native creatives: `creativeType="CREATIVE_TYPE_NATIVE"` * All active creatives with 300x400 or 50x100 dimensions: `entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100")` * All dynamic creatives that are approved by AdX or AppNexus, with a minimum duration of 5 seconds and 200ms: `dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")` * All video creatives that are associated with line item ID 1 or 2: `creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2)` * Find creatives by multiple creative IDs: `creativeId=1 OR creativeId=2` * All creatives with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `creativeId` (default) * `createTime` * `mediaDuration` * `dimensions` (sorts by width first, then by height) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `createTime desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCreatives` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Creatives$Patch + extends StandardParameters { + /** + * Output only. The unique ID of the advertiser the creative belongs to. + */ + advertiserId?: string; + /** + * Output only. The unique ID of the creative. Assigned by the system. + */ + creativeId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Creative; + } + + export class Resource$Advertisers$Insertionorders { + context: APIRequestContext; + targetingTypes: Resource$Advertisers$Insertionorders$Targetingtypes; + constructor(context: APIRequestContext) { + this.context = context; + this.targetingTypes = + new Resource$Advertisers$Insertionorders$Targetingtypes(this.context); + } + + /** + * Creates a new insertion order. Returns the newly created insertion order if successful. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v4'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await displayvideo.advertisers.insertionOrders.create({ + * // Output only. The unique ID of the advertiser the insertion order belongs to. + * advertiserId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "advertiserId": "my_advertiserId", + * // "bidStrategy": {}, + * // "budget": {}, + * // "campaignId": "my_campaignId", + * // "displayName": "my_displayName", + * // "entityStatus": "my_entityStatus", + * // "frequencyCap": {}, + * // "insertionOrderId": "my_insertionOrderId", + * // "insertionOrderType": "my_insertionOrderType", + * // "integrationDetails": {}, + * // "kpi": {}, + * // "name": "my_name", + * // "optimizationObjective": "my_optimizationObjective", + * // "pacing": {}, + * // "partnerCosts": [], + * // "reservationType": "my_reservationType", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "advertiserId": "my_advertiserId", + * // "bidStrategy": {}, + * // "budget": {}, + * // "campaignId": "my_campaignId", + * // "displayName": "my_displayName", + * // "entityStatus": "my_entityStatus", + * // "frequencyCap": {}, + * // "insertionOrderId": "my_insertionOrderId", + * // "insertionOrderType": "my_insertionOrderType", + * // "integrationDetails": {}, + * // "kpi": {}, * // "name": "my_name", - * // "nativeContentPositionDetails": {}, - * // "negativeKeywordListDetails": {}, - * // "omidDetails": {}, - * // "onScreenPositionDetails": {}, - * // "operatingSystemDetails": {}, - * // "parentalStatusDetails": {}, - * // "poiDetails": {}, - * // "proximityLocationListDetails": {}, - * // "regionalLocationListDetails": {}, - * // "sensitiveCategoryExclusionDetails": {}, - * // "sessionPositionDetails": {}, - * // "subExchangeDetails": {}, - * // "targetingType": "my_targetingType", - * // "thirdPartyVerifierDetails": {}, - * // "urlDetails": {}, - * // "userRewardedContentDetails": {}, - * // "videoPlayerSizeDetails": {}, - * // "viewabilityDetails": {}, - * // "youtubeChannelDetails": {}, - * // "youtubeVideoDetails": {} + * // "optimizationObjective": "my_optimizationObjective", + * // "pacing": {}, + * // "partnerCosts": [], + * // "reservationType": "my_reservationType", + * // "updateTime": "my_updateTime" * // } * } * @@ -15096,56 +15563,53 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Get, + create( + params: Params$Resource$Advertisers$Insertionorders$Create, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Get, + create( + params?: Params$Resource$Advertisers$Insertionorders$Create, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Get, + ): Promise>; + create( + params: Params$Resource$Advertisers$Insertionorders$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Advertisers$Insertionorders$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Advertisers$Insertionorders$Create, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Get - | BodyResponseCallback + | Params$Resource$Advertisers$Insertionorders$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Get; + {}) as Params$Resource$Advertisers$Insertionorders$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Get; + params = {} as Params$Resource$Advertisers$Insertionorders$Create; options = {}; } @@ -15159,41 +15623,30 @@ export namespace displayvideo_v4 { options: Object.assign( { url: ( - rootUrl + - '/v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' + rootUrl + '/v4/advertisers/{+advertiserId}/insertionOrders' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: [ - 'advertiserId', - 'insertionOrderId', - 'targetingType', - 'assignedTargetingOptionId', - ], - pathParams: [ - 'advertiserId', - 'assignedTargetingOptionId', - 'insertionOrderId', - 'targetingType', - ], + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists the targeting options assigned to an insertion order. + * Deletes an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist. The insertion order should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. * @example * ```js * // Before running the sample: @@ -15222,32 +15675,16 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await displayvideo.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.list( - * { - * // Required. The ID of the advertiser the insertion order belongs to. - * advertiserId: '[^/]+', - * // Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. - * filter: 'placeholder-value', - * // Required. The ID of the insertion order to list assigned targeting options for. - * insertionOrderId: '[^/]+', - * // Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`. - * orderBy: 'placeholder-value', - * // Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInsertionOrderAssignedTargetingOptions` method. If not specified, the first page of results will be returned. - * pageToken: 'placeholder-value', - * // Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` - * targetingType: '[^/]+', - * }, - * ); + * const res = await displayvideo.advertisers.insertionOrders.delete({ + * // The ID of the advertiser this insertion order belongs to. + * advertiserId: '[^/]+', + * // The ID of the insertion order to delete. + * insertionOrderId: '[^/]+', + * }); * console.log(res.data); * * // Example response - * // { - * // "assignedTargetingOptions": [], - * // "nextPageToken": "my_nextPageToken" - * // } + * // {} * } * * main().catch(e => { @@ -15262,62 +15699,53 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$List, + delete( + params: Params$Resource$Advertisers$Insertionorders$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$List, + delete( + params?: Params$Resource$Advertisers$Insertionorders$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$List, + ): Promise>; + delete( + params: Params$Resource$Advertisers$Insertionorders$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Advertisers$Insertionorders$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Advertisers$Insertionorders$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$List - | BodyResponseCallback + | Params$Resource$Advertisers$Insertionorders$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$List; + {}) as Params$Resource$Advertisers$Insertionorders$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$List; + params = {} as Params$Resource$Advertisers$Insertionorders$Delete; options = {}; } @@ -15332,129 +15760,30 @@ export namespace displayvideo_v4 { { url: ( rootUrl + - '/v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions' + '/v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['advertiserId', 'insertionOrderId', 'targetingType'], - pathParams: ['advertiserId', 'insertionOrderId', 'targetingType'], + requiredParams: ['advertiserId', 'insertionOrderId'], + pathParams: ['advertiserId', 'insertionOrderId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Create - extends StandardParameters { - /** - * Required. The ID of the advertiser the insertion order belongs to. - */ - advertiserId?: string; - /** - * Required. The ID of the insertion order the assigned targeting option will belong to. - */ - insertionOrderId?: string; - /** - * Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY` - */ - targetingType?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$AssignedTargetingOption; - } - export interface Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Delete - extends StandardParameters { - /** - * Required. The ID of the advertiser the insertion order belongs to. - */ - advertiserId?: string; - /** - * Required. The ID of the assigned targeting option to delete. - */ - assignedTargetingOptionId?: string; - /** - * Required. The ID of the insertion order the assigned targeting option belongs to. - */ - insertionOrderId?: string; - /** - * Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY` - */ - targetingType?: string; - } - export interface Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Get - extends StandardParameters { - /** - * Required. The ID of the advertiser the insertion order belongs to. - */ - advertiserId?: string; - /** - * Required. An identifier unique to the targeting type in this insertion order that identifies the assigned targeting option being requested. - */ - assignedTargetingOptionId?: string; - /** - * Required. The ID of the insertion order the assigned targeting option belongs to. - */ - insertionOrderId?: string; - /** - * Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` - */ - targetingType?: string; - } - export interface Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$List - extends StandardParameters { - /** - * Required. The ID of the advertiser the insertion order belongs to. - */ - advertiserId?: string; - /** - * Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. - */ - filter?: string; - /** - * Required. The ID of the insertion order to list assigned targeting options for. - */ - insertionOrderId?: string; - /** - * Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`. - */ - orderBy?: string; - /** - * Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - */ - pageSize?: number; - /** - * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInsertionOrderAssignedTargetingOptions` method. If not specified, the first page of results will be returned. - */ - pageToken?: string; - /** - * Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` - */ - targetingType?: string; - } - - export class Resource$Advertisers$Invoices { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Lists invoices posted for an advertiser in a given month. Invoices generated by billing profiles with a "Partner" invoice level are not retrievable through this method. + * Gets an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist. * @example * ```js * // Before running the sample: @@ -15475,10 +15804,7 @@ export namespace displayvideo_v4 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/display-video', - * 'https://www.googleapis.com/auth/display-video-mediaplanning', - * ], + * scopes: ['https://www.googleapis.com/auth/display-video'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -15486,24 +15812,33 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.invoices.list({ - * // Required. The ID of the advertiser to list invoices for. + * const res = await displayvideo.advertisers.insertionOrders.get({ + * // Required. The ID of the advertiser this insertion order belongs to. * advertiserId: '[^/]+', - * // The month to list the invoices for. If not set, the request will retrieve invoices for the previous month. Must be in the format YYYYMM. - * issueMonth: 'placeholder-value', - * // Select type of invoice to retrieve for Loi Sapin advertisers. Only applicable to Loi Sapin advertisers. Will be ignored otherwise. - * loiSapinInvoiceType: 'placeholder-value', - * // Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInvoices` method. If not specified, the first page of results will be returned. - * pageToken: 'placeholder-value', + * // Required. The ID of the insertion order to fetch. + * insertionOrderId: '[^/]+', * }); * console.log(res.data); * * // Example response * // { - * // "invoices": [], - * // "nextPageToken": "my_nextPageToken" + * // "advertiserId": "my_advertiserId", + * // "bidStrategy": {}, + * // "budget": {}, + * // "campaignId": "my_campaignId", + * // "displayName": "my_displayName", + * // "entityStatus": "my_entityStatus", + * // "frequencyCap": {}, + * // "insertionOrderId": "my_insertionOrderId", + * // "insertionOrderType": "my_insertionOrderType", + * // "integrationDetails": {}, + * // "kpi": {}, + * // "name": "my_name", + * // "optimizationObjective": "my_optimizationObjective", + * // "pacing": {}, + * // "partnerCosts": [], + * // "reservationType": "my_reservationType", + * // "updateTime": "my_updateTime" * // } * } * @@ -15519,55 +15854,53 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Advertisers$Invoices$List, + get( + params: Params$Resource$Advertisers$Insertionorders$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Advertisers$Invoices$List, + get( + params?: Params$Resource$Advertisers$Insertionorders$Get, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Advertisers$Invoices$List, + ): Promise>; + get( + params: Params$Resource$Advertisers$Insertionorders$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Advertisers$Invoices$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Advertisers$Insertionorders$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Advertisers$Invoices$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Advertisers$Insertionorders$Get, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Advertisers$Invoices$List - | BodyResponseCallback + | Params$Resource$Advertisers$Insertionorders$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Invoices$List; + {}) as Params$Resource$Advertisers$Insertionorders$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Invoices$List; + params = {} as Params$Resource$Advertisers$Insertionorders$Get; options = {}; } @@ -15580,32 +15913,32 @@ export namespace displayvideo_v4 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v4/advertisers/{+advertiserId}/invoices').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['advertiserId'], - pathParams: ['advertiserId'], + requiredParams: ['advertiserId', 'insertionOrderId'], + pathParams: ['advertiserId', 'insertionOrderId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Retrieves the invoice currency used by an advertiser in a given month. + * Lists insertion orders in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, insertion orders with `ENTITY_STATUS_ARCHIVED` will not be included in the results. * @example * ```js * // Before running the sample: @@ -15626,10 +15959,7 @@ export namespace displayvideo_v4 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [ - * 'https://www.googleapis.com/auth/display-video', - * 'https://www.googleapis.com/auth/display-video-mediaplanning', - * ], + * scopes: ['https://www.googleapis.com/auth/display-video'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -15637,17 +15967,24 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.invoices.lookupInvoiceCurrency({ - * // Required. The ID of the advertiser to lookup currency for. + * const res = await displayvideo.advertisers.insertionOrders.list({ + * // Required. The ID of the advertiser to list insertion orders for. * advertiserId: '[^/]+', - * // Month for which the currency is needed. If not set, the request will return existing currency settings for the advertiser. Must be in the format YYYYMM. - * invoiceMonth: 'placeholder-value', + * // Allows filtering by insertion order fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All insertion orders under a campaign: `campaignId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")` * All insertion orders with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All insertion orders with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + * filter: 'placeholder-value', + * // Field by which to sort the list. Acceptable values are: * "displayName" (default) * "entityStatus" * "updateTime" The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + * orderBy: 'placeholder-value', + * // Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * pageSize: 'placeholder-value', + * // A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInsertionOrders` method. If not specified, the first page of results will be returned. + * pageToken: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "currencyCode": "my_currencyCode" + * // "insertionOrders": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -15663,58 +16000,57 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - lookupInvoiceCurrency( - params: Params$Resource$Advertisers$Invoices$Lookupinvoicecurrency, + list( + params: Params$Resource$Advertisers$Insertionorders$List, options: StreamMethodOptions ): Promise>; - lookupInvoiceCurrency( - params?: Params$Resource$Advertisers$Invoices$Lookupinvoicecurrency, + list( + params?: Params$Resource$Advertisers$Insertionorders$List, options?: MethodOptions - ): Promise>; - lookupInvoiceCurrency( - params: Params$Resource$Advertisers$Invoices$Lookupinvoicecurrency, + ): Promise>; + list( + params: Params$Resource$Advertisers$Insertionorders$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - lookupInvoiceCurrency( - params: Params$Resource$Advertisers$Invoices$Lookupinvoicecurrency, + list( + params: Params$Resource$Advertisers$Insertionorders$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - lookupInvoiceCurrency( - params: Params$Resource$Advertisers$Invoices$Lookupinvoicecurrency, - callback: BodyResponseCallback + list( + params: Params$Resource$Advertisers$Insertionorders$List, + callback: BodyResponseCallback ): void; - lookupInvoiceCurrency( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - lookupInvoiceCurrency( + list( paramsOrCallback?: - | Params$Resource$Advertisers$Invoices$Lookupinvoicecurrency - | BodyResponseCallback + | Params$Resource$Advertisers$Insertionorders$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Invoices$Lookupinvoicecurrency; + {}) as Params$Resource$Advertisers$Insertionorders$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Advertisers$Invoices$Lookupinvoicecurrency; + params = {} as Params$Resource$Advertisers$Insertionorders$List; options = {}; } @@ -15728,8 +16064,7 @@ export namespace displayvideo_v4 { options: Object.assign( { url: ( - rootUrl + - '/v4/advertisers/{+advertiserId}/invoices:lookupInvoiceCurrency' + rootUrl + '/v4/advertisers/{+advertiserId}/insertionOrders' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -15742,65 +16077,17 @@ export namespace displayvideo_v4 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Advertisers$Invoices$List - extends StandardParameters { - /** - * Required. The ID of the advertiser to list invoices for. - */ - advertiserId?: string; - /** - * The month to list the invoices for. If not set, the request will retrieve invoices for the previous month. Must be in the format YYYYMM. - */ - issueMonth?: string; - /** - * Select type of invoice to retrieve for Loi Sapin advertisers. Only applicable to Loi Sapin advertisers. Will be ignored otherwise. - */ - loiSapinInvoiceType?: string; - /** - * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - */ - pageSize?: number; - /** - * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInvoices` method. If not specified, the first page of results will be returned. - */ - pageToken?: string; - } - export interface Params$Resource$Advertisers$Invoices$Lookupinvoicecurrency - extends StandardParameters { - /** - * Required. The ID of the advertiser to lookup currency for. - */ - advertiserId?: string; - /** - * Month for which the currency is needed. If not set, the request will return existing currency settings for the advertiser. Must be in the format YYYYMM. - */ - invoiceMonth?: string; - } - - export class Resource$Advertisers$Lineitems { - context: APIRequestContext; - targetingTypes: Resource$Advertisers$Lineitems$Targetingtypes; - constructor(context: APIRequestContext) { - this.context = context; - this.targetingTypes = new Resource$Advertisers$Lineitems$Targetingtypes( - this.context - ); - } /** - * Bulk edits targeting options under multiple line items. The operation will delete the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.create_requests. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkUpdate * lineItems.patch * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API. + * Lists assigned targeting options of an insertion order across targeting types. * @example * ```js * // Before running the sample: @@ -15830,27 +16117,28 @@ export namespace displayvideo_v4 { * * // Do the magic * const res = - * await displayvideo.advertisers.lineItems.bulkEditAssignedTargetingOptions({ - * // Required. The ID of the advertiser the line items belong to. - * advertiserId: '[^/]+', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createRequests": [], - * // "deleteRequests": [], - * // "lineItemIds": [] - * // } + * await displayvideo.advertisers.insertionOrders.listAssignedTargetingOptions( + * { + * // Required. The ID of the advertiser the insertion order belongs to. + * advertiserId: '[^/]+', + * // Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` or `TARGETING_TYPE_CHANNEL`: `targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="TARGETING_TYPE_CHANNEL"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + * filter: 'placeholder-value', + * // Required. The ID of the insertion order to list assigned targeting options for. + * insertionOrderId: '[^/]+', + * // Field by which to sort the list. Acceptable values are: * `targetingType` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`. + * orderBy: 'placeholder-value', + * // Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * pageSize: 'placeholder-value', + * // A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to `BulkListInsertionOrderAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + * pageToken: 'placeholder-value', * }, - * }); + * ); * console.log(res.data); * * // Example response * // { - * // "errors": [], - * // "failedLineItemIds": [], - * // "updatedLineItemIds": [] + * // "assignedTargetingOptions": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -15866,62 +16154,62 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - bulkEditAssignedTargetingOptions( - params: Params$Resource$Advertisers$Lineitems$Bulkeditassignedtargetingoptions, + listAssignedTargetingOptions( + params: Params$Resource$Advertisers$Insertionorders$Listassignedtargetingoptions, options: StreamMethodOptions ): Promise>; - bulkEditAssignedTargetingOptions( - params?: Params$Resource$Advertisers$Lineitems$Bulkeditassignedtargetingoptions, + listAssignedTargetingOptions( + params?: Params$Resource$Advertisers$Insertionorders$Listassignedtargetingoptions, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - bulkEditAssignedTargetingOptions( - params: Params$Resource$Advertisers$Lineitems$Bulkeditassignedtargetingoptions, + listAssignedTargetingOptions( + params: Params$Resource$Advertisers$Insertionorders$Listassignedtargetingoptions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - bulkEditAssignedTargetingOptions( - params: Params$Resource$Advertisers$Lineitems$Bulkeditassignedtargetingoptions, + listAssignedTargetingOptions( + params: Params$Resource$Advertisers$Insertionorders$Listassignedtargetingoptions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - bulkEditAssignedTargetingOptions( - params: Params$Resource$Advertisers$Lineitems$Bulkeditassignedtargetingoptions, - callback: BodyResponseCallback + listAssignedTargetingOptions( + params: Params$Resource$Advertisers$Insertionorders$Listassignedtargetingoptions, + callback: BodyResponseCallback ): void; - bulkEditAssignedTargetingOptions( - callback: BodyResponseCallback + listAssignedTargetingOptions( + callback: BodyResponseCallback ): void; - bulkEditAssignedTargetingOptions( + listAssignedTargetingOptions( paramsOrCallback?: - | Params$Resource$Advertisers$Lineitems$Bulkeditassignedtargetingoptions - | BodyResponseCallback + | Params$Resource$Advertisers$Insertionorders$Listassignedtargetingoptions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Lineitems$Bulkeditassignedtargetingoptions; + {}) as Params$Resource$Advertisers$Insertionorders$Listassignedtargetingoptions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Advertisers$Lineitems$Bulkeditassignedtargetingoptions; + {} as Params$Resource$Advertisers$Insertionorders$Listassignedtargetingoptions; options = {}; } @@ -15936,32 +16224,32 @@ export namespace displayvideo_v4 { { url: ( rootUrl + - '/v4/advertisers/{+advertiserId}/lineItems:bulkEditAssignedTargetingOptions' + '/v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}:listAssignedTargetingOptions' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['advertiserId'], - pathParams: ['advertiserId'], + requiredParams: ['advertiserId', 'insertionOrderId'], + pathParams: ['advertiserId', 'insertionOrderId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists assigned targeting options for multiple line items across targeting types. + * Updates an existing insertion order. Returns the updated insertion order if successful. * @example * ```js * // Before running the sample: @@ -15990,27 +16278,59 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await displayvideo.advertisers.lineItems.bulkListAssignedTargetingOptions({ - * // Required. The ID of the advertiser the line items belongs to. - * advertiserId: '[^/]+', - * // Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR` on the same field. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` or `TARGETING_TYPE_CHANNEL`: `targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="TARGETING_TYPE_CHANNEL"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. - * filter: 'placeholder-value', - * // Required. The IDs of the line items to list assigned targeting options for. - * lineItemIds: 'placeholder-value', - * // Field by which to sort the list. Acceptable values are: * `lineItemId` (default) * `assignedTargetingOption.targetingType` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`. - * orderBy: 'placeholder-value', - * // Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - * pageSize: 'placeholder-value', - * // A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to the `BulkListAssignedTargetingOptions` method. If not specified, the first page of results will be returned. - * pageToken: 'placeholder-value', - * }); + * const res = await displayvideo.advertisers.insertionOrders.patch({ + * // Output only. The unique ID of the advertiser the insertion order belongs to. + * advertiserId: '[^/]+', + * // Output only. The unique ID of the insertion order. Assigned by the system. + * insertionOrderId: '[^/]+', + * // Required. The mask to control which fields to update. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "advertiserId": "my_advertiserId", + * // "bidStrategy": {}, + * // "budget": {}, + * // "campaignId": "my_campaignId", + * // "displayName": "my_displayName", + * // "entityStatus": "my_entityStatus", + * // "frequencyCap": {}, + * // "insertionOrderId": "my_insertionOrderId", + * // "insertionOrderType": "my_insertionOrderType", + * // "integrationDetails": {}, + * // "kpi": {}, + * // "name": "my_name", + * // "optimizationObjective": "my_optimizationObjective", + * // "pacing": {}, + * // "partnerCosts": [], + * // "reservationType": "my_reservationType", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "lineItemAssignedTargetingOptions": [], - * // "nextPageToken": "my_nextPageToken" + * // "advertiserId": "my_advertiserId", + * // "bidStrategy": {}, + * // "budget": {}, + * // "campaignId": "my_campaignId", + * // "displayName": "my_displayName", + * // "entityStatus": "my_entityStatus", + * // "frequencyCap": {}, + * // "insertionOrderId": "my_insertionOrderId", + * // "insertionOrderType": "my_insertionOrderType", + * // "integrationDetails": {}, + * // "kpi": {}, + * // "name": "my_name", + * // "optimizationObjective": "my_optimizationObjective", + * // "pacing": {}, + * // "partnerCosts": [], + * // "reservationType": "my_reservationType", + * // "updateTime": "my_updateTime" * // } * } * @@ -16026,62 +16346,53 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - bulkListAssignedTargetingOptions( - params: Params$Resource$Advertisers$Lineitems$Bulklistassignedtargetingoptions, + patch( + params: Params$Resource$Advertisers$Insertionorders$Patch, options: StreamMethodOptions ): Promise>; - bulkListAssignedTargetingOptions( - params?: Params$Resource$Advertisers$Lineitems$Bulklistassignedtargetingoptions, + patch( + params?: Params$Resource$Advertisers$Insertionorders$Patch, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - bulkListAssignedTargetingOptions( - params: Params$Resource$Advertisers$Lineitems$Bulklistassignedtargetingoptions, + ): Promise>; + patch( + params: Params$Resource$Advertisers$Insertionorders$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - bulkListAssignedTargetingOptions( - params: Params$Resource$Advertisers$Lineitems$Bulklistassignedtargetingoptions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - bulkListAssignedTargetingOptions( - params: Params$Resource$Advertisers$Lineitems$Bulklistassignedtargetingoptions, - callback: BodyResponseCallback + patch( + params: Params$Resource$Advertisers$Insertionorders$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - bulkListAssignedTargetingOptions( - callback: BodyResponseCallback + patch( + params: Params$Resource$Advertisers$Insertionorders$Patch, + callback: BodyResponseCallback ): void; - bulkListAssignedTargetingOptions( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Advertisers$Lineitems$Bulklistassignedtargetingoptions - | BodyResponseCallback + | Params$Resource$Advertisers$Insertionorders$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Lineitems$Bulklistassignedtargetingoptions; + {}) as Params$Resource$Advertisers$Insertionorders$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Advertisers$Lineitems$Bulklistassignedtargetingoptions; + params = {} as Params$Resource$Advertisers$Insertionorders$Patch; options = {}; } @@ -16096,185 +16407,154 @@ export namespace displayvideo_v4 { { url: ( rootUrl + - '/v4/advertisers/{+advertiserId}/lineItems:bulkListAssignedTargetingOptions' + '/v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['advertiserId'], - pathParams: ['advertiserId'], + requiredParams: ['advertiserId', 'insertionOrderId'], + pathParams: ['advertiserId', 'insertionOrderId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Advertisers$Insertionorders$Create + extends StandardParameters { /** - * Updates multiple line items. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * BulkEditAssignedTargetingOptions * UpdateLineItem * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const displayvideo = google.displayvideo('v4'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/display-video'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await displayvideo.advertisers.lineItems.bulkUpdate({ - * // Required. The ID of the advertiser this line item belongs to. - * advertiserId: '[^/]+', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "lineItemIds": [], - * // "targetLineItem": {}, - * // "updateMask": "my_updateMask" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "errors": [], - * // "failedLineItemIds": [], - * // "skippedLineItemIds": [], - * // "updatedLineItemIds": [] - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * Output only. The unique ID of the advertiser the insertion order belongs to. */ - bulkUpdate( - params: Params$Resource$Advertisers$Lineitems$Bulkupdate, - options: StreamMethodOptions - ): Promise>; - bulkUpdate( - params?: Params$Resource$Advertisers$Lineitems$Bulkupdate, - options?: MethodOptions - ): Promise>; - bulkUpdate( - params: Params$Resource$Advertisers$Lineitems$Bulkupdate, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - bulkUpdate( - params: Params$Resource$Advertisers$Lineitems$Bulkupdate, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - bulkUpdate( - params: Params$Resource$Advertisers$Lineitems$Bulkupdate, - callback: BodyResponseCallback - ): void; - bulkUpdate( - callback: BodyResponseCallback - ): void; - bulkUpdate( - paramsOrCallback?: - | Params$Resource$Advertisers$Lineitems$Bulkupdate - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Lineitems$Bulkupdate; - let options = (optionsOrCallback || {}) as MethodOptions; + advertiserId?: string; - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Lineitems$Bulkupdate; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$InsertionOrder; + } + export interface Params$Resource$Advertisers$Insertionorders$Delete + extends StandardParameters { + /** + * The ID of the advertiser this insertion order belongs to. + */ + advertiserId?: string; + /** + * The ID of the insertion order to delete. + */ + insertionOrderId?: string; + } + export interface Params$Resource$Advertisers$Insertionorders$Get + extends StandardParameters { + /** + * Required. The ID of the advertiser this insertion order belongs to. + */ + advertiserId?: string; + /** + * Required. The ID of the insertion order to fetch. + */ + insertionOrderId?: string; + } + export interface Params$Resource$Advertisers$Insertionorders$List + extends StandardParameters { + /** + * Required. The ID of the advertiser to list insertion orders for. + */ + advertiserId?: string; + /** + * Allows filtering by insertion order fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All insertion orders under a campaign: `campaignId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")` * All insertion orders with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All insertion orders with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * "displayName" (default) * "entityStatus" * "updateTime" The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInsertionOrders` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Insertionorders$Listassignedtargetingoptions + extends StandardParameters { + /** + * Required. The ID of the advertiser the insertion order belongs to. + */ + advertiserId?: string; + /** + * Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` or `TARGETING_TYPE_CHANNEL`: `targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="TARGETING_TYPE_CHANNEL"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Required. The ID of the insertion order to list assigned targeting options for. + */ + insertionOrderId?: string; + /** + * Field by which to sort the list. Acceptable values are: * `targetingType` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`. + */ + orderBy?: string; + /** + * Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to `BulkListInsertionOrderAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Insertionorders$Patch + extends StandardParameters { + /** + * Output only. The unique ID of the advertiser the insertion order belongs to. + */ + advertiserId?: string; + /** + * Output only. The unique ID of the insertion order. Assigned by the system. + */ + insertionOrderId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$InsertionOrder; + } - const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v4/advertisers/{+advertiserId}/lineItems:bulkUpdate' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['advertiserId'], - pathParams: ['advertiserId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback + export class Resource$Advertisers$Insertionorders$Targetingtypes { + context: APIRequestContext; + assignedTargetingOptions: Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions; + constructor(context: APIRequestContext) { + this.context = context; + this.assignedTargetingOptions = + new Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions( + this.context ); - } else { - return createAPIRequest(parameters); - } + } + } + + export class Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Creates a new line item. Returns the newly created line item if successful. YouTube & Partners line items cannot be created or updated using the API. + * Assigns a targeting option to an insertion order. Returns the assigned targeting option if successful. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY` * @example * ```js * // Before running the sample: @@ -16303,135 +16583,203 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.lineItems.create({ - * // Output only. The unique ID of the advertiser the line item belongs to. - * advertiserId: '[^/]+', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "advertiserId": "my_advertiserId", - * // "bidStrategy": {}, - * // "budget": {}, - * // "campaignId": "my_campaignId", - * // "containsEuPoliticalAds": "my_containsEuPoliticalAds", - * // "conversionCounting": {}, - * // "creativeIds": [], - * // "displayName": "my_displayName", - * // "entityStatus": "my_entityStatus", - * // "excludeNewExchanges": false, - * // "flight": {}, - * // "frequencyCap": {}, - * // "insertionOrderId": "my_insertionOrderId", - * // "integrationDetails": {}, - * // "lineItemId": "my_lineItemId", - * // "lineItemType": "my_lineItemType", - * // "mobileApp": {}, - * // "name": "my_name", - * // "pacing": {}, - * // "partnerCosts": [], - * // "partnerRevenueModel": {}, - * // "reservationType": "my_reservationType", - * // "targetingExpansion": {}, - * // "updateTime": "my_updateTime", - * // "warningMessages": [], - * // "youtubeAndPartnersSettings": {} - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "advertiserId": "my_advertiserId", - * // "bidStrategy": {}, - * // "budget": {}, - * // "campaignId": "my_campaignId", - * // "containsEuPoliticalAds": "my_containsEuPoliticalAds", - * // "conversionCounting": {}, - * // "creativeIds": [], - * // "displayName": "my_displayName", - * // "entityStatus": "my_entityStatus", - * // "excludeNewExchanges": false, - * // "flight": {}, - * // "frequencyCap": {}, - * // "insertionOrderId": "my_insertionOrderId", - * // "integrationDetails": {}, - * // "lineItemId": "my_lineItemId", - * // "lineItemType": "my_lineItemType", - * // "mobileApp": {}, - * // "name": "my_name", - * // "pacing": {}, - * // "partnerCosts": [], - * // "partnerRevenueModel": {}, - * // "reservationType": "my_reservationType", - * // "targetingExpansion": {}, - * // "updateTime": "my_updateTime", - * // "warningMessages": [], - * // "youtubeAndPartnersSettings": {} - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` + * const res = + * await displayvideo.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.create( + * { + * // Required. The ID of the advertiser the insertion order belongs to. + * advertiserId: '[^/]+', + * // Required. The ID of the insertion order the assigned targeting option will belong to. + * insertionOrderId: '[^/]+', + * // Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY` + * targetingType: '[^/]+', * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - create( - params: Params$Resource$Advertisers$Lineitems$Create, + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "ageRangeDetails": {}, + * // "appCategoryDetails": {}, + * // "appDetails": {}, + * // "assignedTargetingOptionId": "my_assignedTargetingOptionId", + * // "assignedTargetingOptionIdAlias": "my_assignedTargetingOptionIdAlias", + * // "audienceGroupDetails": {}, + * // "audioContentTypeDetails": {}, + * // "authorizedSellerStatusDetails": {}, + * // "browserDetails": {}, + * // "businessChainDetails": {}, + * // "carrierAndIspDetails": {}, + * // "categoryDetails": {}, + * // "channelDetails": {}, + * // "contentDurationDetails": {}, + * // "contentGenreDetails": {}, + * // "contentInstreamPositionDetails": {}, + * // "contentOutstreamPositionDetails": {}, + * // "contentStreamTypeDetails": {}, + * // "contentThemeExclusionDetails": {}, + * // "dayAndTimeDetails": {}, + * // "deviceMakeModelDetails": {}, + * // "deviceTypeDetails": {}, + * // "digitalContentLabelExclusionDetails": {}, + * // "environmentDetails": {}, + * // "exchangeDetails": {}, + * // "genderDetails": {}, + * // "geoRegionDetails": {}, + * // "householdIncomeDetails": {}, + * // "inheritance": "my_inheritance", + * // "inventorySourceDetails": {}, + * // "inventorySourceGroupDetails": {}, + * // "keywordDetails": {}, + * // "languageDetails": {}, + * // "name": "my_name", + * // "nativeContentPositionDetails": {}, + * // "negativeKeywordListDetails": {}, + * // "omidDetails": {}, + * // "onScreenPositionDetails": {}, + * // "operatingSystemDetails": {}, + * // "parentalStatusDetails": {}, + * // "poiDetails": {}, + * // "proximityLocationListDetails": {}, + * // "regionalLocationListDetails": {}, + * // "sensitiveCategoryExclusionDetails": {}, + * // "sessionPositionDetails": {}, + * // "subExchangeDetails": {}, + * // "targetingType": "my_targetingType", + * // "thirdPartyVerifierDetails": {}, + * // "urlDetails": {}, + * // "userRewardedContentDetails": {}, + * // "videoPlayerSizeDetails": {}, + * // "viewabilityDetails": {}, + * // "youtubeChannelDetails": {}, + * // "youtubeVideoDetails": {} + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "ageRangeDetails": {}, + * // "appCategoryDetails": {}, + * // "appDetails": {}, + * // "assignedTargetingOptionId": "my_assignedTargetingOptionId", + * // "assignedTargetingOptionIdAlias": "my_assignedTargetingOptionIdAlias", + * // "audienceGroupDetails": {}, + * // "audioContentTypeDetails": {}, + * // "authorizedSellerStatusDetails": {}, + * // "browserDetails": {}, + * // "businessChainDetails": {}, + * // "carrierAndIspDetails": {}, + * // "categoryDetails": {}, + * // "channelDetails": {}, + * // "contentDurationDetails": {}, + * // "contentGenreDetails": {}, + * // "contentInstreamPositionDetails": {}, + * // "contentOutstreamPositionDetails": {}, + * // "contentStreamTypeDetails": {}, + * // "contentThemeExclusionDetails": {}, + * // "dayAndTimeDetails": {}, + * // "deviceMakeModelDetails": {}, + * // "deviceTypeDetails": {}, + * // "digitalContentLabelExclusionDetails": {}, + * // "environmentDetails": {}, + * // "exchangeDetails": {}, + * // "genderDetails": {}, + * // "geoRegionDetails": {}, + * // "householdIncomeDetails": {}, + * // "inheritance": "my_inheritance", + * // "inventorySourceDetails": {}, + * // "inventorySourceGroupDetails": {}, + * // "keywordDetails": {}, + * // "languageDetails": {}, + * // "name": "my_name", + * // "nativeContentPositionDetails": {}, + * // "negativeKeywordListDetails": {}, + * // "omidDetails": {}, + * // "onScreenPositionDetails": {}, + * // "operatingSystemDetails": {}, + * // "parentalStatusDetails": {}, + * // "poiDetails": {}, + * // "proximityLocationListDetails": {}, + * // "regionalLocationListDetails": {}, + * // "sensitiveCategoryExclusionDetails": {}, + * // "sessionPositionDetails": {}, + * // "subExchangeDetails": {}, + * // "targetingType": "my_targetingType", + * // "thirdPartyVerifierDetails": {}, + * // "urlDetails": {}, + * // "userRewardedContentDetails": {}, + * // "videoPlayerSizeDetails": {}, + * // "viewabilityDetails": {}, + * // "youtubeChannelDetails": {}, + * // "youtubeVideoDetails": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Create, options: StreamMethodOptions ): Promise>; create( - params?: Params$Resource$Advertisers$Lineitems$Create, + params?: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Create, options?: MethodOptions - ): Promise>; + ): Promise>; create( - params: Params$Resource$Advertisers$Lineitems$Create, + params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Advertisers$Lineitems$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Advertisers$Lineitems$Create, - callback: BodyResponseCallback + params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; create( paramsOrCallback?: - | Params$Resource$Advertisers$Lineitems$Create - | BodyResponseCallback + | Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Lineitems$Create; + {}) as Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Lineitems$Create; + params = + {} as Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Create; options = {}; } @@ -16445,7 +16793,8 @@ export namespace displayvideo_v4 { options: Object.assign( { url: ( - rootUrl + '/v4/advertisers/{+advertiserId}/lineItems' + rootUrl + + '/v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -16453,22 +16802,22 @@ export namespace displayvideo_v4 { options ), params, - requiredParams: ['advertiserId'], - pathParams: ['advertiserId'], + requiredParams: ['advertiserId', 'insertionOrderId', 'targetingType'], + pathParams: ['advertiserId', 'insertionOrderId', 'targetingType'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a line item. Returns error code `NOT_FOUND` if the line item does not exist. The line item should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. YouTube & Partners line items cannot be created or updated using the API. + * Deletes an assigned targeting option from an insertion order. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY` * @example * ```js * // Before running the sample: @@ -16497,12 +16846,19 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.lineItems.delete({ - * // The ID of the advertiser this line item belongs to. - * advertiserId: '[^/]+', - * // The ID of the line item to delete. - * lineItemId: '[^/]+', - * }); + * const res = + * await displayvideo.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.delete( + * { + * // Required. The ID of the advertiser the insertion order belongs to. + * advertiserId: '[^/]+', + * // Required. The ID of the assigned targeting option to delete. + * assignedTargetingOptionId: '[^/]+', + * // Required. The ID of the insertion order the assigned targeting option belongs to. + * insertionOrderId: '[^/]+', + * // Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY` + * targetingType: '[^/]+', + * }, + * ); * console.log(res.data); * * // Example response @@ -16522,31 +16878,31 @@ export namespace displayvideo_v4 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Advertisers$Lineitems$Delete, + params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Advertisers$Lineitems$Delete, + params?: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Advertisers$Lineitems$Delete, + params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Advertisers$Lineitems$Delete, + params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Advertisers$Lineitems$Delete, + params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Advertisers$Lineitems$Delete + | Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -16562,12 +16918,13 @@ export namespace displayvideo_v4 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Lineitems$Delete; + {}) as Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Lineitems$Delete; + params = + {} as Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Delete; options = {}; } @@ -16582,7 +16939,7 @@ export namespace displayvideo_v4 { { url: ( rootUrl + - '/v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}' + '/v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'DELETE', apiVersion: '', @@ -16590,8 +16947,18 @@ export namespace displayvideo_v4 { options ), params, - requiredParams: ['advertiserId', 'lineItemId'], - pathParams: ['advertiserId', 'lineItemId'], + requiredParams: [ + 'advertiserId', + 'insertionOrderId', + 'targetingType', + 'assignedTargetingOptionId', + ], + pathParams: [ + 'advertiserId', + 'assignedTargetingOptionId', + 'insertionOrderId', + 'targetingType', + ], context: this.context, }; if (callback) { @@ -16605,7 +16972,7 @@ export namespace displayvideo_v4 { } /** - * Duplicates a line item. Returns the ID of the created line item if successful. YouTube & Partners line items cannot be created or updated using the API. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors. + * Gets a single targeting option assigned to an insertion order. * @example * ```js * // Before running the sample: @@ -16634,26 +17001,77 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.lineItems.duplicate({ - * // Required. The ID of the advertiser this line item belongs to. - * advertiserId: '[^/]+', - * // Required. The ID of the line item to duplicate. - * lineItemId: '[^/]+', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "containsEuPoliticalAds": "my_containsEuPoliticalAds", - * // "targetDisplayName": "my_targetDisplayName" - * // } - * }, - * }); + * const res = + * await displayvideo.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.get( + * { + * // Required. The ID of the advertiser the insertion order belongs to. + * advertiserId: '[^/]+', + * // Required. An identifier unique to the targeting type in this insertion order that identifies the assigned targeting option being requested. + * assignedTargetingOptionId: '[^/]+', + * // Required. The ID of the insertion order the assigned targeting option belongs to. + * insertionOrderId: '[^/]+', + * // Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` + * targetingType: '[^/]+', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "duplicateLineItemId": "my_duplicateLineItemId" + * // "ageRangeDetails": {}, + * // "appCategoryDetails": {}, + * // "appDetails": {}, + * // "assignedTargetingOptionId": "my_assignedTargetingOptionId", + * // "assignedTargetingOptionIdAlias": "my_assignedTargetingOptionIdAlias", + * // "audienceGroupDetails": {}, + * // "audioContentTypeDetails": {}, + * // "authorizedSellerStatusDetails": {}, + * // "browserDetails": {}, + * // "businessChainDetails": {}, + * // "carrierAndIspDetails": {}, + * // "categoryDetails": {}, + * // "channelDetails": {}, + * // "contentDurationDetails": {}, + * // "contentGenreDetails": {}, + * // "contentInstreamPositionDetails": {}, + * // "contentOutstreamPositionDetails": {}, + * // "contentStreamTypeDetails": {}, + * // "contentThemeExclusionDetails": {}, + * // "dayAndTimeDetails": {}, + * // "deviceMakeModelDetails": {}, + * // "deviceTypeDetails": {}, + * // "digitalContentLabelExclusionDetails": {}, + * // "environmentDetails": {}, + * // "exchangeDetails": {}, + * // "genderDetails": {}, + * // "geoRegionDetails": {}, + * // "householdIncomeDetails": {}, + * // "inheritance": "my_inheritance", + * // "inventorySourceDetails": {}, + * // "inventorySourceGroupDetails": {}, + * // "keywordDetails": {}, + * // "languageDetails": {}, + * // "name": "my_name", + * // "nativeContentPositionDetails": {}, + * // "negativeKeywordListDetails": {}, + * // "omidDetails": {}, + * // "onScreenPositionDetails": {}, + * // "operatingSystemDetails": {}, + * // "parentalStatusDetails": {}, + * // "poiDetails": {}, + * // "proximityLocationListDetails": {}, + * // "regionalLocationListDetails": {}, + * // "sensitiveCategoryExclusionDetails": {}, + * // "sessionPositionDetails": {}, + * // "subExchangeDetails": {}, + * // "targetingType": "my_targetingType", + * // "thirdPartyVerifierDetails": {}, + * // "urlDetails": {}, + * // "userRewardedContentDetails": {}, + * // "videoPlayerSizeDetails": {}, + * // "viewabilityDetails": {}, + * // "youtubeChannelDetails": {}, + * // "youtubeVideoDetails": {} * // } * } * @@ -16669,57 +17087,56 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - duplicate( - params: Params$Resource$Advertisers$Lineitems$Duplicate, + get( + params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Get, options: StreamMethodOptions ): Promise>; - duplicate( - params?: Params$Resource$Advertisers$Lineitems$Duplicate, + get( + params?: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Get, options?: MethodOptions - ): Promise>; - duplicate( - params: Params$Resource$Advertisers$Lineitems$Duplicate, + ): Promise>; + get( + params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - duplicate( - params: Params$Resource$Advertisers$Lineitems$Duplicate, + get( + params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - duplicate( - params: Params$Resource$Advertisers$Lineitems$Duplicate, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - duplicate( - callback: BodyResponseCallback + get( + params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Get, + callback: BodyResponseCallback ): void; - duplicate( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Advertisers$Lineitems$Duplicate - | BodyResponseCallback + | Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Lineitems$Duplicate; + {}) as Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Lineitems$Duplicate; + params = + {} as Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Get; options = {}; } @@ -16734,30 +17151,40 @@ export namespace displayvideo_v4 { { url: ( rootUrl + - '/v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}:duplicate' + '/v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['advertiserId', 'lineItemId'], - pathParams: ['advertiserId', 'lineItemId'], + requiredParams: [ + 'advertiserId', + 'insertionOrderId', + 'targetingType', + 'assignedTargetingOptionId', + ], + pathParams: [ + 'advertiserId', + 'assignedTargetingOptionId', + 'insertionOrderId', + 'targetingType', + ], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates a new line item with settings (including targeting) inherited from the insertion order and an `ENTITY_STATUS_DRAFT` entity_status. Returns the newly created line item if successful. There are default values based on the three fields: * The insertion order's insertion_order_type * The insertion order's automation_type * The given line_item_type YouTube & Partners line items cannot be created or updated using the API. + * Lists the targeting options assigned to an insertion order. * @example * ```js * // Before running the sample: @@ -16786,52 +17213,31 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.lineItems.generateDefault({ - * // Required. The ID of the advertiser this line item belongs to. - * advertiserId: '[^/]+', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "containsEuPoliticalAds": "my_containsEuPoliticalAds", - * // "displayName": "my_displayName", - * // "insertionOrderId": "my_insertionOrderId", - * // "lineItemType": "my_lineItemType", - * // "mobileApp": {} - * // } - * }, - * }); + * const res = + * await displayvideo.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.list( + * { + * // Required. The ID of the advertiser the insertion order belongs to. + * advertiserId: '[^/]+', + * // Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + * filter: 'placeholder-value', + * // Required. The ID of the insertion order to list assigned targeting options for. + * insertionOrderId: '[^/]+', + * // Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`. + * orderBy: 'placeholder-value', + * // Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * pageSize: 'placeholder-value', + * // A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInsertionOrderAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + * pageToken: 'placeholder-value', + * // Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` + * targetingType: '[^/]+', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "advertiserId": "my_advertiserId", - * // "bidStrategy": {}, - * // "budget": {}, - * // "campaignId": "my_campaignId", - * // "containsEuPoliticalAds": "my_containsEuPoliticalAds", - * // "conversionCounting": {}, - * // "creativeIds": [], - * // "displayName": "my_displayName", - * // "entityStatus": "my_entityStatus", - * // "excludeNewExchanges": false, - * // "flight": {}, - * // "frequencyCap": {}, - * // "insertionOrderId": "my_insertionOrderId", - * // "integrationDetails": {}, - * // "lineItemId": "my_lineItemId", - * // "lineItemType": "my_lineItemType", - * // "mobileApp": {}, - * // "name": "my_name", - * // "pacing": {}, - * // "partnerCosts": [], - * // "partnerRevenueModel": {}, - * // "reservationType": "my_reservationType", - * // "targetingExpansion": {}, - * // "updateTime": "my_updateTime", - * // "warningMessages": [], - * // "youtubeAndPartnersSettings": {} + * // "assignedTargetingOptions": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -16847,53 +17253,62 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - generateDefault( - params: Params$Resource$Advertisers$Lineitems$Generatedefault, + list( + params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$List, options: StreamMethodOptions ): Promise>; - generateDefault( - params?: Params$Resource$Advertisers$Lineitems$Generatedefault, + list( + params?: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$List, options?: MethodOptions - ): Promise>; - generateDefault( - params: Params$Resource$Advertisers$Lineitems$Generatedefault, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - generateDefault( - params: Params$Resource$Advertisers$Lineitems$Generatedefault, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - generateDefault( - params: Params$Resource$Advertisers$Lineitems$Generatedefault, - callback: BodyResponseCallback + list( + params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$List, + callback: BodyResponseCallback ): void; - generateDefault(callback: BodyResponseCallback): void; - generateDefault( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Advertisers$Lineitems$Generatedefault - | BodyResponseCallback + | Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Lineitems$Generatedefault; + {}) as Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Lineitems$Generatedefault; + params = + {} as Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$List; options = {}; } @@ -16908,30 +17323,129 @@ export namespace displayvideo_v4 { { url: ( rootUrl + - '/v4/advertisers/{+advertiserId}/lineItems:generateDefault' + '/v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['advertiserId'], - pathParams: ['advertiserId'], + requiredParams: ['advertiserId', 'insertionOrderId', 'targetingType'], + pathParams: ['advertiserId', 'insertionOrderId', 'targetingType'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Create + extends StandardParameters { /** - * Gets a line item. + * Required. The ID of the advertiser the insertion order belongs to. + */ + advertiserId?: string; + /** + * Required. The ID of the insertion order the assigned targeting option will belong to. + */ + insertionOrderId?: string; + /** + * Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY` + */ + targetingType?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AssignedTargetingOption; + } + export interface Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Delete + extends StandardParameters { + /** + * Required. The ID of the advertiser the insertion order belongs to. + */ + advertiserId?: string; + /** + * Required. The ID of the assigned targeting option to delete. + */ + assignedTargetingOptionId?: string; + /** + * Required. The ID of the insertion order the assigned targeting option belongs to. + */ + insertionOrderId?: string; + /** + * Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY` + */ + targetingType?: string; + } + export interface Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Get + extends StandardParameters { + /** + * Required. The ID of the advertiser the insertion order belongs to. + */ + advertiserId?: string; + /** + * Required. An identifier unique to the targeting type in this insertion order that identifies the assigned targeting option being requested. + */ + assignedTargetingOptionId?: string; + /** + * Required. The ID of the insertion order the assigned targeting option belongs to. + */ + insertionOrderId?: string; + /** + * Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` + */ + targetingType?: string; + } + export interface Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$List + extends StandardParameters { + /** + * Required. The ID of the advertiser the insertion order belongs to. + */ + advertiserId?: string; + /** + * Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Required. The ID of the insertion order to list assigned targeting options for. + */ + insertionOrderId?: string; + /** + * Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInsertionOrderAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` + */ + targetingType?: string; + } + + export class Resource$Advertisers$Invoices { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists invoices posted for an advertiser in a given month. Invoices generated by billing profiles with a "Partner" invoice level are not retrievable through this method. * @example * ```js * // Before running the sample: @@ -16952,7 +17466,10 @@ export namespace displayvideo_v4 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/display-video'], + * scopes: [ + * 'https://www.googleapis.com/auth/display-video', + * 'https://www.googleapis.com/auth/display-video-mediaplanning', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -16960,42 +17477,24 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.lineItems.get({ - * // Required. The ID of the advertiser this line item belongs to. + * const res = await displayvideo.advertisers.invoices.list({ + * // Required. The ID of the advertiser to list invoices for. * advertiserId: '[^/]+', - * // Required. The ID of the line item to fetch. - * lineItemId: '[^/]+', + * // The month to list the invoices for. If not set, the request will retrieve invoices for the previous month. Must be in the format YYYYMM. + * issueMonth: 'placeholder-value', + * // Select type of invoice to retrieve for Loi Sapin advertisers. Only applicable to Loi Sapin advertisers. Will be ignored otherwise. + * loiSapinInvoiceType: 'placeholder-value', + * // Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * pageSize: 'placeholder-value', + * // A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInvoices` method. If not specified, the first page of results will be returned. + * pageToken: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "advertiserId": "my_advertiserId", - * // "bidStrategy": {}, - * // "budget": {}, - * // "campaignId": "my_campaignId", - * // "containsEuPoliticalAds": "my_containsEuPoliticalAds", - * // "conversionCounting": {}, - * // "creativeIds": [], - * // "displayName": "my_displayName", - * // "entityStatus": "my_entityStatus", - * // "excludeNewExchanges": false, - * // "flight": {}, - * // "frequencyCap": {}, - * // "insertionOrderId": "my_insertionOrderId", - * // "integrationDetails": {}, - * // "lineItemId": "my_lineItemId", - * // "lineItemType": "my_lineItemType", - * // "mobileApp": {}, - * // "name": "my_name", - * // "pacing": {}, - * // "partnerCosts": [], - * // "partnerRevenueModel": {}, - * // "reservationType": "my_reservationType", - * // "targetingExpansion": {}, - * // "updateTime": "my_updateTime", - * // "warningMessages": [], - * // "youtubeAndPartnersSettings": {} + * // "invoices": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -17011,53 +17510,55 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Advertisers$Lineitems$Get, + list( + params: Params$Resource$Advertisers$Invoices$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Advertisers$Lineitems$Get, + list( + params?: Params$Resource$Advertisers$Invoices$List, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Advertisers$Lineitems$Get, + ): Promise>; + list( + params: Params$Resource$Advertisers$Invoices$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Advertisers$Lineitems$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Advertisers$Invoices$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Advertisers$Lineitems$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Advertisers$Invoices$List, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Advertisers$Lineitems$Get - | BodyResponseCallback + | Params$Resource$Advertisers$Invoices$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Lineitems$Get; + {}) as Params$Resource$Advertisers$Invoices$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Lineitems$Get; + params = {} as Params$Resource$Advertisers$Invoices$List; options = {}; } @@ -17070,32 +17571,32 @@ export namespace displayvideo_v4 { const parameters = { options: Object.assign( { - url: ( - rootUrl + - '/v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v4/advertisers/{+advertiserId}/invoices').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['advertiserId', 'lineItemId'], - pathParams: ['advertiserId', 'lineItemId'], + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists line items in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, line items with `ENTITY_STATUS_ARCHIVED` will not be included in the results. + * Retrieves the invoice currency used by an advertiser in a given month. * @example * ```js * // Before running the sample: @@ -17116,7 +17617,10 @@ export namespace displayvideo_v4 { * async function main() { * const auth = new google.auth.GoogleAuth({ * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/display-video'], + * scopes: [ + * 'https://www.googleapis.com/auth/display-video', + * 'https://www.googleapis.com/auth/display-video-mediaplanning', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -17124,24 +17628,17 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.lineItems.list({ - * // Required. The ID of the advertiser to list line items for. + * const res = await displayvideo.advertisers.invoices.lookupInvoiceCurrency({ + * // Required. The ID of the advertiser to lookup currency for. * advertiserId: '[^/]+', - * // Allows filtering by line item fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `insertionOrderId` * `lineItemId` * `lineItemType` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All line items under an insertion order: `insertionOrderId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"` * All line items with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All line items with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. - * filter: 'placeholder-value', - * // Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. - * orderBy: 'placeholder-value', - * // Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLineItems` method. If not specified, the first page of results will be returned. - * pageToken: 'placeholder-value', + * // Month for which the currency is needed. If not set, the request will return existing currency settings for the advertiser. Must be in the format YYYYMM. + * invoiceMonth: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "lineItems": [], - * // "nextPageToken": "my_nextPageToken" + * // "currencyCode": "my_currencyCode" * // } * } * @@ -17157,55 +17654,58 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Advertisers$Lineitems$List, + lookupInvoiceCurrency( + params: Params$Resource$Advertisers$Invoices$Lookupinvoicecurrency, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Advertisers$Lineitems$List, + lookupInvoiceCurrency( + params?: Params$Resource$Advertisers$Invoices$Lookupinvoicecurrency, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Advertisers$Lineitems$List, + ): Promise>; + lookupInvoiceCurrency( + params: Params$Resource$Advertisers$Invoices$Lookupinvoicecurrency, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Advertisers$Lineitems$List, + lookupInvoiceCurrency( + params: Params$Resource$Advertisers$Invoices$Lookupinvoicecurrency, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Advertisers$Lineitems$List, - callback: BodyResponseCallback + lookupInvoiceCurrency( + params: Params$Resource$Advertisers$Invoices$Lookupinvoicecurrency, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + lookupInvoiceCurrency( + callback: BodyResponseCallback + ): void; + lookupInvoiceCurrency( paramsOrCallback?: - | Params$Resource$Advertisers$Lineitems$List - | BodyResponseCallback + | Params$Resource$Advertisers$Invoices$Lookupinvoicecurrency + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Lineitems$List; + {}) as Params$Resource$Advertisers$Invoices$Lookupinvoicecurrency; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Lineitems$List; + params = + {} as Params$Resource$Advertisers$Invoices$Lookupinvoicecurrency; options = {}; } @@ -17219,7 +17719,8 @@ export namespace displayvideo_v4 { options: Object.assign( { url: ( - rootUrl + '/v4/advertisers/{+advertiserId}/lineItems' + rootUrl + + '/v4/advertisers/{+advertiserId}/invoices:lookupInvoiceCurrency' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -17232,17 +17733,68 @@ export namespace displayvideo_v4 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Advertisers$Invoices$List + extends StandardParameters { /** - * Updates an existing line item. Returns the updated line item if successful. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * BulkEditAssignedTargetingOptions * BulkUpdateLineItems * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors. + * Required. The ID of the advertiser to list invoices for. + */ + advertiserId?: string; + /** + * The month to list the invoices for. If not set, the request will retrieve invoices for the previous month. Must be in the format YYYYMM. + */ + issueMonth?: string; + /** + * Select type of invoice to retrieve for Loi Sapin advertisers. Only applicable to Loi Sapin advertisers. Will be ignored otherwise. + */ + loiSapinInvoiceType?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInvoices` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Invoices$Lookupinvoicecurrency + extends StandardParameters { + /** + * Required. The ID of the advertiser to lookup currency for. + */ + advertiserId?: string; + /** + * Month for which the currency is needed. If not set, the request will return existing currency settings for the advertiser. Must be in the format YYYYMM. + */ + invoiceMonth?: string; + } + + export class Resource$Advertisers$Lineitems { + context: APIRequestContext; + targetingTypes: Resource$Advertisers$Lineitems$Targetingtypes; + youtubeAssetTypes: Resource$Advertisers$Lineitems$Youtubeassettypes; + constructor(context: APIRequestContext) { + this.context = context; + this.targetingTypes = new Resource$Advertisers$Lineitems$Targetingtypes( + this.context + ); + this.youtubeAssetTypes = + new Resource$Advertisers$Lineitems$Youtubeassettypes(this.context); + } + + /** + * Bulk edits targeting options under multiple line items. The operation will delete the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.create_requests. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkUpdate * lineItems.patch * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API. * @example * ```js * // Before running the sample: @@ -17271,77 +17823,28 @@ export namespace displayvideo_v4 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.lineItems.patch({ - * // Output only. The unique ID of the advertiser the line item belongs to. - * advertiserId: '[^/]+', - * // Output only. The unique ID of the line item. Assigned by the system. - * lineItemId: '[^/]+', - * // Required. The mask to control which fields to update. - * updateMask: 'placeholder-value', + * const res = + * await displayvideo.advertisers.lineItems.bulkEditAssignedTargetingOptions({ + * // Required. The ID of the advertiser the line items belong to. + * advertiserId: '[^/]+', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "advertiserId": "my_advertiserId", - * // "bidStrategy": {}, - * // "budget": {}, - * // "campaignId": "my_campaignId", - * // "containsEuPoliticalAds": "my_containsEuPoliticalAds", - * // "conversionCounting": {}, - * // "creativeIds": [], - * // "displayName": "my_displayName", - * // "entityStatus": "my_entityStatus", - * // "excludeNewExchanges": false, - * // "flight": {}, - * // "frequencyCap": {}, - * // "insertionOrderId": "my_insertionOrderId", - * // "integrationDetails": {}, - * // "lineItemId": "my_lineItemId", - * // "lineItemType": "my_lineItemType", - * // "mobileApp": {}, - * // "name": "my_name", - * // "pacing": {}, - * // "partnerCosts": [], - * // "partnerRevenueModel": {}, - * // "reservationType": "my_reservationType", - * // "targetingExpansion": {}, - * // "updateTime": "my_updateTime", - * // "warningMessages": [], - * // "youtubeAndPartnersSettings": {} - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createRequests": [], + * // "deleteRequests": [], + * // "lineItemIds": [] + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "advertiserId": "my_advertiserId", - * // "bidStrategy": {}, - * // "budget": {}, - * // "campaignId": "my_campaignId", - * // "containsEuPoliticalAds": "my_containsEuPoliticalAds", - * // "conversionCounting": {}, - * // "creativeIds": [], - * // "displayName": "my_displayName", - * // "entityStatus": "my_entityStatus", - * // "excludeNewExchanges": false, - * // "flight": {}, - * // "frequencyCap": {}, - * // "insertionOrderId": "my_insertionOrderId", - * // "integrationDetails": {}, - * // "lineItemId": "my_lineItemId", - * // "lineItemType": "my_lineItemType", - * // "mobileApp": {}, - * // "name": "my_name", - * // "pacing": {}, - * // "partnerCosts": [], - * // "partnerRevenueModel": {}, - * // "reservationType": "my_reservationType", - * // "targetingExpansion": {}, - * // "updateTime": "my_updateTime", - * // "warningMessages": [], - * // "youtubeAndPartnersSettings": {} + * // "errors": [], + * // "failedLineItemIds": [], + * // "updatedLineItemIds": [] * // } * } * @@ -17357,53 +17860,62 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Advertisers$Lineitems$Patch, + bulkEditAssignedTargetingOptions( + params: Params$Resource$Advertisers$Lineitems$Bulkeditassignedtargetingoptions, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Advertisers$Lineitems$Patch, + bulkEditAssignedTargetingOptions( + params?: Params$Resource$Advertisers$Lineitems$Bulkeditassignedtargetingoptions, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Advertisers$Lineitems$Patch, + ): Promise< + GaxiosResponseWithHTTP2 + >; + bulkEditAssignedTargetingOptions( + params: Params$Resource$Advertisers$Lineitems$Bulkeditassignedtargetingoptions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Advertisers$Lineitems$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + bulkEditAssignedTargetingOptions( + params: Params$Resource$Advertisers$Lineitems$Bulkeditassignedtargetingoptions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Advertisers$Lineitems$Patch, - callback: BodyResponseCallback + bulkEditAssignedTargetingOptions( + params: Params$Resource$Advertisers$Lineitems$Bulkeditassignedtargetingoptions, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + bulkEditAssignedTargetingOptions( + callback: BodyResponseCallback + ): void; + bulkEditAssignedTargetingOptions( paramsOrCallback?: - | Params$Resource$Advertisers$Lineitems$Patch - | BodyResponseCallback + | Params$Resource$Advertisers$Lineitems$Bulkeditassignedtargetingoptions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Lineitems$Patch; + {}) as Params$Resource$Advertisers$Lineitems$Bulkeditassignedtargetingoptions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Lineitems$Patch; + params = + {} as Params$Resource$Advertisers$Lineitems$Bulkeditassignedtargetingoptions; options = {}; } @@ -17418,206 +17930,32 @@ export namespace displayvideo_v4 { { url: ( rootUrl + - '/v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}' + '/v4/advertisers/{+advertiserId}/lineItems:bulkEditAssignedTargetingOptions' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['advertiserId', 'lineItemId'], - pathParams: ['advertiserId', 'lineItemId'], + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Advertisers$Lineitems$Bulkeditassignedtargetingoptions - extends StandardParameters { - /** - * Required. The ID of the advertiser the line items belong to. - */ - advertiserId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$BulkEditAssignedTargetingOptionsRequest; - } - export interface Params$Resource$Advertisers$Lineitems$Bulklistassignedtargetingoptions - extends StandardParameters { - /** - * Required. The ID of the advertiser the line items belongs to. - */ - advertiserId?: string; - /** - * Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR` on the same field. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` or `TARGETING_TYPE_CHANNEL`: `targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="TARGETING_TYPE_CHANNEL"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. - */ - filter?: string; - /** - * Required. The IDs of the line items to list assigned targeting options for. - */ - lineItemIds?: string[]; - /** - * Field by which to sort the list. Acceptable values are: * `lineItemId` (default) * `assignedTargetingOption.targetingType` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`. - */ - orderBy?: string; - /** - * Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - */ - pageSize?: number; - /** - * A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to the `BulkListAssignedTargetingOptions` method. If not specified, the first page of results will be returned. - */ - pageToken?: string; - } - export interface Params$Resource$Advertisers$Lineitems$Bulkupdate - extends StandardParameters { - /** - * Required. The ID of the advertiser this line item belongs to. - */ - advertiserId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$BulkUpdateLineItemsRequest; - } - export interface Params$Resource$Advertisers$Lineitems$Create - extends StandardParameters { - /** - * Output only. The unique ID of the advertiser the line item belongs to. - */ - advertiserId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LineItem; - } - export interface Params$Resource$Advertisers$Lineitems$Delete - extends StandardParameters { - /** - * The ID of the advertiser this line item belongs to. - */ - advertiserId?: string; - /** - * The ID of the line item to delete. - */ - lineItemId?: string; - } - export interface Params$Resource$Advertisers$Lineitems$Duplicate - extends StandardParameters { - /** - * Required. The ID of the advertiser this line item belongs to. - */ - advertiserId?: string; - /** - * Required. The ID of the line item to duplicate. - */ - lineItemId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$DuplicateLineItemRequest; - } - export interface Params$Resource$Advertisers$Lineitems$Generatedefault - extends StandardParameters { - /** - * Required. The ID of the advertiser this line item belongs to. - */ - advertiserId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GenerateDefaultLineItemRequest; - } - export interface Params$Resource$Advertisers$Lineitems$Get - extends StandardParameters { - /** - * Required. The ID of the advertiser this line item belongs to. - */ - advertiserId?: string; - /** - * Required. The ID of the line item to fetch. - */ - lineItemId?: string; - } - export interface Params$Resource$Advertisers$Lineitems$List - extends StandardParameters { - /** - * Required. The ID of the advertiser to list line items for. - */ - advertiserId?: string; - /** - * Allows filtering by line item fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `insertionOrderId` * `lineItemId` * `lineItemType` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All line items under an insertion order: `insertionOrderId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"` * All line items with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All line items with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. - */ - filter?: string; - /** - * Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. - */ - orderBy?: string; - /** - * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. - */ - pageSize?: number; - /** - * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLineItems` method. If not specified, the first page of results will be returned. - */ - pageToken?: string; - } - export interface Params$Resource$Advertisers$Lineitems$Patch - extends StandardParameters { - /** - * Output only. The unique ID of the advertiser the line item belongs to. - */ - advertiserId?: string; - /** - * Output only. The unique ID of the line item. Assigned by the system. - */ - lineItemId?: string; - /** - * Required. The mask to control which fields to update. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LineItem; - } - - export class Resource$Advertisers$Lineitems$Targetingtypes { - context: APIRequestContext; - assignedTargetingOptions: Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions; - constructor(context: APIRequestContext) { - this.context = context; - this.assignedTargetingOptions = - new Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions( - this.context - ); - } - } - - export class Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Assigns a targeting option to a line item. Returns the assigned targeting option if successful. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkEditAssignedTargetingOptions * lineItems.bulkUpdate * lineItems.patch * DeleteLineItemAssignedTargetingOption YouTube & Partners line items cannot be created or updated using the API. + * Lists assigned targeting options for multiple line items across targeting types. * @example * ```js * // Before running the sample: @@ -17647,72 +17985,1728 @@ export namespace displayvideo_v4 { * * // Do the magic * const res = - * await displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.create( - * { - * // Required. The ID of the advertiser the line item belongs to. - * advertiserId: '[^/]+', - * // Required. The ID of the line item the assigned targeting option will belong to. - * lineItemId: '[^/]+', - * // Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` - * targetingType: '[^/]+', + * await displayvideo.advertisers.lineItems.bulkListAssignedTargetingOptions({ + * // Required. The ID of the advertiser the line items belongs to. + * advertiserId: '[^/]+', + * // Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR` on the same field. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` or `TARGETING_TYPE_CHANNEL`: `targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="TARGETING_TYPE_CHANNEL"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + * filter: 'placeholder-value', + * // Required. The IDs of the line items to list assigned targeting options for. + * lineItemIds: 'placeholder-value', + * // Field by which to sort the list. Acceptable values are: * `lineItemId` (default) * `assignedTargetingOption.targetingType` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`. + * orderBy: 'placeholder-value', + * // Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * pageSize: 'placeholder-value', + * // A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to the `BulkListAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + * pageToken: 'placeholder-value', + * }); + * console.log(res.data); * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "ageRangeDetails": {}, - * // "appCategoryDetails": {}, - * // "appDetails": {}, - * // "assignedTargetingOptionId": "my_assignedTargetingOptionId", - * // "assignedTargetingOptionIdAlias": "my_assignedTargetingOptionIdAlias", - * // "audienceGroupDetails": {}, - * // "audioContentTypeDetails": {}, - * // "authorizedSellerStatusDetails": {}, - * // "browserDetails": {}, - * // "businessChainDetails": {}, - * // "carrierAndIspDetails": {}, - * // "categoryDetails": {}, - * // "channelDetails": {}, - * // "contentDurationDetails": {}, - * // "contentGenreDetails": {}, - * // "contentInstreamPositionDetails": {}, - * // "contentOutstreamPositionDetails": {}, - * // "contentStreamTypeDetails": {}, - * // "contentThemeExclusionDetails": {}, - * // "dayAndTimeDetails": {}, - * // "deviceMakeModelDetails": {}, - * // "deviceTypeDetails": {}, - * // "digitalContentLabelExclusionDetails": {}, - * // "environmentDetails": {}, - * // "exchangeDetails": {}, - * // "genderDetails": {}, - * // "geoRegionDetails": {}, - * // "householdIncomeDetails": {}, - * // "inheritance": "my_inheritance", - * // "inventorySourceDetails": {}, - * // "inventorySourceGroupDetails": {}, - * // "keywordDetails": {}, - * // "languageDetails": {}, - * // "name": "my_name", - * // "nativeContentPositionDetails": {}, - * // "negativeKeywordListDetails": {}, - * // "omidDetails": {}, - * // "onScreenPositionDetails": {}, - * // "operatingSystemDetails": {}, - * // "parentalStatusDetails": {}, - * // "poiDetails": {}, - * // "proximityLocationListDetails": {}, - * // "regionalLocationListDetails": {}, - * // "sensitiveCategoryExclusionDetails": {}, - * // "sessionPositionDetails": {}, - * // "subExchangeDetails": {}, - * // "targetingType": "my_targetingType", - * // "thirdPartyVerifierDetails": {}, - * // "urlDetails": {}, - * // "userRewardedContentDetails": {}, - * // "videoPlayerSizeDetails": {}, - * // "viewabilityDetails": {}, - * // "youtubeChannelDetails": {}, + * // Example response + * // { + * // "lineItemAssignedTargetingOptions": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + bulkListAssignedTargetingOptions( + params: Params$Resource$Advertisers$Lineitems$Bulklistassignedtargetingoptions, + options: StreamMethodOptions + ): Promise>; + bulkListAssignedTargetingOptions( + params?: Params$Resource$Advertisers$Lineitems$Bulklistassignedtargetingoptions, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + bulkListAssignedTargetingOptions( + params: Params$Resource$Advertisers$Lineitems$Bulklistassignedtargetingoptions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkListAssignedTargetingOptions( + params: Params$Resource$Advertisers$Lineitems$Bulklistassignedtargetingoptions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkListAssignedTargetingOptions( + params: Params$Resource$Advertisers$Lineitems$Bulklistassignedtargetingoptions, + callback: BodyResponseCallback + ): void; + bulkListAssignedTargetingOptions( + callback: BodyResponseCallback + ): void; + bulkListAssignedTargetingOptions( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Bulklistassignedtargetingoptions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Bulklistassignedtargetingoptions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Lineitems$Bulklistassignedtargetingoptions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/lineItems:bulkListAssignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates multiple line items. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * BulkEditAssignedTargetingOptions * UpdateLineItem * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v4'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await displayvideo.advertisers.lineItems.bulkUpdate({ + * // Required. The ID of the advertiser this line item belongs to. + * advertiserId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "lineItemIds": [], + * // "targetLineItem": {}, + * // "updateMask": "my_updateMask" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "errors": [], + * // "failedLineItemIds": [], + * // "skippedLineItemIds": [], + * // "updatedLineItemIds": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + bulkUpdate( + params: Params$Resource$Advertisers$Lineitems$Bulkupdate, + options: StreamMethodOptions + ): Promise>; + bulkUpdate( + params?: Params$Resource$Advertisers$Lineitems$Bulkupdate, + options?: MethodOptions + ): Promise>; + bulkUpdate( + params: Params$Resource$Advertisers$Lineitems$Bulkupdate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkUpdate( + params: Params$Resource$Advertisers$Lineitems$Bulkupdate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkUpdate( + params: Params$Resource$Advertisers$Lineitems$Bulkupdate, + callback: BodyResponseCallback + ): void; + bulkUpdate( + callback: BodyResponseCallback + ): void; + bulkUpdate( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Bulkupdate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Bulkupdate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$Bulkupdate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v4/advertisers/{+advertiserId}/lineItems:bulkUpdate' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a new line item. Returns the newly created line item if successful. YouTube & Partners line items cannot be created or updated using the API. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v4'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await displayvideo.advertisers.lineItems.create({ + * // Output only. The unique ID of the advertiser the line item belongs to. + * advertiserId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "advertiserId": "my_advertiserId", + * // "bidStrategy": {}, + * // "budget": {}, + * // "campaignId": "my_campaignId", + * // "containsEuPoliticalAds": "my_containsEuPoliticalAds", + * // "conversionCounting": {}, + * // "creativeIds": [], + * // "displayName": "my_displayName", + * // "entityStatus": "my_entityStatus", + * // "excludeNewExchanges": false, + * // "flight": {}, + * // "frequencyCap": {}, + * // "insertionOrderId": "my_insertionOrderId", + * // "integrationDetails": {}, + * // "lineItemId": "my_lineItemId", + * // "lineItemType": "my_lineItemType", + * // "mobileApp": {}, + * // "name": "my_name", + * // "pacing": {}, + * // "partnerCosts": [], + * // "partnerRevenueModel": {}, + * // "reservationType": "my_reservationType", + * // "targetingExpansion": {}, + * // "updateTime": "my_updateTime", + * // "warningMessages": [], + * // "youtubeAndPartnersSettings": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "advertiserId": "my_advertiserId", + * // "bidStrategy": {}, + * // "budget": {}, + * // "campaignId": "my_campaignId", + * // "containsEuPoliticalAds": "my_containsEuPoliticalAds", + * // "conversionCounting": {}, + * // "creativeIds": [], + * // "displayName": "my_displayName", + * // "entityStatus": "my_entityStatus", + * // "excludeNewExchanges": false, + * // "flight": {}, + * // "frequencyCap": {}, + * // "insertionOrderId": "my_insertionOrderId", + * // "integrationDetails": {}, + * // "lineItemId": "my_lineItemId", + * // "lineItemType": "my_lineItemType", + * // "mobileApp": {}, + * // "name": "my_name", + * // "pacing": {}, + * // "partnerCosts": [], + * // "partnerRevenueModel": {}, + * // "reservationType": "my_reservationType", + * // "targetingExpansion": {}, + * // "updateTime": "my_updateTime", + * // "warningMessages": [], + * // "youtubeAndPartnersSettings": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Advertisers$Lineitems$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Advertisers$Lineitems$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Advertisers$Lineitems$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Lineitems$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Lineitems$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v4/advertisers/{+advertiserId}/lineItems' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a line item. Returns error code `NOT_FOUND` if the line item does not exist. The line item should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. YouTube & Partners line items cannot be created or updated using the API. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v4'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await displayvideo.advertisers.lineItems.delete({ + * // The ID of the advertiser this line item belongs to. + * advertiserId: '[^/]+', + * // The ID of the line item to delete. + * lineItemId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Advertisers$Lineitems$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Advertisers$Lineitems$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Advertisers$Lineitems$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Lineitems$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Lineitems$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'lineItemId'], + pathParams: ['advertiserId', 'lineItemId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Duplicates a line item. Returns the ID of the created line item if successful. YouTube & Partners line items cannot be created or updated using the API. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v4'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await displayvideo.advertisers.lineItems.duplicate({ + * // Required. The ID of the advertiser this line item belongs to. + * advertiserId: '[^/]+', + * // Required. The ID of the line item to duplicate. + * lineItemId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "containsEuPoliticalAds": "my_containsEuPoliticalAds", + * // "targetDisplayName": "my_targetDisplayName" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "duplicateLineItemId": "my_duplicateLineItemId" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + duplicate( + params: Params$Resource$Advertisers$Lineitems$Duplicate, + options: StreamMethodOptions + ): Promise>; + duplicate( + params?: Params$Resource$Advertisers$Lineitems$Duplicate, + options?: MethodOptions + ): Promise>; + duplicate( + params: Params$Resource$Advertisers$Lineitems$Duplicate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + duplicate( + params: Params$Resource$Advertisers$Lineitems$Duplicate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + duplicate( + params: Params$Resource$Advertisers$Lineitems$Duplicate, + callback: BodyResponseCallback + ): void; + duplicate( + callback: BodyResponseCallback + ): void; + duplicate( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Duplicate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Duplicate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$Duplicate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}:duplicate' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'lineItemId'], + pathParams: ['advertiserId', 'lineItemId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a new line item with settings (including targeting) inherited from the insertion order and an `ENTITY_STATUS_DRAFT` entity_status. Returns the newly created line item if successful. There are default values based on the three fields: * The insertion order's insertion_order_type * The insertion order's automation_type * The given line_item_type YouTube & Partners line items cannot be created or updated using the API. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v4'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await displayvideo.advertisers.lineItems.generateDefault({ + * // Required. The ID of the advertiser this line item belongs to. + * advertiserId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "containsEuPoliticalAds": "my_containsEuPoliticalAds", + * // "displayName": "my_displayName", + * // "insertionOrderId": "my_insertionOrderId", + * // "lineItemType": "my_lineItemType", + * // "mobileApp": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "advertiserId": "my_advertiserId", + * // "bidStrategy": {}, + * // "budget": {}, + * // "campaignId": "my_campaignId", + * // "containsEuPoliticalAds": "my_containsEuPoliticalAds", + * // "conversionCounting": {}, + * // "creativeIds": [], + * // "displayName": "my_displayName", + * // "entityStatus": "my_entityStatus", + * // "excludeNewExchanges": false, + * // "flight": {}, + * // "frequencyCap": {}, + * // "insertionOrderId": "my_insertionOrderId", + * // "integrationDetails": {}, + * // "lineItemId": "my_lineItemId", + * // "lineItemType": "my_lineItemType", + * // "mobileApp": {}, + * // "name": "my_name", + * // "pacing": {}, + * // "partnerCosts": [], + * // "partnerRevenueModel": {}, + * // "reservationType": "my_reservationType", + * // "targetingExpansion": {}, + * // "updateTime": "my_updateTime", + * // "warningMessages": [], + * // "youtubeAndPartnersSettings": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + generateDefault( + params: Params$Resource$Advertisers$Lineitems$Generatedefault, + options: StreamMethodOptions + ): Promise>; + generateDefault( + params?: Params$Resource$Advertisers$Lineitems$Generatedefault, + options?: MethodOptions + ): Promise>; + generateDefault( + params: Params$Resource$Advertisers$Lineitems$Generatedefault, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateDefault( + params: Params$Resource$Advertisers$Lineitems$Generatedefault, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateDefault( + params: Params$Resource$Advertisers$Lineitems$Generatedefault, + callback: BodyResponseCallback + ): void; + generateDefault(callback: BodyResponseCallback): void; + generateDefault( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Generatedefault + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Generatedefault; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$Generatedefault; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/lineItems:generateDefault' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a line item. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v4'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await displayvideo.advertisers.lineItems.get({ + * // Required. The ID of the advertiser this line item belongs to. + * advertiserId: '[^/]+', + * // Required. The ID of the line item to fetch. + * lineItemId: '[^/]+', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "advertiserId": "my_advertiserId", + * // "bidStrategy": {}, + * // "budget": {}, + * // "campaignId": "my_campaignId", + * // "containsEuPoliticalAds": "my_containsEuPoliticalAds", + * // "conversionCounting": {}, + * // "creativeIds": [], + * // "displayName": "my_displayName", + * // "entityStatus": "my_entityStatus", + * // "excludeNewExchanges": false, + * // "flight": {}, + * // "frequencyCap": {}, + * // "insertionOrderId": "my_insertionOrderId", + * // "integrationDetails": {}, + * // "lineItemId": "my_lineItemId", + * // "lineItemType": "my_lineItemType", + * // "mobileApp": {}, + * // "name": "my_name", + * // "pacing": {}, + * // "partnerCosts": [], + * // "partnerRevenueModel": {}, + * // "reservationType": "my_reservationType", + * // "targetingExpansion": {}, + * // "updateTime": "my_updateTime", + * // "warningMessages": [], + * // "youtubeAndPartnersSettings": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Advertisers$Lineitems$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Advertisers$Lineitems$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Advertisers$Lineitems$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Lineitems$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Lineitems$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'lineItemId'], + pathParams: ['advertiserId', 'lineItemId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists line items in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, line items with `ENTITY_STATUS_ARCHIVED` will not be included in the results. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v4'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await displayvideo.advertisers.lineItems.list({ + * // Required. The ID of the advertiser to list line items for. + * advertiserId: '[^/]+', + * // Allows filtering by line item fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `insertionOrderId` * `lineItemId` * `lineItemType` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All line items under an insertion order: `insertionOrderId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"` * All line items with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All line items with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + * filter: 'placeholder-value', + * // Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + * orderBy: 'placeholder-value', + * // Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * pageSize: 'placeholder-value', + * // A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLineItems` method. If not specified, the first page of results will be returned. + * pageToken: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "lineItems": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Advertisers$Lineitems$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Advertisers$Lineitems$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Advertisers$Lineitems$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Lineitems$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Lineitems$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v4/advertisers/{+advertiserId}/lineItems' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing line item. Returns the updated line item if successful. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * BulkEditAssignedTargetingOptions * BulkUpdateLineItems * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v4'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await displayvideo.advertisers.lineItems.patch({ + * // Output only. The unique ID of the advertiser the line item belongs to. + * advertiserId: '[^/]+', + * // Output only. The unique ID of the line item. Assigned by the system. + * lineItemId: '[^/]+', + * // Required. The mask to control which fields to update. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "advertiserId": "my_advertiserId", + * // "bidStrategy": {}, + * // "budget": {}, + * // "campaignId": "my_campaignId", + * // "containsEuPoliticalAds": "my_containsEuPoliticalAds", + * // "conversionCounting": {}, + * // "creativeIds": [], + * // "displayName": "my_displayName", + * // "entityStatus": "my_entityStatus", + * // "excludeNewExchanges": false, + * // "flight": {}, + * // "frequencyCap": {}, + * // "insertionOrderId": "my_insertionOrderId", + * // "integrationDetails": {}, + * // "lineItemId": "my_lineItemId", + * // "lineItemType": "my_lineItemType", + * // "mobileApp": {}, + * // "name": "my_name", + * // "pacing": {}, + * // "partnerCosts": [], + * // "partnerRevenueModel": {}, + * // "reservationType": "my_reservationType", + * // "targetingExpansion": {}, + * // "updateTime": "my_updateTime", + * // "warningMessages": [], + * // "youtubeAndPartnersSettings": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "advertiserId": "my_advertiserId", + * // "bidStrategy": {}, + * // "budget": {}, + * // "campaignId": "my_campaignId", + * // "containsEuPoliticalAds": "my_containsEuPoliticalAds", + * // "conversionCounting": {}, + * // "creativeIds": [], + * // "displayName": "my_displayName", + * // "entityStatus": "my_entityStatus", + * // "excludeNewExchanges": false, + * // "flight": {}, + * // "frequencyCap": {}, + * // "insertionOrderId": "my_insertionOrderId", + * // "integrationDetails": {}, + * // "lineItemId": "my_lineItemId", + * // "lineItemType": "my_lineItemType", + * // "mobileApp": {}, + * // "name": "my_name", + * // "pacing": {}, + * // "partnerCosts": [], + * // "partnerRevenueModel": {}, + * // "reservationType": "my_reservationType", + * // "targetingExpansion": {}, + * // "updateTime": "my_updateTime", + * // "warningMessages": [], + * // "youtubeAndPartnersSettings": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Advertisers$Lineitems$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Advertisers$Lineitems$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Advertisers$Lineitems$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Lineitems$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Lineitems$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'lineItemId'], + pathParams: ['advertiserId', 'lineItemId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Lineitems$Bulkeditassignedtargetingoptions + extends StandardParameters { + /** + * Required. The ID of the advertiser the line items belong to. + */ + advertiserId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BulkEditAssignedTargetingOptionsRequest; + } + export interface Params$Resource$Advertisers$Lineitems$Bulklistassignedtargetingoptions + extends StandardParameters { + /** + * Required. The ID of the advertiser the line items belongs to. + */ + advertiserId?: string; + /** + * Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR` on the same field. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` or `TARGETING_TYPE_CHANNEL`: `targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="TARGETING_TYPE_CHANNEL"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Required. The IDs of the line items to list assigned targeting options for. + */ + lineItemIds?: string[]; + /** + * Field by which to sort the list. Acceptable values are: * `lineItemId` (default) * `assignedTargetingOption.targetingType` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`. + */ + orderBy?: string; + /** + * Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to the `BulkListAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Lineitems$Bulkupdate + extends StandardParameters { + /** + * Required. The ID of the advertiser this line item belongs to. + */ + advertiserId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BulkUpdateLineItemsRequest; + } + export interface Params$Resource$Advertisers$Lineitems$Create + extends StandardParameters { + /** + * Output only. The unique ID of the advertiser the line item belongs to. + */ + advertiserId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LineItem; + } + export interface Params$Resource$Advertisers$Lineitems$Delete + extends StandardParameters { + /** + * The ID of the advertiser this line item belongs to. + */ + advertiserId?: string; + /** + * The ID of the line item to delete. + */ + lineItemId?: string; + } + export interface Params$Resource$Advertisers$Lineitems$Duplicate + extends StandardParameters { + /** + * Required. The ID of the advertiser this line item belongs to. + */ + advertiserId?: string; + /** + * Required. The ID of the line item to duplicate. + */ + lineItemId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DuplicateLineItemRequest; + } + export interface Params$Resource$Advertisers$Lineitems$Generatedefault + extends StandardParameters { + /** + * Required. The ID of the advertiser this line item belongs to. + */ + advertiserId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GenerateDefaultLineItemRequest; + } + export interface Params$Resource$Advertisers$Lineitems$Get + extends StandardParameters { + /** + * Required. The ID of the advertiser this line item belongs to. + */ + advertiserId?: string; + /** + * Required. The ID of the line item to fetch. + */ + lineItemId?: string; + } + export interface Params$Resource$Advertisers$Lineitems$List + extends StandardParameters { + /** + * Required. The ID of the advertiser to list line items for. + */ + advertiserId?: string; + /** + * Allows filtering by line item fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `insertionOrderId` * `lineItemId` * `lineItemType` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All line items under an insertion order: `insertionOrderId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"` * All line items with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All line items with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLineItems` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Lineitems$Patch + extends StandardParameters { + /** + * Output only. The unique ID of the advertiser the line item belongs to. + */ + advertiserId?: string; + /** + * Output only. The unique ID of the line item. Assigned by the system. + */ + lineItemId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LineItem; + } + + export class Resource$Advertisers$Lineitems$Targetingtypes { + context: APIRequestContext; + assignedTargetingOptions: Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions; + constructor(context: APIRequestContext) { + this.context = context; + this.assignedTargetingOptions = + new Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions( + this.context + ); + } + } + + export class Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Assigns a targeting option to a line item. Returns the assigned targeting option if successful. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkEditAssignedTargetingOptions * lineItems.bulkUpdate * lineItems.patch * DeleteLineItemAssignedTargetingOption YouTube & Partners line items cannot be created or updated using the API. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v4'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.create( + * { + * // Required. The ID of the advertiser the line item belongs to. + * advertiserId: '[^/]+', + * // Required. The ID of the line item the assigned targeting option will belong to. + * lineItemId: '[^/]+', + * // Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` + * targetingType: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "ageRangeDetails": {}, + * // "appCategoryDetails": {}, + * // "appDetails": {}, + * // "assignedTargetingOptionId": "my_assignedTargetingOptionId", + * // "assignedTargetingOptionIdAlias": "my_assignedTargetingOptionIdAlias", + * // "audienceGroupDetails": {}, + * // "audioContentTypeDetails": {}, + * // "authorizedSellerStatusDetails": {}, + * // "browserDetails": {}, + * // "businessChainDetails": {}, + * // "carrierAndIspDetails": {}, + * // "categoryDetails": {}, + * // "channelDetails": {}, + * // "contentDurationDetails": {}, + * // "contentGenreDetails": {}, + * // "contentInstreamPositionDetails": {}, + * // "contentOutstreamPositionDetails": {}, + * // "contentStreamTypeDetails": {}, + * // "contentThemeExclusionDetails": {}, + * // "dayAndTimeDetails": {}, + * // "deviceMakeModelDetails": {}, + * // "deviceTypeDetails": {}, + * // "digitalContentLabelExclusionDetails": {}, + * // "environmentDetails": {}, + * // "exchangeDetails": {}, + * // "genderDetails": {}, + * // "geoRegionDetails": {}, + * // "householdIncomeDetails": {}, + * // "inheritance": "my_inheritance", + * // "inventorySourceDetails": {}, + * // "inventorySourceGroupDetails": {}, + * // "keywordDetails": {}, + * // "languageDetails": {}, + * // "name": "my_name", + * // "nativeContentPositionDetails": {}, + * // "negativeKeywordListDetails": {}, + * // "omidDetails": {}, + * // "onScreenPositionDetails": {}, + * // "operatingSystemDetails": {}, + * // "parentalStatusDetails": {}, + * // "poiDetails": {}, + * // "proximityLocationListDetails": {}, + * // "regionalLocationListDetails": {}, + * // "sensitiveCategoryExclusionDetails": {}, + * // "sessionPositionDetails": {}, + * // "subExchangeDetails": {}, + * // "targetingType": "my_targetingType", + * // "thirdPartyVerifierDetails": {}, + * // "urlDetails": {}, + * // "userRewardedContentDetails": {}, + * // "videoPlayerSizeDetails": {}, + * // "viewabilityDetails": {}, + * // "youtubeChannelDetails": {}, * // "youtubeVideoDetails": {} * // } * }, @@ -17722,60 +19716,585 @@ export namespace displayvideo_v4 { * * // Example response * // { - * // "ageRangeDetails": {}, - * // "appCategoryDetails": {}, - * // "appDetails": {}, - * // "assignedTargetingOptionId": "my_assignedTargetingOptionId", - * // "assignedTargetingOptionIdAlias": "my_assignedTargetingOptionIdAlias", - * // "audienceGroupDetails": {}, - * // "audioContentTypeDetails": {}, - * // "authorizedSellerStatusDetails": {}, - * // "browserDetails": {}, - * // "businessChainDetails": {}, - * // "carrierAndIspDetails": {}, - * // "categoryDetails": {}, - * // "channelDetails": {}, - * // "contentDurationDetails": {}, - * // "contentGenreDetails": {}, - * // "contentInstreamPositionDetails": {}, - * // "contentOutstreamPositionDetails": {}, - * // "contentStreamTypeDetails": {}, - * // "contentThemeExclusionDetails": {}, - * // "dayAndTimeDetails": {}, - * // "deviceMakeModelDetails": {}, - * // "deviceTypeDetails": {}, - * // "digitalContentLabelExclusionDetails": {}, - * // "environmentDetails": {}, - * // "exchangeDetails": {}, - * // "genderDetails": {}, - * // "geoRegionDetails": {}, - * // "householdIncomeDetails": {}, - * // "inheritance": "my_inheritance", - * // "inventorySourceDetails": {}, - * // "inventorySourceGroupDetails": {}, - * // "keywordDetails": {}, - * // "languageDetails": {}, - * // "name": "my_name", - * // "nativeContentPositionDetails": {}, - * // "negativeKeywordListDetails": {}, - * // "omidDetails": {}, - * // "onScreenPositionDetails": {}, - * // "operatingSystemDetails": {}, - * // "parentalStatusDetails": {}, - * // "poiDetails": {}, - * // "proximityLocationListDetails": {}, - * // "regionalLocationListDetails": {}, - * // "sensitiveCategoryExclusionDetails": {}, - * // "sessionPositionDetails": {}, - * // "subExchangeDetails": {}, - * // "targetingType": "my_targetingType", - * // "thirdPartyVerifierDetails": {}, - * // "urlDetails": {}, - * // "userRewardedContentDetails": {}, - * // "videoPlayerSizeDetails": {}, - * // "viewabilityDetails": {}, - * // "youtubeChannelDetails": {}, - * // "youtubeVideoDetails": {} + * // "ageRangeDetails": {}, + * // "appCategoryDetails": {}, + * // "appDetails": {}, + * // "assignedTargetingOptionId": "my_assignedTargetingOptionId", + * // "assignedTargetingOptionIdAlias": "my_assignedTargetingOptionIdAlias", + * // "audienceGroupDetails": {}, + * // "audioContentTypeDetails": {}, + * // "authorizedSellerStatusDetails": {}, + * // "browserDetails": {}, + * // "businessChainDetails": {}, + * // "carrierAndIspDetails": {}, + * // "categoryDetails": {}, + * // "channelDetails": {}, + * // "contentDurationDetails": {}, + * // "contentGenreDetails": {}, + * // "contentInstreamPositionDetails": {}, + * // "contentOutstreamPositionDetails": {}, + * // "contentStreamTypeDetails": {}, + * // "contentThemeExclusionDetails": {}, + * // "dayAndTimeDetails": {}, + * // "deviceMakeModelDetails": {}, + * // "deviceTypeDetails": {}, + * // "digitalContentLabelExclusionDetails": {}, + * // "environmentDetails": {}, + * // "exchangeDetails": {}, + * // "genderDetails": {}, + * // "geoRegionDetails": {}, + * // "householdIncomeDetails": {}, + * // "inheritance": "my_inheritance", + * // "inventorySourceDetails": {}, + * // "inventorySourceGroupDetails": {}, + * // "keywordDetails": {}, + * // "languageDetails": {}, + * // "name": "my_name", + * // "nativeContentPositionDetails": {}, + * // "negativeKeywordListDetails": {}, + * // "omidDetails": {}, + * // "onScreenPositionDetails": {}, + * // "operatingSystemDetails": {}, + * // "parentalStatusDetails": {}, + * // "poiDetails": {}, + * // "proximityLocationListDetails": {}, + * // "regionalLocationListDetails": {}, + * // "sensitiveCategoryExclusionDetails": {}, + * // "sessionPositionDetails": {}, + * // "subExchangeDetails": {}, + * // "targetingType": "my_targetingType", + * // "thirdPartyVerifierDetails": {}, + * // "urlDetails": {}, + * // "userRewardedContentDetails": {}, + * // "videoPlayerSizeDetails": {}, + * // "viewabilityDetails": {}, + * // "youtubeChannelDetails": {}, + * // "youtubeVideoDetails": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['advertiserId', 'lineItemId', 'targetingType'], + pathParams: ['advertiserId', 'lineItemId', 'targetingType'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes an assigned targeting option from a line item. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkEditAssignedTargetingOptions * lineItems.bulkUpdate * lineItems.patch * CreateLineItemAssignedTargetingOption YouTube & Partners line items cannot be created or updated using the API. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v4'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.delete( + * { + * // Required. The ID of the advertiser the line item belongs to. + * advertiserId: '[^/]+', + * // Required. The ID of the assigned targeting option to delete. + * assignedTargetingOptionId: '[^/]+', + * // Required. The ID of the line item the assigned targeting option belongs to. + * lineItemId: '[^/]+', + * // Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` + * targetingType: '[^/]+', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: [ + 'advertiserId', + 'lineItemId', + 'targetingType', + 'assignedTargetingOptionId', + ], + pathParams: [ + 'advertiserId', + 'assignedTargetingOptionId', + 'lineItemId', + 'targetingType', + ], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a single targeting option assigned to a line item. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v4'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.get( + * { + * // Required. The ID of the advertiser the line item belongs to. + * advertiserId: '[^/]+', + * // Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested. + * assignedTargetingOptionId: '[^/]+', + * // Required. The ID of the line item the assigned targeting option belongs to. + * lineItemId: '[^/]+', + * // Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_INVENTORY_MODE` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) + * targetingType: '[^/]+', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "ageRangeDetails": {}, + * // "appCategoryDetails": {}, + * // "appDetails": {}, + * // "assignedTargetingOptionId": "my_assignedTargetingOptionId", + * // "assignedTargetingOptionIdAlias": "my_assignedTargetingOptionIdAlias", + * // "audienceGroupDetails": {}, + * // "audioContentTypeDetails": {}, + * // "authorizedSellerStatusDetails": {}, + * // "browserDetails": {}, + * // "businessChainDetails": {}, + * // "carrierAndIspDetails": {}, + * // "categoryDetails": {}, + * // "channelDetails": {}, + * // "contentDurationDetails": {}, + * // "contentGenreDetails": {}, + * // "contentInstreamPositionDetails": {}, + * // "contentOutstreamPositionDetails": {}, + * // "contentStreamTypeDetails": {}, + * // "contentThemeExclusionDetails": {}, + * // "dayAndTimeDetails": {}, + * // "deviceMakeModelDetails": {}, + * // "deviceTypeDetails": {}, + * // "digitalContentLabelExclusionDetails": {}, + * // "environmentDetails": {}, + * // "exchangeDetails": {}, + * // "genderDetails": {}, + * // "geoRegionDetails": {}, + * // "householdIncomeDetails": {}, + * // "inheritance": "my_inheritance", + * // "inventorySourceDetails": {}, + * // "inventorySourceGroupDetails": {}, + * // "keywordDetails": {}, + * // "languageDetails": {}, + * // "name": "my_name", + * // "nativeContentPositionDetails": {}, + * // "negativeKeywordListDetails": {}, + * // "omidDetails": {}, + * // "onScreenPositionDetails": {}, + * // "operatingSystemDetails": {}, + * // "parentalStatusDetails": {}, + * // "poiDetails": {}, + * // "proximityLocationListDetails": {}, + * // "regionalLocationListDetails": {}, + * // "sensitiveCategoryExclusionDetails": {}, + * // "sessionPositionDetails": {}, + * // "subExchangeDetails": {}, + * // "targetingType": "my_targetingType", + * // "thirdPartyVerifierDetails": {}, + * // "urlDetails": {}, + * // "userRewardedContentDetails": {}, + * // "videoPlayerSizeDetails": {}, + * // "viewabilityDetails": {}, + * // "youtubeChannelDetails": {}, + * // "youtubeVideoDetails": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: [ + 'advertiserId', + 'lineItemId', + 'targetingType', + 'assignedTargetingOptionId', + ], + pathParams: [ + 'advertiserId', + 'assignedTargetingOptionId', + 'lineItemId', + 'targetingType', + ], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists the targeting options assigned to a line item. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v4'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/display-video'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.list( + * { + * // Required. The ID of the advertiser the line item belongs to. + * advertiserId: '[^/]+', + * // Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + * filter: 'placeholder-value', + * // Required. The ID of the line item to list assigned targeting options for. + * lineItemId: '[^/]+', + * // Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`. + * orderBy: 'placeholder-value', + * // Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * pageSize: 'placeholder-value', + * // A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLineItemAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + * pageToken: 'placeholder-value', + * // Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_INVENTORY_MODE` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) + * targetingType: '[^/]+', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "assignedTargetingOptions": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -17791,58 +20310,62 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create, + list( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create, + list( + params?: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create, + list( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - create( + list( paramsOrCallback?: - | Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create - | BodyResponseCallback + | Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create; + {}) as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create; + {} as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List; options = {}; } @@ -17859,7 +20382,7 @@ export namespace displayvideo_v4 { rootUrl + '/v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -17870,17 +20393,128 @@ export namespace displayvideo_v4 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + + export interface Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create + extends StandardParameters { + /** + * Required. The ID of the advertiser the line item belongs to. + */ + advertiserId?: string; + /** + * Required. The ID of the line item the assigned targeting option will belong to. + */ + lineItemId?: string; + /** + * Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` + */ + targetingType?: string; /** - * Deletes an assigned targeting option from a line item. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkEditAssignedTargetingOptions * lineItems.bulkUpdate * lineItems.patch * CreateLineItemAssignedTargetingOption YouTube & Partners line items cannot be created or updated using the API. + * Request body metadata + */ + requestBody?: Schema$AssignedTargetingOption; + } + export interface Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete + extends StandardParameters { + /** + * Required. The ID of the advertiser the line item belongs to. + */ + advertiserId?: string; + /** + * Required. The ID of the assigned targeting option to delete. + */ + assignedTargetingOptionId?: string; + /** + * Required. The ID of the line item the assigned targeting option belongs to. + */ + lineItemId?: string; + /** + * Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` + */ + targetingType?: string; + } + export interface Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get + extends StandardParameters { + /** + * Required. The ID of the advertiser the line item belongs to. + */ + advertiserId?: string; + /** + * Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested. + */ + assignedTargetingOptionId?: string; + /** + * Required. The ID of the line item the assigned targeting option belongs to. + */ + lineItemId?: string; + /** + * Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_INVENTORY_MODE` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) + */ + targetingType?: string; + } + export interface Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List + extends StandardParameters { + /** + * Required. The ID of the advertiser the line item belongs to. + */ + advertiserId?: string; + /** + * Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Required. The ID of the line item to list assigned targeting options for. + */ + lineItemId?: string; + /** + * Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLineItemAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_INVENTORY_MODE` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) + */ + targetingType?: string; + } + + export class Resource$Advertisers$Lineitems$Youtubeassettypes { + context: APIRequestContext; + youtubeAssetAssociations: Resource$Advertisers$Lineitems$Youtubeassettypes$Youtubeassetassociations; + constructor(context: APIRequestContext) { + this.context = context; + this.youtubeAssetAssociations = + new Resource$Advertisers$Lineitems$Youtubeassettypes$Youtubeassetassociations( + this.context + ); + } + } + + export class Resource$Advertisers$Lineitems$Youtubeassettypes$Youtubeassetassociations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new association between the identified resource and a YouTube asset. Returns the newly-created association. *Warning:* This method is only available to an informed subset of users. * @example * ```js * // Before running the sample: @@ -17910,22 +20544,36 @@ export namespace displayvideo_v4 { * * // Do the magic * const res = - * await displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.delete( + * await displayvideo.advertisers.lineItems.youtubeAssetTypes.youtubeAssetAssociations.create( * { - * // Required. The ID of the advertiser the line item belongs to. + * // Required. The ID of the advertiser that the linked entity belongs to. * advertiserId: '[^/]+', - * // Required. The ID of the assigned targeting option to delete. - * assignedTargetingOptionId: '[^/]+', - * // Required. The ID of the line item the assigned targeting option belongs to. + * // The ID of a line item. * lineItemId: '[^/]+', - * // Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` - * targetingType: '[^/]+', + * // The ID of an ad group. + * 'linkedEntity.adGroupId': 'placeholder-value', + * // Required. The type of YouTube asset associated with the resource. + * youtubeAssetType: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "linkedYoutubeAsset": {}, + * // "name": "my_name", + * // "youtubeAssetType": "my_youtubeAssetType" + * // } + * }, * }, * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "linkedYoutubeAsset": {}, + * // "name": "my_name", + * // "youtubeAssetType": "my_youtubeAssetType" + * // } * } * * main().catch(e => { @@ -17940,54 +20588,58 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete, + create( + params: Params$Resource$Advertisers$Lineitems$Youtubeassettypes$Youtubeassetassociations$Create, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete, + create( + params?: Params$Resource$Advertisers$Lineitems$Youtubeassettypes$Youtubeassetassociations$Create, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete, + ): Promise>; + create( + params: Params$Resource$Advertisers$Lineitems$Youtubeassettypes$Youtubeassetassociations$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Advertisers$Lineitems$Youtubeassettypes$Youtubeassetassociations$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete, - callback: BodyResponseCallback + create( + params: Params$Resource$Advertisers$Lineitems$Youtubeassettypes$Youtubeassetassociations$Create, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete - | BodyResponseCallback + | Params$Resource$Advertisers$Lineitems$Youtubeassettypes$Youtubeassetassociations$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete; + {}) as Params$Resource$Advertisers$Lineitems$Youtubeassettypes$Youtubeassetassociations$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete; + {} as Params$Resource$Advertisers$Lineitems$Youtubeassettypes$Youtubeassetassociations$Create; options = {}; } @@ -18002,40 +20654,30 @@ export namespace displayvideo_v4 { { url: ( rootUrl + - '/v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' + '/v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: [ - 'advertiserId', - 'lineItemId', - 'targetingType', - 'assignedTargetingOptionId', - ], - pathParams: [ - 'advertiserId', - 'assignedTargetingOptionId', - 'lineItemId', - 'targetingType', - ], + requiredParams: ['advertiserId', 'lineItemId', 'youtubeAssetType'], + pathParams: ['advertiserId', 'lineItemId', 'youtubeAssetType'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a single targeting option assigned to a line item. + * Deletes an existing association between the identified resource and a YouTube asset. *Warning:* This method is only available to an informed subset of users. * @example * ```js * // Before running the sample: @@ -18065,77 +20707,24 @@ export namespace displayvideo_v4 { * * // Do the magic * const res = - * await displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.get( + * await displayvideo.advertisers.lineItems.youtubeAssetTypes.youtubeAssetAssociations.delete( * { - * // Required. The ID of the advertiser the line item belongs to. + * // Required. The ID of the advertiser that the linked entity belongs to. * advertiserId: '[^/]+', - * // Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested. - * assignedTargetingOptionId: '[^/]+', - * // Required. The ID of the line item the assigned targeting option belongs to. + * // The ID of a line item. * lineItemId: '[^/]+', - * // Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_INVENTORY_MODE` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) - * targetingType: '[^/]+', + * // The ID of an ad group. + * 'linkedEntity.adGroupId': 'placeholder-value', + * // Required. The ID of the YouTube asset in the association. For `YOUTUBE_ASSET_TYPE_LOCATION` and `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION` associations: This should be the ID of the asset set linked, or 0 if the location_asset_filter or affiliate_location_asset_filter is `DISABLED`. For `YOUTUBE_ASSET_TYPE_SITELINK` associations: This should be the ID of the sitelink asset linked. + * youtubeAssetAssociationId: '[^/]+', + * // Required. The type of YouTube asset associated with the resource. + * youtubeAssetType: '[^/]+', * }, * ); * console.log(res.data); * * // Example response - * // { - * // "ageRangeDetails": {}, - * // "appCategoryDetails": {}, - * // "appDetails": {}, - * // "assignedTargetingOptionId": "my_assignedTargetingOptionId", - * // "assignedTargetingOptionIdAlias": "my_assignedTargetingOptionIdAlias", - * // "audienceGroupDetails": {}, - * // "audioContentTypeDetails": {}, - * // "authorizedSellerStatusDetails": {}, - * // "browserDetails": {}, - * // "businessChainDetails": {}, - * // "carrierAndIspDetails": {}, - * // "categoryDetails": {}, - * // "channelDetails": {}, - * // "contentDurationDetails": {}, - * // "contentGenreDetails": {}, - * // "contentInstreamPositionDetails": {}, - * // "contentOutstreamPositionDetails": {}, - * // "contentStreamTypeDetails": {}, - * // "contentThemeExclusionDetails": {}, - * // "dayAndTimeDetails": {}, - * // "deviceMakeModelDetails": {}, - * // "deviceTypeDetails": {}, - * // "digitalContentLabelExclusionDetails": {}, - * // "environmentDetails": {}, - * // "exchangeDetails": {}, - * // "genderDetails": {}, - * // "geoRegionDetails": {}, - * // "householdIncomeDetails": {}, - * // "inheritance": "my_inheritance", - * // "inventorySourceDetails": {}, - * // "inventorySourceGroupDetails": {}, - * // "keywordDetails": {}, - * // "languageDetails": {}, - * // "name": "my_name", - * // "nativeContentPositionDetails": {}, - * // "negativeKeywordListDetails": {}, - * // "omidDetails": {}, - * // "onScreenPositionDetails": {}, - * // "operatingSystemDetails": {}, - * // "parentalStatusDetails": {}, - * // "poiDetails": {}, - * // "proximityLocationListDetails": {}, - * // "regionalLocationListDetails": {}, - * // "sensitiveCategoryExclusionDetails": {}, - * // "sessionPositionDetails": {}, - * // "subExchangeDetails": {}, - * // "targetingType": "my_targetingType", - * // "thirdPartyVerifierDetails": {}, - * // "urlDetails": {}, - * // "userRewardedContentDetails": {}, - * // "videoPlayerSizeDetails": {}, - * // "viewabilityDetails": {}, - * // "youtubeChannelDetails": {}, - * // "youtubeVideoDetails": {} - * // } + * // {} * } * * main().catch(e => { @@ -18150,56 +20739,54 @@ export namespace displayvideo_v4 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get, + delete( + params: Params$Resource$Advertisers$Lineitems$Youtubeassettypes$Youtubeassetassociations$Delete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get, + delete( + params?: Params$Resource$Advertisers$Lineitems$Youtubeassettypes$Youtubeassetassociations$Delete, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get, + ): Promise>; + delete( + params: Params$Resource$Advertisers$Lineitems$Youtubeassettypes$Youtubeassetassociations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Advertisers$Lineitems$Youtubeassettypes$Youtubeassetassociations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Advertisers$Lineitems$Youtubeassettypes$Youtubeassetassociations$Delete, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get - | BodyResponseCallback + | Params$Resource$Advertisers$Lineitems$Youtubeassettypes$Youtubeassetassociations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get; + {}) as Params$Resource$Advertisers$Lineitems$Youtubeassettypes$Youtubeassetassociations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get; + {} as Params$Resource$Advertisers$Lineitems$Youtubeassettypes$Youtubeassetassociations$Delete; options = {}; } @@ -18214,9 +20801,9 @@ export namespace displayvideo_v4 { { url: ( rootUrl + - '/v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' + '/v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations/{+youtubeAssetAssociationId}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -18225,29 +20812,29 @@ export namespace displayvideo_v4 { requiredParams: [ 'advertiserId', 'lineItemId', - 'targetingType', - 'assignedTargetingOptionId', + 'youtubeAssetType', + 'youtubeAssetAssociationId', ], pathParams: [ 'advertiserId', - 'assignedTargetingOptionId', 'lineItemId', - 'targetingType', + 'youtubeAssetAssociationId', + 'youtubeAssetType', ], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists the targeting options assigned to a line item. + * Lists the YouTube asset associations linked to the given resource. * @example * ```js * // Before running the sample: @@ -18277,30 +20864,30 @@ export namespace displayvideo_v4 { * * // Do the magic * const res = - * await displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.list( + * await displayvideo.advertisers.lineItems.youtubeAssetTypes.youtubeAssetAssociations.list( * { - * // Required. The ID of the advertiser the line item belongs to. + * // Required. The ID of the advertiser that the linked entity belongs to. * advertiserId: '[^/]+', - * // Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. - * filter: 'placeholder-value', - * // Required. The ID of the line item to list assigned targeting options for. + * // The ID of a line item. * lineItemId: '[^/]+', - * // Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`. + * // The ID of an ad group. + * 'linkedEntity.adGroupId': 'placeholder-value', + * // Optional. Field by which to sort the list. The only acceptable values are: * `linkedYoutubeAsset.locationAssetFilter.assetSetId`, * `linkedYoutubeAsset.affiliateLocationAssetFilter.assetSetId`, * `linkedYoutubeAsset.sitelinkAsset.assetId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `linkedYoutubeAsset.sitelinkAsset.assetId desc`. * orderBy: 'placeholder-value', - * // Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * // Optional. Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. * pageSize: 'placeholder-value', - * // A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLineItemAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + * // Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListYoutubeAssetAssociations` method. If not specified, the first page of results will be returned. * pageToken: 'placeholder-value', - * // Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_INVENTORY_MODE` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) - * targetingType: '[^/]+', + * // Required. The type of YouTube asset being associated with the resource. + * youtubeAssetType: '[^/]+', * }, * ); * console.log(res.data); * * // Example response * // { - * // "assignedTargetingOptions": [], - * // "nextPageToken": "my_nextPageToken" + * // "nextPageToken": "my_nextPageToken", + * // "youtubeAssetAssociations": [] * // } * } * @@ -18317,61 +20904,61 @@ export namespace displayvideo_v4 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List, + params: Params$Resource$Advertisers$Lineitems$Youtubeassettypes$Youtubeassetassociations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List, + params?: Params$Resource$Advertisers$Lineitems$Youtubeassettypes$Youtubeassetassociations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List, + params: Params$Resource$Advertisers$Lineitems$Youtubeassettypes$Youtubeassetassociations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List, + params: Params$Resource$Advertisers$Lineitems$Youtubeassettypes$Youtubeassetassociations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List, - callback: BodyResponseCallback + params: Params$Resource$Advertisers$Lineitems$Youtubeassettypes$Youtubeassetassociations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List - | BodyResponseCallback + | Params$Resource$Advertisers$Lineitems$Youtubeassettypes$Youtubeassetassociations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List; + {}) as Params$Resource$Advertisers$Lineitems$Youtubeassettypes$Youtubeassetassociations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List; + {} as Params$Resource$Advertisers$Lineitems$Youtubeassettypes$Youtubeassetassociations$List; options = {}; } @@ -18386,7 +20973,7 @@ export namespace displayvideo_v4 { { url: ( rootUrl + - '/v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions' + '/v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -18394,111 +20981,100 @@ export namespace displayvideo_v4 { options ), params, - requiredParams: ['advertiserId', 'lineItemId', 'targetingType'], - pathParams: ['advertiserId', 'lineItemId', 'targetingType'], + requiredParams: ['advertiserId', 'lineItemId', 'youtubeAssetType'], + pathParams: ['advertiserId', 'lineItemId', 'youtubeAssetType'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create + export interface Params$Resource$Advertisers$Lineitems$Youtubeassettypes$Youtubeassetassociations$Create extends StandardParameters { /** - * Required. The ID of the advertiser the line item belongs to. + * Required. The ID of the advertiser that the linked entity belongs to. */ advertiserId?: string; /** - * Required. The ID of the line item the assigned targeting option will belong to. + * The ID of a line item. */ lineItemId?: string; /** - * Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` + * The ID of an ad group. */ - targetingType?: string; + 'linkedEntity.adGroupId'?: string; + /** + * Required. The type of YouTube asset associated with the resource. + */ + youtubeAssetType?: string; /** * Request body metadata */ - requestBody?: Schema$AssignedTargetingOption; + requestBody?: Schema$YoutubeAssetAssociation; } - export interface Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete + export interface Params$Resource$Advertisers$Lineitems$Youtubeassettypes$Youtubeassetassociations$Delete extends StandardParameters { /** - * Required. The ID of the advertiser the line item belongs to. + * Required. The ID of the advertiser that the linked entity belongs to. */ advertiserId?: string; /** - * Required. The ID of the assigned targeting option to delete. - */ - assignedTargetingOptionId?: string; - /** - * Required. The ID of the line item the assigned targeting option belongs to. + * The ID of a line item. */ lineItemId?: string; /** - * Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` - */ - targetingType?: string; - } - export interface Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get - extends StandardParameters { - /** - * Required. The ID of the advertiser the line item belongs to. - */ - advertiserId?: string; - /** - * Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested. + * The ID of an ad group. */ - assignedTargetingOptionId?: string; + 'linkedEntity.adGroupId'?: string; /** - * Required. The ID of the line item the assigned targeting option belongs to. + * Required. The ID of the YouTube asset in the association. For `YOUTUBE_ASSET_TYPE_LOCATION` and `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION` associations: This should be the ID of the asset set linked, or 0 if the location_asset_filter or affiliate_location_asset_filter is `DISABLED`. For `YOUTUBE_ASSET_TYPE_SITELINK` associations: This should be the ID of the sitelink asset linked. */ - lineItemId?: string; + youtubeAssetAssociationId?: string; /** - * Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_INVENTORY_MODE` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) + * Required. The type of YouTube asset associated with the resource. */ - targetingType?: string; + youtubeAssetType?: string; } - export interface Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List + export interface Params$Resource$Advertisers$Lineitems$Youtubeassettypes$Youtubeassetassociations$List extends StandardParameters { /** - * Required. The ID of the advertiser the line item belongs to. + * Required. The ID of the advertiser that the linked entity belongs to. */ advertiserId?: string; /** - * Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + * The ID of a line item. */ - filter?: string; + lineItemId?: string; /** - * Required. The ID of the line item to list assigned targeting options for. + * The ID of an ad group. */ - lineItemId?: string; + 'linkedEntity.adGroupId'?: string; /** - * Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`. + * Optional. Field by which to sort the list. The only acceptable values are: * `linkedYoutubeAsset.locationAssetFilter.assetSetId`, * `linkedYoutubeAsset.affiliateLocationAssetFilter.assetSetId`, * `linkedYoutubeAsset.sitelinkAsset.assetId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `linkedYoutubeAsset.sitelinkAsset.assetId desc`. */ orderBy?: string; /** - * Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * Optional. Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. */ pageSize?: number; /** - * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLineItemAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + * Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListYoutubeAssetAssociations` method. If not specified, the first page of results will be returned. */ pageToken?: string; /** - * Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_INVENTORY_MODE` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) + * Required. The type of YouTube asset being associated with the resource. */ - targetingType?: string; + youtubeAssetType?: string; } export class Resource$Advertisers$Locationlists { diff --git a/src/apis/dlp/v2.ts b/src/apis/dlp/v2.ts index 1f6a885e47..e2319bb5cc 100644 --- a/src/apis/dlp/v2.ts +++ b/src/apis/dlp/v2.ts @@ -1503,7 +1503,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2DataSourceType { /** - * Output only. An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket + * An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket */ dataSource?: string | null; } @@ -5527,11 +5527,11 @@ export namespace dlp_v2 { patterns?: Schema$GooglePrivacyDlpV2VertexDatasetRegex[]; } /** - * Identifies a single Vertex AI dataset. + * Identifies a single Vertex AI resource. Currently only datasets are supported. */ export interface Schema$GooglePrivacyDlpV2VertexDatasetResourceReference { /** - * Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + * Required. The name of the Vertex AI resource. If set within a project-level configuration, the specified resource must be within the project. Examples: * `projects/{project\}/locations/{location\}/datasets/{dataset\}` */ datasetResourceName?: string | null; } diff --git a/src/apis/docs/v1.ts b/src/apis/docs/v1.ts index 1499b777b8..f49d367d15 100644 --- a/src/apis/docs/v1.ts +++ b/src/apis/docs/v1.ts @@ -638,11 +638,11 @@ export namespace docs_v1 { */ background?: Schema$Background; /** - * The ID of the default footer. If not set, there's no default footer. This property is read-only. + * The ID of the default footer. If not set, there's no default footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. */ defaultFooterId?: string | null; /** - * The ID of the default header. If not set, there's no default header. This property is read-only. + * The ID of the default header. If not set, there's no default header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. */ defaultHeaderId?: string | null; /** @@ -650,67 +650,67 @@ export namespace docs_v1 { */ documentFormat?: Schema$DocumentFormat; /** - * The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. + * The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. */ evenPageFooterId?: string | null; /** - * The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. + * The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. */ evenPageHeaderId?: string | null; /** - * The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. + * The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. */ firstPageFooterId?: string | null; /** - * The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only. + * The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. */ firstPageHeaderId?: string | null; /** - * Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. + * Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. If DocumentMode is PAGELESS, this property will not be rendered. */ flipPageOrientation?: boolean | null; /** - * The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. + * The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered. */ marginBottom?: Schema$Dimension; /** - * The amount of space between the bottom of the page and the contents of the footer. + * The amount of space between the bottom of the page and the contents of the footer. If DocumentMode is PAGELESS, this property will not be rendered. */ marginFooter?: Schema$Dimension; /** - * The amount of space between the top of the page and the contents of the header. + * The amount of space between the top of the page and the contents of the header. If DocumentMode is PAGELESS, this property will not be rendered. */ marginHeader?: Schema$Dimension; /** - * The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. + * The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered. */ marginLeft?: Schema$Dimension; /** - * The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. + * The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered. */ marginRight?: Schema$Dimension; /** - * The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. + * The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered. */ marginTop?: Schema$Dimension; /** - * The page number from which to start counting the number of pages. + * The page number from which to start counting the number of pages. If DocumentMode is PAGELESS, this property will not be rendered. */ pageNumberStart?: number | null; /** - * The size of a page in the document. + * The size of a page in the document. If DocumentMode is PAGELESS, this property will not be rendered. */ pageSize?: Schema$Size; /** - * Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. This property is read-only. + * Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. */ useCustomHeaderFooterMargins?: boolean | null; /** - * Indicates whether to use the even page header / footer IDs for the even pages. + * Indicates whether to use the even page header / footer IDs for the even pages. If DocumentMode is PAGELESS, this property will not be rendered. */ useEvenPageHeaderFooter?: boolean | null; /** - * Indicates whether to use the first page header / footer IDs for the first page. + * Indicates whether to use the first page header / footer IDs for the first page. If DocumentMode is PAGELESS, this property will not be rendered. */ useFirstPageHeaderFooter?: boolean | null; } @@ -1327,11 +1327,11 @@ export namespace docs_v1 { */ export interface Schema$InsertPersonRequest { /** - * Inserts the person at the end of a header, footer, footnote or the document body. + * Inserts the person mention at the end of a header, footer, footnote or the document body. */ endOfSegmentLocation?: Schema$EndOfSegmentLocation; /** - * Inserts the person at a specific index in the document. The person mention must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). People cannot be inserted inside an equation. + * Inserts the person mention at a specific index in the document. The person mention must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). People cannot be inserted inside an equation. */ location?: Schema$Location; /** @@ -2543,59 +2543,59 @@ export namespace docs_v1 { */ contentDirection?: string | null; /** - * The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. + * The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. */ defaultFooterId?: string | null; /** - * The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. + * The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. */ defaultHeaderId?: string | null; /** - * The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. + * The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. */ evenPageFooterId?: string | null; /** - * The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. + * The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. */ evenPageHeaderId?: string | null; /** - * The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. + * The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. */ firstPageFooterId?: string | null; /** - * The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. + * The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. */ firstPageHeaderId?: string | null; /** - * Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + * Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. */ flipPageOrientation?: boolean | null; /** - * The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + * The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. */ marginBottom?: Schema$Dimension; /** - * The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + * The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. */ marginFooter?: Schema$Dimension; /** - * The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + * The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. */ marginHeader?: Schema$Dimension; /** - * The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + * The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. */ marginLeft?: Schema$Dimension; /** - * The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + * The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. */ marginRight?: Schema$Dimension; /** - * The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + * The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. */ marginTop?: Schema$Dimension; /** - * The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + * The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. */ pageNumberStart?: number | null; /** @@ -2603,7 +2603,7 @@ export namespace docs_v1 { */ sectionType?: string | null; /** - * Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + * Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. */ useFirstPageHeaderFooter?: boolean | null; } diff --git a/src/apis/documentai/v1.ts b/src/apis/documentai/v1.ts index 50b7718b2e..0eb2a98790 100644 --- a/src/apis/documentai/v1.ts +++ b/src/apis/documentai/v1.ts @@ -501,6 +501,123 @@ export namespace documentai_v1 { */ docId?: string | null; } + /** + * The schema defines the output of the processed document by a processor. + */ + export interface Schema$GoogleCloudDocumentaiUiv1beta3DocumentSchema { + /** + * Description of the schema. + */ + description?: string | null; + /** + * Display name to show to users. + */ + displayName?: string | null; + /** + * Entity types of the schema. + */ + entityTypes?: Schema$GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType[]; + /** + * Metadata of the schema. + */ + metadata?: Schema$GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata; + } + /** + * EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. + */ + export interface Schema$GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType { + /** + * The entity type that this type is derived from. For now, one and only one should be set. + */ + baseTypes?: string[] | null; + /** + * The description of the entity type. Could be used to provide more information about the entity type for model calls. + */ + description?: string | null; + /** + * User defined name for the type. + */ + displayName?: string | null; + /** + * Metadata for the entity type. + */ + entityTypeMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata; + /** + * If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is \>10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file. + */ + enumValues?: Schema$GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues; + /** + * Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + */ + name?: string | null; + /** + * Description the nested structure, or composition of an entity. + */ + properties?: Schema$GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty[]; + } + /** + * Defines the a list of enum values. + */ + export interface Schema$GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues { + /** + * The individual values that this enum values type can include. + */ + values?: string[] | null; + } + /** + * Defines properties that can be part of the entity type. + */ + export interface Schema$GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty { + /** + * The description of the property. Could be used to provide more information about the property for model calls. + */ + description?: string | null; + /** + * User defined name for the property. + */ + displayName?: string | null; + /** + * Specifies how the entity's value is obtained. + */ + method?: string | null; + /** + * The name of the property. Follows the same guidelines as the EntityType name. + */ + name?: string | null; + /** + * Occurrence type limits the number of instances an entity type appears in the document. + */ + occurrenceType?: string | null; + /** + * Any additional metadata about the property can be added here. + */ + propertyMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3PropertyMetadata; + /** + * A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field. + */ + valueType?: string | null; + } + /** + * Metadata for global schema behavior. + */ + export interface Schema$GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata { + /** + * If true, on a given page, there can be multiple `document` annotations covering it. + */ + documentAllowMultipleLabels?: boolean | null; + /** + * If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification). + */ + documentSplitter?: boolean | null; + /** + * If set, all the nested entities must be prefixed with the parents. + */ + prefixedNamingOnProperties?: boolean | null; + /** + * If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked. + */ + skipNamingValidation?: boolean | null; + } /** * The long-running operation metadata for the EnableProcessor method. */ @@ -514,6 +631,35 @@ export namespace documentai_v1 { * Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future. */ export interface Schema$GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse {} + /** + * Metadata about an entity type. + */ + export interface Schema$GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata { + /** + * Field tier metadata on the property + */ + fieldTierMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3FieldTierMetadata; + /** + * Human review labeling config on the entity. + */ + humanReviewLabelingMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata; + /** + * Human review config on the entity. + */ + humanReviewMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata; + /** + * Whether the entity type should be considered inactive. + */ + inactive?: boolean | null; + /** + * Schema editability metadata on the entity. + */ + schemaEditabilityMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata; + /** + * Schema inference metadata on the entity. + */ + schemaInferenceMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata; + } /** * Metadata of the EvaluateProcessorVersion method. */ @@ -532,6 +678,76 @@ export namespace documentai_v1 { */ evaluation?: string | null; } + /** + * Evaluation metrics, either in aggregate or about a specific entity. + */ + export interface Schema$GoogleCloudDocumentaiUiv1beta3EvaluationMetrics { + /** + * The calculated f1 score. + */ + f1Score?: number | null; + /** + * The amount of false negatives. + */ + falseNegativesCount?: number | null; + /** + * The amount of false positives. + */ + falsePositivesCount?: number | null; + /** + * The amount of documents with a ground truth occurrence. + */ + groundTruthDocumentCount?: number | null; + /** + * The amount of occurrences in ground truth documents. + */ + groundTruthOccurrencesCount?: number | null; + /** + * The calculated precision. + */ + precision?: number | null; + /** + * The amount of documents with a predicted occurrence. + */ + predictedDocumentCount?: number | null; + /** + * The amount of occurrences in predicted documents. + */ + predictedOccurrencesCount?: number | null; + /** + * The calculated recall. + */ + recall?: number | null; + /** + * The amount of documents that had an occurrence of this label. + */ + totalDocumentsCount?: number | null; + /** + * The amount of true positives. + */ + truePositivesCount?: number | null; + } + /** + * Gives a short summary of an evaluation, and links to the evaluation itself. + */ + export interface Schema$GoogleCloudDocumentaiUiv1beta3EvaluationReference { + /** + * An aggregate of the statistics for the evaluation with fuzzy matching on. + */ + aggregateMetrics?: Schema$GoogleCloudDocumentaiUiv1beta3EvaluationMetrics; + /** + * An aggregate of the statistics for the evaluation with fuzzy matching off. + */ + aggregateMetricsExact?: Schema$GoogleCloudDocumentaiUiv1beta3EvaluationMetrics; + /** + * The resource name of the evaluation. + */ + evaluation?: string | null; + /** + * The resource name of the Long Running Operation for the evaluation. + */ + operation?: string | null; + } /** * Metadata of the batch export documents operation. */ @@ -601,6 +817,59 @@ export namespace documentai_v1 { */ gcsUri?: string | null; } + /** + * Metadata for how this field value is extracted. + */ + export interface Schema$GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata { + /** + * Entity query config. + */ + entityQuery?: Schema$GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery; + /** + * Summary options config. + */ + summaryOptions?: Schema$GoogleCloudDocumentaiUiv1beta3SummaryOptions; + } + /** + * Message for entity query. + */ + export interface Schema$GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery { + /** + * The original entity query inputed by the user. + */ + userEntityQuery?: string | null; + } + /** + * Metadata for the field tier of a property. + */ + export interface Schema$GoogleCloudDocumentaiUiv1beta3FieldTierMetadata { + /** + * Integer that indicates the tier of a property. e.g. Invoice has entities that are classified as tier 1 which is the most important, while tier 2 and tier 3 less so. This attribute can be used to filter schema attributes before running eval. e.g. compute F1 score for only tier 1 entities. If not present this attribute should be inferred as 1. + */ + tierLevel?: number | null; + } + /** + * Metadata for human review labeling config. + */ + export interface Schema$GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata { + /** + * Whether to enable normalization editing. + */ + enableNormalizationEditing?: boolean | null; + } + /** + * Metadata for Human Review config. + */ + export interface Schema$GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata { + /** + * The confidence threshold if human review validation is enabled. + */ + confidenceThreshold?: number | null; + /** + * Whether to enable human review validation. + */ + enableValidation?: boolean | null; + } /** * Metadata of the import document operation. */ @@ -679,860 +948,719 @@ export namespace documentai_v1 { processorVersion?: string | null; } /** - * The metadata proto of `ResyncDataset` method. + * The first-class citizen for Document AI. Each processor defines how to extract structural information from a document. */ - export interface Schema$GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata { + export interface Schema$GoogleCloudDocumentaiUiv1beta3Processor { /** - * The basic metadata of the long-running operation. + * Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project\}/locations/{location\}/schemas/{schema\}/schemaVersions/{schema_version\} */ - commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata; + activeSchemaVersion?: string | null; /** - * The list of dataset resync statuses. Not checked when ResyncDatasetRequest.dataset_documents is specified. + * Output only. The time the processor was created. */ - datasetResyncStatuses?: Schema$GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus[]; + createTime?: string | null; /** - * The list of document resync statuses. The same document could have multiple `individual_document_resync_statuses` if it has multiple inconsistencies. + * The default processor version. */ - individualDocumentResyncStatuses?: Schema$GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus[]; - } - /** - * Resync status against inconsistency types on the dataset level. - */ - export interface Schema$GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus { + defaultProcessorVersion?: string | null; /** - * The type of the inconsistency of the dataset. + * The display name of the processor. */ - datasetInconsistencyType?: string | null; + displayName?: string | null; /** - * The status of resyncing the dataset with regards to the detected inconsistency. Empty if ResyncDatasetRequest.validate_only is `true`. + * The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios. */ - status?: Schema$GoogleRpcStatus; - } - /** - * Resync status for each document per inconsistency type. - */ - export interface Schema$GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus { + kmsKeyName?: string | null; /** - * The document identifier. + * Output only. Immutable. The resource name of the processor. Format: `projects/{project\}/locations/{location\}/processors/{processor\}` */ - documentId?: Schema$GoogleCloudDocumentaiUiv1beta3DocumentId; + name?: string | null; /** - * The type of document inconsistency. + * Output only. Immutable. The http endpoint that can be called to invoke processing. */ - documentInconsistencyType?: string | null; + processEndpoint?: string | null; /** - * The status of resyncing the document with regards to the detected inconsistency. Empty if ResyncDatasetRequest.validate_only is `true`. + * Output only. The processor version aliases. */ - status?: Schema$GoogleRpcStatus; - } - /** - * The response proto of ResyncDataset method. - */ - export interface Schema$GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse {} - /** - * The revision reference specifies which revision on the document to read. - */ - export interface Schema$GoogleCloudDocumentaiUiv1beta3RevisionRef { + processorVersionAliases?: Schema$GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias[]; /** - * Reads the revision generated by the processor version. The format takes the full resource name of processor version. `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` + * Output only. Reserved for future use. */ - latestProcessorVersion?: string | null; + satisfiesPzi?: boolean | null; /** - * Reads the revision by the predefined case. + * Output only. Reserved for future use. */ - revisionCase?: string | null; + satisfiesPzs?: boolean | null; /** - * Reads the revision given by the id. + * Output only. The state of the processor. */ - revisionId?: string | null; - } - /** - * Metadata of the sample documents operation. - */ - export interface Schema$GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata { + state?: string | null; /** - * The basic metadata of the long-running operation. + * The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor types, see FetchProcessorTypes. */ - commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata; + type?: string | null; } /** - * Response of the sample documents operation. + * 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. */ - export interface Schema$GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse { + export interface Schema$GoogleCloudDocumentaiUiv1beta3ProcessorVersion { /** - * The status of sampling documents in test split. + * Output only. The time the processor version was created. */ - sampleTestStatus?: Schema$GoogleRpcStatus; + createTime?: string | null; /** - * The status of sampling documents in training split. + * Output only. Denotes that this `ProcessorVersion` can be deployed and undeployed. */ - sampleTrainingStatus?: Schema$GoogleRpcStatus; + deploymentAllowed?: boolean | null; /** - * The result of the sampling process. + * Output only. If set, information about the eventual deprecation of this version. */ - selectedDocuments?: Schema$GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument[]; - } - export interface Schema$GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument { + deprecationInfo?: Schema$GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo; /** - * An internal identifier for document. + * The display name of the processor version. */ - documentId?: string | null; - } - /** - * The long-running operation metadata for the SetDefaultProcessorVersion method. - */ - export interface Schema$GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata { + displayName?: string | null; /** - * The basic metadata of the long-running operation. + * Output only. The schema of the processor version. Describes the output. */ - commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata; - } - /** - * Response message for the SetDefaultProcessorVersion method. - */ - export interface Schema$GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse {} - /** - * The metadata that represents a processor version being created. - */ - export interface Schema$GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata { + documentSchema?: Schema$GoogleCloudDocumentaiUiv1beta3DocumentSchema; /** - * The basic metadata of the long-running operation. + * Output only. Information about Generative AI model-based processor versions. */ - commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata; + genAiModelInfo?: Schema$GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo; /** - * The test dataset validation information. + * Output only. Denotes that this `ProcessorVersion` is managed by Google. */ - testDatasetValidation?: Schema$GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation; + googleManaged?: boolean | null; /** - * The training dataset validation information. + * Output only. The KMS key name used for encryption. */ - trainingDatasetValidation?: Schema$GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation; - } - /** - * The dataset validation information. This includes any and all errors with documents and the dataset. - */ - export interface Schema$GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation { + kmsKeyName?: string | null; /** - * The total number of dataset errors. + * Output only. The KMS key version with which data is encrypted. */ - datasetErrorCount?: number | null; + kmsKeyVersionName?: string | null; /** - * Error information for the dataset as a whole. A maximum of 10 dataset errors will be returned. A single dataset error is terminal for training. + * Output only. The most recently invoked evaluation for the processor version. */ - datasetErrors?: Schema$GoogleRpcStatus[]; + latestEvaluation?: Schema$GoogleCloudDocumentaiUiv1beta3EvaluationReference; /** - * The total number of document errors. + * Output only. The model type of this processor version. */ - documentErrorCount?: number | null; + modelType?: string | null; /** - * Error information pertaining to specific documents. A maximum of 10 document errors will be returned. Any document with errors will not be used throughout training. + * Identifier. The resource name of the processor version. Format: `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processor_version\}` */ - documentErrors?: Schema$GoogleRpcStatus[]; + name?: string | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; + /** + * The schema of the processor version. Describes the output. + */ + schema?: Schema$GoogleCloudDocumentaiUiv1beta3Schema; + /** + * Output only. The state of the processor version. + */ + state?: string | null; } /** - * The response for TrainProcessorVersion. + * Contains the alias and the aliased resource name of processor version. */ - export interface Schema$GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse { + export interface Schema$GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias { /** - * The resource name of the processor version produced by training. + * The alias in the form of `processor_version` resource name. + */ + alias?: string | null; + /** + * The resource name of aliased processor version. */ processorVersion?: string | null; } /** - * The long-running operation metadata for the UndeployProcessorVersion method. + * Information about the upcoming deprecation of this processor version. */ - export interface Schema$GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata { + export interface Schema$GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo { /** - * The basic metadata of the long-running operation. + * The time at which this processor version will be deprecated. */ - commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata; - } - /** - * Response message for the UndeployProcessorVersion method. - */ - export interface Schema$GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse {} - export interface Schema$GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata { + deprecationTime?: string | null; /** - * The basic metadata of the long-running operation. + * If set, the processor version that will be used as a replacement. */ - commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata; + replacementProcessorVersion?: string | null; } /** - * The long-running operation metadata for updating the human review configuration. + * Information about Generative AI model-based processor versions. */ - export interface Schema$GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata { + export interface Schema$GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo { /** - * The basic metadata of the long-running operation. + * Information for a custom Generative AI model created by the user. */ - commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata; - } - /** - * The long-running operation metadata for UpdateLabelerPool. - */ - export interface Schema$GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata { + customGenAiModelInfo?: Schema$GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo; /** - * The basic metadata of the long-running operation. + * Information for a pretrained Google-managed foundation model. */ - commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata; + foundationGenAiModelInfo?: Schema$GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo; } /** - * Encodes the detailed information of a barcode. + * Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs. */ - export interface Schema$GoogleCloudDocumentaiV1Barcode { - /** - * Format of a barcode. The supported formats are: - `CODE_128`: Code 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - `DATABAR`: GS1 DataBar code type. - */ - format?: string | null; + export interface Schema$GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo { /** - * Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. + * The base processor version ID for the custom model. */ - rawValue?: string | null; + baseProcessorVersionId?: string | null; /** - * Value format describes the format of the value that a barcode encodes. The supported formats are: - `CONTACT_INFO`: Contact information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar event. - `DRIVER_LICENSE`: Driver's license. + * The type of custom model created by the user. */ - valueFormat?: string | null; + customModelType?: string | null; } /** - * The common config to specify a set of documents used as input. + * Information for a pretrained Google-managed foundation model. */ - export interface Schema$GoogleCloudDocumentaiV1BatchDocumentsInputConfig { + export interface Schema$GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo { /** - * The set of documents individually specified on Cloud Storage. + * Whether finetuning is allowed for this base processor version. */ - gcsDocuments?: Schema$GoogleCloudDocumentaiV1GcsDocuments; + finetuningAllowed?: boolean | null; /** - * The set of documents that match the specified Cloud Storage `gcs_prefix`. + * The minimum number of labeled documents in the training dataset required for finetuning. */ - gcsPrefix?: Schema$GoogleCloudDocumentaiV1GcsPrefix; + minTrainLabeledDocuments?: number | null; } /** - * The long-running operation metadata for BatchProcessDocuments. + * Metadata about a property. */ - export interface Schema$GoogleCloudDocumentaiV1BatchProcessMetadata { + export interface Schema$GoogleCloudDocumentaiUiv1beta3PropertyMetadata { /** - * The creation time of the operation. + * Field extraction metadata on the property. */ - createTime?: string | null; + fieldExtractionMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata; /** - * The list of response details of each document. + * Field tier metadata on the property */ - individualProcessStatuses?: Schema$GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus[]; + fieldTierMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3FieldTierMetadata; /** - * The state of the current batch processing. + * Human review labeling config on the property. */ - state?: string | null; + humanReviewLabelingMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata; /** - * A message providing more details about the current state of processing. For example, the error message if the operation is failed. + * Human review validation config on the property. */ - stateMessage?: string | null; + humanReviewMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata; /** - * The last update time of the operation. + * Whether the property should be considered as "inactive". */ - updateTime?: string | null; + inactive?: boolean | null; + /** + * Schema editability metadata on the property. + */ + schemaEditabilityMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata; + /** + * Schema inference metadata on the property. + */ + schemaInferenceMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata; } /** - * The status of a each individual document in the batch process. + * The metadata proto of `ResyncDataset` method. */ - export interface Schema$GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus { - /** - * The status of human review on the processed document. - */ - humanReviewStatus?: Schema$GoogleCloudDocumentaiV1HumanReviewStatus; + export interface Schema$GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata { /** - * The source of the document, same as the input_gcs_source field in the request when the batch process started. + * The basic metadata of the long-running operation. */ - inputGcsSource?: string | null; + commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata; /** - * The Cloud Storage output destination (in the request as DocumentOutputConfig.GcsOutputConfig.gcs_uri) of the processed document if it was successful, otherwise empty. + * The list of dataset resync statuses. Not checked when ResyncDatasetRequest.dataset_documents is specified. */ - outputGcsDestination?: string | null; + datasetResyncStatuses?: Schema$GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus[]; /** - * The status processing the document. + * The list of document resync statuses. The same document could have multiple `individual_document_resync_statuses` if it has multiple inconsistencies. */ - status?: Schema$GoogleRpcStatus; + individualDocumentResyncStatuses?: Schema$GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus[]; } /** - * Request message for BatchProcessDocuments. + * Resync status against inconsistency types on the dataset level. */ - export interface Schema$GoogleCloudDocumentaiV1BatchProcessRequest { + export interface Schema$GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus { /** - * The output configuration for the BatchProcessDocuments method. + * The type of the inconsistency of the dataset. */ - documentOutputConfig?: Schema$GoogleCloudDocumentaiV1DocumentOutputConfig; + datasetInconsistencyType?: string | null; /** - * The input documents for the BatchProcessDocuments method. + * The status of resyncing the dataset with regards to the detected inconsistency. Empty if ResyncDatasetRequest.validate_only is `true`. */ - inputDocuments?: Schema$GoogleCloudDocumentaiV1BatchDocumentsInputConfig; + status?: Schema$GoogleRpcStatus; + } + /** + * Resync status for each document per inconsistency type. + */ + export interface Schema$GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus { /** - * Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. + * The document identifier. */ - labels?: {[key: string]: string} | null; + documentId?: Schema$GoogleCloudDocumentaiUiv1beta3DocumentId; /** - * Inference-time options for the process API + * The type of document inconsistency. */ - processOptions?: Schema$GoogleCloudDocumentaiV1ProcessOptions; + documentInconsistencyType?: string | null; /** - * Whether human review should be skipped for this request. Default to `false`. + * The status of resyncing the document with regards to the detected inconsistency. Empty if ResyncDatasetRequest.validate_only is `true`. */ - skipHumanReview?: boolean | null; + status?: Schema$GoogleRpcStatus; } /** - * Response message for BatchProcessDocuments. + * The response proto of ResyncDataset method. */ - export interface Schema$GoogleCloudDocumentaiV1BatchProcessResponse {} - export interface Schema$GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata { + export interface Schema$GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse {} + /** + * The revision reference specifies which revision on the document to read. + */ + export interface Schema$GoogleCloudDocumentaiUiv1beta3RevisionRef { /** - * The basic metadata of the long-running operation. + * Reads the revision generated by the processor version. The format takes the full resource name of processor version. `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; + latestProcessorVersion?: string | null; /** - * Total number of documents that failed to be deleted in storage. + * Reads the revision by the predefined case. */ - errorDocumentCount?: number | null; + revisionCase?: string | null; /** - * The list of response details of each document. - */ - individualBatchDeleteStatuses?: Schema$GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus[]; - /** - * Total number of documents deleting from dataset. + * Reads the revision given by the id. */ - totalDocumentCount?: number | null; + revisionId?: string | null; } /** - * The status of each individual document in the batch delete process. + * Metadata of the sample documents operation. */ - export interface Schema$GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus { - /** - * The document id of the document. - */ - documentId?: Schema$GoogleCloudDocumentaiV1beta3DocumentId; + export interface Schema$GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata { /** - * The status of deleting the document in storage. + * The basic metadata of the long-running operation. */ - status?: Schema$GoogleRpcStatus; + commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata; } /** - * Response of the delete documents operation. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse {} - /** - * The long-running operation metadata for BatchProcessDocuments. + * Response of the sample documents operation. */ - export interface Schema$GoogleCloudDocumentaiV1beta3BatchProcessMetadata { - /** - * The creation time of the operation. - */ - createTime?: string | null; + export interface Schema$GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse { /** - * The list of response details of each document. + * The status of sampling documents in test split. */ - individualProcessStatuses?: Schema$GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus[]; + sampleTestStatus?: Schema$GoogleRpcStatus; /** - * The state of the current batch processing. + * The status of sampling documents in training split. */ - state?: string | null; + sampleTrainingStatus?: Schema$GoogleRpcStatus; /** - * A message providing more details about the current state of processing. For example, the error message if the operation is failed. + * The result of the sampling process. */ - stateMessage?: string | null; + selectedDocuments?: Schema$GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument[]; + } + export interface Schema$GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument { /** - * The last update time of the operation. + * An internal identifier for document. */ - updateTime?: string | null; + documentId?: string | null; } /** - * The status of a each individual document in the batch process. + * The schema defines the output of the processed document by a processor. */ - export interface Schema$GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus { - /** - * The name of the operation triggered by the processed document. If the human review process isn't triggered, this field will be empty. It has the same response type and metadata as the long-running operation returned by the ReviewDocument method. - */ - humanReviewOperation?: string | null; - /** - * The status of human review on the processed document. - */ - humanReviewStatus?: Schema$GoogleCloudDocumentaiV1beta3HumanReviewStatus; + export interface Schema$GoogleCloudDocumentaiUiv1beta3Schema { /** - * The source of the document, same as the input_gcs_source field in the request when the batch process started. + * Description of the schema. */ - inputGcsSource?: string | null; + description?: string | null; /** - * The Cloud Storage output destination (in the request as DocumentOutputConfig.GcsOutputConfig.gcs_uri) of the processed document if it was successful, otherwise empty. + * Display name to show to users. */ - outputGcsDestination?: string | null; + displayName?: string | null; /** - * The status processing the document. + * Entity types of the schema. */ - status?: Schema$GoogleRpcStatus; + entityTypes?: Schema$GoogleCloudDocumentaiUiv1beta3SchemaEntityType[]; } /** - * Response message for BatchProcessDocuments. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3BatchProcessResponse {} - /** - * The common metadata for long running operations. + * Metadata that specifies whether a label is editable and reasons why. These fields are read-only. Changing these fields has no impact on the backend. */ - export interface Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata { - /** - * The creation time of the operation. - */ - createTime?: string | null; - /** - * A related resource to this operation. - */ - resource?: string | null; - /** - * The state of the operation. - */ - state?: string | null; + export interface Schema$GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata { /** - * A message providing more details about the current state of processing. + * Explicit flag that controls whether the label is editable. */ - stateMessage?: string | null; + editable?: boolean | null; /** - * The last update time of the operation. + * Full resource name of processor versions that contain this label. e.g. `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` */ - updateTime?: string | null; + processorVersions?: string[] | null; } /** - * A singleton resource under a Processor which configures a collection of documents. + * EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. */ - export interface Schema$GoogleCloudDocumentaiV1beta3Dataset { + export interface Schema$GoogleCloudDocumentaiUiv1beta3SchemaEntityType { + baseType?: string | null; /** - * Optional. Deprecated. Warehouse-based dataset configuration is not supported. + * Description of the entity type. */ - documentWarehouseConfig?: Schema$GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig; + description?: string | null; /** - * Optional. User-managed Cloud Storage dataset configuration. Use this configuration if the dataset documents are stored under a user-managed Cloud Storage location. + * If specified, lists all the possible values for this entity. */ - gcsManagedConfig?: Schema$GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig; + enumValues?: string[] | null; /** - * Dataset resource name. Format: `projects/{project\}/locations/{location\}/processors/{processor\}/dataset` + * If the entity type is hidden in the schema. This provides the functionality to temporally "disable" an entity without deleting it. */ - name?: string | null; + hide?: boolean | null; /** - * Output only. Reserved for future use. + * Specifies how the entity's value is obtained. */ - satisfiesPzi?: boolean | null; + method?: string | null; /** - * Output only. Reserved for future use. + * Occurrence type limits the number of times an entity type appears in the document. */ - satisfiesPzs?: boolean | null; + occurrenceType?: string | null; /** - * Optional. A lightweight indexing source with low latency and high reliability, but lacking advanced features like CMEK and content-based search. + * Describing the nested structure of an entity. An EntityType may consist of several other EntityTypes. For example, in a document there can be an EntityType `ID`, which consists of EntityType `name` and `address`, with corresponding attributes, such as TEXT for both types and ONCE for occurrence types. */ - spannerIndexingConfig?: Schema$GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig; + properties?: Schema$GoogleCloudDocumentaiUiv1beta3SchemaEntityType[]; /** - * Required. State of the dataset. Ignored when updating dataset. + * Source of this entity type. */ - state?: string | null; + source?: string | null; /** - * Optional. Unmanaged dataset configuration. Use this configuration if the dataset documents are managed by the document service internally (not user-managed). + * Name of the type. It must satisfy the following constraints: 1. Must be unique within the set of same level types (with case-insensitive match). 2. Maximum 64 characters. 3. Must start with a letter. 4. Allowed characters: ASCII letters [a-zA-Z], ASCII digits [0-9], or one of the following punctuation characters: * underscore '_' (recommended) * hyphen '-' (allowed, not recommended) * colon ':' (allowed, not recommended) NOTE: Whitespace characters are not allowed. 5. Cannot end with a punctuation character. 6. Cannot contain the following restricted strings: "google", "DocumentAI" (case-insensitive match). 7. A slash character '/' is reserved as a separator in flattened representations of nested entity types (e.g., "line_item/amount") in which case each part (e.g., "line_item", "amount") must comply with the rules defined above. We recommend using the snake case ("snake_case") in entity type names. */ - unmanagedDatasetConfig?: Schema$GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig; + type?: string | null; } /** - * Configuration specific to the Document AI Warehouse-based implementation. + * Metadata for schema inference. Only used on dataset.schema for schema inference, can be safely ignored elsewhere. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig { + export interface Schema$GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata { /** - * Output only. The collection in Document AI Warehouse associated with the dataset. - */ - collection?: string | null; - /** - * Output only. The schema in Document AI Warehouse associated with the dataset. + * True if is inferred by schema inference. */ - schema?: string | null; + inferred?: boolean | null; } /** - * Configuration specific to the Cloud Storage-based implementation. + * The long-running operation metadata for the SetDefaultProcessorVersion method. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig { + export interface Schema$GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata { /** - * Required. The Cloud Storage URI (a directory) where the documents belonging to the dataset must be stored. + * The basic metadata of the long-running operation. */ - gcsPrefix?: Schema$GoogleCloudDocumentaiV1beta3GcsPrefix; + commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata; } /** - * Configuration specific to spanner-based indexing. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig {} - /** - * Configuration specific to an unmanaged dataset. + * Response message for the SetDefaultProcessorVersion method. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig {} + export interface Schema$GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse {} /** - * The long-running operation metadata for the DeleteProcessor method. + * Metadata for document summarization. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata { + export interface Schema$GoogleCloudDocumentaiUiv1beta3SummaryOptions { /** - * The basic metadata of the long-running operation. + * The format the summary should be in. */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; - } - /** - * The long-running operation metadata for the DeleteProcessorVersion method. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata { + format?: string | null; /** - * The basic metadata of the long-running operation. + * How long the summary should be. */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; + length?: string | null; } /** - * The long-running operation metadata for the DeployProcessorVersion method. + * The metadata that represents a processor version being created. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata { + export interface Schema$GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata { /** * The basic metadata of the long-running operation. */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; - } - /** - * Response message for the DeployProcessorVersion method. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse {} - /** - * The long-running operation metadata for the DisableProcessor method. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3DisableProcessorMetadata { + commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata; /** - * The basic metadata of the long-running operation. + * The test dataset validation information. */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; + testDatasetValidation?: Schema$GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation; + /** + * The training dataset validation information. + */ + trainingDatasetValidation?: Schema$GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation; } /** - * Response message for the DisableProcessor method. Intentionally empty proto for adding fields in future. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3DisableProcessorResponse {} - /** - * Document Identifier. + * The dataset validation information. This includes any and all errors with documents and the dataset. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentId { + export interface Schema$GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation { /** - * A document id within user-managed Cloud Storage. + * The total number of dataset errors. */ - gcsManagedDocId?: Schema$GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId; + datasetErrorCount?: number | null; /** - * Points to a specific revision of the document if set. + * Error information for the dataset as a whole. A maximum of 10 dataset errors will be returned. A single dataset error is terminal for training. */ - revisionRef?: Schema$GoogleCloudDocumentaiV1beta3RevisionRef; + datasetErrors?: Schema$GoogleRpcStatus[]; /** - * A document id within unmanaged dataset. + * The total number of document errors. */ - unmanagedDocId?: Schema$GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId; + documentErrorCount?: number | null; + /** + * Error information pertaining to specific documents. A maximum of 10 document errors will be returned. Any document with errors will not be used throughout training. + */ + documentErrors?: Schema$GoogleRpcStatus[]; } /** - * Identifies a document uniquely within the scope of a dataset in the user-managed Cloud Storage option. + * The response for TrainProcessorVersion. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId { - /** - * Id of the document (indexed) managed by Content Warehouse. - */ - cwDocId?: string | null; + export interface Schema$GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse { /** - * Required. The Cloud Storage URI where the actual document is stored. + * The resource name of the processor version produced by training. */ - gcsUri?: string | null; + processorVersion?: string | null; } /** - * Identifies a document uniquely within the scope of a dataset in unmanaged option. + * The long-running operation metadata for the UndeployProcessorVersion method. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId { + export interface Schema$GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata { /** - * Required. The id of the document. + * The basic metadata of the long-running operation. */ - docId?: string | null; + commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata; } /** - * The long-running operation metadata for the EnableProcessor method. + * Response message for the UndeployProcessorVersion method. */ - export interface Schema$GoogleCloudDocumentaiV1beta3EnableProcessorMetadata { + export interface Schema$GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse {} + export interface Schema$GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata { /** * The basic metadata of the long-running operation. */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; + commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata; } /** - * Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3EnableProcessorResponse {} - /** - * Metadata of the EvaluateProcessorVersion method. + * The long-running operation metadata for updating the human review configuration. */ - export interface Schema$GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata { + export interface Schema$GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata { /** * The basic metadata of the long-running operation. */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; + commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata; } /** - * Response of the EvaluateProcessorVersion method. + * The long-running operation metadata for UpdateLabelerPool. */ - export interface Schema$GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse { + export interface Schema$GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata { /** - * The resource name of the created evaluation. + * The basic metadata of the long-running operation. */ - evaluation?: string | null; + commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata; } /** - * Specifies all documents on Cloud Storage with a common prefix. + * The long-running operation metadata for the UpdateProcessorVersion method. */ - export interface Schema$GoogleCloudDocumentaiV1beta3GcsPrefix { + export interface Schema$GoogleCloudDocumentaiUiv1beta3UpdateProcessorVersionMetadata { /** - * The URI prefix. + * The basic metadata for the long-running operation. */ - gcsUriPrefix?: string | null; + commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata; } /** - * The status of human review on a processed document. + * Encodes the detailed information of a barcode. */ - export interface Schema$GoogleCloudDocumentaiV1beta3HumanReviewStatus { + export interface Schema$GoogleCloudDocumentaiV1Barcode { /** - * The name of the operation triggered by the processed document. This field is populated only when the state is `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as the long-running operation returned by ReviewDocument. + * Format of a barcode. The supported formats are: - `CODE_128`: Code 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - `DATABAR`: GS1 DataBar code type. */ - humanReviewOperation?: string | null; + format?: string | null; /** - * The state of human review on the processing request. + * Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. */ - state?: string | null; + rawValue?: string | null; /** - * A message providing more details about the human review state. + * Value format describes the format of the value that a barcode encodes. The supported formats are: - `CONTACT_INFO`: Contact information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar event. - `DRIVER_LICENSE`: Driver's license. */ - stateMessage?: string | null; + valueFormat?: string | null; } /** - * Metadata of the import document operation. + * The common config to specify a set of documents used as input. */ - export interface Schema$GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata { - /** - * The basic metadata of the long-running operation. - */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; - /** - * Validation statuses of the batch documents import config. - */ - importConfigValidationResults?: Schema$GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult[]; + export interface Schema$GoogleCloudDocumentaiV1BatchDocumentsInputConfig { /** - * The list of response details of each document. + * The set of documents individually specified on Cloud Storage. */ - individualImportStatuses?: Schema$GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus[]; + gcsDocuments?: Schema$GoogleCloudDocumentaiV1GcsDocuments; /** - * Total number of the documents that are qualified for importing. + * The set of documents that match the specified Cloud Storage `gcs_prefix`. */ - totalDocumentCount?: number | null; + gcsPrefix?: Schema$GoogleCloudDocumentaiV1GcsPrefix; } /** - * The validation status of each import config. Status is set to an error if there are no documents to import in the `import_config`, or `OK` if the operation will try to proceed with at least one document. + * The long-running operation metadata for BatchProcessDocuments. */ - export interface Schema$GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult { + export interface Schema$GoogleCloudDocumentaiV1BatchProcessMetadata { /** - * The source Cloud Storage URI specified in the import config. + * The creation time of the operation. */ - inputGcsSource?: string | null; + createTime?: string | null; /** - * The validation status of import config. + * The list of response details of each document. */ - status?: Schema$GoogleRpcStatus; - } - /** - * The status of each individual document in the import process. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus { + individualProcessStatuses?: Schema$GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus[]; /** - * The source Cloud Storage URI of the document. + * The state of the current batch processing. */ - inputGcsSource?: string | null; + state?: string | null; /** - * The document id of imported document if it was successful, otherwise empty. + * A message providing more details about the current state of processing. For example, the error message if the operation is failed. */ - outputDocumentId?: Schema$GoogleCloudDocumentaiV1beta3DocumentId; + stateMessage?: string | null; /** - * The status of the importing of the document. + * The last update time of the operation. */ - status?: Schema$GoogleRpcStatus; + updateTime?: string | null; } /** - * Response of the import document operation. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3ImportDocumentsResponse {} - /** - * The long-running operation metadata for the ImportProcessorVersion method. + * The status of a each individual document in the batch process. */ - export interface Schema$GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata { + export interface Schema$GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus { /** - * The basic metadata for the long-running operation. + * The status of human review on the processed document. */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; - } - /** - * The response message for the ImportProcessorVersion method. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse { + humanReviewStatus?: Schema$GoogleCloudDocumentaiV1HumanReviewStatus; /** - * The destination processor version name. + * The source of the document, same as the input_gcs_source field in the request when the batch process started. */ - processorVersion?: string | null; + inputGcsSource?: string | null; + /** + * The Cloud Storage output destination (in the request as DocumentOutputConfig.GcsOutputConfig.gcs_uri) of the processed document if it was successful, otherwise empty. + */ + outputGcsDestination?: string | null; + /** + * The status processing the document. + */ + status?: Schema$GoogleRpcStatus; } /** - * The long-running operation metadata for the ReviewDocument method. + * Request message for BatchProcessDocuments. */ - export interface Schema$GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata { - /** - * The basic metadata of the long-running operation. - */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; + export interface Schema$GoogleCloudDocumentaiV1BatchProcessRequest { /** - * The creation time of the operation. + * The output configuration for the BatchProcessDocuments method. */ - createTime?: string | null; + documentOutputConfig?: Schema$GoogleCloudDocumentaiV1DocumentOutputConfig; /** - * The Crowd Compute question ID. + * The input documents for the BatchProcessDocuments method. */ - questionId?: string | null; + inputDocuments?: Schema$GoogleCloudDocumentaiV1BatchDocumentsInputConfig; /** - * Used only when Operation.done is false. + * Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. */ - state?: string | null; + labels?: {[key: string]: string} | null; /** - * A message providing more details about the current state of processing. For example, the error message if the operation is failed. + * Inference-time options for the process API */ - stateMessage?: string | null; + processOptions?: Schema$GoogleCloudDocumentaiV1ProcessOptions; /** - * The last update time of the operation. + * Whether human review should be skipped for this request. Default to `false`. */ - updateTime?: string | null; + skipHumanReview?: boolean | null; } /** - * Response message for the ReviewDocument method. + * Response message for BatchProcessDocuments. */ - export interface Schema$GoogleCloudDocumentaiV1beta3ReviewDocumentResponse { - /** - * The Cloud Storage uri for the human reviewed document if the review is succeeded. - */ - gcsDestination?: string | null; - /** - * The reason why the review is rejected by reviewer. - */ - rejectionReason?: string | null; + export interface Schema$GoogleCloudDocumentaiV1BatchProcessResponse {} + export interface Schema$GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata { /** - * The state of the review operation. + * The basic metadata of the long-running operation. */ - state?: string | null; - } - /** - * The revision reference specifies which revision on the document to read. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3RevisionRef { + commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; /** - * Reads the revision generated by the processor version. The format takes the full resource name of processor version. `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` + * Total number of documents that failed to be deleted in storage. */ - latestProcessorVersion?: string | null; + errorDocumentCount?: number | null; /** - * Reads the revision by the predefined case. + * The list of response details of each document. */ - revisionCase?: string | null; + individualBatchDeleteStatuses?: Schema$GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus[]; /** - * Reads the revision given by the id. + * Total number of documents deleting from dataset. */ - revisionId?: string | null; + totalDocumentCount?: number | null; } /** - * The long-running operation metadata for the SetDefaultProcessorVersion method. + * The status of each individual document in the batch delete process. */ - export interface Schema$GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata { + export interface Schema$GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus { /** - * The basic metadata of the long-running operation. + * The document id of the document. */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; + documentId?: Schema$GoogleCloudDocumentaiV1beta3DocumentId; + /** + * The status of deleting the document in storage. + */ + status?: Schema$GoogleRpcStatus; } /** - * Response message for the SetDefaultProcessorVersion method. + * Response of the delete documents operation. */ - export interface Schema$GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse {} + export interface Schema$GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse {} /** - * The metadata that represents a processor version being created. + * The long-running operation metadata for BatchProcessDocuments. */ - export interface Schema$GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata { - /** - * The basic metadata of the long-running operation. - */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; - /** - * The test dataset validation information. - */ - testDatasetValidation?: Schema$GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation; + export interface Schema$GoogleCloudDocumentaiV1beta3BatchProcessMetadata { /** - * The training dataset validation information. + * The creation time of the operation. */ - trainingDatasetValidation?: Schema$GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation; - } - /** - * The dataset validation information. This includes any and all errors with documents and the dataset. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation { + createTime?: string | null; /** - * The total number of dataset errors. + * The list of response details of each document. */ - datasetErrorCount?: number | null; + individualProcessStatuses?: Schema$GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus[]; /** - * Error information for the dataset as a whole. A maximum of 10 dataset errors will be returned. A single dataset error is terminal for training. + * The state of the current batch processing. */ - datasetErrors?: Schema$GoogleRpcStatus[]; + state?: string | null; /** - * The total number of document errors. + * A message providing more details about the current state of processing. For example, the error message if the operation is failed. */ - documentErrorCount?: number | null; + stateMessage?: string | null; /** - * Error information pertaining to specific documents. A maximum of 10 document errors will be returned. Any document with errors will not be used throughout training. + * The last update time of the operation. */ - documentErrors?: Schema$GoogleRpcStatus[]; + updateTime?: string | null; } /** - * The response for TrainProcessorVersion. + * The status of a each individual document in the batch process. */ - export interface Schema$GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse { + export interface Schema$GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus { /** - * The resource name of the processor version produced by training. + * The name of the operation triggered by the processed document. If the human review process isn't triggered, this field will be empty. It has the same response type and metadata as the long-running operation returned by the ReviewDocument method. */ - processorVersion?: string | null; - } - /** - * The long-running operation metadata for the UndeployProcessorVersion method. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata { + humanReviewOperation?: string | null; /** - * The basic metadata of the long-running operation. + * The status of human review on the processed document. */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; - } - /** - * Response message for the UndeployProcessorVersion method. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse {} - export interface Schema$GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata { + humanReviewStatus?: Schema$GoogleCloudDocumentaiV1beta3HumanReviewStatus; /** - * The basic metadata of the long-running operation. + * The source of the document, same as the input_gcs_source field in the request when the batch process started. */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; - } - /** - * A bounding polygon for the detected image annotation. - */ - export interface Schema$GoogleCloudDocumentaiV1BoundingPoly { + inputGcsSource?: string | null; /** - * The bounding polygon normalized vertices. + * The Cloud Storage output destination (in the request as DocumentOutputConfig.GcsOutputConfig.gcs_uri) of the processed document if it was successful, otherwise empty. */ - normalizedVertices?: Schema$GoogleCloudDocumentaiV1NormalizedVertex[]; + outputGcsDestination?: string | null; /** - * The bounding polygon vertices. + * The status processing the document. */ - vertices?: Schema$GoogleCloudDocumentaiV1Vertex[]; + status?: Schema$GoogleRpcStatus; } + /** + * Response message for BatchProcessDocuments. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3BatchProcessResponse {} /** * The common metadata for long running operations. */ - export interface Schema$GoogleCloudDocumentaiV1CommonOperationMetadata { + export interface Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata { /** * The creation time of the operation. */ @@ -1555,2588 +1683,5276 @@ export namespace documentai_v1 { updateTime?: string | null; } /** - * The long-running operation metadata for the DeleteProcessor method. + * A singleton resource under a Processor which configures a collection of documents. */ - export interface Schema$GoogleCloudDocumentaiV1DeleteProcessorMetadata { + export interface Schema$GoogleCloudDocumentaiV1beta3Dataset { /** - * The basic metadata of the long-running operation. + * Optional. Deprecated. Warehouse-based dataset configuration is not supported. */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1CommonOperationMetadata; + documentWarehouseConfig?: Schema$GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig; + /** + * Optional. User-managed Cloud Storage dataset configuration. Use this configuration if the dataset documents are stored under a user-managed Cloud Storage location. + */ + gcsManagedConfig?: Schema$GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig; + /** + * Dataset resource name. Format: `projects/{project\}/locations/{location\}/processors/{processor\}/dataset` + */ + name?: string | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; + /** + * Optional. A lightweight indexing source with low latency and high reliability, but lacking advanced features like CMEK and content-based search. + */ + spannerIndexingConfig?: Schema$GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig; + /** + * Required. State of the dataset. Ignored when updating dataset. + */ + state?: string | null; + /** + * Optional. Unmanaged dataset configuration. Use this configuration if the dataset documents are managed by the document service internally (not user-managed). + */ + unmanagedDatasetConfig?: Schema$GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig; } /** - * The long-running operation metadata for the DeleteProcessorVersion method. + * Configuration specific to the Document AI Warehouse-based implementation. */ - export interface Schema$GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata { + export interface Schema$GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig { + /** + * Output only. The collection in Document AI Warehouse associated with the dataset. + */ + collection?: string | null; + /** + * Output only. The schema in Document AI Warehouse associated with the dataset. + */ + schema?: string | null; + } + /** + * Configuration specific to the Cloud Storage-based implementation. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig { + /** + * Required. The Cloud Storage URI (a directory) where the documents belonging to the dataset must be stored. + */ + gcsPrefix?: Schema$GoogleCloudDocumentaiV1beta3GcsPrefix; + } + /** + * Configuration specific to spanner-based indexing. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig {} + /** + * Configuration specific to an unmanaged dataset. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig {} + /** + * The long-running operation metadata for the DeleteProcessor method. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata { /** * The basic metadata of the long-running operation. */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1CommonOperationMetadata; + commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; } /** - * The long-running operation metadata for the DeployProcessorVersion method. + * The long-running operation metadata for the DeleteProcessorVersion method. */ - export interface Schema$GoogleCloudDocumentaiV1DeployProcessorVersionMetadata { + export interface Schema$GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata { /** * The basic metadata of the long-running operation. */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1CommonOperationMetadata; + commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; } /** - * Request message for the DeployProcessorVersion method. + * The long-running operation metadata for the DeployProcessorVersion method. */ - export interface Schema$GoogleCloudDocumentaiV1DeployProcessorVersionRequest {} + export interface Schema$GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata { + /** + * The basic metadata of the long-running operation. + */ + commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; + } /** * Response message for the DeployProcessorVersion method. */ - export interface Schema$GoogleCloudDocumentaiV1DeployProcessorVersionResponse {} + export interface Schema$GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse {} /** * The long-running operation metadata for the DisableProcessor method. */ - export interface Schema$GoogleCloudDocumentaiV1DisableProcessorMetadata { + export interface Schema$GoogleCloudDocumentaiV1beta3DisableProcessorMetadata { /** * The basic metadata of the long-running operation. */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1CommonOperationMetadata; + commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; } - /** - * Request message for the DisableProcessor method. - */ - export interface Schema$GoogleCloudDocumentaiV1DisableProcessorRequest {} /** * Response message for the DisableProcessor method. Intentionally empty proto for adding fields in future. */ - export interface Schema$GoogleCloudDocumentaiV1DisableProcessorResponse {} + export interface Schema$GoogleCloudDocumentaiV1beta3DisableProcessorResponse {} /** - * Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. + * Document Identifier. */ - export interface Schema$GoogleCloudDocumentaiV1Document { - /** - * Document chunked based on chunking config. - */ - chunkedDocument?: Schema$GoogleCloudDocumentaiV1DocumentChunkedDocument; + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentId { /** - * Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. + * A document id within user-managed Cloud Storage. */ - content?: string | null; + gcsManagedDocId?: Schema$GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId; /** - * Optional. An internal identifier for document. Should be loggable (no PII). + * Points to a specific revision of the document if set. */ - docid?: string | null; + revisionRef?: Schema$GoogleCloudDocumentaiV1beta3RevisionRef; /** - * Parsed layout of the document. + * A document id within unmanaged dataset. */ - documentLayout?: Schema$GoogleCloudDocumentaiV1DocumentDocumentLayout; + unmanagedDocId?: Schema$GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId; + } + /** + * Identifies a document uniquely within the scope of a dataset in the user-managed Cloud Storage option. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId { /** - * A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. + * Id of the document (indexed) managed by Content Warehouse. */ - entities?: Schema$GoogleCloudDocumentaiV1DocumentEntity[]; + cwDocId?: string | null; /** - * The entity revision id that `document.entities` field is based on. If this field is set and `entities_revisions` is not empty, the entities in `document.entities` field are the entities in the entity revision with this id and `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision. + * Required. The Cloud Storage URI where the actual document is stored. */ - entitiesRevisionId?: string | null; + gcsUri?: string | null; + } + /** + * Identifies a document uniquely within the scope of a dataset in unmanaged option. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId { /** - * A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing. + * Required. The id of the document. */ - entitiesRevisions?: Schema$GoogleCloudDocumentaiV1DocumentEntitiesRevision[]; + docId?: string | null; + } + /** + * The schema defines the output of the processed document by a processor. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentSchema { /** - * Placeholder. Relationship among Document.entities. + * Description of the schema. */ - entityRelations?: Schema$GoogleCloudDocumentaiV1DocumentEntityRelation[]; + description?: string | null; /** - * The entity validation output for the document. This is the validation output for `document.entities` field. + * Display name to show to users. */ - entityValidationOutput?: Schema$GoogleCloudDocumentaiV1DocumentEntityValidationOutput; + displayName?: string | null; /** - * Any error that occurred while processing this document. + * Entity types of the schema. */ - error?: Schema$GoogleRpcStatus; + entityTypes?: Schema$GoogleCloudDocumentaiV1beta3DocumentSchemaEntityType[]; /** - * An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). + * Metadata of the schema. */ - mimeType?: string | null; + metadata?: Schema$GoogleCloudDocumentaiV1beta3DocumentSchemaMetadata; + } + /** + * EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentSchemaEntityType { /** - * Visual page layout for the Document. + * The entity type that this type is derived from. For now, one and only one should be set. */ - pages?: Schema$GoogleCloudDocumentaiV1DocumentPage[]; + baseTypes?: string[] | null; /** - * Placeholder. Revision history of this document. + * The description of the entity type. Could be used to provide more information about the entity type for model calls. */ - revisions?: Schema$GoogleCloudDocumentaiV1DocumentRevision[]; + description?: string | null; /** - * Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified. + * User defined name for the type. */ - shardInfo?: Schema$GoogleCloudDocumentaiV1DocumentShardInfo; + displayName?: string | null; /** - * Optional. UTF-8 encoded text in reading order from the document. + * Metadata for the entity type. */ - text?: string | null; + entityTypeMetadata?: Schema$GoogleCloudDocumentaiV1beta3EntityTypeMetadata; /** - * Placeholder. A list of text corrections made to Document.text. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap with each other. + * If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is \>10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file. */ - textChanges?: Schema$GoogleCloudDocumentaiV1DocumentTextChange[]; + enumValues?: Schema$GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues; /** - * Styles for the Document.text. + * Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. */ - textStyles?: Schema$GoogleCloudDocumentaiV1DocumentStyle[]; + name?: string | null; /** - * Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. For more information, refer to [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris). + * Description the nested structure, or composition of an entity. */ - uri?: string | null; + properties?: Schema$GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeProperty[]; } /** - * Represents the chunks that the document is divided into. + * Defines the a list of enum values. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentChunkedDocument { + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues { /** - * List of chunks. + * The individual values that this enum values type can include. */ - chunks?: Schema$GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk[]; + values?: string[] | null; } /** - * Represents a chunk. + * Defines properties that can be part of the entity type. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk { + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeProperty { /** - * ID of the chunk. + * The description of the property. Could be used to provide more information about the property for model calls. */ - chunkId?: string | null; + description?: string | null; /** - * Text content of the chunk. + * User defined name for the property. */ - content?: string | null; + displayName?: string | null; /** - * Page footers associated with the chunk. + * Specifies how the entity's value is obtained. */ - pageFooters?: Schema$GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter[]; + method?: string | null; /** - * Page headers associated with the chunk. + * The name of the property. Follows the same guidelines as the EntityType name. */ - pageHeaders?: Schema$GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader[]; + name?: string | null; /** - * Page span of the chunk. + * Occurrence type limits the number of instances an entity type appears in the document. */ - pageSpan?: Schema$GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan; + occurrenceType?: string | null; /** - * Unused. + * Any additional metadata about the property can be added here. */ - sourceBlockIds?: string[] | null; + propertyMetadata?: Schema$GoogleCloudDocumentaiV1beta3PropertyMetadata; + /** + * A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field. + */ + valueType?: string | null; } /** - * Represents the page footer associated with the chunk. + * Metadata for global schema behavior. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter { + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentSchemaMetadata { /** - * Page span of the footer. + * If true, on a given page, there can be multiple `document` annotations covering it. */ - pageSpan?: Schema$GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan; + documentAllowMultipleLabels?: boolean | null; /** - * Footer in text format. + * If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification). */ - text?: string | null; - } - /** - * Represents the page header associated with the chunk. - */ - export interface Schema$GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader { + documentSplitter?: boolean | null; /** - * Page span of the header. + * If set, all the nested entities must be prefixed with the parents. */ - pageSpan?: Schema$GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan; + prefixedNamingOnProperties?: boolean | null; /** - * Header in text format. + * If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked. */ - text?: string | null; + skipNamingValidation?: boolean | null; } /** - * Represents where the chunk starts and ends in the document. + * The long-running operation metadata for the EnableProcessor method. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan { - /** - * Page where chunk ends in the document. - */ - pageEnd?: number | null; + export interface Schema$GoogleCloudDocumentaiV1beta3EnableProcessorMetadata { /** - * Page where chunk starts in the document. + * The basic metadata of the long-running operation. */ - pageStart?: number | null; + commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; } /** - * Represents the parsed layout of a document as a collection of blocks that the document is divided into. + * Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentDocumentLayout { - /** - * List of blocks in the document. + export interface Schema$GoogleCloudDocumentaiV1beta3EnableProcessorResponse {} + /** + * Metadata about an entity type. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3EntityTypeMetadata { + /** + * Whether the entity type should be considered inactive. */ - blocks?: Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock[]; + inactive?: boolean | null; } /** - * Represents a block. A block could be one of the various types (text, table, list) supported. + * Metadata of the EvaluateProcessorVersion method. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock { + export interface Schema$GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata { /** - * ID of the block. + * The basic metadata of the long-running operation. */ - blockId?: string | null; + commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; + } + /** + * Response of the EvaluateProcessorVersion method. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse { /** - * Identifies the bounding box for the block. + * The resource name of the created evaluation. */ - boundingBox?: Schema$GoogleCloudDocumentaiV1BoundingPoly; + evaluation?: string | null; + } + /** + * Evaluation metrics, either in aggregate or about a specific entity. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3EvaluationMetrics { /** - * Block consisting of list content/structure. + * The calculated f1 score. */ - listBlock?: Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock; + f1Score?: number | null; /** - * Page span of the block. + * The amount of false negatives. */ - pageSpan?: Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan; + falseNegativesCount?: number | null; /** - * Block consisting of table content/structure. + * The amount of false positives. */ - tableBlock?: Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock; + falsePositivesCount?: number | null; /** - * Block consisting of text content. + * The amount of documents with a ground truth occurrence. */ - textBlock?: Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock; + groundTruthDocumentCount?: number | null; + /** + * The amount of occurrences in ground truth documents. + */ + groundTruthOccurrencesCount?: number | null; + /** + * The calculated precision. + */ + precision?: number | null; + /** + * The amount of documents with a predicted occurrence. + */ + predictedDocumentCount?: number | null; + /** + * The amount of occurrences in predicted documents. + */ + predictedOccurrencesCount?: number | null; + /** + * The calculated recall. + */ + recall?: number | null; + /** + * The amount of documents that had an occurrence of this label. + */ + totalDocumentsCount?: number | null; + /** + * The amount of true positives. + */ + truePositivesCount?: number | null; } /** - * Represents a list type block. + * Gives a short summary of an evaluation, and links to the evaluation itself. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock { + export interface Schema$GoogleCloudDocumentaiV1beta3EvaluationReference { /** - * List entries that constitute a list block. + * An aggregate of the statistics for the evaluation with fuzzy matching on. */ - listEntries?: Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry[]; + aggregateMetrics?: Schema$GoogleCloudDocumentaiV1beta3EvaluationMetrics; /** - * Type of the list_entries (if exist). Available options are `ordered` and `unordered`. + * An aggregate of the statistics for the evaluation with fuzzy matching off. */ - type?: string | null; + aggregateMetricsExact?: Schema$GoogleCloudDocumentaiV1beta3EvaluationMetrics; + /** + * The resource name of the evaluation. + */ + evaluation?: string | null; + /** + * The resource name of the Long Running Operation for the evaluation. + */ + operation?: string | null; } /** - * Represents an entry in the list. + * Metadata for how this field value is extracted. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry { + export interface Schema$GoogleCloudDocumentaiV1beta3FieldExtractionMetadata { /** - * A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks. + * Summary options config. */ - blocks?: Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock[]; + summaryOptions?: Schema$GoogleCloudDocumentaiV1beta3SummaryOptions; } /** - * Represents where the block starts and ends in the document. + * Specifies all documents on Cloud Storage with a common prefix. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan { - /** - * Page where block ends in the document. - */ - pageEnd?: number | null; + export interface Schema$GoogleCloudDocumentaiV1beta3GcsPrefix { /** - * Page where block starts in the document. + * The URI prefix. */ - pageStart?: number | null; + gcsUriPrefix?: string | null; } /** - * Represents a table type block. + * The status of human review on a processed document. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock { + export interface Schema$GoogleCloudDocumentaiV1beta3HumanReviewStatus { /** - * Body rows containing main table content. + * The name of the operation triggered by the processed document. This field is populated only when the state is `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as the long-running operation returned by ReviewDocument. */ - bodyRows?: Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow[]; + humanReviewOperation?: string | null; /** - * Table caption/title. + * The state of human review on the processing request. */ - caption?: string | null; + state?: string | null; /** - * Header rows at the top of the table. + * A message providing more details about the human review state. */ - headerRows?: Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow[]; + stateMessage?: string | null; } /** - * Represents a cell in a table row. + * Metadata of the import document operation. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell { + export interface Schema$GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata { /** - * A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks. + * The basic metadata of the long-running operation. */ - blocks?: Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock[]; + commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; /** - * How many columns this cell spans. + * Validation statuses of the batch documents import config. */ - colSpan?: number | null; + importConfigValidationResults?: Schema$GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult[]; /** - * How many rows this cell spans. + * The list of response details of each document. */ - rowSpan?: number | null; + individualImportStatuses?: Schema$GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus[]; + /** + * Total number of the documents that are qualified for importing. + */ + totalDocumentCount?: number | null; } /** - * Represents a row in a table. + * The validation status of each import config. Status is set to an error if there are no documents to import in the `import_config`, or `OK` if the operation will try to proceed with at least one document. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow { + export interface Schema$GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult { /** - * A table row is a list of table cells. + * The source Cloud Storage URI specified in the import config. */ - cells?: Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell[]; + inputGcsSource?: string | null; + /** + * The validation status of import config. + */ + status?: Schema$GoogleRpcStatus; } /** - * Represents a text type block. + * The status of each individual document in the import process. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock { + export interface Schema$GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus { /** - * A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks. + * The source Cloud Storage URI of the document. */ - blocks?: Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock[]; + inputGcsSource?: string | null; /** - * Text content stored in the block. + * The document id of imported document if it was successful, otherwise empty. */ - text?: string | null; + outputDocumentId?: Schema$GoogleCloudDocumentaiV1beta3DocumentId; /** - * Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`. + * The status of the importing of the document. */ - type?: string | null; + status?: Schema$GoogleRpcStatus; } /** - * Entity revision. + * Response of the import document operation. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentEntitiesRevision { - /** - * The entities in this revision. - */ - entities?: Schema$GoogleCloudDocumentaiV1DocumentEntity[]; + export interface Schema$GoogleCloudDocumentaiV1beta3ImportDocumentsResponse {} + /** + * The long-running operation metadata for the ImportProcessorVersion method. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata { /** - * The entity validation output for this revision. + * The basic metadata for the long-running operation. */ - entityValidationOutput?: Schema$GoogleCloudDocumentaiV1DocumentEntityValidationOutput; + commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; + } + /** + * The response message for the ImportProcessorVersion method. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse { /** - * The revision id. + * The destination processor version name. */ - revisionId?: string | null; + processorVersion?: string | null; } /** - * An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. + * The first-class citizen for Document AI. Each processor defines how to extract structural information from a document. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentEntity { + export interface Schema$GoogleCloudDocumentaiV1beta3Processor { /** - * Optional. Confidence of detected Schema entity. Range `[0, 1]`. + * Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project\}/locations/{location\}/schemas/{schema\}/schemaVersions/{schema_version\} */ - confidence?: number | null; + activeSchemaVersion?: string | null; /** - * Optional. Canonical id. This will be a unique value in the entity list for this document. + * Output only. The time the processor was created. */ - id?: string | null; + createTime?: string | null; /** - * Optional. Deprecated. Use `id` field instead. + * The default processor version. */ - mentionId?: string | null; + defaultProcessorVersion?: string | null; /** - * Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`. + * The display name of the processor. */ - mentionText?: string | null; + displayName?: string | null; /** - * Optional. Specifies how the entity's value is obtained. + * The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios. */ - method?: string | null; + kmsKeyName?: string | null; /** - * Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types. + * Output only. Immutable. The resource name of the processor. Format: `projects/{project\}/locations/{location\}/processors/{processor\}` */ - normalizedValue?: Schema$GoogleCloudDocumentaiV1DocumentEntityNormalizedValue; + name?: string | null; /** - * Optional. Represents the provenance of this entity wrt. the location on the page where it was found. + * Output only. Immutable. The http endpoint that can be called to invoke processing. */ - pageAnchor?: Schema$GoogleCloudDocumentaiV1DocumentPageAnchor; + processEndpoint?: string | null; /** - * Optional. Entities can be nested to form a hierarchical data structure representing the content in the document. + * Output only. The processor version aliases. */ - properties?: Schema$GoogleCloudDocumentaiV1DocumentEntity[]; + processorVersionAliases?: Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionAlias[]; /** - * Optional. The history of this annotation. + * Output only. Reserved for future use. */ - provenance?: Schema$GoogleCloudDocumentaiV1DocumentProvenance; + satisfiesPzi?: boolean | null; /** - * Optional. Whether the entity will be redacted for de-identification purposes. + * Output only. Reserved for future use. */ - redacted?: boolean | null; + satisfiesPzs?: boolean | null; /** - * Optional. Provenance of the entity. Text anchor indexing into the Document.text. + * Output only. The state of the processor. */ - textAnchor?: Schema$GoogleCloudDocumentaiV1DocumentTextAnchor; + state?: string | null; /** - * Required. Entity type from a schema e.g. `Address`. + * The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor types, see FetchProcessorTypes. */ type?: string | null; } /** - * Parsed and normalized entity value. + * 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. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentEntityNormalizedValue { + export interface Schema$GoogleCloudDocumentaiV1beta3ProcessorVersion { /** - * Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto + * Output only. The time the processor version was created. */ - addressValue?: Schema$GoogleTypePostalAddress; + createTime?: string | null; /** - * Boolean value. Can be used for entities with binary values, or for checkboxes. + * Output only. If set, information about the eventual deprecation of this version. */ - booleanValue?: boolean | null; + deprecationInfo?: Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionDeprecationInfo; /** - * DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto + * The display name of the processor version. */ - datetimeValue?: Schema$GoogleTypeDateTime; + displayName?: string | null; /** - * Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto + * Output only. The schema of the processor version. Describes the output. */ - dateValue?: Schema$GoogleTypeDate; + documentSchema?: Schema$GoogleCloudDocumentaiV1beta3DocumentSchema; /** - * Float value. + * Output only. Information about Generative AI model-based processor versions. */ - floatValue?: number | null; + genAiModelInfo?: Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo; /** - * Integer value. + * Output only. Denotes that this `ProcessorVersion` is managed by Google. */ - integerValue?: number | null; + googleManaged?: boolean | null; /** - * Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto + * Output only. The KMS key name used for encryption. */ - moneyValue?: Schema$GoogleTypeMoney; + kmsKeyName?: string | null; /** - * A signature - a graphical representation of a person's name, often used to sign a document. + * Output only. The KMS key version with which data is encrypted. */ - signatureValue?: boolean | null; + kmsKeyVersionName?: string | null; /** - * Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. + * Output only. The most recently invoked evaluation for the processor version. */ - text?: string | null; - } - /** - * Relationship between Entities. - */ - export interface Schema$GoogleCloudDocumentaiV1DocumentEntityRelation { + latestEvaluation?: Schema$GoogleCloudDocumentaiV1beta3EvaluationReference; /** - * Object entity id. + * Output only. The model type of this processor version. */ - objectId?: string | null; + modelType?: string | null; /** - * Relationship description. + * Identifier. The resource name of the processor version. Format: `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processor_version\}` */ - relation?: string | null; + name?: string | null; /** - * Subject entity id. + * Output only. Reserved for future use. */ - subjectId?: string | null; - } - /** - * The output of the validation given the document and the validation rules. - */ - export interface Schema$GoogleCloudDocumentaiV1DocumentEntityValidationOutput { + satisfiesPzi?: boolean | null; /** - * The overall result of the validation, true if all applicable rules are valid. + * Output only. Reserved for future use. */ - passAllRules?: boolean | null; + satisfiesPzs?: boolean | null; /** - * The result of each validation rule. + * Output only. The state of the processor version. */ - validationResults?: Schema$GoogleCloudDocumentaiV1DocumentEntityValidationOutputValidationResult[]; + state?: string | null; } /** - * Validation result for a single validation rule. + * Contains the alias and the aliased resource name of processor version. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentEntityValidationOutputValidationResult { - /** - * The description of the validation rule. - */ - ruleDescription?: string | null; - /** - * The name of the validation rule. - */ - ruleName?: string | null; + export interface Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionAlias { /** - * The detailed information of the running the validation process using the entity from the document based on the validation rule. + * The alias in the form of `processor_version` resource name. */ - validationDetails?: string | null; + alias?: string | null; /** - * The result of the validation rule. + * The resource name of aliased processor version. */ - validationResultType?: string | null; + processorVersion?: string | null; } /** - * Config that controls the output of documents. All documents will be written as a JSON file. + * Information about the upcoming deprecation of this processor version. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentOutputConfig { + export interface Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionDeprecationInfo { /** - * Output config to write the results to Cloud Storage. + * The time at which this processor version will be deprecated. */ - gcsOutputConfig?: Schema$GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig; + deprecationTime?: string | null; + /** + * If set, the processor version that will be used as a replacement. + */ + replacementProcessorVersion?: string | null; } /** - * The configuration used when outputting documents. + * Information about Generative AI model-based processor versions. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig { + export interface Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo { /** - * Specifies which fields to include in the output documents. Only supports top level document and pages field so it must be in the form of `{document_field_name\}` or `pages.{page_field_name\}`. - */ - fieldMask?: string | null; - /** - * The Cloud Storage uri (a directory) of the output. + * Information for a custom Generative AI model created by the user. */ - gcsUri?: string | null; + customGenAiModelInfo?: Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo; /** - * Specifies the sharding config for the output document. + * Information for a pretrained Google-managed foundation model. */ - shardingConfig?: Schema$GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig; + foundationGenAiModelInfo?: Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo; } /** - * The sharding config for the output document. + * Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig { + export interface Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo { /** - * The number of overlapping pages between consecutive shards. + * The base processor version ID for the custom model. */ - pagesOverlap?: number | null; + baseProcessorVersionId?: string | null; /** - * The number of pages per shard. + * The type of custom model created by the user. */ - pagesPerShard?: number | null; + customModelType?: string | null; } /** - * A page in a Document. + * Information for a pretrained Google-managed foundation model. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentPage { + export interface Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo { /** - * A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation. - */ - blocks?: Schema$GoogleCloudDocumentaiV1DocumentPageBlock[]; - /** - * A list of detected barcodes. + * Whether finetuning is allowed for this base processor version. */ - detectedBarcodes?: Schema$GoogleCloudDocumentaiV1DocumentPageDetectedBarcode[]; + finetuningAllowed?: boolean | null; /** - * A list of detected languages together with confidence. + * The minimum number of labeled documents in the training dataset required for finetuning. */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[]; + minTrainLabeledDocuments?: number | null; + } + /** + * Metadata about a property. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3PropertyMetadata { /** - * Physical dimension of the page. + * Field extraction metadata on the property. */ - dimension?: Schema$GoogleCloudDocumentaiV1DocumentPageDimension; + fieldExtractionMetadata?: Schema$GoogleCloudDocumentaiV1beta3FieldExtractionMetadata; /** - * A list of visually detected form fields on the page. + * Whether the property should be considered as "inactive". */ - formFields?: Schema$GoogleCloudDocumentaiV1DocumentPageFormField[]; + inactive?: boolean | null; + } + /** + * The long-running operation metadata for the ReviewDocument method. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata { /** - * Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned. + * The basic metadata of the long-running operation. */ - image?: Schema$GoogleCloudDocumentaiV1DocumentPageImage; + commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; /** - * Image quality scores. + * The creation time of the operation. */ - imageQualityScores?: Schema$GoogleCloudDocumentaiV1DocumentPageImageQualityScores; + createTime?: string | null; /** - * Layout for the page. + * The Crowd Compute question ID. */ - layout?: Schema$GoogleCloudDocumentaiV1DocumentPageLayout; + questionId?: string | null; /** - * A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line. + * Used only when Operation.done is false. */ - lines?: Schema$GoogleCloudDocumentaiV1DocumentPageLine[]; + state?: string | null; /** - * 1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing. + * A message providing more details about the current state of processing. For example, the error message if the operation is failed. */ - pageNumber?: number | null; + stateMessage?: string | null; /** - * A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph. + * The last update time of the operation. */ - paragraphs?: Schema$GoogleCloudDocumentaiV1DocumentPageParagraph[]; + updateTime?: string | null; + } + /** + * Response message for the ReviewDocument method. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3ReviewDocumentResponse { /** - * The history of this page. + * The Cloud Storage uri for the human reviewed document if the review is succeeded. */ - provenance?: Schema$GoogleCloudDocumentaiV1DocumentProvenance; + gcsDestination?: string | null; /** - * A list of visually detected symbols on the page. + * The reason why the review is rejected by reviewer. */ - symbols?: Schema$GoogleCloudDocumentaiV1DocumentPageSymbol[]; + rejectionReason?: string | null; /** - * A list of visually detected tables on the page. + * The state of the review operation. */ - tables?: Schema$GoogleCloudDocumentaiV1DocumentPageTable[]; + state?: string | null; + } + /** + * The revision reference specifies which revision on the document to read. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3RevisionRef { /** - * A list of visually detected tokens on the page. + * Reads the revision generated by the processor version. The format takes the full resource name of processor version. `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` */ - tokens?: Schema$GoogleCloudDocumentaiV1DocumentPageToken[]; + latestProcessorVersion?: string | null; /** - * Transformation matrices that were applied to the original document image to produce Page.image. + * Reads the revision by the predefined case. */ - transforms?: Schema$GoogleCloudDocumentaiV1DocumentPageMatrix[]; + revisionCase?: string | null; /** - * A list of detected non-text visual elements e.g. checkbox, signature etc. on the page. + * Reads the revision given by the id. */ - visualElements?: Schema$GoogleCloudDocumentaiV1DocumentPageVisualElement[]; + revisionId?: string | null; } /** - * Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. + * The long-running operation metadata for the SetDefaultProcessorVersion method. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentPageAnchor { + export interface Schema$GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata { /** - * One or more references to visual page elements + * The basic metadata of the long-running operation. */ - pageRefs?: Schema$GoogleCloudDocumentaiV1DocumentPageAnchorPageRef[]; + commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; } /** - * Represents a weak reference to a page element within a document. + * Response message for the SetDefaultProcessorVersion method. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentPageAnchorPageRef { + export interface Schema$GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse {} + /** + * Metadata for document summarization. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3SummaryOptions { /** - * Optional. Identifies the bounding polygon of a layout element on the page. If `layout_type` is set, the bounding polygon must be exactly the same to the layout element it's referring to. + * The format the summary should be in. */ - boundingPoly?: Schema$GoogleCloudDocumentaiV1BoundingPoly; + format?: string | null; /** - * Optional. Confidence of detected page element, if applicable. Range `[0, 1]`. + * How long the summary should be. */ - confidence?: number | null; + length?: string | null; + } + /** + * The metadata that represents a processor version being created. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata { /** - * Optional. Deprecated. Use PageRef.bounding_poly instead. + * The basic metadata of the long-running operation. */ - layoutId?: string | null; + commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; /** - * Optional. The type of the layout element that is being referenced if any. + * The test dataset validation information. */ - layoutType?: string | null; + testDatasetValidation?: Schema$GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation; /** - * Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See https://developers.google.com/protocol-buffers/docs/proto3#json. + * The training dataset validation information. */ - page?: string | null; + trainingDatasetValidation?: Schema$GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation; } /** - * A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation. + * The dataset validation information. This includes any and all errors with documents and the dataset. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentPageBlock { + export interface Schema$GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation { /** - * A list of detected languages together with confidence. + * The total number of dataset errors. */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[]; + datasetErrorCount?: number | null; /** - * Layout for Block. + * Error information for the dataset as a whole. A maximum of 10 dataset errors will be returned. A single dataset error is terminal for training. */ - layout?: Schema$GoogleCloudDocumentaiV1DocumentPageLayout; + datasetErrors?: Schema$GoogleRpcStatus[]; /** - * The history of this annotation. + * The total number of document errors. */ - provenance?: Schema$GoogleCloudDocumentaiV1DocumentProvenance; + documentErrorCount?: number | null; + /** + * Error information pertaining to specific documents. A maximum of 10 document errors will be returned. Any document with errors will not be used throughout training. + */ + documentErrors?: Schema$GoogleRpcStatus[]; } /** - * A detected barcode. + * The response for TrainProcessorVersion. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentPageDetectedBarcode { - /** - * Detailed barcode information of the DetectedBarcode. - */ - barcode?: Schema$GoogleCloudDocumentaiV1Barcode; + export interface Schema$GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse { /** - * Layout for DetectedBarcode. + * The resource name of the processor version produced by training. */ - layout?: Schema$GoogleCloudDocumentaiV1DocumentPageLayout; + processorVersion?: string | null; } /** - * Detected language for a structural component. + * The long-running operation metadata for the UndeployProcessorVersion method. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentPageDetectedLanguage { - /** - * Confidence of detected language. Range `[0, 1]`. - */ - confidence?: number | null; + export interface Schema$GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata { /** - * The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`. + * The basic metadata of the long-running operation. */ - languageCode?: string | null; + commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; } /** - * Dimension for the page. + * Response message for the UndeployProcessorVersion method. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentPageDimension { - /** - * Page height. - */ - height?: number | null; - /** - * Dimension unit. - */ - unit?: string | null; + export interface Schema$GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse {} + export interface Schema$GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata { /** - * Page width. + * The basic metadata of the long-running operation. */ - width?: number | null; + commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; } /** - * A form field detected on the page. + * The long-running operation metadata for the UpdateProcessorVersion method. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentPageFormField { + export interface Schema$GoogleCloudDocumentaiV1beta3UpdateProcessorVersionMetadata { /** - * Created for Labeling UI to export key text. If corrections were made to the text identified by the `field_name.text_anchor`, this field will contain the correction. + * The basic metadata for the long-running operation. */ - correctedKeyText?: string | null; + commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; + } + /** + * A bounding polygon for the detected image annotation. + */ + export interface Schema$GoogleCloudDocumentaiV1BoundingPoly { /** - * Created for Labeling UI to export value text. If corrections were made to the text identified by the `field_value.text_anchor`, this field will contain the correction. + * The bounding polygon normalized vertices. */ - correctedValueText?: string | null; + normalizedVertices?: Schema$GoogleCloudDocumentaiV1NormalizedVertex[]; /** - * Layout for the FormField name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc. + * The bounding polygon vertices. */ - fieldName?: Schema$GoogleCloudDocumentaiV1DocumentPageLayout; + vertices?: Schema$GoogleCloudDocumentaiV1Vertex[]; + } + /** + * The common metadata for long running operations. + */ + export interface Schema$GoogleCloudDocumentaiV1CommonOperationMetadata { /** - * Layout for the FormField value. + * The creation time of the operation. */ - fieldValue?: Schema$GoogleCloudDocumentaiV1DocumentPageLayout; + createTime?: string | null; /** - * A list of detected languages for name together with confidence. + * A related resource to this operation. */ - nameDetectedLanguages?: Schema$GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[]; + resource?: string | null; /** - * The history of this annotation. + * The state of the operation. */ - provenance?: Schema$GoogleCloudDocumentaiV1DocumentProvenance; + state?: string | null; /** - * A list of detected languages for value together with confidence. + * A message providing more details about the current state of processing. */ - valueDetectedLanguages?: Schema$GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[]; + stateMessage?: string | null; /** - * If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the `field_value` is normal text) - `unfilled_checkbox` - `filled_checkbox` + * The last update time of the operation. */ - valueType?: string | null; + updateTime?: string | null; } /** - * Rendered image contents for this page. + * The long-running operation metadata for the DeleteProcessor method. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentPageImage { + export interface Schema$GoogleCloudDocumentaiV1DeleteProcessorMetadata { /** - * Raw byte content of the image. + * The basic metadata of the long-running operation. */ - content?: string | null; + commonMetadata?: Schema$GoogleCloudDocumentaiV1CommonOperationMetadata; + } + /** + * The long-running operation metadata for the DeleteProcessorVersion method. + */ + export interface Schema$GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata { /** - * Height of the image in pixels. + * The basic metadata of the long-running operation. */ - height?: number | null; + commonMetadata?: Schema$GoogleCloudDocumentaiV1CommonOperationMetadata; + } + /** + * The long-running operation metadata for the DeployProcessorVersion method. + */ + export interface Schema$GoogleCloudDocumentaiV1DeployProcessorVersionMetadata { /** - * Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image. + * The basic metadata of the long-running operation. */ - mimeType?: string | null; + commonMetadata?: Schema$GoogleCloudDocumentaiV1CommonOperationMetadata; + } + /** + * Request message for the DeployProcessorVersion method. + */ + export interface Schema$GoogleCloudDocumentaiV1DeployProcessorVersionRequest {} + /** + * Response message for the DeployProcessorVersion method. + */ + export interface Schema$GoogleCloudDocumentaiV1DeployProcessorVersionResponse {} + /** + * The long-running operation metadata for the DisableProcessor method. + */ + export interface Schema$GoogleCloudDocumentaiV1DisableProcessorMetadata { /** - * Width of the image in pixels. + * The basic metadata of the long-running operation. */ - width?: number | null; + commonMetadata?: Schema$GoogleCloudDocumentaiV1CommonOperationMetadata; } /** - * Image quality scores for the page image. + * Request message for the DisableProcessor method. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentPageImageQualityScores { + export interface Schema$GoogleCloudDocumentaiV1DisableProcessorRequest {} + /** + * Response message for the DisableProcessor method. Intentionally empty proto for adding fields in future. + */ + export interface Schema$GoogleCloudDocumentaiV1DisableProcessorResponse {} + /** + * Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. + */ + export interface Schema$GoogleCloudDocumentaiV1Document { /** - * A list of detected defects. + * Document chunked based on chunking config. */ - detectedDefects?: Schema$GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect[]; + chunkedDocument?: Schema$GoogleCloudDocumentaiV1DocumentChunkedDocument; /** - * The overall quality score. Range `[0, 1]` where `1` is perfect quality. + * Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. */ - qualityScore?: number | null; - } - /** - * Image Quality Defects - */ - export interface Schema$GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect { + content?: string | null; /** - * Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists. + * Optional. An internal identifier for document. Should be loggable (no PII). */ - confidence?: number | null; + docid?: string | null; /** - * Name of the defect type. Supported values are: - `quality/defect_blurry` - `quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `quality/defect_text_too_small` - `quality/defect_document_cutoff` - `quality/defect_text_cutoff` - `quality/defect_glare` + * Parsed layout of the document. */ - type?: string | null; - } - /** - * Visual element describing a layout unit on a page. - */ - export interface Schema$GoogleCloudDocumentaiV1DocumentPageLayout { + documentLayout?: Schema$GoogleCloudDocumentaiV1DocumentDocumentLayout; /** - * The bounding polygon for the Layout. + * A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. */ - boundingPoly?: Schema$GoogleCloudDocumentaiV1BoundingPoly; + entities?: Schema$GoogleCloudDocumentaiV1DocumentEntity[]; /** - * Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`. + * The entity revision id that `document.entities` field is based on. If this field is set and `entities_revisions` is not empty, the entities in `document.entities` field are the entities in the entity revision with this id and `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision. */ - confidence?: number | null; + entitiesRevisionId?: string | null; /** - * Detected orientation for the Layout. + * A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing. */ - orientation?: string | null; + entitiesRevisions?: Schema$GoogleCloudDocumentaiV1DocumentEntitiesRevision[]; /** - * Text anchor indexing into the Document.text. + * Placeholder. Relationship among Document.entities. */ - textAnchor?: Schema$GoogleCloudDocumentaiV1DocumentTextAnchor; - } - /** - * A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc. - */ - export interface Schema$GoogleCloudDocumentaiV1DocumentPageLine { + entityRelations?: Schema$GoogleCloudDocumentaiV1DocumentEntityRelation[]; /** - * A list of detected languages together with confidence. + * The entity validation output for the document. This is the validation output for `document.entities` field. */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[]; + entityValidationOutput?: Schema$GoogleCloudDocumentaiV1DocumentEntityValidationOutput; /** - * Layout for Line. + * Any error that occurred while processing this document. */ - layout?: Schema$GoogleCloudDocumentaiV1DocumentPageLayout; + error?: Schema$GoogleRpcStatus; /** - * The history of this annotation. + * An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). */ - provenance?: Schema$GoogleCloudDocumentaiV1DocumentProvenance; - } - /** - * Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation. - */ - export interface Schema$GoogleCloudDocumentaiV1DocumentPageMatrix { + mimeType?: string | null; /** - * Number of columns in the matrix. + * Visual page layout for the Document. */ - cols?: number | null; + pages?: Schema$GoogleCloudDocumentaiV1DocumentPage[]; /** - * The matrix data. + * Placeholder. Revision history of this document. */ - data?: string | null; + revisions?: Schema$GoogleCloudDocumentaiV1DocumentRevision[]; /** - * Number of rows in the matrix. + * Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified. */ - rows?: number | null; + shardInfo?: Schema$GoogleCloudDocumentaiV1DocumentShardInfo; /** - * This encodes information about what data type the matrix uses. For example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of OpenCV primitive data types, please refer to https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html + * Optional. UTF-8 encoded text in reading order from the document. */ - type?: number | null; - } - /** - * A collection of lines that a human would perceive as a paragraph. - */ - export interface Schema$GoogleCloudDocumentaiV1DocumentPageParagraph { + text?: string | null; /** - * A list of detected languages together with confidence. + * Placeholder. A list of text corrections made to Document.text. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap with each other. */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[]; + textChanges?: Schema$GoogleCloudDocumentaiV1DocumentTextChange[]; /** - * Layout for Paragraph. + * Styles for the Document.text. */ - layout?: Schema$GoogleCloudDocumentaiV1DocumentPageLayout; + textStyles?: Schema$GoogleCloudDocumentaiV1DocumentStyle[]; /** - * The history of this annotation. + * Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. For more information, refer to [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris). */ - provenance?: Schema$GoogleCloudDocumentaiV1DocumentProvenance; + uri?: string | null; } /** - * A detected symbol. + * Represents the chunks that the document is divided into. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentPageSymbol { - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[]; + export interface Schema$GoogleCloudDocumentaiV1DocumentChunkedDocument { /** - * Layout for Symbol. + * List of chunks. */ - layout?: Schema$GoogleCloudDocumentaiV1DocumentPageLayout; + chunks?: Schema$GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk[]; } /** - * A table representation similar to HTML table structure. + * Represents a chunk. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentPageTable { + export interface Schema$GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk { /** - * Body rows of the table. + * ID of the chunk. */ - bodyRows?: Schema$GoogleCloudDocumentaiV1DocumentPageTableTableRow[]; + chunkId?: string | null; /** - * A list of detected languages together with confidence. + * Text content of the chunk. */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[]; + content?: string | null; /** - * Header rows of the table. + * Page footers associated with the chunk. */ - headerRows?: Schema$GoogleCloudDocumentaiV1DocumentPageTableTableRow[]; + pageFooters?: Schema$GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter[]; /** - * Layout for Table. + * Page headers associated with the chunk. */ - layout?: Schema$GoogleCloudDocumentaiV1DocumentPageLayout; + pageHeaders?: Schema$GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader[]; /** - * The history of this table. + * Page span of the chunk. */ - provenance?: Schema$GoogleCloudDocumentaiV1DocumentProvenance; + pageSpan?: Schema$GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan; + /** + * Unused. + */ + sourceBlockIds?: string[] | null; } /** - * A cell representation inside the table. + * Represents the page footer associated with the chunk. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentPageTableTableCell { - /** - * How many columns this cell spans. - */ - colSpan?: number | null; - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[]; + export interface Schema$GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter { /** - * Layout for TableCell. + * Page span of the footer. */ - layout?: Schema$GoogleCloudDocumentaiV1DocumentPageLayout; + pageSpan?: Schema$GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan; /** - * How many rows this cell spans. + * Footer in text format. */ - rowSpan?: number | null; + text?: string | null; } /** - * A row of table cells. + * Represents the page header associated with the chunk. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentPageTableTableRow { + export interface Schema$GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader { /** - * Cells that make up this row. + * Page span of the header. */ - cells?: Schema$GoogleCloudDocumentaiV1DocumentPageTableTableCell[]; + pageSpan?: Schema$GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan; + /** + * Header in text format. + */ + text?: string | null; } /** - * A detected token. + * Represents where the chunk starts and ends in the document. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentPageToken { - /** - * Detected break at the end of a Token. - */ - detectedBreak?: Schema$GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak; - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[]; - /** - * Layout for Token. - */ - layout?: Schema$GoogleCloudDocumentaiV1DocumentPageLayout; + export interface Schema$GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan { /** - * The history of this annotation. + * Page where chunk ends in the document. */ - provenance?: Schema$GoogleCloudDocumentaiV1DocumentProvenance; + pageEnd?: number | null; /** - * Text style attributes. + * Page where chunk starts in the document. */ - styleInfo?: Schema$GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo; + pageStart?: number | null; } /** - * Detected break at the end of a Token. + * Represents the parsed layout of a document as a collection of blocks that the document is divided into. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak { + export interface Schema$GoogleCloudDocumentaiV1DocumentDocumentLayout { /** - * Detected break type. + * List of blocks in the document. */ - type?: string | null; + blocks?: Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock[]; } /** - * Font and other text style attributes. + * Represents a block. A block could be one of the various types (text, table, list) supported. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo { - /** - * Color of the background. - */ - backgroundColor?: Schema$GoogleTypeColor; + export interface Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock { /** - * Whether the text is bold (equivalent to font_weight is at least `700`). + * ID of the block. */ - bold?: boolean | null; + blockId?: string | null; /** - * Font size in points (`1` point is `¹⁄₇₂` inches). + * Identifies the bounding box for the block. */ - fontSize?: number | null; + boundingBox?: Schema$GoogleCloudDocumentaiV1BoundingPoly; /** - * Name or style of the font. + * Block consisting of list content/structure. */ - fontType?: string | null; + listBlock?: Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock; /** - * TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). Normal is `400`, bold is `700`. + * Page span of the block. */ - fontWeight?: number | null; + pageSpan?: Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan; /** - * Whether the text is handwritten. + * Block consisting of table content/structure. */ - handwritten?: boolean | null; + tableBlock?: Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock; /** - * Whether the text is italic. + * Block consisting of text content. */ - italic?: boolean | null; + textBlock?: Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock; + } + /** + * Represents a list type block. + */ + export interface Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock { /** - * Letter spacing in points. + * List entries that constitute a list block. */ - letterSpacing?: number | null; + listEntries?: Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry[]; /** - * Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ `72.0`. + * Type of the list_entries (if exist). Available options are `ordered` and `unordered`. */ - pixelFontSize?: number | null; + type?: string | null; + } + /** + * Represents an entry in the list. + */ + export interface Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry { /** - * Whether the text is in small caps. This feature is not supported yet. + * A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks. */ - smallcaps?: boolean | null; + blocks?: Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock[]; + } + /** + * Represents where the block starts and ends in the document. + */ + export interface Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan { /** - * Whether the text is strikethrough. This feature is not supported yet. + * Page where block ends in the document. */ - strikeout?: boolean | null; + pageEnd?: number | null; /** - * Whether the text is a subscript. This feature is not supported yet. + * Page where block starts in the document. */ - subscript?: boolean | null; + pageStart?: number | null; + } + /** + * Represents a table type block. + */ + export interface Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock { /** - * Whether the text is a superscript. This feature is not supported yet. + * Body rows containing main table content. */ - superscript?: boolean | null; + bodyRows?: Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow[]; /** - * Color of the text. + * Table caption/title. */ - textColor?: Schema$GoogleTypeColor; + caption?: string | null; /** - * Whether the text is underlined. + * Header rows at the top of the table. */ - underlined?: boolean | null; + headerRows?: Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow[]; } /** - * Detected non-text visual elements e.g. checkbox, signature etc. on the page. + * Represents a cell in a table row. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentPageVisualElement { + export interface Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell { /** - * A list of detected languages together with confidence. + * A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks. */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[]; + blocks?: Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock[]; /** - * Layout for VisualElement. + * How many columns this cell spans. */ - layout?: Schema$GoogleCloudDocumentaiV1DocumentPageLayout; + colSpan?: number | null; /** - * Type of the VisualElement. + * How many rows this cell spans. */ - type?: string | null; + rowSpan?: number | null; } /** - * Structure to identify provenance relationships between annotations in different revisions. + * Represents a row in a table. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentProvenance { + export interface Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow { /** - * The Id of this operation. Needs to be unique within the scope of the revision. + * A table row is a list of table cells. */ - id?: number | null; + cells?: Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell[]; + } + /** + * Represents a text type block. + */ + export interface Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock { /** - * References to the original elements that are replaced. + * A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks. */ - parents?: Schema$GoogleCloudDocumentaiV1DocumentProvenanceParent[]; + blocks?: Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock[]; /** - * The index of the revision that produced this element. + * Text content stored in the block. */ - revision?: number | null; + text?: string | null; /** - * The type of provenance operation. + * Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`. */ type?: string | null; } /** - * The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. + * Entity revision. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentProvenanceParent { + export interface Schema$GoogleCloudDocumentaiV1DocumentEntitiesRevision { /** - * The id of the parent provenance. + * The entities in this revision. */ - id?: number | null; + entities?: Schema$GoogleCloudDocumentaiV1DocumentEntity[]; /** - * The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + * The entity validation output for this revision. */ - index?: number | null; + entityValidationOutput?: Schema$GoogleCloudDocumentaiV1DocumentEntityValidationOutput; /** - * The index of the index into current revision's parent_ids list. + * The revision id. */ - revision?: number | null; + revisionId?: string | null; } /** - * Contains past or forward revisions of this document. + * An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentRevision { + export interface Schema$GoogleCloudDocumentaiV1DocumentEntity { /** - * If the change was made by a person specify the name or id of that person. + * Optional. Confidence of detected Schema entity. Range `[0, 1]`. */ - agent?: string | null; + confidence?: number | null; /** - * The time that the revision was created, internally generated by doc proto storage at the time of create. + * Optional. Canonical id. This will be a unique value in the entity list for this document. */ - createTime?: string | null; + id?: string | null; /** - * Human Review information of this revision. + * Optional. Deprecated. Use `id` field instead. */ - humanReview?: Schema$GoogleCloudDocumentaiV1DocumentRevisionHumanReview; + mentionId?: string | null; /** - * Id of the revision, internally generated by doc proto storage. Unique within the context of the document. + * Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`. */ - id?: string | null; + mentionText?: string | null; /** - * The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. + * Optional. Specifies how the entity's value is obtained. */ - parent?: number[] | null; + method?: string | null; /** - * The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field. + * Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types. */ - parentIds?: string[] | null; + normalizedValue?: Schema$GoogleCloudDocumentaiV1DocumentEntityNormalizedValue; /** - * If the annotation was made by processor identify the processor by its resource name. + * Optional. Represents the provenance of this entity wrt. the location on the page where it was found. */ - processor?: string | null; - } - /** - * Human Review information of the document. - */ - export interface Schema$GoogleCloudDocumentaiV1DocumentRevisionHumanReview { + pageAnchor?: Schema$GoogleCloudDocumentaiV1DocumentPageAnchor; /** - * Human review state. e.g. `requested`, `succeeded`, `rejected`. + * Optional. Entities can be nested to form a hierarchical data structure representing the content in the document. */ - state?: string | null; + properties?: Schema$GoogleCloudDocumentaiV1DocumentEntity[]; /** - * A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`. + * Optional. The history of this annotation. */ - stateMessage?: string | null; - } - /** - * The schema defines the output of the processed document by a processor. - */ - export interface Schema$GoogleCloudDocumentaiV1DocumentSchema { - /** - * Description of the schema. - */ - description?: string | null; + provenance?: Schema$GoogleCloudDocumentaiV1DocumentProvenance; /** - * Display name to show to users. + * Optional. Whether the entity will be redacted for de-identification purposes. */ - displayName?: string | null; + redacted?: boolean | null; /** - * Entity types of the schema. + * Optional. Provenance of the entity. Text anchor indexing into the Document.text. */ - entityTypes?: Schema$GoogleCloudDocumentaiV1DocumentSchemaEntityType[]; + textAnchor?: Schema$GoogleCloudDocumentaiV1DocumentTextAnchor; /** - * Metadata of the schema. + * Required. Entity type from a schema e.g. `Address`. */ - metadata?: Schema$GoogleCloudDocumentaiV1DocumentSchemaMetadata; + type?: string | null; } /** - * EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. + * Parsed and normalized entity value. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentSchemaEntityType { + export interface Schema$GoogleCloudDocumentaiV1DocumentEntityNormalizedValue { /** - * The entity type that this type is derived from. For now, one and only one should be set. + * Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto */ - baseTypes?: string[] | null; + addressValue?: Schema$GoogleTypePostalAddress; /** - * User defined name for the type. + * Boolean value. Can be used for entities with binary values, or for checkboxes. */ - displayName?: string | null; + booleanValue?: boolean | null; /** - * If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is \>10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file. + * DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto */ - enumValues?: Schema$GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues; + datetimeValue?: Schema$GoogleTypeDateTime; /** - * Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + * Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto */ - name?: string | null; + dateValue?: Schema$GoogleTypeDate; /** - * Description the nested structure, or composition of an entity. + * Float value. */ - properties?: Schema$GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty[]; + floatValue?: number | null; + /** + * Integer value. + */ + integerValue?: number | null; + /** + * Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto + */ + moneyValue?: Schema$GoogleTypeMoney; + /** + * A signature - a graphical representation of a person's name, often used to sign a document. + */ + signatureValue?: boolean | null; + /** + * Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. + */ + text?: string | null; } /** - * Defines the a list of enum values. + * Relationship between Entities. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues { + export interface Schema$GoogleCloudDocumentaiV1DocumentEntityRelation { /** - * The individual values that this enum values type can include. + * Object entity id. */ - values?: string[] | null; + objectId?: string | null; + /** + * Relationship description. + */ + relation?: string | null; + /** + * Subject entity id. + */ + subjectId?: string | null; } /** - * Defines properties that can be part of the entity type. + * The output of the validation given the document and the validation rules. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty { + export interface Schema$GoogleCloudDocumentaiV1DocumentEntityValidationOutput { /** - * User defined name for the property. + * The overall result of the validation, true if all applicable rules are valid. */ - displayName?: string | null; + passAllRules?: boolean | null; /** - * Specifies how the entity's value is obtained. + * The result of each validation rule. */ - method?: string | null; + validationResults?: Schema$GoogleCloudDocumentaiV1DocumentEntityValidationOutputValidationResult[]; + } + /** + * Validation result for a single validation rule. + */ + export interface Schema$GoogleCloudDocumentaiV1DocumentEntityValidationOutputValidationResult { /** - * The name of the property. Follows the same guidelines as the EntityType name. + * Optional. The name of the rule resource that is used for validation. Format: `projects/{project\}/locations/{location\}/rules/{rule\}` */ - name?: string | null; + rule?: string | null; /** - * Occurrence type limits the number of instances an entity type appears in the document. + * The description of the validation rule. */ - occurrenceType?: string | null; + ruleDescription?: string | null; /** - * A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field. + * The display name of the validation rule. */ - valueType?: string | null; + ruleName?: string | null; + /** + * The detailed information of the running the validation process using the entity from the document based on the validation rule. + */ + validationDetails?: string | null; + /** + * The result of the validation rule. + */ + validationResultType?: string | null; } /** - * Metadata for global schema behavior. + * Config that controls the output of documents. All documents will be written as a JSON file. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentSchemaMetadata { + export interface Schema$GoogleCloudDocumentaiV1DocumentOutputConfig { /** - * If true, on a given page, there can be multiple `document` annotations covering it. + * Output config to write the results to Cloud Storage. */ - documentAllowMultipleLabels?: boolean | null; + gcsOutputConfig?: Schema$GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig; + } + /** + * The configuration used when outputting documents. + */ + export interface Schema$GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig { /** - * If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification). + * Specifies which fields to include in the output documents. Only supports top level document and pages field so it must be in the form of `{document_field_name\}` or `pages.{page_field_name\}`. */ - documentSplitter?: boolean | null; + fieldMask?: string | null; /** - * If set, all the nested entities must be prefixed with the parents. + * The Cloud Storage uri (a directory) of the output. */ - prefixedNamingOnProperties?: boolean | null; + gcsUri?: string | null; /** - * If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked. + * Specifies the sharding config for the output document. */ - skipNamingValidation?: boolean | null; + shardingConfig?: Schema$GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig; } /** - * For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is. + * The sharding config for the output document. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentShardInfo { - /** - * Total number of shards. - */ - shardCount?: string | null; + export interface Schema$GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfigShardingConfig { /** - * The 0-based index of this shard. + * The number of overlapping pages between consecutive shards. */ - shardIndex?: string | null; + pagesOverlap?: number | null; /** - * The index of the first character in Document.text in the overall document global text. + * The number of pages per shard. */ - textOffset?: string | null; + pagesPerShard?: number | null; } /** - * Annotation for common text style attributes. This adheres to CSS conventions as much as possible. + * A page in a Document. */ - export interface Schema$GoogleCloudDocumentaiV1DocumentStyle { + export interface Schema$GoogleCloudDocumentaiV1DocumentPage { /** - * Text background color. + * A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation. */ - backgroundColor?: Schema$GoogleTypeColor; + blocks?: Schema$GoogleCloudDocumentaiV1DocumentPageBlock[]; /** - * Text color. + * A list of detected barcodes. */ - color?: Schema$GoogleTypeColor; + detectedBarcodes?: Schema$GoogleCloudDocumentaiV1DocumentPageDetectedBarcode[]; /** - * Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/cssref/pr_font_font-family.asp + * A list of detected languages together with confidence. */ - fontFamily?: string | null; + detectedLanguages?: Schema$GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[]; /** - * Font size. + * Physical dimension of the page. */ - fontSize?: Schema$GoogleCloudDocumentaiV1DocumentStyleFontSize; + dimension?: Schema$GoogleCloudDocumentaiV1DocumentPageDimension; /** - * [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`. + * A list of visually detected form fields on the page. */ - fontWeight?: string | null; + formFields?: Schema$GoogleCloudDocumentaiV1DocumentPageFormField[]; /** - * Text anchor indexing into the Document.text. + * Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned. */ - textAnchor?: Schema$GoogleCloudDocumentaiV1DocumentTextAnchor; + image?: Schema$GoogleCloudDocumentaiV1DocumentPageImage; /** - * [Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard. + * Image quality scores. */ - textDecoration?: string | null; + imageQualityScores?: Schema$GoogleCloudDocumentaiV1DocumentPageImageQualityScores; /** - * [Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`. + * Layout for the page. */ - textStyle?: string | null; - } - /** - * Font size with unit. - */ - export interface Schema$GoogleCloudDocumentaiV1DocumentStyleFontSize { + layout?: Schema$GoogleCloudDocumentaiV1DocumentPageLayout; /** - * Font size for the text. + * A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line. */ - size?: number | null; + lines?: Schema$GoogleCloudDocumentaiV1DocumentPageLine[]; /** - * Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`). + * 1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing. */ - unit?: string | null; - } - /** - * Text reference indexing into the Document.text. - */ - export interface Schema$GoogleCloudDocumentaiV1DocumentTextAnchor { + pageNumber?: number | null; /** - * Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields. + * A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph. */ - content?: string | null; + paragraphs?: Schema$GoogleCloudDocumentaiV1DocumentPageParagraph[]; /** - * The text segments from the Document.text. + * The history of this page. */ - textSegments?: Schema$GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment[]; - } - /** - * A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset - */ - export interface Schema$GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment { + provenance?: Schema$GoogleCloudDocumentaiV1DocumentProvenance; /** - * TextSegment half open end UTF-8 char index in the Document.text. + * A list of visually detected symbols on the page. */ - endIndex?: string | null; + symbols?: Schema$GoogleCloudDocumentaiV1DocumentPageSymbol[]; /** - * TextSegment start UTF-8 char index in the Document.text. + * A list of visually detected tables on the page. */ - startIndex?: string | null; - } - /** - * This message is used for text changes aka. OCR corrections. - */ - export interface Schema$GoogleCloudDocumentaiV1DocumentTextChange { + tables?: Schema$GoogleCloudDocumentaiV1DocumentPageTable[]; /** - * The text that replaces the text identified in the `text_anchor`. + * A list of visually detected tokens on the page. */ - changedText?: string | null; + tokens?: Schema$GoogleCloudDocumentaiV1DocumentPageToken[]; /** - * The history of this annotation. + * Transformation matrices that were applied to the original document image to produce Page.image. */ - provenance?: Schema$GoogleCloudDocumentaiV1DocumentProvenance[]; + transforms?: Schema$GoogleCloudDocumentaiV1DocumentPageMatrix[]; /** - * Provenance of the correction. Text anchor indexing into the Document.text. There can only be a single `TextAnchor.text_segments` element. If the start and end index of the text segment are the same, the text change is inserted before that index. + * A list of detected non-text visual elements e.g. checkbox, signature etc. on the page. */ - textAnchor?: Schema$GoogleCloudDocumentaiV1DocumentTextAnchor; + visualElements?: Schema$GoogleCloudDocumentaiV1DocumentPageVisualElement[]; } /** - * The long-running operation metadata for the EnableProcessor method. + * Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. */ - export interface Schema$GoogleCloudDocumentaiV1EnableProcessorMetadata { + export interface Schema$GoogleCloudDocumentaiV1DocumentPageAnchor { /** - * The basic metadata of the long-running operation. + * One or more references to visual page elements */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1CommonOperationMetadata; + pageRefs?: Schema$GoogleCloudDocumentaiV1DocumentPageAnchorPageRef[]; } /** - * Request message for the EnableProcessor method. + * Represents a weak reference to a page element within a document. */ - export interface Schema$GoogleCloudDocumentaiV1EnableProcessorRequest {} - /** - * Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future. - */ - export interface Schema$GoogleCloudDocumentaiV1EnableProcessorResponse {} - /** - * Metadata of the EvaluateProcessorVersion method. - */ - export interface Schema$GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata { - /** - * The basic metadata of the long-running operation. - */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1CommonOperationMetadata; - } - /** - * Evaluates the given ProcessorVersion against the supplied documents. - */ - export interface Schema$GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest { - /** - * Optional. The documents used in the evaluation. If unspecified, use the processor's dataset as evaluation input. - */ - evaluationDocuments?: Schema$GoogleCloudDocumentaiV1BatchDocumentsInputConfig; - } - /** - * Response of the EvaluateProcessorVersion method. - */ - export interface Schema$GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse { + export interface Schema$GoogleCloudDocumentaiV1DocumentPageAnchorPageRef { /** - * The resource name of the created evaluation. + * Optional. Identifies the bounding polygon of a layout element on the page. If `layout_type` is set, the bounding polygon must be exactly the same to the layout element it's referring to. */ - evaluation?: string | null; - } - /** - * An evaluation of a ProcessorVersion's performance. - */ - export interface Schema$GoogleCloudDocumentaiV1Evaluation { + boundingPoly?: Schema$GoogleCloudDocumentaiV1BoundingPoly; /** - * Metrics for all the entities in aggregate. + * Optional. Confidence of detected page element, if applicable. Range `[0, 1]`. */ - allEntitiesMetrics?: Schema$GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics; + confidence?: number | null; /** - * The time that the evaluation was created. + * Optional. Deprecated. Use PageRef.bounding_poly instead. */ - createTime?: string | null; + layoutId?: string | null; /** - * Counters for the documents used in the evaluation. + * Optional. The type of the layout element that is being referenced if any. */ - documentCounters?: Schema$GoogleCloudDocumentaiV1EvaluationCounters; + layoutType?: string | null; /** - * Metrics across confidence levels, for different entities. + * Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See https://developers.google.com/protocol-buffers/docs/proto3#json. */ - entityMetrics?: { - [ - key: string - ]: Schema$GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics; - } | null; + page?: string | null; + } + /** + * A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation. + */ + export interface Schema$GoogleCloudDocumentaiV1DocumentPageBlock { /** - * The KMS key name used for encryption. + * A list of detected languages together with confidence. */ - kmsKeyName?: string | null; + detectedLanguages?: Schema$GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[]; /** - * The KMS key version with which data is encrypted. + * Layout for Block. */ - kmsKeyVersionName?: string | null; + layout?: Schema$GoogleCloudDocumentaiV1DocumentPageLayout; /** - * The resource name of the evaluation. Format: `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processor_version\}/evaluations/{evaluation\}` + * The history of this annotation. */ - name?: string | null; + provenance?: Schema$GoogleCloudDocumentaiV1DocumentProvenance; } /** - * Evaluations metrics, at a specific confidence level. + * A detected barcode. */ - export interface Schema$GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics { + export interface Schema$GoogleCloudDocumentaiV1DocumentPageDetectedBarcode { /** - * The confidence level. + * Detailed barcode information of the DetectedBarcode. */ - confidenceLevel?: number | null; + barcode?: Schema$GoogleCloudDocumentaiV1Barcode; /** - * The metrics at the specific confidence level. + * Layout for DetectedBarcode. */ - metrics?: Schema$GoogleCloudDocumentaiV1EvaluationMetrics; + layout?: Schema$GoogleCloudDocumentaiV1DocumentPageLayout; } /** - * Evaluation counters for the documents that were used. + * Detected language for a structural component. */ - export interface Schema$GoogleCloudDocumentaiV1EvaluationCounters { - /** - * How many documents were used in the evaluation. - */ - evaluatedDocumentsCount?: number | null; - /** - * How many documents were not included in the evaluation as Document AI failed to process them. - */ - failedDocumentsCount?: number | null; + export interface Schema$GoogleCloudDocumentaiV1DocumentPageDetectedLanguage { /** - * How many documents were sent for evaluation. + * Confidence of detected language. Range `[0, 1]`. */ - inputDocumentsCount?: number | null; + confidence?: number | null; /** - * How many documents were not included in the evaluation as they didn't pass validation. + * The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`. */ - invalidDocumentsCount?: number | null; + languageCode?: string | null; } /** - * Evaluation metrics, either in aggregate or about a specific entity. + * Dimension for the page. */ - export interface Schema$GoogleCloudDocumentaiV1EvaluationMetrics { + export interface Schema$GoogleCloudDocumentaiV1DocumentPageDimension { /** - * The calculated f1 score. + * Page height. */ - f1Score?: number | null; + height?: number | null; /** - * The amount of false negatives. + * Dimension unit. */ - falseNegativesCount?: number | null; + unit?: string | null; /** - * The amount of false positives. + * Page width. */ - falsePositivesCount?: number | null; + width?: number | null; + } + /** + * A form field detected on the page. + */ + export interface Schema$GoogleCloudDocumentaiV1DocumentPageFormField { /** - * The amount of documents with a ground truth occurrence. + * Created for Labeling UI to export key text. If corrections were made to the text identified by the `field_name.text_anchor`, this field will contain the correction. */ - groundTruthDocumentCount?: number | null; + correctedKeyText?: string | null; /** - * The amount of occurrences in ground truth documents. + * Created for Labeling UI to export value text. If corrections were made to the text identified by the `field_value.text_anchor`, this field will contain the correction. */ - groundTruthOccurrencesCount?: number | null; + correctedValueText?: string | null; /** - * The calculated precision. + * Layout for the FormField name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc. */ - precision?: number | null; + fieldName?: Schema$GoogleCloudDocumentaiV1DocumentPageLayout; /** - * The amount of documents with a predicted occurrence. + * Layout for the FormField value. */ - predictedDocumentCount?: number | null; + fieldValue?: Schema$GoogleCloudDocumentaiV1DocumentPageLayout; /** - * The amount of occurrences in predicted documents. + * A list of detected languages for name together with confidence. */ - predictedOccurrencesCount?: number | null; + nameDetectedLanguages?: Schema$GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[]; /** - * The calculated recall. + * The history of this annotation. */ - recall?: number | null; + provenance?: Schema$GoogleCloudDocumentaiV1DocumentProvenance; /** - * The amount of documents that had an occurrence of this label. + * A list of detected languages for value together with confidence. */ - totalDocumentsCount?: number | null; + valueDetectedLanguages?: Schema$GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[]; /** - * The amount of true positives. + * If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the `field_value` is normal text) - `unfilled_checkbox` - `filled_checkbox` */ - truePositivesCount?: number | null; + valueType?: string | null; } /** - * Metrics across multiple confidence levels. + * Rendered image contents for this page. */ - export interface Schema$GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics { + export interface Schema$GoogleCloudDocumentaiV1DocumentPageImage { /** - * The calculated area under the precision recall curve (AUPRC), computed by integrating over all confidence thresholds. + * Raw byte content of the image. */ - auprc?: number | null; + content?: string | null; /** - * The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching only. + * Height of the image in pixels. */ - auprcExact?: number | null; + height?: number | null; /** - * Metrics across confidence levels with fuzzy matching enabled. + * Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image. */ - confidenceLevelMetrics?: Schema$GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics[]; + mimeType?: string | null; /** - * Metrics across confidence levels with only exact matching. + * Width of the image in pixels. */ - confidenceLevelMetricsExact?: Schema$GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics[]; + width?: number | null; + } + /** + * Image quality scores for the page image. + */ + export interface Schema$GoogleCloudDocumentaiV1DocumentPageImageQualityScores { /** - * The Estimated Calibration Error (ECE) of the confidence of the predicted entities. + * A list of detected defects. */ - estimatedCalibrationError?: number | null; + detectedDefects?: Schema$GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect[]; /** - * The ECE for the predicted entities with fuzzy matching disabled, i.e., exact matching only. + * The overall quality score. Range `[0, 1]` where `1` is perfect quality. */ - estimatedCalibrationErrorExact?: number | null; + qualityScore?: number | null; + } + /** + * Image Quality Defects + */ + export interface Schema$GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect { /** - * The metrics type for the label. + * Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists. */ - metricsType?: string | null; + confidence?: number | null; + /** + * Name of the defect type. Supported values are: - `quality/defect_blurry` - `quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `quality/defect_text_too_small` - `quality/defect_document_cutoff` - `quality/defect_text_cutoff` - `quality/defect_glare` + */ + type?: string | null; } /** - * Gives a short summary of an evaluation, and links to the evaluation itself. + * Visual element describing a layout unit on a page. */ - export interface Schema$GoogleCloudDocumentaiV1EvaluationReference { + export interface Schema$GoogleCloudDocumentaiV1DocumentPageLayout { /** - * An aggregate of the statistics for the evaluation with fuzzy matching on. + * The bounding polygon for the Layout. */ - aggregateMetrics?: Schema$GoogleCloudDocumentaiV1EvaluationMetrics; + boundingPoly?: Schema$GoogleCloudDocumentaiV1BoundingPoly; /** - * An aggregate of the statistics for the evaluation with fuzzy matching off. + * Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`. */ - aggregateMetricsExact?: Schema$GoogleCloudDocumentaiV1EvaluationMetrics; + confidence?: number | null; /** - * The resource name of the evaluation. + * Detected orientation for the Layout. */ - evaluation?: string | null; + orientation?: string | null; /** - * The resource name of the Long Running Operation for the evaluation. + * Text anchor indexing into the Document.text. */ - operation?: string | null; + textAnchor?: Schema$GoogleCloudDocumentaiV1DocumentTextAnchor; } /** - * Response message for the FetchProcessorTypes method. + * A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc. */ - export interface Schema$GoogleCloudDocumentaiV1FetchProcessorTypesResponse { + export interface Schema$GoogleCloudDocumentaiV1DocumentPageLine { /** - * The list of processor types. + * A list of detected languages together with confidence. */ - processorTypes?: Schema$GoogleCloudDocumentaiV1ProcessorType[]; - } - /** - * Specifies a document stored on Cloud Storage. - */ - export interface Schema$GoogleCloudDocumentaiV1GcsDocument { + detectedLanguages?: Schema$GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[]; /** - * The Cloud Storage object uri. + * Layout for Line. */ - gcsUri?: string | null; + layout?: Schema$GoogleCloudDocumentaiV1DocumentPageLayout; /** - * An IANA MIME type (RFC6838) of the content. + * The history of this annotation. */ - mimeType?: string | null; + provenance?: Schema$GoogleCloudDocumentaiV1DocumentProvenance; } /** - * Specifies a set of documents on Cloud Storage. + * Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation. */ - export interface Schema$GoogleCloudDocumentaiV1GcsDocuments { + export interface Schema$GoogleCloudDocumentaiV1DocumentPageMatrix { /** - * The list of documents. + * Number of columns in the matrix. */ - documents?: Schema$GoogleCloudDocumentaiV1GcsDocument[]; - } - /** - * Specifies all documents on Cloud Storage with a common prefix. - */ - export interface Schema$GoogleCloudDocumentaiV1GcsPrefix { + cols?: number | null; /** - * The URI prefix. + * The matrix data. */ - gcsUriPrefix?: string | null; + data?: string | null; + /** + * Number of rows in the matrix. + */ + rows?: number | null; + /** + * This encodes information about what data type the matrix uses. For example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of OpenCV primitive data types, please refer to https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html + */ + type?: number | null; } /** - * The status of human review on a processed document. + * A collection of lines that a human would perceive as a paragraph. */ - export interface Schema$GoogleCloudDocumentaiV1HumanReviewStatus { + export interface Schema$GoogleCloudDocumentaiV1DocumentPageParagraph { /** - * The name of the operation triggered by the processed document. This field is populated only when the state is `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as the long-running operation returned by ReviewDocument. + * A list of detected languages together with confidence. */ - humanReviewOperation?: string | null; + detectedLanguages?: Schema$GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[]; /** - * The state of human review on the processing request. + * Layout for Paragraph. */ - state?: string | null; + layout?: Schema$GoogleCloudDocumentaiV1DocumentPageLayout; /** - * A message providing more details about the human review state. + * The history of this annotation. */ - stateMessage?: string | null; + provenance?: Schema$GoogleCloudDocumentaiV1DocumentProvenance; } /** - * The response from `ListEvaluations`. + * A detected symbol. */ - export interface Schema$GoogleCloudDocumentaiV1ListEvaluationsResponse { + export interface Schema$GoogleCloudDocumentaiV1DocumentPageSymbol { /** - * The evaluations requested. + * A list of detected languages together with confidence. */ - evaluations?: Schema$GoogleCloudDocumentaiV1Evaluation[]; + detectedLanguages?: Schema$GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[]; /** - * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + * Layout for Symbol. */ - nextPageToken?: string | null; + layout?: Schema$GoogleCloudDocumentaiV1DocumentPageLayout; } /** - * Response message for the ListProcessors method. + * A table representation similar to HTML table structure. */ - export interface Schema$GoogleCloudDocumentaiV1ListProcessorsResponse { + export interface Schema$GoogleCloudDocumentaiV1DocumentPageTable { /** - * Points to the next processor, otherwise empty. + * Body rows of the table. */ - nextPageToken?: string | null; + bodyRows?: Schema$GoogleCloudDocumentaiV1DocumentPageTableTableRow[]; /** - * The list of processors. + * A list of detected languages together with confidence. */ - processors?: Schema$GoogleCloudDocumentaiV1Processor[]; - } - /** - * Response message for the ListProcessorTypes method. - */ - export interface Schema$GoogleCloudDocumentaiV1ListProcessorTypesResponse { + detectedLanguages?: Schema$GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[]; /** - * Points to the next page, otherwise empty. + * Header rows of the table. */ - nextPageToken?: string | null; + headerRows?: Schema$GoogleCloudDocumentaiV1DocumentPageTableTableRow[]; /** - * The processor types. + * Layout for Table. */ - processorTypes?: Schema$GoogleCloudDocumentaiV1ProcessorType[]; + layout?: Schema$GoogleCloudDocumentaiV1DocumentPageLayout; + /** + * The history of this table. + */ + provenance?: Schema$GoogleCloudDocumentaiV1DocumentProvenance; } /** - * Response message for the ListProcessorVersions method. + * A cell representation inside the table. */ - export interface Schema$GoogleCloudDocumentaiV1ListProcessorVersionsResponse { + export interface Schema$GoogleCloudDocumentaiV1DocumentPageTableTableCell { /** - * Points to the next processor, otherwise empty. + * How many columns this cell spans. */ - nextPageToken?: string | null; + colSpan?: number | null; /** - * The list of processors. + * A list of detected languages together with confidence. */ - processorVersions?: Schema$GoogleCloudDocumentaiV1ProcessorVersion[]; - } - /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. - */ - export interface Schema$GoogleCloudDocumentaiV1NormalizedVertex { + detectedLanguages?: Schema$GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[]; /** - * X coordinate. + * Layout for TableCell. */ - x?: number | null; + layout?: Schema$GoogleCloudDocumentaiV1DocumentPageLayout; /** - * Y coordinate (starts from the top of the image). + * How many rows this cell spans. */ - y?: number | null; + rowSpan?: number | null; } /** - * Config for Document OCR. + * A row of table cells. */ - export interface Schema$GoogleCloudDocumentaiV1OcrConfig { - /** - * A list of advanced OCR options to further fine-tune OCR behavior. Current valid values are: - `legacy_layout`: a heuristics layout detection algorithm, which serves as an alternative to the current ML-based layout detection algorithm. Customers can choose the best suitable layout algorithm based on their situation. - */ - advancedOcrOptions?: string[] | null; - /** - * Turn on font identification model and return font style information. Deprecated, use PremiumFeatures.compute_style_info instead. - */ - computeStyleInfo?: boolean | null; + export interface Schema$GoogleCloudDocumentaiV1DocumentPageTableTableRow { /** - * Turn off character box detector in OCR engine. Character box detection is enabled by default in OCR 2.0 (and later) processors. + * Cells that make up this row. */ - disableCharacterBoxesDetection?: boolean | null; + cells?: Schema$GoogleCloudDocumentaiV1DocumentPageTableTableCell[]; + } + /** + * A detected token. + */ + export interface Schema$GoogleCloudDocumentaiV1DocumentPageToken { /** - * Enables intelligent document quality scores after OCR. Can help with diagnosing why OCR responses are of poor quality for a given input. Adds additional latency comparable to regular OCR to the process call. + * Detected break at the end of a Token. */ - enableImageQualityScores?: boolean | null; + detectedBreak?: Schema$GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak; /** - * Enables special handling for PDFs with existing text information. Results in better text extraction quality in such PDF inputs. + * A list of detected languages together with confidence. */ - enableNativePdfParsing?: boolean | null; + detectedLanguages?: Schema$GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[]; /** - * Includes symbol level OCR information if set to true. + * Layout for Token. */ - enableSymbol?: boolean | null; + layout?: Schema$GoogleCloudDocumentaiV1DocumentPageLayout; /** - * Hints for the OCR model. + * The history of this annotation. */ - hints?: Schema$GoogleCloudDocumentaiV1OcrConfigHints; + provenance?: Schema$GoogleCloudDocumentaiV1DocumentProvenance; /** - * Configurations for premium OCR features. + * Text style attributes. */ - premiumFeatures?: Schema$GoogleCloudDocumentaiV1OcrConfigPremiumFeatures; + styleInfo?: Schema$GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo; } /** - * Hints for OCR Engine + * Detected break at the end of a Token. */ - export interface Schema$GoogleCloudDocumentaiV1OcrConfigHints { + export interface Schema$GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak { /** - * List of BCP-47 language codes to use for OCR. In most cases, not specifying it yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting hints is not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a significant hindrance if the hint is wrong). + * Detected break type. */ - languageHints?: string[] | null; + type?: string | null; } /** - * Configurations for premium OCR features. + * Font and other text style attributes. */ - export interface Schema$GoogleCloudDocumentaiV1OcrConfigPremiumFeatures { + export interface Schema$GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo { /** - * Turn on font identification model and return font style information. + * Color of the background. */ - computeStyleInfo?: boolean | null; + backgroundColor?: Schema$GoogleTypeColor; /** - * Turn on the model that can extract LaTeX math formulas. + * Whether the text is bold (equivalent to font_weight is at least `700`). */ - enableMathOcr?: boolean | null; + bold?: boolean | null; /** - * Turn on selection mark detector in OCR engine. Only available in OCR 2.0 (and later) processors. + * Font size in points (`1` point is `¹⁄₇₂` inches). */ - enableSelectionMarkDetection?: boolean | null; - } - /** - * Options for Process API - */ - export interface Schema$GoogleCloudDocumentaiV1ProcessOptions { + fontSize?: number | null; /** - * Only process certain pages from the end, same as above. + * Name or style of the font. */ - fromEnd?: number | null; + fontType?: string | null; /** - * Only process certain pages from the start. Process all if the document has fewer pages. + * TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). Normal is `400`, bold is `700`. */ - fromStart?: number | null; + fontWeight?: number | null; /** - * Which pages to process (1-indexed). + * Whether the text is handwritten. */ - individualPageSelector?: Schema$GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector; + handwritten?: boolean | null; /** - * Optional. Only applicable to `LAYOUT_PARSER_PROCESSOR`. Returns error if set on other processor types. + * Whether the text is italic. */ - layoutConfig?: Schema$GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig; + italic?: boolean | null; /** - * Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. Returns error if set on other processor types. + * Letter spacing in points. */ - ocrConfig?: Schema$GoogleCloudDocumentaiV1OcrConfig; + letterSpacing?: number | null; /** - * Optional. Override the schema of the ProcessorVersion. Will return an Invalid Argument error if this field is set when the underlying ProcessorVersion doesn't support schema override. + * Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ `72.0`. */ - schemaOverride?: Schema$GoogleCloudDocumentaiV1DocumentSchema; - } - /** - * A list of individual page numbers. - */ - export interface Schema$GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector { + pixelFontSize?: number | null; /** - * Optional. Indices of the pages (starting from 1). + * Whether the text is in small caps. This feature is not supported yet. */ - pages?: number[] | null; - } - /** - * Serving config for layout parser processor. - */ - export interface Schema$GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig { + smallcaps?: boolean | null; /** - * Optional. Config for chunking in layout parser processor. + * Whether the text is strikethrough. This feature is not supported yet. */ - chunkingConfig?: Schema$GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig; + strikeout?: boolean | null; /** - * Optional. Whether to include bounding boxes in layout parser processor response. + * Whether the text is a subscript. This feature is not supported yet. */ - returnBoundingBoxes?: boolean | null; + subscript?: boolean | null; /** - * Optional. Whether to include images in layout parser processor response. + * Whether the text is a superscript. This feature is not supported yet. */ - returnImages?: boolean | null; - } - /** - * Serving config for chunking. - */ - export interface Schema$GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig { + superscript?: boolean | null; /** - * Optional. The chunk sizes to use when splitting documents, in order of level. + * Color of the text. */ - chunkSize?: number | null; + textColor?: Schema$GoogleTypeColor; /** - * Optional. Whether or not to include ancestor headings when splitting. + * Whether the text is underlined. */ - includeAncestorHeadings?: boolean | null; + underlined?: boolean | null; } /** - * The first-class citizen for Document AI. Each processor defines how to extract structural information from a document. + * Detected non-text visual elements e.g. checkbox, signature etc. on the page. */ - export interface Schema$GoogleCloudDocumentaiV1Processor { + export interface Schema$GoogleCloudDocumentaiV1DocumentPageVisualElement { /** - * Output only. The time the processor was created. + * A list of detected languages together with confidence. */ - createTime?: string | null; + detectedLanguages?: Schema$GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[]; /** - * The default processor version. + * Layout for VisualElement. */ - defaultProcessorVersion?: string | null; + layout?: Schema$GoogleCloudDocumentaiV1DocumentPageLayout; /** - * The display name of the processor. + * Type of the VisualElement. */ - displayName?: string | null; + type?: string | null; + } + /** + * Structure to identify provenance relationships between annotations in different revisions. + */ + export interface Schema$GoogleCloudDocumentaiV1DocumentProvenance { /** - * The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios. + * The Id of this operation. Needs to be unique within the scope of the revision. */ - kmsKeyName?: string | null; + id?: number | null; /** - * Output only. Immutable. The resource name of the processor. Format: `projects/{project\}/locations/{location\}/processors/{processor\}` + * References to the original elements that are replaced. */ - name?: string | null; + parents?: Schema$GoogleCloudDocumentaiV1DocumentProvenanceParent[]; /** - * Output only. Immutable. The http endpoint that can be called to invoke processing. - */ - processEndpoint?: string | null; - /** - * Output only. The processor version aliases. + * The index of the revision that produced this element. */ - processorVersionAliases?: Schema$GoogleCloudDocumentaiV1ProcessorVersionAlias[]; + revision?: number | null; /** - * Output only. Reserved for future use. + * The type of provenance operation. */ - satisfiesPzi?: boolean | null; + type?: string | null; + } + /** + * The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. + */ + export interface Schema$GoogleCloudDocumentaiV1DocumentProvenanceParent { /** - * Output only. Reserved for future use. + * The id of the parent provenance. */ - satisfiesPzs?: boolean | null; + id?: number | null; /** - * Output only. The state of the processor. + * The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. */ - state?: string | null; + index?: number | null; /** - * The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor types, see FetchProcessorTypes. + * The index of the index into current revision's parent_ids list. */ - type?: string | null; + revision?: number | null; } /** - * A processor type is responsible for performing a certain document understanding task on a certain type of document. + * Contains past or forward revisions of this document. */ - export interface Schema$GoogleCloudDocumentaiV1ProcessorType { + export interface Schema$GoogleCloudDocumentaiV1DocumentRevision { /** - * Whether the processor type allows creation. If true, users can create a processor of this processor type. Otherwise, users need to request access. + * If the change was made by a person specify the name or id of that person. */ - allowCreation?: boolean | null; + agent?: string | null; /** - * The locations in which this processor is available. + * The time that the revision was created, internally generated by doc proto storage at the time of create. */ - availableLocations?: Schema$GoogleCloudDocumentaiV1ProcessorTypeLocationInfo[]; + createTime?: string | null; /** - * The processor category, used by UI to group processor types. + * Human Review information of this revision. */ - category?: string | null; + humanReview?: Schema$GoogleCloudDocumentaiV1DocumentRevisionHumanReview; /** - * Launch stage of the processor type + * Id of the revision, internally generated by doc proto storage. Unique within the context of the document. */ - launchStage?: string | null; + id?: string | null; /** - * The resource name of the processor type. Format: `projects/{project\}/processorTypes/{processor_type\}` + * The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. */ - name?: string | null; + parent?: number[] | null; /** - * A set of Cloud Storage URIs of sample documents for this processor. + * The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field. */ - sampleDocumentUris?: string[] | null; + parentIds?: string[] | null; /** - * The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. + * If the annotation was made by processor identify the processor by its resource name. */ - type?: string | null; + processor?: string | null; } /** - * The location information about where the processor is available. + * Human Review information of the document. */ - export interface Schema$GoogleCloudDocumentaiV1ProcessorTypeLocationInfo { + export interface Schema$GoogleCloudDocumentaiV1DocumentRevisionHumanReview { /** - * The location ID. For supported locations, refer to [regional and multi-regional support](/document-ai/docs/regions). + * Human review state. e.g. `requested`, `succeeded`, `rejected`. */ - locationId?: string | null; + state?: string | null; + /** + * A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`. + */ + stateMessage?: string | null; } /** - * 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. + * A set of inline documents. */ - export interface Schema$GoogleCloudDocumentaiV1ProcessorVersion { + export interface Schema$GoogleCloudDocumentaiV1Documents { /** - * Output only. The time the processor version was created. + * The list of documents. */ - createTime?: string | null; + documents?: Schema$GoogleCloudDocumentaiV1Document[]; + } + /** + * The schema defines the output of the processed document by a processor. + */ + export interface Schema$GoogleCloudDocumentaiV1DocumentSchema { /** - * Output only. If set, information about the eventual deprecation of this version. + * Description of the schema. */ - deprecationInfo?: Schema$GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo; + description?: string | null; /** - * The display name of the processor version. + * Display name to show to users. */ displayName?: string | null; /** - * Output only. The schema of the processor version. Describes the output. - */ - documentSchema?: Schema$GoogleCloudDocumentaiV1DocumentSchema; - /** - * Output only. Information about Generative AI model-based processor versions. - */ - genAiModelInfo?: Schema$GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo; - /** - * Output only. Denotes that this `ProcessorVersion` is managed by Google. + * Entity types of the schema. */ - googleManaged?: boolean | null; + entityTypes?: Schema$GoogleCloudDocumentaiV1DocumentSchemaEntityType[]; /** - * Output only. The KMS key name used for encryption. + * Metadata of the schema. */ - kmsKeyName?: string | null; + metadata?: Schema$GoogleCloudDocumentaiV1DocumentSchemaMetadata; + } + /** + * EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. + */ + export interface Schema$GoogleCloudDocumentaiV1DocumentSchemaEntityType { /** - * Output only. The KMS key version with which data is encrypted. + * The entity type that this type is derived from. For now, one and only one should be set. */ - kmsKeyVersionName?: string | null; + baseTypes?: string[] | null; /** - * Output only. The most recently invoked evaluation for the processor version. + * User defined name for the type. */ - latestEvaluation?: Schema$GoogleCloudDocumentaiV1EvaluationReference; + displayName?: string | null; /** - * Output only. The model type of this processor version. + * If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is \>10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file. */ - modelType?: string | null; + enumValues?: Schema$GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues; /** - * Identifier. The resource name of the processor version. Format: `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processor_version\}` + * Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. */ name?: string | null; /** - * Output only. Reserved for future use. - */ - satisfiesPzi?: boolean | null; - /** - * Output only. Reserved for future use. + * Description the nested structure, or composition of an entity. */ - satisfiesPzs?: boolean | null; + properties?: Schema$GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty[]; + } + /** + * Defines the a list of enum values. + */ + export interface Schema$GoogleCloudDocumentaiV1DocumentSchemaEntityTypeEnumValues { /** - * Output only. The state of the processor version. + * The individual values that this enum values type can include. */ - state?: string | null; + values?: string[] | null; } /** - * Contains the alias and the aliased resource name of processor version. + * Defines properties that can be part of the entity type. */ - export interface Schema$GoogleCloudDocumentaiV1ProcessorVersionAlias { + export interface Schema$GoogleCloudDocumentaiV1DocumentSchemaEntityTypeProperty { /** - * The alias in the form of `processor_version` resource name. + * User defined name for the property. */ - alias?: string | null; + displayName?: string | null; /** - * The resource name of aliased processor version. + * Specifies how the entity's value is obtained. */ - processorVersion?: string | null; - } - /** - * Information about the upcoming deprecation of this processor version. - */ - export interface Schema$GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo { + method?: string | null; /** - * The time at which this processor version will be deprecated. + * The name of the property. Follows the same guidelines as the EntityType name. */ - deprecationTime?: string | null; + name?: string | null; /** - * If set, the processor version that will be used as a replacement. + * Occurrence type limits the number of instances an entity type appears in the document. */ - replacementProcessorVersion?: string | null; + occurrenceType?: string | null; + /** + * A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field. + */ + valueType?: string | null; } /** - * Information about Generative AI model-based processor versions. + * Metadata for global schema behavior. */ - export interface Schema$GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo { + export interface Schema$GoogleCloudDocumentaiV1DocumentSchemaMetadata { /** - * Information for a custom Generative AI model created by the user. + * If true, on a given page, there can be multiple `document` annotations covering it. */ - customGenAiModelInfo?: Schema$GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo; + documentAllowMultipleLabels?: boolean | null; /** - * Information for a pretrained Google-managed foundation model. + * If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification). */ - foundationGenAiModelInfo?: Schema$GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo; - } - /** - * Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs. - */ - export interface Schema$GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo { + documentSplitter?: boolean | null; /** - * The base processor version ID for the custom model. + * If set, all the nested entities must be prefixed with the parents. */ - baseProcessorVersionId?: string | null; + prefixedNamingOnProperties?: boolean | null; /** - * The type of custom model created by the user. + * If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked. */ - customModelType?: string | null; + skipNamingValidation?: boolean | null; } /** - * Information for a pretrained Google-managed foundation model. + * For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is. */ - export interface Schema$GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo { + export interface Schema$GoogleCloudDocumentaiV1DocumentShardInfo { /** - * Whether finetuning is allowed for this base processor version. + * Total number of shards. */ - finetuningAllowed?: boolean | null; + shardCount?: string | null; /** - * The minimum number of labeled documents in the training dataset required for finetuning. + * The 0-based index of this shard. */ - minTrainLabeledDocuments?: number | null; + shardIndex?: string | null; + /** + * The index of the first character in Document.text in the overall document global text. + */ + textOffset?: string | null; } /** - * Request message for the ProcessDocument method. + * Annotation for common text style attributes. This adheres to CSS conventions as much as possible. */ - export interface Schema$GoogleCloudDocumentaiV1ProcessRequest { + export interface Schema$GoogleCloudDocumentaiV1DocumentStyle { /** - * Specifies which fields to include in the ProcessResponse.document output. Only supports top-level document and pages field, so it must be in the form of `{document_field_name\}` or `pages.{page_field_name\}`. + * Text background color. */ - fieldMask?: string | null; + backgroundColor?: Schema$GoogleTypeColor; /** - * A raw document on Google Cloud Storage. + * Text color. */ - gcsDocument?: Schema$GoogleCloudDocumentaiV1GcsDocument; + color?: Schema$GoogleTypeColor; /** - * Optional. Option to remove images from the document. + * Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/cssref/pr_font_font-family.asp */ - imagelessMode?: boolean | null; + fontFamily?: string | null; /** - * An inline document proto. + * Font size. */ - inlineDocument?: Schema$GoogleCloudDocumentaiV1Document; + fontSize?: Schema$GoogleCloudDocumentaiV1DocumentStyleFontSize; /** - * Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. + * [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`. */ - labels?: {[key: string]: string} | null; + fontWeight?: string | null; /** - * Inference-time options for the process API + * Text anchor indexing into the Document.text. */ - processOptions?: Schema$GoogleCloudDocumentaiV1ProcessOptions; + textAnchor?: Schema$GoogleCloudDocumentaiV1DocumentTextAnchor; /** - * A raw document content (bytes). + * [Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard. */ - rawDocument?: Schema$GoogleCloudDocumentaiV1RawDocument; + textDecoration?: string | null; /** - * Whether human review should be skipped for this request. Default to `false`. + * [Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`. */ - skipHumanReview?: boolean | null; + textStyle?: string | null; } /** - * Response message for the ProcessDocument method. + * Font size with unit. */ - export interface Schema$GoogleCloudDocumentaiV1ProcessResponse { + export interface Schema$GoogleCloudDocumentaiV1DocumentStyleFontSize { /** - * The document payload, will populate fields based on the processor's behavior. + * Font size for the text. */ - document?: Schema$GoogleCloudDocumentaiV1Document; + size?: number | null; /** - * The status of human review on the processed document. + * Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`). */ - humanReviewStatus?: Schema$GoogleCloudDocumentaiV1HumanReviewStatus; + unit?: string | null; } /** - * Payload message of raw document content (bytes). + * Text reference indexing into the Document.text. */ - export interface Schema$GoogleCloudDocumentaiV1RawDocument { + export interface Schema$GoogleCloudDocumentaiV1DocumentTextAnchor { /** - * Inline document content. + * Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields. */ content?: string | null; /** - * The display name of the document, it supports all Unicode characters except the following: `*`, `?`, `[`, `]`, `%`, `{`, `\}`,`'`, `\"`, `,` `~`, `=` and `:` are reserved. If not specified, a default ID is generated. - */ - displayName?: string | null; - /** - * An IANA MIME type (RFC6838) indicating the nature and format of the content. - */ - mimeType?: string | null; - } - /** - * The long-running operation metadata for the ReviewDocument method. - */ - export interface Schema$GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata { - /** - * The basic metadata of the long-running operation. - */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1CommonOperationMetadata; - /** - * The Crowd Compute question ID. + * The text segments from the Document.text. */ - questionId?: string | null; + textSegments?: Schema$GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment[]; } /** - * Request message for the ReviewDocument method. + * A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset */ - export interface Schema$GoogleCloudDocumentaiV1ReviewDocumentRequest { - /** - * The document schema of the human review task. - */ - documentSchema?: Schema$GoogleCloudDocumentaiV1DocumentSchema; - /** - * Whether the validation should be performed on the ad-hoc review request. - */ - enableSchemaValidation?: boolean | null; + export interface Schema$GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment { /** - * An inline document proto. + * TextSegment half open end UTF-8 char index in the Document.text. */ - inlineDocument?: Schema$GoogleCloudDocumentaiV1Document; + endIndex?: string | null; /** - * The priority of the human review task. + * TextSegment start UTF-8 char index in the Document.text. */ - priority?: string | null; + startIndex?: string | null; } /** - * Response message for the ReviewDocument method. + * This message is used for text changes aka. OCR corrections. */ - export interface Schema$GoogleCloudDocumentaiV1ReviewDocumentResponse { + export interface Schema$GoogleCloudDocumentaiV1DocumentTextChange { /** - * The Cloud Storage uri for the human reviewed document if the review is succeeded. + * The text that replaces the text identified in the `text_anchor`. */ - gcsDestination?: string | null; + changedText?: string | null; /** - * The reason why the review is rejected by reviewer. + * The history of this annotation. */ - rejectionReason?: string | null; + provenance?: Schema$GoogleCloudDocumentaiV1DocumentProvenance[]; /** - * The state of the review operation. + * Provenance of the correction. Text anchor indexing into the Document.text. There can only be a single `TextAnchor.text_segments` element. If the start and end index of the text segment are the same, the text change is inserted before that index. */ - state?: string | null; + textAnchor?: Schema$GoogleCloudDocumentaiV1DocumentTextAnchor; } /** - * The long-running operation metadata for the SetDefaultProcessorVersion method. + * The long-running operation metadata for the EnableProcessor method. */ - export interface Schema$GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata { + export interface Schema$GoogleCloudDocumentaiV1EnableProcessorMetadata { /** * The basic metadata of the long-running operation. */ commonMetadata?: Schema$GoogleCloudDocumentaiV1CommonOperationMetadata; } /** - * Request message for the SetDefaultProcessorVersion method. + * Request message for the EnableProcessor method. */ - export interface Schema$GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest { - /** - * Required. The resource name of child ProcessorVersion to use as default. Format: `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{version\}` - */ - defaultProcessorVersion?: string | null; - } + export interface Schema$GoogleCloudDocumentaiV1EnableProcessorRequest {} /** - * Response message for the SetDefaultProcessorVersion method. + * Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future. */ - export interface Schema$GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse {} + export interface Schema$GoogleCloudDocumentaiV1EnableProcessorResponse {} /** - * The metadata that represents a processor version being created. + * Metadata of the EvaluateProcessorVersion method. */ - export interface Schema$GoogleCloudDocumentaiV1TrainProcessorVersionMetadata { + export interface Schema$GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata { /** * The basic metadata of the long-running operation. */ commonMetadata?: Schema$GoogleCloudDocumentaiV1CommonOperationMetadata; - /** - * The test dataset validation information. - */ - testDatasetValidation?: Schema$GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation; - /** - * The training dataset validation information. - */ - trainingDatasetValidation?: Schema$GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation; } /** - * The dataset validation information. This includes any and all errors with documents and the dataset. + * Evaluates the given ProcessorVersion against the supplied documents. */ - export interface Schema$GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation { - /** - * The total number of dataset errors. - */ - datasetErrorCount?: number | null; - /** - * Error information for the dataset as a whole. A maximum of 10 dataset errors will be returned. A single dataset error is terminal for training. - */ - datasetErrors?: Schema$GoogleRpcStatus[]; + export interface Schema$GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest { /** - * The total number of document errors. + * Optional. The documents used in the evaluation. If unspecified, use the processor's dataset as evaluation input. */ - documentErrorCount?: number | null; + evaluationDocuments?: Schema$GoogleCloudDocumentaiV1BatchDocumentsInputConfig; + } + /** + * Response of the EvaluateProcessorVersion method. + */ + export interface Schema$GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse { /** - * Error information pertaining to specific documents. A maximum of 10 document errors will be returned. Any document with errors will not be used throughout training. + * The resource name of the created evaluation. */ - documentErrors?: Schema$GoogleRpcStatus[]; + evaluation?: string | null; } /** - * Request message for the TrainProcessorVersion method. + * An evaluation of a ProcessorVersion's performance. */ - export interface Schema$GoogleCloudDocumentaiV1TrainProcessorVersionRequest { + export interface Schema$GoogleCloudDocumentaiV1Evaluation { /** - * Optional. The processor version to use as a base for training. This processor version must be a child of `parent`. Format: `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}`. + * Metrics for all the entities in aggregate. */ - baseProcessorVersion?: string | null; + allEntitiesMetrics?: Schema$GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics; /** - * Options to control Custom Document Extraction (CDE) Processor. + * The time that the evaluation was created. */ - customDocumentExtractionOptions?: Schema$GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions; + createTime?: string | null; /** - * Optional. The schema the processor version will be trained with. + * Counters for the documents used in the evaluation. */ - documentSchema?: Schema$GoogleCloudDocumentaiV1DocumentSchema; + documentCounters?: Schema$GoogleCloudDocumentaiV1EvaluationCounters; /** - * Options to control foundation model tuning of a processor. + * Metrics across confidence levels, for different entities. */ - foundationModelTuningOptions?: Schema$GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions; + entityMetrics?: { + [ + key: string + ]: Schema$GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics; + } | null; /** - * Optional. The input data used to train the ProcessorVersion. + * The KMS key name used for encryption. */ - inputData?: Schema$GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData; + kmsKeyName?: string | null; /** - * Required. The processor version to be created. + * The KMS key version with which data is encrypted. */ - processorVersion?: Schema$GoogleCloudDocumentaiV1ProcessorVersion; - } - /** - * Options to control the training of the Custom Document Extraction (CDE) Processor. - */ - export interface Schema$GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions { + kmsKeyVersionName?: string | null; /** - * Optional. Training method to use for CDE training. + * The resource name of the evaluation. Format: `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processor_version\}/evaluations/{evaluation\}` */ - trainingMethod?: string | null; + name?: string | null; } /** - * Options to control foundation model tuning of the processor. + * Evaluations metrics, at a specific confidence level. */ - export interface Schema$GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions { + export interface Schema$GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics { /** - * Optional. The multiplier to apply to the recommended learning rate. Valid values are between 0.1 and 10. If not provided, recommended learning rate will be used. + * The confidence level. */ - learningRateMultiplier?: number | null; + confidenceLevel?: number | null; /** - * Optional. The number of steps to run for model tuning. Valid values are between 1 and 400. If not provided, recommended steps will be used. + * The metrics at the specific confidence level. */ - trainSteps?: number | null; + metrics?: Schema$GoogleCloudDocumentaiV1EvaluationMetrics; } /** - * The input data used to train a new ProcessorVersion. + * Evaluation counters for the documents that were used. */ - export interface Schema$GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData { + export interface Schema$GoogleCloudDocumentaiV1EvaluationCounters { /** - * The documents used for testing the trained version. + * How many documents were used in the evaluation. */ - testDocuments?: Schema$GoogleCloudDocumentaiV1BatchDocumentsInputConfig; + evaluatedDocumentsCount?: number | null; /** - * The documents used for training the new version. + * How many documents were not included in the evaluation as Document AI failed to process them. */ - trainingDocuments?: Schema$GoogleCloudDocumentaiV1BatchDocumentsInputConfig; - } - /** - * The response for TrainProcessorVersion. - */ - export interface Schema$GoogleCloudDocumentaiV1TrainProcessorVersionResponse { + failedDocumentsCount?: number | null; /** - * The resource name of the processor version produced by training. + * How many documents were sent for evaluation. */ - processorVersion?: string | null; - } - /** - * The long-running operation metadata for the UndeployProcessorVersion method. - */ - export interface Schema$GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata { + inputDocumentsCount?: number | null; /** - * The basic metadata of the long-running operation. + * How many documents were not included in the evaluation as they didn't pass validation. */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1CommonOperationMetadata; + invalidDocumentsCount?: number | null; } /** - * Request message for the UndeployProcessorVersion method. - */ - export interface Schema$GoogleCloudDocumentaiV1UndeployProcessorVersionRequest {} - /** - * Response message for the UndeployProcessorVersion method. - */ - export interface Schema$GoogleCloudDocumentaiV1UndeployProcessorVersionResponse {} - /** - * A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. + * Evaluation metrics, either in aggregate or about a specific entity. */ - export interface Schema$GoogleCloudDocumentaiV1Vertex { + export interface Schema$GoogleCloudDocumentaiV1EvaluationMetrics { /** - * X coordinate. + * The calculated f1 score. */ - x?: number | null; + f1Score?: number | null; /** - * Y coordinate (starts from the top of the image). + * The amount of false negatives. */ - y?: number | null; - } - /** - * The response message for Locations.ListLocations. - */ - export interface Schema$GoogleCloudLocationListLocationsResponse { + falseNegativesCount?: number | null; /** - * A list of locations that matches the specified filter in the request. + * The amount of false positives. */ - locations?: Schema$GoogleCloudLocationLocation[]; + falsePositivesCount?: number | null; /** - * The standard List next-page token. + * The amount of documents with a ground truth occurrence. */ - nextPageToken?: string | null; - } - /** - * A resource that represents a Google Cloud location. - */ - export interface Schema$GoogleCloudLocationLocation { + groundTruthDocumentCount?: number | null; /** - * The friendly name for this location, typically a nearby city name. For example, "Tokyo". + * The amount of occurrences in ground truth documents. */ - displayName?: string | null; + groundTruthOccurrencesCount?: number | null; /** - * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"\} + * The calculated precision. */ - labels?: {[key: string]: string} | null; + precision?: number | null; /** - * The canonical id for this location. For example: `"us-east1"`. + * The amount of documents with a predicted occurrence. */ - locationId?: string | null; + predictedDocumentCount?: number | null; /** - * Service-specific metadata. For example the available capacity at the given location. + * The amount of occurrences in predicted documents. */ - metadata?: {[key: string]: any} | null; + predictedOccurrencesCount?: number | null; /** - * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` + * The calculated recall. */ - name?: string | null; + recall?: number | null; + /** + * The amount of documents that had an occurrence of this label. + */ + totalDocumentsCount?: number | null; + /** + * The amount of true positives. + */ + truePositivesCount?: number | null; } /** - * The response message for Operations.ListOperations. + * Metrics across multiple confidence levels. */ - export interface Schema$GoogleLongrunningListOperationsResponse { + export interface Schema$GoogleCloudDocumentaiV1EvaluationMultiConfidenceMetrics { /** - * The standard List next-page token. + * The calculated area under the precision recall curve (AUPRC), computed by integrating over all confidence thresholds. */ - nextPageToken?: string | null; + auprc?: number | null; /** - * A list of operations that matches the specified filter in the request. + * The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching only. */ - operations?: Schema$GoogleLongrunningOperation[]; + auprcExact?: number | null; /** - * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + * Metrics across confidence levels with fuzzy matching enabled. */ - unreachable?: string[] | null; + confidenceLevelMetrics?: Schema$GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics[]; + /** + * Metrics across confidence levels with only exact matching. + */ + confidenceLevelMetricsExact?: Schema$GoogleCloudDocumentaiV1EvaluationConfidenceLevelMetrics[]; + /** + * The Estimated Calibration Error (ECE) of the confidence of the predicted entities. + */ + estimatedCalibrationError?: number | null; + /** + * The ECE for the predicted entities with fuzzy matching disabled, i.e., exact matching only. + */ + estimatedCalibrationErrorExact?: number | null; + /** + * The metrics type for the label. + */ + metricsType?: string | null; } /** - * This resource represents a long-running operation that is the result of a network API call. + * Gives a short summary of an evaluation, and links to the evaluation itself. */ - export interface Schema$GoogleLongrunningOperation { - /** - * 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. - */ - done?: boolean | null; + export interface Schema$GoogleCloudDocumentaiV1EvaluationReference { /** - * The error result of the operation in case of failure or cancellation. + * An aggregate of the statistics for the evaluation with fuzzy matching on. */ - error?: Schema$GoogleRpcStatus; + aggregateMetrics?: Schema$GoogleCloudDocumentaiV1EvaluationMetrics; /** - * 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. + * An aggregate of the statistics for the evaluation with fuzzy matching off. */ - metadata?: {[key: string]: any} | null; + aggregateMetricsExact?: Schema$GoogleCloudDocumentaiV1EvaluationMetrics; /** - * 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\}`. + * The resource name of the evaluation. */ - name?: string | null; + evaluation?: string | null; /** - * 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`. + * The resource name of the Long Running Operation for the evaluation. */ - response?: {[key: string]: any} | null; + operation?: string | null; } /** - * 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); \} + * Response message for the FetchProcessorTypes method. */ - export interface Schema$GoogleProtobufEmpty {} + export interface Schema$GoogleCloudDocumentaiV1FetchProcessorTypesResponse { + /** + * The list of processor types. + */ + processorTypes?: Schema$GoogleCloudDocumentaiV1ProcessorType[]; + } /** - * 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). + * Specifies a document stored on Cloud Storage. */ - export interface Schema$GoogleRpcStatus { + export interface Schema$GoogleCloudDocumentaiV1GcsDocument { /** - * The status code, which should be an enum value of google.rpc.Code. + * The Cloud Storage object uri. */ - code?: number | null; + gcsUri?: string | null; /** - * A list of messages that carry the error details. There is a common set of message types for APIs to use. + * An IANA MIME type (RFC6838) of the content. */ - details?: Array<{[key: string]: any}> | null; + mimeType?: string | null; + } + /** + * Specifies a set of documents on Cloud Storage. + */ + export interface Schema$GoogleCloudDocumentaiV1GcsDocuments { /** - * 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. + * The list of documents. */ - message?: string | null; + documents?: Schema$GoogleCloudDocumentaiV1GcsDocument[]; } /** - * Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); \} public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); \} return resultBuilder.build(); \} // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; \} return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; \} static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; \} Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; \} [result autorelease]; return result; \} // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); \} var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); \}; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); \} resultBuilder.push(hexString); return resultBuilder.join(''); \}; // ... + * Specifies all documents on Cloud Storage with a common prefix. */ - export interface Schema$GoogleTypeColor { + export interface Schema$GoogleCloudDocumentaiV1GcsPrefix { /** - * The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0). + * The URI prefix. */ - alpha?: number | null; + gcsUriPrefix?: string | null; + } + /** + * Request message for GenerateSchemaVersion. + */ + export interface Schema$GoogleCloudDocumentaiV1GenerateSchemaVersionRequest { /** - * The amount of blue in the color as a value in the interval [0, 1]. + * The base schema version name to use for the schema generation. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}/schemaVersions/{schema_version\}` */ - blue?: number | null; + baseSchemaVersion?: string | null; /** - * The amount of green in the color as a value in the interval [0, 1]. + * The set of documents placed on Cloud Storage. */ - green?: number | null; + gcsDocuments?: Schema$GoogleCloudDocumentaiV1GcsDocuments; /** - * The amount of red in the color as a value in the interval [0, 1]. + * The common prefix of documents placed on Cloud Storage. */ - red?: number | null; - } - /** - * Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp - */ - export interface Schema$GoogleTypeDate { + gcsPrefix?: Schema$GoogleCloudDocumentaiV1GcsPrefix; /** - * Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + * Optional. User specified parameters for the schema generation. */ - day?: number | null; + generateSchemaVersionParams?: Schema$GoogleCloudDocumentaiV1GenerateSchemaVersionRequestGenerateSchemaVersionParams; /** - * Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + * The set of documents specified inline. */ - month?: number | null; + inlineDocuments?: Schema$GoogleCloudDocumentaiV1Documents; /** - * Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + * The set of raw documents. */ - year?: number | null; + rawDocuments?: Schema$GoogleCloudDocumentaiV1RawDocuments; } /** - * Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. + * The parameters for the schema generation. */ - export interface Schema$GoogleTypeDateTime { - /** - * Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day. - */ - day?: number | null; + export interface Schema$GoogleCloudDocumentaiV1GenerateSchemaVersionRequestGenerateSchemaVersionParams { /** - * Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time. + * Optional. Previous prompt-answers in a chronological order. */ - hours?: number | null; + history?: Schema$GoogleCloudDocumentaiV1SchemaGenerationHistory; /** - * Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0. + * Optional. The prompt used for the schema generation. */ - minutes?: number | null; + prompt?: string | null; + } + /** + * Response message for GenerateSchemaVersion. + */ + export interface Schema$GoogleCloudDocumentaiV1GenerateSchemaVersionResponse { /** - * Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month. + * The schema version generated by the model. */ - month?: number | null; + schemaVersion?: Schema$GoogleCloudDocumentaiV1SchemaVersion; + } + /** + * The status of human review on a processed document. + */ + export interface Schema$GoogleCloudDocumentaiV1HumanReviewStatus { /** - * Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0. + * The name of the operation triggered by the processed document. This field is populated only when the state is `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as the long-running operation returned by ReviewDocument. */ - nanos?: number | null; + humanReviewOperation?: string | null; /** - * Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds. + * The state of human review on the processing request. */ - seconds?: number | null; + state?: string | null; /** - * Time zone. + * A message providing more details about the human review state. */ - timeZone?: Schema$GoogleTypeTimeZone; + stateMessage?: string | null; + } + /** + * The response from `ListEvaluations`. + */ + export interface Schema$GoogleCloudDocumentaiV1ListEvaluationsResponse { /** - * UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 \}. + * The evaluations requested. */ - utcOffset?: string | null; + evaluations?: Schema$GoogleCloudDocumentaiV1Evaluation[]; /** - * Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */ - year?: number | null; + nextPageToken?: string | null; } /** - * Represents an amount of money with its currency type. + * Response message for the ListProcessors method. */ - export interface Schema$GoogleTypeMoney { + export interface Schema$GoogleCloudDocumentaiV1ListProcessorsResponse { /** - * The three-letter currency code defined in ISO 4217. + * Points to the next processor, otherwise empty. */ - currencyCode?: string | null; + nextPageToken?: string | null; /** - * Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. + * The list of processors. */ - nanos?: number | null; + processors?: Schema$GoogleCloudDocumentaiV1Processor[]; + } + /** + * Response message for the ListProcessorTypes method. + */ + export interface Schema$GoogleCloudDocumentaiV1ListProcessorTypesResponse { /** - * The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. + * Points to the next page, otherwise empty. */ - units?: string | null; + nextPageToken?: string | null; + /** + * The processor types. + */ + processorTypes?: Schema$GoogleCloudDocumentaiV1ProcessorType[]; } /** - * Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. + * Response message for the ListProcessorVersions method. */ - export interface Schema$GoogleTypePostalAddress { + export interface Schema$GoogleCloudDocumentaiV1ListProcessorVersionsResponse { /** - * Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). + * Points to the next processor, otherwise empty. */ - addressLines?: string[] | null; + nextPageToken?: string | null; /** - * Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated. + * The list of processors. */ - administrativeArea?: string | null; + processorVersions?: Schema$GoogleCloudDocumentaiV1ProcessorVersion[]; + } + /** + * Response message for ListSchemas. + */ + export interface Schema$GoogleCloudDocumentaiV1ListSchemasResponse { /** - * Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en". + * Points to the next Schema, otherwise empty. */ - languageCode?: string | null; + nextPageToken?: string | null; /** - * Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`. + * The list of Schemas. */ - locality?: string | null; + schemas?: Schema$GoogleCloudDocumentaiV1NextSchema[]; + } + /** + * Response message for ListSchemaVersions. + */ + export interface Schema$GoogleCloudDocumentaiV1ListSchemaVersionsResponse { /** - * Optional. The name of the organization at the address. + * Points to the next SchemaVersion, otherwise empty. */ - organization?: string | null; + nextPageToken?: string | null; /** - * Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States). + * The list of SchemaVersions. */ - postalCode?: string | null; + schemaVersions?: Schema$GoogleCloudDocumentaiV1SchemaVersion[]; + } + /** + * NextSchema is a collection of SchemaVersions. + */ + export interface Schema$GoogleCloudDocumentaiV1NextSchema { /** - * Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information. + * Output only. The time when the Schema was created. */ - recipients?: string[] | null; + createTime?: string | null; /** - * Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. + * Optional. The user-defined name of the Schema. */ - regionCode?: string | null; + displayName?: string | null; /** - * The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions. + * Optional. The GCP labels for the Schema. */ - revision?: number | null; + labels?: {[key: string]: string} | null; /** - * Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire). + * Identifier. The resource name of the Schema. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}` */ - sortingCode?: string | null; + name?: string | null; /** - * Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district. + * Output only. The time when the Schema was last updated. */ - sublocality?: string | null; + updateTime?: string | null; } /** - * Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ - export interface Schema$GoogleTypeTimeZone { + export interface Schema$GoogleCloudDocumentaiV1NormalizedVertex { /** - * IANA Time Zone Database time zone. For example "America/New_York". + * X coordinate. */ - id?: string | null; + x?: number | null; /** - * Optional. IANA Time Zone Database version number. For example "2019a". + * Y coordinate (starts from the top of the image). */ - version?: string | null; + y?: number | null; + } + /** + * Config for Document OCR. + */ + export interface Schema$GoogleCloudDocumentaiV1OcrConfig { + /** + * A list of advanced OCR options to further fine-tune OCR behavior. Current valid values are: - `legacy_layout`: a heuristics layout detection algorithm, which serves as an alternative to the current ML-based layout detection algorithm. Customers can choose the best suitable layout algorithm based on their situation. + */ + advancedOcrOptions?: string[] | null; + /** + * Turn on font identification model and return font style information. Deprecated, use PremiumFeatures.compute_style_info instead. + */ + computeStyleInfo?: boolean | null; + /** + * Turn off character box detector in OCR engine. Character box detection is enabled by default in OCR 2.0 (and later) processors. + */ + disableCharacterBoxesDetection?: boolean | null; + /** + * Enables intelligent document quality scores after OCR. Can help with diagnosing why OCR responses are of poor quality for a given input. Adds additional latency comparable to regular OCR to the process call. + */ + enableImageQualityScores?: boolean | null; + /** + * Enables special handling for PDFs with existing text information. Results in better text extraction quality in such PDF inputs. + */ + enableNativePdfParsing?: boolean | null; + /** + * Includes symbol level OCR information if set to true. + */ + enableSymbol?: boolean | null; + /** + * Hints for the OCR model. + */ + hints?: Schema$GoogleCloudDocumentaiV1OcrConfigHints; + /** + * Configurations for premium OCR features. + */ + premiumFeatures?: Schema$GoogleCloudDocumentaiV1OcrConfigPremiumFeatures; + } + /** + * Hints for OCR Engine + */ + export interface Schema$GoogleCloudDocumentaiV1OcrConfigHints { + /** + * List of BCP-47 language codes to use for OCR. In most cases, not specifying it yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting hints is not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a significant hindrance if the hint is wrong). + */ + languageHints?: string[] | null; + } + /** + * Configurations for premium OCR features. + */ + export interface Schema$GoogleCloudDocumentaiV1OcrConfigPremiumFeatures { + /** + * Turn on font identification model and return font style information. + */ + computeStyleInfo?: boolean | null; + /** + * Turn on the model that can extract LaTeX math formulas. + */ + enableMathOcr?: boolean | null; + /** + * Turn on selection mark detector in OCR engine. Only available in OCR 2.0 (and later) processors. + */ + enableSelectionMarkDetection?: boolean | null; + } + /** + * Options for Process API + */ + export interface Schema$GoogleCloudDocumentaiV1ProcessOptions { + /** + * Only process certain pages from the end, same as above. + */ + fromEnd?: number | null; + /** + * Only process certain pages from the start. Process all if the document has fewer pages. + */ + fromStart?: number | null; + /** + * Which pages to process (1-indexed). + */ + individualPageSelector?: Schema$GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector; + /** + * Optional. Only applicable to `LAYOUT_PARSER_PROCESSOR`. Returns error if set on other processor types. + */ + layoutConfig?: Schema$GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig; + /** + * Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. Returns error if set on other processor types. + */ + ocrConfig?: Schema$GoogleCloudDocumentaiV1OcrConfig; + /** + * Optional. Override the schema of the ProcessorVersion. Will return an Invalid Argument error if this field is set when the underlying ProcessorVersion doesn't support schema override. + */ + schemaOverride?: Schema$GoogleCloudDocumentaiV1DocumentSchema; + } + /** + * A list of individual page numbers. + */ + export interface Schema$GoogleCloudDocumentaiV1ProcessOptionsIndividualPageSelector { + /** + * Optional. Indices of the pages (starting from 1). + */ + pages?: number[] | null; + } + /** + * Serving config for layout parser processor. + */ + export interface Schema$GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig { + /** + * Optional. Config for chunking in layout parser processor. + */ + chunkingConfig?: Schema$GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig; + /** + * Optional. Whether to include image annotations in layout parser response. + */ + enableImageAnnotation?: boolean | null; + /** + * Optional. Whether to include table annotations in layout parser response. + */ + enableTableAnnotation?: boolean | null; + /** + * Optional. Whether to include bounding boxes in layout parser processor response. + */ + returnBoundingBoxes?: boolean | null; + /** + * Optional. Whether to include images in layout parser processor response. + */ + returnImages?: boolean | null; + } + /** + * Serving config for chunking. + */ + export interface Schema$GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig { + /** + * Optional. The chunk sizes to use when splitting documents, in order of level. + */ + chunkSize?: number | null; + /** + * Optional. Whether or not to include ancestor headings when splitting. + */ + includeAncestorHeadings?: boolean | null; + } + /** + * The first-class citizen for Document AI. Each processor defines how to extract structural information from a document. + */ + export interface Schema$GoogleCloudDocumentaiV1Processor { + /** + * Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project\}/locations/{location\}/schemas/{schema\}/schemaVersions/{schema_version\} + */ + activeSchemaVersion?: string | null; + /** + * Output only. The time the processor was created. + */ + createTime?: string | null; + /** + * The default processor version. + */ + defaultProcessorVersion?: string | null; + /** + * The display name of the processor. + */ + displayName?: string | null; + /** + * The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios. + */ + kmsKeyName?: string | null; + /** + * Output only. Immutable. The resource name of the processor. Format: `projects/{project\}/locations/{location\}/processors/{processor\}` + */ + name?: string | null; + /** + * Output only. Immutable. The http endpoint that can be called to invoke processing. + */ + processEndpoint?: string | null; + /** + * Output only. The processor version aliases. + */ + processorVersionAliases?: Schema$GoogleCloudDocumentaiV1ProcessorVersionAlias[]; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; + /** + * Output only. The state of the processor. + */ + state?: string | null; + /** + * The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor types, see FetchProcessorTypes. + */ + type?: string | null; + } + /** + * A processor type is responsible for performing a certain document understanding task on a certain type of document. + */ + export interface Schema$GoogleCloudDocumentaiV1ProcessorType { + /** + * Whether the processor type allows creation. If true, users can create a processor of this processor type. Otherwise, users need to request access. + */ + allowCreation?: boolean | null; + /** + * The locations in which this processor is available. + */ + availableLocations?: Schema$GoogleCloudDocumentaiV1ProcessorTypeLocationInfo[]; + /** + * The processor category, used by UI to group processor types. + */ + category?: string | null; + /** + * Launch stage of the processor type + */ + launchStage?: string | null; + /** + * The resource name of the processor type. Format: `projects/{project\}/processorTypes/{processor_type\}` + */ + name?: string | null; + /** + * A set of Cloud Storage URIs of sample documents for this processor. + */ + sampleDocumentUris?: string[] | null; + /** + * The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. + */ + type?: string | null; + } + /** + * The location information about where the processor is available. + */ + export interface Schema$GoogleCloudDocumentaiV1ProcessorTypeLocationInfo { + /** + * The location ID. For supported locations, refer to [regional and multi-regional support](/document-ai/docs/regions). + */ + locationId?: string | null; } + /** + * 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. + */ + export interface Schema$GoogleCloudDocumentaiV1ProcessorVersion { + /** + * Output only. The time the processor version was created. + */ + createTime?: string | null; + /** + * Output only. If set, information about the eventual deprecation of this version. + */ + deprecationInfo?: Schema$GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo; + /** + * The display name of the processor version. + */ + displayName?: string | null; + /** + * Output only. The schema of the processor version. Describes the output. + */ + documentSchema?: Schema$GoogleCloudDocumentaiV1DocumentSchema; + /** + * Output only. Information about Generative AI model-based processor versions. + */ + genAiModelInfo?: Schema$GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo; + /** + * Output only. Denotes that this `ProcessorVersion` is managed by Google. + */ + googleManaged?: boolean | null; + /** + * Output only. The KMS key name used for encryption. + */ + kmsKeyName?: string | null; + /** + * Output only. The KMS key version with which data is encrypted. + */ + kmsKeyVersionName?: string | null; + /** + * Output only. The most recently invoked evaluation for the processor version. + */ + latestEvaluation?: Schema$GoogleCloudDocumentaiV1EvaluationReference; + /** + * Output only. The model type of this processor version. + */ + modelType?: string | null; + /** + * Identifier. The resource name of the processor version. Format: `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processor_version\}` + */ + name?: string | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; + /** + * Output only. The state of the processor version. + */ + state?: string | null; + } + /** + * Contains the alias and the aliased resource name of processor version. + */ + export interface Schema$GoogleCloudDocumentaiV1ProcessorVersionAlias { + /** + * The alias in the form of `processor_version` resource name. + */ + alias?: string | null; + /** + * The resource name of aliased processor version. + */ + processorVersion?: string | null; + } + /** + * Information about the upcoming deprecation of this processor version. + */ + export interface Schema$GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo { + /** + * The time at which this processor version will be deprecated. + */ + deprecationTime?: string | null; + /** + * If set, the processor version that will be used as a replacement. + */ + replacementProcessorVersion?: string | null; + } + /** + * Information about Generative AI model-based processor versions. + */ + export interface Schema$GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo { + /** + * Information for a custom Generative AI model created by the user. + */ + customGenAiModelInfo?: Schema$GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo; + /** + * Information for a pretrained Google-managed foundation model. + */ + foundationGenAiModelInfo?: Schema$GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo; + } + /** + * Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs. + */ + export interface Schema$GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo { + /** + * The base processor version ID for the custom model. + */ + baseProcessorVersionId?: string | null; + /** + * The type of custom model created by the user. + */ + customModelType?: string | null; + } + /** + * Information for a pretrained Google-managed foundation model. + */ + export interface Schema$GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo { + /** + * Whether finetuning is allowed for this base processor version. + */ + finetuningAllowed?: boolean | null; + /** + * The minimum number of labeled documents in the training dataset required for finetuning. + */ + minTrainLabeledDocuments?: number | null; + } + /** + * Request message for the ProcessDocument method. + */ + export interface Schema$GoogleCloudDocumentaiV1ProcessRequest { + /** + * Specifies which fields to include in the ProcessResponse.document output. Only supports top-level document and pages field, so it must be in the form of `{document_field_name\}` or `pages.{page_field_name\}`. + */ + fieldMask?: string | null; + /** + * A raw document on Google Cloud Storage. + */ + gcsDocument?: Schema$GoogleCloudDocumentaiV1GcsDocument; + /** + * Optional. Option to remove images from the document. + */ + imagelessMode?: boolean | null; + /** + * An inline document proto. + */ + inlineDocument?: Schema$GoogleCloudDocumentaiV1Document; + /** + * Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. + */ + labels?: {[key: string]: string} | null; + /** + * Inference-time options for the process API + */ + processOptions?: Schema$GoogleCloudDocumentaiV1ProcessOptions; + /** + * A raw document content (bytes). + */ + rawDocument?: Schema$GoogleCloudDocumentaiV1RawDocument; + /** + * Whether human review should be skipped for this request. Default to `false`. + */ + skipHumanReview?: boolean | null; + } + /** + * Response message for the ProcessDocument method. + */ + export interface Schema$GoogleCloudDocumentaiV1ProcessResponse { + /** + * The document payload, will populate fields based on the processor's behavior. + */ + document?: Schema$GoogleCloudDocumentaiV1Document; + /** + * The status of human review on the processed document. + */ + humanReviewStatus?: Schema$GoogleCloudDocumentaiV1HumanReviewStatus; + } + /** + * Payload message of raw document content (bytes). + */ + export interface Schema$GoogleCloudDocumentaiV1RawDocument { + /** + * Inline document content. + */ + content?: string | null; + /** + * The display name of the document, it supports all Unicode characters except the following: `*`, `?`, `[`, `]`, `%`, `{`, `\}`,`'`, `\"`, `,` `~`, `=` and `:` are reserved. If not specified, a default ID is generated. + */ + displayName?: string | null; + /** + * An IANA MIME type (RFC6838) indicating the nature and format of the content. + */ + mimeType?: string | null; + } + /** + * Specifies a set of raw documents. + */ + export interface Schema$GoogleCloudDocumentaiV1RawDocuments { + /** + * Specifies raw document content and mime type. + */ + documents?: Schema$GoogleCloudDocumentaiV1RawDocument[]; + } + /** + * The long-running operation metadata for the ReviewDocument method. + */ + export interface Schema$GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata { + /** + * The basic metadata of the long-running operation. + */ + commonMetadata?: Schema$GoogleCloudDocumentaiV1CommonOperationMetadata; + /** + * The Crowd Compute question ID. + */ + questionId?: string | null; + } + /** + * Request message for the ReviewDocument method. + */ + export interface Schema$GoogleCloudDocumentaiV1ReviewDocumentRequest { + /** + * The document schema of the human review task. + */ + documentSchema?: Schema$GoogleCloudDocumentaiV1DocumentSchema; + /** + * Whether the validation should be performed on the ad-hoc review request. + */ + enableSchemaValidation?: boolean | null; + /** + * An inline document proto. + */ + inlineDocument?: Schema$GoogleCloudDocumentaiV1Document; + /** + * The priority of the human review task. + */ + priority?: string | null; + } + /** + * Response message for the ReviewDocument method. + */ + export interface Schema$GoogleCloudDocumentaiV1ReviewDocumentResponse { + /** + * The Cloud Storage uri for the human reviewed document if the review is succeeded. + */ + gcsDestination?: string | null; + /** + * The reason why the review is rejected by reviewer. + */ + rejectionReason?: string | null; + /** + * The state of the review operation. + */ + state?: string | null; + } + /** + * The history of schema generation iterations. + */ + export interface Schema$GoogleCloudDocumentaiV1SchemaGenerationHistory { + /** + * Required. Previous prompt-answers in a chronological order. + */ + iterations?: Schema$GoogleCloudDocumentaiV1SchemaGenerationIteration[]; + } + /** + * A single iteration of the schema generation. + */ + export interface Schema$GoogleCloudDocumentaiV1SchemaGenerationIteration { + /** + * Optional. The previous schema version adjusted by the model. + */ + adjustedSchema?: Schema$GoogleCloudDocumentaiV1SchemaVersion; + /** + * Required. The schema version generated by the model. + */ + generatedSchema?: Schema$GoogleCloudDocumentaiV1SchemaVersion; + /** + * Optional. The prompt used for the iteration. + */ + prompt?: string | null; + } + /** + * SchemaVersion is a version of the Schema which is created in SchemaGroup. + */ + export interface Schema$GoogleCloudDocumentaiV1SchemaVersion { + /** + * Output only. The time when the SchemaVersion was created. + */ + createTime?: string | null; + /** + * Optional. The user-defined name of the SchemaVersion. + */ + displayName?: string | null; + /** + * Optional. The GCP labels for the SchemaVersion. + */ + labels?: {[key: string]: string} | null; + /** + * Identifier. The resource name of the SchemaVersion. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}/schemaVersions/{schema_version\}` + */ + name?: string | null; + /** + * Required. The schema of the SchemaVersion. + */ + schema?: Schema$GoogleCloudDocumentaiV1DocumentSchema; + } + /** + * The long-running operation metadata for the SetDefaultProcessorVersion method. + */ + export interface Schema$GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata { + /** + * The basic metadata of the long-running operation. + */ + commonMetadata?: Schema$GoogleCloudDocumentaiV1CommonOperationMetadata; + } + /** + * Request message for the SetDefaultProcessorVersion method. + */ + export interface Schema$GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest { + /** + * Required. The resource name of child ProcessorVersion to use as default. Format: `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{version\}` + */ + defaultProcessorVersion?: string | null; + } + /** + * Response message for the SetDefaultProcessorVersion method. + */ + export interface Schema$GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse {} + /** + * The metadata that represents a processor version being created. + */ + export interface Schema$GoogleCloudDocumentaiV1TrainProcessorVersionMetadata { + /** + * The basic metadata of the long-running operation. + */ + commonMetadata?: Schema$GoogleCloudDocumentaiV1CommonOperationMetadata; + /** + * The test dataset validation information. + */ + testDatasetValidation?: Schema$GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation; + /** + * The training dataset validation information. + */ + trainingDatasetValidation?: Schema$GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation; + } + /** + * The dataset validation information. This includes any and all errors with documents and the dataset. + */ + export interface Schema$GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation { + /** + * The total number of dataset errors. + */ + datasetErrorCount?: number | null; + /** + * Error information for the dataset as a whole. A maximum of 10 dataset errors will be returned. A single dataset error is terminal for training. + */ + datasetErrors?: Schema$GoogleRpcStatus[]; + /** + * The total number of document errors. + */ + documentErrorCount?: number | null; + /** + * Error information pertaining to specific documents. A maximum of 10 document errors will be returned. Any document with errors will not be used throughout training. + */ + documentErrors?: Schema$GoogleRpcStatus[]; + } + /** + * Request message for the TrainProcessorVersion method. + */ + export interface Schema$GoogleCloudDocumentaiV1TrainProcessorVersionRequest { + /** + * Optional. The processor version to use as a base for training. This processor version must be a child of `parent`. Format: `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}`. + */ + baseProcessorVersion?: string | null; + /** + * Options to control Custom Document Extraction (CDE) Processor. + */ + customDocumentExtractionOptions?: Schema$GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions; + /** + * Optional. The schema the processor version will be trained with. + */ + documentSchema?: Schema$GoogleCloudDocumentaiV1DocumentSchema; + /** + * Options to control foundation model tuning of a processor. + */ + foundationModelTuningOptions?: Schema$GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions; + /** + * Optional. The input data used to train the ProcessorVersion. + */ + inputData?: Schema$GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData; + /** + * Required. The processor version to be created. + */ + processorVersion?: Schema$GoogleCloudDocumentaiV1ProcessorVersion; + } + /** + * Options to control the training of the Custom Document Extraction (CDE) Processor. + */ + export interface Schema$GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions { + /** + * Optional. Training method to use for CDE training. + */ + trainingMethod?: string | null; + } + /** + * Options to control foundation model tuning of the processor. + */ + export interface Schema$GoogleCloudDocumentaiV1TrainProcessorVersionRequestFoundationModelTuningOptions { + /** + * Optional. The multiplier to apply to the recommended learning rate. Valid values are between 0.1 and 10. If not provided, recommended learning rate will be used. + */ + learningRateMultiplier?: number | null; + /** + * Optional. The number of steps to run for model tuning. Valid values are between 1 and 400. If not provided, recommended steps will be used. + */ + trainSteps?: number | null; + } + /** + * The input data used to train a new ProcessorVersion. + */ + export interface Schema$GoogleCloudDocumentaiV1TrainProcessorVersionRequestInputData { + /** + * The documents used for testing the trained version. + */ + testDocuments?: Schema$GoogleCloudDocumentaiV1BatchDocumentsInputConfig; + /** + * The documents used for training the new version. + */ + trainingDocuments?: Schema$GoogleCloudDocumentaiV1BatchDocumentsInputConfig; + } + /** + * The response for TrainProcessorVersion. + */ + export interface Schema$GoogleCloudDocumentaiV1TrainProcessorVersionResponse { + /** + * The resource name of the processor version produced by training. + */ + processorVersion?: string | null; + } + /** + * The long-running operation metadata for the UndeployProcessorVersion method. + */ + export interface Schema$GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata { + /** + * The basic metadata of the long-running operation. + */ + commonMetadata?: Schema$GoogleCloudDocumentaiV1CommonOperationMetadata; + } + /** + * Request message for the UndeployProcessorVersion method. + */ + export interface Schema$GoogleCloudDocumentaiV1UndeployProcessorVersionRequest {} + /** + * Response message for the UndeployProcessorVersion method. + */ + export interface Schema$GoogleCloudDocumentaiV1UndeployProcessorVersionResponse {} + /** + * A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. + */ + export interface Schema$GoogleCloudDocumentaiV1Vertex { + /** + * X coordinate. + */ + x?: number | null; + /** + * Y coordinate (starts from the top of the image). + */ + y?: number | null; + } + /** + * The response message for Locations.ListLocations. + */ + export interface Schema$GoogleCloudLocationListLocationsResponse { + /** + * A list of locations that matches the specified filter in the request. + */ + locations?: Schema$GoogleCloudLocationLocation[]; + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + } + /** + * A resource that represents a Google Cloud location. + */ + export interface Schema$GoogleCloudLocationLocation { + /** + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". + */ + displayName?: string | null; + /** + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"\} + */ + labels?: {[key: string]: string} | null; + /** + * The canonical id for this location. For example: `"us-east1"`. + */ + locationId?: string | null; + /** + * Service-specific metadata. For example the available capacity at the given location. + */ + metadata?: {[key: string]: any} | null; + /** + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` + */ + name?: string | null; + } + /** + * The response message for Operations.ListOperations. + */ + export interface Schema$GoogleLongrunningListOperationsResponse { + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + /** + * A list of operations that matches the specified filter in the request. + */ + operations?: Schema$GoogleLongrunningOperation[]; + /** + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; + } + /** + * This resource represents a long-running operation that is the result of a network API call. + */ + export interface Schema$GoogleLongrunningOperation { + /** + * 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. + */ + done?: boolean | null; + /** + * The error result of the operation in case of failure or cancellation. + */ + error?: Schema$GoogleRpcStatus; + /** + * 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. + */ + metadata?: {[key: string]: any} | null; + /** + * 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\}`. + */ + name?: string | null; + /** + * 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`. + */ + response?: {[key: string]: any} | null; + } + /** + * 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); \} + */ + export interface Schema$GoogleProtobufEmpty {} + /** + * 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). + */ + export interface Schema$GoogleRpcStatus { + /** + * The status code, which should be an enum value of google.rpc.Code. + */ + code?: number | null; + /** + * A list of messages that carry the error details. There is a common set of message types for APIs to use. + */ + details?: Array<{[key: string]: any}> | null; + /** + * 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. + */ + message?: string | null; + } + /** + * Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); \} public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); \} return resultBuilder.build(); \} // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; \} return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; \} static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; \} Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; \} [result autorelease]; return result; \} // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); \} var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); \}; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); \} resultBuilder.push(hexString); return resultBuilder.join(''); \}; // ... + */ + export interface Schema$GoogleTypeColor { + /** + * The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0). + */ + alpha?: number | null; + /** + * The amount of blue in the color as a value in the interval [0, 1]. + */ + blue?: number | null; + /** + * The amount of green in the color as a value in the interval [0, 1]. + */ + green?: number | null; + /** + * The amount of red in the color as a value in the interval [0, 1]. + */ + red?: number | null; + } + /** + * Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp + */ + export interface Schema$GoogleTypeDate { + /** + * Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + */ + day?: number | null; + /** + * Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + */ + month?: number | null; + /** + * Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + */ + year?: number | null; + } + /** + * Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. + */ + export interface Schema$GoogleTypeDateTime { + /** + * Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day. + */ + day?: number | null; + /** + * Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time. + */ + hours?: number | null; + /** + * Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0. + */ + minutes?: number | null; + /** + * Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month. + */ + month?: number | null; + /** + * Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0. + */ + nanos?: number | null; + /** + * Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds. + */ + seconds?: number | null; + /** + * Time zone. + */ + timeZone?: Schema$GoogleTypeTimeZone; + /** + * UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 \}. + */ + utcOffset?: string | null; + /** + * Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. + */ + year?: number | null; + } + /** + * Represents an amount of money with its currency type. + */ + export interface Schema$GoogleTypeMoney { + /** + * The three-letter currency code defined in ISO 4217. + */ + currencyCode?: string | null; + /** + * Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. + */ + nanos?: number | null; + /** + * The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. + */ + units?: string | null; + } + /** + * Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. + */ + export interface Schema$GoogleTypePostalAddress { + /** + * Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). + */ + addressLines?: string[] | null; + /** + * Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated. + */ + administrativeArea?: string | null; + /** + * Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en". + */ + languageCode?: string | null; + /** + * Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`. + */ + locality?: string | null; + /** + * Optional. The name of the organization at the address. + */ + organization?: string | null; + /** + * Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States). + */ + postalCode?: string | null; + /** + * Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information. + */ + recipients?: string[] | null; + /** + * Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. + */ + regionCode?: string | null; + /** + * The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions. + */ + revision?: number | null; + /** + * Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire). + */ + sortingCode?: string | null; + /** + * Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district. + */ + sublocality?: string | null; + } + /** + * Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). + */ + export interface Schema$GoogleTypeTimeZone { + /** + * IANA Time Zone Database time zone. For example "America/New_York". + */ + id?: string | null; + /** + * Optional. IANA Time Zone Database version number. For example "2019a". + */ + version?: string | null; + } + + export class Resource$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/documentai.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const documentai = google.documentai('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await documentai.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'operations/.*', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Operations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Operations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://documentai.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + + export class Resource$Projects { + context: APIRequestContext; + locations: Resource$Projects$Locations; + operations: Resource$Projects$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Projects$Locations(this.context); + this.operations = new Resource$Projects$Operations(this.context); + } + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + operations: Resource$Projects$Locations$Operations; + processors: Resource$Projects$Locations$Processors; + processorTypes: Resource$Projects$Locations$Processortypes; + schemas: Resource$Projects$Locations$Schemas; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Projects$Locations$Operations( + this.context + ); + this.processors = new Resource$Projects$Locations$Processors( + this.context + ); + this.processorTypes = new Resource$Projects$Locations$Processortypes( + this.context + ); + this.schemas = new Resource$Projects$Locations$Schemas(this.context); + } + + /** + * Fetches processor types. Note that we don't use ListProcessorTypes here, because it isn't paginated. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/documentai.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const documentai = google.documentai('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await documentai.projects.locations.fetchProcessorTypes({ + * // Required. The location of processor types to list. Format: `projects/{project\}/locations/{location\}`. + * parent: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "processorTypes": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + fetchProcessorTypes( + params: Params$Resource$Projects$Locations$Fetchprocessortypes, + options: StreamMethodOptions + ): Promise>; + fetchProcessorTypes( + params?: Params$Resource$Projects$Locations$Fetchprocessortypes, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + fetchProcessorTypes( + params: Params$Resource$Projects$Locations$Fetchprocessortypes, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchProcessorTypes( + params: Params$Resource$Projects$Locations$Fetchprocessortypes, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchProcessorTypes( + params: Params$Resource$Projects$Locations$Fetchprocessortypes, + callback: BodyResponseCallback + ): void; + fetchProcessorTypes( + callback: BodyResponseCallback + ): void; + fetchProcessorTypes( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Fetchprocessortypes + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Fetchprocessortypes; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Fetchprocessortypes; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://documentai.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}:fetchProcessorTypes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets information about a location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/documentai.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const documentai = google.documentai('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await documentai.projects.locations.get({ + * // Resource name for the location. + * name: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "displayName": "my_displayName", + * // "labels": {}, + * // "locationId": "my_locationId", + * // "metadata": {}, + * // "name": "my_name" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://documentai.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists information about the supported locations for this service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/documentai.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const documentai = google.documentai('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await documentai.projects.locations.list({ + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * extraLocationTypes: 'placeholder-value', + * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). + * filter: 'placeholder-value', + * // The resource that owns the locations collection, if applicable. + * name: 'projects/my-project', + * // The maximum number of results to return. If not set, the service selects a default. + * pageSize: 'placeholder-value', + * // A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. + * pageToken: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "locations": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://documentai.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/locations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Fetchprocessortypes + extends StandardParameters { + /** + * Required. The location of processor types to list. Format: `projects/{project\}/locations/{location\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Get + extends StandardParameters { + /** + * Resource name for the location. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$List + extends StandardParameters { + /** + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + */ + extraLocationTypes?: string[]; + /** + * A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). + */ + filter?: string; + /** + * The resource that owns the locations collection, if applicable. + */ + name?: string; + /** + * The maximum number of results to return. If not set, the service selects a default. + */ + pageSize?: number; + /** + * A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/documentai.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const documentai = google.documentai('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await documentai.projects.locations.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Projects$Locations$Operations$Cancel, + options?: MethodOptions + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://documentai.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/documentai.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const documentai = google.documentai('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await documentai.projects.locations.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Operations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Operations$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://documentai.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/documentai.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const documentai = google.documentai('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await documentai.projects.locations.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/operations', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Operations$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://documentai.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + + export class Resource$Projects$Locations$Processors { + context: APIRequestContext; + humanReviewConfig: Resource$Projects$Locations$Processors$Humanreviewconfig; + processorVersions: Resource$Projects$Locations$Processors$Processorversions; + constructor(context: APIRequestContext) { + this.context = context; + this.humanReviewConfig = + new Resource$Projects$Locations$Processors$Humanreviewconfig( + this.context + ); + this.processorVersions = + new Resource$Projects$Locations$Processors$Processorversions( + this.context + ); + } + + /** + * LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/documentai.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const documentai = google.documentai('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await documentai.projects.locations.processors.batchProcess({ + * // Required. The resource name of Processor or ProcessorVersion. Format: `projects/{project\}/locations/{location\}/processors/{processor\}`, or `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` + * name: 'projects/my-project/locations/my-location/processors/my-processor', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "documentOutputConfig": {}, + * // "inputDocuments": {}, + * // "labels": {}, + * // "processOptions": {}, + * // "skipHumanReview": false + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + batchProcess( + params: Params$Resource$Projects$Locations$Processors$Batchprocess, + options: StreamMethodOptions + ): Promise>; + batchProcess( + params?: Params$Resource$Projects$Locations$Processors$Batchprocess, + options?: MethodOptions + ): Promise>; + batchProcess( + params: Params$Resource$Projects$Locations$Processors$Batchprocess, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchProcess( + params: Params$Resource$Projects$Locations$Processors$Batchprocess, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchProcess( + params: Params$Resource$Projects$Locations$Processors$Batchprocess, + callback: BodyResponseCallback + ): void; + batchProcess( + callback: BodyResponseCallback + ): void; + batchProcess( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Processors$Batchprocess + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Processors$Batchprocess; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Processors$Batchprocess; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://documentai.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:batchProcess').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a processor from the ProcessorType provided. The processor will be at `ENABLED` state by default after its creation. Note that this method requires the `documentai.processors.create` permission on the project, which is highly privileged. A user or service account with this permission can create new processors that can interact with any gcs bucket in your project. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/documentai.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const documentai = google.documentai('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await documentai.projects.locations.processors.create({ + * // Required. The parent (project and location) under which to create the processor. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "activeSchemaVersion": "my_activeSchemaVersion", + * // "createTime": "my_createTime", + * // "defaultProcessorVersion": "my_defaultProcessorVersion", + * // "displayName": "my_displayName", + * // "kmsKeyName": "my_kmsKeyName", + * // "name": "my_name", + * // "processEndpoint": "my_processEndpoint", + * // "processorVersionAliases": [], + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "state": "my_state", + * // "type": "my_type" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "activeSchemaVersion": "my_activeSchemaVersion", + * // "createTime": "my_createTime", + * // "defaultProcessorVersion": "my_defaultProcessorVersion", + * // "displayName": "my_displayName", + * // "kmsKeyName": "my_kmsKeyName", + * // "name": "my_name", + * // "processEndpoint": "my_processEndpoint", + * // "processorVersionAliases": [], + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "state": "my_state", + * // "type": "my_type" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Processors$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Processors$Create, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Processors$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Processors$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Processors$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Processors$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Processors$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Processors$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://documentai.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/processors').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Deletes the processor, unloads all deployed model artifacts if it was enabled and then deletes all artifacts associated with this processor. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/documentai.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const documentai = google.documentai('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await documentai.projects.locations.processors.delete({ + * // Required. The processor resource name to be deleted. + * name: 'projects/my-project/locations/my-location/processors/my-processor', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Processors$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Processors$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Processors$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Processors$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Processors$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Processors$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Processors$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; - export class Resource$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Processors$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://documentai.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Disables a processor * @example * ```js * // Before running the sample: @@ -4165,14 +6981,26 @@ export namespace documentai_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await documentai.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'operations/.*', + * const res = await documentai.projects.locations.processors.disable({ + * // Required. The processor resource name to be disabled. + * name: 'projects/my-project/locations/my-location/processors/my-processor', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -4187,53 +7015,57 @@ export namespace documentai_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Operations$Delete, + disable( + params: Params$Resource$Projects$Locations$Processors$Disable, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Operations$Delete, + disable( + params?: Params$Resource$Projects$Locations$Processors$Disable, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Operations$Delete, + ): Promise>; + disable( + params: Params$Resource$Projects$Locations$Processors$Disable, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + disable( + params: Params$Resource$Projects$Locations$Processors$Disable, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Operations$Delete, - callback: BodyResponseCallback + disable( + params: Params$Resource$Projects$Locations$Processors$Disable, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + disable( + callback: BodyResponseCallback + ): void; + disable( paramsOrCallback?: - | Params$Resource$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Processors$Disable + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Processors$Disable; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Operations$Delete; + params = {} as Params$Resource$Projects$Locations$Processors$Disable; options = {}; } @@ -4246,8 +7078,11 @@ export namespace documentai_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}:disable').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -4258,55 +7093,17 @@ export namespace documentai_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Operations$Delete - extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - - export class Resource$Projects { - context: APIRequestContext; - locations: Resource$Projects$Locations; - operations: Resource$Projects$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.locations = new Resource$Projects$Locations(this.context); - this.operations = new Resource$Projects$Operations(this.context); - } - } - - export class Resource$Projects$Locations { - context: APIRequestContext; - operations: Resource$Projects$Locations$Operations; - processors: Resource$Projects$Locations$Processors; - processorTypes: Resource$Projects$Locations$Processortypes; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = new Resource$Projects$Locations$Operations( - this.context - ); - this.processors = new Resource$Projects$Locations$Processors( - this.context - ); - this.processorTypes = new Resource$Projects$Locations$Processortypes( - this.context - ); - } /** - * Fetches processor types. Note that we don't use ListProcessorTypes here, because it isn't paginated. + * Enables a processor * @example * ```js * // Before running the sample: @@ -4335,15 +7132,25 @@ export namespace documentai_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await documentai.projects.locations.fetchProcessorTypes({ - * // Required. The location of processor types to list. Format: `projects/{project\}/locations/{location\}`. - * parent: 'projects/my-project/locations/my-location', + * const res = await documentai.projects.locations.processors.enable({ + * // Required. The processor resource name to be enabled. + * name: 'projects/my-project/locations/my-location/processors/my-processor', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, * }); * console.log(res.data); * * // Example response * // { - * // "processorTypes": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -4359,61 +7166,57 @@ export namespace documentai_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - fetchProcessorTypes( - params: Params$Resource$Projects$Locations$Fetchprocessortypes, + enable( + params: Params$Resource$Projects$Locations$Processors$Enable, options: StreamMethodOptions ): Promise>; - fetchProcessorTypes( - params?: Params$Resource$Projects$Locations$Fetchprocessortypes, + enable( + params?: Params$Resource$Projects$Locations$Processors$Enable, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - fetchProcessorTypes( - params: Params$Resource$Projects$Locations$Fetchprocessortypes, + ): Promise>; + enable( + params: Params$Resource$Projects$Locations$Processors$Enable, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - fetchProcessorTypes( - params: Params$Resource$Projects$Locations$Fetchprocessortypes, + enable( + params: Params$Resource$Projects$Locations$Processors$Enable, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - fetchProcessorTypes( - params: Params$Resource$Projects$Locations$Fetchprocessortypes, - callback: BodyResponseCallback + enable( + params: Params$Resource$Projects$Locations$Processors$Enable, + callback: BodyResponseCallback ): void; - fetchProcessorTypes( - callback: BodyResponseCallback + enable( + callback: BodyResponseCallback ): void; - fetchProcessorTypes( + enable( paramsOrCallback?: - | Params$Resource$Projects$Locations$Fetchprocessortypes - | BodyResponseCallback + | Params$Resource$Projects$Locations$Processors$Enable + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Fetchprocessortypes; + {}) as Params$Resource$Projects$Locations$Processors$Enable; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Fetchprocessortypes; + params = {} as Params$Resource$Projects$Locations$Processors$Enable; options = {}; } @@ -4426,34 +7229,29 @@ export namespace documentai_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}:fetchProcessorTypes').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:enable').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets information about a location. + * Gets a processor detail. * @example * ```js * // Before running the sample: @@ -4482,19 +7280,26 @@ export namespace documentai_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await documentai.projects.locations.get({ - * // Resource name for the location. - * name: 'projects/my-project/locations/my-location', + * const res = await documentai.projects.locations.processors.get({ + * // Required. The processor resource name. + * name: 'projects/my-project/locations/my-location/processors/my-processor', * }); * console.log(res.data); * * // Example response * // { + * // "activeSchemaVersion": "my_activeSchemaVersion", + * // "createTime": "my_createTime", + * // "defaultProcessorVersion": "my_defaultProcessorVersion", * // "displayName": "my_displayName", - * // "labels": {}, - * // "locationId": "my_locationId", - * // "metadata": {}, - * // "name": "my_name" + * // "kmsKeyName": "my_kmsKeyName", + * // "name": "my_name", + * // "processEndpoint": "my_processEndpoint", + * // "processorVersionAliases": [], + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "state": "my_state", + * // "type": "my_type" * // } * } * @@ -4511,56 +7316,60 @@ export namespace documentai_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Get, + params: Params$Resource$Projects$Locations$Processors$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Get, + params?: Params$Resource$Projects$Locations$Processors$Get, options?: MethodOptions - ): Promise>; + ): Promise< + GaxiosResponseWithHTTP2 + >; get( - params: Params$Resource$Projects$Locations$Get, + params: Params$Resource$Projects$Locations$Processors$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Get, + params: Params$Resource$Projects$Locations$Processors$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Processors$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Processors$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Get; + {}) as Params$Resource$Projects$Locations$Processors$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Get; + params = {} as Params$Resource$Projects$Locations$Processors$Get; options = {}; } @@ -4585,17 +7394,19 @@ export namespace documentai_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists information about the supported locations for this service. + * Lists all processors which belong to this project. * @example * ```js * // Before running the sample: @@ -4624,24 +7435,20 @@ export namespace documentai_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await documentai.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. - * extraLocationTypes: 'placeholder-value', - * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). - * filter: 'placeholder-value', - * // The resource that owns the locations collection, if applicable. - * name: 'projects/my-project', - * // The maximum number of results to return. If not set, the service selects a default. + * const res = await documentai.projects.locations.processors.list({ + * // The maximum number of processors to return. If unspecified, at most `50` processors will be returned. The maximum value is `100`. Values above `100` will be coerced to `100`. * pageSize: 'placeholder-value', - * // A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. + * // We will return the processors sorted by creation time. The page token will point to the next processor. * pageToken: 'placeholder-value', + * // Required. The parent (project and location) which owns this collection of Processors. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', * }); * console.log(res.data); * * // Example response * // { - * // "locations": [], - * // "nextPageToken": "my_nextPageToken" + * // "nextPageToken": "my_nextPageToken", + * // "processors": [] * // } * } * @@ -4658,60 +7465,60 @@ export namespace documentai_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$List, + params: Params$Resource$Projects$Locations$Processors$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$List, + params?: Params$Resource$Projects$Locations$Processors$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$List, + params: Params$Resource$Projects$Locations$Processors$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$List, + params: Params$Resource$Projects$Locations$Processors$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Processors$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Processors$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$List; + {}) as Params$Resource$Projects$Locations$Processors$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$List; + params = {} as Params$Resource$Projects$Locations$Processors$List; options = {}; } @@ -4724,7 +7531,7 @@ export namespace documentai_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/locations').replace( + url: (rootUrl + '/v1/{+parent}/processors').replace( /([^:]\/)\/+/g, '$1' ), @@ -4734,69 +7541,24 @@ export namespace documentai_v1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Fetchprocessortypes - extends StandardParameters { - /** - * Required. The location of processor types to list. Format: `projects/{project\}/locations/{location\}`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Get - extends StandardParameters { - /** - * Resource name for the location. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$List - extends StandardParameters { - /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. - */ - extraLocationTypes?: string[]; - /** - * A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). - */ - filter?: string; - /** - * The resource that owns the locations collection, if applicable. - */ - name?: string; - /** - * The maximum number of results to return. If not set, the service selects a default. - */ - pageSize?: number; - /** - * A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. - */ - pageToken?: string; - } - - export class Resource$Projects$Locations$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Processes a single document. * @example * ```js * // Before running the sample: @@ -4825,14 +7587,32 @@ export namespace documentai_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await documentai.projects.locations.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/operations/my-operation', + * const res = await documentai.projects.locations.processors.process({ + * // Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: `projects/{project\}/locations/{location\}/processors/{processor\}`, or `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` + * name: 'projects/my-project/locations/my-location/processors/my-processor', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "fieldMask": "my_fieldMask", + * // "gcsDocument": {}, + * // "imagelessMode": false, + * // "inlineDocument": {}, + * // "labels": {}, + * // "processOptions": {}, + * // "rawDocument": {}, + * // "skipHumanReview": false + * // } + * }, * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "document": {}, + * // "humanReviewStatus": {} + * // } * } * * main().catch(e => { @@ -4847,53 +7627,61 @@ export namespace documentai_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, + process( + params: Params$Resource$Projects$Locations$Processors$Process, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Operations$Cancel, + process( + params?: Params$Resource$Projects$Locations$Processors$Process, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, + ): Promise< + GaxiosResponseWithHTTP2 + >; + process( + params: Params$Resource$Projects$Locations$Processors$Process, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + process( + params: Params$Resource$Projects$Locations$Processors$Process, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, - callback: BodyResponseCallback + process( + params: Params$Resource$Projects$Locations$Processors$Process, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + process( + callback: BodyResponseCallback + ): void; + process( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Processors$Process + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Processors$Process; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Cancel; + params = {} as Params$Resource$Projects$Locations$Processors$Process; options = {}; } @@ -4906,7 +7694,10 @@ export namespace documentai_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:process').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, @@ -4918,17 +7709,19 @@ export namespace documentai_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Set the default (active) version of a Processor that will be used in ProcessDocument and BatchProcessDocuments. * @example * ```js * // Before running the sample: @@ -4957,10 +7750,20 @@ export namespace documentai_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await documentai.projects.locations.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/operations/my-operation', - * }); + * const res = + * await documentai.projects.locations.processors.setDefaultProcessorVersion({ + * // Required. The resource name of the Processor to change default version. + * processor: + * 'projects/my-project/locations/my-location/processors/my-processor', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "defaultProcessorVersion": "my_defaultProcessorVersion" + * // } + * }, + * }); * console.log(res.data); * * // Example response @@ -4985,36 +7788,36 @@ export namespace documentai_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Operations$Get, + setDefaultProcessorVersion( + params: Params$Resource$Projects$Locations$Processors$Setdefaultprocessorversion, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Operations$Get, + setDefaultProcessorVersion( + params?: Params$Resource$Projects$Locations$Processors$Setdefaultprocessorversion, options?: MethodOptions ): Promise>; - get( - params: Params$Resource$Projects$Locations$Operations$Get, + setDefaultProcessorVersion( + params: Params$Resource$Projects$Locations$Processors$Setdefaultprocessorversion, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Operations$Get, + setDefaultProcessorVersion( + params: Params$Resource$Projects$Locations$Processors$Setdefaultprocessorversion, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Operations$Get, + setDefaultProcessorVersion( + params: Params$Resource$Projects$Locations$Processors$Setdefaultprocessorversion, callback: BodyResponseCallback ): void; - get( + setDefaultProcessorVersion( callback: BodyResponseCallback ): void; - get( + setDefaultProcessorVersion( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Get + | Params$Resource$Projects$Locations$Processors$Setdefaultprocessorversion | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -5030,12 +7833,13 @@ export namespace documentai_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Get; + {}) as Params$Resource$Projects$Locations$Processors$Setdefaultprocessorversion; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Get; + params = + {} as Params$Resource$Projects$Locations$Processors$Setdefaultprocessorversion; options = {}; } @@ -5048,15 +7852,17 @@ export namespace documentai_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: ( + rootUrl + '/v1/{+processor}:setDefaultProcessorVersion' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['processor'], + pathParams: ['processor'], context: this.context, }; if (callback) { @@ -5068,9 +7874,118 @@ export namespace documentai_v1 { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Processors$Batchprocess + extends StandardParameters { /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Required. The resource name of Processor or ProcessorVersion. Format: `projects/{project\}/locations/{location\}/processors/{processor\}`, or `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDocumentaiV1BatchProcessRequest; + } + export interface Params$Resource$Projects$Locations$Processors$Create + extends StandardParameters { + /** + * Required. The parent (project and location) under which to create the processor. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDocumentaiV1Processor; + } + export interface Params$Resource$Projects$Locations$Processors$Delete + extends StandardParameters { + /** + * Required. The processor resource name to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Processors$Disable + extends StandardParameters { + /** + * Required. The processor resource name to be disabled. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDocumentaiV1DisableProcessorRequest; + } + export interface Params$Resource$Projects$Locations$Processors$Enable + extends StandardParameters { + /** + * Required. The processor resource name to be enabled. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDocumentaiV1EnableProcessorRequest; + } + export interface Params$Resource$Projects$Locations$Processors$Get + extends StandardParameters { + /** + * Required. The processor resource name. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Processors$List + extends StandardParameters { + /** + * The maximum number of processors to return. If unspecified, at most `50` processors will be returned. The maximum value is `100`. Values above `100` will be coerced to `100`. + */ + pageSize?: number; + /** + * We will return the processors sorted by creation time. The page token will point to the next processor. + */ + pageToken?: string; + /** + * Required. The parent (project and location) which owns this collection of Processors. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Processors$Process + extends StandardParameters { + /** + * Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: `projects/{project\}/locations/{location\}/processors/{processor\}`, or `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDocumentaiV1ProcessRequest; + } + export interface Params$Resource$Projects$Locations$Processors$Setdefaultprocessorversion + extends StandardParameters { + /** + * Required. The resource name of the Processor to change default version. + */ + processor?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest; + } + + export class Resource$Projects$Locations$Processors$Humanreviewconfig { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Send a document for Human Review. The input document should be processed by the specified processor. * @example * ```js * // Before running the sample: @@ -5099,25 +8014,34 @@ export namespace documentai_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await documentai.projects.locations.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/operations', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * const res = + * await documentai.projects.locations.processors.humanReviewConfig.reviewDocument( + * { + * // Required. The resource name of the HumanReviewConfig that the document will be reviewed with. + * humanReviewConfig: + * 'projects/my-project/locations/my-location/processors/my-processor/humanReviewConfig', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "documentSchema": {}, + * // "enableSchemaValidation": false, + * // "inlineDocument": {}, + * // "priority": "my_priority" + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -5133,61 +8057,58 @@ export namespace documentai_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Operations$List, + reviewDocument( + params: Params$Resource$Projects$Locations$Processors$Humanreviewconfig$Reviewdocument, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Operations$List, + reviewDocument( + params?: Params$Resource$Projects$Locations$Processors$Humanreviewconfig$Reviewdocument, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Operations$List, + ): Promise>; + reviewDocument( + params: Params$Resource$Projects$Locations$Processors$Humanreviewconfig$Reviewdocument, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Operations$List, + reviewDocument( + params: Params$Resource$Projects$Locations$Processors$Humanreviewconfig$Reviewdocument, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Operations$List, - callback: BodyResponseCallback + reviewDocument( + params: Params$Resource$Projects$Locations$Processors$Humanreviewconfig$Reviewdocument, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + reviewDocument( + callback: BodyResponseCallback ): void; - list( + reviewDocument( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Processors$Humanreviewconfig$Reviewdocument + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$List; + {}) as Params$Resource$Projects$Locations$Processors$Humanreviewconfig$Reviewdocument; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$List; + params = + {} as Params$Resource$Projects$Locations$Processors$Humanreviewconfig$Reviewdocument; options = {}; } @@ -5200,80 +8121,51 @@ export namespace documentai_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+humanReviewConfig}:reviewDocument').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['humanReviewConfig'], + pathParams: ['humanReviewConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Operations$Cancel - extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Operations$List + export interface Params$Resource$Projects$Locations$Processors$Humanreviewconfig$Reviewdocument extends StandardParameters { /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. + * Required. The resource name of the HumanReviewConfig that the document will be reviewed with. */ - pageToken?: string; + humanReviewConfig?: string; + /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * Request body metadata */ - returnPartialSuccess?: boolean; + requestBody?: Schema$GoogleCloudDocumentaiV1ReviewDocumentRequest; } - export class Resource$Projects$Locations$Processors { + export class Resource$Projects$Locations$Processors$Processorversions { context: APIRequestContext; - humanReviewConfig: Resource$Projects$Locations$Processors$Humanreviewconfig; - processorVersions: Resource$Projects$Locations$Processors$Processorversions; + evaluations: Resource$Projects$Locations$Processors$Processorversions$Evaluations; constructor(context: APIRequestContext) { this.context = context; - this.humanReviewConfig = - new Resource$Projects$Locations$Processors$Humanreviewconfig( - this.context - ); - this.processorVersions = - new Resource$Projects$Locations$Processors$Processorversions( + this.evaluations = + new Resource$Projects$Locations$Processors$Processorversions$Evaluations( this.context ); } @@ -5308,22 +8200,25 @@ export namespace documentai_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await documentai.projects.locations.processors.batchProcess({ - * // Required. The resource name of Processor or ProcessorVersion. Format: `projects/{project\}/locations/{location\}/processors/{processor\}`, or `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` - * name: 'projects/my-project/locations/my-location/processors/my-processor', + * const res = + * await documentai.projects.locations.processors.processorVersions.batchProcess( + * { + * // Required. The resource name of Processor or ProcessorVersion. Format: `projects/{project\}/locations/{location\}/processors/{processor\}`, or `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` + * name: 'projects/my-project/locations/my-location/processors/my-processor/processorVersions/my-processorVersion', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "documentOutputConfig": {}, - * // "inputDocuments": {}, - * // "labels": {}, - * // "processOptions": {}, - * // "skipHumanReview": false - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "documentOutputConfig": {}, + * // "inputDocuments": {}, + * // "labels": {}, + * // "processOptions": {}, + * // "skipHumanReview": false + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response @@ -5349,27 +8244,27 @@ export namespace documentai_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ batchProcess( - params: Params$Resource$Projects$Locations$Processors$Batchprocess, + params: Params$Resource$Projects$Locations$Processors$Processorversions$Batchprocess, options: StreamMethodOptions ): Promise>; batchProcess( - params?: Params$Resource$Projects$Locations$Processors$Batchprocess, + params?: Params$Resource$Projects$Locations$Processors$Processorversions$Batchprocess, options?: MethodOptions ): Promise>; batchProcess( - params: Params$Resource$Projects$Locations$Processors$Batchprocess, + params: Params$Resource$Projects$Locations$Processors$Processorversions$Batchprocess, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; batchProcess( - params: Params$Resource$Projects$Locations$Processors$Batchprocess, + params: Params$Resource$Projects$Locations$Processors$Processorversions$Batchprocess, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; batchProcess( - params: Params$Resource$Projects$Locations$Processors$Batchprocess, + params: Params$Resource$Projects$Locations$Processors$Processorversions$Batchprocess, callback: BodyResponseCallback ): void; batchProcess( @@ -5377,7 +8272,7 @@ export namespace documentai_v1 { ): void; batchProcess( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Batchprocess + | Params$Resource$Projects$Locations$Processors$Processorversions$Batchprocess | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -5393,13 +8288,13 @@ export namespace documentai_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Batchprocess; + {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Batchprocess; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Processors$Batchprocess; + {} as Params$Resource$Projects$Locations$Processors$Processorversions$Batchprocess; options = {}; } @@ -5437,7 +8332,7 @@ export namespace documentai_v1 { } /** - * Creates a processor from the ProcessorType provided. The processor will be at `ENABLED` state by default after its creation. Note that this method requires the `documentai.processors.create` permission on the project, which is highly privileged. A user or service account with this permission can create new processors that can interact with any gcs bucket in your project. + * Deletes the processor version, all artifacts under the processor version will be deleted. * @example * ```js * // Before running the sample: @@ -5466,43 +8361,20 @@ export namespace documentai_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await documentai.projects.locations.processors.create({ - * // Required. The parent (project and location) under which to create the processor. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "defaultProcessorVersion": "my_defaultProcessorVersion", - * // "displayName": "my_displayName", - * // "kmsKeyName": "my_kmsKeyName", - * // "name": "my_name", - * // "processEndpoint": "my_processEndpoint", - * // "processorVersionAliases": [], - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "state": "my_state", - * // "type": "my_type" - * // } - * }, - * }); + * const res = + * await documentai.projects.locations.processors.processorVersions.delete({ + * // Required. The processor version resource name to be deleted. + * name: 'projects/my-project/locations/my-location/processors/my-processor/processorVersions/my-processorVersion', + * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "defaultProcessorVersion": "my_defaultProcessorVersion", - * // "displayName": "my_displayName", - * // "kmsKeyName": "my_kmsKeyName", + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "processEndpoint": "my_processEndpoint", - * // "processorVersionAliases": [], - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "state": "my_state", - * // "type": "my_type" + * // "response": {} * // } * } * @@ -5518,61 +8390,58 @@ export namespace documentai_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Processors$Create, + delete( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Delete, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Processors$Create, + delete( + params?: Params$Resource$Projects$Locations$Processors$Processorversions$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - create( - params: Params$Resource$Projects$Locations$Processors$Create, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Processors$Create, + delete( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Processors$Create, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Delete, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - create( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Processors$Processorversions$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Create; + {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Processors$Create; + params = + {} as Params$Resource$Projects$Locations$Processors$Processorversions$Delete; options = {}; } @@ -5585,34 +8454,29 @@ export namespace documentai_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/processors').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes the processor, unloads all deployed model artifacts if it was enabled and then deletes all artifacts associated with this processor. + * Deploys the processor version. * @example * ```js * // Before running the sample: @@ -5641,10 +8505,17 @@ export namespace documentai_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await documentai.projects.locations.processors.delete({ - * // Required. The processor resource name to be deleted. - * name: 'projects/my-project/locations/my-location/processors/my-processor', - * }); + * const res = + * await documentai.projects.locations.processors.processorVersions.deploy({ + * // Required. The processor version resource name to be deployed. + * name: 'projects/my-project/locations/my-location/processors/my-processor/processorVersions/my-processorVersion', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); * console.log(res.data); * * // Example response @@ -5669,36 +8540,36 @@ export namespace documentai_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Processors$Delete, + deploy( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Deploy, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Processors$Delete, + deploy( + params?: Params$Resource$Projects$Locations$Processors$Processorversions$Deploy, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Processors$Delete, + deploy( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Deploy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Processors$Delete, + deploy( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Deploy, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Processors$Delete, + deploy( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Deploy, callback: BodyResponseCallback ): void; - delete( + deploy( callback: BodyResponseCallback ): void; - delete( + deploy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Delete + | Params$Resource$Projects$Locations$Processors$Processorversions$Deploy | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -5714,12 +8585,13 @@ export namespace documentai_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Delete; + {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Deploy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Processors$Delete; + params = + {} as Params$Resource$Projects$Locations$Processors$Processorversions$Deploy; options = {}; } @@ -5732,8 +8604,8 @@ export namespace documentai_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}:deploy').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -5754,7 +8626,7 @@ export namespace documentai_v1 { } /** - * Disables a processor + * Evaluates a ProcessorVersion against annotated documents, producing an Evaluation. * @example * ```js * // Before running the sample: @@ -5783,16 +8655,22 @@ export namespace documentai_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await documentai.projects.locations.processors.disable({ - * // Required. The processor resource name to be disabled. - * name: 'projects/my-project/locations/my-location/processors/my-processor', + * const res = + * await documentai.projects.locations.processors.processorVersions.evaluateProcessorVersion( + * { + * // Required. The resource name of the ProcessorVersion to evaluate. `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` + * processorVersion: + * 'projects/my-project/locations/my-location/processors/my-processor/processorVersions/my-processorVersion', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "evaluationDocuments": {} + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response @@ -5817,36 +8695,36 @@ export namespace documentai_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - disable( - params: Params$Resource$Projects$Locations$Processors$Disable, + evaluateProcessorVersion( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluateprocessorversion, options: StreamMethodOptions ): Promise>; - disable( - params?: Params$Resource$Projects$Locations$Processors$Disable, + evaluateProcessorVersion( + params?: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluateprocessorversion, options?: MethodOptions ): Promise>; - disable( - params: Params$Resource$Projects$Locations$Processors$Disable, + evaluateProcessorVersion( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluateprocessorversion, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - disable( - params: Params$Resource$Projects$Locations$Processors$Disable, + evaluateProcessorVersion( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluateprocessorversion, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - disable( - params: Params$Resource$Projects$Locations$Processors$Disable, + evaluateProcessorVersion( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluateprocessorversion, callback: BodyResponseCallback ): void; - disable( + evaluateProcessorVersion( callback: BodyResponseCallback ): void; - disable( + evaluateProcessorVersion( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Disable + | Params$Resource$Projects$Locations$Processors$Processorversions$Evaluateprocessorversion | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -5862,12 +8740,13 @@ export namespace documentai_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Disable; + {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Evaluateprocessorversion; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Processors$Disable; + params = + {} as Params$Resource$Projects$Locations$Processors$Processorversions$Evaluateprocessorversion; options = {}; } @@ -5880,18 +8759,17 @@ export namespace documentai_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:disable').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1/{+processorVersion}:evaluateProcessorVersion' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['processorVersion'], + pathParams: ['processorVersion'], context: this.context, }; if (callback) { @@ -5905,7 +8783,7 @@ export namespace documentai_v1 { } /** - * Enables a processor + * Gets a processor version detail. * @example * ```js * // Before running the sample: @@ -5934,25 +8812,29 @@ export namespace documentai_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await documentai.projects.locations.processors.enable({ - * // Required. The processor resource name to be enabled. - * name: 'projects/my-project/locations/my-location/processors/my-processor', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }); + * const res = + * await documentai.projects.locations.processors.processorVersions.get({ + * // Required. The processor resource name. + * name: 'projects/my-project/locations/my-location/processors/my-processor/processorVersions/my-processorVersion', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "createTime": "my_createTime", + * // "deprecationInfo": {}, + * // "displayName": "my_displayName", + * // "documentSchema": {}, + * // "genAiModelInfo": {}, + * // "googleManaged": false, + * // "kmsKeyName": "my_kmsKeyName", + * // "kmsKeyVersionName": "my_kmsKeyVersionName", + * // "latestEvaluation": {}, + * // "modelType": "my_modelType", * // "name": "my_name", - * // "response": {} + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "state": "my_state" * // } * } * @@ -5968,57 +8850,62 @@ export namespace documentai_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - enable( - params: Params$Resource$Projects$Locations$Processors$Enable, + get( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Get, options: StreamMethodOptions ): Promise>; - enable( - params?: Params$Resource$Projects$Locations$Processors$Enable, + get( + params?: Params$Resource$Projects$Locations$Processors$Processorversions$Get, options?: MethodOptions - ): Promise>; - enable( - params: Params$Resource$Projects$Locations$Processors$Enable, + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - enable( - params: Params$Resource$Projects$Locations$Processors$Enable, + get( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - enable( - params: Params$Resource$Projects$Locations$Processors$Enable, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Get, + callback: BodyResponseCallback ): void; - enable( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - enable( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Enable - | BodyResponseCallback + | Params$Resource$Projects$Locations$Processors$Processorversions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Enable; + {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Processors$Enable; + params = + {} as Params$Resource$Projects$Locations$Processors$Processorversions$Get; options = {}; } @@ -6031,8 +8918,8 @@ export namespace documentai_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:enable').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -6043,17 +8930,19 @@ export namespace documentai_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a processor detail. + * Lists all versions of a processor. * @example * ```js * // Before running the sample: @@ -6082,25 +8971,22 @@ export namespace documentai_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await documentai.projects.locations.processors.get({ - * // Required. The processor resource name. - * name: 'projects/my-project/locations/my-location/processors/my-processor', - * }); + * const res = + * await documentai.projects.locations.processors.processorVersions.list({ + * // The maximum number of processor versions to return. If unspecified, at most `10` processor versions will be returned. The maximum value is `20`. Values above `20` will be coerced to `20`. + * pageSize: 'placeholder-value', + * // We will return the processor versions sorted by creation time. The page token will point to the next processor version. + * pageToken: 'placeholder-value', + * // Required. The parent (project, location and processor) to list all versions. Format: `projects/{project\}/locations/{location\}/processors/{processor\}` + * parent: + * 'projects/my-project/locations/my-location/processors/my-processor', + * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "defaultProcessorVersion": "my_defaultProcessorVersion", - * // "displayName": "my_displayName", - * // "kmsKeyName": "my_kmsKeyName", - * // "name": "my_name", - * // "processEndpoint": "my_processEndpoint", - * // "processorVersionAliases": [], - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "state": "my_state", - * // "type": "my_type" + * // "nextPageToken": "my_nextPageToken", + * // "processorVersions": [] * // } * } * @@ -6116,61 +9002,62 @@ export namespace documentai_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Processors$Get, + list( + params: Params$Resource$Projects$Locations$Processors$Processorversions$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Processors$Get, + list( + params?: Params$Resource$Projects$Locations$Processors$Processorversions$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Processors$Get, + list( + params: Params$Resource$Projects$Locations$Processors$Processorversions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Processors$Get, + list( + params: Params$Resource$Projects$Locations$Processors$Processorversions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Processors$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Processors$Processorversions$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Processors$Processorversions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Get; + {}) as Params$Resource$Projects$Locations$Processors$Processorversions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Processors$Get; + params = + {} as Params$Resource$Projects$Locations$Processors$Processorversions$List; options = {}; } @@ -6183,31 +9070,34 @@ export namespace documentai_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/processorVersions').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists all processors which belong to this project. + * Processes a single document. * @example * ```js * // Before running the sample: @@ -6236,20 +9126,32 @@ export namespace documentai_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await documentai.projects.locations.processors.list({ - * // The maximum number of processors to return. If unspecified, at most `50` processors will be returned. The maximum value is `100`. Values above `100` will be coerced to `100`. - * pageSize: 'placeholder-value', - * // We will return the processors sorted by creation time. The page token will point to the next processor. - * pageToken: 'placeholder-value', - * // Required. The parent (project and location) which owns this collection of Processors. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * }); + * const res = + * await documentai.projects.locations.processors.processorVersions.process({ + * // Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: `projects/{project\}/locations/{location\}/processors/{processor\}`, or `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` + * name: 'projects/my-project/locations/my-location/processors/my-processor/processorVersions/my-processorVersion', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "fieldMask": "my_fieldMask", + * // "gcsDocument": {}, + * // "imagelessMode": false, + * // "inlineDocument": {}, + * // "labels": {}, + * // "processOptions": {}, + * // "rawDocument": {}, + * // "skipHumanReview": false + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "processors": [] + * // "document": {}, + * // "humanReviewStatus": {} * // } * } * @@ -6265,61 +9167,62 @@ export namespace documentai_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Processors$List, + process( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Process, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Processors$List, + process( + params?: Params$Resource$Projects$Locations$Processors$Processorversions$Process, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Processors$List, + process( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Process, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Processors$List, + process( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Process, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Processors$List, - callback: BodyResponseCallback + process( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Process, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + process( + callback: BodyResponseCallback ): void; - list( + process( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Processors$Processorversions$Process + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$List; + {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Process; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Processors$List; + params = + {} as Params$Resource$Projects$Locations$Processors$Processorversions$Process; options = {}; } @@ -6332,34 +9235,34 @@ export namespace documentai_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/processors').replace( + url: (rootUrl + '/v1/{+name}:process').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Processes a single document. + * Trains a new processor version. Operation metadata is returned as TrainProcessorVersionMetadata. * @example * ```js * // Before running the sample: @@ -6388,31 +9291,34 @@ export namespace documentai_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await documentai.projects.locations.processors.process({ - * // Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: `projects/{project\}/locations/{location\}/processors/{processor\}`, or `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` - * name: 'projects/my-project/locations/my-location/processors/my-processor', + * const res = + * await documentai.projects.locations.processors.processorVersions.train({ + * // Required. The parent (project, location and processor) to create the new version for. Format: `projects/{project\}/locations/{location\}/processors/{processor\}`. + * parent: + * 'projects/my-project/locations/my-location/processors/my-processor', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "fieldMask": "my_fieldMask", - * // "gcsDocument": {}, - * // "imagelessMode": false, - * // "inlineDocument": {}, - * // "labels": {}, - * // "processOptions": {}, - * // "rawDocument": {}, - * // "skipHumanReview": false - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "baseProcessorVersion": "my_baseProcessorVersion", + * // "customDocumentExtractionOptions": {}, + * // "documentSchema": {}, + * // "foundationModelTuningOptions": {}, + * // "inputData": {}, + * // "processorVersion": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "document": {}, - * // "humanReviewStatus": {} + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -6428,61 +9334,58 @@ export namespace documentai_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - process( - params: Params$Resource$Projects$Locations$Processors$Process, + train( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Train, options: StreamMethodOptions ): Promise>; - process( - params?: Params$Resource$Projects$Locations$Processors$Process, + train( + params?: Params$Resource$Projects$Locations$Processors$Processorversions$Train, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - process( - params: Params$Resource$Projects$Locations$Processors$Process, + ): Promise>; + train( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Train, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - process( - params: Params$Resource$Projects$Locations$Processors$Process, + train( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Train, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - process( - params: Params$Resource$Projects$Locations$Processors$Process, - callback: BodyResponseCallback + train( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Train, + callback: BodyResponseCallback ): void; - process( - callback: BodyResponseCallback + train( + callback: BodyResponseCallback ): void; - process( + train( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Process - | BodyResponseCallback + | Params$Resource$Projects$Locations$Processors$Processorversions$Train + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Process; + {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Train; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Processors$Process; + params = + {} as Params$Resource$Projects$Locations$Processors$Processorversions$Train; options = {}; } @@ -6495,7 +9398,7 @@ export namespace documentai_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:process').replace( + url: (rootUrl + '/v1/{+parent}/processorVersions:train').replace( /([^:]\/)\/+/g, '$1' ), @@ -6505,24 +9408,22 @@ export namespace documentai_v1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Set the default (active) version of a Processor that will be used in ProcessDocument and BatchProcessDocuments. + * Undeploys the processor version. * @example * ```js * // Before running the sample: @@ -6552,17 +9453,14 @@ export namespace documentai_v1 { * * // Do the magic * const res = - * await documentai.projects.locations.processors.setDefaultProcessorVersion({ - * // Required. The resource name of the Processor to change default version. - * processor: - * 'projects/my-project/locations/my-location/processors/my-processor', + * await documentai.projects.locations.processors.processorVersions.undeploy({ + * // Required. The processor version resource name to be undeployed. + * name: 'projects/my-project/locations/my-location/processors/my-processor/processorVersions/my-processorVersion', * * // Request body metadata * requestBody: { * // request body parameters - * // { - * // "defaultProcessorVersion": "my_defaultProcessorVersion" - * // } + * // {} * }, * }); * console.log(res.data); @@ -6589,36 +9487,36 @@ export namespace documentai_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setDefaultProcessorVersion( - params: Params$Resource$Projects$Locations$Processors$Setdefaultprocessorversion, + undeploy( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Undeploy, options: StreamMethodOptions ): Promise>; - setDefaultProcessorVersion( - params?: Params$Resource$Projects$Locations$Processors$Setdefaultprocessorversion, + undeploy( + params?: Params$Resource$Projects$Locations$Processors$Processorversions$Undeploy, options?: MethodOptions ): Promise>; - setDefaultProcessorVersion( - params: Params$Resource$Projects$Locations$Processors$Setdefaultprocessorversion, + undeploy( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Undeploy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setDefaultProcessorVersion( - params: Params$Resource$Projects$Locations$Processors$Setdefaultprocessorversion, + undeploy( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Undeploy, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setDefaultProcessorVersion( - params: Params$Resource$Projects$Locations$Processors$Setdefaultprocessorversion, + undeploy( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Undeploy, callback: BodyResponseCallback ): void; - setDefaultProcessorVersion( + undeploy( callback: BodyResponseCallback ): void; - setDefaultProcessorVersion( + undeploy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Setdefaultprocessorversion + | Params$Resource$Projects$Locations$Processors$Processorversions$Undeploy | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -6634,13 +9532,13 @@ export namespace documentai_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Setdefaultprocessorversion; + {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Undeploy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Processors$Setdefaultprocessorversion; + {} as Params$Resource$Projects$Locations$Processors$Processorversions$Undeploy; options = {}; } @@ -6653,17 +9551,18 @@ export namespace documentai_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+processor}:setDefaultProcessorVersion' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:undeploy').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['processor'], - pathParams: ['processor'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -6677,7 +9576,7 @@ export namespace documentai_v1 { } } - export interface Params$Resource$Projects$Locations$Processors$Batchprocess + export interface Params$Resource$Projects$Locations$Processors$Processorversions$Batchprocess extends StandardParameters { /** * Required. The resource name of Processor or ProcessorVersion. Format: `projects/{project\}/locations/{location\}/processors/{processor\}`, or `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` @@ -6689,104 +9588,258 @@ export namespace documentai_v1 { */ requestBody?: Schema$GoogleCloudDocumentaiV1BatchProcessRequest; } - export interface Params$Resource$Projects$Locations$Processors$Create - extends StandardParameters { - /** - * Required. The parent (project and location) under which to create the processor. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDocumentaiV1Processor; - } - export interface Params$Resource$Projects$Locations$Processors$Delete + export interface Params$Resource$Projects$Locations$Processors$Processorversions$Delete extends StandardParameters { /** - * Required. The processor resource name to be deleted. + * Required. The processor version resource name to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Processors$Disable + export interface Params$Resource$Projects$Locations$Processors$Processorversions$Deploy extends StandardParameters { /** - * Required. The processor resource name to be disabled. + * Required. The processor version resource name to be deployed. */ name?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDocumentaiV1DisableProcessorRequest; + requestBody?: Schema$GoogleCloudDocumentaiV1DeployProcessorVersionRequest; } - export interface Params$Resource$Projects$Locations$Processors$Enable + export interface Params$Resource$Projects$Locations$Processors$Processorversions$Evaluateprocessorversion extends StandardParameters { /** - * Required. The processor resource name to be enabled. + * Required. The resource name of the ProcessorVersion to evaluate. `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` */ - name?: string; + processorVersion?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDocumentaiV1EnableProcessorRequest; + requestBody?: Schema$GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest; } - export interface Params$Resource$Projects$Locations$Processors$Get + export interface Params$Resource$Projects$Locations$Processors$Processorversions$Get extends StandardParameters { /** * Required. The processor resource name. */ name?: string; } - export interface Params$Resource$Projects$Locations$Processors$List + export interface Params$Resource$Projects$Locations$Processors$Processorversions$List extends StandardParameters { /** - * The maximum number of processors to return. If unspecified, at most `50` processors will be returned. The maximum value is `100`. Values above `100` will be coerced to `100`. + * The maximum number of processor versions to return. If unspecified, at most `10` processor versions will be returned. The maximum value is `20`. Values above `20` will be coerced to `20`. */ pageSize?: number; /** - * We will return the processors sorted by creation time. The page token will point to the next processor. + * We will return the processor versions sorted by creation time. The page token will point to the next processor version. */ pageToken?: string; /** - * Required. The parent (project and location) which owns this collection of Processors. Format: `projects/{project\}/locations/{location\}` + * Required. The parent (project, location and processor) to list all versions. Format: `projects/{project\}/locations/{location\}/processors/{processor\}` */ parent?: string; } - export interface Params$Resource$Projects$Locations$Processors$Process + export interface Params$Resource$Projects$Locations$Processors$Processorversions$Process extends StandardParameters { /** * Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: `projects/{project\}/locations/{location\}/processors/{processor\}`, or `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` */ name?: string; - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDocumentaiV1ProcessRequest; - } - export interface Params$Resource$Projects$Locations$Processors$Setdefaultprocessorversion - extends StandardParameters { - /** - * Required. The resource name of the Processor to change default version. - */ - processor?: string; + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDocumentaiV1ProcessRequest; + } + export interface Params$Resource$Projects$Locations$Processors$Processorversions$Train + extends StandardParameters { + /** + * Required. The parent (project, location and processor) to create the new version for. Format: `projects/{project\}/locations/{location\}/processors/{processor\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDocumentaiV1TrainProcessorVersionRequest; + } + export interface Params$Resource$Projects$Locations$Processors$Processorversions$Undeploy + extends StandardParameters { + /** + * Required. The processor version resource name to be undeployed. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDocumentaiV1UndeployProcessorVersionRequest; + } + + export class Resource$Projects$Locations$Processors$Processorversions$Evaluations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves a specific evaluation. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/documentai.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const documentai = google.documentai('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await documentai.projects.locations.processors.processorVersions.evaluations.get( + * { + * // Required. The resource name of the Evaluation to get. `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}/evaluations/{evaluation\}` + * name: 'projects/my-project/locations/my-location/processors/my-processor/processorVersions/my-processorVersion/evaluations/my-evaluation', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "allEntitiesMetrics": {}, + * // "createTime": "my_createTime", + * // "documentCounters": {}, + * // "entityMetrics": {}, + * // "kmsKeyName": "my_kmsKeyName", + * // "kmsKeyVersionName": "my_kmsKeyVersionName", + * // "name": "my_name" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$Get; + options = {}; + } - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDocumentaiV1SetDefaultProcessorVersionRequest; - } + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } - export class Resource$Projects$Locations$Processors$Humanreviewconfig { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + const rootUrl = options.rootUrl || 'https://documentai.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } } /** - * Send a document for Human Review. The input document should be processed by the specified processor. + * Retrieves a set of evaluations for a given processor version. * @example * ```js * // Before running the sample: @@ -6816,33 +9869,23 @@ export namespace documentai_v1 { * * // Do the magic * const res = - * await documentai.projects.locations.processors.humanReviewConfig.reviewDocument( + * await documentai.projects.locations.processors.processorVersions.evaluations.list( * { - * // Required. The resource name of the HumanReviewConfig that the document will be reviewed with. - * humanReviewConfig: - * 'projects/my-project/locations/my-location/processors/my-processor/humanReviewConfig', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "documentSchema": {}, - * // "enableSchemaValidation": false, - * // "inlineDocument": {}, - * // "priority": "my_priority" - * // } - * }, + * // The standard list page size. If unspecified, at most `5` evaluations are returned. The maximum value is `100`. Values above `100` are coerced to `100`. + * pageSize: 'placeholder-value', + * // A page token, received from a previous `ListEvaluations` call. Provide this to retrieve the subsequent page. + * pageToken: 'placeholder-value', + * // Required. The resource name of the ProcessorVersion to list evaluations for. `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` + * parent: + * 'projects/my-project/locations/my-location/processors/my-processor/processorVersions/my-processorVersion', * }, * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "evaluations": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -6858,58 +9901,62 @@ export namespace documentai_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - reviewDocument( - params: Params$Resource$Projects$Locations$Processors$Humanreviewconfig$Reviewdocument, + list( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$List, options: StreamMethodOptions ): Promise>; - reviewDocument( - params?: Params$Resource$Projects$Locations$Processors$Humanreviewconfig$Reviewdocument, + list( + params?: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$List, options?: MethodOptions - ): Promise>; - reviewDocument( - params: Params$Resource$Projects$Locations$Processors$Humanreviewconfig$Reviewdocument, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - reviewDocument( - params: Params$Resource$Projects$Locations$Processors$Humanreviewconfig$Reviewdocument, + list( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - reviewDocument( - params: Params$Resource$Projects$Locations$Processors$Humanreviewconfig$Reviewdocument, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$List, + callback: BodyResponseCallback ): void; - reviewDocument( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - reviewDocument( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Humanreviewconfig$Reviewdocument - | BodyResponseCallback + | Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Humanreviewconfig$Reviewdocument; + {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Processors$Humanreviewconfig$Reviewdocument; + {} as Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$List; options = {}; } @@ -6922,57 +9969,64 @@ export namespace documentai_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+humanReviewConfig}:reviewDocument').replace( + url: (rootUrl + '/v1/{+parent}/evaluations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['humanReviewConfig'], - pathParams: ['humanReviewConfig'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Processors$Humanreviewconfig$Reviewdocument + export interface Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$Get extends StandardParameters { /** - * Required. The resource name of the HumanReviewConfig that the document will be reviewed with. + * Required. The resource name of the Evaluation to get. `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}/evaluations/{evaluation\}` */ - humanReviewConfig?: string; - + name?: string; + } + export interface Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$List + extends StandardParameters { /** - * Request body metadata + * The standard list page size. If unspecified, at most `5` evaluations are returned. The maximum value is `100`. Values above `100` are coerced to `100`. */ - requestBody?: Schema$GoogleCloudDocumentaiV1ReviewDocumentRequest; + pageSize?: number; + /** + * A page token, received from a previous `ListEvaluations` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The resource name of the ProcessorVersion to list evaluations for. `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` + */ + parent?: string; } - export class Resource$Projects$Locations$Processors$Processorversions { + export class Resource$Projects$Locations$Processortypes { context: APIRequestContext; - evaluations: Resource$Projects$Locations$Processors$Processorversions$Evaluations; constructor(context: APIRequestContext) { this.context = context; - this.evaluations = - new Resource$Projects$Locations$Processors$Processorversions$Evaluations( - this.context - ); } /** - * LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format. + * Gets a processor type detail. * @example * ```js * // Before running the sample: @@ -7001,34 +10055,21 @@ export namespace documentai_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await documentai.projects.locations.processors.processorVersions.batchProcess( - * { - * // Required. The resource name of Processor or ProcessorVersion. Format: `projects/{project\}/locations/{location\}/processors/{processor\}`, or `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` - * name: 'projects/my-project/locations/my-location/processors/my-processor/processorVersions/my-processorVersion', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "documentOutputConfig": {}, - * // "inputDocuments": {}, - * // "labels": {}, - * // "processOptions": {}, - * // "skipHumanReview": false - * // } - * }, - * }, - * ); + * const res = await documentai.projects.locations.processorTypes.get({ + * // Required. The processor type resource name. + * name: 'projects/my-project/locations/my-location/processorTypes/my-processorType', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "allowCreation": false, + * // "availableLocations": [], + * // "category": "my_category", + * // "launchStage": "my_launchStage", * // "name": "my_name", - * // "response": {} + * // "sampleDocumentUris": [], + * // "type": "my_type" * // } * } * @@ -7044,58 +10085,61 @@ export namespace documentai_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchProcess( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Batchprocess, + get( + params: Params$Resource$Projects$Locations$Processortypes$Get, options: StreamMethodOptions ): Promise>; - batchProcess( - params?: Params$Resource$Projects$Locations$Processors$Processorversions$Batchprocess, + get( + params?: Params$Resource$Projects$Locations$Processortypes$Get, options?: MethodOptions - ): Promise>; - batchProcess( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Batchprocess, + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Processortypes$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchProcess( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Batchprocess, + get( + params: Params$Resource$Projects$Locations$Processortypes$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchProcess( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Batchprocess, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Processortypes$Get, + callback: BodyResponseCallback ): void; - batchProcess( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - batchProcess( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Processorversions$Batchprocess - | BodyResponseCallback + | Params$Resource$Projects$Locations$Processortypes$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Batchprocess; + {}) as Params$Resource$Projects$Locations$Processortypes$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Processors$Processorversions$Batchprocess; + params = {} as Params$Resource$Projects$Locations$Processortypes$Get; options = {}; } @@ -7108,11 +10152,8 @@ export namespace documentai_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:batchProcess').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -7123,17 +10164,19 @@ export namespace documentai_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes the processor version, all artifacts under the processor version will be deleted. + * Lists the processor types that exist. * @example * ```js * // Before running the sample: @@ -7162,20 +10205,20 @@ export namespace documentai_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await documentai.projects.locations.processors.processorVersions.delete({ - * // Required. The processor version resource name to be deleted. - * name: 'projects/my-project/locations/my-location/processors/my-processor/processorVersions/my-processorVersion', - * }); + * const res = await documentai.projects.locations.processorTypes.list({ + * // The maximum number of processor types to return. If unspecified, at most `100` processor types will be returned. The maximum value is `500`. Values above `500` will be coerced to `500`. + * pageSize: 'placeholder-value', + * // Used to retrieve the next page of results, empty if at the end of the list. + * pageToken: 'placeholder-value', + * // Required. The location of processor types to list. Format: `projects/{project\}/locations/{location\}`. + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "processorTypes": [] * // } * } * @@ -7191,58 +10234,61 @@ export namespace documentai_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Delete, + list( + params: Params$Resource$Projects$Locations$Processortypes$List, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Processors$Processorversions$Delete, + list( + params?: Params$Resource$Projects$Locations$Processortypes$List, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Processortypes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Delete, + list( + params: Params$Resource$Projects$Locations$Processortypes$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Processortypes$List, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - delete( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Processorversions$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Processortypes$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Delete; + {}) as Params$Resource$Projects$Locations$Processortypes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Processors$Processorversions$Delete; + params = {} as Params$Resource$Projects$Locations$Processortypes$List; options = {}; } @@ -7255,29 +10301,67 @@ export namespace documentai_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/processorTypes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Processortypes$Get + extends StandardParameters { /** - * Deploys the processor version. + * Required. The processor type resource name. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Processortypes$List + extends StandardParameters { + /** + * The maximum number of processor types to return. If unspecified, at most `100` processor types will be returned. The maximum value is `500`. Values above `500` will be coerced to `500`. + */ + pageSize?: number; + /** + * Used to retrieve the next page of results, empty if at the end of the list. + */ + pageToken?: string; + /** + * Required. The location of processor types to list. Format: `projects/{project\}/locations/{location\}`. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Schemas { + context: APIRequestContext; + schemaVersions: Resource$Projects$Locations$Schemas$Schemaversions; + constructor(context: APIRequestContext) { + this.context = context; + this.schemaVersions = + new Resource$Projects$Locations$Schemas$Schemaversions(this.context); + } + + /** + * Creates a schema. * @example * ```js * // Before running the sample: @@ -7306,26 +10390,31 @@ export namespace documentai_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await documentai.projects.locations.processors.processorVersions.deploy({ - * // Required. The processor version resource name to be deployed. - * name: 'projects/my-project/locations/my-location/processors/my-processor/processorVersions/my-processorVersion', + * const res = await documentai.projects.locations.schemas.create({ + * // Required. The parent (project and location) under which to create the Schema. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "labels": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "labels": {}, * // "name": "my_name", - * // "response": {} + * // "updateTime": "my_updateTime" * // } * } * @@ -7341,58 +10430,61 @@ export namespace documentai_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - deploy( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Deploy, + create( + params: Params$Resource$Projects$Locations$Schemas$Create, options: StreamMethodOptions ): Promise>; - deploy( - params?: Params$Resource$Projects$Locations$Processors$Processorversions$Deploy, + create( + params?: Params$Resource$Projects$Locations$Schemas$Create, options?: MethodOptions - ): Promise>; - deploy( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Deploy, + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Schemas$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deploy( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Deploy, + create( + params: Params$Resource$Projects$Locations$Schemas$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - deploy( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Deploy, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Schemas$Create, + callback: BodyResponseCallback ): void; - deploy( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - deploy( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Processorversions$Deploy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Schemas$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Deploy; + {}) as Params$Resource$Projects$Locations$Schemas$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Processors$Processorversions$Deploy; + params = {} as Params$Resource$Projects$Locations$Schemas$Create; options = {}; } @@ -7405,29 +10497,34 @@ export namespace documentai_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:deploy').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/schemas').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Evaluates a ProcessorVersion against annotated documents, producing an Evaluation. + * Deletes a schema. * @example * ```js * // Before running the sample: @@ -7447,31 +10544,21 @@ export namespace documentai_v1 { * * async function main() { * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/cloud-platform'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await documentai.projects.locations.processors.processorVersions.evaluateProcessorVersion( - * { - * // Required. The resource name of the ProcessorVersion to evaluate. `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` - * processorVersion: - * 'projects/my-project/locations/my-location/processors/my-processor/processorVersions/my-processorVersion', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "evaluationDocuments": {} - * // } - * }, - * }, - * ); + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await documentai.projects.locations.schemas.delete({ + * // Optional. If set to true, any child resources of this Schema will also be deleted. (Otherwise, the request will only work if the Schema has no child resources.) + * force: 'placeholder-value', + * // Required. The name of the Schema to be deleted. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}` + * name: 'projects/my-project/locations/my-location/schemas/my-schema', + * }); * console.log(res.data); * * // Example response @@ -7496,36 +10583,36 @@ export namespace documentai_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - evaluateProcessorVersion( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluateprocessorversion, + delete( + params: Params$Resource$Projects$Locations$Schemas$Delete, options: StreamMethodOptions ): Promise>; - evaluateProcessorVersion( - params?: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluateprocessorversion, + delete( + params?: Params$Resource$Projects$Locations$Schemas$Delete, options?: MethodOptions ): Promise>; - evaluateProcessorVersion( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluateprocessorversion, + delete( + params: Params$Resource$Projects$Locations$Schemas$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - evaluateProcessorVersion( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluateprocessorversion, + delete( + params: Params$Resource$Projects$Locations$Schemas$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - evaluateProcessorVersion( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluateprocessorversion, + delete( + params: Params$Resource$Projects$Locations$Schemas$Delete, callback: BodyResponseCallback ): void; - evaluateProcessorVersion( + delete( callback: BodyResponseCallback ): void; - evaluateProcessorVersion( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Processorversions$Evaluateprocessorversion + | Params$Resource$Projects$Locations$Schemas$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -7541,13 +10628,12 @@ export namespace documentai_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Evaluateprocessorversion; + {}) as Params$Resource$Projects$Locations$Schemas$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Processors$Processorversions$Evaluateprocessorversion; + params = {} as Params$Resource$Projects$Locations$Schemas$Delete; options = {}; } @@ -7560,17 +10646,15 @@ export namespace documentai_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+processorVersion}:evaluateProcessorVersion' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['processorVersion'], - pathParams: ['processorVersion'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -7584,7 +10668,7 @@ export namespace documentai_v1 { } /** - * Gets a processor version detail. + * Gets a schema. * @example * ```js * // Before running the sample: @@ -7613,29 +10697,19 @@ export namespace documentai_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await documentai.projects.locations.processors.processorVersions.get({ - * // Required. The processor resource name. - * name: 'projects/my-project/locations/my-location/processors/my-processor/processorVersions/my-processorVersion', - * }); + * const res = await documentai.projects.locations.schemas.get({ + * // Required. The name of the Schema to get. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}` + * name: 'projects/my-project/locations/my-location/schemas/my-schema', + * }); * console.log(res.data); * * // Example response * // { * // "createTime": "my_createTime", - * // "deprecationInfo": {}, * // "displayName": "my_displayName", - * // "documentSchema": {}, - * // "genAiModelInfo": {}, - * // "googleManaged": false, - * // "kmsKeyName": "my_kmsKeyName", - * // "kmsKeyVersionName": "my_kmsKeyVersionName", - * // "latestEvaluation": {}, - * // "modelType": "my_modelType", + * // "labels": {}, * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "state": "my_state" + * // "updateTime": "my_updateTime" * // } * } * @@ -7652,61 +10726,60 @@ export namespace documentai_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Get, + params: Params$Resource$Projects$Locations$Schemas$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Processors$Processorversions$Get, + params?: Params$Resource$Projects$Locations$Schemas$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; get( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Get, + params: Params$Resource$Projects$Locations$Schemas$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Get, + params: Params$Resource$Projects$Locations$Schemas$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Schemas$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Processorversions$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Schemas$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Get; + {}) as Params$Resource$Projects$Locations$Schemas$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Processors$Processorversions$Get; + params = {} as Params$Resource$Projects$Locations$Schemas$Get; options = {}; } @@ -7731,19 +10804,19 @@ export namespace documentai_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists all versions of a processor. + * Lists Schemas. * @example * ```js * // Before running the sample: @@ -7772,22 +10845,20 @@ export namespace documentai_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await documentai.projects.locations.processors.processorVersions.list({ - * // The maximum number of processor versions to return. If unspecified, at most `10` processor versions will be returned. The maximum value is `20`. Values above `20` will be coerced to `20`. - * pageSize: 'placeholder-value', - * // We will return the processor versions sorted by creation time. The page token will point to the next processor version. - * pageToken: 'placeholder-value', - * // Required. The parent (project, location and processor) to list all versions. Format: `projects/{project\}/locations/{location\}/processors/{processor\}` - * parent: - * 'projects/my-project/locations/my-location/processors/my-processor', - * }); + * const res = await documentai.projects.locations.schemas.list({ + * // Optional. The maximum number of schema groups to return. If unspecified, at most `10` Schema will be returned. The maximum value is `20`. Values above `20` will be coerced to `20`. + * pageSize: 'placeholder-value', + * // Optional. We will return the schema groups sorted by creation time. The page token will point to the next Schema. + * pageToken: 'placeholder-value', + * // Required. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "processorVersions": [] + * // "schemas": [] * // } * } * @@ -7804,61 +10875,60 @@ export namespace documentai_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Processors$Processorversions$List, + params: Params$Resource$Projects$Locations$Schemas$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Processors$Processorversions$List, + params?: Params$Resource$Projects$Locations$Schemas$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Processors$Processorversions$List, + params: Params$Resource$Projects$Locations$Schemas$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Processors$Processorversions$List, + params: Params$Resource$Projects$Locations$Schemas$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Processors$Processorversions$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Schemas$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Processorversions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Schemas$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Processorversions$List; + {}) as Params$Resource$Projects$Locations$Schemas$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Processors$Processorversions$List; + params = {} as Params$Resource$Projects$Locations$Schemas$List; options = {}; } @@ -7871,7 +10941,7 @@ export namespace documentai_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/processorVersions').replace( + url: (rootUrl + '/v1/{+parent}/schemas').replace( /([^:]\/)\/+/g, '$1' ), @@ -7886,19 +10956,19 @@ export namespace documentai_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Processes a single document. + * Updates a schema. Editable fields are: - `display_name` - `labels` * @example * ```js * // Before running the sample: @@ -7927,32 +10997,33 @@ export namespace documentai_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await documentai.projects.locations.processors.processorVersions.process({ - * // Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: `projects/{project\}/locations/{location\}/processors/{processor\}`, or `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` - * name: 'projects/my-project/locations/my-location/processors/my-processor/processorVersions/my-processorVersion', + * const res = await documentai.projects.locations.schemas.patch({ + * // Identifier. The resource name of the Schema. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}` + * name: 'projects/my-project/locations/my-location/schemas/my-schema', + * // Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name. - labels. + * updateMask: 'placeholder-value', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "fieldMask": "my_fieldMask", - * // "gcsDocument": {}, - * // "imagelessMode": false, - * // "inlineDocument": {}, - * // "labels": {}, - * // "processOptions": {}, - * // "rawDocument": {}, - * // "skipHumanReview": false - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "labels": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "document": {}, - * // "humanReviewStatus": {} + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "labels": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime" * // } * } * @@ -7968,62 +11039,61 @@ export namespace documentai_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - process( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Process, + patch( + params: Params$Resource$Projects$Locations$Schemas$Patch, options: StreamMethodOptions ): Promise>; - process( - params?: Params$Resource$Projects$Locations$Processors$Processorversions$Process, + patch( + params?: Params$Resource$Projects$Locations$Schemas$Patch, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - process( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Process, + patch( + params: Params$Resource$Projects$Locations$Schemas$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - process( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Process, + patch( + params: Params$Resource$Projects$Locations$Schemas$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - process( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Process, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Schemas$Patch, + callback: BodyResponseCallback ): void; - process( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - process( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Processorversions$Process - | BodyResponseCallback + | Params$Resource$Projects$Locations$Schemas$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Process; + {}) as Params$Resource$Projects$Locations$Schemas$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Processors$Processorversions$Process; + params = {} as Params$Resource$Projects$Locations$Schemas$Patch; options = {}; } @@ -8036,11 +11106,8 @@ export namespace documentai_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:process').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -8051,19 +11118,88 @@ export namespace documentai_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Schemas$Create + extends StandardParameters { /** - * Trains a new processor version. Operation metadata is returned as TrainProcessorVersionMetadata. + * Required. The parent (project and location) under which to create the Schema. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDocumentaiV1NextSchema; + } + export interface Params$Resource$Projects$Locations$Schemas$Delete + extends StandardParameters { + /** + * Optional. If set to true, any child resources of this Schema will also be deleted. (Otherwise, the request will only work if the Schema has no child resources.) + */ + force?: boolean; + /** + * Required. The name of the Schema to be deleted. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Schemas$Get + extends StandardParameters { + /** + * Required. The name of the Schema to get. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Schemas$List + extends StandardParameters { + /** + * Optional. The maximum number of schema groups to return. If unspecified, at most `10` Schema will be returned. The maximum value is `20`. Values above `20` will be coerced to `20`. + */ + pageSize?: number; + /** + * Optional. We will return the schema groups sorted by creation time. The page token will point to the next Schema. + */ + pageToken?: string; + /** + * Required. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Schemas$Patch + extends StandardParameters { + /** + * Identifier. The resource name of the Schema. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}` + */ + name?: string; + /** + * Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name. - labels. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDocumentaiV1NextSchema; + } + + export class Resource$Projects$Locations$Schemas$Schemaversions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a schema version. * @example * ```js * // Before running the sample: @@ -8092,34 +11228,33 @@ export namespace documentai_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await documentai.projects.locations.processors.processorVersions.train({ - * // Required. The parent (project, location and processor) to create the new version for. Format: `projects/{project\}/locations/{location\}/processors/{processor\}`. - * parent: - * 'projects/my-project/locations/my-location/processors/my-processor', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "baseProcessorVersion": "my_baseProcessorVersion", - * // "customDocumentExtractionOptions": {}, - * // "documentSchema": {}, - * // "foundationModelTuningOptions": {}, - * // "inputData": {}, - * // "processorVersion": {} + * const res = await documentai.projects.locations.schemas.schemaVersions.create( + * { + * // Required. The parent (project and location) under which to create the SchemaVersion. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}` + * parent: 'projects/my-project/locations/my-location/schemas/my-schema', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "labels": {}, + * // "name": "my_name", + * // "schema": {} * // } * }, - * }); + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "labels": {}, * // "name": "my_name", - * // "response": {} + * // "schema": {} * // } * } * @@ -8135,58 +11270,62 @@ export namespace documentai_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - train( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Train, + create( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$Create, options: StreamMethodOptions ): Promise>; - train( - params?: Params$Resource$Projects$Locations$Processors$Processorversions$Train, + create( + params?: Params$Resource$Projects$Locations$Schemas$Schemaversions$Create, options?: MethodOptions - ): Promise>; - train( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Train, + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - train( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Train, + create( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - train( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Train, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$Create, + callback: BodyResponseCallback ): void; - train( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - train( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Processorversions$Train - | BodyResponseCallback + | Params$Resource$Projects$Locations$Schemas$Schemaversions$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Train; + {}) as Params$Resource$Projects$Locations$Schemas$Schemaversions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Processors$Processorversions$Train; + {} as Params$Resource$Projects$Locations$Schemas$Schemaversions$Create; options = {}; } @@ -8199,7 +11338,7 @@ export namespace documentai_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/processorVersions:train').replace( + url: (rootUrl + '/v1/{+parent}/schemaVersions').replace( /([^:]\/)\/+/g, '$1' ), @@ -8214,17 +11353,19 @@ export namespace documentai_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Undeploys the processor version. + * Deletes a schema version. * @example * ```js * // Before running the sample: @@ -8253,17 +11394,12 @@ export namespace documentai_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await documentai.projects.locations.processors.processorVersions.undeploy({ - * // Required. The processor version resource name to be undeployed. - * name: 'projects/my-project/locations/my-location/processors/my-processor/processorVersions/my-processorVersion', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }); + * const res = await documentai.projects.locations.schemas.schemaVersions.delete( + * { + * // Required. The name of the SchemaVersion to delete. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}/schemaVersions/{schema_version\}` + * name: 'projects/my-project/locations/my-location/schemas/my-schema/schemaVersions/my-schemaVersion', + * }, + * ); * console.log(res.data); * * // Example response @@ -8288,36 +11424,36 @@ export namespace documentai_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - undeploy( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Undeploy, + delete( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$Delete, options: StreamMethodOptions ): Promise>; - undeploy( - params?: Params$Resource$Projects$Locations$Processors$Processorversions$Undeploy, + delete( + params?: Params$Resource$Projects$Locations$Schemas$Schemaversions$Delete, options?: MethodOptions ): Promise>; - undeploy( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Undeploy, + delete( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - undeploy( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Undeploy, + delete( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - undeploy( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Undeploy, + delete( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$Delete, callback: BodyResponseCallback ): void; - undeploy( + delete( callback: BodyResponseCallback ): void; - undeploy( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Processorversions$Undeploy + | Params$Resource$Projects$Locations$Schemas$Schemaversions$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -8333,13 +11469,13 @@ export namespace documentai_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Undeploy; + {}) as Params$Resource$Projects$Locations$Schemas$Schemaversions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Processors$Processorversions$Undeploy; + {} as Params$Resource$Projects$Locations$Schemas$Schemaversions$Delete; options = {}; } @@ -8352,11 +11488,8 @@ export namespace documentai_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:undeploy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -8375,118 +11508,9 @@ export namespace documentai_v1 { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Processors$Processorversions$Batchprocess - extends StandardParameters { - /** - * Required. The resource name of Processor or ProcessorVersion. Format: `projects/{project\}/locations/{location\}/processors/{processor\}`, or `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDocumentaiV1BatchProcessRequest; - } - export interface Params$Resource$Projects$Locations$Processors$Processorversions$Delete - extends StandardParameters { - /** - * Required. The processor version resource name to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Processors$Processorversions$Deploy - extends StandardParameters { - /** - * Required. The processor version resource name to be deployed. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDocumentaiV1DeployProcessorVersionRequest; - } - export interface Params$Resource$Projects$Locations$Processors$Processorversions$Evaluateprocessorversion - extends StandardParameters { - /** - * Required. The resource name of the ProcessorVersion to evaluate. `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` - */ - processorVersion?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDocumentaiV1EvaluateProcessorVersionRequest; - } - export interface Params$Resource$Projects$Locations$Processors$Processorversions$Get - extends StandardParameters { - /** - * Required. The processor resource name. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Processors$Processorversions$List - extends StandardParameters { - /** - * The maximum number of processor versions to return. If unspecified, at most `10` processor versions will be returned. The maximum value is `20`. Values above `20` will be coerced to `20`. - */ - pageSize?: number; - /** - * We will return the processor versions sorted by creation time. The page token will point to the next processor version. - */ - pageToken?: string; - /** - * Required. The parent (project, location and processor) to list all versions. Format: `projects/{project\}/locations/{location\}/processors/{processor\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Processors$Processorversions$Process - extends StandardParameters { - /** - * Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: `projects/{project\}/locations/{location\}/processors/{processor\}`, or `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDocumentaiV1ProcessRequest; - } - export interface Params$Resource$Projects$Locations$Processors$Processorversions$Train - extends StandardParameters { - /** - * Required. The parent (project, location and processor) to create the new version for. Format: `projects/{project\}/locations/{location\}/processors/{processor\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDocumentaiV1TrainProcessorVersionRequest; - } - export interface Params$Resource$Projects$Locations$Processors$Processorversions$Undeploy - extends StandardParameters { - /** - * Required. The processor version resource name to be undeployed. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDocumentaiV1UndeployProcessorVersionRequest; - } - - export class Resource$Projects$Locations$Processors$Processorversions$Evaluations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Retrieves a specific evaluation. + * Generates a schema version. * @example * ```js * // Before running the sample: @@ -8516,23 +11540,28 @@ export namespace documentai_v1 { * * // Do the magic * const res = - * await documentai.projects.locations.processors.processorVersions.evaluations.get( - * { - * // Required. The resource name of the Evaluation to get. `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}/evaluations/{evaluation\}` - * name: 'projects/my-project/locations/my-location/processors/my-processor/processorVersions/my-processorVersion/evaluations/my-evaluation', + * await documentai.projects.locations.schemas.schemaVersions.generate({ + * // Required. The parent (project, location and schema) under which to generate the SchemaVersion. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}` + * parent: 'projects/my-project/locations/my-location/schemas/my-schema', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "baseSchemaVersion": "my_baseSchemaVersion", + * // "gcsDocuments": {}, + * // "gcsPrefix": {}, + * // "generateSchemaVersionParams": {}, + * // "inlineDocuments": {}, + * // "rawDocuments": {} + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response * // { - * // "allEntitiesMetrics": {}, - * // "createTime": "my_createTime", - * // "documentCounters": {}, - * // "entityMetrics": {}, - * // "kmsKeyName": "my_kmsKeyName", - * // "kmsKeyVersionName": "my_kmsKeyVersionName", - * // "name": "my_name" + * // "schemaVersion": {} * // } * } * @@ -8548,62 +11577,62 @@ export namespace documentai_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$Get, + generate( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$Generate, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$Get, + generate( + params?: Params$Resource$Projects$Locations$Schemas$Schemaversions$Generate, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$Get, + generate( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$Generate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$Get, + generate( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$Generate, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$Get, - callback: BodyResponseCallback + generate( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$Generate, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + generate( + callback: BodyResponseCallback ): void; - get( + generate( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Schemas$Schemaversions$Generate + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$Get; + {}) as Params$Resource$Projects$Locations$Schemas$Schemaversions$Generate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$Get; + {} as Params$Resource$Projects$Locations$Schemas$Schemaversions$Generate; options = {}; } @@ -8616,31 +11645,34 @@ export namespace documentai_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+parent}/schemaVersions:generate').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Retrieves a set of evaluations for a given processor version. + * Gets a schema version. * @example * ```js * // Before running the sample: @@ -8669,24 +11701,19 @@ export namespace documentai_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await documentai.projects.locations.processors.processorVersions.evaluations.list( - * { - * // The standard list page size. If unspecified, at most `5` evaluations are returned. The maximum value is `100`. Values above `100` are coerced to `100`. - * pageSize: 'placeholder-value', - * // A page token, received from a previous `ListEvaluations` call. Provide this to retrieve the subsequent page. - * pageToken: 'placeholder-value', - * // Required. The resource name of the ProcessorVersion to list evaluations for. `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` - * parent: - * 'projects/my-project/locations/my-location/processors/my-processor/processorVersions/my-processorVersion', - * }, - * ); + * const res = await documentai.projects.locations.schemas.schemaVersions.get({ + * // Required. The name of the SchemaVersion to get. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}/schemaVersions/{schema_version\}` + * name: 'projects/my-project/locations/my-location/schemas/my-schema/schemaVersions/my-schemaVersion', + * }); * console.log(res.data); * * // Example response * // { - * // "evaluations": [], - * // "nextPageToken": "my_nextPageToken" + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "labels": {}, + * // "name": "my_name", + * // "schema": {} * // } * } * @@ -8702,62 +11729,62 @@ export namespace documentai_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$List, + get( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$List, + get( + params?: Params$Resource$Projects$Locations$Schemas$Schemaversions$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$List, + get( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$List, + get( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Schemas$Schemaversions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$List; + {}) as Params$Resource$Projects$Locations$Schemas$Schemaversions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$List; + {} as Params$Resource$Projects$Locations$Schemas$Schemaversions$Get; options = {}; } @@ -8770,64 +11797,31 @@ export namespace documentai_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/evaluations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$Get - extends StandardParameters { - /** - * Required. The resource name of the Evaluation to get. `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}/evaluations/{evaluation\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$List - extends StandardParameters { - /** - * The standard list page size. If unspecified, at most `5` evaluations are returned. The maximum value is `100`. Values above `100` are coerced to `100`. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListEvaluations` call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. The resource name of the ProcessorVersion to list evaluations for. `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` - */ - parent?: string; - } - - export class Resource$Projects$Locations$Processortypes { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Gets a processor type detail. + * Lists SchemaVersions. * @example * ```js * // Before running the sample: @@ -8856,21 +11850,20 @@ export namespace documentai_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await documentai.projects.locations.processorTypes.get({ - * // Required. The processor type resource name. - * name: 'projects/my-project/locations/my-location/processorTypes/my-processorType', + * const res = await documentai.projects.locations.schemas.schemaVersions.list({ + * // Optional. The maximum number of SchemaVersion to return. If unspecified, at most `10` SchemaVersion will be returned. The maximum value is `20`. Values above `20` will be coerced to `20`. + * pageSize: 'placeholder-value', + * // Optional. We will return the SchemaVersion sorted by creation time. The page token will point to the next SchemaVersion. + * pageToken: 'placeholder-value', + * // Required. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}` + * parent: 'projects/my-project/locations/my-location/schemas/my-schema', * }); * console.log(res.data); * * // Example response * // { - * // "allowCreation": false, - * // "availableLocations": [], - * // "category": "my_category", - * // "launchStage": "my_launchStage", - * // "name": "my_name", - * // "sampleDocumentUris": [], - * // "type": "my_type" + * // "nextPageToken": "my_nextPageToken", + * // "schemaVersions": [] * // } * } * @@ -8886,61 +11879,62 @@ export namespace documentai_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Processortypes$Get, + list( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Processortypes$Get, + list( + params?: Params$Resource$Projects$Locations$Schemas$Schemaversions$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Processortypes$Get, + list( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Processortypes$Get, + list( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Processortypes$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processortypes$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Schemas$Schemaversions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processortypes$Get; + {}) as Params$Resource$Projects$Locations$Schemas$Schemaversions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Processortypes$Get; + params = + {} as Params$Resource$Projects$Locations$Schemas$Schemaversions$List; options = {}; } @@ -8953,31 +11947,34 @@ export namespace documentai_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/schemaVersions').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists the processor types that exist. + * Updates a schema version. Editable fields are: - `display_name` - `labels` * @example * ```js * // Before running the sample: @@ -9006,20 +12003,33 @@ export namespace documentai_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await documentai.projects.locations.processorTypes.list({ - * // The maximum number of processor types to return. If unspecified, at most `100` processor types will be returned. The maximum value is `500`. Values above `500` will be coerced to `500`. - * pageSize: 'placeholder-value', - * // Used to retrieve the next page of results, empty if at the end of the list. - * pageToken: 'placeholder-value', - * // Required. The location of processor types to list. Format: `projects/{project\}/locations/{location\}`. - * parent: 'projects/my-project/locations/my-location', + * const res = await documentai.projects.locations.schemas.schemaVersions.patch({ + * // Identifier. The resource name of the SchemaVersion. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}/schemaVersions/{schema_version\}` + * name: 'projects/my-project/locations/my-location/schemas/my-schema/schemaVersions/my-schemaVersion', + * // Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name. - labels. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "labels": {}, + * // "name": "my_name", + * // "schema": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "processorTypes": [] + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "labels": {}, + * // "name": "my_name", + * // "schema": {} * // } * } * @@ -9035,61 +12045,62 @@ export namespace documentai_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Processortypes$List, + patch( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$Patch, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Processortypes$List, + patch( + params?: Params$Resource$Projects$Locations$Schemas$Schemaversions$Patch, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Processortypes$List, + patch( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Processortypes$List, + patch( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Processortypes$List, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$Patch, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - list( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processortypes$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Schemas$Schemaversions$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processortypes$List; + {}) as Params$Resource$Projects$Locations$Schemas$Schemaversions$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Processortypes$List; + params = + {} as Params$Resource$Projects$Locations$Schemas$Schemaversions$Patch; options = {}; } @@ -9102,55 +12113,99 @@ export namespace documentai_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/processorTypes').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Processortypes$Get + export interface Params$Resource$Projects$Locations$Schemas$Schemaversions$Create extends StandardParameters { /** - * Required. The processor type resource name. + * Required. The parent (project and location) under which to create the SchemaVersion. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDocumentaiV1SchemaVersion; + } + export interface Params$Resource$Projects$Locations$Schemas$Schemaversions$Delete + extends StandardParameters { + /** + * Required. The name of the SchemaVersion to delete. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}/schemaVersions/{schema_version\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Processortypes$List + export interface Params$Resource$Projects$Locations$Schemas$Schemaversions$Generate extends StandardParameters { /** - * The maximum number of processor types to return. If unspecified, at most `100` processor types will be returned. The maximum value is `500`. Values above `500` will be coerced to `500`. + * Required. The parent (project, location and schema) under which to generate the SchemaVersion. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDocumentaiV1GenerateSchemaVersionRequest; + } + export interface Params$Resource$Projects$Locations$Schemas$Schemaversions$Get + extends StandardParameters { + /** + * Required. The name of the SchemaVersion to get. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}/schemaVersions/{schema_version\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Schemas$Schemaversions$List + extends StandardParameters { + /** + * Optional. The maximum number of SchemaVersion to return. If unspecified, at most `10` SchemaVersion will be returned. The maximum value is `20`. Values above `20` will be coerced to `20`. */ pageSize?: number; /** - * Used to retrieve the next page of results, empty if at the end of the list. + * Optional. We will return the SchemaVersion sorted by creation time. The page token will point to the next SchemaVersion. */ pageToken?: string; /** - * Required. The location of processor types to list. Format: `projects/{project\}/locations/{location\}`. + * Required. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}` */ parent?: string; } + export interface Params$Resource$Projects$Locations$Schemas$Schemaversions$Patch + extends StandardParameters { + /** + * Identifier. The resource name of the SchemaVersion. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}/schemaVersions/{schema_version\}` + */ + name?: string; + /** + * Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name. - labels. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDocumentaiV1SchemaVersion; + } export class Resource$Projects$Operations { context: APIRequestContext; diff --git a/src/apis/documentai/v1beta3.ts b/src/apis/documentai/v1beta3.ts index 2b39c3a64e..0c47cc80d6 100644 --- a/src/apis/documentai/v1beta3.ts +++ b/src/apis/documentai/v1beta3.ts @@ -499,6 +499,123 @@ export namespace documentai_v1beta3 { */ docId?: string | null; } + /** + * The schema defines the output of the processed document by a processor. + */ + export interface Schema$GoogleCloudDocumentaiUiv1beta3DocumentSchema { + /** + * Description of the schema. + */ + description?: string | null; + /** + * Display name to show to users. + */ + displayName?: string | null; + /** + * Entity types of the schema. + */ + entityTypes?: Schema$GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType[]; + /** + * Metadata of the schema. + */ + metadata?: Schema$GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata; + } + /** + * EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. + */ + export interface Schema$GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType { + /** + * The entity type that this type is derived from. For now, one and only one should be set. + */ + baseTypes?: string[] | null; + /** + * The description of the entity type. Could be used to provide more information about the entity type for model calls. + */ + description?: string | null; + /** + * User defined name for the type. + */ + displayName?: string | null; + /** + * Metadata for the entity type. + */ + entityTypeMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata; + /** + * If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is \>10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file. + */ + enumValues?: Schema$GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues; + /** + * Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + */ + name?: string | null; + /** + * Description the nested structure, or composition of an entity. + */ + properties?: Schema$GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty[]; + } + /** + * Defines the a list of enum values. + */ + export interface Schema$GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues { + /** + * The individual values that this enum values type can include. + */ + values?: string[] | null; + } + /** + * Defines properties that can be part of the entity type. + */ + export interface Schema$GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty { + /** + * The description of the property. Could be used to provide more information about the property for model calls. + */ + description?: string | null; + /** + * User defined name for the property. + */ + displayName?: string | null; + /** + * Specifies how the entity's value is obtained. + */ + method?: string | null; + /** + * The name of the property. Follows the same guidelines as the EntityType name. + */ + name?: string | null; + /** + * Occurrence type limits the number of instances an entity type appears in the document. + */ + occurrenceType?: string | null; + /** + * Any additional metadata about the property can be added here. + */ + propertyMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3PropertyMetadata; + /** + * A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field. + */ + valueType?: string | null; + } + /** + * Metadata for global schema behavior. + */ + export interface Schema$GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata { + /** + * If true, on a given page, there can be multiple `document` annotations covering it. + */ + documentAllowMultipleLabels?: boolean | null; + /** + * If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification). + */ + documentSplitter?: boolean | null; + /** + * If set, all the nested entities must be prefixed with the parents. + */ + prefixedNamingOnProperties?: boolean | null; + /** + * If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked. + */ + skipNamingValidation?: boolean | null; + } /** * The long-running operation metadata for the EnableProcessor method. */ @@ -512,6 +629,35 @@ export namespace documentai_v1beta3 { * Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future. */ export interface Schema$GoogleCloudDocumentaiUiv1beta3EnableProcessorResponse {} + /** + * Metadata about an entity type. + */ + export interface Schema$GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata { + /** + * Field tier metadata on the property + */ + fieldTierMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3FieldTierMetadata; + /** + * Human review labeling config on the entity. + */ + humanReviewLabelingMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata; + /** + * Human review config on the entity. + */ + humanReviewMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata; + /** + * Whether the entity type should be considered inactive. + */ + inactive?: boolean | null; + /** + * Schema editability metadata on the entity. + */ + schemaEditabilityMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata; + /** + * Schema inference metadata on the entity. + */ + schemaInferenceMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata; + } /** * Metadata of the EvaluateProcessorVersion method. */ @@ -530,6 +676,76 @@ export namespace documentai_v1beta3 { */ evaluation?: string | null; } + /** + * Evaluation metrics, either in aggregate or about a specific entity. + */ + export interface Schema$GoogleCloudDocumentaiUiv1beta3EvaluationMetrics { + /** + * The calculated f1 score. + */ + f1Score?: number | null; + /** + * The amount of false negatives. + */ + falseNegativesCount?: number | null; + /** + * The amount of false positives. + */ + falsePositivesCount?: number | null; + /** + * The amount of documents with a ground truth occurrence. + */ + groundTruthDocumentCount?: number | null; + /** + * The amount of occurrences in ground truth documents. + */ + groundTruthOccurrencesCount?: number | null; + /** + * The calculated precision. + */ + precision?: number | null; + /** + * The amount of documents with a predicted occurrence. + */ + predictedDocumentCount?: number | null; + /** + * The amount of occurrences in predicted documents. + */ + predictedOccurrencesCount?: number | null; + /** + * The calculated recall. + */ + recall?: number | null; + /** + * The amount of documents that had an occurrence of this label. + */ + totalDocumentsCount?: number | null; + /** + * The amount of true positives. + */ + truePositivesCount?: number | null; + } + /** + * Gives a short summary of an evaluation, and links to the evaluation itself. + */ + export interface Schema$GoogleCloudDocumentaiUiv1beta3EvaluationReference { + /** + * An aggregate of the statistics for the evaluation with fuzzy matching on. + */ + aggregateMetrics?: Schema$GoogleCloudDocumentaiUiv1beta3EvaluationMetrics; + /** + * An aggregate of the statistics for the evaluation with fuzzy matching off. + */ + aggregateMetricsExact?: Schema$GoogleCloudDocumentaiUiv1beta3EvaluationMetrics; + /** + * The resource name of the evaluation. + */ + evaluation?: string | null; + /** + * The resource name of the Long Running Operation for the evaluation. + */ + operation?: string | null; + } /** * Metadata of the batch export documents operation. */ @@ -599,6 +815,59 @@ export namespace documentai_v1beta3 { */ gcsUri?: string | null; } + /** + * Metadata for how this field value is extracted. + */ + export interface Schema$GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata { + /** + * Entity query config. + */ + entityQuery?: Schema$GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery; + /** + * Summary options config. + */ + summaryOptions?: Schema$GoogleCloudDocumentaiUiv1beta3SummaryOptions; + } + /** + * Message for entity query. + */ + export interface Schema$GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery { + /** + * The original entity query inputed by the user. + */ + userEntityQuery?: string | null; + } + /** + * Metadata for the field tier of a property. + */ + export interface Schema$GoogleCloudDocumentaiUiv1beta3FieldTierMetadata { + /** + * Integer that indicates the tier of a property. e.g. Invoice has entities that are classified as tier 1 which is the most important, while tier 2 and tier 3 less so. This attribute can be used to filter schema attributes before running eval. e.g. compute F1 score for only tier 1 entities. If not present this attribute should be inferred as 1. + */ + tierLevel?: number | null; + } + /** + * Metadata for human review labeling config. + */ + export interface Schema$GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata { + /** + * Whether to enable normalization editing. + */ + enableNormalizationEditing?: boolean | null; + } + /** + * Metadata for Human Review config. + */ + export interface Schema$GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata { + /** + * The confidence threshold if human review validation is enabled. + */ + confidenceThreshold?: number | null; + /** + * Whether to enable human review validation. + */ + enableValidation?: boolean | null; + } /** * Metadata of the import document operation. */ @@ -677,3891 +946,6161 @@ export namespace documentai_v1beta3 { processorVersion?: string | null; } /** - * The metadata proto of `ResyncDataset` method. + * The first-class citizen for Document AI. Each processor defines how to extract structural information from a document. */ - export interface Schema$GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata { + export interface Schema$GoogleCloudDocumentaiUiv1beta3Processor { /** - * The basic metadata of the long-running operation. + * Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project\}/locations/{location\}/schemas/{schema\}/schemaVersions/{schema_version\} */ - commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata; + activeSchemaVersion?: string | null; /** - * The list of dataset resync statuses. Not checked when ResyncDatasetRequest.dataset_documents is specified. + * Output only. The time the processor was created. */ - datasetResyncStatuses?: Schema$GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus[]; + createTime?: string | null; /** - * The list of document resync statuses. The same document could have multiple `individual_document_resync_statuses` if it has multiple inconsistencies. + * The default processor version. */ - individualDocumentResyncStatuses?: Schema$GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus[]; - } - /** - * Resync status against inconsistency types on the dataset level. - */ - export interface Schema$GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus { + defaultProcessorVersion?: string | null; /** - * The type of the inconsistency of the dataset. + * The display name of the processor. */ - datasetInconsistencyType?: string | null; + displayName?: string | null; /** - * The status of resyncing the dataset with regards to the detected inconsistency. Empty if ResyncDatasetRequest.validate_only is `true`. + * The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios. */ - status?: Schema$GoogleRpcStatus; - } - /** - * Resync status for each document per inconsistency type. - */ - export interface Schema$GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus { + kmsKeyName?: string | null; /** - * The document identifier. + * Output only. Immutable. The resource name of the processor. Format: `projects/{project\}/locations/{location\}/processors/{processor\}` */ - documentId?: Schema$GoogleCloudDocumentaiUiv1beta3DocumentId; + name?: string | null; /** - * The type of document inconsistency. + * Output only. Immutable. The http endpoint that can be called to invoke processing. */ - documentInconsistencyType?: string | null; + processEndpoint?: string | null; /** - * The status of resyncing the document with regards to the detected inconsistency. Empty if ResyncDatasetRequest.validate_only is `true`. + * Output only. The processor version aliases. */ - status?: Schema$GoogleRpcStatus; - } - /** - * The response proto of ResyncDataset method. - */ - export interface Schema$GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse {} - /** - * The revision reference specifies which revision on the document to read. - */ - export interface Schema$GoogleCloudDocumentaiUiv1beta3RevisionRef { + processorVersionAliases?: Schema$GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias[]; /** - * Reads the revision generated by the processor version. The format takes the full resource name of processor version. `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` + * Output only. Reserved for future use. */ - latestProcessorVersion?: string | null; + satisfiesPzi?: boolean | null; /** - * Reads the revision by the predefined case. + * Output only. Reserved for future use. */ - revisionCase?: string | null; + satisfiesPzs?: boolean | null; /** - * Reads the revision given by the id. + * Output only. The state of the processor. */ - revisionId?: string | null; - } - /** - * Metadata of the sample documents operation. - */ - export interface Schema$GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata { + state?: string | null; /** - * The basic metadata of the long-running operation. + * The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor types, see FetchProcessorTypes. */ - commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata; + type?: string | null; } /** - * Response of the sample documents operation. + * 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. */ - export interface Schema$GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse { + export interface Schema$GoogleCloudDocumentaiUiv1beta3ProcessorVersion { /** - * The status of sampling documents in test split. + * Output only. The time the processor version was created. */ - sampleTestStatus?: Schema$GoogleRpcStatus; + createTime?: string | null; /** - * The status of sampling documents in training split. + * Output only. Denotes that this `ProcessorVersion` can be deployed and undeployed. */ - sampleTrainingStatus?: Schema$GoogleRpcStatus; + deploymentAllowed?: boolean | null; /** - * The result of the sampling process. + * Output only. If set, information about the eventual deprecation of this version. */ - selectedDocuments?: Schema$GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument[]; - } - export interface Schema$GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument { + deprecationInfo?: Schema$GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo; /** - * An internal identifier for document. + * The display name of the processor version. */ - documentId?: string | null; - } - /** - * The long-running operation metadata for the SetDefaultProcessorVersion method. - */ - export interface Schema$GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata { + displayName?: string | null; /** - * The basic metadata of the long-running operation. + * Output only. The schema of the processor version. Describes the output. */ - commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata; - } - /** - * Response message for the SetDefaultProcessorVersion method. - */ - export interface Schema$GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse {} - /** - * The metadata that represents a processor version being created. - */ - export interface Schema$GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata { + documentSchema?: Schema$GoogleCloudDocumentaiUiv1beta3DocumentSchema; /** - * The basic metadata of the long-running operation. + * Output only. Information about Generative AI model-based processor versions. */ - commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata; + genAiModelInfo?: Schema$GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo; /** - * The test dataset validation information. + * Output only. Denotes that this `ProcessorVersion` is managed by Google. */ - testDatasetValidation?: Schema$GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation; + googleManaged?: boolean | null; /** - * The training dataset validation information. + * Output only. The KMS key name used for encryption. */ - trainingDatasetValidation?: Schema$GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation; - } - /** - * The dataset validation information. This includes any and all errors with documents and the dataset. - */ - export interface Schema$GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation { + kmsKeyName?: string | null; /** - * The total number of dataset errors. + * Output only. The KMS key version with which data is encrypted. */ - datasetErrorCount?: number | null; + kmsKeyVersionName?: string | null; /** - * Error information for the dataset as a whole. A maximum of 10 dataset errors will be returned. A single dataset error is terminal for training. + * Output only. The most recently invoked evaluation for the processor version. */ - datasetErrors?: Schema$GoogleRpcStatus[]; + latestEvaluation?: Schema$GoogleCloudDocumentaiUiv1beta3EvaluationReference; /** - * The total number of document errors. + * Output only. The model type of this processor version. */ - documentErrorCount?: number | null; + modelType?: string | null; /** - * Error information pertaining to specific documents. A maximum of 10 document errors will be returned. Any document with errors will not be used throughout training. + * Identifier. The resource name of the processor version. Format: `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processor_version\}` */ - documentErrors?: Schema$GoogleRpcStatus[]; + name?: string | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; + /** + * The schema of the processor version. Describes the output. + */ + schema?: Schema$GoogleCloudDocumentaiUiv1beta3Schema; + /** + * Output only. The state of the processor version. + */ + state?: string | null; } /** - * The response for TrainProcessorVersion. + * Contains the alias and the aliased resource name of processor version. */ - export interface Schema$GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse { + export interface Schema$GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias { /** - * The resource name of the processor version produced by training. + * The alias in the form of `processor_version` resource name. + */ + alias?: string | null; + /** + * The resource name of aliased processor version. */ processorVersion?: string | null; } /** - * The long-running operation metadata for the UndeployProcessorVersion method. + * Information about the upcoming deprecation of this processor version. */ - export interface Schema$GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata { + export interface Schema$GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo { /** - * The basic metadata of the long-running operation. + * The time at which this processor version will be deprecated. */ - commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata; - } - /** - * Response message for the UndeployProcessorVersion method. - */ - export interface Schema$GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse {} - export interface Schema$GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata { + deprecationTime?: string | null; /** - * The basic metadata of the long-running operation. + * If set, the processor version that will be used as a replacement. */ - commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata; + replacementProcessorVersion?: string | null; } /** - * The long-running operation metadata for updating the human review configuration. + * Information about Generative AI model-based processor versions. */ - export interface Schema$GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata { + export interface Schema$GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo { /** - * The basic metadata of the long-running operation. + * Information for a custom Generative AI model created by the user. */ - commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata; + customGenAiModelInfo?: Schema$GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo; + /** + * Information for a pretrained Google-managed foundation model. + */ + foundationGenAiModelInfo?: Schema$GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo; } /** - * The long-running operation metadata for UpdateLabelerPool. + * Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs. */ - export interface Schema$GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata { + export interface Schema$GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo { /** - * The basic metadata of the long-running operation. + * The base processor version ID for the custom model. */ - commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata; + baseProcessorVersionId?: string | null; + /** + * The type of custom model created by the user. + */ + customModelType?: string | null; } /** - * The long-running operation metadata for BatchProcessDocuments. + * Information for a pretrained Google-managed foundation model. */ - export interface Schema$GoogleCloudDocumentaiV1BatchProcessMetadata { + export interface Schema$GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo { /** - * The creation time of the operation. + * Whether finetuning is allowed for this base processor version. */ - createTime?: string | null; + finetuningAllowed?: boolean | null; /** - * The list of response details of each document. + * The minimum number of labeled documents in the training dataset required for finetuning. */ - individualProcessStatuses?: Schema$GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus[]; + minTrainLabeledDocuments?: number | null; + } + /** + * Metadata about a property. + */ + export interface Schema$GoogleCloudDocumentaiUiv1beta3PropertyMetadata { /** - * The state of the current batch processing. + * Field extraction metadata on the property. */ - state?: string | null; + fieldExtractionMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata; /** - * A message providing more details about the current state of processing. For example, the error message if the operation is failed. + * Field tier metadata on the property */ - stateMessage?: string | null; + fieldTierMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3FieldTierMetadata; /** - * The last update time of the operation. + * Human review labeling config on the property. */ - updateTime?: string | null; - } - /** - * The status of a each individual document in the batch process. - */ - export interface Schema$GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus { + humanReviewLabelingMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata; /** - * The status of human review on the processed document. + * Human review validation config on the property. */ - humanReviewStatus?: Schema$GoogleCloudDocumentaiV1HumanReviewStatus; + humanReviewMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata; /** - * The source of the document, same as the input_gcs_source field in the request when the batch process started. + * Whether the property should be considered as "inactive". */ - inputGcsSource?: string | null; + inactive?: boolean | null; /** - * The Cloud Storage output destination (in the request as DocumentOutputConfig.GcsOutputConfig.gcs_uri) of the processed document if it was successful, otherwise empty. + * Schema editability metadata on the property. */ - outputGcsDestination?: string | null; + schemaEditabilityMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata; /** - * The status processing the document. + * Schema inference metadata on the property. */ - status?: Schema$GoogleRpcStatus; + schemaInferenceMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata; } /** - * Response message for BatchProcessDocuments. - */ - export interface Schema$GoogleCloudDocumentaiV1BatchProcessResponse {} - /** - * Encodes the detailed information of a barcode. + * The metadata proto of `ResyncDataset` method. */ - export interface Schema$GoogleCloudDocumentaiV1beta3Barcode { + export interface Schema$GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata { /** - * Format of a barcode. The supported formats are: - `CODE_128`: Code 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - `DATABAR`: GS1 DataBar code type. + * The basic metadata of the long-running operation. */ - format?: string | null; + commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata; /** - * Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. + * The list of dataset resync statuses. Not checked when ResyncDatasetRequest.dataset_documents is specified. */ - rawValue?: string | null; + datasetResyncStatuses?: Schema$GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus[]; /** - * Value format describes the format of the value that a barcode encodes. The supported formats are: - `CONTACT_INFO`: Contact information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar event. - `DRIVER_LICENSE`: Driver's license. + * The list of document resync statuses. The same document could have multiple `individual_document_resync_statuses` if it has multiple inconsistencies. */ - valueFormat?: string | null; + individualDocumentResyncStatuses?: Schema$GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus[]; } /** - * Dataset documents that the batch operation will be applied to. + * Resync status against inconsistency types on the dataset level. */ - export interface Schema$GoogleCloudDocumentaiV1beta3BatchDatasetDocuments { + export interface Schema$GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus { /** - * A filter matching the documents. Follows the same format and restriction as [google.cloud.documentai.master.ListDocumentsRequest.filter]. + * The type of the inconsistency of the dataset. */ - filter?: string | null; + datasetInconsistencyType?: string | null; /** - * Document identifiers. + * The status of resyncing the dataset with regards to the detected inconsistency. Empty if ResyncDatasetRequest.validate_only is `true`. */ - individualDocumentIds?: Schema$GoogleCloudDocumentaiV1beta3BatchDatasetDocumentsIndividualDocumentIds; + status?: Schema$GoogleRpcStatus; } /** - * List of individual DocumentIds. + * Resync status for each document per inconsistency type. */ - export interface Schema$GoogleCloudDocumentaiV1beta3BatchDatasetDocumentsIndividualDocumentIds { - /** - * Required. List of Document IDs indicating where the actual documents are stored. - */ - documentIds?: Schema$GoogleCloudDocumentaiV1beta3DocumentId[]; - } - export interface Schema$GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata { - /** - * The basic metadata of the long-running operation. - */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; + export interface Schema$GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus { /** - * Total number of documents that failed to be deleted in storage. + * The document identifier. */ - errorDocumentCount?: number | null; + documentId?: Schema$GoogleCloudDocumentaiUiv1beta3DocumentId; /** - * The list of response details of each document. + * The type of document inconsistency. */ - individualBatchDeleteStatuses?: Schema$GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus[]; + documentInconsistencyType?: string | null; /** - * Total number of documents deleting from dataset. + * The status of resyncing the document with regards to the detected inconsistency. Empty if ResyncDatasetRequest.validate_only is `true`. */ - totalDocumentCount?: number | null; + status?: Schema$GoogleRpcStatus; } /** - * The status of each individual document in the batch delete process. + * The response proto of ResyncDataset method. */ - export interface Schema$GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus { + export interface Schema$GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse {} + /** + * The revision reference specifies which revision on the document to read. + */ + export interface Schema$GoogleCloudDocumentaiUiv1beta3RevisionRef { /** - * The document id of the document. + * Reads the revision generated by the processor version. The format takes the full resource name of processor version. `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` */ - documentId?: Schema$GoogleCloudDocumentaiV1beta3DocumentId; + latestProcessorVersion?: string | null; /** - * The status of deleting the document in storage. + * Reads the revision by the predefined case. */ - status?: Schema$GoogleRpcStatus; - } - export interface Schema$GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsRequest { + revisionCase?: string | null; /** - * Required. Dataset documents input. If given `filter`, all documents satisfying the filter will be deleted. If given documentIds, a maximum of 50 documents can be deleted in a batch. The request will be rejected if more than 50 document_ids are provided. + * Reads the revision given by the id. */ - datasetDocuments?: Schema$GoogleCloudDocumentaiV1beta3BatchDatasetDocuments; + revisionId?: string | null; } /** - * Response of the delete documents operation. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse {} - /** - * The common config to specify a set of documents used as input. + * Metadata of the sample documents operation. */ - export interface Schema$GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig { - /** - * The set of documents individually specified on Cloud Storage. - */ - gcsDocuments?: Schema$GoogleCloudDocumentaiV1beta3GcsDocuments; + export interface Schema$GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata { /** - * The set of documents that match the specified Cloud Storage `gcs_prefix`. + * The basic metadata of the long-running operation. */ - gcsPrefix?: Schema$GoogleCloudDocumentaiV1beta3GcsPrefix; + commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata; } /** - * The long-running operation metadata for BatchProcessDocuments. + * Response of the sample documents operation. */ - export interface Schema$GoogleCloudDocumentaiV1beta3BatchProcessMetadata { - /** - * The creation time of the operation. - */ - createTime?: string | null; + export interface Schema$GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse { /** - * The list of response details of each document. + * The status of sampling documents in test split. */ - individualProcessStatuses?: Schema$GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus[]; + sampleTestStatus?: Schema$GoogleRpcStatus; /** - * The state of the current batch processing. + * The status of sampling documents in training split. */ - state?: string | null; + sampleTrainingStatus?: Schema$GoogleRpcStatus; /** - * A message providing more details about the current state of processing. For example, the error message if the operation is failed. + * The result of the sampling process. */ - stateMessage?: string | null; + selectedDocuments?: Schema$GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument[]; + } + export interface Schema$GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument { /** - * The last update time of the operation. + * An internal identifier for document. */ - updateTime?: string | null; + documentId?: string | null; } /** - * The status of a each individual document in the batch process. + * The schema defines the output of the processed document by a processor. */ - export interface Schema$GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus { + export interface Schema$GoogleCloudDocumentaiUiv1beta3Schema { /** - * The name of the operation triggered by the processed document. If the human review process isn't triggered, this field will be empty. It has the same response type and metadata as the long-running operation returned by the ReviewDocument method. + * Description of the schema. */ - humanReviewOperation?: string | null; + description?: string | null; /** - * The status of human review on the processed document. + * Display name to show to users. */ - humanReviewStatus?: Schema$GoogleCloudDocumentaiV1beta3HumanReviewStatus; + displayName?: string | null; /** - * The source of the document, same as the input_gcs_source field in the request when the batch process started. + * Entity types of the schema. */ - inputGcsSource?: string | null; + entityTypes?: Schema$GoogleCloudDocumentaiUiv1beta3SchemaEntityType[]; + } + /** + * Metadata that specifies whether a label is editable and reasons why. These fields are read-only. Changing these fields has no impact on the backend. + */ + export interface Schema$GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata { /** - * The Cloud Storage output destination (in the request as DocumentOutputConfig.GcsOutputConfig.gcs_uri) of the processed document if it was successful, otherwise empty. + * Explicit flag that controls whether the label is editable. */ - outputGcsDestination?: string | null; + editable?: boolean | null; /** - * The status processing the document. + * Full resource name of processor versions that contain this label. e.g. `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` */ - status?: Schema$GoogleRpcStatus; + processorVersions?: string[] | null; } /** - * Request message for BatchProcessDocuments. + * EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. */ - export interface Schema$GoogleCloudDocumentaiV1beta3BatchProcessRequest { + export interface Schema$GoogleCloudDocumentaiUiv1beta3SchemaEntityType { + baseType?: string | null; /** - * The output configuration for the BatchProcessDocuments method. + * Description of the entity type. */ - documentOutputConfig?: Schema$GoogleCloudDocumentaiV1beta3DocumentOutputConfig; + description?: string | null; /** - * The input config for each single document in the batch process. + * If specified, lists all the possible values for this entity. */ - inputConfigs?: Schema$GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchInputConfig[]; + enumValues?: string[] | null; /** - * The input documents for the BatchProcessDocuments method. + * If the entity type is hidden in the schema. This provides the functionality to temporally "disable" an entity without deleting it. */ - inputDocuments?: Schema$GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig; + hide?: boolean | null; /** - * Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. + * Specifies how the entity's value is obtained. */ - labels?: {[key: string]: string} | null; + method?: string | null; /** - * The overall output config for batch process. + * Occurrence type limits the number of times an entity type appears in the document. */ - outputConfig?: Schema$GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchOutputConfig; + occurrenceType?: string | null; /** - * Inference-time options for the process API + * Describing the nested structure of an entity. An EntityType may consist of several other EntityTypes. For example, in a document there can be an EntityType `ID`, which consists of EntityType `name` and `address`, with corresponding attributes, such as TEXT for both types and ONCE for occurrence types. */ - processOptions?: Schema$GoogleCloudDocumentaiV1beta3ProcessOptions; + properties?: Schema$GoogleCloudDocumentaiUiv1beta3SchemaEntityType[]; /** - * Whether human review should be skipped for this request. Default to `false`. + * Source of this entity type. */ - skipHumanReview?: boolean | null; + source?: string | null; + /** + * Name of the type. It must satisfy the following constraints: 1. Must be unique within the set of same level types (with case-insensitive match). 2. Maximum 64 characters. 3. Must start with a letter. 4. Allowed characters: ASCII letters [a-zA-Z], ASCII digits [0-9], or one of the following punctuation characters: * underscore '_' (recommended) * hyphen '-' (allowed, not recommended) * colon ':' (allowed, not recommended) NOTE: Whitespace characters are not allowed. 5. Cannot end with a punctuation character. 6. Cannot contain the following restricted strings: "google", "DocumentAI" (case-insensitive match). 7. A slash character '/' is reserved as a separator in flattened representations of nested entity types (e.g., "line_item/amount") in which case each part (e.g., "line_item", "amount") must comply with the rules defined above. We recommend using the snake case ("snake_case") in entity type names. + */ + type?: string | null; } /** - * The message for input config in batch process. + * Metadata for schema inference. Only used on dataset.schema for schema inference, can be safely ignored elsewhere. */ - export interface Schema$GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchInputConfig { - /** - * The Cloud Storage location as the source of the document. - */ - gcsSource?: string | null; + export interface Schema$GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata { /** - * An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) of the input. If the input is a raw document, refer to [supported file types](https://cloud.google.com/document-ai/docs/file-types) for the list of media types. If the input is a Document, the type should be `application/json`. + * True if is inferred by schema inference. */ - mimeType?: string | null; + inferred?: boolean | null; } /** - * The output configuration in the BatchProcessDocuments method. + * The long-running operation metadata for the SetDefaultProcessorVersion method. */ - export interface Schema$GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchOutputConfig { + export interface Schema$GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata { /** - * The output Cloud Storage directory to put the processed documents. + * The basic metadata of the long-running operation. */ - gcsDestination?: string | null; + commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata; } /** - * Response message for BatchProcessDocuments. + * Response message for the SetDefaultProcessorVersion method. */ - export interface Schema$GoogleCloudDocumentaiV1beta3BatchProcessResponse {} + export interface Schema$GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse {} /** - * A bounding polygon for the detected image annotation. + * Metadata for document summarization. */ - export interface Schema$GoogleCloudDocumentaiV1beta3BoundingPoly { + export interface Schema$GoogleCloudDocumentaiUiv1beta3SummaryOptions { /** - * The bounding polygon normalized vertices. + * The format the summary should be in. */ - normalizedVertices?: Schema$GoogleCloudDocumentaiV1beta3NormalizedVertex[]; + format?: string | null; /** - * The bounding polygon vertices. + * How long the summary should be. */ - vertices?: Schema$GoogleCloudDocumentaiV1beta3Vertex[]; + length?: string | null; } /** - * The common metadata for long running operations. + * The metadata that represents a processor version being created. */ - export interface Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata { - /** - * The creation time of the operation. - */ - createTime?: string | null; - /** - * A related resource to this operation. - */ - resource?: string | null; + export interface Schema$GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata { /** - * The state of the operation. + * The basic metadata of the long-running operation. */ - state?: string | null; + commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata; /** - * A message providing more details about the current state of processing. + * The test dataset validation information. */ - stateMessage?: string | null; + testDatasetValidation?: Schema$GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation; /** - * The last update time of the operation. + * The training dataset validation information. */ - updateTime?: string | null; + trainingDatasetValidation?: Schema$GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation; } /** - * A singleton resource under a Processor which configures a collection of documents. + * The dataset validation information. This includes any and all errors with documents and the dataset. */ - export interface Schema$GoogleCloudDocumentaiV1beta3Dataset { - /** - * Optional. Deprecated. Warehouse-based dataset configuration is not supported. - */ - documentWarehouseConfig?: Schema$GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig; + export interface Schema$GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation { /** - * Optional. User-managed Cloud Storage dataset configuration. Use this configuration if the dataset documents are stored under a user-managed Cloud Storage location. + * The total number of dataset errors. */ - gcsManagedConfig?: Schema$GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig; + datasetErrorCount?: number | null; /** - * Dataset resource name. Format: `projects/{project\}/locations/{location\}/processors/{processor\}/dataset` + * Error information for the dataset as a whole. A maximum of 10 dataset errors will be returned. A single dataset error is terminal for training. */ - name?: string | null; + datasetErrors?: Schema$GoogleRpcStatus[]; /** - * Output only. Reserved for future use. + * The total number of document errors. */ - satisfiesPzi?: boolean | null; + documentErrorCount?: number | null; /** - * Output only. Reserved for future use. + * Error information pertaining to specific documents. A maximum of 10 document errors will be returned. Any document with errors will not be used throughout training. */ - satisfiesPzs?: boolean | null; + documentErrors?: Schema$GoogleRpcStatus[]; + } + /** + * The response for TrainProcessorVersion. + */ + export interface Schema$GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse { /** - * Optional. A lightweight indexing source with low latency and high reliability, but lacking advanced features like CMEK and content-based search. + * The resource name of the processor version produced by training. */ - spannerIndexingConfig?: Schema$GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig; + processorVersion?: string | null; + } + /** + * The long-running operation metadata for the UndeployProcessorVersion method. + */ + export interface Schema$GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata { /** - * Required. State of the dataset. Ignored when updating dataset. + * The basic metadata of the long-running operation. */ - state?: string | null; + commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata; + } + /** + * Response message for the UndeployProcessorVersion method. + */ + export interface Schema$GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse {} + export interface Schema$GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata { /** - * Optional. Unmanaged dataset configuration. Use this configuration if the dataset documents are managed by the document service internally (not user-managed). + * The basic metadata of the long-running operation. */ - unmanagedDatasetConfig?: Schema$GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig; + commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata; } /** - * Configuration specific to the Document AI Warehouse-based implementation. + * The long-running operation metadata for updating the human review configuration. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig { + export interface Schema$GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata { /** - * Output only. The collection in Document AI Warehouse associated with the dataset. + * The basic metadata of the long-running operation. */ - collection?: string | null; + commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata; + } + /** + * The long-running operation metadata for UpdateLabelerPool. + */ + export interface Schema$GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata { /** - * Output only. The schema in Document AI Warehouse associated with the dataset. + * The basic metadata of the long-running operation. */ - schema?: string | null; + commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata; } /** - * Configuration specific to the Cloud Storage-based implementation. + * The long-running operation metadata for the UpdateProcessorVersion method. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig { + export interface Schema$GoogleCloudDocumentaiUiv1beta3UpdateProcessorVersionMetadata { /** - * Required. The Cloud Storage URI (a directory) where the documents belonging to the dataset must be stored. + * The basic metadata for the long-running operation. */ - gcsPrefix?: Schema$GoogleCloudDocumentaiV1beta3GcsPrefix; + commonMetadata?: Schema$GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata; } /** - * Dataset Schema. + * The long-running operation metadata for BatchProcessDocuments. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DatasetSchema { + export interface Schema$GoogleCloudDocumentaiV1BatchProcessMetadata { /** - * Optional. Schema of the dataset. + * The creation time of the operation. */ - documentSchema?: Schema$GoogleCloudDocumentaiV1beta3DocumentSchema; + createTime?: string | null; /** - * Dataset schema resource name. Format: `projects/{project\}/locations/{location\}/processors/{processor\}/dataset/datasetSchema` + * The list of response details of each document. */ - name?: string | null; + individualProcessStatuses?: Schema$GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus[]; /** - * Output only. Reserved for future use. + * The state of the current batch processing. */ - satisfiesPzi?: boolean | null; + state?: string | null; /** - * Output only. Reserved for future use. + * A message providing more details about the current state of processing. For example, the error message if the operation is failed. */ - satisfiesPzs?: boolean | null; - } - /** - * Configuration specific to spanner-based indexing. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig {} - /** - * Configuration specific to an unmanaged dataset. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig {} - /** - * The long-running operation metadata for the DeleteProcessor method. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata { + stateMessage?: string | null; /** - * The basic metadata of the long-running operation. + * The last update time of the operation. */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; + updateTime?: string | null; } /** - * The long-running operation metadata for the DeleteProcessorVersion method. + * The status of a each individual document in the batch process. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata { + export interface Schema$GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus { /** - * The basic metadata of the long-running operation. + * The status of human review on the processed document. */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; - } - /** - * The long-running operation metadata for the DeployProcessorVersion method. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata { + humanReviewStatus?: Schema$GoogleCloudDocumentaiV1HumanReviewStatus; /** - * The basic metadata of the long-running operation. + * The source of the document, same as the input_gcs_source field in the request when the batch process started. */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; - } - /** - * Request message for the DeployProcessorVersion method. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3DeployProcessorVersionRequest {} - /** - * Response message for the DeployProcessorVersion method. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse {} - /** - * The long-running operation metadata for the DisableProcessor method. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3DisableProcessorMetadata { + inputGcsSource?: string | null; /** - * The basic metadata of the long-running operation. + * The Cloud Storage output destination (in the request as DocumentOutputConfig.GcsOutputConfig.gcs_uri) of the processed document if it was successful, otherwise empty. */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; + outputGcsDestination?: string | null; + /** + * The status processing the document. + */ + status?: Schema$GoogleRpcStatus; } /** - * Request message for the DisableProcessor method. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3DisableProcessorRequest {} - /** - * Response message for the DisableProcessor method. Intentionally empty proto for adding fields in future. + * Response message for BatchProcessDocuments. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DisableProcessorResponse {} + export interface Schema$GoogleCloudDocumentaiV1BatchProcessResponse {} /** - * Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. + * Encodes the detailed information of a barcode. */ - export interface Schema$GoogleCloudDocumentaiV1beta3Document { + export interface Schema$GoogleCloudDocumentaiV1beta3Barcode { /** - * Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, e.g. image bytes, such that it can be referenced by other fields in the document via asset id. + * Format of a barcode. The supported formats are: - `CODE_128`: Code 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - `DATABAR`: GS1 DataBar code type. */ - blobAssets?: Schema$GoogleCloudDocumentaiV1beta3DocumentBlobAsset[]; + format?: string | null; /** - * Document chunked based on chunking config. + * Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. */ - chunkedDocument?: Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocument; + rawValue?: string | null; /** - * Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. + * Value format describes the format of the value that a barcode encodes. The supported formats are: - `CONTACT_INFO`: Contact information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar event. - `DRIVER_LICENSE`: Driver's license. */ - content?: string | null; + valueFormat?: string | null; + } + /** + * Dataset documents that the batch operation will be applied to. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3BatchDatasetDocuments { /** - * Optional. An internal identifier for document. Should be loggable (no PII). + * A filter matching the documents. Follows the same format and restriction as [google.cloud.documentai.master.ListDocumentsRequest.filter]. */ - docid?: string | null; + filter?: string | null; /** - * Parsed layout of the document. + * Document identifiers. */ - documentLayout?: Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayout; + individualDocumentIds?: Schema$GoogleCloudDocumentaiV1beta3BatchDatasetDocumentsIndividualDocumentIds; + } + /** + * List of individual DocumentIds. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3BatchDatasetDocumentsIndividualDocumentIds { /** - * A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. + * Required. List of Document IDs indicating where the actual documents are stored. */ - entities?: Schema$GoogleCloudDocumentaiV1beta3DocumentEntity[]; + documentIds?: Schema$GoogleCloudDocumentaiV1beta3DocumentId[]; + } + export interface Schema$GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata { /** - * The entity revision id that `document.entities` field is based on. If this field is set and `entities_revisions` is not empty, the entities in `document.entities` field are the entities in the entity revision with this id and `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision. + * The basic metadata of the long-running operation. */ - entitiesRevisionId?: string | null; + commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; /** - * A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing. + * Total number of documents that failed to be deleted in storage. */ - entitiesRevisions?: Schema$GoogleCloudDocumentaiV1beta3DocumentEntitiesRevision[]; + errorDocumentCount?: number | null; /** - * Placeholder. Relationship among Document.entities. + * The list of response details of each document. */ - entityRelations?: Schema$GoogleCloudDocumentaiV1beta3DocumentEntityRelation[]; + individualBatchDeleteStatuses?: Schema$GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus[]; /** - * The entity validation output for the document. This is the validation output for `document.entities` field. + * Total number of documents deleting from dataset. */ - entityValidationOutput?: Schema$GoogleCloudDocumentaiV1beta3DocumentEntityValidationOutput; + totalDocumentCount?: number | null; + } + /** + * The status of each individual document in the batch delete process. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadataIndividualBatchDeleteStatus { /** - * Any error that occurred while processing this document. + * The document id of the document. */ - error?: Schema$GoogleRpcStatus; + documentId?: Schema$GoogleCloudDocumentaiV1beta3DocumentId; /** - * An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). + * The status of deleting the document in storage. */ - mimeType?: string | null; + status?: Schema$GoogleRpcStatus; + } + export interface Schema$GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsRequest { /** - * Visual page layout for the Document. + * Required. Dataset documents input. If given `filter`, all documents satisfying the filter will be deleted. If given documentIds, a maximum of 50 documents can be deleted in a batch. The request will be rejected if more than 50 document_ids are provided. */ - pages?: Schema$GoogleCloudDocumentaiV1beta3DocumentPage[]; + datasetDocuments?: Schema$GoogleCloudDocumentaiV1beta3BatchDatasetDocuments; + } + /** + * Response of the delete documents operation. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsResponse {} + /** + * The common config to specify a set of documents used as input. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig { /** - * Placeholder. Revision history of this document. + * The set of documents individually specified on Cloud Storage. */ - revisions?: Schema$GoogleCloudDocumentaiV1beta3DocumentRevision[]; + gcsDocuments?: Schema$GoogleCloudDocumentaiV1beta3GcsDocuments; /** - * Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified. + * The set of documents that match the specified Cloud Storage `gcs_prefix`. */ - shardInfo?: Schema$GoogleCloudDocumentaiV1beta3DocumentShardInfo; + gcsPrefix?: Schema$GoogleCloudDocumentaiV1beta3GcsPrefix; + } + /** + * The long-running operation metadata for BatchProcessDocuments. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3BatchProcessMetadata { /** - * Optional. UTF-8 encoded text in reading order from the document. + * The creation time of the operation. */ - text?: string | null; + createTime?: string | null; /** - * Placeholder. A list of text corrections made to Document.text. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap with each other. + * The list of response details of each document. */ - textChanges?: Schema$GoogleCloudDocumentaiV1beta3DocumentTextChange[]; + individualProcessStatuses?: Schema$GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus[]; /** - * Styles for the Document.text. + * The state of the current batch processing. */ - textStyles?: Schema$GoogleCloudDocumentaiV1beta3DocumentStyle[]; + state?: string | null; /** - * Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. For more information, refer to [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris). + * A message providing more details about the current state of processing. For example, the error message if the operation is failed. */ - uri?: string | null; - } - /** - * Represents the annotation of a block or a chunk. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentAnnotations { + stateMessage?: string | null; /** - * The description of the content with this annotation. + * The last update time of the operation. */ - description?: string | null; + updateTime?: string | null; } /** - * Represents a blob asset. It's used to store the content of the inline blob in this document, e.g. image bytes, such that it can be referenced by other fields in the document via asset id. + * The status of a each individual document in the batch process. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentBlobAsset { + export interface Schema$GoogleCloudDocumentaiV1beta3BatchProcessMetadataIndividualProcessStatus { /** - * Optional. The id of the blob asset. + * The name of the operation triggered by the processed document. If the human review process isn't triggered, this field will be empty. It has the same response type and metadata as the long-running operation returned by the ReviewDocument method. */ - assetId?: string | null; + humanReviewOperation?: string | null; /** - * Optional. The content of the blob asset, e.g. image bytes. + * The status of human review on the processed document. */ - content?: string | null; + humanReviewStatus?: Schema$GoogleCloudDocumentaiV1beta3HumanReviewStatus; /** - * The mime type of the blob asset. An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). + * The source of the document, same as the input_gcs_source field in the request when the batch process started. */ - mimeType?: string | null; - } - /** - * Represents the chunks that the document is divided into. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocument { + inputGcsSource?: string | null; /** - * List of chunks. + * The Cloud Storage output destination (in the request as DocumentOutputConfig.GcsOutputConfig.gcs_uri) of the processed document if it was successful, otherwise empty. */ - chunks?: Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunk[]; + outputGcsDestination?: string | null; + /** + * The status processing the document. + */ + status?: Schema$GoogleRpcStatus; } /** - * Represents a chunk. + * Request message for BatchProcessDocuments. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunk { + export interface Schema$GoogleCloudDocumentaiV1beta3BatchProcessRequest { /** - * Chunk fields inside this chunk. + * The output configuration for the BatchProcessDocuments method. */ - chunkFields?: Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkField[]; + documentOutputConfig?: Schema$GoogleCloudDocumentaiV1beta3DocumentOutputConfig; /** - * ID of the chunk. + * The input config for each single document in the batch process. */ - chunkId?: string | null; + inputConfigs?: Schema$GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchInputConfig[]; /** - * Text content of the chunk. + * The input documents for the BatchProcessDocuments method. */ - content?: string | null; + inputDocuments?: Schema$GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig; /** - * Page footers associated with the chunk. + * Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. */ - pageFooters?: Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkPageFooter[]; + labels?: {[key: string]: string} | null; /** - * Page headers associated with the chunk. + * The overall output config for batch process. */ - pageHeaders?: Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkPageHeader[]; + outputConfig?: Schema$GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchOutputConfig; /** - * Page span of the chunk. + * Inference-time options for the process API */ - pageSpan?: Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkPageSpan; + processOptions?: Schema$GoogleCloudDocumentaiV1beta3ProcessOptions; /** - * Unused. + * Whether human review should be skipped for this request. Default to `false`. */ - sourceBlockIds?: string[] | null; + skipHumanReview?: boolean | null; } /** - * The chunk field in the chunk. A chunk field could be one of the various types (e.g. image, table) supported. + * The message for input config in batch process. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkField { + export interface Schema$GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchInputConfig { /** - * The image chunk field in the chunk. + * The Cloud Storage location as the source of the document. */ - imageChunkField?: Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkImageChunkField; + gcsSource?: string | null; /** - * The table chunk field in the chunk. + * An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) of the input. If the input is a raw document, refer to [supported file types](https://cloud.google.com/document-ai/docs/file-types) for the list of media types. If the input is a Document, the type should be `application/json`. */ - tableChunkField?: Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkTableChunkField; + mimeType?: string | null; } /** - * Represents the page footer associated with the chunk. + * The output configuration in the BatchProcessDocuments method. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkPageFooter { - /** - * Page span of the footer. - */ - pageSpan?: Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkPageSpan; + export interface Schema$GoogleCloudDocumentaiV1beta3BatchProcessRequestBatchOutputConfig { /** - * Footer in text format. + * The output Cloud Storage directory to put the processed documents. */ - text?: string | null; + gcsDestination?: string | null; } /** - * Represents the page header associated with the chunk. + * Response message for BatchProcessDocuments. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkPageHeader { - /** - * Page span of the header. - */ - pageSpan?: Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkPageSpan; - /** - * Header in text format. - */ - text?: string | null; - } + export interface Schema$GoogleCloudDocumentaiV1beta3BatchProcessResponse {} /** - * Represents where the chunk starts and ends in the document. + * A bounding polygon for the detected image annotation. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkPageSpan { + export interface Schema$GoogleCloudDocumentaiV1beta3BoundingPoly { /** - * Page where chunk ends in the document. + * The bounding polygon normalized vertices. */ - pageEnd?: number | null; + normalizedVertices?: Schema$GoogleCloudDocumentaiV1beta3NormalizedVertex[]; /** - * Page where chunk starts in the document. + * The bounding polygon vertices. */ - pageStart?: number | null; + vertices?: Schema$GoogleCloudDocumentaiV1beta3Vertex[]; } /** - * The image chunk field in the chunk. + * The common metadata for long running operations. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkImageChunkField { + export interface Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata { /** - * Annotation of the image chunk field. + * The creation time of the operation. */ - annotations?: Schema$GoogleCloudDocumentaiV1beta3DocumentAnnotations; + createTime?: string | null; /** - * Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. + * A related resource to this operation. */ - blobAssetId?: string | null; + resource?: string | null; /** - * Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + * The state of the operation. */ - dataUri?: string | null; + state?: string | null; /** - * Optional. Google Cloud Storage uri of the image. + * A message providing more details about the current state of processing. */ - gcsUri?: string | null; - } - /** - * The table chunk field in the chunk. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkTableChunkField { + stateMessage?: string | null; /** - * Annotation of the table chunk field. + * The last update time of the operation. */ - annotations?: Schema$GoogleCloudDocumentaiV1beta3DocumentAnnotations; + updateTime?: string | null; } /** - * Represents the parsed layout of a document as a collection of blocks that the document is divided into. + * A singleton resource under a Processor which configures a collection of documents. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayout { + export interface Schema$GoogleCloudDocumentaiV1beta3Dataset { /** - * List of blocks in the document. + * Optional. Deprecated. Warehouse-based dataset configuration is not supported. */ - blocks?: Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlock[]; - } - /** - * Represents a block. A block could be one of the various types (text, table, list) supported. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlock { + documentWarehouseConfig?: Schema$GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig; /** - * ID of the block. + * Optional. User-managed Cloud Storage dataset configuration. Use this configuration if the dataset documents are stored under a user-managed Cloud Storage location. */ - blockId?: string | null; + gcsManagedConfig?: Schema$GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig; /** - * Identifies the bounding box for the block. + * Dataset resource name. Format: `projects/{project\}/locations/{location\}/processors/{processor\}/dataset` */ - boundingBox?: Schema$GoogleCloudDocumentaiV1beta3BoundingPoly; + name?: string | null; /** - * Block consisting of image content. + * Output only. Reserved for future use. */ - imageBlock?: Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutImageBlock; + satisfiesPzi?: boolean | null; /** - * Block consisting of list content/structure. + * Output only. Reserved for future use. */ - listBlock?: Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock; + satisfiesPzs?: boolean | null; /** - * Page span of the block. + * Optional. A lightweight indexing source with low latency and high reliability, but lacking advanced features like CMEK and content-based search. */ - pageSpan?: Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan; + spannerIndexingConfig?: Schema$GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig; /** - * Block consisting of table content/structure. + * Required. State of the dataset. Ignored when updating dataset. */ - tableBlock?: Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock; + state?: string | null; /** - * Block consisting of text content. + * Optional. Unmanaged dataset configuration. Use this configuration if the dataset documents are managed by the document service internally (not user-managed). */ - textBlock?: Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock; + unmanagedDatasetConfig?: Schema$GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig; } /** - * Represents an image type block. + * Configuration specific to the Document AI Warehouse-based implementation. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutImageBlock { + export interface Schema$GoogleCloudDocumentaiV1beta3DatasetDocumentWarehouseConfig { /** - * Annotation of the image block. + * Output only. The collection in Document AI Warehouse associated with the dataset. */ - annotations?: Schema$GoogleCloudDocumentaiV1beta3DocumentAnnotations; + collection?: string | null; /** - * Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. + * Output only. The schema in Document AI Warehouse associated with the dataset. */ - blobAssetId?: string | null; + schema?: string | null; + } + /** + * Configuration specific to the Cloud Storage-based implementation. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DatasetGCSManagedConfig { /** - * Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + * Required. The Cloud Storage URI (a directory) where the documents belonging to the dataset must be stored. */ - dataUri?: string | null; + gcsPrefix?: Schema$GoogleCloudDocumentaiV1beta3GcsPrefix; + } + /** + * Dataset Schema. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DatasetSchema { /** - * Optional. Google Cloud Storage uri of the image. + * Optional. Schema of the dataset. */ - gcsUri?: string | null; + documentSchema?: Schema$GoogleCloudDocumentaiV1beta3DocumentSchema; /** - * Text extracted from the image using OCR or alt text describing the image. + * Dataset schema resource name. Format: `projects/{project\}/locations/{location\}/processors/{processor\}/dataset/datasetSchema` */ - imageText?: string | null; + name?: string | null; /** - * Mime type of the image. An IANA published [media type (MIME type)] (https://www.iana.org/assignments/media-types/media-types.xhtml). + * Output only. Reserved for future use. */ - mimeType?: string | null; + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; } /** - * Represents a list type block. + * Configuration specific to spanner-based indexing. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock { - /** - * List entries that constitute a list block. - */ - listEntries?: Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry[]; + export interface Schema$GoogleCloudDocumentaiV1beta3DatasetSpannerIndexingConfig {} + /** + * Configuration specific to an unmanaged dataset. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DatasetUnmanagedDatasetConfig {} + /** + * The long-running operation metadata for the DeleteProcessor method. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DeleteProcessorMetadata { /** - * Type of the list_entries (if exist). Available options are `ordered` and `unordered`. + * The basic metadata of the long-running operation. */ - type?: string | null; + commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; } /** - * Represents an entry in the list. + * The long-running operation metadata for the DeleteProcessorVersion method. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry { + export interface Schema$GoogleCloudDocumentaiV1beta3DeleteProcessorVersionMetadata { /** - * A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks. + * The basic metadata of the long-running operation. */ - blocks?: Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlock[]; + commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; } /** - * Represents where the block starts and ends in the document. + * The long-running operation metadata for the DeployProcessorVersion method. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan { + export interface Schema$GoogleCloudDocumentaiV1beta3DeployProcessorVersionMetadata { /** - * Page where block ends in the document. + * The basic metadata of the long-running operation. */ - pageEnd?: number | null; + commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; + } + /** + * Request message for the DeployProcessorVersion method. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DeployProcessorVersionRequest {} + /** + * Response message for the DeployProcessorVersion method. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DeployProcessorVersionResponse {} + /** + * The long-running operation metadata for the DisableProcessor method. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DisableProcessorMetadata { /** - * Page where block starts in the document. + * The basic metadata of the long-running operation. */ - pageStart?: number | null; + commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; } /** - * Represents a table type block. + * Request message for the DisableProcessor method. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock { + export interface Schema$GoogleCloudDocumentaiV1beta3DisableProcessorRequest {} + /** + * Response message for the DisableProcessor method. Intentionally empty proto for adding fields in future. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DisableProcessorResponse {} + /** + * Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3Document { /** - * Annotation of the table block. + * Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, e.g. image bytes, such that it can be referenced by other fields in the document via asset id. */ - annotations?: Schema$GoogleCloudDocumentaiV1beta3DocumentAnnotations; + blobAssets?: Schema$GoogleCloudDocumentaiV1beta3DocumentBlobAsset[]; /** - * Body rows containing main table content. + * Document chunked based on chunking config. */ - bodyRows?: Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow[]; + chunkedDocument?: Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocument; /** - * Table caption/title. + * Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. */ - caption?: string | null; + content?: string | null; /** - * Header rows at the top of the table. + * Optional. An internal identifier for document. Should be loggable (no PII). */ - headerRows?: Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow[]; - } - /** - * Represents a cell in a table row. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell { + docid?: string | null; /** - * A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks. + * Parsed layout of the document. */ - blocks?: Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlock[]; + documentLayout?: Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayout; /** - * How many columns this cell spans. + * A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. */ - colSpan?: number | null; + entities?: Schema$GoogleCloudDocumentaiV1beta3DocumentEntity[]; /** - * How many rows this cell spans. + * The entity revision id that `document.entities` field is based on. If this field is set and `entities_revisions` is not empty, the entities in `document.entities` field are the entities in the entity revision with this id and `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision. */ - rowSpan?: number | null; - } - /** - * Represents a row in a table. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow { - /** - * A table row is a list of table cells. - */ - cells?: Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell[]; - } - /** - * Represents a text type block. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock { - /** - * Annotation of the text block. - */ - annotations?: Schema$GoogleCloudDocumentaiV1beta3DocumentAnnotations; - /** - * A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks. - */ - blocks?: Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlock[]; - /** - * Text content stored in the block. - */ - text?: string | null; + entitiesRevisionId?: string | null; /** - * Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`. + * A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing. */ - type?: string | null; - } - /** - * Entity revision. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentEntitiesRevision { + entitiesRevisions?: Schema$GoogleCloudDocumentaiV1beta3DocumentEntitiesRevision[]; /** - * The entities in this revision. + * Placeholder. Relationship among Document.entities. */ - entities?: Schema$GoogleCloudDocumentaiV1beta3DocumentEntity[]; + entityRelations?: Schema$GoogleCloudDocumentaiV1beta3DocumentEntityRelation[]; /** - * The entity validation output for this revision. + * The entity validation output for the document. This is the validation output for `document.entities` field. */ entityValidationOutput?: Schema$GoogleCloudDocumentaiV1beta3DocumentEntityValidationOutput; /** - * The revision id. + * Any error that occurred while processing this document. */ - revisionId?: string | null; - } - /** - * An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentEntity { + error?: Schema$GoogleRpcStatus; /** - * Optional. Confidence of detected Schema entity. Range `[0, 1]`. + * An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). */ - confidence?: number | null; + mimeType?: string | null; /** - * Optional. Canonical id. This will be a unique value in the entity list for this document. + * Visual page layout for the Document. */ - id?: string | null; + pages?: Schema$GoogleCloudDocumentaiV1beta3DocumentPage[]; /** - * Optional. Deprecated. Use `id` field instead. + * Placeholder. Revision history of this document. */ - mentionId?: string | null; + revisions?: Schema$GoogleCloudDocumentaiV1beta3DocumentRevision[]; /** - * Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`. + * Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified. */ - mentionText?: string | null; + shardInfo?: Schema$GoogleCloudDocumentaiV1beta3DocumentShardInfo; /** - * Optional. Specifies how the entity's value is obtained. + * Optional. UTF-8 encoded text in reading order from the document. */ - method?: string | null; + text?: string | null; /** - * Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types. + * Placeholder. A list of text corrections made to Document.text. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap with each other. */ - normalizedValue?: Schema$GoogleCloudDocumentaiV1beta3DocumentEntityNormalizedValue; + textChanges?: Schema$GoogleCloudDocumentaiV1beta3DocumentTextChange[]; /** - * Optional. Represents the provenance of this entity wrt. the location on the page where it was found. + * Styles for the Document.text. */ - pageAnchor?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageAnchor; + textStyles?: Schema$GoogleCloudDocumentaiV1beta3DocumentStyle[]; /** - * Optional. Entities can be nested to form a hierarchical data structure representing the content in the document. + * Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. For more information, refer to [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris). */ - properties?: Schema$GoogleCloudDocumentaiV1beta3DocumentEntity[]; + uri?: string | null; + } + /** + * Represents the annotation of a block or a chunk. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentAnnotations { /** - * Optional. The history of this annotation. + * The description of the content with this annotation. */ - provenance?: Schema$GoogleCloudDocumentaiV1beta3DocumentProvenance; + description?: string | null; + } + /** + * Represents a blob asset. It's used to store the content of the inline blob in this document, e.g. image bytes, such that it can be referenced by other fields in the document via asset id. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentBlobAsset { /** - * Optional. Whether the entity will be redacted for de-identification purposes. + * Optional. The id of the blob asset. */ - redacted?: boolean | null; + assetId?: string | null; /** - * Optional. Provenance of the entity. Text anchor indexing into the Document.text. + * Optional. The content of the blob asset, e.g. image bytes. */ - textAnchor?: Schema$GoogleCloudDocumentaiV1beta3DocumentTextAnchor; + content?: string | null; /** - * Required. Entity type from a schema e.g. `Address`. + * The mime type of the blob asset. An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). */ - type?: string | null; + mimeType?: string | null; } /** - * Parsed and normalized entity value. + * Represents the chunks that the document is divided into. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentEntityNormalizedValue { - /** - * Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto - */ - addressValue?: Schema$GoogleTypePostalAddress; + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocument { /** - * Boolean value. Can be used for entities with binary values, or for checkboxes. + * List of chunks. */ - booleanValue?: boolean | null; + chunks?: Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunk[]; + } + /** + * Represents a chunk. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunk { /** - * DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto + * Chunk fields inside this chunk. */ - datetimeValue?: Schema$GoogleTypeDateTime; + chunkFields?: Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkField[]; /** - * Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto + * ID of the chunk. */ - dateValue?: Schema$GoogleTypeDate; + chunkId?: string | null; /** - * Float value. + * Text content of the chunk. */ - floatValue?: number | null; + content?: string | null; /** - * Integer value. + * Page footers associated with the chunk. */ - integerValue?: number | null; + pageFooters?: Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkPageFooter[]; /** - * Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto + * Page headers associated with the chunk. */ - moneyValue?: Schema$GoogleTypeMoney; + pageHeaders?: Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkPageHeader[]; /** - * A signature - a graphical representation of a person's name, often used to sign a document. + * Page span of the chunk. */ - signatureValue?: boolean | null; + pageSpan?: Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkPageSpan; /** - * Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. + * Unused. */ - text?: string | null; + sourceBlockIds?: string[] | null; } /** - * Relationship between Entities. + * The chunk field in the chunk. A chunk field could be one of the various types (e.g. image, table) supported. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentEntityRelation { - /** - * Object entity id. - */ - objectId?: string | null; + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkField { /** - * Relationship description. + * The image chunk field in the chunk. */ - relation?: string | null; + imageChunkField?: Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkImageChunkField; /** - * Subject entity id. + * The table chunk field in the chunk. */ - subjectId?: string | null; + tableChunkField?: Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkTableChunkField; } /** - * The output of the validation given the document and the validation rules. + * Represents the page footer associated with the chunk. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentEntityValidationOutput { + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkPageFooter { /** - * The overall result of the validation, true if all applicable rules are valid. + * Page span of the footer. */ - passAllRules?: boolean | null; + pageSpan?: Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkPageSpan; /** - * The result of each validation rule. + * Footer in text format. */ - validationResults?: Schema$GoogleCloudDocumentaiV1beta3DocumentEntityValidationOutputValidationResult[]; + text?: string | null; } /** - * Validation result for a single validation rule. + * Represents the page header associated with the chunk. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentEntityValidationOutputValidationResult { + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkPageHeader { /** - * The description of the validation rule. + * Page span of the header. */ - ruleDescription?: string | null; + pageSpan?: Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkPageSpan; /** - * The name of the validation rule. + * Header in text format. */ - ruleName?: string | null; + text?: string | null; + } + /** + * Represents where the chunk starts and ends in the document. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkChunkPageSpan { /** - * The detailed information of the running the validation process using the entity from the document based on the validation rule. + * Page where chunk ends in the document. */ - validationDetails?: string | null; + pageEnd?: number | null; /** - * The result of the validation rule. + * Page where chunk starts in the document. */ - validationResultType?: string | null; + pageStart?: number | null; } /** - * Document Identifier. + * The image chunk field in the chunk. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentId { + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkImageChunkField { /** - * A document id within user-managed Cloud Storage. + * Annotation of the image chunk field. */ - gcsManagedDocId?: Schema$GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId; + annotations?: Schema$GoogleCloudDocumentaiV1beta3DocumentAnnotations; /** - * Points to a specific revision of the document if set. + * Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. */ - revisionRef?: Schema$GoogleCloudDocumentaiV1beta3RevisionRef; + blobAssetId?: string | null; /** - * A document id within unmanaged dataset. + * Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, */ - unmanagedDocId?: Schema$GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId; + dataUri?: string | null; + /** + * Optional. Google Cloud Storage uri of the image. + */ + gcsUri?: string | null; } /** - * Identifies a document uniquely within the scope of a dataset in the user-managed Cloud Storage option. + * The table chunk field in the chunk. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId { - /** - * Id of the document (indexed) managed by Content Warehouse. - */ - cwDocId?: string | null; + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentChunkedDocumentChunkTableChunkField { /** - * Required. The Cloud Storage URI where the actual document is stored. + * Annotation of the table chunk field. */ - gcsUri?: string | null; + annotations?: Schema$GoogleCloudDocumentaiV1beta3DocumentAnnotations; } /** - * Identifies a document uniquely within the scope of a dataset in unmanaged option. + * Represents the parsed layout of a document as a collection of blocks that the document is divided into. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId { + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayout { /** - * Required. The id of the document. + * List of blocks in the document. */ - docId?: string | null; + blocks?: Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlock[]; } /** - * Metadata about a document. + * Represents a block. A block could be one of the various types (text, table, list) supported. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentMetadata { + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlock { /** - * Type of the dataset split to which the document belongs. + * ID of the block. */ - datasetType?: string | null; + blockId?: string | null; /** - * The display name of the document. + * Identifies the bounding box for the block. */ - displayName?: string | null; + boundingBox?: Schema$GoogleCloudDocumentaiV1beta3BoundingPoly; /** - * Document identifier. + * Block consisting of image content. */ - documentId?: Schema$GoogleCloudDocumentaiV1beta3DocumentId; + imageBlock?: Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutImageBlock; /** - * Labeling state of the document. + * Block consisting of list content/structure. */ - labelingState?: string | null; + listBlock?: Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock; /** - * Number of pages in the document. + * Page span of the block. */ - pageCount?: number | null; - } - /** - * Config that controls the output of documents. All documents will be written as a JSON file. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentOutputConfig { + pageSpan?: Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan; /** - * Output config to write the results to Cloud Storage. + * Block consisting of table content/structure. */ - gcsOutputConfig?: Schema$GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfig; + tableBlock?: Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock; + /** + * Block consisting of text content. + */ + textBlock?: Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock; } /** - * The configuration used when outputting documents. + * Represents an image type block. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfig { + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutImageBlock { /** - * Specifies which fields to include in the output documents. Only supports top level document and pages field so it must be in the form of `{document_field_name\}` or `pages.{page_field_name\}`. + * Annotation of the image block. */ - fieldMask?: string | null; + annotations?: Schema$GoogleCloudDocumentaiV1beta3DocumentAnnotations; /** - * The Cloud Storage uri (a directory) of the output. + * Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. + */ + blobAssetId?: string | null; + /** + * Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + */ + dataUri?: string | null; + /** + * Optional. Google Cloud Storage uri of the image. */ gcsUri?: string | null; /** - * Specifies the sharding config for the output document. + * Text extracted from the image using OCR or alt text describing the image. */ - shardingConfig?: Schema$GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfigShardingConfig; + imageText?: string | null; + /** + * Mime type of the image. An IANA published [media type (MIME type)] (https://www.iana.org/assignments/media-types/media-types.xhtml). + */ + mimeType?: string | null; } /** - * The sharding config for the output document. + * Represents a list type block. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfigShardingConfig { + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock { /** - * The number of overlapping pages between consecutive shards. + * List entries that constitute a list block. */ - pagesOverlap?: number | null; + listEntries?: Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry[]; /** - * The number of pages per shard. + * Type of the list_entries (if exist). Available options are `ordered` and `unordered`. */ - pagesPerShard?: number | null; + type?: string | null; } /** - * A page in a Document. + * Represents an entry in the list. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPage { + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry { /** - * A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation. + * A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks. */ - blocks?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageBlock[]; + blocks?: Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlock[]; + } + /** + * Represents where the block starts and ends in the document. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan { /** - * A list of detected barcodes. + * Page where block ends in the document. */ - detectedBarcodes?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageDetectedBarcode[]; + pageEnd?: number | null; /** - * A list of detected languages together with confidence. + * Page where block starts in the document. */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage[]; + pageStart?: number | null; + } + /** + * Represents a table type block. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock { /** - * Physical dimension of the page. + * Annotation of the table block. */ - dimension?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageDimension; + annotations?: Schema$GoogleCloudDocumentaiV1beta3DocumentAnnotations; /** - * A list of visually detected form fields on the page. + * Body rows containing main table content. */ - formFields?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageFormField[]; + bodyRows?: Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow[]; /** - * Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned. + * Table caption/title. */ - image?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageImage; + caption?: string | null; /** - * Image quality scores. + * Header rows at the top of the table. */ - imageQualityScores?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageImageQualityScores; + headerRows?: Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow[]; + } + /** + * Represents a cell in a table row. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell { /** - * Layout for the page. + * A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks. */ - layout?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageLayout; + blocks?: Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlock[]; /** - * A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line. + * How many columns this cell spans. */ - lines?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageLine[]; + colSpan?: number | null; /** - * 1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing. + * How many rows this cell spans. */ - pageNumber?: number | null; + rowSpan?: number | null; + } + /** + * Represents a row in a table. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow { /** - * A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph. + * A table row is a list of table cells. */ - paragraphs?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageParagraph[]; + cells?: Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell[]; + } + /** + * Represents a text type block. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock { /** - * The history of this page. + * Annotation of the text block. */ - provenance?: Schema$GoogleCloudDocumentaiV1beta3DocumentProvenance; + annotations?: Schema$GoogleCloudDocumentaiV1beta3DocumentAnnotations; /** - * A list of visually detected symbols on the page. + * A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks. */ - symbols?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageSymbol[]; + blocks?: Schema$GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlock[]; /** - * A list of visually detected tables on the page. + * Text content stored in the block. */ - tables?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageTable[]; + text?: string | null; /** - * A list of visually detected tokens on the page. + * Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`. */ - tokens?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageToken[]; + type?: string | null; + } + /** + * Entity revision. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentEntitiesRevision { /** - * Transformation matrices that were applied to the original document image to produce Page.image. + * The entities in this revision. */ - transforms?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageMatrix[]; + entities?: Schema$GoogleCloudDocumentaiV1beta3DocumentEntity[]; /** - * A list of detected non-text visual elements e.g. checkbox, signature etc. on the page. + * The entity validation output for this revision. */ - visualElements?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageVisualElement[]; - } - /** - * Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageAnchor { + entityValidationOutput?: Schema$GoogleCloudDocumentaiV1beta3DocumentEntityValidationOutput; /** - * One or more references to visual page elements + * The revision id. */ - pageRefs?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageAnchorPageRef[]; + revisionId?: string | null; } /** - * Represents a weak reference to a page element within a document. + * An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageAnchorPageRef { + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentEntity { /** - * Optional. Identifies the bounding polygon of a layout element on the page. If `layout_type` is set, the bounding polygon must be exactly the same to the layout element it's referring to. + * Optional. Confidence of detected Schema entity. Range `[0, 1]`. */ - boundingPoly?: Schema$GoogleCloudDocumentaiV1beta3BoundingPoly; + confidence?: number | null; /** - * Optional. Confidence of detected page element, if applicable. Range `[0, 1]`. + * Optional. Canonical id. This will be a unique value in the entity list for this document. */ - confidence?: number | null; + id?: string | null; /** - * Optional. Deprecated. Use PageRef.bounding_poly instead. + * Optional. Deprecated. Use `id` field instead. */ - layoutId?: string | null; + mentionId?: string | null; /** - * Optional. The type of the layout element that is being referenced if any. + * Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`. */ - layoutType?: string | null; + mentionText?: string | null; /** - * Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See https://developers.google.com/protocol-buffers/docs/proto3#json. + * Optional. Specifies how the entity's value is obtained. */ - page?: string | null; - } - /** - * A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageBlock { + method?: string | null; /** - * A list of detected languages together with confidence. + * Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types. */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage[]; + normalizedValue?: Schema$GoogleCloudDocumentaiV1beta3DocumentEntityNormalizedValue; /** - * Layout for Block. + * Optional. Represents the provenance of this entity wrt. the location on the page where it was found. */ - layout?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageLayout; + pageAnchor?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageAnchor; /** - * The history of this annotation. + * Optional. Entities can be nested to form a hierarchical data structure representing the content in the document. */ - provenance?: Schema$GoogleCloudDocumentaiV1beta3DocumentProvenance; - } - /** - * A detected barcode. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageDetectedBarcode { + properties?: Schema$GoogleCloudDocumentaiV1beta3DocumentEntity[]; /** - * Detailed barcode information of the DetectedBarcode. + * Optional. The history of this annotation. */ - barcode?: Schema$GoogleCloudDocumentaiV1beta3Barcode; + provenance?: Schema$GoogleCloudDocumentaiV1beta3DocumentProvenance; /** - * Layout for DetectedBarcode. + * Optional. Whether the entity will be redacted for de-identification purposes. */ - layout?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageLayout; - } - /** - * Detected language for a structural component. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage { + redacted?: boolean | null; /** - * Confidence of detected language. Range `[0, 1]`. + * Optional. Provenance of the entity. Text anchor indexing into the Document.text. */ - confidence?: number | null; + textAnchor?: Schema$GoogleCloudDocumentaiV1beta3DocumentTextAnchor; /** - * The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`. + * Required. Entity type from a schema e.g. `Address`. */ - languageCode?: string | null; + type?: string | null; } /** - * Dimension for the page. + * Parsed and normalized entity value. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageDimension { + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentEntityNormalizedValue { /** - * Page height. + * Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto */ - height?: number | null; + addressValue?: Schema$GoogleTypePostalAddress; /** - * Dimension unit. + * Boolean value. Can be used for entities with binary values, or for checkboxes. */ - unit?: string | null; + booleanValue?: boolean | null; /** - * Page width. + * DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto */ - width?: number | null; - } - /** - * A form field detected on the page. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageFormField { - /** - * Created for Labeling UI to export key text. If corrections were made to the text identified by the `field_name.text_anchor`, this field will contain the correction. - */ - correctedKeyText?: string | null; - /** - * Created for Labeling UI to export value text. If corrections were made to the text identified by the `field_value.text_anchor`, this field will contain the correction. - */ - correctedValueText?: string | null; + datetimeValue?: Schema$GoogleTypeDateTime; /** - * Layout for the FormField name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc. + * Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto */ - fieldName?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageLayout; + dateValue?: Schema$GoogleTypeDate; /** - * Layout for the FormField value. + * Float value. */ - fieldValue?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageLayout; + floatValue?: number | null; /** - * A list of detected languages for name together with confidence. + * Integer value. */ - nameDetectedLanguages?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage[]; + integerValue?: number | null; /** - * The history of this annotation. + * Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto */ - provenance?: Schema$GoogleCloudDocumentaiV1beta3DocumentProvenance; + moneyValue?: Schema$GoogleTypeMoney; /** - * A list of detected languages for value together with confidence. + * A signature - a graphical representation of a person's name, often used to sign a document. */ - valueDetectedLanguages?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage[]; + signatureValue?: boolean | null; /** - * If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the `field_value` is normal text) - `unfilled_checkbox` - `filled_checkbox` + * Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. */ - valueType?: string | null; + text?: string | null; } /** - * Rendered image contents for this page. + * Relationship between Entities. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageImage { - /** - * Raw byte content of the image. - */ - content?: string | null; + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentEntityRelation { /** - * Height of the image in pixels. + * Object entity id. */ - height?: number | null; + objectId?: string | null; /** - * Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image. + * Relationship description. */ - mimeType?: string | null; + relation?: string | null; /** - * Width of the image in pixels. + * Subject entity id. */ - width?: number | null; + subjectId?: string | null; } /** - * Image quality scores for the page image. + * The output of the validation given the document and the validation rules. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageImageQualityScores { + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentEntityValidationOutput { /** - * A list of detected defects. + * The overall result of the validation, true if all applicable rules are valid. */ - detectedDefects?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageImageQualityScoresDetectedDefect[]; + passAllRules?: boolean | null; /** - * The overall quality score. Range `[0, 1]` where `1` is perfect quality. + * The result of each validation rule. */ - qualityScore?: number | null; + validationResults?: Schema$GoogleCloudDocumentaiV1beta3DocumentEntityValidationOutputValidationResult[]; } /** - * Image Quality Defects + * Validation result for a single validation rule. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageImageQualityScoresDetectedDefect { - /** - * Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists. - */ - confidence?: number | null; + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentEntityValidationOutputValidationResult { /** - * Name of the defect type. Supported values are: - `quality/defect_blurry` - `quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `quality/defect_text_too_small` - `quality/defect_document_cutoff` - `quality/defect_text_cutoff` - `quality/defect_glare` + * Optional. The name of the rule resource that is used for validation. Format: `projects/{project\}/locations/{location\}/rules/{rule\}` */ - type?: string | null; - } - /** - * Visual element describing a layout unit on a page. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageLayout { + rule?: string | null; /** - * The bounding polygon for the Layout. + * The description of the validation rule. */ - boundingPoly?: Schema$GoogleCloudDocumentaiV1beta3BoundingPoly; + ruleDescription?: string | null; /** - * Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`. + * The display name of the validation rule. */ - confidence?: number | null; + ruleName?: string | null; /** - * Detected orientation for the Layout. + * The detailed information of the running the validation process using the entity from the document based on the validation rule. */ - orientation?: string | null; + validationDetails?: string | null; /** - * Text anchor indexing into the Document.text. + * The result of the validation rule. */ - textAnchor?: Schema$GoogleCloudDocumentaiV1beta3DocumentTextAnchor; + validationResultType?: string | null; } /** - * A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc. + * Document Identifier. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageLine { + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentId { /** - * A list of detected languages together with confidence. + * A document id within user-managed Cloud Storage. */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage[]; + gcsManagedDocId?: Schema$GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId; /** - * Layout for Line. + * Points to a specific revision of the document if set. */ - layout?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageLayout; + revisionRef?: Schema$GoogleCloudDocumentaiV1beta3RevisionRef; /** - * The history of this annotation. + * A document id within unmanaged dataset. */ - provenance?: Schema$GoogleCloudDocumentaiV1beta3DocumentProvenance; + unmanagedDocId?: Schema$GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId; } /** - * Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation. + * Identifies a document uniquely within the scope of a dataset in the user-managed Cloud Storage option. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageMatrix { - /** - * Number of columns in the matrix. - */ - cols?: number | null; + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId { /** - * The matrix data. + * Id of the document (indexed) managed by Content Warehouse. */ - data?: string | null; + cwDocId?: string | null; /** - * Number of rows in the matrix. + * Required. The Cloud Storage URI where the actual document is stored. */ - rows?: number | null; + gcsUri?: string | null; + } + /** + * Identifies a document uniquely within the scope of a dataset in unmanaged option. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId { /** - * This encodes information about what data type the matrix uses. For example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of OpenCV primitive data types, please refer to https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html + * Required. The id of the document. */ - type?: number | null; + docId?: string | null; } /** - * A collection of lines that a human would perceive as a paragraph. + * Metadata about a document. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageParagraph { + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentMetadata { /** - * A list of detected languages together with confidence. + * Type of the dataset split to which the document belongs. */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage[]; + datasetType?: string | null; /** - * Layout for Paragraph. + * The display name of the document. */ - layout?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageLayout; + displayName?: string | null; /** - * The history of this annotation. + * Document identifier. */ - provenance?: Schema$GoogleCloudDocumentaiV1beta3DocumentProvenance; + documentId?: Schema$GoogleCloudDocumentaiV1beta3DocumentId; + /** + * Labeling state of the document. + */ + labelingState?: string | null; + /** + * Number of pages in the document. + */ + pageCount?: number | null; } /** - * A detected symbol. + * Config that controls the output of documents. All documents will be written as a JSON file. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageSymbol { - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage[]; + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentOutputConfig { /** - * Layout for Symbol. + * Output config to write the results to Cloud Storage. */ - layout?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageLayout; + gcsOutputConfig?: Schema$GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfig; } /** - * A table representation similar to HTML table structure. + * The configuration used when outputting documents. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageTable { + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfig { /** - * Body rows of the table. + * Specifies which fields to include in the output documents. Only supports top level document and pages field so it must be in the form of `{document_field_name\}` or `pages.{page_field_name\}`. */ - bodyRows?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageTableTableRow[]; + fieldMask?: string | null; /** - * A list of detected languages together with confidence. + * The Cloud Storage uri (a directory) of the output. */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage[]; + gcsUri?: string | null; /** - * Header rows of the table. + * Specifies the sharding config for the output document. */ - headerRows?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageTableTableRow[]; + shardingConfig?: Schema$GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfigShardingConfig; + } + /** + * The sharding config for the output document. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentOutputConfigGcsOutputConfigShardingConfig { /** - * Layout for Table. + * The number of overlapping pages between consecutive shards. */ - layout?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageLayout; + pagesOverlap?: number | null; /** - * The history of this table. + * The number of pages per shard. */ - provenance?: Schema$GoogleCloudDocumentaiV1beta3DocumentProvenance; + pagesPerShard?: number | null; } /** - * A cell representation inside the table. + * A page in a Document. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageTableTableCell { + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPage { /** - * How many columns this cell spans. + * A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation. */ - colSpan?: number | null; + blocks?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageBlock[]; /** - * A list of detected languages together with confidence. + * A list of detected barcodes. */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage[]; + detectedBarcodes?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageDetectedBarcode[]; /** - * Layout for TableCell. + * A list of detected languages together with confidence. */ - layout?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageLayout; + detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage[]; /** - * How many rows this cell spans. + * Physical dimension of the page. */ - rowSpan?: number | null; - } - /** - * A row of table cells. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageTableTableRow { + dimension?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageDimension; /** - * Cells that make up this row. + * A list of visually detected form fields on the page. */ - cells?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageTableTableCell[]; - } - /** - * A detected token. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageToken { + formFields?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageFormField[]; /** - * Detected break at the end of a Token. + * Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned. */ - detectedBreak?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageTokenDetectedBreak; + image?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageImage; /** - * A list of detected languages together with confidence. + * Image quality scores. */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage[]; + imageQualityScores?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageImageQualityScores; /** - * Layout for Token. + * Layout for the page. */ layout?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageLayout; /** - * The history of this annotation. + * A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line. */ - provenance?: Schema$GoogleCloudDocumentaiV1beta3DocumentProvenance; + lines?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageLine[]; /** - * Text style attributes. + * 1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing. */ - styleInfo?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageTokenStyleInfo; - } - /** - * Detected break at the end of a Token. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageTokenDetectedBreak { - /** - * Detected break type. - */ - type?: string | null; - } - /** - * Font and other text style attributes. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageTokenStyleInfo { - /** - * Color of the background. - */ - backgroundColor?: Schema$GoogleTypeColor; - /** - * Whether the text is bold (equivalent to font_weight is at least `700`). - */ - bold?: boolean | null; + pageNumber?: number | null; /** - * Font size in points (`1` point is `¹⁄₇₂` inches). + * A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph. */ - fontSize?: number | null; + paragraphs?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageParagraph[]; /** - * Name or style of the font. + * The history of this page. */ - fontType?: string | null; + provenance?: Schema$GoogleCloudDocumentaiV1beta3DocumentProvenance; /** - * TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). Normal is `400`, bold is `700`. + * A list of visually detected symbols on the page. */ - fontWeight?: number | null; + symbols?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageSymbol[]; /** - * Whether the text is handwritten. + * A list of visually detected tables on the page. */ - handwritten?: boolean | null; + tables?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageTable[]; /** - * Whether the text is italic. + * A list of visually detected tokens on the page. */ - italic?: boolean | null; + tokens?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageToken[]; /** - * Letter spacing in points. + * Transformation matrices that were applied to the original document image to produce Page.image. */ - letterSpacing?: number | null; + transforms?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageMatrix[]; /** - * Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ `72.0`. + * A list of detected non-text visual elements e.g. checkbox, signature etc. on the page. */ - pixelFontSize?: number | null; + visualElements?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageVisualElement[]; + } + /** + * Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageAnchor { /** - * Whether the text is in small caps. This feature is not supported yet. + * One or more references to visual page elements */ - smallcaps?: boolean | null; + pageRefs?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageAnchorPageRef[]; + } + /** + * Represents a weak reference to a page element within a document. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageAnchorPageRef { /** - * Whether the text is strikethrough. This feature is not supported yet. + * Optional. Identifies the bounding polygon of a layout element on the page. If `layout_type` is set, the bounding polygon must be exactly the same to the layout element it's referring to. */ - strikeout?: boolean | null; + boundingPoly?: Schema$GoogleCloudDocumentaiV1beta3BoundingPoly; /** - * Whether the text is a subscript. This feature is not supported yet. + * Optional. Confidence of detected page element, if applicable. Range `[0, 1]`. */ - subscript?: boolean | null; + confidence?: number | null; /** - * Whether the text is a superscript. This feature is not supported yet. + * Optional. Deprecated. Use PageRef.bounding_poly instead. */ - superscript?: boolean | null; + layoutId?: string | null; /** - * Color of the text. + * Optional. The type of the layout element that is being referenced if any. */ - textColor?: Schema$GoogleTypeColor; + layoutType?: string | null; /** - * Whether the text is underlined. + * Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See https://developers.google.com/protocol-buffers/docs/proto3#json. */ - underlined?: boolean | null; + page?: string | null; } /** - * Detected non-text visual elements e.g. checkbox, signature etc. on the page. + * A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageVisualElement { + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageBlock { /** * A list of detected languages together with confidence. */ detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage[]; /** - * Layout for VisualElement. + * Layout for Block. */ layout?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageLayout; /** - * Type of the VisualElement. + * The history of this annotation. */ - type?: string | null; + provenance?: Schema$GoogleCloudDocumentaiV1beta3DocumentProvenance; } /** - * Structure to identify provenance relationships between annotations in different revisions. + * A detected barcode. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentProvenance { + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageDetectedBarcode { /** - * The Id of this operation. Needs to be unique within the scope of the revision. + * Detailed barcode information of the DetectedBarcode. */ - id?: number | null; + barcode?: Schema$GoogleCloudDocumentaiV1beta3Barcode; /** - * References to the original elements that are replaced. + * Layout for DetectedBarcode. */ - parents?: Schema$GoogleCloudDocumentaiV1beta3DocumentProvenanceParent[]; + layout?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageLayout; + } + /** + * Detected language for a structural component. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage { /** - * The index of the revision that produced this element. + * Confidence of detected language. Range `[0, 1]`. */ - revision?: number | null; + confidence?: number | null; /** - * The type of provenance operation. + * The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`. */ - type?: string | null; + languageCode?: string | null; } /** - * The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. + * Dimension for the page. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentProvenanceParent { + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageDimension { /** - * The id of the parent provenance. + * Page height. */ - id?: number | null; + height?: number | null; /** - * The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. + * Dimension unit. */ - index?: number | null; + unit?: string | null; /** - * The index of the index into current revision's parent_ids list. + * Page width. */ - revision?: number | null; + width?: number | null; } /** - * Contains past or forward revisions of this document. + * A form field detected on the page. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentRevision { + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageFormField { /** - * If the change was made by a person specify the name or id of that person. + * Created for Labeling UI to export key text. If corrections were made to the text identified by the `field_name.text_anchor`, this field will contain the correction. */ - agent?: string | null; + correctedKeyText?: string | null; /** - * The time that the revision was created, internally generated by doc proto storage at the time of create. + * Created for Labeling UI to export value text. If corrections were made to the text identified by the `field_value.text_anchor`, this field will contain the correction. */ - createTime?: string | null; + correctedValueText?: string | null; /** - * Human Review information of this revision. + * Layout for the FormField name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc. */ - humanReview?: Schema$GoogleCloudDocumentaiV1beta3DocumentRevisionHumanReview; + fieldName?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageLayout; /** - * Id of the revision, internally generated by doc proto storage. Unique within the context of the document. + * Layout for the FormField value. */ - id?: string | null; + fieldValue?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageLayout; /** - * The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. + * A list of detected languages for name together with confidence. */ - parent?: number[] | null; + nameDetectedLanguages?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage[]; /** - * The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field. + * The history of this annotation. */ - parentIds?: string[] | null; + provenance?: Schema$GoogleCloudDocumentaiV1beta3DocumentProvenance; /** - * If the annotation was made by processor identify the processor by its resource name. + * A list of detected languages for value together with confidence. */ - processor?: string | null; + valueDetectedLanguages?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage[]; + /** + * If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the `field_value` is normal text) - `unfilled_checkbox` - `filled_checkbox` + */ + valueType?: string | null; } /** - * Human Review information of the document. + * Rendered image contents for this page. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentRevisionHumanReview { + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageImage { /** - * Human review state. e.g. `requested`, `succeeded`, `rejected`. + * Raw byte content of the image. */ - state?: string | null; + content?: string | null; /** - * A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`. + * Height of the image in pixels. */ - stateMessage?: string | null; + height?: number | null; + /** + * Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image. + */ + mimeType?: string | null; + /** + * Width of the image in pixels. + */ + width?: number | null; } /** - * The schema defines the output of the processed document by a processor. + * Image quality scores for the page image. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentSchema { + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageImageQualityScores { /** - * Description of the schema. + * A list of detected defects. */ - description?: string | null; + detectedDefects?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageImageQualityScoresDetectedDefect[]; /** - * Display name to show to users. + * The overall quality score. Range `[0, 1]` where `1` is perfect quality. */ - displayName?: string | null; + qualityScore?: number | null; + } + /** + * Image Quality Defects + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageImageQualityScoresDetectedDefect { /** - * Entity types of the schema. + * Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists. */ - entityTypes?: Schema$GoogleCloudDocumentaiV1beta3DocumentSchemaEntityType[]; + confidence?: number | null; /** - * Metadata of the schema. + * Name of the defect type. Supported values are: - `quality/defect_blurry` - `quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `quality/defect_text_too_small` - `quality/defect_document_cutoff` - `quality/defect_text_cutoff` - `quality/defect_glare` */ - metadata?: Schema$GoogleCloudDocumentaiV1beta3DocumentSchemaMetadata; + type?: string | null; } /** - * EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. + * Visual element describing a layout unit on a page. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentSchemaEntityType { + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageLayout { /** - * The entity type that this type is derived from. For now, one and only one should be set. + * The bounding polygon for the Layout. */ - baseTypes?: string[] | null; + boundingPoly?: Schema$GoogleCloudDocumentaiV1beta3BoundingPoly; /** - * The description of the entity type. Could be used to provide more information about the entity type for model calls. + * Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`. */ - description?: string | null; + confidence?: number | null; /** - * User defined name for the type. + * Detected orientation for the Layout. */ - displayName?: string | null; + orientation?: string | null; /** - * Metadata for the entity type. + * Text anchor indexing into the Document.text. */ - entityTypeMetadata?: Schema$GoogleCloudDocumentaiV1beta3EntityTypeMetadata; + textAnchor?: Schema$GoogleCloudDocumentaiV1beta3DocumentTextAnchor; + } + /** + * A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageLine { /** - * If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is \>10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file. + * A list of detected languages together with confidence. */ - enumValues?: Schema$GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues; + detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage[]; /** - * Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + * Layout for Line. */ - name?: string | null; + layout?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageLayout; /** - * Description the nested structure, or composition of an entity. + * The history of this annotation. */ - properties?: Schema$GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeProperty[]; + provenance?: Schema$GoogleCloudDocumentaiV1beta3DocumentProvenance; } /** - * Defines the a list of enum values. + * Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues { - /** - * The individual values that this enum values type can include. - */ - values?: string[] | null; - } - /** - * Defines properties that can be part of the entity type. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeProperty { - /** - * The description of the property. Could be used to provide more information about the property for model calls. - */ - description?: string | null; - /** - * User defined name for the property. - */ - displayName?: string | null; - /** - * Specifies how the entity's value is obtained. - */ - method?: string | null; + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageMatrix { /** - * The name of the property. Follows the same guidelines as the EntityType name. + * Number of columns in the matrix. */ - name?: string | null; + cols?: number | null; /** - * Occurrence type limits the number of instances an entity type appears in the document. + * The matrix data. */ - occurrenceType?: string | null; + data?: string | null; /** - * Any additional metadata about the property can be added here. + * Number of rows in the matrix. */ - propertyMetadata?: Schema$GoogleCloudDocumentaiV1beta3PropertyMetadata; + rows?: number | null; /** - * A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field. + * This encodes information about what data type the matrix uses. For example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of OpenCV primitive data types, please refer to https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html */ - valueType?: string | null; + type?: number | null; } /** - * Metadata for global schema behavior. + * A collection of lines that a human would perceive as a paragraph. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentSchemaMetadata { - /** - * If true, on a given page, there can be multiple `document` annotations covering it. - */ - documentAllowMultipleLabels?: boolean | null; + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageParagraph { /** - * If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification). + * A list of detected languages together with confidence. */ - documentSplitter?: boolean | null; + detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage[]; /** - * If set, all the nested entities must be prefixed with the parents. + * Layout for Paragraph. */ - prefixedNamingOnProperties?: boolean | null; + layout?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageLayout; /** - * If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked. + * The history of this annotation. */ - skipNamingValidation?: boolean | null; + provenance?: Schema$GoogleCloudDocumentaiV1beta3DocumentProvenance; } /** - * For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is. + * A detected symbol. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentShardInfo { - /** - * Total number of shards. - */ - shardCount?: string | null; + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageSymbol { /** - * The 0-based index of this shard. + * A list of detected languages together with confidence. */ - shardIndex?: string | null; + detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage[]; /** - * The index of the first character in Document.text in the overall document global text. + * Layout for Symbol. */ - textOffset?: string | null; + layout?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageLayout; } /** - * Annotation for common text style attributes. This adheres to CSS conventions as much as possible. + * A table representation similar to HTML table structure. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentStyle { - /** - * Text background color. - */ - backgroundColor?: Schema$GoogleTypeColor; + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageTable { /** - * Text color. + * Body rows of the table. */ - color?: Schema$GoogleTypeColor; + bodyRows?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageTableTableRow[]; /** - * Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/cssref/pr_font_font-family.asp + * A list of detected languages together with confidence. */ - fontFamily?: string | null; + detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage[]; /** - * Font size. + * Header rows of the table. */ - fontSize?: Schema$GoogleCloudDocumentaiV1beta3DocumentStyleFontSize; + headerRows?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageTableTableRow[]; /** - * [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`. + * Layout for Table. */ - fontWeight?: string | null; + layout?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageLayout; /** - * Text anchor indexing into the Document.text. + * The history of this table. */ - textAnchor?: Schema$GoogleCloudDocumentaiV1beta3DocumentTextAnchor; + provenance?: Schema$GoogleCloudDocumentaiV1beta3DocumentProvenance; + } + /** + * A cell representation inside the table. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageTableTableCell { /** - * [Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard. + * How many columns this cell spans. */ - textDecoration?: string | null; + colSpan?: number | null; /** - * [Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`. + * A list of detected languages together with confidence. */ - textStyle?: string | null; - } - /** - * Font size with unit. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentStyleFontSize { + detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage[]; /** - * Font size for the text. + * Layout for TableCell. */ - size?: number | null; + layout?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageLayout; /** - * Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`). + * How many rows this cell spans. */ - unit?: string | null; + rowSpan?: number | null; } /** - * Text reference indexing into the Document.text. + * A row of table cells. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentTextAnchor { - /** - * Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields. - */ - content?: string | null; + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageTableTableRow { /** - * The text segments from the Document.text. + * Cells that make up this row. */ - textSegments?: Schema$GoogleCloudDocumentaiV1beta3DocumentTextAnchorTextSegment[]; + cells?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageTableTableCell[]; } /** - * A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset + * A detected token. */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentTextAnchorTextSegment { + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageToken { /** - * TextSegment half open end UTF-8 char index in the Document.text. + * Detected break at the end of a Token. */ - endIndex?: string | null; + detectedBreak?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageTokenDetectedBreak; /** - * TextSegment start UTF-8 char index in the Document.text. + * A list of detected languages together with confidence. */ - startIndex?: string | null; - } - /** - * This message is used for text changes aka. OCR corrections. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3DocumentTextChange { + detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage[]; /** - * The text that replaces the text identified in the `text_anchor`. + * Layout for Token. */ - changedText?: string | null; + layout?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageLayout; /** * The history of this annotation. */ - provenance?: Schema$GoogleCloudDocumentaiV1beta3DocumentProvenance[]; + provenance?: Schema$GoogleCloudDocumentaiV1beta3DocumentProvenance; /** - * Provenance of the correction. Text anchor indexing into the Document.text. There can only be a single `TextAnchor.text_segments` element. If the start and end index of the text segment are the same, the text change is inserted before that index. + * Text style attributes. */ - textAnchor?: Schema$GoogleCloudDocumentaiV1beta3DocumentTextAnchor; + styleInfo?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageTokenStyleInfo; } /** - * The long-running operation metadata for the EnableProcessor method. + * Detected break at the end of a Token. */ - export interface Schema$GoogleCloudDocumentaiV1beta3EnableProcessorMetadata { + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageTokenDetectedBreak { /** - * The basic metadata of the long-running operation. + * Detected break type. */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; + type?: string | null; } /** - * Request message for the EnableProcessor method. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3EnableProcessorRequest {} - /** - * Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3EnableProcessorResponse {} - /** - * Metadata about an entity type. + * Font and other text style attributes. */ - export interface Schema$GoogleCloudDocumentaiV1beta3EntityTypeMetadata { + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageTokenStyleInfo { /** - * Whether the entity type should be considered inactive. + * Color of the background. */ - inactive?: boolean | null; - } - /** - * Metadata of the EvaluateProcessorVersion method. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata { + backgroundColor?: Schema$GoogleTypeColor; /** - * The basic metadata of the long-running operation. + * Whether the text is bold (equivalent to font_weight is at least `700`). */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; - } - /** - * Evaluates the given ProcessorVersion against the supplied documents. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionRequest { + bold?: boolean | null; /** - * Optional. The documents used in the evaluation. If unspecified, use the processor's dataset as evaluation input. + * Font size in points (`1` point is `¹⁄₇₂` inches). */ - evaluationDocuments?: Schema$GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig; - } - /** - * Response of the EvaluateProcessorVersion method. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse { + fontSize?: number | null; /** - * The resource name of the created evaluation. + * Name or style of the font. */ - evaluation?: string | null; - } - /** - * An evaluation of a ProcessorVersion's performance. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3Evaluation { + fontType?: string | null; /** - * Metrics for all the entities in aggregate. + * TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). Normal is `400`, bold is `700`. */ - allEntitiesMetrics?: Schema$GoogleCloudDocumentaiV1beta3EvaluationMultiConfidenceMetrics; + fontWeight?: number | null; /** - * The time that the evaluation was created. + * Whether the text is handwritten. */ - createTime?: string | null; + handwritten?: boolean | null; /** - * Counters for the documents used in the evaluation. + * Whether the text is italic. */ - documentCounters?: Schema$GoogleCloudDocumentaiV1beta3EvaluationCounters; + italic?: boolean | null; /** - * Metrics across confidence levels, for different entities. + * Letter spacing in points. */ - entityMetrics?: { - [ - key: string - ]: Schema$GoogleCloudDocumentaiV1beta3EvaluationMultiConfidenceMetrics; - } | null; + letterSpacing?: number | null; /** - * The KMS key name used for encryption. + * Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ `72.0`. */ - kmsKeyName?: string | null; + pixelFontSize?: number | null; /** - * The KMS key version with which data is encrypted. + * Whether the text is in small caps. This feature is not supported yet. */ - kmsKeyVersionName?: string | null; + smallcaps?: boolean | null; /** - * The resource name of the evaluation. Format: `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processor_version\}/evaluations/{evaluation\}` + * Whether the text is strikethrough. This feature is not supported yet. */ - name?: string | null; - } - /** - * Evaluations metrics, at a specific confidence level. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3EvaluationConfidenceLevelMetrics { - /** - * The confidence level. - */ - confidenceLevel?: number | null; - /** - * The metrics at the specific confidence level. - */ - metrics?: Schema$GoogleCloudDocumentaiV1beta3EvaluationMetrics; - } - /** - * Evaluation counters for the documents that were used. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3EvaluationCounters { + strikeout?: boolean | null; /** - * How many documents were used in the evaluation. + * Whether the text is a subscript. This feature is not supported yet. */ - evaluatedDocumentsCount?: number | null; + subscript?: boolean | null; /** - * How many documents were not included in the evaluation as Document AI failed to process them. + * Whether the text is a superscript. This feature is not supported yet. */ - failedDocumentsCount?: number | null; + superscript?: boolean | null; /** - * How many documents were sent for evaluation. + * Color of the text. */ - inputDocumentsCount?: number | null; + textColor?: Schema$GoogleTypeColor; /** - * How many documents were not included in the evaluation as they didn't pass validation. + * Whether the text is underlined. */ - invalidDocumentsCount?: number | null; + underlined?: boolean | null; } /** - * Evaluation metrics, either in aggregate or about a specific entity. + * Detected non-text visual elements e.g. checkbox, signature etc. on the page. */ - export interface Schema$GoogleCloudDocumentaiV1beta3EvaluationMetrics { - /** - * The calculated f1 score. - */ - f1Score?: number | null; + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentPageVisualElement { /** - * The amount of false negatives. + * A list of detected languages together with confidence. */ - falseNegativesCount?: number | null; + detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageDetectedLanguage[]; /** - * The amount of false positives. + * Layout for VisualElement. */ - falsePositivesCount?: number | null; + layout?: Schema$GoogleCloudDocumentaiV1beta3DocumentPageLayout; /** - * The amount of documents with a ground truth occurrence. + * Type of the VisualElement. */ - groundTruthDocumentCount?: number | null; + type?: string | null; + } + /** + * Structure to identify provenance relationships between annotations in different revisions. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentProvenance { /** - * The amount of occurrences in ground truth documents. + * The Id of this operation. Needs to be unique within the scope of the revision. */ - groundTruthOccurrencesCount?: number | null; + id?: number | null; /** - * The calculated precision. + * References to the original elements that are replaced. */ - precision?: number | null; + parents?: Schema$GoogleCloudDocumentaiV1beta3DocumentProvenanceParent[]; /** - * The amount of documents with a predicted occurrence. + * The index of the revision that produced this element. */ - predictedDocumentCount?: number | null; + revision?: number | null; /** - * The amount of occurrences in predicted documents. + * The type of provenance operation. */ - predictedOccurrencesCount?: number | null; + type?: string | null; + } + /** + * The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentProvenanceParent { /** - * The calculated recall. + * The id of the parent provenance. */ - recall?: number | null; + id?: number | null; /** - * The amount of documents that had an occurrence of this label. + * The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. */ - totalDocumentsCount?: number | null; + index?: number | null; /** - * The amount of true positives. + * The index of the index into current revision's parent_ids list. */ - truePositivesCount?: number | null; + revision?: number | null; } /** - * Metrics across multiple confidence levels. + * Contains past or forward revisions of this document. */ - export interface Schema$GoogleCloudDocumentaiV1beta3EvaluationMultiConfidenceMetrics { + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentRevision { /** - * The calculated area under the precision recall curve (AUPRC), computed by integrating over all confidence thresholds. + * If the change was made by a person specify the name or id of that person. */ - auprc?: number | null; + agent?: string | null; /** - * The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching only. + * The time that the revision was created, internally generated by doc proto storage at the time of create. */ - auprcExact?: number | null; + createTime?: string | null; /** - * Metrics across confidence levels with fuzzy matching enabled. + * Human Review information of this revision. */ - confidenceLevelMetrics?: Schema$GoogleCloudDocumentaiV1beta3EvaluationConfidenceLevelMetrics[]; + humanReview?: Schema$GoogleCloudDocumentaiV1beta3DocumentRevisionHumanReview; /** - * Metrics across confidence levels with only exact matching. + * Id of the revision, internally generated by doc proto storage. Unique within the context of the document. */ - confidenceLevelMetricsExact?: Schema$GoogleCloudDocumentaiV1beta3EvaluationConfidenceLevelMetrics[]; + id?: string | null; /** - * The Estimated Calibration Error (ECE) of the confidence of the predicted entities. + * The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. */ - estimatedCalibrationError?: number | null; + parent?: number[] | null; /** - * The ECE for the predicted entities with fuzzy matching disabled, i.e., exact matching only. + * The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field. */ - estimatedCalibrationErrorExact?: number | null; + parentIds?: string[] | null; /** - * The metrics type for the label. + * If the annotation was made by processor identify the processor by its resource name. */ - metricsType?: string | null; + processor?: string | null; } /** - * Gives a short summary of an evaluation, and links to the evaluation itself. + * Human Review information of the document. */ - export interface Schema$GoogleCloudDocumentaiV1beta3EvaluationReference { - /** - * An aggregate of the statistics for the evaluation with fuzzy matching on. - */ - aggregateMetrics?: Schema$GoogleCloudDocumentaiV1beta3EvaluationMetrics; - /** - * An aggregate of the statistics for the evaluation with fuzzy matching off. - */ - aggregateMetricsExact?: Schema$GoogleCloudDocumentaiV1beta3EvaluationMetrics; - /** - * The resource name of the evaluation. - */ - evaluation?: string | null; + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentRevisionHumanReview { /** - * The resource name of the Long Running Operation for the evaluation. + * Human review state. e.g. `requested`, `succeeded`, `rejected`. */ - operation?: string | null; - } - /** - * Response message for the FetchProcessorTypes method. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3FetchProcessorTypesResponse { + state?: string | null; /** - * The list of processor types. + * A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`. */ - processorTypes?: Schema$GoogleCloudDocumentaiV1beta3ProcessorType[]; + stateMessage?: string | null; } /** - * Metadata for how this field value is extracted. + * A set of inline documents. */ - export interface Schema$GoogleCloudDocumentaiV1beta3FieldExtractionMetadata { + export interface Schema$GoogleCloudDocumentaiV1beta3Documents { /** - * Summary options config. + * The list of documents. */ - summaryOptions?: Schema$GoogleCloudDocumentaiV1beta3SummaryOptions; + documents?: Schema$GoogleCloudDocumentaiV1beta3Document[]; } /** - * Specifies a document stored on Cloud Storage. + * The schema defines the output of the processed document by a processor. */ - export interface Schema$GoogleCloudDocumentaiV1beta3GcsDocument { + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentSchema { /** - * The Cloud Storage object uri. + * Description of the schema. */ - gcsUri?: string | null; + description?: string | null; /** - * An IANA MIME type (RFC6838) of the content. + * Display name to show to users. */ - mimeType?: string | null; - } - /** - * Specifies a set of documents on Cloud Storage. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3GcsDocuments { + displayName?: string | null; /** - * The list of documents. + * Entity types of the schema. */ - documents?: Schema$GoogleCloudDocumentaiV1beta3GcsDocument[]; - } - /** - * Specifies all documents on Cloud Storage with a common prefix. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3GcsPrefix { + entityTypes?: Schema$GoogleCloudDocumentaiV1beta3DocumentSchemaEntityType[]; /** - * The URI prefix. + * Metadata of the schema. */ - gcsUriPrefix?: string | null; - } - export interface Schema$GoogleCloudDocumentaiV1beta3GetDocumentResponse { - document?: Schema$GoogleCloudDocumentaiV1beta3Document; + metadata?: Schema$GoogleCloudDocumentaiV1beta3DocumentSchemaMetadata; } /** - * The status of human review on a processed document. + * EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. */ - export interface Schema$GoogleCloudDocumentaiV1beta3HumanReviewStatus { + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentSchemaEntityType { /** - * The name of the operation triggered by the processed document. This field is populated only when the state is `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as the long-running operation returned by ReviewDocument. + * The entity type that this type is derived from. For now, one and only one should be set. */ - humanReviewOperation?: string | null; + baseTypes?: string[] | null; /** - * The state of human review on the processing request. + * The description of the entity type. Could be used to provide more information about the entity type for model calls. */ - state?: string | null; + description?: string | null; /** - * A message providing more details about the human review state. + * User defined name for the type. */ - stateMessage?: string | null; - } - /** - * Metadata of the import document operation. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata { + displayName?: string | null; /** - * The basic metadata of the long-running operation. + * Metadata for the entity type. */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; + entityTypeMetadata?: Schema$GoogleCloudDocumentaiV1beta3EntityTypeMetadata; /** - * Validation statuses of the batch documents import config. + * If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is \>10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file. */ - importConfigValidationResults?: Schema$GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult[]; + enumValues?: Schema$GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues; /** - * The list of response details of each document. + * Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. */ - individualImportStatuses?: Schema$GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus[]; + name?: string | null; /** - * Total number of the documents that are qualified for importing. + * Description the nested structure, or composition of an entity. */ - totalDocumentCount?: number | null; + properties?: Schema$GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeProperty[]; } /** - * The validation status of each import config. Status is set to an error if there are no documents to import in the `import_config`, or `OK` if the operation will try to proceed with at least one document. + * Defines the a list of enum values. */ - export interface Schema$GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult { - /** - * The source Cloud Storage URI specified in the import config. - */ - inputGcsSource?: string | null; + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues { /** - * The validation status of import config. + * The individual values that this enum values type can include. */ - status?: Schema$GoogleRpcStatus; + values?: string[] | null; } /** - * The status of each individual document in the import process. + * Defines properties that can be part of the entity type. */ - export interface Schema$GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus { + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeProperty { /** - * The source Cloud Storage URI of the document. + * The description of the property. Could be used to provide more information about the property for model calls. */ - inputGcsSource?: string | null; + description?: string | null; /** - * The document id of imported document if it was successful, otherwise empty. + * User defined name for the property. */ - outputDocumentId?: Schema$GoogleCloudDocumentaiV1beta3DocumentId; + displayName?: string | null; /** - * The status of the importing of the document. + * Specifies how the entity's value is obtained. */ - status?: Schema$GoogleRpcStatus; - } - export interface Schema$GoogleCloudDocumentaiV1beta3ImportDocumentsRequest { + method?: string | null; /** - * Required. The Cloud Storage uri containing raw documents that must be imported. + * The name of the property. Follows the same guidelines as the EntityType name. */ - batchDocumentsImportConfigs?: Schema$GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfig[]; - } - /** - * Config for importing documents. Each batch can have its own dataset split type. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfig { + name?: string | null; /** - * If set, documents will be automatically split into training and test split category with the specified ratio. + * Occurrence type limits the number of instances an entity type appears in the document. */ - autoSplitConfig?: Schema$GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfigAutoSplitConfig; + occurrenceType?: string | null; /** - * The common config to specify a set of documents used as input. + * Any additional metadata about the property can be added here. */ - batchInputConfig?: Schema$GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig; + propertyMetadata?: Schema$GoogleCloudDocumentaiV1beta3PropertyMetadata; /** - * Target dataset split where the documents must be stored. + * A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field. */ - datasetSplit?: string | null; + valueType?: string | null; } /** - * The config for auto-split. + * Metadata for global schema behavior. */ - export interface Schema$GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfigAutoSplitConfig { + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentSchemaMetadata { /** - * Ratio of training dataset split. + * If true, on a given page, there can be multiple `document` annotations covering it. */ - trainingSplitRatio?: number | null; - } - /** - * Response of the import document operation. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3ImportDocumentsResponse {} - /** - * The long-running operation metadata for the ImportProcessorVersion method. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata { + documentAllowMultipleLabels?: boolean | null; /** - * The basic metadata for the long-running operation. + * If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification). */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; - } - /** - * The request message for the ImportProcessorVersion method. The Document AI [Service Agent](https://cloud.google.com/iam/docs/service-agents) of the destination project must have [Document AI Editor role](https://cloud.google.com/document-ai/docs/access-control/iam-roles) on the source project. The destination project is specified as part of the parent field. The source project is specified as part of the source or external_processor_version_source field. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3ImportProcessorVersionRequest { + documentSplitter?: boolean | null; /** - * The source processor version to import from. It can be from a different environment and region than the destination processor. + * If set, all the nested entities must be prefixed with the parents. */ - externalProcessorVersionSource?: Schema$GoogleCloudDocumentaiV1beta3ImportProcessorVersionRequestExternalProcessorVersionSource; + prefixedNamingOnProperties?: boolean | null; /** - * The source processor version to import from. The source processor version and destination processor need to be in the same environment and region. + * If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked. */ - processorVersionSource?: string | null; + skipNamingValidation?: boolean | null; } /** - * The external source processor version. + * For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is. */ - export interface Schema$GoogleCloudDocumentaiV1beta3ImportProcessorVersionRequestExternalProcessorVersionSource { + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentShardInfo { /** - * Required. The processor version name. Format: `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` + * Total number of shards. */ - processorVersion?: string | null; + shardCount?: string | null; /** - * Optional. The Document AI service endpoint. For example, 'https://us-documentai.googleapis.com' + * The 0-based index of this shard. */ - serviceEndpoint?: string | null; + shardIndex?: string | null; + /** + * The index of the first character in Document.text in the overall document global text. + */ + textOffset?: string | null; } /** - * The response message for the ImportProcessorVersion method. + * Annotation for common text style attributes. This adheres to CSS conventions as much as possible. */ - export interface Schema$GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse { + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentStyle { /** - * The destination processor version name. + * Text background color. */ - processorVersion?: string | null; - } - export interface Schema$GoogleCloudDocumentaiV1beta3ListDocumentsRequest { + backgroundColor?: Schema$GoogleTypeColor; /** - * Optional. Query to filter the documents based on https://google.aip.dev/160. ## Currently support query strings are: `SplitType=DATASET_SPLIT_TEST|DATASET_SPLIT_TRAIN|DATASET_SPLIT_UNASSIGNED` - `LabelingState=DOCUMENT_LABELED|DOCUMENT_UNLABELED|DOCUMENT_AUTO_LABELED` - `DisplayName=\"file_name.pdf\"` - `EntityType=abc/def` - `TagName=\"auto-labeling-running\"|\"sampled\"` Note: - Only `AND`, `=` and `!=` are supported. e.g. `DisplayName=file_name AND EntityType!=abc` IS supported. - Wildcard `*` is supported only in `DisplayName` filter - No duplicate filter keys are allowed, e.g. `EntityType=a AND EntityType=b` is NOT supported. - String match is case sensitive (for filter `DisplayName` & `EntityType`). + * Text color. */ - filter?: string | null; + color?: Schema$GoogleTypeColor; /** - * The maximum number of documents to return. The service may return fewer than this value. If unspecified, at most 20 documents will be returned. The maximum value is 100; values above 100 will be coerced to 100. + * Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/cssref/pr_font_font-family.asp */ - pageSize?: number | null; + fontFamily?: string | null; /** - * A page token, received from a previous `ListDocuments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDocuments` must match the call that provided the page token. + * Font size. */ - pageToken?: string | null; + fontSize?: Schema$GoogleCloudDocumentaiV1beta3DocumentStyleFontSize; /** - * Optional. Controls if the request requires a total size of matched documents. See ListDocumentsResponse.total_size. Enabling this flag may adversely impact performance. Defaults to false. + * [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`. */ - returnTotalSize?: boolean | null; + fontWeight?: string | null; /** - * Optional. Number of results to skip beginning from the `page_token` if provided. https://google.aip.dev/158#skipping-results. It must be a non-negative integer. Negative values will be rejected. Note that this is not the number of pages to skip. If this value causes the cursor to move past the end of results, ListDocumentsResponse.document_metadata and ListDocumentsResponse.next_page_token will be empty. + * Text anchor indexing into the Document.text. */ - skip?: number | null; - } - export interface Schema$GoogleCloudDocumentaiV1beta3ListDocumentsResponse { + textAnchor?: Schema$GoogleCloudDocumentaiV1beta3DocumentTextAnchor; /** - * Document metadata corresponding to the listed documents. + * [Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard. */ - documentMetadata?: Schema$GoogleCloudDocumentaiV1beta3DocumentMetadata[]; + textDecoration?: string | null; /** - * A token, which can be sent as ListDocumentsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. + * [Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`. */ - nextPageToken?: string | null; + textStyle?: string | null; + } + /** + * Font size with unit. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentStyleFontSize { /** - * Total count of documents queried. + * Font size for the text. */ - totalSize?: number | null; + size?: number | null; + /** + * Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`). + */ + unit?: string | null; } /** - * The response from `ListEvaluations`. + * Text reference indexing into the Document.text. */ - export interface Schema$GoogleCloudDocumentaiV1beta3ListEvaluationsResponse { + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentTextAnchor { /** - * The evaluations requested. + * Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields. */ - evaluations?: Schema$GoogleCloudDocumentaiV1beta3Evaluation[]; + content?: string | null; /** - * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + * The text segments from the Document.text. */ - nextPageToken?: string | null; + textSegments?: Schema$GoogleCloudDocumentaiV1beta3DocumentTextAnchorTextSegment[]; } /** - * Response message for the ListProcessors method. + * A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset */ - export interface Schema$GoogleCloudDocumentaiV1beta3ListProcessorsResponse { + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentTextAnchorTextSegment { /** - * Points to the next processor, otherwise empty. + * TextSegment half open end UTF-8 char index in the Document.text. */ - nextPageToken?: string | null; + endIndex?: string | null; /** - * The list of processors. + * TextSegment start UTF-8 char index in the Document.text. */ - processors?: Schema$GoogleCloudDocumentaiV1beta3Processor[]; + startIndex?: string | null; } /** - * Response message for the ListProcessorTypes method. + * This message is used for text changes aka. OCR corrections. */ - export interface Schema$GoogleCloudDocumentaiV1beta3ListProcessorTypesResponse { + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentTextChange { /** - * Points to the next page, otherwise empty. + * The text that replaces the text identified in the `text_anchor`. */ - nextPageToken?: string | null; + changedText?: string | null; /** - * The processor types. + * The history of this annotation. */ - processorTypes?: Schema$GoogleCloudDocumentaiV1beta3ProcessorType[]; + provenance?: Schema$GoogleCloudDocumentaiV1beta3DocumentProvenance[]; + /** + * Provenance of the correction. Text anchor indexing into the Document.text. There can only be a single `TextAnchor.text_segments` element. If the start and end index of the text segment are the same, the text change is inserted before that index. + */ + textAnchor?: Schema$GoogleCloudDocumentaiV1beta3DocumentTextAnchor; } /** - * Response message for the ListProcessorVersions method. + * The long-running operation metadata for the EnableProcessor method. */ - export interface Schema$GoogleCloudDocumentaiV1beta3ListProcessorVersionsResponse { + export interface Schema$GoogleCloudDocumentaiV1beta3EnableProcessorMetadata { /** - * Points to the next processor, otherwise empty. + * The basic metadata of the long-running operation. */ - nextPageToken?: string | null; + commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; + } + /** + * Request message for the EnableProcessor method. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3EnableProcessorRequest {} + /** + * Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3EnableProcessorResponse {} + /** + * Metadata about an entity type. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3EntityTypeMetadata { /** - * The list of processors. + * Whether the entity type should be considered inactive. */ - processorVersions?: Schema$GoogleCloudDocumentaiV1beta3ProcessorVersion[]; + inactive?: boolean | null; } /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. + * Metadata of the EvaluateProcessorVersion method. */ - export interface Schema$GoogleCloudDocumentaiV1beta3NormalizedVertex { + export interface Schema$GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata { /** - * X coordinate. + * The basic metadata of the long-running operation. */ - x?: number | null; + commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; + } + /** + * Evaluates the given ProcessorVersion against the supplied documents. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionRequest { /** - * Y coordinate (starts from the top of the image). + * Optional. The documents used in the evaluation. If unspecified, use the processor's dataset as evaluation input. */ - y?: number | null; + evaluationDocuments?: Schema$GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig; } /** - * Config for Document OCR. + * Response of the EvaluateProcessorVersion method. */ - export interface Schema$GoogleCloudDocumentaiV1beta3OcrConfig { + export interface Schema$GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse { /** - * A list of advanced OCR options to further fine-tune OCR behavior. Current valid values are: - `legacy_layout`: a heuristics layout detection algorithm, which serves as an alternative to the current ML-based layout detection algorithm. Customers can choose the best suitable layout algorithm based on their situation. + * The resource name of the created evaluation. */ - advancedOcrOptions?: string[] | null; + evaluation?: string | null; + } + /** + * An evaluation of a ProcessorVersion's performance. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3Evaluation { /** - * Turn on font identification model and return font style information. Deprecated, use PremiumFeatures.compute_style_info instead. + * Metrics for all the entities in aggregate. */ - computeStyleInfo?: boolean | null; + allEntitiesMetrics?: Schema$GoogleCloudDocumentaiV1beta3EvaluationMultiConfidenceMetrics; /** - * Turn off character box detector in OCR engine. Character box detection is enabled by default in OCR 2.0 (and later) processors. + * The time that the evaluation was created. */ - disableCharacterBoxesDetection?: boolean | null; + createTime?: string | null; /** - * Enables intelligent document quality scores after OCR. Can help with diagnosing why OCR responses are of poor quality for a given input. Adds additional latency comparable to regular OCR to the process call. + * Counters for the documents used in the evaluation. */ - enableImageQualityScores?: boolean | null; + documentCounters?: Schema$GoogleCloudDocumentaiV1beta3EvaluationCounters; /** - * Enables special handling for PDFs with existing text information. Results in better text extraction quality in such PDF inputs. + * Metrics across confidence levels, for different entities. */ - enableNativePdfParsing?: boolean | null; + entityMetrics?: { + [ + key: string + ]: Schema$GoogleCloudDocumentaiV1beta3EvaluationMultiConfidenceMetrics; + } | null; /** - * Includes symbol level OCR information if set to true. + * The KMS key name used for encryption. */ - enableSymbol?: boolean | null; + kmsKeyName?: string | null; /** - * Hints for the OCR model. + * The KMS key version with which data is encrypted. */ - hints?: Schema$GoogleCloudDocumentaiV1beta3OcrConfigHints; + kmsKeyVersionName?: string | null; /** - * Configurations for premium OCR features. + * The resource name of the evaluation. Format: `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processor_version\}/evaluations/{evaluation\}` */ - premiumFeatures?: Schema$GoogleCloudDocumentaiV1beta3OcrConfigPremiumFeatures; + name?: string | null; } /** - * Hints for OCR Engine + * Evaluations metrics, at a specific confidence level. */ - export interface Schema$GoogleCloudDocumentaiV1beta3OcrConfigHints { + export interface Schema$GoogleCloudDocumentaiV1beta3EvaluationConfidenceLevelMetrics { /** - * List of BCP-47 language codes to use for OCR. In most cases, not specifying it yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting hints is not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a significant hindrance if the hint is wrong). + * The confidence level. */ - languageHints?: string[] | null; + confidenceLevel?: number | null; + /** + * The metrics at the specific confidence level. + */ + metrics?: Schema$GoogleCloudDocumentaiV1beta3EvaluationMetrics; } /** - * Configurations for premium OCR features. + * Evaluation counters for the documents that were used. */ - export interface Schema$GoogleCloudDocumentaiV1beta3OcrConfigPremiumFeatures { + export interface Schema$GoogleCloudDocumentaiV1beta3EvaluationCounters { /** - * Turn on font identification model and return font style information. + * How many documents were used in the evaluation. */ - computeStyleInfo?: boolean | null; + evaluatedDocumentsCount?: number | null; /** - * Turn on the model that can extract LaTeX math formulas. + * How many documents were not included in the evaluation as Document AI failed to process them. */ - enableMathOcr?: boolean | null; + failedDocumentsCount?: number | null; /** - * Turn on selection mark detector in OCR engine. Only available in OCR 2.0 (and later) processors. + * How many documents were sent for evaluation. */ - enableSelectionMarkDetection?: boolean | null; + inputDocumentsCount?: number | null; + /** + * How many documents were not included in the evaluation as they didn't pass validation. + */ + invalidDocumentsCount?: number | null; } /** - * Options for Process API + * Evaluation metrics, either in aggregate or about a specific entity. */ - export interface Schema$GoogleCloudDocumentaiV1beta3ProcessOptions { + export interface Schema$GoogleCloudDocumentaiV1beta3EvaluationMetrics { /** - * Only process certain pages from the end, same as above. + * The calculated f1 score. */ - fromEnd?: number | null; + f1Score?: number | null; /** - * Only process certain pages from the start. Process all if the document has fewer pages. + * The amount of false negatives. */ - fromStart?: number | null; + falseNegativesCount?: number | null; /** - * Which pages to process (1-indexed). + * The amount of false positives. */ - individualPageSelector?: Schema$GoogleCloudDocumentaiV1beta3ProcessOptionsIndividualPageSelector; + falsePositivesCount?: number | null; /** - * Optional. Only applicable to `LAYOUT_PARSER_PROCESSOR`. Returns error if set on other processor types. + * The amount of documents with a ground truth occurrence. */ - layoutConfig?: Schema$GoogleCloudDocumentaiV1beta3ProcessOptionsLayoutConfig; + groundTruthDocumentCount?: number | null; /** - * Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. Returns error if set on other processor types. + * The amount of occurrences in ground truth documents. */ - ocrConfig?: Schema$GoogleCloudDocumentaiV1beta3OcrConfig; + groundTruthOccurrencesCount?: number | null; /** - * Optional. Override the schema of the ProcessorVersion. Will return an Invalid Argument error if this field is set when the underlying ProcessorVersion doesn't support schema override. + * The calculated precision. */ - schemaOverride?: Schema$GoogleCloudDocumentaiV1beta3DocumentSchema; - } - /** - * A list of individual page numbers. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3ProcessOptionsIndividualPageSelector { + precision?: number | null; /** - * Optional. Indices of the pages (starting from 1). + * The amount of documents with a predicted occurrence. */ - pages?: number[] | null; - } - /** - * Serving config for layout parser processor. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3ProcessOptionsLayoutConfig { + predictedDocumentCount?: number | null; /** - * Optional. Config for chunking in layout parser processor. + * The amount of occurrences in predicted documents. */ - chunkingConfig?: Schema$GoogleCloudDocumentaiV1beta3ProcessOptionsLayoutConfigChunkingConfig; + predictedOccurrencesCount?: number | null; /** - * Optional. Whether to include image annotations in layout parser response. + * The calculated recall. */ - enableImageAnnotation?: boolean | null; + recall?: number | null; /** - * Optional. Whether to extract images in layout parser response. + * The amount of documents that had an occurrence of this label. */ - enableImageExtraction?: boolean | null; + totalDocumentsCount?: number | null; /** - * Optional. Whether to refine PDF layout using LLM. + * The amount of true positives. */ - enableLlmLayoutParsing?: boolean | null; + truePositivesCount?: number | null; + } + /** + * Metrics across multiple confidence levels. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3EvaluationMultiConfidenceMetrics { /** - * Optional. Whether to include table annotations in layout parser response. + * The calculated area under the precision recall curve (AUPRC), computed by integrating over all confidence thresholds. */ - enableTableAnnotation?: boolean | null; + auprc?: number | null; /** - * Optional. Whether to include bounding boxes in layout parser processor response. + * The AUPRC for metrics with fuzzy matching disabled, i.e., exact matching only. */ - returnBoundingBoxes?: boolean | null; + auprcExact?: number | null; /** - * Optional. Whether to include images in layout parser processor response. + * Metrics across confidence levels with fuzzy matching enabled. */ - returnImages?: boolean | null; - } - /** - * Serving config for chunking. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3ProcessOptionsLayoutConfigChunkingConfig { + confidenceLevelMetrics?: Schema$GoogleCloudDocumentaiV1beta3EvaluationConfidenceLevelMetrics[]; /** - * Optional. The percentile of cosine dissimilarity that must be exceeded between a group of tokens and the next. The smaller this number is, the more chunks will be generated. THIS FIELD IS NOT YET USED. + * Metrics across confidence levels with only exact matching. */ - breakpointPercentileThreshold?: number | null; + confidenceLevelMetricsExact?: Schema$GoogleCloudDocumentaiV1beta3EvaluationConfidenceLevelMetrics[]; /** - * Optional. The chunk sizes to use when splitting documents, in order of level. + * The Estimated Calibration Error (ECE) of the confidence of the predicted entities. */ - chunkSize?: number | null; + estimatedCalibrationError?: number | null; /** - * Optional. Whether or not to include ancestor headings when splitting. + * The ECE for the predicted entities with fuzzy matching disabled, i.e., exact matching only. */ - includeAncestorHeadings?: boolean | null; + estimatedCalibrationErrorExact?: number | null; /** - * Optional. The number of tokens to group together when evaluating semantic similarity. THIS FIELD IS NOT YET USED. + * The metrics type for the label. */ - semanticChunkingGroupSize?: boolean | null; + metricsType?: string | null; } /** - * The first-class citizen for Document AI. Each processor defines how to extract structural information from a document. + * Gives a short summary of an evaluation, and links to the evaluation itself. */ - export interface Schema$GoogleCloudDocumentaiV1beta3Processor { - /** - * Output only. The time the processor was created. - */ - createTime?: string | null; + export interface Schema$GoogleCloudDocumentaiV1beta3EvaluationReference { /** - * The default processor version. + * An aggregate of the statistics for the evaluation with fuzzy matching on. */ - defaultProcessorVersion?: string | null; + aggregateMetrics?: Schema$GoogleCloudDocumentaiV1beta3EvaluationMetrics; /** - * The display name of the processor. + * An aggregate of the statistics for the evaluation with fuzzy matching off. */ - displayName?: string | null; + aggregateMetricsExact?: Schema$GoogleCloudDocumentaiV1beta3EvaluationMetrics; /** - * The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios. + * The resource name of the evaluation. */ - kmsKeyName?: string | null; + evaluation?: string | null; /** - * Output only. Immutable. The resource name of the processor. Format: `projects/{project\}/locations/{location\}/processors/{processor\}` + * The resource name of the Long Running Operation for the evaluation. */ - name?: string | null; + operation?: string | null; + } + /** + * Response message for the FetchProcessorTypes method. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3FetchProcessorTypesResponse { /** - * Output only. Immutable. The http endpoint that can be called to invoke processing. + * The list of processor types. */ - processEndpoint?: string | null; + processorTypes?: Schema$GoogleCloudDocumentaiV1beta3ProcessorType[]; + } + /** + * Metadata for how this field value is extracted. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3FieldExtractionMetadata { /** - * Output only. The processor version aliases. + * Summary options config. */ - processorVersionAliases?: Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionAlias[]; + summaryOptions?: Schema$GoogleCloudDocumentaiV1beta3SummaryOptions; + } + /** + * Specifies a document stored on Cloud Storage. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3GcsDocument { /** - * Output only. Reserved for future use. + * The Cloud Storage object uri. */ - satisfiesPzi?: boolean | null; + gcsUri?: string | null; /** - * Output only. Reserved for future use. + * An IANA MIME type (RFC6838) of the content. */ - satisfiesPzs?: boolean | null; + mimeType?: string | null; + } + /** + * Specifies a set of documents on Cloud Storage. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3GcsDocuments { /** - * Output only. The state of the processor. + * The list of documents. */ - state?: string | null; + documents?: Schema$GoogleCloudDocumentaiV1beta3GcsDocument[]; + } + /** + * Specifies all documents on Cloud Storage with a common prefix. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3GcsPrefix { /** - * The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor types, see FetchProcessorTypes. + * The URI prefix. */ - type?: string | null; + gcsUriPrefix?: string | null; } /** - * A processor type is responsible for performing a certain document understanding task on a certain type of document. + * Request message for GenerateSchemaVersion. */ - export interface Schema$GoogleCloudDocumentaiV1beta3ProcessorType { + export interface Schema$GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequest { /** - * Whether the processor type allows creation. If true, users can create a processor of this processor type. Otherwise, users need to request access. + * The base schema version name to use for the schema generation. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}/schemaVersions/{schema_version\}` */ - allowCreation?: boolean | null; + baseSchemaVersion?: string | null; /** - * The locations in which this processor is available. + * The set of documents placed on Cloud Storage. */ - availableLocations?: Schema$GoogleCloudDocumentaiV1beta3ProcessorTypeLocationInfo[]; + gcsDocuments?: Schema$GoogleCloudDocumentaiV1beta3GcsDocuments; /** - * The processor category, used by UI to group processor types. + * The common prefix of documents placed on Cloud Storage. */ - category?: string | null; + gcsPrefix?: Schema$GoogleCloudDocumentaiV1beta3GcsPrefix; /** - * Launch stage of the processor type + * Optional. User specified parameters for the schema generation. */ - launchStage?: string | null; + generateSchemaVersionParams?: Schema$GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequestGenerateSchemaVersionParams; /** - * The resource name of the processor type. Format: `projects/{project\}/processorTypes/{processor_type\}` + * The set of documents specified inline. */ - name?: string | null; + inlineDocuments?: Schema$GoogleCloudDocumentaiV1beta3Documents; /** - * A set of Cloud Storage URIs of sample documents for this processor. + * The set of raw documents. */ - sampleDocumentUris?: string[] | null; + rawDocuments?: Schema$GoogleCloudDocumentaiV1beta3RawDocuments; + } + /** + * The parameters for the schema generation. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequestGenerateSchemaVersionParams { /** - * The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. + * Optional. Previous prompt-answers in a chronological order. */ - type?: string | null; + history?: Schema$GoogleCloudDocumentaiV1beta3SchemaGenerationHistory; + /** + * Optional. The prompt used for the schema generation. + */ + prompt?: string | null; } /** - * The location information about where the processor is available. + * Response message for GenerateSchemaVersion. */ - export interface Schema$GoogleCloudDocumentaiV1beta3ProcessorTypeLocationInfo { + export interface Schema$GoogleCloudDocumentaiV1beta3GenerateSchemaVersionResponse { /** - * The location ID. For supported locations, refer to [regional and multi-regional support](/document-ai/docs/regions). + * The schema version generated by the model. */ - locationId?: string | null; + schemaVersion?: Schema$GoogleCloudDocumentaiV1beta3SchemaVersion; + } + export interface Schema$GoogleCloudDocumentaiV1beta3GetDocumentResponse { + document?: Schema$GoogleCloudDocumentaiV1beta3Document; } /** - * 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. + * The status of human review on a processed document. */ - export interface Schema$GoogleCloudDocumentaiV1beta3ProcessorVersion { + export interface Schema$GoogleCloudDocumentaiV1beta3HumanReviewStatus { /** - * Output only. The time the processor version was created. + * The name of the operation triggered by the processed document. This field is populated only when the state is `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as the long-running operation returned by ReviewDocument. */ - createTime?: string | null; + humanReviewOperation?: string | null; /** - * Output only. If set, information about the eventual deprecation of this version. + * The state of human review on the processing request. */ - deprecationInfo?: Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionDeprecationInfo; + state?: string | null; /** - * The display name of the processor version. + * A message providing more details about the human review state. */ - displayName?: string | null; + stateMessage?: string | null; + } + /** + * Metadata of the import document operation. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata { /** - * Output only. The schema of the processor version. Describes the output. + * The basic metadata of the long-running operation. */ - documentSchema?: Schema$GoogleCloudDocumentaiV1beta3DocumentSchema; + commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; /** - * Output only. Information about Generative AI model-based processor versions. + * Validation statuses of the batch documents import config. */ - genAiModelInfo?: Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo; - /** - * Output only. Denotes that this `ProcessorVersion` is managed by Google. - */ - googleManaged?: boolean | null; + importConfigValidationResults?: Schema$GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult[]; /** - * Output only. The KMS key name used for encryption. + * The list of response details of each document. */ - kmsKeyName?: string | null; + individualImportStatuses?: Schema$GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus[]; /** - * Output only. The KMS key version with which data is encrypted. + * Total number of the documents that are qualified for importing. */ - kmsKeyVersionName?: string | null; + totalDocumentCount?: number | null; + } + /** + * The validation status of each import config. Status is set to an error if there are no documents to import in the `import_config`, or `OK` if the operation will try to proceed with at least one document. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult { /** - * Output only. The most recently invoked evaluation for the processor version. + * The source Cloud Storage URI specified in the import config. */ - latestEvaluation?: Schema$GoogleCloudDocumentaiV1beta3EvaluationReference; + inputGcsSource?: string | null; /** - * Output only. The model type of this processor version. + * The validation status of import config. */ - modelType?: string | null; + status?: Schema$GoogleRpcStatus; + } + /** + * The status of each individual document in the import process. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus { /** - * Identifier. The resource name of the processor version. Format: `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processor_version\}` + * The source Cloud Storage URI of the document. */ - name?: string | null; + inputGcsSource?: string | null; /** - * Output only. Reserved for future use. + * The document id of imported document if it was successful, otherwise empty. */ - satisfiesPzi?: boolean | null; + outputDocumentId?: Schema$GoogleCloudDocumentaiV1beta3DocumentId; /** - * Output only. Reserved for future use. + * The status of the importing of the document. */ - satisfiesPzs?: boolean | null; + status?: Schema$GoogleRpcStatus; + } + export interface Schema$GoogleCloudDocumentaiV1beta3ImportDocumentsRequest { /** - * Output only. The state of the processor version. + * Required. The Cloud Storage uri containing raw documents that must be imported. */ - state?: string | null; + batchDocumentsImportConfigs?: Schema$GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfig[]; } /** - * Contains the alias and the aliased resource name of processor version. + * Config for importing documents. Each batch can have its own dataset split type. */ - export interface Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionAlias { + export interface Schema$GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfig { /** - * The alias in the form of `processor_version` resource name. + * If set, documents will be automatically split into training and test split category with the specified ratio. */ - alias?: string | null; + autoSplitConfig?: Schema$GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfigAutoSplitConfig; /** - * The resource name of aliased processor version. + * The common config to specify a set of documents used as input. */ - processorVersion?: string | null; + batchInputConfig?: Schema$GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig; + /** + * Target dataset split where the documents must be stored. + */ + datasetSplit?: string | null; } /** - * Information about the upcoming deprecation of this processor version. + * The config for auto-split. */ - export interface Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionDeprecationInfo { - /** - * The time at which this processor version will be deprecated. - */ - deprecationTime?: string | null; + export interface Schema$GoogleCloudDocumentaiV1beta3ImportDocumentsRequestBatchDocumentsImportConfigAutoSplitConfig { /** - * If set, the processor version that will be used as a replacement. + * Ratio of training dataset split. */ - replacementProcessorVersion?: string | null; + trainingSplitRatio?: number | null; } /** - * Information about Generative AI model-based processor versions. + * Response of the import document operation. */ - export interface Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo { - /** - * Information for a custom Generative AI model created by the user. - */ - customGenAiModelInfo?: Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo; + export interface Schema$GoogleCloudDocumentaiV1beta3ImportDocumentsResponse {} + /** + * The long-running operation metadata for the ImportProcessorVersion method. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata { /** - * Information for a pretrained Google-managed foundation model. + * The basic metadata for the long-running operation. */ - foundationGenAiModelInfo?: Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo; + commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; } /** - * Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs. + * The request message for the ImportProcessorVersion method. The Document AI [Service Agent](https://cloud.google.com/iam/docs/service-agents) of the destination project must have [Document AI Editor role](https://cloud.google.com/document-ai/docs/access-control/iam-roles) on the source project. The destination project is specified as part of the parent field. The source project is specified as part of the source or external_processor_version_source field. */ - export interface Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo { + export interface Schema$GoogleCloudDocumentaiV1beta3ImportProcessorVersionRequest { /** - * The base processor version ID for the custom model. + * The source processor version to import from. It can be from a different environment and region than the destination processor. */ - baseProcessorVersionId?: string | null; + externalProcessorVersionSource?: Schema$GoogleCloudDocumentaiV1beta3ImportProcessorVersionRequestExternalProcessorVersionSource; /** - * The type of custom model created by the user. + * The source processor version to import from. The source processor version and destination processor need to be in the same environment and region. */ - customModelType?: string | null; + processorVersionSource?: string | null; } /** - * Information for a pretrained Google-managed foundation model. + * The external source processor version. */ - export interface Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo { + export interface Schema$GoogleCloudDocumentaiV1beta3ImportProcessorVersionRequestExternalProcessorVersionSource { /** - * Whether finetuning is allowed for this base processor version. + * Required. The processor version name. Format: `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` */ - finetuningAllowed?: boolean | null; + processorVersion?: string | null; /** - * The minimum number of labeled documents in the training dataset required for finetuning. + * Optional. The Document AI service endpoint. For example, 'https://us-documentai.googleapis.com' */ - minTrainLabeledDocuments?: number | null; + serviceEndpoint?: string | null; } /** - * Request message for the ProcessDocument method. + * The response message for the ImportProcessorVersion method. */ - export interface Schema$GoogleCloudDocumentaiV1beta3ProcessRequest { + export interface Schema$GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse { /** - * The document payload, the content and mime_type fields must be set. + * The destination processor version name. */ - document?: Schema$GoogleCloudDocumentaiV1beta3Document; + processorVersion?: string | null; + } + export interface Schema$GoogleCloudDocumentaiV1beta3ListDocumentsRequest { /** - * Specifies which fields to include in the ProcessResponse.document output. Only supports top-level document and pages field, so it must be in the form of `{document_field_name\}` or `pages.{page_field_name\}`. + * Optional. Query to filter the documents based on https://google.aip.dev/160. ## Currently support query strings are: `SplitType=DATASET_SPLIT_TEST|DATASET_SPLIT_TRAIN|DATASET_SPLIT_UNASSIGNED` - `LabelingState=DOCUMENT_LABELED|DOCUMENT_UNLABELED|DOCUMENT_AUTO_LABELED` - `DisplayName=\"file_name.pdf\"` - `EntityType=abc/def` - `TagName=\"auto-labeling-running\"|\"sampled\"` Note: - Only `AND`, `=` and `!=` are supported. e.g. `DisplayName=file_name AND EntityType!=abc` IS supported. - Wildcard `*` is supported only in `DisplayName` filter - No duplicate filter keys are allowed, e.g. `EntityType=a AND EntityType=b` is NOT supported. - String match is case sensitive (for filter `DisplayName` & `EntityType`). */ - fieldMask?: string | null; + filter?: string | null; /** - * A raw document on Google Cloud Storage. + * The maximum number of documents to return. The service may return fewer than this value. If unspecified, at most 20 documents will be returned. The maximum value is 100; values above 100 will be coerced to 100. */ - gcsDocument?: Schema$GoogleCloudDocumentaiV1beta3GcsDocument; + pageSize?: number | null; /** - * Optional. Option to remove images from the document. + * A page token, received from a previous `ListDocuments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDocuments` must match the call that provided the page token. */ - imagelessMode?: boolean | null; + pageToken?: string | null; /** - * An inline document proto. + * Optional. Controls if the request requires a total size of matched documents. See ListDocumentsResponse.total_size. Enabling this flag may adversely impact performance. Defaults to false. */ - inlineDocument?: Schema$GoogleCloudDocumentaiV1beta3Document; + returnTotalSize?: boolean | null; /** - * Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. + * Optional. Number of results to skip beginning from the `page_token` if provided. https://google.aip.dev/158#skipping-results. It must be a non-negative integer. Negative values will be rejected. Note that this is not the number of pages to skip. If this value causes the cursor to move past the end of results, ListDocumentsResponse.document_metadata and ListDocumentsResponse.next_page_token will be empty. */ - labels?: {[key: string]: string} | null; + skip?: number | null; + } + export interface Schema$GoogleCloudDocumentaiV1beta3ListDocumentsResponse { /** - * Inference-time options for the process API + * Document metadata corresponding to the listed documents. */ - processOptions?: Schema$GoogleCloudDocumentaiV1beta3ProcessOptions; + documentMetadata?: Schema$GoogleCloudDocumentaiV1beta3DocumentMetadata[]; /** - * A raw document content (bytes). + * A token, which can be sent as ListDocumentsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. */ - rawDocument?: Schema$GoogleCloudDocumentaiV1beta3RawDocument; + nextPageToken?: string | null; /** - * Whether human review should be skipped for this request. Default to `false`. + * Total count of documents queried. */ - skipHumanReview?: boolean | null; + totalSize?: number | null; } /** - * Response message for the ProcessDocument method. + * The response from `ListEvaluations`. */ - export interface Schema$GoogleCloudDocumentaiV1beta3ProcessResponse { - /** - * The document payload, will populate fields based on the processor's behavior. - */ - document?: Schema$GoogleCloudDocumentaiV1beta3Document; + export interface Schema$GoogleCloudDocumentaiV1beta3ListEvaluationsResponse { /** - * The name of the operation triggered by the processed document. If the human review process isn't triggered, this field is empty. It has the same response type and metadata as the long-running operation returned by ReviewDocument. + * The evaluations requested. */ - humanReviewOperation?: string | null; + evaluations?: Schema$GoogleCloudDocumentaiV1beta3Evaluation[]; /** - * The status of human review on the processed document. + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */ - humanReviewStatus?: Schema$GoogleCloudDocumentaiV1beta3HumanReviewStatus; + nextPageToken?: string | null; } /** - * Metadata about a property. + * Response message for the ListProcessors method. */ - export interface Schema$GoogleCloudDocumentaiV1beta3PropertyMetadata { + export interface Schema$GoogleCloudDocumentaiV1beta3ListProcessorsResponse { /** - * Field extraction metadata on the property. + * Points to the next processor, otherwise empty. */ - fieldExtractionMetadata?: Schema$GoogleCloudDocumentaiV1beta3FieldExtractionMetadata; + nextPageToken?: string | null; /** - * Whether the property should be considered as "inactive". + * The list of processors. */ - inactive?: boolean | null; + processors?: Schema$GoogleCloudDocumentaiV1beta3Processor[]; } /** - * Payload message of raw document content (bytes). + * Response message for the ListProcessorTypes method. */ - export interface Schema$GoogleCloudDocumentaiV1beta3RawDocument { - /** - * Inline document content. - */ - content?: string | null; + export interface Schema$GoogleCloudDocumentaiV1beta3ListProcessorTypesResponse { /** - * The display name of the document, it supports all Unicode characters except the following: `*`, `?`, `[`, `]`, `%`, `{`, `\}`,`'`, `\"`, `,` `~`, `=` and `:` are reserved. If not specified, a default ID is generated. + * Points to the next page, otherwise empty. */ - displayName?: string | null; + nextPageToken?: string | null; /** - * An IANA MIME type (RFC6838) indicating the nature and format of the content. + * The processor types. */ - mimeType?: string | null; + processorTypes?: Schema$GoogleCloudDocumentaiV1beta3ProcessorType[]; } /** - * The long-running operation metadata for the ReviewDocument method. + * Response message for the ListProcessorVersions method. */ - export interface Schema$GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata { + export interface Schema$GoogleCloudDocumentaiV1beta3ListProcessorVersionsResponse { /** - * The basic metadata of the long-running operation. + * Points to the next processor, otherwise empty. */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; + nextPageToken?: string | null; /** - * The creation time of the operation. + * The list of processors. */ - createTime?: string | null; + processorVersions?: Schema$GoogleCloudDocumentaiV1beta3ProcessorVersion[]; + } + /** + * Response message for ListSchemas. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3ListSchemasResponse { /** - * The Crowd Compute question ID. + * Points to the next Schema, otherwise empty. */ - questionId?: string | null; + nextPageToken?: string | null; /** - * Used only when Operation.done is false. + * The list of Schemas. */ - state?: string | null; + schemas?: Schema$GoogleCloudDocumentaiV1beta3NextSchema[]; + } + /** + * Response message for ListSchemaVersions. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3ListSchemaVersionsResponse { /** - * A message providing more details about the current state of processing. For example, the error message if the operation is failed. + * Points to the next SchemaVersion, otherwise empty. */ - stateMessage?: string | null; + nextPageToken?: string | null; /** - * The last update time of the operation. + * The list of SchemaVersions. */ - updateTime?: string | null; + schemaVersions?: Schema$GoogleCloudDocumentaiV1beta3SchemaVersion[]; } /** - * Request message for the ReviewDocument method. + * NextSchema is a collection of SchemaVersions. */ - export interface Schema$GoogleCloudDocumentaiV1beta3ReviewDocumentRequest { + export interface Schema$GoogleCloudDocumentaiV1beta3NextSchema { /** - * The document that needs human review. + * Output only. The time when the Schema was created. */ - document?: Schema$GoogleCloudDocumentaiV1beta3Document; + createTime?: string | null; /** - * The document schema of the human review task. + * Optional. The user-defined name of the Schema. */ - documentSchema?: Schema$GoogleCloudDocumentaiV1beta3DocumentSchema; + displayName?: string | null; /** - * Whether the validation should be performed on the ad-hoc review request. + * Optional. The GCP labels for the Schema. */ - enableSchemaValidation?: boolean | null; + labels?: {[key: string]: string} | null; /** - * An inline document proto. + * Identifier. The resource name of the Schema. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}` */ - inlineDocument?: Schema$GoogleCloudDocumentaiV1beta3Document; + name?: string | null; /** - * The priority of the human review task. + * Output only. The time when the Schema was last updated. */ - priority?: string | null; + updateTime?: string | null; } /** - * Response message for the ReviewDocument method. + * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. */ - export interface Schema$GoogleCloudDocumentaiV1beta3ReviewDocumentResponse { + export interface Schema$GoogleCloudDocumentaiV1beta3NormalizedVertex { /** - * The Cloud Storage uri for the human reviewed document if the review is succeeded. + * X coordinate. */ - gcsDestination?: string | null; - /** - * The reason why the review is rejected by reviewer. - */ - rejectionReason?: string | null; + x?: number | null; /** - * The state of the review operation. + * Y coordinate (starts from the top of the image). */ - state?: string | null; + y?: number | null; } /** - * The revision reference specifies which revision on the document to read. + * Config for Document OCR. */ - export interface Schema$GoogleCloudDocumentaiV1beta3RevisionRef { + export interface Schema$GoogleCloudDocumentaiV1beta3OcrConfig { /** - * Reads the revision generated by the processor version. The format takes the full resource name of processor version. `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` + * A list of advanced OCR options to further fine-tune OCR behavior. Current valid values are: - `legacy_layout`: a heuristics layout detection algorithm, which serves as an alternative to the current ML-based layout detection algorithm. Customers can choose the best suitable layout algorithm based on their situation. */ - latestProcessorVersion?: string | null; + advancedOcrOptions?: string[] | null; /** - * Reads the revision by the predefined case. + * Turn on font identification model and return font style information. Deprecated, use PremiumFeatures.compute_style_info instead. */ - revisionCase?: string | null; + computeStyleInfo?: boolean | null; /** - * Reads the revision given by the id. + * Turn off character box detector in OCR engine. Character box detection is enabled by default in OCR 2.0 (and later) processors. */ - revisionId?: string | null; - } - /** - * The long-running operation metadata for the SetDefaultProcessorVersion method. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata { + disableCharacterBoxesDetection?: boolean | null; /** - * The basic metadata of the long-running operation. + * Enables intelligent document quality scores after OCR. Can help with diagnosing why OCR responses are of poor quality for a given input. Adds additional latency comparable to regular OCR to the process call. */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; - } - /** - * Request message for the SetDefaultProcessorVersion method. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionRequest { + enableImageQualityScores?: boolean | null; /** - * Required. The resource name of child ProcessorVersion to use as default. Format: `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{version\}` + * Enables special handling for PDFs with existing text information. Results in better text extraction quality in such PDF inputs. */ - defaultProcessorVersion?: string | null; - } - /** - * Response message for the SetDefaultProcessorVersion method. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse {} - /** - * Metadata for document summarization. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3SummaryOptions { + enableNativePdfParsing?: boolean | null; /** - * The format the summary should be in. + * Includes symbol level OCR information if set to true. */ - format?: string | null; + enableSymbol?: boolean | null; /** - * How long the summary should be. + * Hints for the OCR model. */ - length?: string | null; + hints?: Schema$GoogleCloudDocumentaiV1beta3OcrConfigHints; + /** + * Configurations for premium OCR features. + */ + premiumFeatures?: Schema$GoogleCloudDocumentaiV1beta3OcrConfigPremiumFeatures; } /** - * The metadata that represents a processor version being created. + * Hints for OCR Engine */ - export interface Schema$GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata { - /** - * The basic metadata of the long-running operation. - */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; - /** - * The test dataset validation information. - */ - testDatasetValidation?: Schema$GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation; + export interface Schema$GoogleCloudDocumentaiV1beta3OcrConfigHints { /** - * The training dataset validation information. + * List of BCP-47 language codes to use for OCR. In most cases, not specifying it yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting hints is not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a significant hindrance if the hint is wrong). */ - trainingDatasetValidation?: Schema$GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation; + languageHints?: string[] | null; } /** - * The dataset validation information. This includes any and all errors with documents and the dataset. + * Configurations for premium OCR features. */ - export interface Schema$GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation { - /** - * The total number of dataset errors. - */ - datasetErrorCount?: number | null; + export interface Schema$GoogleCloudDocumentaiV1beta3OcrConfigPremiumFeatures { /** - * Error information for the dataset as a whole. A maximum of 10 dataset errors will be returned. A single dataset error is terminal for training. + * Turn on font identification model and return font style information. */ - datasetErrors?: Schema$GoogleRpcStatus[]; + computeStyleInfo?: boolean | null; /** - * The total number of document errors. + * Turn on the model that can extract LaTeX math formulas. */ - documentErrorCount?: number | null; + enableMathOcr?: boolean | null; /** - * Error information pertaining to specific documents. A maximum of 10 document errors will be returned. Any document with errors will not be used throughout training. + * Turn on selection mark detector in OCR engine. Only available in OCR 2.0 (and later) processors. */ - documentErrors?: Schema$GoogleRpcStatus[]; + enableSelectionMarkDetection?: boolean | null; } /** - * Request message for the TrainProcessorVersion method. + * Options for Process API */ - export interface Schema$GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequest { + export interface Schema$GoogleCloudDocumentaiV1beta3ProcessOptions { /** - * Optional. The processor version to use as a base for training. This processor version must be a child of `parent`. Format: `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}`. + * Only process certain pages from the end, same as above. */ - baseProcessorVersion?: string | null; + fromEnd?: number | null; /** - * Options to control Custom Document Extraction (CDE) Processor. + * Only process certain pages from the start. Process all if the document has fewer pages. */ - customDocumentExtractionOptions?: Schema$GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequestCustomDocumentExtractionOptions; + fromStart?: number | null; /** - * Optional. The schema the processor version will be trained with. + * Which pages to process (1-indexed). */ - documentSchema?: Schema$GoogleCloudDocumentaiV1beta3DocumentSchema; + individualPageSelector?: Schema$GoogleCloudDocumentaiV1beta3ProcessOptionsIndividualPageSelector; /** - * Options to control foundation model tuning of a processor. + * Optional. Only applicable to `LAYOUT_PARSER_PROCESSOR`. Returns error if set on other processor types. */ - foundationModelTuningOptions?: Schema$GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequestFoundationModelTuningOptions; + layoutConfig?: Schema$GoogleCloudDocumentaiV1beta3ProcessOptionsLayoutConfig; /** - * Optional. The input data used to train the ProcessorVersion. + * Only applicable to `OCR_PROCESSOR` and `FORM_PARSER_PROCESSOR`. Returns error if set on other processor types. */ - inputData?: Schema$GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequestInputData; + ocrConfig?: Schema$GoogleCloudDocumentaiV1beta3OcrConfig; /** - * Required. The processor version to be created. + * Optional. Override the schema of the ProcessorVersion. Will return an Invalid Argument error if this field is set when the underlying ProcessorVersion doesn't support schema override. */ - processorVersion?: Schema$GoogleCloudDocumentaiV1beta3ProcessorVersion; + schemaOverride?: Schema$GoogleCloudDocumentaiV1beta3DocumentSchema; } /** - * Options to control the training of the Custom Document Extraction (CDE) Processor. + * A list of individual page numbers. */ - export interface Schema$GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequestCustomDocumentExtractionOptions { + export interface Schema$GoogleCloudDocumentaiV1beta3ProcessOptionsIndividualPageSelector { /** - * Optional. Training method to use for CDE training. + * Optional. Indices of the pages (starting from 1). */ - trainingMethod?: string | null; + pages?: number[] | null; } /** - * Options to control foundation model tuning of the processor. + * Serving config for layout parser processor. */ - export interface Schema$GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequestFoundationModelTuningOptions { + export interface Schema$GoogleCloudDocumentaiV1beta3ProcessOptionsLayoutConfig { /** - * Optional. The multiplier to apply to the recommended learning rate. Valid values are between 0.1 and 10. If not provided, recommended learning rate will be used. + * Optional. Config for chunking in layout parser processor. */ - learningRateMultiplier?: number | null; + chunkingConfig?: Schema$GoogleCloudDocumentaiV1beta3ProcessOptionsLayoutConfigChunkingConfig; /** - * Optional. The number of steps to run for model tuning. Valid values are between 1 and 400. If not provided, recommended steps will be used. + * Optional. Whether to include image annotations in layout parser response. */ - trainSteps?: number | null; - } - /** - * The input data used to train a new ProcessorVersion. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequestInputData { + enableImageAnnotation?: boolean | null; /** - * The documents used for testing the trained version. + * Optional. Whether to extract images in layout parser response. */ - testDocuments?: Schema$GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig; + enableImageExtraction?: boolean | null; /** - * The documents used for training the new version. + * Optional. Whether to refine PDF layout using LLM. */ - trainingDocuments?: Schema$GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig; - } - /** - * The response for TrainProcessorVersion. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse { + enableLlmLayoutParsing?: boolean | null; /** - * The resource name of the processor version produced by training. + * Optional. Whether to include table annotations in layout parser response. */ - processorVersion?: string | null; - } - /** - * The long-running operation metadata for the UndeployProcessorVersion method. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata { + enableTableAnnotation?: boolean | null; /** - * The basic metadata of the long-running operation. + * Optional. Whether to include bounding boxes in layout parser processor response. */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; - } - /** - * Request message for the UndeployProcessorVersion method. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3UndeployProcessorVersionRequest {} - /** - * Response message for the UndeployProcessorVersion method. - */ - export interface Schema$GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse {} - export interface Schema$GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata { + returnBoundingBoxes?: boolean | null; /** - * The basic metadata of the long-running operation. + * Optional. Whether to include images in layout parser processor response. */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; + returnImages?: boolean | null; } /** - * A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. + * Serving config for chunking. */ - export interface Schema$GoogleCloudDocumentaiV1beta3Vertex { + export interface Schema$GoogleCloudDocumentaiV1beta3ProcessOptionsLayoutConfigChunkingConfig { /** - * X coordinate. + * Optional. The percentile of cosine dissimilarity that must be exceeded between a group of tokens and the next. The smaller this number is, the more chunks will be generated. THIS FIELD IS NOT YET USED. */ - x?: number | null; + breakpointPercentileThreshold?: number | null; /** - * Y coordinate (starts from the top of the image). + * Optional. The chunk sizes to use when splitting documents, in order of level. */ - y?: number | null; + chunkSize?: number | null; + /** + * Optional. Whether or not to include ancestor headings when splitting. + */ + includeAncestorHeadings?: boolean | null; + /** + * Optional. The number of tokens to group together when evaluating semantic similarity. THIS FIELD IS NOT YET USED. + */ + semanticChunkingGroupSize?: boolean | null; } /** - * The common metadata for long running operations. + * The first-class citizen for Document AI. Each processor defines how to extract structural information from a document. */ - export interface Schema$GoogleCloudDocumentaiV1CommonOperationMetadata { + export interface Schema$GoogleCloudDocumentaiV1beta3Processor { /** - * The creation time of the operation. + * Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project\}/locations/{location\}/schemas/{schema\}/schemaVersions/{schema_version\} + */ + activeSchemaVersion?: string | null; + /** + * Output only. The time the processor was created. */ createTime?: string | null; /** - * A related resource to this operation. + * The default processor version. */ - resource?: string | null; + defaultProcessorVersion?: string | null; /** - * The state of the operation. + * The display name of the processor. */ - state?: string | null; + displayName?: string | null; /** - * A message providing more details about the current state of processing. + * The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios. */ - stateMessage?: string | null; + kmsKeyName?: string | null; /** - * The last update time of the operation. + * Output only. Immutable. The resource name of the processor. Format: `projects/{project\}/locations/{location\}/processors/{processor\}` */ - updateTime?: string | null; - } - /** - * The long-running operation metadata for the DeleteProcessor method. - */ - export interface Schema$GoogleCloudDocumentaiV1DeleteProcessorMetadata { + name?: string | null; /** - * The basic metadata of the long-running operation. + * Output only. Immutable. The http endpoint that can be called to invoke processing. */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1CommonOperationMetadata; - } - /** - * The long-running operation metadata for the DeleteProcessorVersion method. - */ - export interface Schema$GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata { + processEndpoint?: string | null; /** - * The basic metadata of the long-running operation. + * Output only. The processor version aliases. */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1CommonOperationMetadata; - } - /** - * The long-running operation metadata for the DeployProcessorVersion method. - */ - export interface Schema$GoogleCloudDocumentaiV1DeployProcessorVersionMetadata { + processorVersionAliases?: Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionAlias[]; /** - * The basic metadata of the long-running operation. + * Output only. Reserved for future use. */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1CommonOperationMetadata; - } - /** - * Response message for the DeployProcessorVersion method. - */ - export interface Schema$GoogleCloudDocumentaiV1DeployProcessorVersionResponse {} - /** - * The long-running operation metadata for the DisableProcessor method. - */ - export interface Schema$GoogleCloudDocumentaiV1DisableProcessorMetadata { + satisfiesPzi?: boolean | null; /** - * The basic metadata of the long-running operation. + * Output only. Reserved for future use. */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1CommonOperationMetadata; - } - /** - * Response message for the DisableProcessor method. Intentionally empty proto for adding fields in future. - */ - export interface Schema$GoogleCloudDocumentaiV1DisableProcessorResponse {} - /** - * The long-running operation metadata for the EnableProcessor method. - */ - export interface Schema$GoogleCloudDocumentaiV1EnableProcessorMetadata { + satisfiesPzs?: boolean | null; /** - * The basic metadata of the long-running operation. + * Output only. The state of the processor. */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1CommonOperationMetadata; - } - /** - * Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future. - */ - export interface Schema$GoogleCloudDocumentaiV1EnableProcessorResponse {} - /** - * Metadata of the EvaluateProcessorVersion method. - */ - export interface Schema$GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata { + state?: string | null; /** - * The basic metadata of the long-running operation. + * The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor types, see FetchProcessorTypes. */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1CommonOperationMetadata; + type?: string | null; } /** - * Response of the EvaluateProcessorVersion method. + * A processor type is responsible for performing a certain document understanding task on a certain type of document. */ - export interface Schema$GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse { + export interface Schema$GoogleCloudDocumentaiV1beta3ProcessorType { /** - * The resource name of the created evaluation. + * Whether the processor type allows creation. If true, users can create a processor of this processor type. Otherwise, users need to request access. */ - evaluation?: string | null; - } - /** - * The status of human review on a processed document. - */ - export interface Schema$GoogleCloudDocumentaiV1HumanReviewStatus { + allowCreation?: boolean | null; /** - * The name of the operation triggered by the processed document. This field is populated only when the state is `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as the long-running operation returned by ReviewDocument. + * The locations in which this processor is available. */ - humanReviewOperation?: string | null; + availableLocations?: Schema$GoogleCloudDocumentaiV1beta3ProcessorTypeLocationInfo[]; /** - * The state of human review on the processing request. + * The processor category, used by UI to group processor types. */ - state?: string | null; + category?: string | null; /** - * A message providing more details about the human review state. + * Launch stage of the processor type */ - stateMessage?: string | null; + launchStage?: string | null; + /** + * The resource name of the processor type. Format: `projects/{project\}/processorTypes/{processor_type\}` + */ + name?: string | null; + /** + * A set of Cloud Storage URIs of sample documents for this processor. + */ + sampleDocumentUris?: string[] | null; + /** + * The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. + */ + type?: string | null; } /** - * The long-running operation metadata for the ReviewDocument method. + * The location information about where the processor is available. */ - export interface Schema$GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata { - /** - * The basic metadata of the long-running operation. - */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1CommonOperationMetadata; + export interface Schema$GoogleCloudDocumentaiV1beta3ProcessorTypeLocationInfo { /** - * The Crowd Compute question ID. + * The location ID. For supported locations, refer to [regional and multi-regional support](/document-ai/docs/regions). */ - questionId?: string | null; + locationId?: string | null; } /** - * Response message for the ReviewDocument method. + * 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. */ - export interface Schema$GoogleCloudDocumentaiV1ReviewDocumentResponse { + export interface Schema$GoogleCloudDocumentaiV1beta3ProcessorVersion { /** - * The Cloud Storage uri for the human reviewed document if the review is succeeded. + * Output only. The time the processor version was created. */ - gcsDestination?: string | null; + createTime?: string | null; /** - * The reason why the review is rejected by reviewer. + * Output only. If set, information about the eventual deprecation of this version. */ - rejectionReason?: string | null; + deprecationInfo?: Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionDeprecationInfo; /** - * The state of the review operation. + * The display name of the processor version. */ - state?: string | null; - } - /** - * The long-running operation metadata for the SetDefaultProcessorVersion method. - */ - export interface Schema$GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata { + displayName?: string | null; /** - * The basic metadata of the long-running operation. + * Output only. The schema of the processor version. Describes the output. */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1CommonOperationMetadata; - } - /** - * Response message for the SetDefaultProcessorVersion method. - */ - export interface Schema$GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse {} - /** - * The metadata that represents a processor version being created. - */ - export interface Schema$GoogleCloudDocumentaiV1TrainProcessorVersionMetadata { + documentSchema?: Schema$GoogleCloudDocumentaiV1beta3DocumentSchema; /** - * The basic metadata of the long-running operation. + * Output only. Information about Generative AI model-based processor versions. */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1CommonOperationMetadata; + genAiModelInfo?: Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo; /** - * The test dataset validation information. + * Output only. Denotes that this `ProcessorVersion` is managed by Google. */ - testDatasetValidation?: Schema$GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation; + googleManaged?: boolean | null; /** - * The training dataset validation information. + * Output only. The KMS key name used for encryption. */ - trainingDatasetValidation?: Schema$GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation; - } - /** - * The dataset validation information. This includes any and all errors with documents and the dataset. - */ - export interface Schema$GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation { + kmsKeyName?: string | null; /** - * The total number of dataset errors. + * Output only. The KMS key version with which data is encrypted. */ - datasetErrorCount?: number | null; + kmsKeyVersionName?: string | null; /** - * Error information for the dataset as a whole. A maximum of 10 dataset errors will be returned. A single dataset error is terminal for training. + * Output only. The most recently invoked evaluation for the processor version. */ - datasetErrors?: Schema$GoogleRpcStatus[]; + latestEvaluation?: Schema$GoogleCloudDocumentaiV1beta3EvaluationReference; /** - * The total number of document errors. + * Output only. The model type of this processor version. */ - documentErrorCount?: number | null; + modelType?: string | null; /** - * Error information pertaining to specific documents. A maximum of 10 document errors will be returned. Any document with errors will not be used throughout training. + * Identifier. The resource name of the processor version. Format: `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processor_version\}` */ - documentErrors?: Schema$GoogleRpcStatus[]; + name?: string | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; + /** + * Output only. The state of the processor version. + */ + state?: string | null; } /** - * The response for TrainProcessorVersion. + * Contains the alias and the aliased resource name of processor version. */ - export interface Schema$GoogleCloudDocumentaiV1TrainProcessorVersionResponse { + export interface Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionAlias { /** - * The resource name of the processor version produced by training. + * The alias in the form of `processor_version` resource name. + */ + alias?: string | null; + /** + * The resource name of aliased processor version. */ processorVersion?: string | null; } /** - * The long-running operation metadata for the UndeployProcessorVersion method. + * Information about the upcoming deprecation of this processor version. */ - export interface Schema$GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata { + export interface Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionDeprecationInfo { /** - * The basic metadata of the long-running operation. + * The time at which this processor version will be deprecated. */ - commonMetadata?: Schema$GoogleCloudDocumentaiV1CommonOperationMetadata; + deprecationTime?: string | null; + /** + * If set, the processor version that will be used as a replacement. + */ + replacementProcessorVersion?: string | null; } /** - * Response message for the UndeployProcessorVersion method. - */ - export interface Schema$GoogleCloudDocumentaiV1UndeployProcessorVersionResponse {} - /** - * The response message for Locations.ListLocations. + * Information about Generative AI model-based processor versions. */ - export interface Schema$GoogleCloudLocationListLocationsResponse { + export interface Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo { /** - * A list of locations that matches the specified filter in the request. + * Information for a custom Generative AI model created by the user. */ - locations?: Schema$GoogleCloudLocationLocation[]; + customGenAiModelInfo?: Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo; /** - * The standard List next-page token. + * Information for a pretrained Google-managed foundation model. */ - nextPageToken?: string | null; + foundationGenAiModelInfo?: Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo; } /** - * A resource that represents a Google Cloud location. + * Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs. */ - export interface Schema$GoogleCloudLocationLocation { - /** - * The friendly name for this location, typically a nearby city name. For example, "Tokyo". - */ - displayName?: string | null; + export interface Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo { /** - * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"\} + * The base processor version ID for the custom model. */ - labels?: {[key: string]: string} | null; + baseProcessorVersionId?: string | null; /** - * The canonical id for this location. For example: `"us-east1"`. + * The type of custom model created by the user. */ - locationId?: string | null; + customModelType?: string | null; + } + /** + * Information for a pretrained Google-managed foundation model. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo { /** - * Service-specific metadata. For example the available capacity at the given location. + * Whether finetuning is allowed for this base processor version. */ - metadata?: {[key: string]: any} | null; + finetuningAllowed?: boolean | null; /** - * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` + * The minimum number of labeled documents in the training dataset required for finetuning. */ - name?: string | null; + minTrainLabeledDocuments?: number | null; } /** - * The response message for Operations.ListOperations. + * Request message for the ProcessDocument method. */ - export interface Schema$GoogleLongrunningListOperationsResponse { + export interface Schema$GoogleCloudDocumentaiV1beta3ProcessRequest { /** - * The standard List next-page token. + * The document payload, the content and mime_type fields must be set. */ - nextPageToken?: string | null; + document?: Schema$GoogleCloudDocumentaiV1beta3Document; /** - * A list of operations that matches the specified filter in the request. + * Specifies which fields to include in the ProcessResponse.document output. Only supports top-level document and pages field, so it must be in the form of `{document_field_name\}` or `pages.{page_field_name\}`. */ - operations?: Schema$GoogleLongrunningOperation[]; + fieldMask?: string | null; /** - * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + * A raw document on Google Cloud Storage. */ - unreachable?: string[] | null; - } - /** - * This resource represents a long-running operation that is the result of a network API call. - */ - export interface Schema$GoogleLongrunningOperation { + gcsDocument?: Schema$GoogleCloudDocumentaiV1beta3GcsDocument; /** - * 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. + * Optional. Option to remove images from the document. */ - done?: boolean | null; + imagelessMode?: boolean | null; /** - * The error result of the operation in case of failure or cancellation. + * An inline document proto. */ - error?: Schema$GoogleRpcStatus; + inlineDocument?: Schema$GoogleCloudDocumentaiV1beta3Document; /** - * 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. + * Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. */ - metadata?: {[key: string]: any} | null; + labels?: {[key: string]: string} | null; /** - * 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\}`. + * Inference-time options for the process API */ - name?: string | null; + processOptions?: Schema$GoogleCloudDocumentaiV1beta3ProcessOptions; /** - * 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 raw document content (bytes). */ - response?: {[key: string]: any} | null; + rawDocument?: Schema$GoogleCloudDocumentaiV1beta3RawDocument; + /** + * Whether human review should be skipped for this request. Default to `false`. + */ + skipHumanReview?: boolean | null; } /** - * 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); \} - */ - export interface Schema$GoogleProtobufEmpty {} - /** - * 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). + * Response message for the ProcessDocument method. */ - export interface Schema$GoogleRpcStatus { + export interface Schema$GoogleCloudDocumentaiV1beta3ProcessResponse { /** - * The status code, which should be an enum value of google.rpc.Code. + * The document payload, will populate fields based on the processor's behavior. */ - code?: number | null; + document?: Schema$GoogleCloudDocumentaiV1beta3Document; /** - * A list of messages that carry the error details. There is a common set of message types for APIs to use. + * The name of the operation triggered by the processed document. If the human review process isn't triggered, this field is empty. It has the same response type and metadata as the long-running operation returned by ReviewDocument. */ - details?: Array<{[key: string]: any}> | null; + humanReviewOperation?: string | null; /** - * 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. + * The status of human review on the processed document. */ - message?: string | null; + humanReviewStatus?: Schema$GoogleCloudDocumentaiV1beta3HumanReviewStatus; } /** - * Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); \} public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); \} return resultBuilder.build(); \} // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; \} return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; \} static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; \} Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; \} [result autorelease]; return result; \} // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); \} var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); \}; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); \} resultBuilder.push(hexString); return resultBuilder.join(''); \}; // ... + * Metadata about a property. */ - export interface Schema$GoogleTypeColor { + export interface Schema$GoogleCloudDocumentaiV1beta3PropertyMetadata { /** - * The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0). + * Field extraction metadata on the property. */ - alpha?: number | null; + fieldExtractionMetadata?: Schema$GoogleCloudDocumentaiV1beta3FieldExtractionMetadata; /** - * The amount of blue in the color as a value in the interval [0, 1]. + * Whether the property should be considered as "inactive". */ - blue?: number | null; + inactive?: boolean | null; + } + /** + * Payload message of raw document content (bytes). + */ + export interface Schema$GoogleCloudDocumentaiV1beta3RawDocument { /** - * The amount of green in the color as a value in the interval [0, 1]. + * Inline document content. */ - green?: number | null; + content?: string | null; /** - * The amount of red in the color as a value in the interval [0, 1]. + * The display name of the document, it supports all Unicode characters except the following: `*`, `?`, `[`, `]`, `%`, `{`, `\}`,`'`, `\"`, `,` `~`, `=` and `:` are reserved. If not specified, a default ID is generated. */ - red?: number | null; + displayName?: string | null; + /** + * An IANA MIME type (RFC6838) indicating the nature and format of the content. + */ + mimeType?: string | null; } /** - * Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp + * Specifies a set of raw documents. */ - export interface Schema$GoogleTypeDate { + export interface Schema$GoogleCloudDocumentaiV1beta3RawDocuments { /** - * Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + * Specifies raw document content and mime type. */ - day?: number | null; + documents?: Schema$GoogleCloudDocumentaiV1beta3RawDocument[]; + } + /** + * The long-running operation metadata for the ReviewDocument method. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata { /** - * Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + * The basic metadata of the long-running operation. */ - month?: number | null; + commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; /** - * Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + * The creation time of the operation. */ - year?: number | null; + createTime?: string | null; + /** + * The Crowd Compute question ID. + */ + questionId?: string | null; + /** + * Used only when Operation.done is false. + */ + state?: string | null; + /** + * A message providing more details about the current state of processing. For example, the error message if the operation is failed. + */ + stateMessage?: string | null; + /** + * The last update time of the operation. + */ + updateTime?: string | null; } /** - * Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. + * Request message for the ReviewDocument method. */ - export interface Schema$GoogleTypeDateTime { - /** - * Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day. - */ - day?: number | null; + export interface Schema$GoogleCloudDocumentaiV1beta3ReviewDocumentRequest { /** - * Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time. + * The document that needs human review. */ - hours?: number | null; + document?: Schema$GoogleCloudDocumentaiV1beta3Document; /** - * Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0. + * The document schema of the human review task. */ - minutes?: number | null; + documentSchema?: Schema$GoogleCloudDocumentaiV1beta3DocumentSchema; /** - * Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month. + * Whether the validation should be performed on the ad-hoc review request. */ - month?: number | null; + enableSchemaValidation?: boolean | null; /** - * Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0. + * An inline document proto. */ - nanos?: number | null; + inlineDocument?: Schema$GoogleCloudDocumentaiV1beta3Document; /** - * Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds. + * The priority of the human review task. */ - seconds?: number | null; + priority?: string | null; + } + /** + * Response message for the ReviewDocument method. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3ReviewDocumentResponse { /** - * Time zone. + * The Cloud Storage uri for the human reviewed document if the review is succeeded. */ - timeZone?: Schema$GoogleTypeTimeZone; + gcsDestination?: string | null; /** - * UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 \}. + * The reason why the review is rejected by reviewer. */ - utcOffset?: string | null; + rejectionReason?: string | null; /** - * Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. + * The state of the review operation. */ - year?: number | null; + state?: string | null; } /** - * Represents an amount of money with its currency type. + * The revision reference specifies which revision on the document to read. */ - export interface Schema$GoogleTypeMoney { + export interface Schema$GoogleCloudDocumentaiV1beta3RevisionRef { /** - * The three-letter currency code defined in ISO 4217. + * Reads the revision generated by the processor version. The format takes the full resource name of processor version. `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` */ - currencyCode?: string | null; + latestProcessorVersion?: string | null; /** - * Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. + * Reads the revision by the predefined case. */ - nanos?: number | null; + revisionCase?: string | null; /** - * The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. + * Reads the revision given by the id. */ - units?: string | null; + revisionId?: string | null; } /** - * Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. + * The history of schema generation iterations. */ - export interface Schema$GoogleTypePostalAddress { + export interface Schema$GoogleCloudDocumentaiV1beta3SchemaGenerationHistory { /** - * Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). + * Required. Previous prompt-answers in a chronological order. */ - addressLines?: string[] | null; + iterations?: Schema$GoogleCloudDocumentaiV1beta3SchemaGenerationIteration[]; + } + /** + * A single iteration of the schema generation. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3SchemaGenerationIteration { /** - * Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated. + * Optional. The previous schema version adjusted by the model. */ - administrativeArea?: string | null; + adjustedSchema?: Schema$GoogleCloudDocumentaiV1beta3SchemaVersion; /** - * Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en". + * Required. The schema version generated by the model. */ - languageCode?: string | null; + generatedSchema?: Schema$GoogleCloudDocumentaiV1beta3SchemaVersion; /** - * Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`. + * Optional. The prompt used for the iteration. */ - locality?: string | null; + prompt?: string | null; + } + /** + * SchemaVersion is a version of the Schema which is created in SchemaGroup. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3SchemaVersion { /** - * Optional. The name of the organization at the address. + * Output only. The time when the SchemaVersion was created. */ - organization?: string | null; + createTime?: string | null; /** - * Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States). + * Optional. The user-defined name of the SchemaVersion. */ - postalCode?: string | null; + displayName?: string | null; /** - * Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information. + * Optional. The GCP labels for the SchemaVersion. */ - recipients?: string[] | null; + labels?: {[key: string]: string} | null; /** - * Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. + * Identifier. The resource name of the SchemaVersion. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}/schemaVersions/{schema_version\}` */ - regionCode?: string | null; + name?: string | null; /** - * The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions. + * Required. The schema of the SchemaVersion. */ - revision?: number | null; + schema?: Schema$GoogleCloudDocumentaiV1beta3DocumentSchema; + } + /** + * The long-running operation metadata for the SetDefaultProcessorVersion method. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata { /** - * Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire). + * The basic metadata of the long-running operation. */ - sortingCode?: string | null; + commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; + } + /** + * Request message for the SetDefaultProcessorVersion method. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionRequest { /** - * Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district. + * Required. The resource name of child ProcessorVersion to use as default. Format: `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{version\}` */ - sublocality?: string | null; + defaultProcessorVersion?: string | null; } /** - * Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). + * Response message for the SetDefaultProcessorVersion method. */ - export interface Schema$GoogleTypeTimeZone { + export interface Schema$GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionResponse {} + /** + * Metadata for document summarization. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3SummaryOptions { /** - * IANA Time Zone Database time zone. For example "America/New_York". + * The format the summary should be in. */ - id?: string | null; + format?: string | null; /** - * Optional. IANA Time Zone Database version number. For example "2019a". + * How long the summary should be. + */ + length?: string | null; + } + /** + * The metadata that represents a processor version being created. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata { + /** + * The basic metadata of the long-running operation. + */ + commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; + /** + * The test dataset validation information. + */ + testDatasetValidation?: Schema$GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation; + /** + * The training dataset validation information. + */ + trainingDatasetValidation?: Schema$GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation; + } + /** + * The dataset validation information. This includes any and all errors with documents and the dataset. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadataDatasetValidation { + /** + * The total number of dataset errors. + */ + datasetErrorCount?: number | null; + /** + * Error information for the dataset as a whole. A maximum of 10 dataset errors will be returned. A single dataset error is terminal for training. + */ + datasetErrors?: Schema$GoogleRpcStatus[]; + /** + * The total number of document errors. + */ + documentErrorCount?: number | null; + /** + * Error information pertaining to specific documents. A maximum of 10 document errors will be returned. Any document with errors will not be used throughout training. + */ + documentErrors?: Schema$GoogleRpcStatus[]; + } + /** + * Request message for the TrainProcessorVersion method. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequest { + /** + * Optional. The processor version to use as a base for training. This processor version must be a child of `parent`. Format: `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}`. + */ + baseProcessorVersion?: string | null; + /** + * Options to control Custom Document Extraction (CDE) Processor. + */ + customDocumentExtractionOptions?: Schema$GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequestCustomDocumentExtractionOptions; + /** + * Optional. The schema the processor version will be trained with. + */ + documentSchema?: Schema$GoogleCloudDocumentaiV1beta3DocumentSchema; + /** + * Options to control foundation model tuning of a processor. + */ + foundationModelTuningOptions?: Schema$GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequestFoundationModelTuningOptions; + /** + * Optional. The input data used to train the ProcessorVersion. + */ + inputData?: Schema$GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequestInputData; + /** + * Required. The processor version to be created. + */ + processorVersion?: Schema$GoogleCloudDocumentaiV1beta3ProcessorVersion; + } + /** + * Options to control the training of the Custom Document Extraction (CDE) Processor. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequestCustomDocumentExtractionOptions { + /** + * Optional. Training method to use for CDE training. + */ + trainingMethod?: string | null; + } + /** + * Options to control foundation model tuning of the processor. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequestFoundationModelTuningOptions { + /** + * Optional. The multiplier to apply to the recommended learning rate. Valid values are between 0.1 and 10. If not provided, recommended learning rate will be used. + */ + learningRateMultiplier?: number | null; + /** + * Optional. The number of steps to run for model tuning. Valid values are between 1 and 400. If not provided, recommended steps will be used. + */ + trainSteps?: number | null; + } + /** + * The input data used to train a new ProcessorVersion. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequestInputData { + /** + * The documents used for testing the trained version. + */ + testDocuments?: Schema$GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig; + /** + * The documents used for training the new version. + */ + trainingDocuments?: Schema$GoogleCloudDocumentaiV1beta3BatchDocumentsInputConfig; + } + /** + * The response for TrainProcessorVersion. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3TrainProcessorVersionResponse { + /** + * The resource name of the processor version produced by training. + */ + processorVersion?: string | null; + } + /** + * The long-running operation metadata for the UndeployProcessorVersion method. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3UndeployProcessorVersionMetadata { + /** + * The basic metadata of the long-running operation. + */ + commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; + } + /** + * Request message for the UndeployProcessorVersion method. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3UndeployProcessorVersionRequest {} + /** + * Response message for the UndeployProcessorVersion method. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3UndeployProcessorVersionResponse {} + export interface Schema$GoogleCloudDocumentaiV1beta3UpdateDatasetOperationMetadata { + /** + * The basic metadata of the long-running operation. + */ + commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; + } + /** + * The long-running operation metadata for the UpdateProcessorVersion method. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3UpdateProcessorVersionMetadata { + /** + * The basic metadata for the long-running operation. + */ + commonMetadata?: Schema$GoogleCloudDocumentaiV1beta3CommonOperationMetadata; + } + /** + * A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3Vertex { + /** + * X coordinate. + */ + x?: number | null; + /** + * Y coordinate (starts from the top of the image). + */ + y?: number | null; + } + /** + * The common metadata for long running operations. + */ + export interface Schema$GoogleCloudDocumentaiV1CommonOperationMetadata { + /** + * The creation time of the operation. + */ + createTime?: string | null; + /** + * A related resource to this operation. + */ + resource?: string | null; + /** + * The state of the operation. + */ + state?: string | null; + /** + * A message providing more details about the current state of processing. + */ + stateMessage?: string | null; + /** + * The last update time of the operation. + */ + updateTime?: string | null; + } + /** + * The long-running operation metadata for the DeleteProcessor method. + */ + export interface Schema$GoogleCloudDocumentaiV1DeleteProcessorMetadata { + /** + * The basic metadata of the long-running operation. + */ + commonMetadata?: Schema$GoogleCloudDocumentaiV1CommonOperationMetadata; + } + /** + * The long-running operation metadata for the DeleteProcessorVersion method. + */ + export interface Schema$GoogleCloudDocumentaiV1DeleteProcessorVersionMetadata { + /** + * The basic metadata of the long-running operation. + */ + commonMetadata?: Schema$GoogleCloudDocumentaiV1CommonOperationMetadata; + } + /** + * The long-running operation metadata for the DeployProcessorVersion method. + */ + export interface Schema$GoogleCloudDocumentaiV1DeployProcessorVersionMetadata { + /** + * The basic metadata of the long-running operation. + */ + commonMetadata?: Schema$GoogleCloudDocumentaiV1CommonOperationMetadata; + } + /** + * Response message for the DeployProcessorVersion method. + */ + export interface Schema$GoogleCloudDocumentaiV1DeployProcessorVersionResponse {} + /** + * The long-running operation metadata for the DisableProcessor method. + */ + export interface Schema$GoogleCloudDocumentaiV1DisableProcessorMetadata { + /** + * The basic metadata of the long-running operation. + */ + commonMetadata?: Schema$GoogleCloudDocumentaiV1CommonOperationMetadata; + } + /** + * Response message for the DisableProcessor method. Intentionally empty proto for adding fields in future. + */ + export interface Schema$GoogleCloudDocumentaiV1DisableProcessorResponse {} + /** + * The long-running operation metadata for the EnableProcessor method. + */ + export interface Schema$GoogleCloudDocumentaiV1EnableProcessorMetadata { + /** + * The basic metadata of the long-running operation. + */ + commonMetadata?: Schema$GoogleCloudDocumentaiV1CommonOperationMetadata; + } + /** + * Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future. + */ + export interface Schema$GoogleCloudDocumentaiV1EnableProcessorResponse {} + /** + * Metadata of the EvaluateProcessorVersion method. + */ + export interface Schema$GoogleCloudDocumentaiV1EvaluateProcessorVersionMetadata { + /** + * The basic metadata of the long-running operation. + */ + commonMetadata?: Schema$GoogleCloudDocumentaiV1CommonOperationMetadata; + } + /** + * Response of the EvaluateProcessorVersion method. + */ + export interface Schema$GoogleCloudDocumentaiV1EvaluateProcessorVersionResponse { + /** + * The resource name of the created evaluation. + */ + evaluation?: string | null; + } + /** + * The status of human review on a processed document. + */ + export interface Schema$GoogleCloudDocumentaiV1HumanReviewStatus { + /** + * The name of the operation triggered by the processed document. This field is populated only when the state is `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as the long-running operation returned by ReviewDocument. + */ + humanReviewOperation?: string | null; + /** + * The state of human review on the processing request. + */ + state?: string | null; + /** + * A message providing more details about the human review state. + */ + stateMessage?: string | null; + } + /** + * The long-running operation metadata for the ReviewDocument method. + */ + export interface Schema$GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata { + /** + * The basic metadata of the long-running operation. + */ + commonMetadata?: Schema$GoogleCloudDocumentaiV1CommonOperationMetadata; + /** + * The Crowd Compute question ID. + */ + questionId?: string | null; + } + /** + * Response message for the ReviewDocument method. + */ + export interface Schema$GoogleCloudDocumentaiV1ReviewDocumentResponse { + /** + * The Cloud Storage uri for the human reviewed document if the review is succeeded. + */ + gcsDestination?: string | null; + /** + * The reason why the review is rejected by reviewer. + */ + rejectionReason?: string | null; + /** + * The state of the review operation. + */ + state?: string | null; + } + /** + * The long-running operation metadata for the SetDefaultProcessorVersion method. + */ + export interface Schema$GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata { + /** + * The basic metadata of the long-running operation. + */ + commonMetadata?: Schema$GoogleCloudDocumentaiV1CommonOperationMetadata; + } + /** + * Response message for the SetDefaultProcessorVersion method. + */ + export interface Schema$GoogleCloudDocumentaiV1SetDefaultProcessorVersionResponse {} + /** + * The metadata that represents a processor version being created. + */ + export interface Schema$GoogleCloudDocumentaiV1TrainProcessorVersionMetadata { + /** + * The basic metadata of the long-running operation. + */ + commonMetadata?: Schema$GoogleCloudDocumentaiV1CommonOperationMetadata; + /** + * The test dataset validation information. + */ + testDatasetValidation?: Schema$GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation; + /** + * The training dataset validation information. + */ + trainingDatasetValidation?: Schema$GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation; + } + /** + * The dataset validation information. This includes any and all errors with documents and the dataset. + */ + export interface Schema$GoogleCloudDocumentaiV1TrainProcessorVersionMetadataDatasetValidation { + /** + * The total number of dataset errors. + */ + datasetErrorCount?: number | null; + /** + * Error information for the dataset as a whole. A maximum of 10 dataset errors will be returned. A single dataset error is terminal for training. + */ + datasetErrors?: Schema$GoogleRpcStatus[]; + /** + * The total number of document errors. + */ + documentErrorCount?: number | null; + /** + * Error information pertaining to specific documents. A maximum of 10 document errors will be returned. Any document with errors will not be used throughout training. + */ + documentErrors?: Schema$GoogleRpcStatus[]; + } + /** + * The response for TrainProcessorVersion. + */ + export interface Schema$GoogleCloudDocumentaiV1TrainProcessorVersionResponse { + /** + * The resource name of the processor version produced by training. + */ + processorVersion?: string | null; + } + /** + * The long-running operation metadata for the UndeployProcessorVersion method. + */ + export interface Schema$GoogleCloudDocumentaiV1UndeployProcessorVersionMetadata { + /** + * The basic metadata of the long-running operation. + */ + commonMetadata?: Schema$GoogleCloudDocumentaiV1CommonOperationMetadata; + } + /** + * Response message for the UndeployProcessorVersion method. + */ + export interface Schema$GoogleCloudDocumentaiV1UndeployProcessorVersionResponse {} + /** + * The response message for Locations.ListLocations. + */ + export interface Schema$GoogleCloudLocationListLocationsResponse { + /** + * A list of locations that matches the specified filter in the request. + */ + locations?: Schema$GoogleCloudLocationLocation[]; + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + } + /** + * A resource that represents a Google Cloud location. + */ + export interface Schema$GoogleCloudLocationLocation { + /** + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". + */ + displayName?: string | null; + /** + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"\} + */ + labels?: {[key: string]: string} | null; + /** + * The canonical id for this location. For example: `"us-east1"`. + */ + locationId?: string | null; + /** + * Service-specific metadata. For example the available capacity at the given location. + */ + metadata?: {[key: string]: any} | null; + /** + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` + */ + name?: string | null; + } + /** + * The response message for Operations.ListOperations. + */ + export interface Schema$GoogleLongrunningListOperationsResponse { + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + /** + * A list of operations that matches the specified filter in the request. + */ + operations?: Schema$GoogleLongrunningOperation[]; + /** + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; + } + /** + * This resource represents a long-running operation that is the result of a network API call. + */ + export interface Schema$GoogleLongrunningOperation { + /** + * 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. + */ + done?: boolean | null; + /** + * The error result of the operation in case of failure or cancellation. + */ + error?: Schema$GoogleRpcStatus; + /** + * 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. + */ + metadata?: {[key: string]: any} | null; + /** + * 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\}`. + */ + name?: string | null; + /** + * 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`. + */ + response?: {[key: string]: any} | null; + } + /** + * 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); \} + */ + export interface Schema$GoogleProtobufEmpty {} + /** + * 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). + */ + export interface Schema$GoogleRpcStatus { + /** + * The status code, which should be an enum value of google.rpc.Code. + */ + code?: number | null; + /** + * A list of messages that carry the error details. There is a common set of message types for APIs to use. + */ + details?: Array<{[key: string]: any}> | null; + /** + * 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. + */ + message?: string | null; + } + /** + * Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); \} public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); \} return resultBuilder.build(); \} // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; \} return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; \} static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; \} Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; \} [result autorelease]; return result; \} // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); \} var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); \}; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); \} resultBuilder.push(hexString); return resultBuilder.join(''); \}; // ... + */ + export interface Schema$GoogleTypeColor { + /** + * The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0). + */ + alpha?: number | null; + /** + * The amount of blue in the color as a value in the interval [0, 1]. + */ + blue?: number | null; + /** + * The amount of green in the color as a value in the interval [0, 1]. + */ + green?: number | null; + /** + * The amount of red in the color as a value in the interval [0, 1]. + */ + red?: number | null; + } + /** + * Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp + */ + export interface Schema$GoogleTypeDate { + /** + * Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + */ + day?: number | null; + /** + * Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + */ + month?: number | null; + /** + * Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + */ + year?: number | null; + } + /** + * Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. + */ + export interface Schema$GoogleTypeDateTime { + /** + * Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day. + */ + day?: number | null; + /** + * Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time. + */ + hours?: number | null; + /** + * Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0. + */ + minutes?: number | null; + /** + * Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month. + */ + month?: number | null; + /** + * Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0. + */ + nanos?: number | null; + /** + * Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds. + */ + seconds?: number | null; + /** + * Time zone. + */ + timeZone?: Schema$GoogleTypeTimeZone; + /** + * UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 \}. + */ + utcOffset?: string | null; + /** + * Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. + */ + year?: number | null; + } + /** + * Represents an amount of money with its currency type. + */ + export interface Schema$GoogleTypeMoney { + /** + * The three-letter currency code defined in ISO 4217. + */ + currencyCode?: string | null; + /** + * Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. + */ + nanos?: number | null; + /** + * The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. + */ + units?: string | null; + } + /** + * Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. + */ + export interface Schema$GoogleTypePostalAddress { + /** + * Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). + */ + addressLines?: string[] | null; + /** + * Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated. + */ + administrativeArea?: string | null; + /** + * Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en". + */ + languageCode?: string | null; + /** + * Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`. + */ + locality?: string | null; + /** + * Optional. The name of the organization at the address. + */ + organization?: string | null; + /** + * Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States). + */ + postalCode?: string | null; + /** + * Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information. + */ + recipients?: string[] | null; + /** + * Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. + */ + regionCode?: string | null; + /** + * The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions. + */ + revision?: number | null; + /** + * Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire). + */ + sortingCode?: string | null; + /** + * Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district. + */ + sublocality?: string | null; + } + /** + * Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). + */ + export interface Schema$GoogleTypeTimeZone { + /** + * IANA Time Zone Database time zone. For example "America/New_York". + */ + id?: string | null; + /** + * Optional. IANA Time Zone Database version number. For example "2019a". + */ + version?: string | null; + } + + export class Resource$Projects { + context: APIRequestContext; + locations: Resource$Projects$Locations; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Projects$Locations(this.context); + } + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + operations: Resource$Projects$Locations$Operations; + processors: Resource$Projects$Locations$Processors; + processorTypes: Resource$Projects$Locations$Processortypes; + schemas: Resource$Projects$Locations$Schemas; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Projects$Locations$Operations( + this.context + ); + this.processors = new Resource$Projects$Locations$Processors( + this.context + ); + this.processorTypes = new Resource$Projects$Locations$Processortypes( + this.context + ); + this.schemas = new Resource$Projects$Locations$Schemas(this.context); + } + + /** + * Fetches processor types. Note that we don't use ListProcessorTypes here, because it isn't paginated. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/documentai.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const documentai = google.documentai('v1beta3'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await documentai.projects.locations.fetchProcessorTypes({ + * // Required. The location of processor types to list. Format: `projects/{project\}/locations/{location\}`. + * parent: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "processorTypes": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + fetchProcessorTypes( + params: Params$Resource$Projects$Locations$Fetchprocessortypes, + options: StreamMethodOptions + ): Promise>; + fetchProcessorTypes( + params?: Params$Resource$Projects$Locations$Fetchprocessortypes, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + fetchProcessorTypes( + params: Params$Resource$Projects$Locations$Fetchprocessortypes, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchProcessorTypes( + params: Params$Resource$Projects$Locations$Fetchprocessortypes, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchProcessorTypes( + params: Params$Resource$Projects$Locations$Fetchprocessortypes, + callback: BodyResponseCallback + ): void; + fetchProcessorTypes( + callback: BodyResponseCallback + ): void; + fetchProcessorTypes( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Fetchprocessortypes + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Fetchprocessortypes; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Fetchprocessortypes; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://documentai.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta3/{+parent}:fetchProcessorTypes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets information about a location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/documentai.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const documentai = google.documentai('v1beta3'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await documentai.projects.locations.get({ + * // Resource name for the location. + * name: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "displayName": "my_displayName", + * // "labels": {}, + * // "locationId": "my_locationId", + * // "metadata": {}, + * // "name": "my_name" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://documentai.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta3/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists information about the supported locations for this service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/documentai.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const documentai = google.documentai('v1beta3'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await documentai.projects.locations.list({ + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * extraLocationTypes: 'placeholder-value', + * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). + * filter: 'placeholder-value', + * // The resource that owns the locations collection, if applicable. + * name: 'projects/my-project', + * // The maximum number of results to return. If not set, the service selects a default. + * pageSize: 'placeholder-value', + * // A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. + * pageToken: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "locations": [], + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://documentai.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta3/{+name}/locations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Fetchprocessortypes + extends StandardParameters { + /** + * Required. The location of processor types to list. Format: `projects/{project\}/locations/{location\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Get + extends StandardParameters { + /** + * Resource name for the location. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$List + extends StandardParameters { + /** + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + */ + extraLocationTypes?: string[]; + /** + * A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). + */ + filter?: string; + /** + * The resource that owns the locations collection, if applicable. + */ + name?: string; + /** + * The maximum number of results to return. If not set, the service selects a default. + */ + pageSize?: number; + /** + * A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/documentai.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const documentai = google.documentai('v1beta3'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await documentai.projects.locations.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Projects$Locations$Operations$Cancel, + options?: MethodOptions + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://documentai.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta3/{+name}:cancel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/documentai.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const documentai = google.documentai('v1beta3'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await documentai.projects.locations.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Operations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Operations$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://documentai.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta3/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/documentai.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const documentai = google.documentai('v1beta3'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await documentai.projects.locations.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/operations', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Operations$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://documentai.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta3/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + + export class Resource$Projects$Locations$Processors { + context: APIRequestContext; + dataset: Resource$Projects$Locations$Processors$Dataset; + humanReviewConfig: Resource$Projects$Locations$Processors$Humanreviewconfig; + processorVersions: Resource$Projects$Locations$Processors$Processorversions; + constructor(context: APIRequestContext) { + this.context = context; + this.dataset = new Resource$Projects$Locations$Processors$Dataset( + this.context + ); + this.humanReviewConfig = + new Resource$Projects$Locations$Processors$Humanreviewconfig( + this.context + ); + this.processorVersions = + new Resource$Projects$Locations$Processors$Processorversions( + this.context + ); + } + + /** + * LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/documentai.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const documentai = google.documentai('v1beta3'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await documentai.projects.locations.processors.batchProcess({ + * // Required. The resource name of Processor or ProcessorVersion. Format: `projects/{project\}/locations/{location\}/processors/{processor\}`, or `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` + * name: 'projects/my-project/locations/my-location/processors/my-processor', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "documentOutputConfig": {}, + * // "inputConfigs": [], + * // "inputDocuments": {}, + * // "labels": {}, + * // "outputConfig": {}, + * // "processOptions": {}, + * // "skipHumanReview": false + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + batchProcess( + params: Params$Resource$Projects$Locations$Processors$Batchprocess, + options: StreamMethodOptions + ): Promise>; + batchProcess( + params?: Params$Resource$Projects$Locations$Processors$Batchprocess, + options?: MethodOptions + ): Promise>; + batchProcess( + params: Params$Resource$Projects$Locations$Processors$Batchprocess, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchProcess( + params: Params$Resource$Projects$Locations$Processors$Batchprocess, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchProcess( + params: Params$Resource$Projects$Locations$Processors$Batchprocess, + callback: BodyResponseCallback + ): void; + batchProcess( + callback: BodyResponseCallback + ): void; + batchProcess( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Processors$Batchprocess + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Processors$Batchprocess; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Processors$Batchprocess; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://documentai.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta3/{+name}:batchProcess').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a processor from the ProcessorType provided. The processor will be at `ENABLED` state by default after its creation. Note that this method requires the `documentai.processors.create` permission on the project, which is highly privileged. A user or service account with this permission can create new processors that can interact with any gcs bucket in your project. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/documentai.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const documentai = google.documentai('v1beta3'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await documentai.projects.locations.processors.create({ + * // Required. The parent (project and location) under which to create the processor. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "activeSchemaVersion": "my_activeSchemaVersion", + * // "createTime": "my_createTime", + * // "defaultProcessorVersion": "my_defaultProcessorVersion", + * // "displayName": "my_displayName", + * // "kmsKeyName": "my_kmsKeyName", + * // "name": "my_name", + * // "processEndpoint": "my_processEndpoint", + * // "processorVersionAliases": [], + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "state": "my_state", + * // "type": "my_type" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "activeSchemaVersion": "my_activeSchemaVersion", + * // "createTime": "my_createTime", + * // "defaultProcessorVersion": "my_defaultProcessorVersion", + * // "displayName": "my_displayName", + * // "kmsKeyName": "my_kmsKeyName", + * // "name": "my_name", + * // "processEndpoint": "my_processEndpoint", + * // "processorVersionAliases": [], + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "state": "my_state", + * // "type": "my_type" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Processors$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Processors$Create, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Processors$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Processors$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Processors$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Processors$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Processors$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Processors$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://documentai.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta3/{+parent}/processors').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Deletes the processor, unloads all deployed model artifacts if it was enabled and then deletes all artifacts associated with this processor. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/documentai.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const documentai = google.documentai('v1beta3'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await documentai.projects.locations.processors.delete({ + * // Required. The processor resource name to be deleted. + * name: 'projects/my-project/locations/my-location/processors/my-processor', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Processors$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Processors$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Processors$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Processors$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Processors$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Processors$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Processors$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Processors$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://documentai.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta3/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Disables a processor + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/documentai.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const documentai = google.documentai('v1beta3'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await documentai.projects.locations.processors.disable({ + * // Required. The processor resource name to be disabled. + * name: 'projects/my-project/locations/my-location/processors/my-processor', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + disable( + params: Params$Resource$Projects$Locations$Processors$Disable, + options: StreamMethodOptions + ): Promise>; + disable( + params?: Params$Resource$Projects$Locations$Processors$Disable, + options?: MethodOptions + ): Promise>; + disable( + params: Params$Resource$Projects$Locations$Processors$Disable, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + disable( + params: Params$Resource$Projects$Locations$Processors$Disable, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + disable( + params: Params$Resource$Projects$Locations$Processors$Disable, + callback: BodyResponseCallback + ): void; + disable( + callback: BodyResponseCallback + ): void; + disable( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Processors$Disable + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Processors$Disable; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Processors$Disable; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://documentai.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta3/{+name}:disable').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Enables a processor + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/documentai.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const documentai = google.documentai('v1beta3'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await documentai.projects.locations.processors.enable({ + * // Required. The processor resource name to be enabled. + * name: 'projects/my-project/locations/my-location/processors/my-processor', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. */ - version?: string | null; - } + enable( + params: Params$Resource$Projects$Locations$Processors$Enable, + options: StreamMethodOptions + ): Promise>; + enable( + params?: Params$Resource$Projects$Locations$Processors$Enable, + options?: MethodOptions + ): Promise>; + enable( + params: Params$Resource$Projects$Locations$Processors$Enable, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + enable( + params: Params$Resource$Projects$Locations$Processors$Enable, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + enable( + params: Params$Resource$Projects$Locations$Processors$Enable, + callback: BodyResponseCallback + ): void; + enable( + callback: BodyResponseCallback + ): void; + enable( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Processors$Enable + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Processors$Enable; + let options = (optionsOrCallback || {}) as MethodOptions; - export class Resource$Projects { - context: APIRequestContext; - locations: Resource$Projects$Locations; - constructor(context: APIRequestContext) { - this.context = context; - this.locations = new Resource$Projects$Locations(this.context); - } - } + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Processors$Enable; + options = {}; + } - export class Resource$Projects$Locations { - context: APIRequestContext; - operations: Resource$Projects$Locations$Operations; - processors: Resource$Projects$Locations$Processors; - processorTypes: Resource$Projects$Locations$Processortypes; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = new Resource$Projects$Locations$Operations( - this.context - ); - this.processors = new Resource$Projects$Locations$Processors( - this.context - ); - this.processorTypes = new Resource$Projects$Locations$Processortypes( - this.context - ); + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://documentai.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta3/{+name}:enable').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } } /** - * Fetches processor types. Note that we don't use ListProcessorTypes here, because it isn't paginated. + * Gets a processor detail. * @example * ```js * // Before running the sample: @@ -4590,15 +7129,26 @@ export namespace documentai_v1beta3 { * google.options({auth: authClient}); * * // Do the magic - * const res = await documentai.projects.locations.fetchProcessorTypes({ - * // Required. The location of processor types to list. Format: `projects/{project\}/locations/{location\}`. - * parent: 'projects/my-project/locations/my-location', + * const res = await documentai.projects.locations.processors.get({ + * // Required. The processor resource name. + * name: 'projects/my-project/locations/my-location/processors/my-processor', * }); * console.log(res.data); * * // Example response * // { - * // "processorTypes": [] + * // "activeSchemaVersion": "my_activeSchemaVersion", + * // "createTime": "my_createTime", + * // "defaultProcessorVersion": "my_defaultProcessorVersion", + * // "displayName": "my_displayName", + * // "kmsKeyName": "my_kmsKeyName", + * // "name": "my_name", + * // "processEndpoint": "my_processEndpoint", + * // "processorVersionAliases": [], + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "state": "my_state", + * // "type": "my_type" * // } * } * @@ -4614,61 +7164,61 @@ export namespace documentai_v1beta3 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - fetchProcessorTypes( - params: Params$Resource$Projects$Locations$Fetchprocessortypes, + get( + params: Params$Resource$Projects$Locations$Processors$Get, options: StreamMethodOptions ): Promise>; - fetchProcessorTypes( - params?: Params$Resource$Projects$Locations$Fetchprocessortypes, + get( + params?: Params$Resource$Projects$Locations$Processors$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - fetchProcessorTypes( - params: Params$Resource$Projects$Locations$Fetchprocessortypes, + get( + params: Params$Resource$Projects$Locations$Processors$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - fetchProcessorTypes( - params: Params$Resource$Projects$Locations$Fetchprocessortypes, + get( + params: Params$Resource$Projects$Locations$Processors$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - fetchProcessorTypes( - params: Params$Resource$Projects$Locations$Fetchprocessortypes, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Processors$Get, + callback: BodyResponseCallback ): void; - fetchProcessorTypes( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - fetchProcessorTypes( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Fetchprocessortypes - | BodyResponseCallback + | Params$Resource$Projects$Locations$Processors$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Fetchprocessortypes; + {}) as Params$Resource$Projects$Locations$Processors$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Fetchprocessortypes; + params = {} as Params$Resource$Projects$Locations$Processors$Get; options = {}; } @@ -4681,34 +7231,31 @@ export namespace documentai_v1beta3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta3/{+parent}:fetchProcessorTypes').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1beta3/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets information about a location. + * Lists all processors which belong to this project. * @example * ```js * // Before running the sample: @@ -4735,21 +7282,22 @@ export namespace documentai_v1beta3 { * // Acquire an auth client, and bind it to all future calls * const authClient = await auth.getClient(); * google.options({auth: authClient}); - * - * // Do the magic - * const res = await documentai.projects.locations.get({ - * // Resource name for the location. - * name: 'projects/my-project/locations/my-location', + * + * // Do the magic + * const res = await documentai.projects.locations.processors.list({ + * // The maximum number of processors to return. If unspecified, at most `50` processors will be returned. The maximum value is `100`. Values above `100` will be coerced to `100`. + * pageSize: 'placeholder-value', + * // We will return the processors sorted by creation time. The page token will point to the next processor. + * pageToken: 'placeholder-value', + * // Required. The parent (project and location) which owns this collection of Processors. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', * }); * console.log(res.data); * * // Example response * // { - * // "displayName": "my_displayName", - * // "labels": {}, - * // "locationId": "my_locationId", - * // "metadata": {}, - * // "name": "my_name" + * // "nextPageToken": "my_nextPageToken", + * // "processors": [] * // } * } * @@ -4765,57 +7313,61 @@ export namespace documentai_v1beta3 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Get, + list( + params: Params$Resource$Projects$Locations$Processors$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Get, + list( + params?: Params$Resource$Projects$Locations$Processors$List, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Processors$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Get, + list( + params: Params$Resource$Projects$Locations$Processors$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Processors$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Processors$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Get; + {}) as Params$Resource$Projects$Locations$Processors$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Get; + params = {} as Params$Resource$Projects$Locations$Processors$List; options = {}; } @@ -4828,29 +7380,34 @@ export namespace documentai_v1beta3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta3/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta3/{+parent}/processors').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists information about the supported locations for this service. + * Processes a single document. * @example * ```js * // Before running the sample: @@ -4879,24 +7436,33 @@ export namespace documentai_v1beta3 { * google.options({auth: authClient}); * * // Do the magic - * const res = await documentai.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. - * extraLocationTypes: 'placeholder-value', - * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). - * filter: 'placeholder-value', - * // The resource that owns the locations collection, if applicable. - * name: 'projects/my-project', - * // The maximum number of results to return. If not set, the service selects a default. - * pageSize: 'placeholder-value', - * // A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. - * pageToken: 'placeholder-value', + * const res = await documentai.projects.locations.processors.process({ + * // Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: `projects/{project\}/locations/{location\}/processors/{processor\}`, or `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` + * name: 'projects/my-project/locations/my-location/processors/my-processor', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "document": {}, + * // "fieldMask": "my_fieldMask", + * // "gcsDocument": {}, + * // "imagelessMode": false, + * // "inlineDocument": {}, + * // "labels": {}, + * // "processOptions": {}, + * // "rawDocument": {}, + * // "skipHumanReview": false + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "locations": [], - * // "nextPageToken": "my_nextPageToken" + * // "document": {}, + * // "humanReviewOperation": "my_humanReviewOperation", + * // "humanReviewStatus": {} * // } * } * @@ -4912,61 +7478,61 @@ export namespace documentai_v1beta3 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$List, + process( + params: Params$Resource$Projects$Locations$Processors$Process, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$List, + process( + params?: Params$Resource$Projects$Locations$Processors$Process, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$List, + process( + params: Params$Resource$Projects$Locations$Processors$Process, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$List, + process( + params: Params$Resource$Projects$Locations$Processors$Process, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$List, - callback: BodyResponseCallback + process( + params: Params$Resource$Projects$Locations$Processors$Process, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + process( + callback: BodyResponseCallback ): void; - list( + process( paramsOrCallback?: - | Params$Resource$Projects$Locations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Processors$Process + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$List; + {}) as Params$Resource$Projects$Locations$Processors$Process; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$List; + params = {} as Params$Resource$Projects$Locations$Processors$Process; options = {}; } @@ -4979,11 +7545,11 @@ export namespace documentai_v1beta3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta3/{+name}/locations').replace( + url: (rootUrl + '/v1beta3/{+name}:process').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -4994,64 +7560,19 @@ export namespace documentai_v1beta3 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Fetchprocessortypes - extends StandardParameters { - /** - * Required. The location of processor types to list. Format: `projects/{project\}/locations/{location\}`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Get - extends StandardParameters { - /** - * Resource name for the location. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$List - extends StandardParameters { - /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. - */ - extraLocationTypes?: string[]; - /** - * A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). - */ - filter?: string; - /** - * The resource that owns the locations collection, if applicable. - */ - name?: string; - /** - * The maximum number of results to return. If not set, the service selects a default. - */ - pageSize?: number; - /** - * A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. - */ - pageToken?: string; - } - - export class Resource$Projects$Locations$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Set the default (active) version of a Processor that will be used in ProcessDocument and BatchProcessDocuments. * @example * ```js * // Before running the sample: @@ -5080,14 +7601,30 @@ export namespace documentai_v1beta3 { * google.options({auth: authClient}); * * // Do the magic - * const res = await documentai.projects.locations.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/operations/my-operation', - * }); + * const res = + * await documentai.projects.locations.processors.setDefaultProcessorVersion({ + * // Required. The resource name of the Processor to change default version. + * processor: + * 'projects/my-project/locations/my-location/processors/my-processor', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "defaultProcessorVersion": "my_defaultProcessorVersion" + * // } + * }, + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -5102,53 +7639,58 @@ export namespace documentai_v1beta3 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, + setDefaultProcessorVersion( + params: Params$Resource$Projects$Locations$Processors$Setdefaultprocessorversion, options: StreamMethodOptions - ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Operations$Cancel, + ): Promise>; + setDefaultProcessorVersion( + params?: Params$Resource$Projects$Locations$Processors$Setdefaultprocessorversion, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, + ): Promise>; + setDefaultProcessorVersion( + params: Params$Resource$Projects$Locations$Processors$Setdefaultprocessorversion, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + setDefaultProcessorVersion( + params: Params$Resource$Projects$Locations$Processors$Setdefaultprocessorversion, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, - callback: BodyResponseCallback + setDefaultProcessorVersion( + params: Params$Resource$Projects$Locations$Processors$Setdefaultprocessorversion, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + setDefaultProcessorVersion( + callback: BodyResponseCallback + ): void; + setDefaultProcessorVersion( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Processors$Setdefaultprocessorversion + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Processors$Setdefaultprocessorversion; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Cancel; + params = + {} as Params$Resource$Projects$Locations$Processors$Setdefaultprocessorversion; options = {}; } @@ -5161,32 +7703,31 @@ export namespace documentai_v1beta3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta3/{+name}:cancel').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1beta3/{+processor}:setDefaultProcessorVersion' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['processor'], + pathParams: ['processor'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Updates metadata associated with a dataset. Note that this method requires the `documentai.googleapis.com/datasets.update` permission on the project, which is highly privileged. A user or service account with this permission can create new processors that can interact with any gcs bucket in your project. * @example * ```js * // Before running the sample: @@ -5215,9 +7756,26 @@ export namespace documentai_v1beta3 { * google.options({auth: authClient}); * * // Do the magic - * const res = await documentai.projects.locations.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/operations/my-operation', + * const res = await documentai.projects.locations.processors.updateDataset({ + * // Dataset resource name. Format: `projects/{project\}/locations/{location\}/processors/{processor\}/dataset` + * name: 'projects/my-project/locations/my-location/processors/my-processor/dataset', + * // The update mask applies to the resource. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "documentWarehouseConfig": {}, + * // "gcsManagedConfig": {}, + * // "name": "my_name", + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "spannerIndexingConfig": {}, + * // "state": "my_state", + * // "unmanagedDatasetConfig": {} + * // } + * }, * }); * console.log(res.data); * @@ -5243,36 +7801,36 @@ export namespace documentai_v1beta3 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Operations$Get, + updateDataset( + params: Params$Resource$Projects$Locations$Processors$Updatedataset, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Operations$Get, + updateDataset( + params?: Params$Resource$Projects$Locations$Processors$Updatedataset, options?: MethodOptions ): Promise>; - get( - params: Params$Resource$Projects$Locations$Operations$Get, + updateDataset( + params: Params$Resource$Projects$Locations$Processors$Updatedataset, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Operations$Get, + updateDataset( + params: Params$Resource$Projects$Locations$Processors$Updatedataset, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Operations$Get, + updateDataset( + params: Params$Resource$Projects$Locations$Processors$Updatedataset, callback: BodyResponseCallback ): void; - get( + updateDataset( callback: BodyResponseCallback ): void; - get( + updateDataset( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Get + | Params$Resource$Projects$Locations$Processors$Updatedataset | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -5288,47 +7846,173 @@ export namespace documentai_v1beta3 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Get; + {}) as Params$Resource$Projects$Locations$Processors$Updatedataset; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Get; + params = + {} as Params$Resource$Projects$Locations$Processors$Updatedataset; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; options = {}; } - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + const rootUrl = options.rootUrl || 'https://documentai.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta3/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Processors$Batchprocess + extends StandardParameters { + /** + * Required. The resource name of Processor or ProcessorVersion. Format: `projects/{project\}/locations/{location\}/processors/{processor\}`, or `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDocumentaiV1beta3BatchProcessRequest; + } + export interface Params$Resource$Projects$Locations$Processors$Create + extends StandardParameters { + /** + * Required. The parent (project and location) under which to create the processor. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDocumentaiV1beta3Processor; + } + export interface Params$Resource$Projects$Locations$Processors$Delete + extends StandardParameters { + /** + * Required. The processor resource name to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Processors$Disable + extends StandardParameters { + /** + * Required. The processor resource name to be disabled. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDocumentaiV1beta3DisableProcessorRequest; + } + export interface Params$Resource$Projects$Locations$Processors$Enable + extends StandardParameters { + /** + * Required. The processor resource name to be enabled. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDocumentaiV1beta3EnableProcessorRequest; + } + export interface Params$Resource$Projects$Locations$Processors$Get + extends StandardParameters { + /** + * Required. The processor resource name. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Processors$List + extends StandardParameters { + /** + * The maximum number of processors to return. If unspecified, at most `50` processors will be returned. The maximum value is `100`. Values above `100` will be coerced to `100`. + */ + pageSize?: number; + /** + * We will return the processors sorted by creation time. The page token will point to the next processor. + */ + pageToken?: string; + /** + * Required. The parent (project and location) which owns this collection of Processors. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Processors$Process + extends StandardParameters { + /** + * Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: `projects/{project\}/locations/{location\}/processors/{processor\}`, or `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDocumentaiV1beta3ProcessRequest; + } + export interface Params$Resource$Projects$Locations$Processors$Setdefaultprocessorversion + extends StandardParameters { + /** + * Required. The resource name of the Processor to change default version. + */ + processor?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionRequest; + } + export interface Params$Resource$Projects$Locations$Processors$Updatedataset + extends StandardParameters { + /** + * Dataset resource name. Format: `projects/{project\}/locations/{location\}/processors/{processor\}/dataset` + */ + name?: string; + /** + * The update mask applies to the resource. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDocumentaiV1beta3Dataset; + } - const rootUrl = options.rootUrl || 'https://documentai.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta3/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } + export class Resource$Projects$Locations$Processors$Dataset { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Deletes a set of documents. * @example * ```js * // Before running the sample: @@ -5357,25 +8041,31 @@ export namespace documentai_v1beta3 { * google.options({auth: authClient}); * * // Do the magic - * const res = await documentai.projects.locations.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/operations', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * const res = + * await documentai.projects.locations.processors.dataset.batchDeleteDocuments( + * { + * // Required. The dataset resource name. Format: projects/{project\}/locations/{location\}/processors/{processor\}/dataset + * dataset: + * 'projects/my-project/locations/my-location/processors/my-processor/dataset', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "datasetDocuments": {} + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -5391,61 +8081,58 @@ export namespace documentai_v1beta3 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Operations$List, + batchDeleteDocuments( + params: Params$Resource$Projects$Locations$Processors$Dataset$Batchdeletedocuments, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Operations$List, + batchDeleteDocuments( + params?: Params$Resource$Projects$Locations$Processors$Dataset$Batchdeletedocuments, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Operations$List, + ): Promise>; + batchDeleteDocuments( + params: Params$Resource$Projects$Locations$Processors$Dataset$Batchdeletedocuments, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Operations$List, + batchDeleteDocuments( + params: Params$Resource$Projects$Locations$Processors$Dataset$Batchdeletedocuments, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Operations$List, - callback: BodyResponseCallback + batchDeleteDocuments( + params: Params$Resource$Projects$Locations$Processors$Dataset$Batchdeletedocuments, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + batchDeleteDocuments( + callback: BodyResponseCallback ): void; - list( + batchDeleteDocuments( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Processors$Dataset$Batchdeletedocuments + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$List; + {}) as Params$Resource$Projects$Locations$Processors$Dataset$Batchdeletedocuments; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$List; + params = + {} as Params$Resource$Projects$Locations$Processors$Dataset$Batchdeletedocuments; options = {}; } @@ -5458,90 +8145,32 @@ export namespace documentai_v1beta3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta3/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta3/{+dataset}:batchDeleteDocuments').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['dataset'], + pathParams: ['dataset'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Operations$Cancel - extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - - export class Resource$Projects$Locations$Processors { - context: APIRequestContext; - dataset: Resource$Projects$Locations$Processors$Dataset; - humanReviewConfig: Resource$Projects$Locations$Processors$Humanreviewconfig; - processorVersions: Resource$Projects$Locations$Processors$Processorversions; - constructor(context: APIRequestContext) { - this.context = context; - this.dataset = new Resource$Projects$Locations$Processors$Dataset( - this.context - ); - this.humanReviewConfig = - new Resource$Projects$Locations$Processors$Humanreviewconfig( - this.context - ); - this.processorVersions = - new Resource$Projects$Locations$Processors$Processorversions( - this.context - ); - } /** - * LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format. + * Gets the `DatasetSchema` of a `Dataset`. * @example * ```js * // Before running the sample: @@ -5570,33 +8199,21 @@ export namespace documentai_v1beta3 { * google.options({auth: authClient}); * * // Do the magic - * const res = await documentai.projects.locations.processors.batchProcess({ - * // Required. The resource name of Processor or ProcessorVersion. Format: `projects/{project\}/locations/{location\}/processors/{processor\}`, or `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` - * name: 'projects/my-project/locations/my-location/processors/my-processor', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "documentOutputConfig": {}, - * // "inputConfigs": [], - * // "inputDocuments": {}, - * // "labels": {}, - * // "outputConfig": {}, - * // "processOptions": {}, - * // "skipHumanReview": false - * // } - * }, - * }); + * const res = + * await documentai.projects.locations.processors.dataset.getDatasetSchema({ + * // Required. The dataset schema resource name. Format: projects/{project\}/locations/{location\}/processors/{processor\}/dataset/datasetSchema + * name: 'projects/my-project/locations/my-location/processors/my-processor/dataset/datasetSchema', + * // If set, only returns the visible fields of the schema. + * visibleFieldsOnly: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "documentSchema": {}, * // "name": "my_name", - * // "response": {} + * // "satisfiesPzi": false, + * // "satisfiesPzs": false * // } * } * @@ -5612,58 +8229,62 @@ export namespace documentai_v1beta3 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchProcess( - params: Params$Resource$Projects$Locations$Processors$Batchprocess, + getDatasetSchema( + params: Params$Resource$Projects$Locations$Processors$Dataset$Getdatasetschema, options: StreamMethodOptions ): Promise>; - batchProcess( - params?: Params$Resource$Projects$Locations$Processors$Batchprocess, + getDatasetSchema( + params?: Params$Resource$Projects$Locations$Processors$Dataset$Getdatasetschema, options?: MethodOptions - ): Promise>; - batchProcess( - params: Params$Resource$Projects$Locations$Processors$Batchprocess, + ): Promise< + GaxiosResponseWithHTTP2 + >; + getDatasetSchema( + params: Params$Resource$Projects$Locations$Processors$Dataset$Getdatasetschema, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchProcess( - params: Params$Resource$Projects$Locations$Processors$Batchprocess, + getDatasetSchema( + params: Params$Resource$Projects$Locations$Processors$Dataset$Getdatasetschema, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchProcess( - params: Params$Resource$Projects$Locations$Processors$Batchprocess, - callback: BodyResponseCallback + getDatasetSchema( + params: Params$Resource$Projects$Locations$Processors$Dataset$Getdatasetschema, + callback: BodyResponseCallback ): void; - batchProcess( - callback: BodyResponseCallback + getDatasetSchema( + callback: BodyResponseCallback ): void; - batchProcess( + getDatasetSchema( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Batchprocess - | BodyResponseCallback + | Params$Resource$Projects$Locations$Processors$Dataset$Getdatasetschema + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Batchprocess; + {}) as Params$Resource$Projects$Locations$Processors$Dataset$Getdatasetschema; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Processors$Batchprocess; + {} as Params$Resource$Projects$Locations$Processors$Dataset$Getdatasetschema; options = {}; } @@ -5676,11 +8297,8 @@ export namespace documentai_v1beta3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta3/{+name}:batchProcess').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta3/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -5691,17 +8309,19 @@ export namespace documentai_v1beta3 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Creates a processor from the ProcessorType provided. The processor will be at `ENABLED` state by default after its creation. Note that this method requires the `documentai.processors.create` permission on the project, which is highly privileged. A user or service account with this permission can create new processors that can interact with any gcs bucket in your project. + * Returns relevant fields present in the requested document. * @example * ```js * // Before running the sample: @@ -5730,43 +8350,35 @@ export namespace documentai_v1beta3 { * google.options({auth: authClient}); * * // Do the magic - * const res = await documentai.projects.locations.processors.create({ - * // Required. The parent (project and location) under which to create the processor. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "defaultProcessorVersion": "my_defaultProcessorVersion", - * // "displayName": "my_displayName", - * // "kmsKeyName": "my_kmsKeyName", - * // "name": "my_name", - * // "processEndpoint": "my_processEndpoint", - * // "processorVersionAliases": [], - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "state": "my_state", - * // "type": "my_type" - * // } - * }, - * }); + * const res = + * await documentai.projects.locations.processors.dataset.getDocument({ + * // Required. The resource name of the dataset that the document belongs to . Format: projects/{project\}/locations/{location\}/processors/{processor\}/dataset + * dataset: + * 'projects/my-project/locations/my-location/processors/my-processor/dataset', + * // Id of the document (indexed) managed by Content Warehouse. + * 'documentId.gcsManagedDocId.cwDocId': 'placeholder-value', + * // Required. The Cloud Storage URI where the actual document is stored. + * 'documentId.gcsManagedDocId.gcsUri': 'placeholder-value', + * // Reads the revision generated by the processor version. The format takes the full resource name of processor version. `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` + * 'documentId.revisionRef.latestProcessorVersion': 'placeholder-value', + * // Reads the revision by the predefined case. + * 'documentId.revisionRef.revisionCase': 'placeholder-value', + * // Reads the revision given by the id. + * 'documentId.revisionRef.revisionId': 'placeholder-value', + * // Required. The id of the document. + * 'documentId.unmanagedDocId.docId': 'placeholder-value', + * // Last page number (one-based index) to be returned. + * 'pageRange.end': 'placeholder-value', + * // First page number (one-based index) to be returned. + * 'pageRange.start': 'placeholder-value', + * // If set, only fields listed here will be returned. Otherwise, all fields will be returned by default. + * readMask: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "defaultProcessorVersion": "my_defaultProcessorVersion", - * // "displayName": "my_displayName", - * // "kmsKeyName": "my_kmsKeyName", - * // "name": "my_name", - * // "processEndpoint": "my_processEndpoint", - * // "processorVersionAliases": [], - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "state": "my_state", - * // "type": "my_type" + * // "document": {} * // } * } * @@ -5782,61 +8394,62 @@ export namespace documentai_v1beta3 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Processors$Create, + getDocument( + params: Params$Resource$Projects$Locations$Processors$Dataset$Getdocument, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Processors$Create, + getDocument( + params?: Params$Resource$Projects$Locations$Processors$Dataset$Getdocument, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - create( - params: Params$Resource$Projects$Locations$Processors$Create, + getDocument( + params: Params$Resource$Projects$Locations$Processors$Dataset$Getdocument, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Processors$Create, + getDocument( + params: Params$Resource$Projects$Locations$Processors$Dataset$Getdocument, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Processors$Create, - callback: BodyResponseCallback + getDocument( + params: Params$Resource$Projects$Locations$Processors$Dataset$Getdocument, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + getDocument( + callback: BodyResponseCallback ): void; - create( + getDocument( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Processors$Dataset$Getdocument + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Create; + {}) as Params$Resource$Projects$Locations$Processors$Dataset$Getdocument; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Processors$Create; + params = + {} as Params$Resource$Projects$Locations$Processors$Dataset$Getdocument; options = {}; } @@ -5849,34 +8462,34 @@ export namespace documentai_v1beta3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta3/{+parent}/processors').replace( + url: (rootUrl + '/v1beta3/{+dataset}:getDocument').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['dataset'], + pathParams: ['dataset'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes the processor, unloads all deployed model artifacts if it was enabled and then deletes all artifacts associated with this processor. + * Import documents into a dataset. * @example * ```js * // Before running the sample: @@ -5905,10 +8518,20 @@ export namespace documentai_v1beta3 { * google.options({auth: authClient}); * * // Do the magic - * const res = await documentai.projects.locations.processors.delete({ - * // Required. The processor resource name to be deleted. - * name: 'projects/my-project/locations/my-location/processors/my-processor', - * }); + * const res = + * await documentai.projects.locations.processors.dataset.importDocuments({ + * // Required. The dataset resource name. Format: projects/{project\}/locations/{location\}/processors/{processor\}/dataset + * dataset: + * 'projects/my-project/locations/my-location/processors/my-processor/dataset', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "batchDocumentsImportConfigs": [] + * // } + * }, + * }); * console.log(res.data); * * // Example response @@ -5933,36 +8556,36 @@ export namespace documentai_v1beta3 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Processors$Delete, + importDocuments( + params: Params$Resource$Projects$Locations$Processors$Dataset$Importdocuments, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Processors$Delete, + importDocuments( + params?: Params$Resource$Projects$Locations$Processors$Dataset$Importdocuments, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Processors$Delete, + importDocuments( + params: Params$Resource$Projects$Locations$Processors$Dataset$Importdocuments, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Processors$Delete, + importDocuments( + params: Params$Resource$Projects$Locations$Processors$Dataset$Importdocuments, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Processors$Delete, + importDocuments( + params: Params$Resource$Projects$Locations$Processors$Dataset$Importdocuments, callback: BodyResponseCallback ): void; - delete( + importDocuments( callback: BodyResponseCallback ): void; - delete( + importDocuments( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Delete + | Params$Resource$Projects$Locations$Processors$Dataset$Importdocuments | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -5978,12 +8601,13 @@ export namespace documentai_v1beta3 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Delete; + {}) as Params$Resource$Projects$Locations$Processors$Dataset$Importdocuments; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Processors$Delete; + params = + {} as Params$Resource$Projects$Locations$Processors$Dataset$Importdocuments; options = {}; } @@ -5996,15 +8620,18 @@ export namespace documentai_v1beta3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta3/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1beta3/{+dataset}:importDocuments').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['dataset'], + pathParams: ['dataset'], context: this.context, }; if (callback) { @@ -6018,7 +8645,7 @@ export namespace documentai_v1beta3 { } /** - * Disables a processor + * Returns a list of documents present in the dataset. * @example * ```js * // Before running the sample: @@ -6047,25 +8674,31 @@ export namespace documentai_v1beta3 { * google.options({auth: authClient}); * * // Do the magic - * const res = await documentai.projects.locations.processors.disable({ - * // Required. The processor resource name to be disabled. - * name: 'projects/my-project/locations/my-location/processors/my-processor', + * const res = + * await documentai.projects.locations.processors.dataset.listDocuments({ + * // Required. The resource name of the dataset to be listed. Format: projects/{project\}/locations/{location\}/processors/{processor\}/dataset + * dataset: + * 'projects/my-project/locations/my-location/processors/my-processor/dataset', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "filter": "my_filter", + * // "pageSize": 0, + * // "pageToken": "my_pageToken", + * // "returnTotalSize": false, + * // "skip": 0 + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "documentMetadata": [], + * // "nextPageToken": "my_nextPageToken", + * // "totalSize": 0 * // } * } * @@ -6081,57 +8714,62 @@ export namespace documentai_v1beta3 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - disable( - params: Params$Resource$Projects$Locations$Processors$Disable, + listDocuments( + params: Params$Resource$Projects$Locations$Processors$Dataset$Listdocuments, options: StreamMethodOptions ): Promise>; - disable( - params?: Params$Resource$Projects$Locations$Processors$Disable, + listDocuments( + params?: Params$Resource$Projects$Locations$Processors$Dataset$Listdocuments, options?: MethodOptions - ): Promise>; - disable( - params: Params$Resource$Projects$Locations$Processors$Disable, + ): Promise< + GaxiosResponseWithHTTP2 + >; + listDocuments( + params: Params$Resource$Projects$Locations$Processors$Dataset$Listdocuments, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - disable( - params: Params$Resource$Projects$Locations$Processors$Disable, + listDocuments( + params: Params$Resource$Projects$Locations$Processors$Dataset$Listdocuments, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - disable( - params: Params$Resource$Projects$Locations$Processors$Disable, - callback: BodyResponseCallback + listDocuments( + params: Params$Resource$Projects$Locations$Processors$Dataset$Listdocuments, + callback: BodyResponseCallback ): void; - disable( - callback: BodyResponseCallback + listDocuments( + callback: BodyResponseCallback ): void; - disable( + listDocuments( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Disable - | BodyResponseCallback + | Params$Resource$Projects$Locations$Processors$Dataset$Listdocuments + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Disable; + {}) as Params$Resource$Projects$Locations$Processors$Dataset$Listdocuments; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Processors$Disable; + params = + {} as Params$Resource$Projects$Locations$Processors$Dataset$Listdocuments; options = {}; } @@ -6144,7 +8782,7 @@ export namespace documentai_v1beta3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta3/{+name}:disable').replace( + url: (rootUrl + '/v1beta3/{+dataset}:listDocuments').replace( /([^:]\/)\/+/g, '$1' ), @@ -6154,22 +8792,24 @@ export namespace documentai_v1beta3 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['dataset'], + pathParams: ['dataset'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Enables a processor + * Updates a `DatasetSchema`. * @example * ```js * // Before running the sample: @@ -6198,25 +8838,32 @@ export namespace documentai_v1beta3 { * google.options({auth: authClient}); * * // Do the magic - * const res = await documentai.projects.locations.processors.enable({ - * // Required. The processor resource name to be enabled. - * name: 'projects/my-project/locations/my-location/processors/my-processor', + * const res = + * await documentai.projects.locations.processors.dataset.updateDatasetSchema({ + * // Dataset schema resource name. Format: `projects/{project\}/locations/{location\}/processors/{processor\}/dataset/datasetSchema` + * name: 'projects/my-project/locations/my-location/processors/my-processor/dataset/datasetSchema', + * // The update mask applies to the resource. + * updateMask: 'placeholder-value', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "documentSchema": {}, + * // "name": "my_name", + * // "satisfiesPzi": false, + * // "satisfiesPzs": false + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "documentSchema": {}, * // "name": "my_name", - * // "response": {} + * // "satisfiesPzi": false, + * // "satisfiesPzs": false * // } * } * @@ -6232,95 +8879,213 @@ export namespace documentai_v1beta3 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - enable( - params: Params$Resource$Projects$Locations$Processors$Enable, + updateDatasetSchema( + params: Params$Resource$Projects$Locations$Processors$Dataset$Updatedatasetschema, options: StreamMethodOptions ): Promise>; - enable( - params?: Params$Resource$Projects$Locations$Processors$Enable, + updateDatasetSchema( + params?: Params$Resource$Projects$Locations$Processors$Dataset$Updatedatasetschema, options?: MethodOptions - ): Promise>; - enable( - params: Params$Resource$Projects$Locations$Processors$Enable, + ): Promise< + GaxiosResponseWithHTTP2 + >; + updateDatasetSchema( + params: Params$Resource$Projects$Locations$Processors$Dataset$Updatedatasetschema, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - enable( - params: Params$Resource$Projects$Locations$Processors$Enable, + updateDatasetSchema( + params: Params$Resource$Projects$Locations$Processors$Dataset$Updatedatasetschema, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - enable( - params: Params$Resource$Projects$Locations$Processors$Enable, - callback: BodyResponseCallback + updateDatasetSchema( + params: Params$Resource$Projects$Locations$Processors$Dataset$Updatedatasetschema, + callback: BodyResponseCallback ): void; - enable( - callback: BodyResponseCallback + updateDatasetSchema( + callback: BodyResponseCallback ): void; - enable( + updateDatasetSchema( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Enable - | BodyResponseCallback + | Params$Resource$Projects$Locations$Processors$Dataset$Updatedatasetschema + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Enable; + {}) as Params$Resource$Projects$Locations$Processors$Dataset$Updatedatasetschema; let options = (optionsOrCallback || {}) as MethodOptions; - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Processors$Enable; - options = {}; - } + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Processors$Dataset$Updatedatasetschema; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://documentai.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta3/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Processors$Dataset$Batchdeletedocuments + extends StandardParameters { + /** + * Required. The dataset resource name. Format: projects/{project\}/locations/{location\}/processors/{processor\}/dataset + */ + dataset?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsRequest; + } + export interface Params$Resource$Projects$Locations$Processors$Dataset$Getdatasetschema + extends StandardParameters { + /** + * Required. The dataset schema resource name. Format: projects/{project\}/locations/{location\}/processors/{processor\}/dataset/datasetSchema + */ + name?: string; + /** + * If set, only returns the visible fields of the schema. + */ + visibleFieldsOnly?: boolean; + } + export interface Params$Resource$Projects$Locations$Processors$Dataset$Getdocument + extends StandardParameters { + /** + * Required. The resource name of the dataset that the document belongs to . Format: projects/{project\}/locations/{location\}/processors/{processor\}/dataset + */ + dataset?: string; + /** + * Id of the document (indexed) managed by Content Warehouse. + */ + 'documentId.gcsManagedDocId.cwDocId'?: string; + /** + * Required. The Cloud Storage URI where the actual document is stored. + */ + 'documentId.gcsManagedDocId.gcsUri'?: string; + /** + * Reads the revision generated by the processor version. The format takes the full resource name of processor version. `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` + */ + 'documentId.revisionRef.latestProcessorVersion'?: string; + /** + * Reads the revision by the predefined case. + */ + 'documentId.revisionRef.revisionCase'?: string; + /** + * Reads the revision given by the id. + */ + 'documentId.revisionRef.revisionId'?: string; + /** + * Required. The id of the document. + */ + 'documentId.unmanagedDocId.docId'?: string; + /** + * Last page number (one-based index) to be returned. + */ + 'pageRange.end'?: number; + /** + * First page number (one-based index) to be returned. + */ + 'pageRange.start'?: number; + /** + * If set, only fields listed here will be returned. Otherwise, all fields will be returned by default. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Processors$Dataset$Importdocuments + extends StandardParameters { + /** + * Required. The dataset resource name. Format: projects/{project\}/locations/{location\}/processors/{processor\}/dataset + */ + dataset?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDocumentaiV1beta3ImportDocumentsRequest; + } + export interface Params$Resource$Projects$Locations$Processors$Dataset$Listdocuments + extends StandardParameters { + /** + * Required. The resource name of the dataset to be listed. Format: projects/{project\}/locations/{location\}/processors/{processor\}/dataset + */ + dataset?: string; - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDocumentaiV1beta3ListDocumentsRequest; + } + export interface Params$Resource$Projects$Locations$Processors$Dataset$Updatedatasetschema + extends StandardParameters { + /** + * Dataset schema resource name. Format: `projects/{project\}/locations/{location\}/processors/{processor\}/dataset/datasetSchema` + */ + name?: string; + /** + * The update mask applies to the resource. + */ + updateMask?: string; - const rootUrl = options.rootUrl || 'https://documentai.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta3/{+name}:enable').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDocumentaiV1beta3DatasetSchema; + } + + export class Resource$Projects$Locations$Processors$Humanreviewconfig { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Gets a processor detail. + * Send a document for Human Review. The input document should be processed by the specified processor. * @example * ```js * // Before running the sample: @@ -6349,25 +9114,35 @@ export namespace documentai_v1beta3 { * google.options({auth: authClient}); * * // Do the magic - * const res = await documentai.projects.locations.processors.get({ - * // Required. The processor resource name. - * name: 'projects/my-project/locations/my-location/processors/my-processor', - * }); + * const res = + * await documentai.projects.locations.processors.humanReviewConfig.reviewDocument( + * { + * // Required. The resource name of the HumanReviewConfig that the document will be reviewed with. + * humanReviewConfig: + * 'projects/my-project/locations/my-location/processors/my-processor/humanReviewConfig', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "document": {}, + * // "documentSchema": {}, + * // "enableSchemaValidation": false, + * // "inlineDocument": {}, + * // "priority": "my_priority" + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "defaultProcessorVersion": "my_defaultProcessorVersion", - * // "displayName": "my_displayName", - * // "kmsKeyName": "my_kmsKeyName", + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "processEndpoint": "my_processEndpoint", - * // "processorVersionAliases": [], - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "state": "my_state", - * // "type": "my_type" + * // "response": {} * // } * } * @@ -6383,61 +9158,58 @@ export namespace documentai_v1beta3 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Processors$Get, + reviewDocument( + params: Params$Resource$Projects$Locations$Processors$Humanreviewconfig$Reviewdocument, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Processors$Get, + reviewDocument( + params?: Params$Resource$Projects$Locations$Processors$Humanreviewconfig$Reviewdocument, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Processors$Get, + ): Promise>; + reviewDocument( + params: Params$Resource$Projects$Locations$Processors$Humanreviewconfig$Reviewdocument, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Processors$Get, + reviewDocument( + params: Params$Resource$Projects$Locations$Processors$Humanreviewconfig$Reviewdocument, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Processors$Get, - callback: BodyResponseCallback + reviewDocument( + params: Params$Resource$Projects$Locations$Processors$Humanreviewconfig$Reviewdocument, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + reviewDocument( + callback: BodyResponseCallback ): void; - get( + reviewDocument( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Processors$Humanreviewconfig$Reviewdocument + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Get; + {}) as Params$Resource$Projects$Locations$Processors$Humanreviewconfig$Reviewdocument; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Processors$Get; + params = + {} as Params$Resource$Projects$Locations$Processors$Humanreviewconfig$Reviewdocument; options = {}; } @@ -6450,31 +9222,56 @@ export namespace documentai_v1beta3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta3/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: ( + rootUrl + '/v1beta3/{+humanReviewConfig}:reviewDocument' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['humanReviewConfig'], + pathParams: ['humanReviewConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Processors$Humanreviewconfig$Reviewdocument + extends StandardParameters { /** - * Lists all processors which belong to this project. + * Required. The resource name of the HumanReviewConfig that the document will be reviewed with. + */ + humanReviewConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDocumentaiV1beta3ReviewDocumentRequest; + } + + export class Resource$Projects$Locations$Processors$Processorversions { + context: APIRequestContext; + evaluations: Resource$Projects$Locations$Processors$Processorversions$Evaluations; + constructor(context: APIRequestContext) { + this.context = context; + this.evaluations = + new Resource$Projects$Locations$Processors$Processorversions$Evaluations( + this.context + ); + } + + /** + * LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format. * @example * ```js * // Before running the sample: @@ -6503,20 +9300,36 @@ export namespace documentai_v1beta3 { * google.options({auth: authClient}); * * // Do the magic - * const res = await documentai.projects.locations.processors.list({ - * // The maximum number of processors to return. If unspecified, at most `50` processors will be returned. The maximum value is `100`. Values above `100` will be coerced to `100`. - * pageSize: 'placeholder-value', - * // We will return the processors sorted by creation time. The page token will point to the next processor. - * pageToken: 'placeholder-value', - * // Required. The parent (project and location) which owns this collection of Processors. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * }); + * const res = + * await documentai.projects.locations.processors.processorVersions.batchProcess( + * { + * // Required. The resource name of Processor or ProcessorVersion. Format: `projects/{project\}/locations/{location\}/processors/{processor\}`, or `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` + * name: 'projects/my-project/locations/my-location/processors/my-processor/processorVersions/my-processorVersion', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "documentOutputConfig": {}, + * // "inputConfigs": [], + * // "inputDocuments": {}, + * // "labels": {}, + * // "outputConfig": {}, + * // "processOptions": {}, + * // "skipHumanReview": false + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "processors": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -6532,61 +9345,58 @@ export namespace documentai_v1beta3 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Processors$List, + batchProcess( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Batchprocess, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Processors$List, + batchProcess( + params?: Params$Resource$Projects$Locations$Processors$Processorversions$Batchprocess, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Processors$List, + ): Promise>; + batchProcess( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Batchprocess, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Processors$List, + batchProcess( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Batchprocess, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Processors$List, - callback: BodyResponseCallback + batchProcess( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Batchprocess, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + batchProcess( + callback: BodyResponseCallback ): void; - list( + batchProcess( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Processors$Processorversions$Batchprocess + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$List; + {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Batchprocess; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Processors$List; + params = + {} as Params$Resource$Projects$Locations$Processors$Processorversions$Batchprocess; options = {}; } @@ -6599,34 +9409,32 @@ export namespace documentai_v1beta3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta3/{+parent}/processors').replace( + url: (rootUrl + '/v1beta3/{+name}:batchProcess').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Processes a single document. + * Deletes the processor version, all artifacts under the processor version will be deleted. * @example * ```js * // Before running the sample: @@ -6655,33 +9463,20 @@ export namespace documentai_v1beta3 { * google.options({auth: authClient}); * * // Do the magic - * const res = await documentai.projects.locations.processors.process({ - * // Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: `projects/{project\}/locations/{location\}/processors/{processor\}`, or `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` - * name: 'projects/my-project/locations/my-location/processors/my-processor', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "document": {}, - * // "fieldMask": "my_fieldMask", - * // "gcsDocument": {}, - * // "imagelessMode": false, - * // "inlineDocument": {}, - * // "labels": {}, - * // "processOptions": {}, - * // "rawDocument": {}, - * // "skipHumanReview": false - * // } - * }, - * }); + * const res = + * await documentai.projects.locations.processors.processorVersions.delete({ + * // Required. The processor version resource name to be deleted. + * name: 'projects/my-project/locations/my-location/processors/my-processor/processorVersions/my-processorVersion', + * }); * console.log(res.data); * * // Example response * // { - * // "document": {}, - * // "humanReviewOperation": "my_humanReviewOperation", - * // "humanReviewStatus": {} + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -6697,61 +9492,58 @@ export namespace documentai_v1beta3 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - process( - params: Params$Resource$Projects$Locations$Processors$Process, + delete( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Delete, options: StreamMethodOptions ): Promise>; - process( - params?: Params$Resource$Projects$Locations$Processors$Process, + delete( + params?: Params$Resource$Projects$Locations$Processors$Processorversions$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - process( - params: Params$Resource$Projects$Locations$Processors$Process, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - process( - params: Params$Resource$Projects$Locations$Processors$Process, + delete( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - process( - params: Params$Resource$Projects$Locations$Processors$Process, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Delete, + callback: BodyResponseCallback ): void; - process( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - process( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Process - | BodyResponseCallback + | Params$Resource$Projects$Locations$Processors$Processorversions$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Process; + {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Processors$Process; + params = + {} as Params$Resource$Projects$Locations$Processors$Processorversions$Delete; options = {}; } @@ -6764,11 +9556,8 @@ export namespace documentai_v1beta3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta3/{+name}:process').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta3/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -6779,19 +9568,17 @@ export namespace documentai_v1beta3 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Set the default (active) version of a Processor that will be used in ProcessDocument and BatchProcessDocuments. + * Deploys the processor version. * @example * ```js * // Before running the sample: @@ -6821,17 +9608,14 @@ export namespace documentai_v1beta3 { * * // Do the magic * const res = - * await documentai.projects.locations.processors.setDefaultProcessorVersion({ - * // Required. The resource name of the Processor to change default version. - * processor: - * 'projects/my-project/locations/my-location/processors/my-processor', + * await documentai.projects.locations.processors.processorVersions.deploy({ + * // Required. The processor version resource name to be deployed. + * name: 'projects/my-project/locations/my-location/processors/my-processor/processorVersions/my-processorVersion', * * // Request body metadata * requestBody: { * // request body parameters - * // { - * // "defaultProcessorVersion": "my_defaultProcessorVersion" - * // } + * // {} * }, * }); * console.log(res.data); @@ -6858,36 +9642,36 @@ export namespace documentai_v1beta3 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setDefaultProcessorVersion( - params: Params$Resource$Projects$Locations$Processors$Setdefaultprocessorversion, + deploy( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Deploy, options: StreamMethodOptions ): Promise>; - setDefaultProcessorVersion( - params?: Params$Resource$Projects$Locations$Processors$Setdefaultprocessorversion, + deploy( + params?: Params$Resource$Projects$Locations$Processors$Processorversions$Deploy, options?: MethodOptions ): Promise>; - setDefaultProcessorVersion( - params: Params$Resource$Projects$Locations$Processors$Setdefaultprocessorversion, + deploy( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Deploy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setDefaultProcessorVersion( - params: Params$Resource$Projects$Locations$Processors$Setdefaultprocessorversion, + deploy( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Deploy, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setDefaultProcessorVersion( - params: Params$Resource$Projects$Locations$Processors$Setdefaultprocessorversion, + deploy( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Deploy, callback: BodyResponseCallback ): void; - setDefaultProcessorVersion( + deploy( callback: BodyResponseCallback ): void; - setDefaultProcessorVersion( + deploy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Setdefaultprocessorversion + | Params$Resource$Projects$Locations$Processors$Processorversions$Deploy | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -6903,13 +9687,13 @@ export namespace documentai_v1beta3 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Setdefaultprocessorversion; + {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Deploy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Processors$Setdefaultprocessorversion; + {} as Params$Resource$Projects$Locations$Processors$Processorversions$Deploy; options = {}; } @@ -6922,17 +9706,18 @@ export namespace documentai_v1beta3 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta3/{+processor}:setDefaultProcessorVersion' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta3/{+name}:deploy').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['processor'], - pathParams: ['processor'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -6946,7 +9731,7 @@ export namespace documentai_v1beta3 { } /** - * Updates metadata associated with a dataset. Note that this method requires the `documentai.googleapis.com/datasets.update` permission on the project, which is highly privileged. A user or service account with this permission can create new processors that can interact with any gcs bucket in your project. + * Evaluates a ProcessorVersion against annotated documents, producing an Evaluation. * @example * ```js * // Before running the sample: @@ -6971,31 +9756,26 @@ export namespace documentai_v1beta3 { * }); * * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await documentai.projects.locations.processors.updateDataset({ - * // Dataset resource name. Format: `projects/{project\}/locations/{location\}/processors/{processor\}/dataset` - * name: 'projects/my-project/locations/my-location/processors/my-processor/dataset', - * // The update mask applies to the resource. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "documentWarehouseConfig": {}, - * // "gcsManagedConfig": {}, - * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "spannerIndexingConfig": {}, - * // "state": "my_state", - * // "unmanagedDatasetConfig": {} - * // } - * }, - * }); + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await documentai.projects.locations.processors.processorVersions.evaluateProcessorVersion( + * { + * // Required. The resource name of the ProcessorVersion to evaluate. `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` + * processorVersion: + * 'projects/my-project/locations/my-location/processors/my-processor/processorVersions/my-processorVersion', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "evaluationDocuments": {} + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response @@ -7020,36 +9800,36 @@ export namespace documentai_v1beta3 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - updateDataset( - params: Params$Resource$Projects$Locations$Processors$Updatedataset, + evaluateProcessorVersion( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluateprocessorversion, options: StreamMethodOptions ): Promise>; - updateDataset( - params?: Params$Resource$Projects$Locations$Processors$Updatedataset, + evaluateProcessorVersion( + params?: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluateprocessorversion, options?: MethodOptions ): Promise>; - updateDataset( - params: Params$Resource$Projects$Locations$Processors$Updatedataset, + evaluateProcessorVersion( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluateprocessorversion, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateDataset( - params: Params$Resource$Projects$Locations$Processors$Updatedataset, + evaluateProcessorVersion( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluateprocessorversion, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateDataset( - params: Params$Resource$Projects$Locations$Processors$Updatedataset, + evaluateProcessorVersion( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluateprocessorversion, callback: BodyResponseCallback ): void; - updateDataset( + evaluateProcessorVersion( callback: BodyResponseCallback ): void; - updateDataset( + evaluateProcessorVersion( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Updatedataset + | Params$Resource$Projects$Locations$Processors$Processorversions$Evaluateprocessorversion | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -7065,13 +9845,13 @@ export namespace documentai_v1beta3 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Updatedataset; + {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Evaluateprocessorversion; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Processors$Updatedataset; + {} as Params$Resource$Projects$Locations$Processors$Processorversions$Evaluateprocessorversion; options = {}; } @@ -7084,15 +9864,17 @@ export namespace documentai_v1beta3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta3/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: ( + rootUrl + '/v1beta3/{+processorVersion}:evaluateProcessorVersion' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['processorVersion'], + pathParams: ['processorVersion'], context: this.context, }; if (callback) { @@ -7104,134 +9886,9 @@ export namespace documentai_v1beta3 { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Processors$Batchprocess - extends StandardParameters { - /** - * Required. The resource name of Processor or ProcessorVersion. Format: `projects/{project\}/locations/{location\}/processors/{processor\}`, or `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDocumentaiV1beta3BatchProcessRequest; - } - export interface Params$Resource$Projects$Locations$Processors$Create - extends StandardParameters { - /** - * Required. The parent (project and location) under which to create the processor. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDocumentaiV1beta3Processor; - } - export interface Params$Resource$Projects$Locations$Processors$Delete - extends StandardParameters { - /** - * Required. The processor resource name to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Processors$Disable - extends StandardParameters { - /** - * Required. The processor resource name to be disabled. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDocumentaiV1beta3DisableProcessorRequest; - } - export interface Params$Resource$Projects$Locations$Processors$Enable - extends StandardParameters { - /** - * Required. The processor resource name to be enabled. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDocumentaiV1beta3EnableProcessorRequest; - } - export interface Params$Resource$Projects$Locations$Processors$Get - extends StandardParameters { - /** - * Required. The processor resource name. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Processors$List - extends StandardParameters { - /** - * The maximum number of processors to return. If unspecified, at most `50` processors will be returned. The maximum value is `100`. Values above `100` will be coerced to `100`. - */ - pageSize?: number; - /** - * We will return the processors sorted by creation time. The page token will point to the next processor. - */ - pageToken?: string; - /** - * Required. The parent (project and location) which owns this collection of Processors. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Processors$Process - extends StandardParameters { - /** - * Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: `projects/{project\}/locations/{location\}/processors/{processor\}`, or `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDocumentaiV1beta3ProcessRequest; - } - export interface Params$Resource$Projects$Locations$Processors$Setdefaultprocessorversion - extends StandardParameters { - /** - * Required. The resource name of the Processor to change default version. - */ - processor?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionRequest; - } - export interface Params$Resource$Projects$Locations$Processors$Updatedataset - extends StandardParameters { - /** - * Dataset resource name. Format: `projects/{project\}/locations/{location\}/processors/{processor\}/dataset` - */ - name?: string; - /** - * The update mask applies to the resource. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDocumentaiV1beta3Dataset; - } - - export class Resource$Projects$Locations$Processors$Dataset { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Deletes a set of documents. + * Gets a processor version detail. * @example * ```js * // Before running the sample: @@ -7261,30 +9918,28 @@ export namespace documentai_v1beta3 { * * // Do the magic * const res = - * await documentai.projects.locations.processors.dataset.batchDeleteDocuments( - * { - * // Required. The dataset resource name. Format: projects/{project\}/locations/{location\}/processors/{processor\}/dataset - * dataset: - * 'projects/my-project/locations/my-location/processors/my-processor/dataset', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "datasetDocuments": {} - * // } - * }, - * }, - * ); + * await documentai.projects.locations.processors.processorVersions.get({ + * // Required. The processor resource name. + * name: 'projects/my-project/locations/my-location/processors/my-processor/processorVersions/my-processorVersion', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "createTime": "my_createTime", + * // "deprecationInfo": {}, + * // "displayName": "my_displayName", + * // "documentSchema": {}, + * // "genAiModelInfo": {}, + * // "googleManaged": false, + * // "kmsKeyName": "my_kmsKeyName", + * // "kmsKeyVersionName": "my_kmsKeyVersionName", + * // "latestEvaluation": {}, + * // "modelType": "my_modelType", * // "name": "my_name", - * // "response": {} + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "state": "my_state" * // } * } * @@ -7300,58 +9955,62 @@ export namespace documentai_v1beta3 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchDeleteDocuments( - params: Params$Resource$Projects$Locations$Processors$Dataset$Batchdeletedocuments, + get( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Get, options: StreamMethodOptions ): Promise>; - batchDeleteDocuments( - params?: Params$Resource$Projects$Locations$Processors$Dataset$Batchdeletedocuments, + get( + params?: Params$Resource$Projects$Locations$Processors$Processorversions$Get, options?: MethodOptions - ): Promise>; - batchDeleteDocuments( - params: Params$Resource$Projects$Locations$Processors$Dataset$Batchdeletedocuments, + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchDeleteDocuments( - params: Params$Resource$Projects$Locations$Processors$Dataset$Batchdeletedocuments, + get( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - batchDeleteDocuments( - params: Params$Resource$Projects$Locations$Processors$Dataset$Batchdeletedocuments, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchDeleteDocuments( - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Get, + callback: BodyResponseCallback ): void; - batchDeleteDocuments( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Dataset$Batchdeletedocuments - | BodyResponseCallback + | Params$Resource$Projects$Locations$Processors$Processorversions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Dataset$Batchdeletedocuments; + {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Processors$Dataset$Batchdeletedocuments; + {} as Params$Resource$Projects$Locations$Processors$Processorversions$Get; options = {}; } @@ -7364,32 +10023,31 @@ export namespace documentai_v1beta3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta3/{+dataset}:batchDeleteDocuments').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta3/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['dataset'], - pathParams: ['dataset'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the `DatasetSchema` of a `Dataset`. + * Imports a processor version from source processor version. * @example * ```js * // Before running the sample: @@ -7419,20 +10077,31 @@ export namespace documentai_v1beta3 { * * // Do the magic * const res = - * await documentai.projects.locations.processors.dataset.getDatasetSchema({ - * // Required. The dataset schema resource name. Format: projects/{project\}/locations/{location\}/processors/{processor\}/dataset/datasetSchema - * name: 'projects/my-project/locations/my-location/processors/my-processor/dataset/datasetSchema', - * // If set, only returns the visible fields of the schema. - * visibleFieldsOnly: 'placeholder-value', - * }); + * await documentai.projects.locations.processors.processorVersions.importProcessorVersion( + * { + * // Required. The destination processor name to create the processor version in. Format: `projects/{project\}/locations/{location\}/processors/{processor\}` + * parent: + * 'projects/my-project/locations/my-location/processors/my-processor', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "externalProcessorVersionSource": {}, + * // "processorVersionSource": "my_processorVersionSource" + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "documentSchema": {}, + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false + * // "response": {} * // } * } * @@ -7448,62 +10117,58 @@ export namespace documentai_v1beta3 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getDatasetSchema( - params: Params$Resource$Projects$Locations$Processors$Dataset$Getdatasetschema, + importProcessorVersion( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Importprocessorversion, options: StreamMethodOptions ): Promise>; - getDatasetSchema( - params?: Params$Resource$Projects$Locations$Processors$Dataset$Getdatasetschema, + importProcessorVersion( + params?: Params$Resource$Projects$Locations$Processors$Processorversions$Importprocessorversion, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - getDatasetSchema( - params: Params$Resource$Projects$Locations$Processors$Dataset$Getdatasetschema, + ): Promise>; + importProcessorVersion( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Importprocessorversion, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getDatasetSchema( - params: Params$Resource$Projects$Locations$Processors$Dataset$Getdatasetschema, + importProcessorVersion( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Importprocessorversion, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getDatasetSchema( - params: Params$Resource$Projects$Locations$Processors$Dataset$Getdatasetschema, - callback: BodyResponseCallback + importProcessorVersion( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Importprocessorversion, + callback: BodyResponseCallback ): void; - getDatasetSchema( - callback: BodyResponseCallback + importProcessorVersion( + callback: BodyResponseCallback ): void; - getDatasetSchema( + importProcessorVersion( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Dataset$Getdatasetschema - | BodyResponseCallback + | Params$Resource$Projects$Locations$Processors$Processorversions$Importprocessorversion + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Dataset$Getdatasetschema; + {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Importprocessorversion; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Processors$Dataset$Getdatasetschema; + {} as Params$Resource$Projects$Locations$Processors$Processorversions$Importprocessorversion; options = {}; } @@ -7516,31 +10181,32 @@ export namespace documentai_v1beta3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta3/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: ( + rootUrl + + '/v1beta3/{+parent}/processorVersions:importProcessorVersion' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Returns relevant fields present in the requested document. + * Lists all versions of a processor. * @example * ```js * // Before running the sample: @@ -7570,34 +10236,21 @@ export namespace documentai_v1beta3 { * * // Do the magic * const res = - * await documentai.projects.locations.processors.dataset.getDocument({ - * // Required. The resource name of the dataset that the document belongs to . Format: projects/{project\}/locations/{location\}/processors/{processor\}/dataset - * dataset: - * 'projects/my-project/locations/my-location/processors/my-processor/dataset', - * // Id of the document (indexed) managed by Content Warehouse. - * 'documentId.gcsManagedDocId.cwDocId': 'placeholder-value', - * // Required. The Cloud Storage URI where the actual document is stored. - * 'documentId.gcsManagedDocId.gcsUri': 'placeholder-value', - * // Reads the revision generated by the processor version. The format takes the full resource name of processor version. `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` - * 'documentId.revisionRef.latestProcessorVersion': 'placeholder-value', - * // Reads the revision by the predefined case. - * 'documentId.revisionRef.revisionCase': 'placeholder-value', - * // Reads the revision given by the id. - * 'documentId.revisionRef.revisionId': 'placeholder-value', - * // Required. The id of the document. - * 'documentId.unmanagedDocId.docId': 'placeholder-value', - * // Last page number (one-based index) to be returned. - * 'pageRange.end': 'placeholder-value', - * // First page number (one-based index) to be returned. - * 'pageRange.start': 'placeholder-value', - * // If set, only fields listed here will be returned. Otherwise, all fields will be returned by default. - * readMask: 'placeholder-value', + * await documentai.projects.locations.processors.processorVersions.list({ + * // The maximum number of processor versions to return. If unspecified, at most `10` processor versions will be returned. The maximum value is `20`. Values above `20` will be coerced to `20`. + * pageSize: 'placeholder-value', + * // We will return the processor versions sorted by creation time. The page token will point to the next processor version. + * pageToken: 'placeholder-value', + * // Required. The parent (project, location and processor) to list all versions. Format: `projects/{project\}/locations/{location\}/processors/{processor\}` + * parent: + * 'projects/my-project/locations/my-location/processors/my-processor', * }); * console.log(res.data); * * // Example response * // { - * // "document": {} + * // "nextPageToken": "my_nextPageToken", + * // "processorVersions": [] * // } * } * @@ -7613,62 +10266,62 @@ export namespace documentai_v1beta3 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getDocument( - params: Params$Resource$Projects$Locations$Processors$Dataset$Getdocument, + list( + params: Params$Resource$Projects$Locations$Processors$Processorversions$List, options: StreamMethodOptions ): Promise>; - getDocument( - params?: Params$Resource$Projects$Locations$Processors$Dataset$Getdocument, + list( + params?: Params$Resource$Projects$Locations$Processors$Processorversions$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - getDocument( - params: Params$Resource$Projects$Locations$Processors$Dataset$Getdocument, + list( + params: Params$Resource$Projects$Locations$Processors$Processorversions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getDocument( - params: Params$Resource$Projects$Locations$Processors$Dataset$Getdocument, + list( + params: Params$Resource$Projects$Locations$Processors$Processorversions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getDocument( - params: Params$Resource$Projects$Locations$Processors$Dataset$Getdocument, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Processors$Processorversions$List, + callback: BodyResponseCallback ): void; - getDocument( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - getDocument( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Dataset$Getdocument - | BodyResponseCallback + | Params$Resource$Projects$Locations$Processors$Processorversions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Dataset$Getdocument; + {}) as Params$Resource$Projects$Locations$Processors$Processorversions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Processors$Dataset$Getdocument; + {} as Params$Resource$Projects$Locations$Processors$Processorversions$List; options = {}; } @@ -7681,7 +10334,7 @@ export namespace documentai_v1beta3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta3/{+dataset}:getDocument').replace( + url: (rootUrl + '/v1beta3/{+parent}/processorVersions').replace( /([^:]\/)\/+/g, '$1' ), @@ -7691,24 +10344,24 @@ export namespace documentai_v1beta3 { options ), params, - requiredParams: ['dataset'], - pathParams: ['dataset'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Import documents into a dataset. + * Processes a single document. * @example * ```js * // Before running the sample: @@ -7738,28 +10391,33 @@ export namespace documentai_v1beta3 { * * // Do the magic * const res = - * await documentai.projects.locations.processors.dataset.importDocuments({ - * // Required. The dataset resource name. Format: projects/{project\}/locations/{location\}/processors/{processor\}/dataset - * dataset: - * 'projects/my-project/locations/my-location/processors/my-processor/dataset', + * await documentai.projects.locations.processors.processorVersions.process({ + * // Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: `projects/{project\}/locations/{location\}/processors/{processor\}`, or `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` + * name: 'projects/my-project/locations/my-location/processors/my-processor/processorVersions/my-processorVersion', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "batchDocumentsImportConfigs": [] + * // "document": {}, + * // "fieldMask": "my_fieldMask", + * // "gcsDocument": {}, + * // "imagelessMode": false, + * // "inlineDocument": {}, + * // "labels": {}, + * // "processOptions": {}, + * // "rawDocument": {}, + * // "skipHumanReview": false * // } * }, * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // { + * // "document": {}, + * // "humanReviewOperation": "my_humanReviewOperation", + * // "humanReviewStatus": {} * // } * } * @@ -7775,58 +10433,62 @@ export namespace documentai_v1beta3 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - importDocuments( - params: Params$Resource$Projects$Locations$Processors$Dataset$Importdocuments, + process( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Process, options: StreamMethodOptions ): Promise>; - importDocuments( - params?: Params$Resource$Projects$Locations$Processors$Dataset$Importdocuments, + process( + params?: Params$Resource$Projects$Locations$Processors$Processorversions$Process, options?: MethodOptions - ): Promise>; - importDocuments( - params: Params$Resource$Projects$Locations$Processors$Dataset$Importdocuments, + ): Promise< + GaxiosResponseWithHTTP2 + >; + process( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Process, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - importDocuments( - params: Params$Resource$Projects$Locations$Processors$Dataset$Importdocuments, + process( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Process, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - importDocuments( - params: Params$Resource$Projects$Locations$Processors$Dataset$Importdocuments, - callback: BodyResponseCallback + process( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Process, + callback: BodyResponseCallback ): void; - importDocuments( - callback: BodyResponseCallback + process( + callback: BodyResponseCallback ): void; - importDocuments( + process( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Dataset$Importdocuments - | BodyResponseCallback + | Params$Resource$Projects$Locations$Processors$Processorversions$Process + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Dataset$Importdocuments; + {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Process; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Processors$Dataset$Importdocuments; + {} as Params$Resource$Projects$Locations$Processors$Processorversions$Process; options = {}; } @@ -7839,7 +10501,7 @@ export namespace documentai_v1beta3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta3/{+dataset}:importDocuments').replace( + url: (rootUrl + '/v1beta3/{+name}:process').replace( /([^:]\/)\/+/g, '$1' ), @@ -7849,22 +10511,24 @@ export namespace documentai_v1beta3 { options ), params, - requiredParams: ['dataset'], - pathParams: ['dataset'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Returns a list of documents present in the dataset. + * Trains a new processor version. Operation metadata is returned as TrainProcessorVersionMetadata. * @example * ```js * // Before running the sample: @@ -7894,20 +10558,21 @@ export namespace documentai_v1beta3 { * * // Do the magic * const res = - * await documentai.projects.locations.processors.dataset.listDocuments({ - * // Required. The resource name of the dataset to be listed. Format: projects/{project\}/locations/{location\}/processors/{processor\}/dataset - * dataset: - * 'projects/my-project/locations/my-location/processors/my-processor/dataset', + * await documentai.projects.locations.processors.processorVersions.train({ + * // Required. The parent (project, location and processor) to create the new version for. Format: `projects/{project\}/locations/{location\}/processors/{processor\}`. + * parent: + * 'projects/my-project/locations/my-location/processors/my-processor', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "filter": "my_filter", - * // "pageSize": 0, - * // "pageToken": "my_pageToken", - * // "returnTotalSize": false, - * // "skip": 0 + * // "baseProcessorVersion": "my_baseProcessorVersion", + * // "customDocumentExtractionOptions": {}, + * // "documentSchema": {}, + * // "foundationModelTuningOptions": {}, + * // "inputData": {}, + * // "processorVersion": {} * // } * }, * }); @@ -7915,9 +10580,11 @@ export namespace documentai_v1beta3 { * * // Example response * // { - * // "documentMetadata": [], - * // "nextPageToken": "my_nextPageToken", - * // "totalSize": 0 + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -7933,62 +10600,58 @@ export namespace documentai_v1beta3 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listDocuments( - params: Params$Resource$Projects$Locations$Processors$Dataset$Listdocuments, + train( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Train, options: StreamMethodOptions ): Promise>; - listDocuments( - params?: Params$Resource$Projects$Locations$Processors$Dataset$Listdocuments, + train( + params?: Params$Resource$Projects$Locations$Processors$Processorversions$Train, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - listDocuments( - params: Params$Resource$Projects$Locations$Processors$Dataset$Listdocuments, + ): Promise>; + train( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Train, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listDocuments( - params: Params$Resource$Projects$Locations$Processors$Dataset$Listdocuments, + train( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Train, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listDocuments( - params: Params$Resource$Projects$Locations$Processors$Dataset$Listdocuments, - callback: BodyResponseCallback + train( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Train, + callback: BodyResponseCallback ): void; - listDocuments( - callback: BodyResponseCallback + train( + callback: BodyResponseCallback ): void; - listDocuments( + train( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Dataset$Listdocuments - | BodyResponseCallback + | Params$Resource$Projects$Locations$Processors$Processorversions$Train + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Dataset$Listdocuments; + {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Train; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Processors$Dataset$Listdocuments; + {} as Params$Resource$Projects$Locations$Processors$Processorversions$Train; options = {}; } @@ -8001,34 +10664,31 @@ export namespace documentai_v1beta3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta3/{+dataset}:listDocuments').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1beta3/{+parent}/processorVersions:train' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['dataset'], - pathParams: ['dataset'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a `DatasetSchema`. + * Undeploys the processor version. * @example * ```js * // Before running the sample: @@ -8058,31 +10718,25 @@ export namespace documentai_v1beta3 { * * // Do the magic * const res = - * await documentai.projects.locations.processors.dataset.updateDatasetSchema({ - * // Dataset schema resource name. Format: `projects/{project\}/locations/{location\}/processors/{processor\}/dataset/datasetSchema` - * name: 'projects/my-project/locations/my-location/processors/my-processor/dataset/datasetSchema', - * // The update mask applies to the resource. - * updateMask: 'placeholder-value', + * await documentai.projects.locations.processors.processorVersions.undeploy({ + * // Required. The processor version resource name to be undeployed. + * name: 'projects/my-project/locations/my-location/processors/my-processor/processorVersions/my-processorVersion', * * // Request body metadata * requestBody: { * // request body parameters - * // { - * // "documentSchema": {}, - * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false - * // } + * // {} * }, * }); * console.log(res.data); * * // Example response * // { - * // "documentSchema": {}, + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false + * // "response": {} * // } * } * @@ -8098,62 +10752,58 @@ export namespace documentai_v1beta3 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - updateDatasetSchema( - params: Params$Resource$Projects$Locations$Processors$Dataset$Updatedatasetschema, + undeploy( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Undeploy, options: StreamMethodOptions ): Promise>; - updateDatasetSchema( - params?: Params$Resource$Projects$Locations$Processors$Dataset$Updatedatasetschema, + undeploy( + params?: Params$Resource$Projects$Locations$Processors$Processorversions$Undeploy, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - updateDatasetSchema( - params: Params$Resource$Projects$Locations$Processors$Dataset$Updatedatasetschema, + ): Promise>; + undeploy( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Undeploy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateDatasetSchema( - params: Params$Resource$Projects$Locations$Processors$Dataset$Updatedatasetschema, + undeploy( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Undeploy, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - updateDatasetSchema( - params: Params$Resource$Projects$Locations$Processors$Dataset$Updatedatasetschema, - callback: BodyResponseCallback + undeploy( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Undeploy, + callback: BodyResponseCallback ): void; - updateDatasetSchema( - callback: BodyResponseCallback + undeploy( + callback: BodyResponseCallback ): void; - updateDatasetSchema( + undeploy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Dataset$Updatedatasetschema - | BodyResponseCallback + | Params$Resource$Projects$Locations$Processors$Processorversions$Undeploy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Dataset$Updatedatasetschema; + {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Undeploy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Processors$Dataset$Updatedatasetschema; + {} as Params$Resource$Projects$Locations$Processors$Processorversions$Undeploy; options = {}; } @@ -8166,8 +10816,11 @@ export namespace documentai_v1beta3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta3/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1beta3/{+name}:undeploy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -8178,133 +10831,138 @@ export namespace documentai_v1beta3 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters + callback as BodyResponseCallback ); + } else { + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Processors$Dataset$Batchdeletedocuments + export interface Params$Resource$Projects$Locations$Processors$Processorversions$Batchprocess extends StandardParameters { /** - * Required. The dataset resource name. Format: projects/{project\}/locations/{location\}/processors/{processor\}/dataset + * Required. The resource name of Processor or ProcessorVersion. Format: `projects/{project\}/locations/{location\}/processors/{processor\}`, or `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` */ - dataset?: string; + name?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsRequest; + requestBody?: Schema$GoogleCloudDocumentaiV1beta3BatchProcessRequest; } - export interface Params$Resource$Projects$Locations$Processors$Dataset$Getdatasetschema + export interface Params$Resource$Projects$Locations$Processors$Processorversions$Delete extends StandardParameters { /** - * Required. The dataset schema resource name. Format: projects/{project\}/locations/{location\}/processors/{processor\}/dataset/datasetSchema + * Required. The processor version resource name to be deleted. */ name?: string; - /** - * If set, only returns the visible fields of the schema. - */ - visibleFieldsOnly?: boolean; } - export interface Params$Resource$Projects$Locations$Processors$Dataset$Getdocument + export interface Params$Resource$Projects$Locations$Processors$Processorversions$Deploy extends StandardParameters { /** - * Required. The resource name of the dataset that the document belongs to . Format: projects/{project\}/locations/{location\}/processors/{processor\}/dataset + * Required. The processor version resource name to be deployed. */ - dataset?: string; + name?: string; + /** - * Id of the document (indexed) managed by Content Warehouse. + * Request body metadata */ - 'documentId.gcsManagedDocId.cwDocId'?: string; + requestBody?: Schema$GoogleCloudDocumentaiV1beta3DeployProcessorVersionRequest; + } + export interface Params$Resource$Projects$Locations$Processors$Processorversions$Evaluateprocessorversion + extends StandardParameters { /** - * Required. The Cloud Storage URI where the actual document is stored. + * Required. The resource name of the ProcessorVersion to evaluate. `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` */ - 'documentId.gcsManagedDocId.gcsUri'?: string; + processorVersion?: string; + /** - * Reads the revision generated by the processor version. The format takes the full resource name of processor version. `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` + * Request body metadata */ - 'documentId.revisionRef.latestProcessorVersion'?: string; + requestBody?: Schema$GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionRequest; + } + export interface Params$Resource$Projects$Locations$Processors$Processorversions$Get + extends StandardParameters { /** - * Reads the revision by the predefined case. + * Required. The processor resource name. */ - 'documentId.revisionRef.revisionCase'?: string; + name?: string; + } + export interface Params$Resource$Projects$Locations$Processors$Processorversions$Importprocessorversion + extends StandardParameters { /** - * Reads the revision given by the id. + * Required. The destination processor name to create the processor version in. Format: `projects/{project\}/locations/{location\}/processors/{processor\}` */ - 'documentId.revisionRef.revisionId'?: string; + parent?: string; + /** - * Required. The id of the document. + * Request body metadata */ - 'documentId.unmanagedDocId.docId'?: string; + requestBody?: Schema$GoogleCloudDocumentaiV1beta3ImportProcessorVersionRequest; + } + export interface Params$Resource$Projects$Locations$Processors$Processorversions$List + extends StandardParameters { /** - * Last page number (one-based index) to be returned. + * The maximum number of processor versions to return. If unspecified, at most `10` processor versions will be returned. The maximum value is `20`. Values above `20` will be coerced to `20`. */ - 'pageRange.end'?: number; + pageSize?: number; /** - * First page number (one-based index) to be returned. + * We will return the processor versions sorted by creation time. The page token will point to the next processor version. */ - 'pageRange.start'?: number; + pageToken?: string; /** - * If set, only fields listed here will be returned. Otherwise, all fields will be returned by default. + * Required. The parent (project, location and processor) to list all versions. Format: `projects/{project\}/locations/{location\}/processors/{processor\}` */ - readMask?: string; + parent?: string; } - export interface Params$Resource$Projects$Locations$Processors$Dataset$Importdocuments + export interface Params$Resource$Projects$Locations$Processors$Processorversions$Process extends StandardParameters { /** - * Required. The dataset resource name. Format: projects/{project\}/locations/{location\}/processors/{processor\}/dataset + * Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: `projects/{project\}/locations/{location\}/processors/{processor\}`, or `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` */ - dataset?: string; + name?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDocumentaiV1beta3ImportDocumentsRequest; + requestBody?: Schema$GoogleCloudDocumentaiV1beta3ProcessRequest; } - export interface Params$Resource$Projects$Locations$Processors$Dataset$Listdocuments + export interface Params$Resource$Projects$Locations$Processors$Processorversions$Train extends StandardParameters { /** - * Required. The resource name of the dataset to be listed. Format: projects/{project\}/locations/{location\}/processors/{processor\}/dataset + * Required. The parent (project, location and processor) to create the new version for. Format: `projects/{project\}/locations/{location\}/processors/{processor\}`. */ - dataset?: string; + parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDocumentaiV1beta3ListDocumentsRequest; + requestBody?: Schema$GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequest; } - export interface Params$Resource$Projects$Locations$Processors$Dataset$Updatedatasetschema + export interface Params$Resource$Projects$Locations$Processors$Processorversions$Undeploy extends StandardParameters { /** - * Dataset schema resource name. Format: `projects/{project\}/locations/{location\}/processors/{processor\}/dataset/datasetSchema` + * Required. The processor version resource name to be undeployed. */ name?: string; - /** - * The update mask applies to the resource. - */ - updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDocumentaiV1beta3DatasetSchema; + requestBody?: Schema$GoogleCloudDocumentaiV1beta3UndeployProcessorVersionRequest; } - export class Resource$Projects$Locations$Processors$Humanreviewconfig { + export class Resource$Projects$Locations$Processors$Processorversions$Evaluations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Send a document for Human Review. The input document should be processed by the specified processor. + * Retrieves a specific evaluation. * @example * ```js * // Before running the sample: @@ -8334,34 +10992,23 @@ export namespace documentai_v1beta3 { * * // Do the magic * const res = - * await documentai.projects.locations.processors.humanReviewConfig.reviewDocument( + * await documentai.projects.locations.processors.processorVersions.evaluations.get( * { - * // Required. The resource name of the HumanReviewConfig that the document will be reviewed with. - * humanReviewConfig: - * 'projects/my-project/locations/my-location/processors/my-processor/humanReviewConfig', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "document": {}, - * // "documentSchema": {}, - * // "enableSchemaValidation": false, - * // "inlineDocument": {}, - * // "priority": "my_priority" - * // } - * }, + * // Required. The resource name of the Evaluation to get. `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}/evaluations/{evaluation\}` + * name: 'projects/my-project/locations/my-location/processors/my-processor/processorVersions/my-processorVersion/evaluations/my-evaluation', * }, * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "allEntitiesMetrics": {}, + * // "createTime": "my_createTime", + * // "documentCounters": {}, + * // "entityMetrics": {}, + * // "kmsKeyName": "my_kmsKeyName", + * // "kmsKeyVersionName": "my_kmsKeyVersionName", + * // "name": "my_name" * // } * } * @@ -8377,58 +11024,62 @@ export namespace documentai_v1beta3 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - reviewDocument( - params: Params$Resource$Projects$Locations$Processors$Humanreviewconfig$Reviewdocument, + get( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$Get, options: StreamMethodOptions ): Promise>; - reviewDocument( - params?: Params$Resource$Projects$Locations$Processors$Humanreviewconfig$Reviewdocument, + get( + params?: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$Get, options?: MethodOptions - ): Promise>; - reviewDocument( - params: Params$Resource$Projects$Locations$Processors$Humanreviewconfig$Reviewdocument, + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - reviewDocument( - params: Params$Resource$Projects$Locations$Processors$Humanreviewconfig$Reviewdocument, + get( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - reviewDocument( - params: Params$Resource$Projects$Locations$Processors$Humanreviewconfig$Reviewdocument, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$Get, + callback: BodyResponseCallback ): void; - reviewDocument( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - reviewDocument( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Humanreviewconfig$Reviewdocument - | BodyResponseCallback + | Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Humanreviewconfig$Reviewdocument; + {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Processors$Humanreviewconfig$Reviewdocument; + {} as Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$Get; options = {}; } @@ -8441,56 +11092,31 @@ export namespace documentai_v1beta3 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta3/{+humanReviewConfig}:reviewDocument' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1beta3/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['humanReviewConfig'], - pathParams: ['humanReviewConfig'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Processors$Humanreviewconfig$Reviewdocument - extends StandardParameters { - /** - * Required. The resource name of the HumanReviewConfig that the document will be reviewed with. - */ - humanReviewConfig?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDocumentaiV1beta3ReviewDocumentRequest; - } - - export class Resource$Projects$Locations$Processors$Processorversions { - context: APIRequestContext; - evaluations: Resource$Projects$Locations$Processors$Processorversions$Evaluations; - constructor(context: APIRequestContext) { - this.context = context; - this.evaluations = - new Resource$Projects$Locations$Processors$Processorversions$Evaluations( - this.context + return createAPIRequest( + parameters ); + } } /** - * LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format. + * Retrieves a set of evaluations for a given processor version. * @example * ```js * // Before running the sample: @@ -8514,41 +11140,29 @@ export namespace documentai_v1beta3 { * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await documentai.projects.locations.processors.processorVersions.batchProcess( - * { - * // Required. The resource name of Processor or ProcessorVersion. Format: `projects/{project\}/locations/{location\}/processors/{processor\}`, or `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` - * name: 'projects/my-project/locations/my-location/processors/my-processor/processorVersions/my-processorVersion', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "documentOutputConfig": {}, - * // "inputConfigs": [], - * // "inputDocuments": {}, - * // "labels": {}, - * // "outputConfig": {}, - * // "processOptions": {}, - * // "skipHumanReview": false - * // } - * }, + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await documentai.projects.locations.processors.processorVersions.evaluations.list( + * { + * // The standard list page size. If unspecified, at most `5` evaluations are returned. The maximum value is `100`. Values above `100` are coerced to `100`. + * pageSize: 'placeholder-value', + * // A page token, received from a previous `ListEvaluations` call. Provide this to retrieve the subsequent page. + * pageToken: 'placeholder-value', + * // Required. The resource name of the ProcessorVersion to list evaluations for. `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` + * parent: + * 'projects/my-project/locations/my-location/processors/my-processor/processorVersions/my-processorVersion', * }, * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "evaluations": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -8564,58 +11178,62 @@ export namespace documentai_v1beta3 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchProcess( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Batchprocess, + list( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$List, options: StreamMethodOptions ): Promise>; - batchProcess( - params?: Params$Resource$Projects$Locations$Processors$Processorversions$Batchprocess, + list( + params?: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$List, options?: MethodOptions - ): Promise>; - batchProcess( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Batchprocess, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchProcess( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Batchprocess, + list( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchProcess( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Batchprocess, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$List, + callback: BodyResponseCallback ): void; - batchProcess( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - batchProcess( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Processorversions$Batchprocess - | BodyResponseCallback + | Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Batchprocess; + {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Processors$Processorversions$Batchprocess; + {} as Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$List; options = {}; } @@ -8628,32 +11246,64 @@ export namespace documentai_v1beta3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta3/{+name}:batchProcess').replace( + url: (rootUrl + '/v1beta3/{+parent}/evaluations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$Get + extends StandardParameters { /** - * Deletes the processor version, all artifacts under the processor version will be deleted. + * Required. The resource name of the Evaluation to get. `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}/evaluations/{evaluation\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$List + extends StandardParameters { + /** + * The standard list page size. If unspecified, at most `5` evaluations are returned. The maximum value is `100`. Values above `100` are coerced to `100`. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListEvaluations` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The resource name of the ProcessorVersion to list evaluations for. `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` + */ + parent?: string; + } + + export class Resource$Projects$Locations$Processortypes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a processor type detail. * @example * ```js * // Before running the sample: @@ -8682,20 +11332,21 @@ export namespace documentai_v1beta3 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await documentai.projects.locations.processors.processorVersions.delete({ - * // Required. The processor version resource name to be deleted. - * name: 'projects/my-project/locations/my-location/processors/my-processor/processorVersions/my-processorVersion', - * }); + * const res = await documentai.projects.locations.processorTypes.get({ + * // Required. The processor type resource name. + * name: 'projects/my-project/locations/my-location/processorTypes/my-processorType', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "allowCreation": false, + * // "availableLocations": [], + * // "category": "my_category", + * // "launchStage": "my_launchStage", * // "name": "my_name", - * // "response": {} + * // "sampleDocumentUris": [], + * // "type": "my_type" * // } * } * @@ -8711,58 +11362,61 @@ export namespace documentai_v1beta3 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Delete, + get( + params: Params$Resource$Projects$Locations$Processortypes$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Processors$Processorversions$Delete, + get( + params?: Params$Resource$Projects$Locations$Processortypes$Get, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Processortypes$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Delete, + get( + params: Params$Resource$Projects$Locations$Processortypes$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Processortypes$Get, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - delete( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Processorversions$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Processortypes$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Delete; + {}) as Params$Resource$Projects$Locations$Processortypes$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Processors$Processorversions$Delete; + params = {} as Params$Resource$Projects$Locations$Processortypes$Get; options = {}; } @@ -8776,7 +11430,7 @@ export namespace documentai_v1beta3 { options: Object.assign( { url: (rootUrl + '/v1beta3/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -8787,17 +11441,19 @@ export namespace documentai_v1beta3 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deploys the processor version. + * Lists the processor types that exist. * @example * ```js * // Before running the sample: @@ -8826,26 +11482,20 @@ export namespace documentai_v1beta3 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await documentai.projects.locations.processors.processorVersions.deploy({ - * // Required. The processor version resource name to be deployed. - * name: 'projects/my-project/locations/my-location/processors/my-processor/processorVersions/my-processorVersion', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }); + * const res = await documentai.projects.locations.processorTypes.list({ + * // The maximum number of processor types to return. If unspecified, at most `100` processor types will be returned. The maximum value is `500`. Values above `500` will be coerced to `500`. + * pageSize: 'placeholder-value', + * // Used to retrieve the next page of results, empty if at the end of the list. + * pageToken: 'placeholder-value', + * // Required. The location of processor types to list. Format: `projects/{project\}/locations/{location\}`. + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "processorTypes": [] * // } * } * @@ -8861,58 +11511,61 @@ export namespace documentai_v1beta3 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - deploy( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Deploy, + list( + params: Params$Resource$Projects$Locations$Processortypes$List, options: StreamMethodOptions ): Promise>; - deploy( - params?: Params$Resource$Projects$Locations$Processors$Processorversions$Deploy, + list( + params?: Params$Resource$Projects$Locations$Processortypes$List, options?: MethodOptions - ): Promise>; - deploy( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Deploy, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Processortypes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deploy( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Deploy, + list( + params: Params$Resource$Projects$Locations$Processortypes$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - deploy( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Deploy, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - deploy( - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Processortypes$List, + callback: BodyResponseCallback ): void; - deploy( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Processorversions$Deploy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Processortypes$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Deploy; + {}) as Params$Resource$Projects$Locations$Processortypes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Processors$Processorversions$Deploy; + params = {} as Params$Resource$Projects$Locations$Processortypes$List; options = {}; } @@ -8925,32 +11578,67 @@ export namespace documentai_v1beta3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta3/{+name}:deploy').replace( + url: (rootUrl + '/v1beta3/{+parent}/processorTypes').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Processortypes$Get + extends StandardParameters { /** - * Evaluates a ProcessorVersion against annotated documents, producing an Evaluation. + * Required. The processor type resource name. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Processortypes$List + extends StandardParameters { + /** + * The maximum number of processor types to return. If unspecified, at most `100` processor types will be returned. The maximum value is `500`. Values above `500` will be coerced to `500`. + */ + pageSize?: number; + /** + * Used to retrieve the next page of results, empty if at the end of the list. + */ + pageToken?: string; + /** + * Required. The location of processor types to list. Format: `projects/{project\}/locations/{location\}`. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Schemas { + context: APIRequestContext; + schemaVersions: Resource$Projects$Locations$Schemas$Schemaversions; + constructor(context: APIRequestContext) { + this.context = context; + this.schemaVersions = + new Resource$Projects$Locations$Schemas$Schemaversions(this.context); + } + + /** + * Creates a schema. * @example * ```js * // Before running the sample: @@ -8979,31 +11667,31 @@ export namespace documentai_v1beta3 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await documentai.projects.locations.processors.processorVersions.evaluateProcessorVersion( - * { - * // Required. The resource name of the ProcessorVersion to evaluate. `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` - * processorVersion: - * 'projects/my-project/locations/my-location/processors/my-processor/processorVersions/my-processorVersion', + * const res = await documentai.projects.locations.schemas.create({ + * // Required. The parent (project and location) under which to create the Schema. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "evaluationDocuments": {} - * // } - * }, - * }, - * ); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "labels": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "labels": {}, * // "name": "my_name", - * // "response": {} + * // "updateTime": "my_updateTime" * // } * } * @@ -9019,58 +11707,61 @@ export namespace documentai_v1beta3 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - evaluateProcessorVersion( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluateprocessorversion, + create( + params: Params$Resource$Projects$Locations$Schemas$Create, options: StreamMethodOptions ): Promise>; - evaluateProcessorVersion( - params?: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluateprocessorversion, + create( + params?: Params$Resource$Projects$Locations$Schemas$Create, options?: MethodOptions - ): Promise>; - evaluateProcessorVersion( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluateprocessorversion, + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Schemas$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - evaluateProcessorVersion( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluateprocessorversion, + create( + params: Params$Resource$Projects$Locations$Schemas$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - evaluateProcessorVersion( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluateprocessorversion, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Schemas$Create, + callback: BodyResponseCallback ): void; - evaluateProcessorVersion( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - evaluateProcessorVersion( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Processorversions$Evaluateprocessorversion - | BodyResponseCallback + | Params$Resource$Projects$Locations$Schemas$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Evaluateprocessorversion; + {}) as Params$Resource$Projects$Locations$Schemas$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Processors$Processorversions$Evaluateprocessorversion; + params = {} as Params$Resource$Projects$Locations$Schemas$Create; options = {}; } @@ -9083,31 +11774,34 @@ export namespace documentai_v1beta3 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta3/{+processorVersion}:evaluateProcessorVersion' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta3/{+parent}/schemas').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['processorVersion'], - pathParams: ['processorVersion'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a processor version detail. + * Deletes a schema. * @example * ```js * // Before running the sample: @@ -9136,29 +11830,21 @@ export namespace documentai_v1beta3 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await documentai.projects.locations.processors.processorVersions.get({ - * // Required. The processor resource name. - * name: 'projects/my-project/locations/my-location/processors/my-processor/processorVersions/my-processorVersion', - * }); + * const res = await documentai.projects.locations.schemas.delete({ + * // Optional. If set to true, any child resources of this Schema will also be deleted. (Otherwise, the request will only work if the Schema has no child resources.) + * force: 'placeholder-value', + * // Required. The name of the Schema to be deleted. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}` + * name: 'projects/my-project/locations/my-location/schemas/my-schema', + * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "deprecationInfo": {}, - * // "displayName": "my_displayName", - * // "documentSchema": {}, - * // "genAiModelInfo": {}, - * // "googleManaged": false, - * // "kmsKeyName": "my_kmsKeyName", - * // "kmsKeyVersionName": "my_kmsKeyVersionName", - * // "latestEvaluation": {}, - * // "modelType": "my_modelType", + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "state": "my_state" + * // "response": {} * // } * } * @@ -9174,62 +11860,57 @@ export namespace documentai_v1beta3 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Get, + delete( + params: Params$Resource$Projects$Locations$Schemas$Delete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Processors$Processorversions$Get, + delete( + params?: Params$Resource$Projects$Locations$Schemas$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Get, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Schemas$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Get, + delete( + params: Params$Resource$Projects$Locations$Schemas$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Schemas$Delete, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - get( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Processorversions$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Schemas$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Get; + {}) as Params$Resource$Projects$Locations$Schemas$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Processors$Processorversions$Get; + params = {} as Params$Resource$Projects$Locations$Schemas$Delete; options = {}; } @@ -9243,7 +11924,7 @@ export namespace documentai_v1beta3 { options: Object.assign( { url: (rootUrl + '/v1beta3/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -9254,19 +11935,17 @@ export namespace documentai_v1beta3 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Imports a processor version from source processor version. + * Gets a schema. * @example * ```js * // Before running the sample: @@ -9289,38 +11968,25 @@ export namespace documentai_v1beta3 { * // Scopes can be specified either as an array or as a single, space-delimited string. * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await documentai.projects.locations.processors.processorVersions.importProcessorVersion( - * { - * // Required. The destination processor name to create the processor version in. Format: `projects/{project\}/locations/{location\}/processors/{processor\}` - * parent: - * 'projects/my-project/locations/my-location/processors/my-processor', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "externalProcessorVersionSource": {}, - * // "processorVersionSource": "my_processorVersionSource" - * // } - * }, - * }, - * ); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await documentai.projects.locations.schemas.get({ + * // Required. The name of the Schema to get. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}` + * name: 'projects/my-project/locations/my-location/schemas/my-schema', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "labels": {}, * // "name": "my_name", - * // "response": {} + * // "updateTime": "my_updateTime" * // } * } * @@ -9336,58 +12002,61 @@ export namespace documentai_v1beta3 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - importProcessorVersion( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Importprocessorversion, + get( + params: Params$Resource$Projects$Locations$Schemas$Get, options: StreamMethodOptions ): Promise>; - importProcessorVersion( - params?: Params$Resource$Projects$Locations$Processors$Processorversions$Importprocessorversion, + get( + params?: Params$Resource$Projects$Locations$Schemas$Get, options?: MethodOptions - ): Promise>; - importProcessorVersion( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Importprocessorversion, + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Schemas$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - importProcessorVersion( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Importprocessorversion, + get( + params: Params$Resource$Projects$Locations$Schemas$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - importProcessorVersion( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Importprocessorversion, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Schemas$Get, + callback: BodyResponseCallback ): void; - importProcessorVersion( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - importProcessorVersion( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Processorversions$Importprocessorversion - | BodyResponseCallback + | Params$Resource$Projects$Locations$Schemas$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Importprocessorversion; + {}) as Params$Resource$Projects$Locations$Schemas$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Processors$Processorversions$Importprocessorversion; + params = {} as Params$Resource$Projects$Locations$Schemas$Get; options = {}; } @@ -9400,32 +12069,31 @@ export namespace documentai_v1beta3 { const parameters = { options: Object.assign( { - url: ( - rootUrl + - '/v1beta3/{+parent}/processorVersions:importProcessorVersion' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1beta3/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists all versions of a processor. + * Lists Schemas. * @example * ```js * // Before running the sample: @@ -9454,22 +12122,20 @@ export namespace documentai_v1beta3 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await documentai.projects.locations.processors.processorVersions.list({ - * // The maximum number of processor versions to return. If unspecified, at most `10` processor versions will be returned. The maximum value is `20`. Values above `20` will be coerced to `20`. - * pageSize: 'placeholder-value', - * // We will return the processor versions sorted by creation time. The page token will point to the next processor version. - * pageToken: 'placeholder-value', - * // Required. The parent (project, location and processor) to list all versions. Format: `projects/{project\}/locations/{location\}/processors/{processor\}` - * parent: - * 'projects/my-project/locations/my-location/processors/my-processor', - * }); + * const res = await documentai.projects.locations.schemas.list({ + * // Optional. The maximum number of schema groups to return. If unspecified, at most `10` Schema will be returned. The maximum value is `20`. Values above `20` will be coerced to `20`. + * pageSize: 'placeholder-value', + * // Optional. We will return the schema groups sorted by creation time. The page token will point to the next Schema. + * pageToken: 'placeholder-value', + * // Required. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "processorVersions": [] + * // "schemas": [] * // } * } * @@ -9486,61 +12152,60 @@ export namespace documentai_v1beta3 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Processors$Processorversions$List, + params: Params$Resource$Projects$Locations$Schemas$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Processors$Processorversions$List, + params?: Params$Resource$Projects$Locations$Schemas$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Processors$Processorversions$List, + params: Params$Resource$Projects$Locations$Schemas$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Processors$Processorversions$List, + params: Params$Resource$Projects$Locations$Schemas$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Processors$Processorversions$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Schemas$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Processorversions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Schemas$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Processorversions$List; + {}) as Params$Resource$Projects$Locations$Schemas$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Processors$Processorversions$List; + params = {} as Params$Resource$Projects$Locations$Schemas$List; options = {}; } @@ -9553,7 +12218,7 @@ export namespace documentai_v1beta3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta3/{+parent}/processorVersions').replace( + url: (rootUrl + '/v1beta3/{+parent}/schemas').replace( /([^:]\/)\/+/g, '$1' ), @@ -9568,19 +12233,19 @@ export namespace documentai_v1beta3 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Processes a single document. + * Updates a schema. Editable fields are: - `display_name` - `labels` * @example * ```js * // Before running the sample: @@ -9609,34 +12274,33 @@ export namespace documentai_v1beta3 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await documentai.projects.locations.processors.processorVersions.process({ - * // Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: `projects/{project\}/locations/{location\}/processors/{processor\}`, or `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` - * name: 'projects/my-project/locations/my-location/processors/my-processor/processorVersions/my-processorVersion', + * const res = await documentai.projects.locations.schemas.patch({ + * // Identifier. The resource name of the Schema. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}` + * name: 'projects/my-project/locations/my-location/schemas/my-schema', + * // Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name. - labels. + * updateMask: 'placeholder-value', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "document": {}, - * // "fieldMask": "my_fieldMask", - * // "gcsDocument": {}, - * // "imagelessMode": false, - * // "inlineDocument": {}, - * // "labels": {}, - * // "processOptions": {}, - * // "rawDocument": {}, - * // "skipHumanReview": false - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "labels": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "document": {}, - * // "humanReviewOperation": "my_humanReviewOperation", - * // "humanReviewStatus": {} + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "labels": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime" * // } * } * @@ -9652,62 +12316,61 @@ export namespace documentai_v1beta3 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - process( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Process, + patch( + params: Params$Resource$Projects$Locations$Schemas$Patch, options: StreamMethodOptions ): Promise>; - process( - params?: Params$Resource$Projects$Locations$Processors$Processorversions$Process, + patch( + params?: Params$Resource$Projects$Locations$Schemas$Patch, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - process( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Process, + patch( + params: Params$Resource$Projects$Locations$Schemas$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - process( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Process, + patch( + params: Params$Resource$Projects$Locations$Schemas$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - process( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Process, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Schemas$Patch, + callback: BodyResponseCallback ): void; - process( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - process( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Processorversions$Process - | BodyResponseCallback + | Params$Resource$Projects$Locations$Schemas$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Process; + {}) as Params$Resource$Projects$Locations$Schemas$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Processors$Processorversions$Process; + params = {} as Params$Resource$Projects$Locations$Schemas$Patch; options = {}; } @@ -9720,11 +12383,8 @@ export namespace documentai_v1beta3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta3/{+name}:process').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta3/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -9735,19 +12395,88 @@ export namespace documentai_v1beta3 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Schemas$Create + extends StandardParameters { /** - * Trains a new processor version. Operation metadata is returned as TrainProcessorVersionMetadata. + * Required. The parent (project and location) under which to create the Schema. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDocumentaiV1beta3NextSchema; + } + export interface Params$Resource$Projects$Locations$Schemas$Delete + extends StandardParameters { + /** + * Optional. If set to true, any child resources of this Schema will also be deleted. (Otherwise, the request will only work if the Schema has no child resources.) + */ + force?: boolean; + /** + * Required. The name of the Schema to be deleted. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Schemas$Get + extends StandardParameters { + /** + * Required. The name of the Schema to get. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Schemas$List + extends StandardParameters { + /** + * Optional. The maximum number of schema groups to return. If unspecified, at most `10` Schema will be returned. The maximum value is `20`. Values above `20` will be coerced to `20`. + */ + pageSize?: number; + /** + * Optional. We will return the schema groups sorted by creation time. The page token will point to the next Schema. + */ + pageToken?: string; + /** + * Required. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Schemas$Patch + extends StandardParameters { + /** + * Identifier. The resource name of the Schema. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}` + */ + name?: string; + /** + * Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name. - labels. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDocumentaiV1beta3NextSchema; + } + + export class Resource$Projects$Locations$Schemas$Schemaversions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a schema version. * @example * ```js * // Before running the sample: @@ -9776,34 +12505,33 @@ export namespace documentai_v1beta3 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await documentai.projects.locations.processors.processorVersions.train({ - * // Required. The parent (project, location and processor) to create the new version for. Format: `projects/{project\}/locations/{location\}/processors/{processor\}`. - * parent: - * 'projects/my-project/locations/my-location/processors/my-processor', + * const res = await documentai.projects.locations.schemas.schemaVersions.create( + * { + * // Required. The parent (project and location) under which to create the SchemaVersion. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}` + * parent: 'projects/my-project/locations/my-location/schemas/my-schema', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "baseProcessorVersion": "my_baseProcessorVersion", - * // "customDocumentExtractionOptions": {}, - * // "documentSchema": {}, - * // "foundationModelTuningOptions": {}, - * // "inputData": {}, - * // "processorVersion": {} + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "labels": {}, + * // "name": "my_name", + * // "schema": {} * // } * }, - * }); + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "labels": {}, * // "name": "my_name", - * // "response": {} + * // "schema": {} * // } * } * @@ -9819,58 +12547,62 @@ export namespace documentai_v1beta3 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - train( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Train, + create( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$Create, options: StreamMethodOptions - ): Promise>; - train( - params?: Params$Resource$Projects$Locations$Processors$Processorversions$Train, + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Schemas$Schemaversions$Create, options?: MethodOptions - ): Promise>; - train( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Train, + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - train( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Train, + create( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - train( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Train, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$Create, + callback: BodyResponseCallback ): void; - train( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - train( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Processorversions$Train - | BodyResponseCallback + | Params$Resource$Projects$Locations$Schemas$Schemaversions$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Train; + {}) as Params$Resource$Projects$Locations$Schemas$Schemaversions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Processors$Processorversions$Train; + {} as Params$Resource$Projects$Locations$Schemas$Schemaversions$Create; options = {}; } @@ -9883,9 +12615,10 @@ export namespace documentai_v1beta3 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta3/{+parent}/processorVersions:train' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta3/{+parent}/schemaVersions').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, @@ -9897,17 +12630,19 @@ export namespace documentai_v1beta3 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Undeploys the processor version. + * Deletes a schema version. * @example * ```js * // Before running the sample: @@ -9936,17 +12671,12 @@ export namespace documentai_v1beta3 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await documentai.projects.locations.processors.processorVersions.undeploy({ - * // Required. The processor version resource name to be undeployed. - * name: 'projects/my-project/locations/my-location/processors/my-processor/processorVersions/my-processorVersion', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }); + * const res = await documentai.projects.locations.schemas.schemaVersions.delete( + * { + * // Required. The name of the SchemaVersion to delete. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}/schemaVersions/{schema_version\}` + * name: 'projects/my-project/locations/my-location/schemas/my-schema/schemaVersions/my-schemaVersion', + * }, + * ); * console.log(res.data); * * // Example response @@ -9971,36 +12701,36 @@ export namespace documentai_v1beta3 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - undeploy( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Undeploy, + delete( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$Delete, options: StreamMethodOptions ): Promise>; - undeploy( - params?: Params$Resource$Projects$Locations$Processors$Processorversions$Undeploy, + delete( + params?: Params$Resource$Projects$Locations$Schemas$Schemaversions$Delete, options?: MethodOptions ): Promise>; - undeploy( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Undeploy, + delete( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - undeploy( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Undeploy, + delete( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - undeploy( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Undeploy, + delete( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$Delete, callback: BodyResponseCallback ): void; - undeploy( + delete( callback: BodyResponseCallback ): void; - undeploy( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Processorversions$Undeploy + | Params$Resource$Projects$Locations$Schemas$Schemaversions$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -10016,13 +12746,13 @@ export namespace documentai_v1beta3 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Undeploy; + {}) as Params$Resource$Projects$Locations$Schemas$Schemaversions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Processors$Processorversions$Undeploy; + {} as Params$Resource$Projects$Locations$Schemas$Schemaversions$Delete; options = {}; } @@ -10035,11 +12765,8 @@ export namespace documentai_v1beta3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta3/{+name}:undeploy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta3/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -10058,130 +12785,9 @@ export namespace documentai_v1beta3 { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Processors$Processorversions$Batchprocess - extends StandardParameters { - /** - * Required. The resource name of Processor or ProcessorVersion. Format: `projects/{project\}/locations/{location\}/processors/{processor\}`, or `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDocumentaiV1beta3BatchProcessRequest; - } - export interface Params$Resource$Projects$Locations$Processors$Processorversions$Delete - extends StandardParameters { - /** - * Required. The processor version resource name to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Processors$Processorversions$Deploy - extends StandardParameters { - /** - * Required. The processor version resource name to be deployed. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDocumentaiV1beta3DeployProcessorVersionRequest; - } - export interface Params$Resource$Projects$Locations$Processors$Processorversions$Evaluateprocessorversion - extends StandardParameters { - /** - * Required. The resource name of the ProcessorVersion to evaluate. `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` - */ - processorVersion?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionRequest; - } - export interface Params$Resource$Projects$Locations$Processors$Processorversions$Get - extends StandardParameters { - /** - * Required. The processor resource name. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Processors$Processorversions$Importprocessorversion - extends StandardParameters { - /** - * Required. The destination processor name to create the processor version in. Format: `projects/{project\}/locations/{location\}/processors/{processor\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDocumentaiV1beta3ImportProcessorVersionRequest; - } - export interface Params$Resource$Projects$Locations$Processors$Processorversions$List - extends StandardParameters { - /** - * The maximum number of processor versions to return. If unspecified, at most `10` processor versions will be returned. The maximum value is `20`. Values above `20` will be coerced to `20`. - */ - pageSize?: number; - /** - * We will return the processor versions sorted by creation time. The page token will point to the next processor version. - */ - pageToken?: string; - /** - * Required. The parent (project, location and processor) to list all versions. Format: `projects/{project\}/locations/{location\}/processors/{processor\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Processors$Processorversions$Process - extends StandardParameters { - /** - * Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: `projects/{project\}/locations/{location\}/processors/{processor\}`, or `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDocumentaiV1beta3ProcessRequest; - } - export interface Params$Resource$Projects$Locations$Processors$Processorversions$Train - extends StandardParameters { - /** - * Required. The parent (project, location and processor) to create the new version for. Format: `projects/{project\}/locations/{location\}/processors/{processor\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequest; - } - export interface Params$Resource$Projects$Locations$Processors$Processorversions$Undeploy - extends StandardParameters { - /** - * Required. The processor version resource name to be undeployed. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDocumentaiV1beta3UndeployProcessorVersionRequest; - } - - export class Resource$Projects$Locations$Processors$Processorversions$Evaluations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Retrieves a specific evaluation. + * Generates a schema version. * @example * ```js * // Before running the sample: @@ -10211,23 +12817,28 @@ export namespace documentai_v1beta3 { * * // Do the magic * const res = - * await documentai.projects.locations.processors.processorVersions.evaluations.get( - * { - * // Required. The resource name of the Evaluation to get. `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}/evaluations/{evaluation\}` - * name: 'projects/my-project/locations/my-location/processors/my-processor/processorVersions/my-processorVersion/evaluations/my-evaluation', + * await documentai.projects.locations.schemas.schemaVersions.generate({ + * // Required. The parent (project, location and schema) under which to generate the SchemaVersion. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}` + * parent: 'projects/my-project/locations/my-location/schemas/my-schema', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "baseSchemaVersion": "my_baseSchemaVersion", + * // "gcsDocuments": {}, + * // "gcsPrefix": {}, + * // "generateSchemaVersionParams": {}, + * // "inlineDocuments": {}, + * // "rawDocuments": {} + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response * // { - * // "allEntitiesMetrics": {}, - * // "createTime": "my_createTime", - * // "documentCounters": {}, - * // "entityMetrics": {}, - * // "kmsKeyName": "my_kmsKeyName", - * // "kmsKeyVersionName": "my_kmsKeyVersionName", - * // "name": "my_name" + * // "schemaVersion": {} * // } * } * @@ -10243,62 +12854,62 @@ export namespace documentai_v1beta3 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$Get, + generate( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$Generate, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$Get, + generate( + params?: Params$Resource$Projects$Locations$Schemas$Schemaversions$Generate, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$Get, + generate( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$Generate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$Get, + generate( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$Generate, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$Get, - callback: BodyResponseCallback + generate( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$Generate, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + generate( + callback: BodyResponseCallback ): void; - get( + generate( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Schemas$Schemaversions$Generate + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$Get; + {}) as Params$Resource$Projects$Locations$Schemas$Schemaversions$Generate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$Get; + {} as Params$Resource$Projects$Locations$Schemas$Schemaversions$Generate; options = {}; } @@ -10311,31 +12922,33 @@ export namespace documentai_v1beta3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta3/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: ( + rootUrl + '/v1beta3/{+parent}/schemaVersions:generate' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Retrieves a set of evaluations for a given processor version. + * Gets a schema version. * @example * ```js * // Before running the sample: @@ -10364,24 +12977,19 @@ export namespace documentai_v1beta3 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await documentai.projects.locations.processors.processorVersions.evaluations.list( - * { - * // The standard list page size. If unspecified, at most `5` evaluations are returned. The maximum value is `100`. Values above `100` are coerced to `100`. - * pageSize: 'placeholder-value', - * // A page token, received from a previous `ListEvaluations` call. Provide this to retrieve the subsequent page. - * pageToken: 'placeholder-value', - * // Required. The resource name of the ProcessorVersion to list evaluations for. `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` - * parent: - * 'projects/my-project/locations/my-location/processors/my-processor/processorVersions/my-processorVersion', - * }, - * ); + * const res = await documentai.projects.locations.schemas.schemaVersions.get({ + * // Required. The name of the SchemaVersion to get. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}/schemaVersions/{schema_version\}` + * name: 'projects/my-project/locations/my-location/schemas/my-schema/schemaVersions/my-schemaVersion', + * }); * console.log(res.data); * * // Example response * // { - * // "evaluations": [], - * // "nextPageToken": "my_nextPageToken" + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "labels": {}, + * // "name": "my_name", + * // "schema": {} * // } * } * @@ -10397,62 +13005,62 @@ export namespace documentai_v1beta3 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$List, + get( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$List, + get( + params?: Params$Resource$Projects$Locations$Schemas$Schemaversions$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$List, + get( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$List, + get( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Schemas$Schemaversions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$List; + {}) as Params$Resource$Projects$Locations$Schemas$Schemaversions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$List; + {} as Params$Resource$Projects$Locations$Schemas$Schemaversions$Get; options = {}; } @@ -10465,64 +13073,31 @@ export namespace documentai_v1beta3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta3/{+parent}/evaluations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1beta3/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$Get - extends StandardParameters { - /** - * Required. The resource name of the Evaluation to get. `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}/evaluations/{evaluation\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Processors$Processorversions$Evaluations$List - extends StandardParameters { - /** - * The standard list page size. If unspecified, at most `5` evaluations are returned. The maximum value is `100`. Values above `100` are coerced to `100`. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListEvaluations` call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. The resource name of the ProcessorVersion to list evaluations for. `projects/{project\}/locations/{location\}/processors/{processor\}/processorVersions/{processorVersion\}` - */ - parent?: string; - } - - export class Resource$Projects$Locations$Processortypes { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Gets a processor type detail. + * Lists SchemaVersions. * @example * ```js * // Before running the sample: @@ -10551,21 +13126,20 @@ export namespace documentai_v1beta3 { * google.options({auth: authClient}); * * // Do the magic - * const res = await documentai.projects.locations.processorTypes.get({ - * // Required. The processor type resource name. - * name: 'projects/my-project/locations/my-location/processorTypes/my-processorType', + * const res = await documentai.projects.locations.schemas.schemaVersions.list({ + * // Optional. The maximum number of SchemaVersion to return. If unspecified, at most `10` SchemaVersion will be returned. The maximum value is `20`. Values above `20` will be coerced to `20`. + * pageSize: 'placeholder-value', + * // Optional. We will return the SchemaVersion sorted by creation time. The page token will point to the next SchemaVersion. + * pageToken: 'placeholder-value', + * // Required. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}` + * parent: 'projects/my-project/locations/my-location/schemas/my-schema', * }); * console.log(res.data); * * // Example response * // { - * // "allowCreation": false, - * // "availableLocations": [], - * // "category": "my_category", - * // "launchStage": "my_launchStage", - * // "name": "my_name", - * // "sampleDocumentUris": [], - * // "type": "my_type" + * // "nextPageToken": "my_nextPageToken", + * // "schemaVersions": [] * // } * } * @@ -10581,61 +13155,62 @@ export namespace documentai_v1beta3 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Processortypes$Get, + list( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Processortypes$Get, + list( + params?: Params$Resource$Projects$Locations$Schemas$Schemaversions$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Processortypes$Get, + list( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Processortypes$Get, + list( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Processortypes$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processortypes$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Schemas$Schemaversions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processortypes$Get; + {}) as Params$Resource$Projects$Locations$Schemas$Schemaversions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Processortypes$Get; + params = + {} as Params$Resource$Projects$Locations$Schemas$Schemaversions$List; options = {}; } @@ -10648,31 +13223,34 @@ export namespace documentai_v1beta3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta3/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta3/{+parent}/schemaVersions').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists the processor types that exist. + * Updates a schema version. Editable fields are: - `display_name` - `labels` * @example * ```js * // Before running the sample: @@ -10701,20 +13279,33 @@ export namespace documentai_v1beta3 { * google.options({auth: authClient}); * * // Do the magic - * const res = await documentai.projects.locations.processorTypes.list({ - * // The maximum number of processor types to return. If unspecified, at most `100` processor types will be returned. The maximum value is `500`. Values above `500` will be coerced to `500`. - * pageSize: 'placeholder-value', - * // Used to retrieve the next page of results, empty if at the end of the list. - * pageToken: 'placeholder-value', - * // Required. The location of processor types to list. Format: `projects/{project\}/locations/{location\}`. - * parent: 'projects/my-project/locations/my-location', + * const res = await documentai.projects.locations.schemas.schemaVersions.patch({ + * // Identifier. The resource name of the SchemaVersion. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}/schemaVersions/{schema_version\}` + * name: 'projects/my-project/locations/my-location/schemas/my-schema/schemaVersions/my-schemaVersion', + * // Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name. - labels. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "labels": {}, + * // "name": "my_name", + * // "schema": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "processorTypes": [] + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "labels": {}, + * // "name": "my_name", + * // "schema": {} * // } * } * @@ -10730,61 +13321,62 @@ export namespace documentai_v1beta3 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Processortypes$List, + patch( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$Patch, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Processortypes$List, + patch( + params?: Params$Resource$Projects$Locations$Schemas$Schemaversions$Patch, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Processortypes$List, + patch( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Processortypes$List, + patch( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Processortypes$List, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Schemas$Schemaversions$Patch, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - list( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Processortypes$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Schemas$Schemaversions$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Processortypes$List; + {}) as Params$Resource$Projects$Locations$Schemas$Schemaversions$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Processortypes$List; + params = + {} as Params$Resource$Projects$Locations$Schemas$Schemaversions$Patch; options = {}; } @@ -10797,53 +13389,97 @@ export namespace documentai_v1beta3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta3/{+parent}/processorTypes').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1beta3/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Processortypes$Get + export interface Params$Resource$Projects$Locations$Schemas$Schemaversions$Create extends StandardParameters { /** - * Required. The processor type resource name. + * Required. The parent (project and location) under which to create the SchemaVersion. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDocumentaiV1beta3SchemaVersion; + } + export interface Params$Resource$Projects$Locations$Schemas$Schemaversions$Delete + extends StandardParameters { + /** + * Required. The name of the SchemaVersion to delete. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}/schemaVersions/{schema_version\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Processortypes$List + export interface Params$Resource$Projects$Locations$Schemas$Schemaversions$Generate extends StandardParameters { /** - * The maximum number of processor types to return. If unspecified, at most `100` processor types will be returned. The maximum value is `500`. Values above `500` will be coerced to `500`. + * Required. The parent (project, location and schema) under which to generate the SchemaVersion. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequest; + } + export interface Params$Resource$Projects$Locations$Schemas$Schemaversions$Get + extends StandardParameters { + /** + * Required. The name of the SchemaVersion to get. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}/schemaVersions/{schema_version\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Schemas$Schemaversions$List + extends StandardParameters { + /** + * Optional. The maximum number of SchemaVersion to return. If unspecified, at most `10` SchemaVersion will be returned. The maximum value is `20`. Values above `20` will be coerced to `20`. */ pageSize?: number; /** - * Used to retrieve the next page of results, empty if at the end of the list. + * Optional. We will return the SchemaVersion sorted by creation time. The page token will point to the next SchemaVersion. */ pageToken?: string; /** - * Required. The location of processor types to list. Format: `projects/{project\}/locations/{location\}`. + * Required. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}` */ parent?: string; } + export interface Params$Resource$Projects$Locations$Schemas$Schemaversions$Patch + extends StandardParameters { + /** + * Identifier. The resource name of the SchemaVersion. Format: `projects/{project\}/locations/{location\}/schemas/{schema\}/schemaVersions/{schema_version\}` + */ + name?: string; + /** + * Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name. - labels. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDocumentaiV1beta3SchemaVersion; + } } diff --git a/src/apis/drive/v3.ts b/src/apis/drive/v3.ts index 90d476443d..36cfc37152 100644 --- a/src/apis/drive/v3.ts +++ b/src/apis/drive/v3.ts @@ -523,6 +523,10 @@ export namespace drive_v3 { * A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Manage comments and replies](https://developers.google.com/workspace/drive/api/v3/manage-comments). */ anchor?: string | null; + /** + * Output only. The email of the user who is assigned to this comment, if none is assigned this will be unset. + */ + assigneeEmailAddress?: string | null; /** * Output only. The author of the comment. The author's email address and permission ID will not be populated. */ @@ -551,6 +555,10 @@ export namespace drive_v3 { * Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#comment"`. */ kind?: string | null; + /** + * Output only. The emails of the users who were mentioned in this comment, if none were mentioned this will be an empty list. + */ + mentionedEmailAddresses?: string[] | null; /** * The last time the comment or any of its replies was modified (RFC 3339 date-time). */ @@ -1431,6 +1439,10 @@ export namespace drive_v3 { * The action the reply performed to the parent comment. Valid values are: * `resolve` * `reopen` */ action?: string | null; + /** + * Output only. The email of the user who is assigned to this reply, if none is assigned this will be unset. + */ + assigneeEmailAddress?: string | null; /** * Output only. The author of the reply. The author's email address and permission ID will not be populated. */ @@ -1459,6 +1471,10 @@ export namespace drive_v3 { * Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#reply"`. */ kind?: string | null; + /** + * Output only. The emails of the users who were mentioned in this reply, if none were mentioned this will be an empty list. + */ + mentionedEmailAddresses?: string[] | null; /** * The last time the reply was modified (RFC 3339 date-time). */ @@ -3615,6 +3631,7 @@ export namespace drive_v3 { * // request body parameters * // { * // "anchor": "my_anchor", + * // "assigneeEmailAddress": "my_assigneeEmailAddress", * // "author": {}, * // "content": "my_content", * // "createdTime": "my_createdTime", @@ -3622,6 +3639,7 @@ export namespace drive_v3 { * // "htmlContent": "my_htmlContent", * // "id": "my_id", * // "kind": "my_kind", + * // "mentionedEmailAddresses": [], * // "modifiedTime": "my_modifiedTime", * // "quotedFileContent": {}, * // "replies": [], @@ -3634,6 +3652,7 @@ export namespace drive_v3 { * // Example response * // { * // "anchor": "my_anchor", + * // "assigneeEmailAddress": "my_assigneeEmailAddress", * // "author": {}, * // "content": "my_content", * // "createdTime": "my_createdTime", @@ -3641,6 +3660,7 @@ export namespace drive_v3 { * // "htmlContent": "my_htmlContent", * // "id": "my_id", * // "kind": "my_kind", + * // "mentionedEmailAddresses": [], * // "modifiedTime": "my_modifiedTime", * // "quotedFileContent": {}, * // "replies": [], @@ -3923,6 +3943,7 @@ export namespace drive_v3 { * // Example response * // { * // "anchor": "my_anchor", + * // "assigneeEmailAddress": "my_assigneeEmailAddress", * // "author": {}, * // "content": "my_content", * // "createdTime": "my_createdTime", @@ -3930,6 +3951,7 @@ export namespace drive_v3 { * // "htmlContent": "my_htmlContent", * // "id": "my_id", * // "kind": "my_kind", + * // "mentionedEmailAddresses": [], * // "modifiedTime": "my_modifiedTime", * // "quotedFileContent": {}, * // "replies": [], @@ -4225,6 +4247,7 @@ export namespace drive_v3 { * // request body parameters * // { * // "anchor": "my_anchor", + * // "assigneeEmailAddress": "my_assigneeEmailAddress", * // "author": {}, * // "content": "my_content", * // "createdTime": "my_createdTime", @@ -4232,6 +4255,7 @@ export namespace drive_v3 { * // "htmlContent": "my_htmlContent", * // "id": "my_id", * // "kind": "my_kind", + * // "mentionedEmailAddresses": [], * // "modifiedTime": "my_modifiedTime", * // "quotedFileContent": {}, * // "replies": [], @@ -4244,6 +4268,7 @@ export namespace drive_v3 { * // Example response * // { * // "anchor": "my_anchor", + * // "assigneeEmailAddress": "my_assigneeEmailAddress", * // "author": {}, * // "content": "my_content", * // "createdTime": "my_createdTime", @@ -4251,6 +4276,7 @@ export namespace drive_v3 { * // "htmlContent": "my_htmlContent", * // "id": "my_id", * // "kind": "my_kind", + * // "mentionedEmailAddresses": [], * // "modifiedTime": "my_modifiedTime", * // "quotedFileContent": {}, * // "replies": [], @@ -9658,6 +9684,7 @@ export namespace drive_v3 { * // request body parameters * // { * // "action": "my_action", + * // "assigneeEmailAddress": "my_assigneeEmailAddress", * // "author": {}, * // "content": "my_content", * // "createdTime": "my_createdTime", @@ -9665,6 +9692,7 @@ export namespace drive_v3 { * // "htmlContent": "my_htmlContent", * // "id": "my_id", * // "kind": "my_kind", + * // "mentionedEmailAddresses": [], * // "modifiedTime": "my_modifiedTime" * // } * }, @@ -9674,6 +9702,7 @@ export namespace drive_v3 { * // Example response * // { * // "action": "my_action", + * // "assigneeEmailAddress": "my_assigneeEmailAddress", * // "author": {}, * // "content": "my_content", * // "createdTime": "my_createdTime", @@ -9681,6 +9710,7 @@ export namespace drive_v3 { * // "htmlContent": "my_htmlContent", * // "id": "my_id", * // "kind": "my_kind", + * // "mentionedEmailAddresses": [], * // "modifiedTime": "my_modifiedTime" * // } * } @@ -9964,6 +9994,7 @@ export namespace drive_v3 { * // Example response * // { * // "action": "my_action", + * // "assigneeEmailAddress": "my_assigneeEmailAddress", * // "author": {}, * // "content": "my_content", * // "createdTime": "my_createdTime", @@ -9971,6 +10002,7 @@ export namespace drive_v3 { * // "htmlContent": "my_htmlContent", * // "id": "my_id", * // "kind": "my_kind", + * // "mentionedEmailAddresses": [], * // "modifiedTime": "my_modifiedTime" * // } * } @@ -10265,6 +10297,7 @@ export namespace drive_v3 { * // request body parameters * // { * // "action": "my_action", + * // "assigneeEmailAddress": "my_assigneeEmailAddress", * // "author": {}, * // "content": "my_content", * // "createdTime": "my_createdTime", @@ -10272,6 +10305,7 @@ export namespace drive_v3 { * // "htmlContent": "my_htmlContent", * // "id": "my_id", * // "kind": "my_kind", + * // "mentionedEmailAddresses": [], * // "modifiedTime": "my_modifiedTime" * // } * }, @@ -10281,6 +10315,7 @@ export namespace drive_v3 { * // Example response * // { * // "action": "my_action", + * // "assigneeEmailAddress": "my_assigneeEmailAddress", * // "author": {}, * // "content": "my_content", * // "createdTime": "my_createdTime", @@ -10288,6 +10323,7 @@ export namespace drive_v3 { * // "htmlContent": "my_htmlContent", * // "id": "my_id", * // "kind": "my_kind", + * // "mentionedEmailAddresses": [], * // "modifiedTime": "my_modifiedTime" * // } * } diff --git a/src/apis/eventarc/v1.ts b/src/apis/eventarc/v1.ts index 7027f258d4..edfad3985a 100644 --- a/src/apis/eventarc/v1.ts +++ b/src/apis/eventarc/v1.ts @@ -1662,7 +1662,7 @@ export namespace eventarc_v1 { * * // Do the magic * const res = await eventarc.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -1950,7 +1950,7 @@ export namespace eventarc_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/file/v1.ts b/src/apis/file/v1.ts index 4a4e6ad8ab..bb69cb8558 100644 --- a/src/apis/file/v1.ts +++ b/src/apis/file/v1.ts @@ -244,6 +244,15 @@ export namespace file_v1 { */ time?: Schema$TimeOfDay; } + /** + * Directory Services configuration for Kerberos-based authentication. + */ + export interface Schema$DirectoryServicesConfig { + /** + * Configuration for LDAP servers. + */ + ldap?: Schema$LdapConfig; + } /** * 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); \} */ @@ -519,6 +528,10 @@ export namespace file_v1 { * The description of the instance (2048 characters or less). */ description?: string | null; + /** + * Optional. Directory Services configuration for Kerberos-based authentication. Should only be set if protocol is "NFS_V4_1". + */ + directoryServices?: Schema$DirectoryServicesConfig; /** * Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other. */ @@ -605,6 +618,27 @@ export namespace file_v1 { */ maxIopsPerTb?: string | null; } + /** + * LdapConfig contains all the parameters for connecting to LDAP servers. + */ + export interface Schema$LdapConfig { + /** + * Required. The LDAP domain name in the format of `my-domain.com`. + */ + domain?: string | null; + /** + * Optional. The groups Organizational Unit (OU) is optional. This parameter is a hint to allow faster lookup in the LDAP namespace. In case that this parameter is not provided, Filestore instance will query the whole LDAP namespace. + */ + groupsOu?: string | null; + /** + * Required. The servers names are used for specifying the LDAP servers names. The LDAP servers names can come with two formats: 1. DNS name, for example: `ldap.example1.com`, `ldap.example2.com`. 2. IP address, for example: `10.0.0.1`, `10.0.0.2`, `10.0.0.3`. All servers names must be in the same format: either all DNS names or all IP addresses. + */ + servers?: string[] | null; + /** + * Optional. The users Organizational Unit (OU) is optional. This parameter is a hint to allow faster lookup in the LDAP namespace. In case that this parameter is not provided, Filestore instance will query the whole LDAP namespace. + */ + usersOu?: string | null; + } /** * ListBackupsResponse is the result of ListBackupsRequest. */ @@ -664,6 +698,10 @@ export namespace file_v1 { * A list of operations that matches the specified filter in the request. */ operations?: Schema$Operation[]; + /** + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; } /** * ListSnapshotsResponse is the result of ListSnapshotsRequest. @@ -2337,6 +2375,7 @@ export namespace file_v1 { * // "deletionProtectionEnabled": false, * // "deletionProtectionReason": "my_deletionProtectionReason", * // "description": "my_description", + * // "directoryServices": {}, * // "etag": "my_etag", * // "fileShares": [], * // "kmsKeyName": "my_kmsKeyName", @@ -2650,6 +2689,7 @@ export namespace file_v1 { * // "deletionProtectionEnabled": false, * // "deletionProtectionReason": "my_deletionProtectionReason", * // "description": "my_description", + * // "directoryServices": {}, * // "etag": "my_etag", * // "fileShares": [], * // "kmsKeyName": "my_kmsKeyName", @@ -2959,6 +2999,7 @@ export namespace file_v1 { * // "deletionProtectionEnabled": false, * // "deletionProtectionReason": "my_deletionProtectionReason", * // "description": "my_description", + * // "directoryServices": {}, * // "etag": "my_etag", * // "fileShares": [], * // "kmsKeyName": "my_kmsKeyName", @@ -4921,13 +4962,16 @@ export namespace file_v1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -5073,5 +5117,9 @@ export namespace file_v1 { * The standard list page token. */ pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } } diff --git a/src/apis/file/v1beta1.ts b/src/apis/file/v1beta1.ts index bebb247129..4b6b990a70 100644 --- a/src/apis/file/v1beta1.ts +++ b/src/apis/file/v1beta1.ts @@ -718,6 +718,10 @@ export namespace file_v1beta1 { * A list of operations that matches the specified filter in the request. */ operations?: Schema$Operation[]; + /** + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; } /** * ListSharesResponse is the result of ListSharesRequest. @@ -6230,13 +6234,16 @@ export namespace file_v1beta1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -6382,5 +6389,9 @@ export namespace file_v1beta1 { * The standard list page token. */ pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } } diff --git a/src/apis/firebaseappdistribution/v1alpha.ts b/src/apis/firebaseappdistribution/v1alpha.ts index 3ee4f9e9aa..52880f0c86 100644 --- a/src/apis/firebaseappdistribution/v1alpha.ts +++ b/src/apis/firebaseappdistribution/v1alpha.ts @@ -305,6 +305,19 @@ export namespace firebaseappdistribution_v1alpha { * The (empty) response message for `CancelReleaseTest`. */ export interface Schema$GoogleFirebaseAppdistroV1alphaCancelReleaseTestResponse {} + /** + * Request message for `ClearTestCaseCache`. + */ + export interface Schema$GoogleFirebaseAppdistroV1alphaClearTestCaseCacheRequest { + /** + * Optional. The list of devices for which to clear the cache. If not present, clear all of them. + */ + testDevices?: Schema$GoogleFirebaseAppdistroV1alphaTestDevice[]; + } + /** + * Response empty (google.protobuf.Empty) message for `ClearTestCaseCache` + */ + export interface Schema$GoogleFirebaseAppdistroV1alphaClearTestCaseCacheResponse {} /** * The request message for `CreateReleaseNotes`. */ @@ -3743,6 +3756,162 @@ export namespace firebaseappdistribution_v1alpha { } } + /** + * Clears cached test runs for a specific test case and device(s). + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/firebaseappdistribution.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const firebaseappdistribution = google.firebaseappdistribution('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await firebaseappdistribution.projects.apps.testCases.clearTestCaseCache({ + * // Required. The name of the test case resource for which to clear the cache. Format: `projects/{project_number\}/apps/{app_id\}/testCases/{test_case_id\}` + * testCase: 'projects/my-project/apps/my-app/testCases/my-testCase', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "testDevices": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // {} + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + clearTestCaseCache( + params: Params$Resource$Projects$Apps$Testcases$Cleartestcasecache, + options: StreamMethodOptions + ): Promise>; + clearTestCaseCache( + params?: Params$Resource$Projects$Apps$Testcases$Cleartestcasecache, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + clearTestCaseCache( + params: Params$Resource$Projects$Apps$Testcases$Cleartestcasecache, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + clearTestCaseCache( + params: Params$Resource$Projects$Apps$Testcases$Cleartestcasecache, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + clearTestCaseCache( + params: Params$Resource$Projects$Apps$Testcases$Cleartestcasecache, + callback: BodyResponseCallback + ): void; + clearTestCaseCache( + callback: BodyResponseCallback + ): void; + clearTestCaseCache( + paramsOrCallback?: + | Params$Resource$Projects$Apps$Testcases$Cleartestcasecache + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Apps$Testcases$Cleartestcasecache; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Apps$Testcases$Cleartestcasecache; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseappdistribution.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+testCase}:clearTestCaseCache').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['testCase'], + pathParams: ['testCase'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Create a new test case. * @example @@ -4537,6 +4706,18 @@ export namespace firebaseappdistribution_v1alpha { */ requestBody?: Schema$GoogleFirebaseAppdistroV1alphaBatchUpdateTestCasesRequest; } + export interface Params$Resource$Projects$Apps$Testcases$Cleartestcasecache + extends StandardParameters { + /** + * Required. The name of the test case resource for which to clear the cache. Format: `projects/{project_number\}/apps/{app_id\}/testCases/{test_case_id\}` + */ + testCase?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleFirebaseAppdistroV1alphaClearTestCaseCacheRequest; + } export interface Params$Resource$Projects$Apps$Testcases$Create extends StandardParameters { /** diff --git a/src/apis/firebaseapphosting/v1.ts b/src/apis/firebaseapphosting/v1.ts index f6ac21b528..8b1969c9ba 100644 --- a/src/apis/firebaseapphosting/v1.ts +++ b/src/apis/firebaseapphosting/v1.ts @@ -729,6 +729,10 @@ export namespace firebaseapphosting_v1 { * A list of operations that matches the specified filter in the request. */ operations?: Schema$Operation[]; + /** + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; } /** * Message for response to list rollouts. @@ -1304,7 +1308,7 @@ export namespace firebaseapphosting_v1 { * * // Do the magic * const res = await firebaseapphosting.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -1433,7 +1437,7 @@ export namespace firebaseapphosting_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** @@ -5338,13 +5342,16 @@ export namespace firebaseapphosting_v1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -5491,5 +5498,9 @@ export namespace firebaseapphosting_v1 { * The standard list page token. */ pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } } diff --git a/src/apis/firebaseapphosting/v1beta.ts b/src/apis/firebaseapphosting/v1beta.ts index 7e85a0017b..ccb0d9a88b 100644 --- a/src/apis/firebaseapphosting/v1beta.ts +++ b/src/apis/firebaseapphosting/v1beta.ts @@ -741,6 +741,10 @@ export namespace firebaseapphosting_v1beta { * A list of operations that matches the specified filter in the request. */ operations?: Schema$Operation[]; + /** + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; } /** * Message for response to list rollouts. @@ -1316,7 +1320,7 @@ export namespace firebaseapphosting_v1beta { * * // Do the magic * const res = await firebaseapphosting.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -1445,7 +1449,7 @@ export namespace firebaseapphosting_v1beta { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** @@ -5357,13 +5361,16 @@ export namespace firebaseapphosting_v1beta { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -5505,5 +5512,9 @@ export namespace firebaseapphosting_v1beta { * The standard list page token. */ pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } } diff --git a/src/apis/firebasedataconnect/v1.ts b/src/apis/firebasedataconnect/v1.ts index fd28102ce5..597c0b462c 100644 --- a/src/apis/firebasedataconnect/v1.ts +++ b/src/apis/firebasedataconnect/v1.ts @@ -261,7 +261,7 @@ export namespace firebasedataconnect_v1 { path?: string | null; } /** - * GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql` and `ExecuteGraphqlRead` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation` and `ExecuteQuery` all return Code.OK with a list of `GraphqlError` in response body. + * GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql`, `ExecuteGraphqlRead` and `IntrospectGraphql` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation`, `ExecuteQuery`, `IntrospectGraphql`, `ImpersonateQuery` and `ImpersonateMutation` all return Code.OK with a list of `GraphqlError` in response body. */ export interface Schema$GraphqlError { /** @@ -269,7 +269,7 @@ export namespace firebasedataconnect_v1 { */ extensions?: Schema$GraphqlErrorExtensions; /** - * The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source. + * The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `IntrospectGraphql`, `ImpersonateQuery`, `ImpersonateMutation`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source. */ locations?: Schema$SourceLocation[]; /** @@ -298,9 +298,13 @@ export namespace firebasedataconnect_v1 { */ file?: string | null; /** - * Distinguish which schema or connector the error originates from. It should be set on errors from control plane APIs (e.g. `UpdateSchema`, `UpdateConnector`). + * Warning level describes the severity and required action to suppress this warning when Firebase CLI run into it. */ - resource?: string | null; + warningLevel?: string | null; + /** + * Workarounds provide suggestions to address the compile errors or warnings. + */ + workarounds?: Schema$Workaround[]; } /** * The GraphQL request to Firebase Data Connect. It strives to match the GraphQL over HTTP spec. https://github.com/graphql/graphql-over-http/blob/main/spec/GraphQLOverHTTP.md#post @@ -421,6 +425,10 @@ export namespace firebasedataconnect_v1 { * A list of operations that matches the specified filter in the request. */ operations?: Schema$Operation[]; + /** + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; } /** * Message for response to listing Schemas. By default, `schemas.source` will not be included in the response. To specify the fields included in the response, the response field mask can be provided by using the query parameter `$fields` or the header `X-Goog-FieldMask`. @@ -697,6 +705,23 @@ export namespace firebasedataconnect_v1 { */ message?: string | null; } + /** + * Workaround provides suggestions to address errors and warnings. + */ + export interface Schema$Workaround { + /** + * Description of this workaround. + */ + description?: string | null; + /** + * Why would this workaround address the error and warning. + */ + reason?: string | null; + /** + * A suggested code snippet to fix the error and warning. + */ + replace?: string | null; + } export class Resource$Projects { context: APIRequestContext; @@ -889,7 +914,7 @@ export namespace firebasedataconnect_v1 { * * // Do the magic * const res = await firebasedataconnect.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -1018,7 +1043,7 @@ export namespace firebasedataconnect_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** @@ -1495,13 +1520,16 @@ export namespace firebasedataconnect_v1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -1648,6 +1676,10 @@ export namespace firebasedataconnect_v1 { * The standard list page token. */ pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Services { diff --git a/src/apis/firebasedataconnect/v1beta.ts b/src/apis/firebasedataconnect/v1beta.ts index a4fef66969..710e6442bb 100644 --- a/src/apis/firebasedataconnect/v1beta.ts +++ b/src/apis/firebasedataconnect/v1beta.ts @@ -261,7 +261,7 @@ export namespace firebasedataconnect_v1beta { path?: string | null; } /** - * GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql` and `ExecuteGraphqlRead` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation` and `ExecuteQuery` all return Code.OK with a list of `GraphqlError` in response body. + * GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql`, `ExecuteGraphqlRead` and `IntrospectGraphql` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation`, `ExecuteQuery`, `IntrospectGraphql`, `ImpersonateQuery` and `ImpersonateMutation` all return Code.OK with a list of `GraphqlError` in response body. */ export interface Schema$GraphqlError { /** @@ -269,7 +269,7 @@ export namespace firebasedataconnect_v1beta { */ extensions?: Schema$GraphqlErrorExtensions; /** - * The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source. + * The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `IntrospectGraphql`, `ImpersonateQuery`, `ImpersonateMutation`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source. */ locations?: Schema$SourceLocation[]; /** @@ -298,9 +298,13 @@ export namespace firebasedataconnect_v1beta { */ file?: string | null; /** - * Distinguish which schema or connector the error originates from. It should be set on errors from control plane APIs (e.g. `UpdateSchema`, `UpdateConnector`). + * Warning level describes the severity and required action to suppress this warning when Firebase CLI run into it. */ - resource?: string | null; + warningLevel?: string | null; + /** + * Workarounds provide suggestions to address the compile errors or warnings. + */ + workarounds?: Schema$Workaround[]; } /** * The GraphQL request to Firebase Data Connect. It strives to match the GraphQL over HTTP spec. https://github.com/graphql/graphql-over-http/blob/main/spec/GraphQLOverHTTP.md#post @@ -421,6 +425,10 @@ export namespace firebasedataconnect_v1beta { * A list of operations that matches the specified filter in the request. */ operations?: Schema$Operation[]; + /** + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; } /** * Message for response to listing Schemas. By default, `schemas.source` will not be included in the response. To specify the fields included in the response, the response field mask can be provided by using the query parameter `$fields` or the header `X-Goog-FieldMask`. @@ -697,6 +705,23 @@ export namespace firebasedataconnect_v1beta { */ message?: string | null; } + /** + * Workaround provides suggestions to address errors and warnings. + */ + export interface Schema$Workaround { + /** + * Description of this workaround. + */ + description?: string | null; + /** + * Why would this workaround address the error and warning. + */ + reason?: string | null; + /** + * A suggested code snippet to fix the error and warning. + */ + replace?: string | null; + } export class Resource$Projects { context: APIRequestContext; @@ -889,7 +914,7 @@ export namespace firebasedataconnect_v1beta { * * // Do the magic * const res = await firebasedataconnect.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -1018,7 +1043,7 @@ export namespace firebasedataconnect_v1beta { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** @@ -1498,13 +1523,16 @@ export namespace firebasedataconnect_v1beta { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -1651,6 +1679,10 @@ export namespace firebasedataconnect_v1beta { * The standard list page token. */ pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Services { diff --git a/src/apis/firebaseml/v2beta.ts b/src/apis/firebaseml/v2beta.ts index be1eb941fe..d7427f3603 100644 --- a/src/apis/firebaseml/v2beta.ts +++ b/src/apis/firebaseml/v2beta.ts @@ -258,15 +258,15 @@ export namespace firebaseml_v2beta { serviceAccount?: string | null; } /** - * Content blob. + * A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. */ export interface Schema$GoogleCloudAiplatformV1beta1Blob { /** - * Required. Raw bytes. + * Required. The raw bytes of the data. */ data?: string | null; /** - * Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + * Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. */ displayName?: string | null; /** @@ -279,81 +279,81 @@ export namespace firebaseml_v2beta { */ export interface Schema$GoogleCloudAiplatformV1beta1Candidate { /** - * Output only. Average log probability score of the candidate. + * Output only. The average log probability of the tokens in this candidate. This is a length-normalized score that can be used to compare the quality of candidates of different lengths. A higher average log probability suggests a more confident and coherent response. */ avgLogprobs?: number | null; /** - * Output only. Source attribution of the generated content. + * Output only. A collection of citations that apply to the generated content. */ citationMetadata?: Schema$GoogleCloudAiplatformV1beta1CitationMetadata; /** - * Output only. Content parts of the candidate. + * Output only. The content of the candidate. */ content?: Schema$GoogleCloudAiplatformV1beta1Content; /** - * Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set. + * Output only. Describes the reason the model stopped generating tokens in more detail. This field is returned only when `finish_reason` is set. */ finishMessage?: string | null; /** - * Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens. + * Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating. */ finishReason?: string | null; /** - * Output only. Metadata specifies sources used to ground generated content. + * Output only. Metadata returned when grounding is enabled. It contains the sources used to ground the generated content. */ groundingMetadata?: Schema$GoogleCloudAiplatformV1beta1GroundingMetadata; /** - * Output only. Index of the candidate. + * Output only. The 0-based index of this candidate in the list of generated responses. This is useful for distinguishing between multiple candidates when `candidate_count` \> 1. */ index?: number | null; /** - * Output only. Log-likelihood scores for the response tokens and top tokens + * Output only. The detailed log probability information for the tokens in this candidate. This is useful for debugging, understanding model uncertainty, and identifying potential "hallucinations". */ logprobsResult?: Schema$GoogleCloudAiplatformV1beta1LogprobsResult; /** - * Output only. List of ratings for the safety of a response candidate. There is at most one rating per category. + * Output only. A list of ratings for the safety of a response candidate. There is at most one rating per category. */ safetyRatings?: Schema$GoogleCloudAiplatformV1beta1SafetyRating[]; /** - * Output only. Metadata related to url context retrieval tool. + * Output only. Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. */ urlContextMetadata?: Schema$GoogleCloudAiplatformV1beta1UrlContextMetadata; } /** - * Source attributions for content. + * A citation for a piece of generatedcontent. */ export interface Schema$GoogleCloudAiplatformV1beta1Citation { /** - * Output only. End index into the content. + * Output only. The end index of the citation in the content. */ endIndex?: number | null; /** - * Output only. License of the attribution. + * Output only. The license of the source of the citation. */ license?: string | null; /** - * Output only. Publication date of the attribution. + * Output only. The publication date of the source of the citation. */ publicationDate?: Schema$Date; /** - * Output only. Start index into the content. + * Output only. The start index of the citation in the content. */ startIndex?: number | null; /** - * Output only. Title of the attribution. + * Output only. The title of the source of the citation. */ title?: string | null; /** - * Output only. Url reference of the attribution. + * Output only. The URI of the source of the citation. */ uri?: string | null; } /** - * A collection of source attributions for a piece of content. + * A collection of citations that apply to a piece of generated content. */ export interface Schema$GoogleCloudAiplatformV1beta1CitationMetadata { /** - * Output only. List of citations. + * Output only. A list of citations for the content. */ citations?: Schema$GoogleCloudAiplatformV1beta1Citation[]; } @@ -371,15 +371,15 @@ export namespace firebaseml_v2beta { output?: string | null; } /** - * The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. + * The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. */ export interface Schema$GoogleCloudAiplatformV1beta1Content { /** - * Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. + * Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. */ parts?: Schema$GoogleCloudAiplatformV1beta1Part[]; /** - * Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + * Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. */ role?: string | null; } @@ -519,15 +519,15 @@ export namespace firebaseml_v2beta { */ export interface Schema$GoogleCloudAiplatformV1beta1ExternalApiSimpleSearchParams {} /** - * URI based data. + * URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. */ export interface Schema$GoogleCloudAiplatformV1beta1FileData { /** - * Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + * Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. */ displayName?: string | null; /** - * Required. URI. + * Required. The URI of the file in Google Cloud Storage. */ fileUri?: string | null; /** @@ -799,23 +799,23 @@ export namespace firebaseml_v2beta { trafficType?: string | null; } /** - * Generation config. + * Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. */ export interface Schema$GoogleCloudAiplatformV1beta1GenerationConfig { /** - * Optional. If enabled, audio timestamp will be included in the request to the model. + * Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. */ audioTimestamp?: boolean | null; /** - * Optional. Number of candidates to generate. + * Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. */ candidateCount?: number | null; /** - * Optional. If enabled, the model will detect emotions and adapt its responses accordingly. + * Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. */ enableAffectiveDialog?: boolean | null; /** - * Optional. Frequency penalties. + * Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. */ frequencyPenalty?: number | null; /** @@ -823,15 +823,15 @@ export namespace firebaseml_v2beta { */ imageConfig?: Schema$GoogleCloudAiplatformV1beta1ImageConfig; /** - * Optional. Logit probabilities. + * Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. */ logprobs?: number | null; /** - * Optional. The maximum number of output tokens to generate per message. + * Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. */ maxOutputTokens?: number | null; /** - * Optional. If specified, the media resolution specified will be used. + * Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. */ mediaResolution?: string | null; /** @@ -839,27 +839,27 @@ export namespace firebaseml_v2beta { */ modelConfig?: Schema$GoogleCloudAiplatformV1beta1GenerationConfigModelConfig; /** - * Optional. Positive penalties. + * Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. */ presencePenalty?: number | null; /** - * Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. + * Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. */ responseJsonSchema?: any | null; /** - * Optional. If true, export the logprobs results in response. + * Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. */ responseLogprobs?: boolean | null; /** - * Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + * Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. */ responseMimeType?: string | null; /** - * Optional. The modalities of the response. + * Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. */ responseModalities?: string[] | null; /** - * Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + * Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. */ responseSchema?: Schema$GoogleCloudAiplatformV1beta1Schema; /** @@ -867,7 +867,7 @@ export namespace firebaseml_v2beta { */ routingConfig?: Schema$GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig; /** - * Optional. Seed. + * Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. */ seed?: number | null; /** @@ -875,23 +875,23 @@ export namespace firebaseml_v2beta { */ speechConfig?: Schema$GoogleCloudAiplatformV1beta1SpeechConfig; /** - * Optional. Stop sequences. + * Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. */ stopSequences?: string[] | null; /** - * Optional. Controls the randomness of predictions. + * Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. */ temperature?: number | null; /** - * Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. + * Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. */ thinkingConfig?: Schema$GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig; /** - * Optional. If specified, top-k sampling will be used. + * Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. */ topK?: number | null; /** - * Optional. If specified, nucleus sampling will be used. + * Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. */ topP?: number | null; } @@ -905,20 +905,20 @@ export namespace firebaseml_v2beta { featureSelectionPreference?: string | null; } /** - * The configuration for routing the request to a specific model. + * The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. */ export interface Schema$GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig { /** - * Automated routing. + * In this mode, the model is selected automatically based on the content of the request. */ autoMode?: Schema$GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode; /** - * Manual routing. + * In this mode, the model is specified manually. */ manualMode?: Schema$GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode; } /** - * When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. + * The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. */ export interface Schema$GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode { /** @@ -927,24 +927,24 @@ export namespace firebaseml_v2beta { modelRoutingPreference?: string | null; } /** - * When manual routing is set, the specified model will be used directly. + * The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. */ export interface Schema$GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode { /** - * The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + * The name of the model to use. Only public LLM models are accepted. */ modelName?: string | null; } /** - * Config for thinking features. + * Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. */ export interface Schema$GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig { /** - * Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. + * Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. */ includeThoughts?: boolean | null; /** - * Optional. Indicates the thinking budget in tokens. + * Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. */ thinkingBudget?: number | null; } @@ -967,58 +967,58 @@ export namespace firebaseml_v2beta { dynamicRetrievalConfig?: Schema$GoogleCloudAiplatformV1beta1DynamicRetrievalConfig; } /** - * Grounding chunk. + * A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information. */ export interface Schema$GoogleCloudAiplatformV1beta1GroundingChunk { /** - * Grounding chunk from Google Maps. + * A grounding chunk from Google Maps. See the `Maps` message for details. */ maps?: Schema$GoogleCloudAiplatformV1beta1GroundingChunkMaps; /** - * Grounding chunk from context retrieved by the retrieval tools. + * A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details */ retrievedContext?: Schema$GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext; /** - * Grounding chunk from the web. + * A grounding chunk from a web page, typically from Google Search. See the `Web` message for details. */ web?: Schema$GoogleCloudAiplatformV1beta1GroundingChunkWeb; } /** - * Chunk from Google Maps. + * A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains information about a place, such as its name, address, and reviews. This is used to provide the user with rich, location-based information. */ export interface Schema$GoogleCloudAiplatformV1beta1GroundingChunkMaps { /** - * Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. + * The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. */ placeAnswerSources?: Schema$GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources; /** - * This Place's resource name, in `places/{place_id\}` format. Can be used to look up the Place. + * This Place's resource name, in `places/{place_id\}` format. This can be used to look up the place in the Google Maps API. */ placeId?: string | null; /** - * Text of the place answer. + * The text of the place answer. */ text?: string | null; /** - * Title of the place. + * The title of the place. */ title?: string | null; /** - * URI reference of the place. + * The URI of the place. */ uri?: string | null; } /** - * Sources used to generate the place answer. + * The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. */ export interface Schema$GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources { /** - * Snippets of reviews that are used to generate the answer. + * Snippets of reviews that were used to generate the answer. */ reviewSnippets?: Schema$GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet[]; } /** - * Encapsulates a review snippet. + * A review snippet that is used to generate the answer. */ export interface Schema$GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet { /** @@ -1026,125 +1026,125 @@ export namespace firebaseml_v2beta { */ googleMapsUri?: string | null; /** - * Id of the review referencing the place. + * The ID of the review that is being referenced. */ reviewId?: string | null; /** - * Title of the review. + * The title of the review. */ title?: string | null; } /** - * Chunk from context retrieved by the retrieval tools. + * Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset. */ export interface Schema$GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext { /** - * Output only. The full document name for the referenced Vertex AI Search document. + * Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. */ documentName?: string | null; /** - * Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool. + * Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used. */ ragChunk?: Schema$GoogleCloudAiplatformV1beta1RagChunk; /** - * Text of the attribution. + * The content of the retrieved data source. */ text?: string | null; /** - * Title of the attribution. + * The title of the retrieved data source. */ title?: string | null; /** - * URI reference of the attribution. + * The URI of the retrieved data source. */ uri?: string | null; } /** - * Chunk from the web. + * A `Web` chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information. */ export interface Schema$GoogleCloudAiplatformV1beta1GroundingChunkWeb { /** - * Domain of the (original) URI. + * The domain of the web page that contains the evidence. This can be used to filter out low-quality sources. */ domain?: string | null; /** - * Title of the chunk. + * The title of the web page that contains the evidence. */ title?: string | null; /** - * URI reference of the chunk. + * The URI of the web page that contains the evidence. */ uri?: string | null; } /** - * Metadata returned to client when grounding is enabled. + * Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources. */ export interface Schema$GoogleCloudAiplatformV1beta1GroundingMetadata { /** - * 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. + * Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. */ googleMapsWidgetContextToken?: string | null; /** - * List of supporting references retrieved from specified grounding source. + * A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps. */ groundingChunks?: Schema$GoogleCloudAiplatformV1beta1GroundingChunk[]; /** - * Optional. List of grounding support. + * Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search. */ groundingSupports?: Schema$GoogleCloudAiplatformV1beta1GroundingSupport[]; /** - * Optional. Output only. Retrieval metadata. + * Optional. Output only. Metadata related to the retrieval grounding source. */ retrievalMetadata?: Schema$GoogleCloudAiplatformV1beta1RetrievalMetadata; /** - * Optional. Queries executed by the retrieval tools. + * Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search. */ retrievalQueries?: string[] | null; /** - * Optional. Google search entry for the following-up web searches. + * Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search. */ searchEntryPoint?: Schema$GoogleCloudAiplatformV1beta1SearchEntryPoint; /** - * Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. + * Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps. */ sourceFlaggingUris?: Schema$GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri[]; /** - * Optional. Web search queries for the following-up web search. + * Optional. The web search queries that were used to generate the content. This field is populated only when the grounding source is Google Search. */ webSearchQueries?: string[] | null; } /** - * Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. + * A URI that can be used to flag a place or review for inappropriate content. This is populated only when the grounding source is Google Maps. */ export interface Schema$GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri { /** - * A link where users can flag a problem with the source (place or review). + * The URI that can be used to flag the content. */ flagContentUri?: string | null; /** - * Id of the place or review. + * The ID of the place or review. */ sourceId?: string | null; } /** - * Grounding support. + * A collection of supporting references for a segment of the model's response. */ export interface Schema$GoogleCloudAiplatformV1beta1GroundingSupport { /** - * Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored. + * The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored. */ confidenceScores?: number[] | null; /** - * A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim. + * A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment. */ groundingChunkIndices?: number[] | null; /** - * Segment of the content this support belongs to. + * The content segment that this support message applies to. */ segment?: Schema$GoogleCloudAiplatformV1beta1Segment; } /** - * Config for image generation features. + * Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. */ export interface Schema$GoogleCloudAiplatformV1beta1ImageConfig { /** @@ -1174,72 +1174,72 @@ export namespace firebaseml_v2beta { mimeType?: string | null; } /** - * Logprobs Result + * The log probabilities of the tokens generated by the model. This is useful for understanding the model's confidence in its predictions and for debugging. For example, you can use log probabilities to identify when the model is making a less confident prediction or to explore alternative responses that the model considered. A low log probability can also indicate that the model is "hallucinating" or generating factually incorrect information. */ export interface Schema$GoogleCloudAiplatformV1beta1LogprobsResult { /** - * Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates. + * A list of the chosen candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. Note that the chosen candidate might not be in `top_candidates`. */ chosenCandidates?: Schema$GoogleCloudAiplatformV1beta1LogprobsResultCandidate[]; /** - * Length = total number of decoding steps. + * A list of the top candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. */ topCandidates?: Schema$GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates[]; } /** - * Candidate for the logprobs token and score. + * A single token and its associated log probability. */ export interface Schema$GoogleCloudAiplatformV1beta1LogprobsResultCandidate { /** - * The candidate's log probability. + * The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain. */ logProbability?: number | null; /** - * The candidate's token string value. + * The token's string representation. */ token?: string | null; /** - * The candidate's token id value. + * The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary. */ tokenId?: number | null; } /** - * Candidates with top log probabilities at each decoding step. + * A list of the top candidate tokens and their log probabilities at each decoding step. This can be used to see what other tokens the model considered. */ export interface Schema$GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates { /** - * Sorted by log probability in descending order. + * The list of candidate tokens, sorted by log probability in descending order. */ candidates?: Schema$GoogleCloudAiplatformV1beta1LogprobsResultCandidate[]; } /** - * Represents token counting info for a single modality. + * Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. */ export interface Schema$GoogleCloudAiplatformV1beta1ModalityTokenCount { /** - * The modality associated with this token count. + * The modality that this token count applies to. */ modality?: string | null; /** - * Number of tokens. + * The number of tokens counted for this modality. */ tokenCount?: number | null; } /** - * Configuration for Model Armor integrations of prompt and responses. + * Configuration for Model Armor. Model Armor is a Google Cloud service that provides safety and security filtering for prompts and responses. It helps protect your AI applications from risks such as harmful content, sensitive data leakage, and prompt injection attacks. */ export interface Schema$GoogleCloudAiplatformV1beta1ModelArmorConfig { /** - * Optional. The name of the Model Armor template to use for prompt sanitization. + * Optional. The resource name of the Model Armor template to use for prompt screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the user's prompt for safety and security risks before it is sent to the model. The name must be in the format `projects/{project\}/locations/{location\}/templates/{template\}`. */ promptTemplateName?: string | null; /** - * Optional. The name of the Model Armor template to use for response sanitization. + * Optional. The resource name of the Model Armor template to use for response screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the model's response for safety and security risks before it is returned to the user. The name must be in the format `projects/{project\}/locations/{location\}/templates/{template\}`. */ responseTemplateName?: string | null; } /** - * Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. + * Configuration for a multi-speaker text-to-speech request. */ export interface Schema$GoogleCloudAiplatformV1beta1MultiSpeakerVoiceConfig { /** @@ -1248,39 +1248,39 @@ export namespace firebaseml_v2beta { speakerVoiceConfigs?: Schema$GoogleCloudAiplatformV1beta1SpeakerVoiceConfig[]; } /** - * A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + * A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. */ export interface Schema$GoogleCloudAiplatformV1beta1Part { /** - * Optional. Result of executing the [ExecutableCode]. + * Optional. The result of executing the ExecutableCode. */ codeExecutionResult?: Schema$GoogleCloudAiplatformV1beta1CodeExecutionResult; /** - * Optional. Code generated by the model that is meant to be executed. + * Optional. Code generated by the model that is intended to be executed. */ executableCode?: Schema$GoogleCloudAiplatformV1beta1ExecutableCode; /** - * Optional. URI based data. + * Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. */ fileData?: Schema$GoogleCloudAiplatformV1beta1FileData; /** - * Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + * Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. */ functionCall?: Schema$GoogleCloudAiplatformV1beta1FunctionCall; /** - * Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + * Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. */ functionResponse?: Schema$GoogleCloudAiplatformV1beta1FunctionResponse; /** - * Optional. Inlined bytes data. + * Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. */ inlineData?: Schema$GoogleCloudAiplatformV1beta1Blob; /** - * Optional. Text part (can be code). + * Optional. The text content of the part. */ text?: string | null; /** - * Optional. Indicates if the part is thought from the model. + * Optional. Indicates whether the `part` represents the model's thought process or reasoning. */ thought?: boolean | null; /** @@ -1293,11 +1293,11 @@ export namespace firebaseml_v2beta { videoMetadata?: Schema$GoogleCloudAiplatformV1beta1VideoMetadata; } /** - * The configuration for the prebuilt speaker to use. + * Configuration for a prebuilt voice. */ export interface Schema$GoogleCloudAiplatformV1beta1PrebuiltVoiceConfig { /** - * The name of the preset voice to use. + * The name of the prebuilt voice to use. */ voiceName?: string | null; } @@ -1440,24 +1440,24 @@ export namespace firebaseml_v2beta { latLng?: Schema$LatLng; } /** - * Metadata related to retrieval in the grounding flow. + * Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. */ export interface Schema$GoogleCloudAiplatformV1beta1RetrievalMetadata { /** - * Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search. + * Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. */ googleSearchDynamicRetrievalScore?: number | null; } /** - * Safety rating corresponding to the generated content. + * A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level. */ export interface Schema$GoogleCloudAiplatformV1beta1SafetyRating { /** - * Output only. Indicates whether the content was filtered out because of this rating. + * Output only. Indicates whether the content was blocked because of this rating. */ blocked?: boolean | null; /** - * Output only. Harm category. + * Output only. The harm category of this rating. */ category?: string | null; /** @@ -1465,36 +1465,36 @@ export namespace firebaseml_v2beta { */ overwrittenThreshold?: string | null; /** - * Output only. Harm probability levels in the content. + * Output only. The probability of harm for this category. */ probability?: string | null; /** - * Output only. Harm probability score. + * Output only. The probability score of harm for this category. */ probabilityScore?: number | null; /** - * Output only. Harm severity levels in the content. + * Output only. The severity of harm for this category. */ severity?: string | null; /** - * Output only. Harm severity score. + * Output only. The severity score of harm for this category. */ severityScore?: number | null; } /** - * Safety settings. + * A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category. */ export interface Schema$GoogleCloudAiplatformV1beta1SafetySetting { /** - * Required. Harm category. + * Required. The harm category to be blocked. */ category?: string | null; /** - * Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score. + * Optional. The method for blocking content. If not specified, the default behavior is to use the probability score. */ method?: string | null; /** - * Required. The harm block threshold. + * Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. */ threshold?: string | null; } @@ -1606,41 +1606,41 @@ export namespace firebaseml_v2beta { type?: string | null; } /** - * Google search entry point. + * An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application. */ export interface Schema$GoogleCloudAiplatformV1beta1SearchEntryPoint { /** - * Optional. Web content snippet that can be embedded in a web page or an app webview. + * Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result. */ renderedContent?: string | null; /** - * Optional. Base64 encoded JSON representing array of tuple. + * Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI. */ sdkBlob?: string | null; } /** - * Segment of the content. + * A segment of the content. */ export interface Schema$GoogleCloudAiplatformV1beta1Segment { /** - * Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. + * Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index. */ endIndex?: number | null; /** - * Output only. The index of a Part object within its parent Content object. + * Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content. */ partIndex?: number | null; /** - * Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. + * Output only. The start index of the segment in the `Part`, measured in bytes. This marks the beginning of the segment and is inclusive, meaning the byte at this index is the first byte of the segment. */ startIndex?: number | null; /** - * Output only. The text corresponding to the segment from the response. + * Output only. The text of the segment. */ text?: string | null; } /** - * Configuration for a single speaker in a multi speaker setup. + * Configuration for a single speaker in a multi-speaker setup. */ export interface Schema$GoogleCloudAiplatformV1beta1SpeakerVoiceConfig { /** @@ -1653,11 +1653,11 @@ export namespace firebaseml_v2beta { voiceConfig?: Schema$GoogleCloudAiplatformV1beta1VoiceConfig; } /** - * The speech generation config. + * Configuration for speech generation. */ export interface Schema$GoogleCloudAiplatformV1beta1SpeechConfig { /** - * Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + * Optional. The language code (ISO 639-1) for the speech synthesis. */ languageCode?: string | null; /** @@ -1665,7 +1665,7 @@ export namespace firebaseml_v2beta { */ multiSpeakerVoiceConfig?: Schema$GoogleCloudAiplatformV1beta1MultiSpeakerVoiceConfig; /** - * The configuration for the speaker to use. + * The configuration for the voice to use. */ voiceConfig?: Schema$GoogleCloudAiplatformV1beta1VoiceConfig; } @@ -1723,7 +1723,7 @@ export namespace firebaseml_v2beta { */ environment?: string | null; /** - * Optional. By default, predefined functions are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + * Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. */ excludedPredefinedFunctions?: string[] | null; } @@ -1758,24 +1758,24 @@ export namespace firebaseml_v2beta { */ export interface Schema$GoogleCloudAiplatformV1beta1UrlContext {} /** - * Metadata related to url context retrieval tool. + * Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. */ export interface Schema$GoogleCloudAiplatformV1beta1UrlContextMetadata { /** - * Output only. List of url context. + * Output only. A list of URL metadata, with one entry for each URL retrieved by the tool. */ urlMetadata?: Schema$GoogleCloudAiplatformV1beta1UrlMetadata[]; } /** - * Context of the a single url retrieval. + * The metadata for a single URL retrieval. */ export interface Schema$GoogleCloudAiplatformV1beta1UrlMetadata { /** - * Retrieved url by the tool. + * The URL retrieved by the tool. */ retrievedUrl?: string | null; /** - * Status of the url retrieval. + * The status of the URL retrieval. */ urlRetrievalStatus?: string | null; } @@ -1860,7 +1860,7 @@ export namespace firebaseml_v2beta { ragFileIds?: string[] | null; } /** - * Metadata describes the input video content. + * Provides metadata for a video, including the start and end offsets for clipping and the frame rate. */ export interface Schema$GoogleCloudAiplatformV1beta1VideoMetadata { /** @@ -1868,7 +1868,7 @@ export namespace firebaseml_v2beta { */ endOffset?: string | null; /** - * Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + * Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. */ fps?: number | null; /** @@ -1877,11 +1877,11 @@ export namespace firebaseml_v2beta { startOffset?: string | null; } /** - * The configuration for the voice to use. + * Configuration for a voice. */ export interface Schema$GoogleCloudAiplatformV1beta1VoiceConfig { /** - * The configuration for the prebuilt voice to use. + * The configuration for a prebuilt voice. */ prebuiltVoiceConfig?: Schema$GoogleCloudAiplatformV1beta1PrebuiltVoiceConfig; } diff --git a/src/apis/firestore/v1.ts b/src/apis/firestore/v1.ts index efae5003d9..09be0065a0 100644 --- a/src/apis/firestore/v1.ts +++ b/src/apis/firestore/v1.ts @@ -10959,7 +10959,7 @@ export namespace firestore_v1 { * * // Do the magic * const res = await firestore.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -11087,7 +11087,7 @@ export namespace firestore_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/gkeonprem/v1.ts b/src/apis/gkeonprem/v1.ts index 7e602b09bb..4a0bea7ea5 100644 --- a/src/apis/gkeonprem/v1.ts +++ b/src/apis/gkeonprem/v1.ts @@ -1397,6 +1397,10 @@ export namespace gkeonprem_v1 { * A list of operations that matches the specified filter in the request. */ operations?: Schema$Operation[]; + /** + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; } /** * Response message for listing VMware admin clusters. @@ -5266,13 +5270,16 @@ export namespace gkeonprem_v1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -5400,6 +5407,10 @@ export namespace gkeonprem_v1 { * The standard list page token. */ pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Baremetalclusters { @@ -9298,6 +9309,8 @@ export namespace gkeonprem_v1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); @@ -9305,7 +9318,8 @@ export namespace gkeonprem_v1 { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -9433,6 +9447,10 @@ export namespace gkeonprem_v1 { * The standard list page token. */ pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Baremetalclusters$Operations { @@ -9621,13 +9639,16 @@ export namespace gkeonprem_v1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -9755,6 +9776,10 @@ export namespace gkeonprem_v1 { * The standard list page token. */ pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Operations { @@ -10210,13 +10235,16 @@ export namespace gkeonprem_v1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -10362,6 +10390,10 @@ export namespace gkeonprem_v1 { * The standard list page token. */ pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Vmwareadminclusters { @@ -12149,13 +12181,16 @@ export namespace gkeonprem_v1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -12283,6 +12318,10 @@ export namespace gkeonprem_v1 { * The standard list page token. */ pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Vmwareclusters { @@ -14428,6 +14467,8 @@ export namespace gkeonprem_v1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); @@ -14435,7 +14476,8 @@ export namespace gkeonprem_v1 { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -14563,6 +14605,10 @@ export namespace gkeonprem_v1 { * The standard list page token. */ pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Vmwareclusters$Vmwarenodepools { @@ -16464,6 +16510,8 @@ export namespace gkeonprem_v1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }, * ); * console.log(res.data); @@ -16471,7 +16519,8 @@ export namespace gkeonprem_v1 { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -16599,5 +16648,9 @@ export namespace gkeonprem_v1 { * The standard list page token. */ pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } } diff --git a/src/apis/iamcredentials/v1.ts b/src/apis/iamcredentials/v1.ts index 3cfe081992..3e33833fdd 100644 --- a/src/apis/iamcredentials/v1.ts +++ b/src/apis/iamcredentials/v1.ts @@ -112,7 +112,6 @@ export namespace iamcredentials_v1 { */ export class Iamcredentials { context: APIRequestContext; - locations: Resource$Locations; projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { @@ -121,7 +120,6 @@ export namespace iamcredentials_v1 { google, }; - this.locations = new Resource$Locations(this.context); this.projects = new Resource$Projects(this.context); } } @@ -174,19 +172,6 @@ export namespace iamcredentials_v1 { */ token?: string | null; } - /** - * Represents a list of allowed locations for given service account. - */ - export interface Schema$ServiceAccountAllowedLocations { - /** - * Output only. The hex encoded bitmap of the trust boundary locations - */ - encodedLocations?: string | null; - /** - * Output only. The human readable trust boundary locations. For example, ["us-central1", "europe-west1"] - */ - locations?: string[] | null; - } export interface Schema$SignBlobRequest { /** * The sequence of service accounts in a delegation chain. Each service account must be granted the `roles/iam.serviceAccountTokenCreator` role on its next service account in the chain. The last service account in the chain must be granted the `roles/iam.serviceAccountTokenCreator` role on the service account that is specified in the `name` field of the request. The delegates must have the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID\}`. The `-` wildcard character is required; replacing it with a project ID is invalid. @@ -227,396 +212,18 @@ export namespace iamcredentials_v1 { */ signedJwt?: string | null; } - /** - * Represents a list of allowed locations for given workforce pool. - */ - export interface Schema$WorkforcePoolAllowedLocations { - /** - * Output only. The hex encoded bitmap of the trust boundary locations - */ - encodedLocations?: string | null; - /** - * Output only. The human readable trust boundary locations. For example, ["us-central1", "europe-west1"] - */ - locations?: string[] | null; - } - /** - * Represents a list of allowed locations for given workload identity pool. - */ - export interface Schema$WorkloadIdentityPoolAllowedLocations { - /** - * Output only. The hex encoded bitmap of the trust boundary locations - */ - encodedLocations?: string | null; - /** - * Output only. The human readable trust boundary locations. For example, ["us-central1", "europe-west1"] - */ - locations?: string[] | null; - } - - export class Resource$Locations { - context: APIRequestContext; - workforcePools: Resource$Locations$Workforcepools; - constructor(context: APIRequestContext) { - this.context = context; - this.workforcePools = new Resource$Locations$Workforcepools(this.context); - } - } - - export class Resource$Locations$Workforcepools { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Returns the trust boundary info for a given workforce pool. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/iamcredentials.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const iamcredentials = google.iamcredentials('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await iamcredentials.locations.workforcePools.getAllowedLocations( - * { - * // Required. Resource name of workforce pool. - * name: 'locations/my-location/workforcePools/my-workforcePool', - * }, - * ); - * console.log(res.data); - * - * // Example response - * // { - * // "encodedLocations": "my_encodedLocations", - * // "locations": [] - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getAllowedLocations( - params: Params$Resource$Locations$Workforcepools$Getallowedlocations, - options: StreamMethodOptions - ): Promise>; - getAllowedLocations( - params?: Params$Resource$Locations$Workforcepools$Getallowedlocations, - options?: MethodOptions - ): Promise>; - getAllowedLocations( - params: Params$Resource$Locations$Workforcepools$Getallowedlocations, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getAllowedLocations( - params: Params$Resource$Locations$Workforcepools$Getallowedlocations, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getAllowedLocations( - params: Params$Resource$Locations$Workforcepools$Getallowedlocations, - callback: BodyResponseCallback - ): void; - getAllowedLocations( - callback: BodyResponseCallback - ): void; - getAllowedLocations( - paramsOrCallback?: - | Params$Resource$Locations$Workforcepools$Getallowedlocations - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Locations$Workforcepools$Getallowedlocations; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Locations$Workforcepools$Getallowedlocations; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://iamcredentials.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}/allowedLocations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Locations$Workforcepools$Getallowedlocations - extends StandardParameters { - /** - * Required. Resource name of workforce pool. - */ - name?: string; - } export class Resource$Projects { context: APIRequestContext; - locations: Resource$Projects$Locations; serviceAccounts: Resource$Projects$Serviceaccounts; constructor(context: APIRequestContext) { this.context = context; - this.locations = new Resource$Projects$Locations(this.context); this.serviceAccounts = new Resource$Projects$Serviceaccounts( this.context ); } } - export class Resource$Projects$Locations { - context: APIRequestContext; - workloadIdentityPools: Resource$Projects$Locations$Workloadidentitypools; - constructor(context: APIRequestContext) { - this.context = context; - this.workloadIdentityPools = - new Resource$Projects$Locations$Workloadidentitypools(this.context); - } - } - - export class Resource$Projects$Locations$Workloadidentitypools { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Returns the trust boundary info for a given workload identity pool. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/iamcredentials.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const iamcredentials = google.iamcredentials('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await iamcredentials.projects.locations.workloadIdentityPools.getAllowedLocations( - * { - * // Required. Resource name of workload identity pool. - * name: 'projects/my-project/locations/my-location/workloadIdentityPools/my-workloadIdentityPool', - * }, - * ); - * console.log(res.data); - * - * // Example response - * // { - * // "encodedLocations": "my_encodedLocations", - * // "locations": [] - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getAllowedLocations( - params: Params$Resource$Projects$Locations$Workloadidentitypools$Getallowedlocations, - options: StreamMethodOptions - ): Promise>; - getAllowedLocations( - params?: Params$Resource$Projects$Locations$Workloadidentitypools$Getallowedlocations, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - getAllowedLocations( - params: Params$Resource$Projects$Locations$Workloadidentitypools$Getallowedlocations, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getAllowedLocations( - params: Params$Resource$Projects$Locations$Workloadidentitypools$Getallowedlocations, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getAllowedLocations( - params: Params$Resource$Projects$Locations$Workloadidentitypools$Getallowedlocations, - callback: BodyResponseCallback - ): void; - getAllowedLocations( - callback: BodyResponseCallback - ): void; - getAllowedLocations( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Workloadidentitypools$Getallowedlocations - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Workloadidentitypools$Getallowedlocations; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Workloadidentitypools$Getallowedlocations; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://iamcredentials.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}/allowedLocations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Workloadidentitypools$Getallowedlocations - extends StandardParameters { - /** - * Required. Resource name of workload identity pool. - */ - name?: string; - } - export class Resource$Projects$Serviceaccounts { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -932,154 +539,6 @@ export namespace iamcredentials_v1 { } } - /** - * Returns the trust boundary info for a given service account. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/iamcredentials.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const iamcredentials = google.iamcredentials('v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: [], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await iamcredentials.projects.serviceAccounts.getAllowedLocations( - * { - * // Required. Resource name of service account. - * name: 'projects/my-project/serviceAccounts/my-serviceAccount', - * }, - * ); - * console.log(res.data); - * - * // Example response - * // { - * // "encodedLocations": "my_encodedLocations", - * // "locations": [] - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getAllowedLocations( - params: Params$Resource$Projects$Serviceaccounts$Getallowedlocations, - options: StreamMethodOptions - ): Promise>; - getAllowedLocations( - params?: Params$Resource$Projects$Serviceaccounts$Getallowedlocations, - options?: MethodOptions - ): Promise>; - getAllowedLocations( - params: Params$Resource$Projects$Serviceaccounts$Getallowedlocations, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getAllowedLocations( - params: Params$Resource$Projects$Serviceaccounts$Getallowedlocations, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getAllowedLocations( - params: Params$Resource$Projects$Serviceaccounts$Getallowedlocations, - callback: BodyResponseCallback - ): void; - getAllowedLocations( - callback: BodyResponseCallback - ): void; - getAllowedLocations( - paramsOrCallback?: - | Params$Resource$Projects$Serviceaccounts$Getallowedlocations - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Serviceaccounts$Getallowedlocations; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Serviceaccounts$Getallowedlocations; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://iamcredentials.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}/allowedLocations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - /** * Signs a blob using a service account's system-managed private key. * @example @@ -1401,13 +860,6 @@ export namespace iamcredentials_v1 { */ requestBody?: Schema$GenerateIdTokenRequest; } - export interface Params$Resource$Projects$Serviceaccounts$Getallowedlocations - extends StandardParameters { - /** - * Required. Resource name of service account. - */ - name?: string; - } export interface Params$Resource$Projects$Serviceaccounts$Signblob extends StandardParameters { /** diff --git a/src/apis/ids/v1.ts b/src/apis/ids/v1.ts index 51f679435b..f570a868d7 100644 --- a/src/apis/ids/v1.ts +++ b/src/apis/ids/v1.ts @@ -232,6 +232,10 @@ export namespace ids_v1 { * A list of operations that matches the specified filter in the request. */ operations?: Schema$Operation[]; + /** + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; } /** * A resource that represents a Google Cloud location. @@ -524,7 +528,7 @@ export namespace ids_v1 { * * // Do the magic * const res = await ids.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -652,7 +656,7 @@ export namespace ids_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -1980,13 +1984,16 @@ export namespace ids_v1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -2132,5 +2139,9 @@ export namespace ids_v1 { * The standard list page token. */ pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } } diff --git a/src/apis/logging/v2.ts b/src/apis/logging/v2.ts index 4d73960db9..4618cb5057 100644 --- a/src/apis/logging/v2.ts +++ b/src/apis/logging/v2.ts @@ -843,6 +843,10 @@ export namespace logging_v2 { * A list of operations that matches the specified filter in the request. */ operations?: Schema$Operation[]; + /** + * Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections e.g. when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; } /** * The response from ListRecentQueries. @@ -6793,13 +6797,16 @@ export namespace logging_v2 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', + * // When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -6939,6 +6946,10 @@ export namespace logging_v2 { * The standard list page token. */ pageToken?: string; + /** + * When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Billingaccounts$Locations$Recentqueries { @@ -17062,13 +17073,16 @@ export namespace logging_v2 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', + * // When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -17207,6 +17221,10 @@ export namespace logging_v2 { * The standard list page token. */ pageToken?: string; + /** + * When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Folders$Locations$Recentqueries { @@ -23584,13 +23602,16 @@ export namespace logging_v2 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', + * // When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -23729,6 +23750,10 @@ export namespace logging_v2 { * The standard list page token. */ pageToken?: string; + /** + * When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Logs { @@ -30699,13 +30724,16 @@ export namespace logging_v2 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', + * // When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -30844,6 +30872,10 @@ export namespace logging_v2 { * The standard list page token. */ pageToken?: string; + /** + * When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Organizations$Locations$Recentqueries { @@ -39367,13 +39399,16 @@ export namespace logging_v2 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', + * // When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -39512,6 +39547,10 @@ export namespace logging_v2 { * The standard list page token. */ pageToken?: string; + /** + * When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Recentqueries { diff --git a/src/apis/looker/v1.ts b/src/apis/looker/v1.ts index 5479e53a9b..dac7ee7727 100644 --- a/src/apis/looker/v1.ts +++ b/src/apis/looker/v1.ts @@ -137,6 +137,19 @@ export namespace looker_v1 { * The request message for Operations.CancelOperation. */ export interface Schema$CancelOperationRequest {} + /** + * Controlled egress configuration. + */ + export interface Schema$ControlledEgressConfig { + /** + * Optional. List of fully qualified domain names to be added to the allowlist for outbound traffic. + */ + egressFqdns?: string[] | null; + /** + * Optional. Whether marketplace is enabled. + */ + marketplaceEnabled?: boolean | null; + } /** * Custom domain information. */ @@ -298,6 +311,14 @@ export namespace looker_v1 { * Network name in the consumer project. Format: `projects/{project\}/global/networks/{network\}`. Note that the consumer network may be in a different GCP project than the consumer project that is hosting the Looker Instance. */ consumerNetwork?: string | null; + /** + * Optional. Controlled egress configuration. + */ + controlledEgressConfig?: Schema$ControlledEgressConfig; + /** + * Optional. Whether controlled egress is enabled on the Looker instance. + */ + controlledEgressEnabled?: boolean | null; /** * Output only. The time when the Looker instance provisioning was first requested. */ @@ -1125,6 +1146,8 @@ export namespace looker_v1 { * // "adminSettings": {}, * // "classType": "my_classType", * // "consumerNetwork": "my_consumerNetwork", + * // "controlledEgressConfig": {}, + * // "controlledEgressEnabled": false, * // "createTime": "my_createTime", * // "customDomain": {}, * // "denyMaintenancePeriod": {}, @@ -1591,6 +1614,8 @@ export namespace looker_v1 { * // "adminSettings": {}, * // "classType": "my_classType", * // "consumerNetwork": "my_consumerNetwork", + * // "controlledEgressConfig": {}, + * // "controlledEgressEnabled": false, * // "createTime": "my_createTime", * // "customDomain": {}, * // "denyMaintenancePeriod": {}, @@ -2048,6 +2073,8 @@ export namespace looker_v1 { * // "adminSettings": {}, * // "classType": "my_classType", * // "consumerNetwork": "my_consumerNetwork", + * // "controlledEgressConfig": {}, + * // "controlledEgressEnabled": false, * // "createTime": "my_createTime", * // "customDomain": {}, * // "denyMaintenancePeriod": {}, diff --git a/src/apis/managedkafka/v1.ts b/src/apis/managedkafka/v1.ts index b22ee402b0..09047a1502 100644 --- a/src/apis/managedkafka/v1.ts +++ b/src/apis/managedkafka/v1.ts @@ -359,7 +359,7 @@ export namespace managedkafka_v1 { */ satisfiesPzs?: boolean | null; /** - * Output only. The current state of the cluster. + * Output only. The current state of the Kafka Connect cluster. */ state?: string | null; /** @@ -1256,7 +1256,7 @@ export namespace managedkafka_v1 { * * // Do the magic * const res = await managedkafka.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -1384,7 +1384,7 @@ export namespace managedkafka_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/marketingplatformadmin/v1alpha.ts b/src/apis/marketingplatformadmin/v1alpha.ts index 3d01b63fbf..6ea59314a1 100644 --- a/src/apis/marketingplatformadmin/v1alpha.ts +++ b/src/apis/marketingplatformadmin/v1alpha.ts @@ -145,10 +145,83 @@ export namespace marketingplatformadmin_v1alpha { */ name?: string | null; } + /** + * Contains the bill amount. + */ + export interface Schema$BillInfo { + /** + * The amount of the monthly base fee. + */ + baseFee?: Schema$Money; + /** + * The amount of the event fee. + */ + eventFee?: Schema$Money; + /** + * The amount of the price protection credit, this is only available for eligible customers. + */ + priceProtectionCredit?: Schema$Money; + /** + * The total amount of the bill. + */ + total?: Schema$Money; + } + /** + * Contains the client data. + */ + export interface Schema$ClientData { + /** + * The end date of the contract between the sales org and the end client. + */ + endDate?: Schema$Date; + /** + * The end client that has/had contract with the requested sales org. + */ + organization?: Schema$Organization; + /** + * The start date of the contract between the sales org and the end client. + */ + startDate?: Schema$Date; + } + /** + * Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp + */ + export interface Schema$Date { + /** + * Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + */ + day?: number | null; + /** + * Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + */ + month?: number | null; + /** + * Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + */ + year?: number | null; + } /** * 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); \} */ export interface Schema$Empty {} + /** + * Request message for FindSalesPartnerManagedClients RPC. + */ + export interface Schema$FindSalesPartnerManagedClientsRequest { + /** + * Optional. If set, only active and just ended clients will be returned. + */ + isActive?: boolean | null; + } + /** + * Response message for FindSalesPartnerManagedClients RPC. + */ + export interface Schema$FindSalesPartnerManagedClientsResponse { + /** + * The clients managed by the sales org. + */ + clientData?: Schema$ClientData[]; + } /** * Response message for ListAnalyticsAccountLinks RPC. */ @@ -162,6 +235,36 @@ export namespace marketingplatformadmin_v1alpha { */ nextPageToken?: string | null; } + /** + * Response message for ListOrganizations RPC. + */ + export interface Schema$ListOrganizationsResponse { + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * The Organization resource that the user has access to, which includes the org id and display name. + */ + organizations?: Schema$Organization[]; + } + /** + * Represents an amount of money with its currency type. + */ + export interface Schema$Money { + /** + * The three-letter currency code defined in ISO 4217. + */ + currencyCode?: string | null; + /** + * Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. + */ + nanos?: number | null; + /** + * The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. + */ + units?: string | null; + } /** * A resource message representing a Google Marketing Platform organization. */ @@ -175,6 +278,61 @@ export namespace marketingplatformadmin_v1alpha { */ name?: string | null; } + /** + * Contains the count of events received by the property, along with metadata that influences the volume of `billable` events. + */ + export interface Schema$PropertyUsage { + /** + * The ID of the property's parent account. + */ + accountId?: string | null; + /** + * The number of events for which the property is billed in the requested month. + */ + billableEventCount?: string | null; + /** + * The display name of the property. + */ + displayName?: string | null; + /** + * The name of the Google Analytics Admin API property resource. Format: analyticsadmin.googleapis.com/properties/{property_id\} + */ + property?: string | null; + /** + * The subtype of the analytics property. This affects the billable event count. + */ + propertyType?: string | null; + /** + * The service level of the property. + */ + serviceLevel?: string | null; + /** + * Total event count that the property received during the requested month. + */ + totalEventCount?: string | null; + } + /** + * Request message for ReportPropertyUsage RPC. + */ + export interface Schema$ReportPropertyUsageRequest { + /** + * Required. The target month to list property usages. Format: YYYY-MM. For example, "2025-05" + */ + month?: string | null; + } + /** + * Response message for ReportPropertyUsage RPC. + */ + export interface Schema$ReportPropertyUsageResponse { + /** + * Bill amount in the specified organization and month. Will be empty if user only has access to usage data. + */ + billInfo?: Schema$BillInfo; + /** + * Usage data for all properties in the specified organization and month. + */ + propertyUsages?: Schema$PropertyUsage[]; + } /** * Request message for SetPropertyServiceLevel RPC. */ @@ -202,6 +360,167 @@ export namespace marketingplatformadmin_v1alpha { new Resource$Organizations$Analyticsaccountlinks(this.context); } + /** + * Returns a list of clients managed by the sales partner organization. User needs to be an OrgAdmin/BillingAdmin on the sales partner organization in order to view the end clients. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/marketingplatformadmin.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const marketingplatformadmin = google.marketingplatformadmin('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/marketingplatformadmin.analytics.read', + * 'https://www.googleapis.com/auth/marketingplatformadmin.analytics.update', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await marketingplatformadmin.organizations.findSalesPartnerManagedClients({ + * // Required. The name of the sales partner organization. Format: organizations/{org_id\} + * organization: 'organizations/my-organization', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "isActive": false + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientData": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + findSalesPartnerManagedClients( + params: Params$Resource$Organizations$Findsalespartnermanagedclients, + options: StreamMethodOptions + ): Promise>; + findSalesPartnerManagedClients( + params?: Params$Resource$Organizations$Findsalespartnermanagedclients, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + findSalesPartnerManagedClients( + params: Params$Resource$Organizations$Findsalespartnermanagedclients, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + findSalesPartnerManagedClients( + params: Params$Resource$Organizations$Findsalespartnermanagedclients, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + findSalesPartnerManagedClients( + params: Params$Resource$Organizations$Findsalespartnermanagedclients, + callback: BodyResponseCallback + ): void; + findSalesPartnerManagedClients( + callback: BodyResponseCallback + ): void; + findSalesPartnerManagedClients( + paramsOrCallback?: + | Params$Resource$Organizations$Findsalespartnermanagedclients + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Findsalespartnermanagedclients; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Organizations$Findsalespartnermanagedclients; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://marketingplatformadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1alpha/{+organization}:findSalesPartnerManagedClients' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['organization'], + pathParams: ['organization'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Lookup for a single organization. * @example @@ -340,8 +659,321 @@ export namespace marketingplatformadmin_v1alpha { return createAPIRequest(parameters); } } + + /** + * Returns a list of organizations that the user has access to. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/marketingplatformadmin.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const marketingplatformadmin = google.marketingplatformadmin('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/marketingplatformadmin.analytics.read', + * 'https://www.googleapis.com/auth/marketingplatformadmin.analytics.update', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await marketingplatformadmin.organizations.list({ + * // Optional. The maximum number of organizations to return in one call. The service may return fewer than this value. If unspecified, at most 50 organizations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // Optional. A page token, received from a previous ListOrganizations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListOrganizations` must match the call that provided the page token. + * pageToken: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "organizations": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Organizations$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Organizations$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Organizations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Organizations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://marketingplatformadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/organizations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Get the usage and billing data for properties within the organization for the specified month. Per direct client org, user needs to be OrgAdmin/BillingAdmin on the organization in order to view the billing and usage data. Per sales partner client org, user needs to be OrgAdmin/BillingAdmin on the sales partner org in order to view the billing and usage data, or OrgAdmin/BillingAdmin on the sales partner client org in order to view the usage data only. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/marketingplatformadmin.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const marketingplatformadmin = google.marketingplatformadmin('v1alpha'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/marketingplatformadmin.analytics.read', + * 'https://www.googleapis.com/auth/marketingplatformadmin.analytics.update', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await marketingplatformadmin.organizations.reportPropertyUsage({ + * // Required. Specifies the organization whose property usage will be listed. Format: organizations/{org_id\} + * organization: 'organizations/my-organization', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "month": "my_month" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "billInfo": {}, + * // "propertyUsages": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + reportPropertyUsage( + params: Params$Resource$Organizations$Reportpropertyusage, + options: StreamMethodOptions + ): Promise>; + reportPropertyUsage( + params?: Params$Resource$Organizations$Reportpropertyusage, + options?: MethodOptions + ): Promise>; + reportPropertyUsage( + params: Params$Resource$Organizations$Reportpropertyusage, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + reportPropertyUsage( + params: Params$Resource$Organizations$Reportpropertyusage, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + reportPropertyUsage( + params: Params$Resource$Organizations$Reportpropertyusage, + callback: BodyResponseCallback + ): void; + reportPropertyUsage( + callback: BodyResponseCallback + ): void; + reportPropertyUsage( + paramsOrCallback?: + | Params$Resource$Organizations$Reportpropertyusage + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Reportpropertyusage; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Reportpropertyusage; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://marketingplatformadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1alpha/{+organization}:reportPropertyUsage' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['organization'], + pathParams: ['organization'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } + export interface Params$Resource$Organizations$Findsalespartnermanagedclients + extends StandardParameters { + /** + * Required. The name of the sales partner organization. Format: organizations/{org_id\} + */ + organization?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FindSalesPartnerManagedClientsRequest; + } export interface Params$Resource$Organizations$Get extends StandardParameters { /** @@ -349,6 +981,29 @@ export namespace marketingplatformadmin_v1alpha { */ name?: string; } + export interface Params$Resource$Organizations$List + extends StandardParameters { + /** + * Optional. The maximum number of organizations to return in one call. The service may return fewer than this value. If unspecified, at most 50 organizations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous ListOrganizations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListOrganizations` must match the call that provided the page token. + */ + pageToken?: string; + } + export interface Params$Resource$Organizations$Reportpropertyusage + extends StandardParameters { + /** + * Required. Specifies the organization whose property usage will be listed. Format: organizations/{org_id\} + */ + organization?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ReportPropertyUsageRequest; + } export class Resource$Organizations$Analyticsaccountlinks { context: APIRequestContext; diff --git a/src/apis/merchantapi/accounts_v1.ts b/src/apis/merchantapi/accounts_v1.ts index 56e9e8cc62..627b3b0ee6 100644 --- a/src/apis/merchantapi/accounts_v1.ts +++ b/src/apis/merchantapi/accounts_v1.ts @@ -2123,7 +2123,7 @@ export namespace merchantapi_accounts_v1 { checkoutUriTemplate?: string | null; } /** - * The `User` message represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472). + * The `User` resource represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472). */ export interface Schema$User { /** @@ -2720,149 +2720,6 @@ export namespace merchantapi_accounts_v1 { } } - /** - * Retrieves the merchant account that the calling GCP is registered with. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/merchantapi.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const merchantapi = google.merchantapi('accounts_v1'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/content'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await merchantapi.accounts.getAccountForGcpRegistration({}); - * console.log(res.data); - * - * // Example response - * // { - * // "name": "my_name" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getAccountForGcpRegistration( - params: Params$Resource$Accounts$Getaccountforgcpregistration, - options: StreamMethodOptions - ): Promise>; - getAccountForGcpRegistration( - params?: Params$Resource$Accounts$Getaccountforgcpregistration, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - getAccountForGcpRegistration( - params: Params$Resource$Accounts$Getaccountforgcpregistration, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getAccountForGcpRegistration( - params: Params$Resource$Accounts$Getaccountforgcpregistration, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getAccountForGcpRegistration( - params: Params$Resource$Accounts$Getaccountforgcpregistration, - callback: BodyResponseCallback - ): void; - getAccountForGcpRegistration( - callback: BodyResponseCallback - ): void; - getAccountForGcpRegistration( - paramsOrCallback?: - | Params$Resource$Accounts$Getaccountforgcpregistration - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Getaccountforgcpregistration; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Getaccountforgcpregistration; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/accounts/v1/accounts:getAccountForGcpRegistration' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: [], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - /** * Note: For the `accounts.list` method, quota and limits usage are charged for each user, and not for the Merchant Center ID or the advanced account ID. To list several sub-accounts, you should use the `accounts.listSubaccounts` method, which is more suitable for advanced accounts use case. * @example @@ -3334,8 +3191,6 @@ export namespace merchantapi_accounts_v1 { */ name?: string; } - export interface Params$Resource$Accounts$Getaccountforgcpregistration - extends StandardParameters {} export interface Params$Resource$Accounts$List extends StandardParameters { /** * Optional. Returns only accounts that match the [filter](https://developers.google.com/merchant/api/guides/accounts/filter). For more details, see the [filter syntax reference](https://developers.google.com/merchant/api/guides/accounts/filter-syntax). @@ -4725,6 +4580,153 @@ export namespace merchantapi_accounts_v1 { this.context = context; } + /** + * Retrieves the merchant account that the calling GCP is registered with. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/merchantapi.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const merchantapi = google.merchantapi('accounts_v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/content'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await merchantapi.accounts.developerRegistration.getAccountForGcpRegistration( + * {}, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "name": "my_name" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getAccountForGcpRegistration( + params: Params$Resource$Accounts$Developerregistration$Getaccountforgcpregistration, + options: StreamMethodOptions + ): Promise>; + getAccountForGcpRegistration( + params?: Params$Resource$Accounts$Developerregistration$Getaccountforgcpregistration, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + getAccountForGcpRegistration( + params: Params$Resource$Accounts$Developerregistration$Getaccountforgcpregistration, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getAccountForGcpRegistration( + params: Params$Resource$Accounts$Developerregistration$Getaccountforgcpregistration, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getAccountForGcpRegistration( + params: Params$Resource$Accounts$Developerregistration$Getaccountforgcpregistration, + callback: BodyResponseCallback + ): void; + getAccountForGcpRegistration( + callback: BodyResponseCallback + ): void; + getAccountForGcpRegistration( + paramsOrCallback?: + | Params$Resource$Accounts$Developerregistration$Getaccountforgcpregistration + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Developerregistration$Getaccountforgcpregistration; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Accounts$Developerregistration$Getaccountforgcpregistration; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/accounts/v1/accounts:getAccountForGcpRegistration' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Retrieves a developer registration for a merchant. * @example @@ -5163,6 +5165,8 @@ export namespace merchantapi_accounts_v1 { } } + export interface Params$Resource$Accounts$Developerregistration$Getaccountforgcpregistration + extends StandardParameters {} export interface Params$Resource$Accounts$Developerregistration$Getdeveloperregistration extends StandardParameters { /** diff --git a/src/apis/merchantapi/accounts_v1beta.ts b/src/apis/merchantapi/accounts_v1beta.ts index f0fdc3f13d..76634168db 100644 --- a/src/apis/merchantapi/accounts_v1beta.ts +++ b/src/apis/merchantapi/accounts_v1beta.ts @@ -2060,7 +2060,7 @@ export namespace merchantapi_accounts_v1beta { checkoutUriTemplate?: string | null; } /** - * The `User` message represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472). + * The `User` resource represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472). */ export interface Schema$User { /** @@ -2657,149 +2657,6 @@ export namespace merchantapi_accounts_v1beta { } } - /** - * Retrieves the merchant account that the calling GCP is registered with. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/merchantapi.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const merchantapi = google.merchantapi('accounts_v1beta'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/content'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await merchantapi.accounts.getAccountForGcpRegistration({}); - * console.log(res.data); - * - * // Example response - * // { - * // "name": "my_name" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getAccountForGcpRegistration( - params: Params$Resource$Accounts$Getaccountforgcpregistration, - options: StreamMethodOptions - ): Promise>; - getAccountForGcpRegistration( - params?: Params$Resource$Accounts$Getaccountforgcpregistration, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - getAccountForGcpRegistration( - params: Params$Resource$Accounts$Getaccountforgcpregistration, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getAccountForGcpRegistration( - params: Params$Resource$Accounts$Getaccountforgcpregistration, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getAccountForGcpRegistration( - params: Params$Resource$Accounts$Getaccountforgcpregistration, - callback: BodyResponseCallback - ): void; - getAccountForGcpRegistration( - callback: BodyResponseCallback - ): void; - getAccountForGcpRegistration( - paramsOrCallback?: - | Params$Resource$Accounts$Getaccountforgcpregistration - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Getaccountforgcpregistration; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Getaccountforgcpregistration; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/accounts/v1beta/accounts:getAccountForGcpRegistration' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: [], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - /** * Note: For the `accounts.list` method, quota and limits usage are charged for each user, and not for the Merchant Center ID or the advanced account ID. To list several sub-accounts, you should use the `accounts.listSubaccounts` method, which is more suitable for advanced accounts use case. * @example @@ -3270,8 +3127,6 @@ export namespace merchantapi_accounts_v1beta { */ name?: string; } - export interface Params$Resource$Accounts$Getaccountforgcpregistration - extends StandardParameters {} export interface Params$Resource$Accounts$List extends StandardParameters { /** * Optional. Returns only accounts that match the [filter](https://developers.google.com/merchant/api/guides/accounts/filter). For more details, see the [filter syntax reference](https://developers.google.com/merchant/api/guides/accounts/filter-syntax). @@ -4661,6 +4516,153 @@ export namespace merchantapi_accounts_v1beta { this.context = context; } + /** + * Retrieves the merchant account that the calling GCP is registered with. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/merchantapi.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const merchantapi = google.merchantapi('accounts_v1beta'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/content'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await merchantapi.accounts.developerRegistration.getAccountForGcpRegistration( + * {}, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "name": "my_name" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getAccountForGcpRegistration( + params: Params$Resource$Accounts$Developerregistration$Getaccountforgcpregistration, + options: StreamMethodOptions + ): Promise>; + getAccountForGcpRegistration( + params?: Params$Resource$Accounts$Developerregistration$Getaccountforgcpregistration, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + getAccountForGcpRegistration( + params: Params$Resource$Accounts$Developerregistration$Getaccountforgcpregistration, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getAccountForGcpRegistration( + params: Params$Resource$Accounts$Developerregistration$Getaccountforgcpregistration, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getAccountForGcpRegistration( + params: Params$Resource$Accounts$Developerregistration$Getaccountforgcpregistration, + callback: BodyResponseCallback + ): void; + getAccountForGcpRegistration( + callback: BodyResponseCallback + ): void; + getAccountForGcpRegistration( + paramsOrCallback?: + | Params$Resource$Accounts$Developerregistration$Getaccountforgcpregistration + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Developerregistration$Getaccountforgcpregistration; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Accounts$Developerregistration$Getaccountforgcpregistration; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/accounts/v1beta/accounts:getAccountForGcpRegistration' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Retrieves a developer registration for a merchant. * @example @@ -5099,6 +5101,8 @@ export namespace merchantapi_accounts_v1beta { } } + export interface Params$Resource$Accounts$Developerregistration$Getaccountforgcpregistration + extends StandardParameters {} export interface Params$Resource$Accounts$Developerregistration$Getdeveloperregistration extends StandardParameters { /** diff --git a/src/apis/metastore/v1alpha.ts b/src/apis/metastore/v1alpha.ts index 31a3b70e52..cbfd8379cc 100644 --- a/src/apis/metastore/v1alpha.ts +++ b/src/apis/metastore/v1alpha.ts @@ -1679,7 +1679,7 @@ export namespace metastore_v1alpha { * * // Do the magic * const res = await metastore.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160). * filter: 'placeholder-value', @@ -1807,7 +1807,7 @@ export namespace metastore_v1alpha { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/metastore/v1beta.ts b/src/apis/metastore/v1beta.ts index 98eeab4d85..1bb7275386 100644 --- a/src/apis/metastore/v1beta.ts +++ b/src/apis/metastore/v1beta.ts @@ -1679,7 +1679,7 @@ export namespace metastore_v1beta { * * // Do the magic * const res = await metastore.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160). * filter: 'placeholder-value', @@ -1807,7 +1807,7 @@ export namespace metastore_v1beta { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/migrationcenter/v1.ts b/src/apis/migrationcenter/v1.ts index 35f62657f7..1690263aac 100644 --- a/src/apis/migrationcenter/v1.ts +++ b/src/apis/migrationcenter/v1.ts @@ -3799,7 +3799,7 @@ export namespace migrationcenter_v1 { * * // Do the magic * const res = await migrationcenter.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -4088,7 +4088,7 @@ export namespace migrationcenter_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/migrationcenter/v1alpha1.ts b/src/apis/migrationcenter/v1alpha1.ts index 2ab115c2f9..45dc819449 100644 --- a/src/apis/migrationcenter/v1alpha1.ts +++ b/src/apis/migrationcenter/v1alpha1.ts @@ -283,6 +283,10 @@ export namespace migrationcenter_v1alpha1 { * Output only. Asset information specific for AWS CloudFront distributions. */ awsCloudFrontDistributionDetails?: Schema$AwsCloudFrontDistributionDetails; + /** + * Output only. Asset information specific for AWS DynamoDB tables. + */ + awsDynamodbTableDetails?: Schema$AwsDynamoDBTableDetails; /** * Output only. Asset information specific for AWS ECS clusters. */ @@ -303,10 +307,18 @@ export namespace migrationcenter_v1alpha1 { * Output only. Asset information specific for AWS Lambda functions. */ awsLambdaFunctionDetails?: Schema$AwsLambdaFunctionDetails; + /** + * Output only. Asset information specific for AwsNatGatewayDetails + */ + awsNatGatewayDetails?: Schema$AwsNatGatewayDetails; /** * Output only. Asset information specific for AWS Redshift */ awsRedshiftDetails?: Schema$AwsRedshiftDetails; + /** + * Output only. Asset information specific for AwsRoute53HostedZoneDetails + */ + awsRoute53HostedZoneDetails?: Schema$AwsRoute53HostedZoneDetails; /** * Output only. Asset information specific for AWS S3 buckets. */ @@ -396,6 +408,10 @@ export namespace migrationcenter_v1alpha1 { * Asset information specific for AWS CloudFront distributions. */ awsCloudFrontDistributionDetails?: Schema$AwsCloudFrontDistributionDetails; + /** + * Asset information specific for AWS DynamoDB tables. + */ + awsDynamodbTableDetails?: Schema$AwsDynamoDBTableDetails; /** * Asset information specific for AWS ECS clusters. */ @@ -416,10 +432,18 @@ export namespace migrationcenter_v1alpha1 { * Asset information specific for AWS Lambda functions. */ awsLambdaFunctionDetails?: Schema$AwsLambdaFunctionDetails; + /** + * Asset information specific for AwsNatGatewayDetails + */ + awsNatGatewayDetails?: Schema$AwsNatGatewayDetails; /** * Asset information specific for AWS Redshift clusters. */ awsRedshiftDetails?: Schema$AwsRedshiftDetails; + /** + * Asset information specific for AwsRoute53HostedZoneDetails + */ + awsRoute53HostedZoneDetails?: Schema$AwsRoute53HostedZoneDetails; /** * Asset information specific for AWS S3 buckets. */ @@ -602,12 +626,7 @@ export namespace migrationcenter_v1alpha1 { /** * Configuration for network dependencies exports. */ - export interface Schema$AssetsExportJobNetworkDependencies { - /** - * Optional. When this value is set to a positive integer, network connections data will be returned for the most recent days for which data is available. When this value is unset (or set to zero), all available data is returned. - */ - maxDays?: number | null; - } + export interface Schema$AssetsExportJobNetworkDependencies {} /** * Configuration for performance data exports. */ @@ -621,6 +640,10 @@ export namespace migrationcenter_v1alpha1 { * Details of an AWS CloudFront distribution. */ export interface Schema$AwsCloudFrontDistributionDetails {} + /** + * Details of an AWS DynamoDB table. + */ + export interface Schema$AwsDynamoDBTableDetails {} /** * AWS EC2 specific details. */ @@ -658,6 +681,10 @@ export namespace migrationcenter_v1alpha1 { * Asset information specific for AWS Lambda functions. */ export interface Schema$AwsLambdaFunctionDetails {} + /** + * Details of an AWS NAT Gateway. + */ + export interface Schema$AwsNatGatewayDetails {} /** * Specific details for an AWS RDS database deployment. */ @@ -666,6 +693,10 @@ export namespace migrationcenter_v1alpha1 { * Details of an AWS Redshift cluster. */ export interface Schema$AwsRedshiftDetails {} + /** + * Details of an AWS Route 53 Hosted Zone. + */ + export interface Schema$AwsRoute53HostedZoneDetails {} /** * Asset information specific for AWS S3 buckets. */ @@ -5158,7 +5189,7 @@ export namespace migrationcenter_v1alpha1 { * * // Do the magic * const res = await migrationcenter.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -5448,7 +5479,7 @@ export namespace migrationcenter_v1alpha1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** @@ -6123,12 +6154,15 @@ export namespace migrationcenter_v1alpha1 { * // "assignedGroups": [], * // "attributes": {}, * // "awsCloudFrontDistributionDetails": {}, + * // "awsDynamodbTableDetails": {}, * // "awsEcsClusterDetails": {}, * // "awsEfsFileSystemDetails": {}, * // "awsEksClusterDetails": {}, * // "awsElbLoadBalancerDetails": {}, * // "awsLambdaFunctionDetails": {}, + * // "awsNatGatewayDetails": {}, * // "awsRedshiftDetails": {}, + * // "awsRoute53HostedZoneDetails": {}, * // "awsS3BucketDetails": {}, * // "awsVpcDetails": {}, * // "createTime": "my_createTime", @@ -6441,12 +6475,15 @@ export namespace migrationcenter_v1alpha1 { * // "assignedGroups": [], * // "attributes": {}, * // "awsCloudFrontDistributionDetails": {}, + * // "awsDynamodbTableDetails": {}, * // "awsEcsClusterDetails": {}, * // "awsEfsFileSystemDetails": {}, * // "awsEksClusterDetails": {}, * // "awsElbLoadBalancerDetails": {}, * // "awsLambdaFunctionDetails": {}, + * // "awsNatGatewayDetails": {}, * // "awsRedshiftDetails": {}, + * // "awsRoute53HostedZoneDetails": {}, * // "awsS3BucketDetails": {}, * // "awsVpcDetails": {}, * // "createTime": "my_createTime", @@ -6476,12 +6513,15 @@ export namespace migrationcenter_v1alpha1 { * // "assignedGroups": [], * // "attributes": {}, * // "awsCloudFrontDistributionDetails": {}, + * // "awsDynamodbTableDetails": {}, * // "awsEcsClusterDetails": {}, * // "awsEfsFileSystemDetails": {}, * // "awsEksClusterDetails": {}, * // "awsElbLoadBalancerDetails": {}, * // "awsLambdaFunctionDetails": {}, + * // "awsNatGatewayDetails": {}, * // "awsRedshiftDetails": {}, + * // "awsRoute53HostedZoneDetails": {}, * // "awsS3BucketDetails": {}, * // "awsVpcDetails": {}, * // "createTime": "my_createTime", diff --git a/src/apis/netapp/v1.ts b/src/apis/netapp/v1.ts index 5ee14acc9f..f3b44a3e12 100644 --- a/src/apis/netapp/v1.ts +++ b/src/apis/netapp/v1.ts @@ -668,7 +668,7 @@ export namespace netapp_v1 { */ createTime?: string | null; /** - * Required. Customer managed crypto key resource full name. Format: projects/{project\}/locations/{location\}/keyRings/{key_ring\}/cryptoKeys/{key\}. + * Required. Customer managed crypto key resource full name. Format: projects/{project\}/locations/{location\}/keyRings/{key_ring\}/cryptoKeys/{crypto_key\}. */ cryptoKeyName?: string | null; /** diff --git a/src/apis/netapp/v1beta1.ts b/src/apis/netapp/v1beta1.ts index 9605027446..7107780861 100644 --- a/src/apis/netapp/v1beta1.ts +++ b/src/apis/netapp/v1beta1.ts @@ -689,7 +689,7 @@ export namespace netapp_v1beta1 { */ createTime?: string | null; /** - * Required. Customer managed crypto key resource full name. Format: projects/{project\}/locations/{location\}/keyRings/{key_ring\}/cryptoKeys/{key\}. + * Required. Customer managed crypto key resource full name. Format: projects/{project\}/locations/{location\}/keyRings/{key_ring\}/cryptoKeys/{crypto_key\}. */ cryptoKeyName?: string | null; /** diff --git a/src/apis/networkservices/v1.ts b/src/apis/networkservices/v1.ts index 617bf90677..3b861aba17 100644 --- a/src/apis/networkservices/v1.ts +++ b/src/apis/networkservices/v1.ts @@ -371,19 +371,27 @@ export namespace networkservices_v1 { */ forwardHeaders?: string[] | null; /** - * Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id\}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings. + * Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. For `AuthzExtension` resources, the metadata is available under the namespace `com.google.authz_extension.`. For other types of extensions, the metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id\}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings. */ metadata?: {[key: string]: any} | null; /** - * Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. + * Optional. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. This field is required except for AuthzExtension. */ name?: string | null; + /** + * Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. + */ + requestBodySendMode?: string | null; + /** + * Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. + */ + responseBodySendMode?: string | null; /** * Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project\}/regions/{region\}/backendServices/{backendService\}` or `https://www.googleapis.com/compute/v1/projects/{project\}/global/backendServices/{backendService\}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project\}/locations/{location\}/wasmPlugins/{plugin\}` or `//networkservices.googleapis.com/projects/{project\}/locations/{location\}/wasmPlugins/{wasmPlugin\}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, and the `LbEdgeExtension` resources. */ service?: string | null; /** - * Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. + * Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. */ supportedEvents?: string[] | null; /** @@ -1145,6 +1153,43 @@ export namespace networkservices_v1 { */ pathPrefixRewrite?: string | null; } + /** + * `LbEdgeExtension` is a resource that lets the extension service influence the selection of backend services and Cloud CDN cache keys by modifying request headers. + */ + export interface Schema$LbEdgeExtension { + /** + * Output only. The timestamp when the resource was created. + */ + createTime?: string | null; + /** + * Optional. A human-readable description of the resource. + */ + description?: string | null; + /** + * Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource. + */ + extensionChains?: Schema$ExtensionChain[]; + /** + * Required. A list of references to the forwarding rules to which this service extension is attached. At least one forwarding rule is required. Only one `LbEdgeExtension` resource can be associated with a forwarding rule. + */ + forwardingRules?: string[] | null; + /** + * Optional. Set of labels associated with the `LbEdgeExtension` resource. The format must comply with [the requirements for labels](https://cloud.google.com/compute/docs/labeling-resources#requirements) for Google Cloud resources. + */ + labels?: {[key: string]: string} | null; + /** + * Required. All forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `EXTERNAL_MANAGED`. + */ + loadBalancingScheme?: string | null; + /** + * Required. Identifier. Name of the `LbEdgeExtension` resource in the following format: `projects/{project\}/locations/{location\}/lbEdgeExtensions/{lb_edge_extension\}`. + */ + name?: string | null; + /** + * Output only. The timestamp when the resource was updated. + */ + updateTime?: string | null; + } /** * `LbRouteExtension` is a resource that lets you control where traffic is routed to for a given request. */ @@ -1329,6 +1374,23 @@ export namespace networkservices_v1 { */ unreachable?: string[] | null; } + /** + * Message for response to listing `LbEdgeExtension` resources. + */ + export interface Schema$ListLbEdgeExtensionsResponse { + /** + * The list of `LbEdgeExtension` resources. + */ + lbEdgeExtensions?: Schema$LbEdgeExtension[]; + /** + * A token identifying a page of results that the server returns. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } /** * Message for response to listing `LbRouteExtension` resources. */ @@ -1422,6 +1484,10 @@ export namespace networkservices_v1 { * A list of operations that matches the specified filter in the request. */ operations?: Schema$Operation[]; + /** + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; } /** * Response returned by the ListServiceBindings method. @@ -2231,6 +2297,7 @@ export namespace networkservices_v1 { gateways: Resource$Projects$Locations$Gateways; grpcRoutes: Resource$Projects$Locations$Grpcroutes; httpRoutes: Resource$Projects$Locations$Httproutes; + lbEdgeExtensions: Resource$Projects$Locations$Lbedgeextensions; lbRouteExtensions: Resource$Projects$Locations$Lbrouteextensions; lbTrafficExtensions: Resource$Projects$Locations$Lbtrafficextensions; meshes: Resource$Projects$Locations$Meshes; @@ -2263,6 +2330,9 @@ export namespace networkservices_v1 { this.httpRoutes = new Resource$Projects$Locations$Httproutes( this.context ); + this.lbEdgeExtensions = new Resource$Projects$Locations$Lbedgeextensions( + this.context + ); this.lbRouteExtensions = new Resource$Projects$Locations$Lbrouteextensions(this.context); this.lbTrafficExtensions = @@ -2453,7 +2523,7 @@ export namespace networkservices_v1 { * * // Do the magic * const res = await networkservices.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -2582,7 +2652,7 @@ export namespace networkservices_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -8601,14 +8671,14 @@ export namespace networkservices_v1 { requestBody?: Schema$HttpRoute; } - export class Resource$Projects$Locations$Lbrouteextensions { + export class Resource$Projects$Locations$Lbedgeextensions { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates a new `LbRouteExtension` resource in a given project and location. + * Creates a new `LbEdgeExtension` resource in a given project and location. * @example * ```js * // Before running the sample: @@ -8637,32 +8707,29 @@ export namespace networkservices_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await networkservices.projects.locations.lbRouteExtensions.create( - * { - * // Required. User-provided ID of the `LbRouteExtension` resource to be created. - * lbRouteExtensionId: 'placeholder-value', - * // Required. The parent resource of the `LbRouteExtension` resource. Must be in the format `projects/{project\}/locations/{location\}`. - * parent: 'projects/my-project/locations/my-location', - * // Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server 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). - * requestId: 'placeholder-value', + * const res = await networkservices.projects.locations.lbEdgeExtensions.create({ + * // Required. User-provided ID of the `LbEdgeExtension` resource to be created. + * lbEdgeExtensionId: 'placeholder-value', + * // Required. The parent resource of the `LbEdgeExtension` resource. Must be in the format `projects/{project\}/locations/{location\}`. + * parent: 'projects/my-project/locations/my-location', + * // Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server 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). + * requestId: 'placeholder-value', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "extensionChains": [], - * // "forwardingRules": [], - * // "labels": {}, - * // "loadBalancingScheme": "my_loadBalancingScheme", - * // "metadata": {}, - * // "name": "my_name", - * // "updateTime": "my_updateTime" - * // } - * }, + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "extensionChains": [], + * // "forwardingRules": [], + * // "labels": {}, + * // "loadBalancingScheme": "my_loadBalancingScheme", + * // "name": "my_name", + * // "updateTime": "my_updateTime" + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response @@ -8688,31 +8755,31 @@ export namespace networkservices_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + params: Params$Resource$Projects$Locations$Lbedgeextensions$Create, options: StreamMethodOptions ): Promise>; create( - params?: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + params?: Params$Resource$Projects$Locations$Lbedgeextensions$Create, options?: MethodOptions ): Promise>; create( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + params: Params$Resource$Projects$Locations$Lbedgeextensions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + params: Params$Resource$Projects$Locations$Lbedgeextensions$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + params: Params$Resource$Projects$Locations$Lbedgeextensions$Create, callback: BodyResponseCallback ): void; create(callback: BodyResponseCallback): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbrouteextensions$Create + | Params$Resource$Projects$Locations$Lbedgeextensions$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -8728,13 +8795,13 @@ export namespace networkservices_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Create; + {}) as Params$Resource$Projects$Locations$Lbedgeextensions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lbrouteextensions$Create; + {} as Params$Resource$Projects$Locations$Lbedgeextensions$Create; options = {}; } @@ -8748,7 +8815,7 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/lbRouteExtensions').replace( + url: (rootUrl + '/v1/{+parent}/lbEdgeExtensions').replace( /([^:]\/)\/+/g, '$1' ), @@ -8773,7 +8840,7 @@ export namespace networkservices_v1 { } /** - * Deletes the specified `LbRouteExtension` resource. + * Deletes the specified `LbEdgeExtension` resource. * @example * ```js * // Before running the sample: @@ -8802,14 +8869,12 @@ export namespace networkservices_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await networkservices.projects.locations.lbRouteExtensions.delete( - * { - * // Required. The name of the `LbRouteExtension` resource to delete. Must be in the format `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. - * name: 'projects/my-project/locations/my-location/lbRouteExtensions/my-lbRouteExtension', - * // Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server 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). - * requestId: 'placeholder-value', - * }, - * ); + * const res = await networkservices.projects.locations.lbEdgeExtensions.delete({ + * // Required. The name of the `LbEdgeExtension` resource to delete. Must be in the format `projects/{project\}/locations/{location\}/lbEdgeExtensions/{lb_edge_extension\}`. + * name: 'projects/my-project/locations/my-location/lbEdgeExtensions/my-lbEdgeExtension', + * // Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server 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). + * requestId: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -8835,31 +8900,31 @@ export namespace networkservices_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, + params: Params$Resource$Projects$Locations$Lbedgeextensions$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, + params?: Params$Resource$Projects$Locations$Lbedgeextensions$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, + params: Params$Resource$Projects$Locations$Lbedgeextensions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, + params: Params$Resource$Projects$Locations$Lbedgeextensions$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, + params: Params$Resource$Projects$Locations$Lbedgeextensions$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbrouteextensions$Delete + | Params$Resource$Projects$Locations$Lbedgeextensions$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -8875,13 +8940,13 @@ export namespace networkservices_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Delete; + {}) as Params$Resource$Projects$Locations$Lbedgeextensions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lbrouteextensions$Delete; + {} as Params$Resource$Projects$Locations$Lbedgeextensions$Delete; options = {}; } @@ -8917,7 +8982,7 @@ export namespace networkservices_v1 { } /** - * Gets details of the specified `LbRouteExtension` resource. + * Gets details of the specified `LbEdgeExtension` resource. * @example * ```js * // Before running the sample: @@ -8946,9 +9011,9 @@ export namespace networkservices_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await networkservices.projects.locations.lbRouteExtensions.get({ - * // Required. A name of the `LbRouteExtension` resource to get. Must be in the format `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. - * name: 'projects/my-project/locations/my-location/lbRouteExtensions/my-lbRouteExtension', + * const res = await networkservices.projects.locations.lbEdgeExtensions.get({ + * // Required. A name of the `LbEdgeExtension` resource to get. Must be in the format `projects/{project\}/locations/{location\}/lbEdgeExtensions/{lb_edge_extension\}`. + * name: 'projects/my-project/locations/my-location/lbEdgeExtensions/my-lbEdgeExtension', * }); * console.log(res.data); * @@ -8960,7 +9025,6 @@ export namespace networkservices_v1 { * // "forwardingRules": [], * // "labels": {}, * // "loadBalancingScheme": "my_loadBalancingScheme", - * // "metadata": {}, * // "name": "my_name", * // "updateTime": "my_updateTime" * // } @@ -8979,52 +9043,52 @@ export namespace networkservices_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, + params: Params$Resource$Projects$Locations$Lbedgeextensions$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Lbrouteextensions$Get, + params?: Params$Resource$Projects$Locations$Lbedgeextensions$Get, options?: MethodOptions - ): Promise>; + ): Promise>; get( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, + params: Params$Resource$Projects$Locations$Lbedgeextensions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Lbedgeextensions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Lbedgeextensions$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbrouteextensions$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lbedgeextensions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Get; + {}) as Params$Resource$Projects$Locations$Lbedgeextensions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Lbrouteextensions$Get; + params = {} as Params$Resource$Projects$Locations$Lbedgeextensions$Get; options = {}; } @@ -9050,17 +9114,17 @@ export namespace networkservices_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists `LbRouteExtension` resources in a given project and location. + * Lists `LbEdgeExtension` resources in a given project and location. * @example * ```js * // Before running the sample: @@ -9089,7 +9153,7 @@ export namespace networkservices_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await networkservices.projects.locations.lbRouteExtensions.list({ + * const res = await networkservices.projects.locations.lbEdgeExtensions.list({ * // Optional. Filtering results. * filter: 'placeholder-value', * // Optional. Hint about how to order the results. @@ -9098,14 +9162,14 @@ export namespace networkservices_v1 { * pageSize: 'placeholder-value', * // Optional. A token identifying a page of results that the server returns. * pageToken: 'placeholder-value', - * // Required. The project and location from which the `LbRouteExtension` resources are listed. These values are specified in the following format: `projects/{project\}/locations/{location\}`. + * // Required. The project and location from which the `LbEdgeExtension` resources are listed. These values are specified in the following format: `projects/{project\}/locations/{location\}`. * parent: 'projects/my-project/locations/my-location', * }); * console.log(res.data); * * // Example response * // { - * // "lbRouteExtensions": [], + * // "lbEdgeExtensions": [], * // "nextPageToken": "my_nextPageToken", * // "unreachable": [] * // } @@ -9124,57 +9188,56 @@ export namespace networkservices_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Lbrouteextensions$List, + params: Params$Resource$Projects$Locations$Lbedgeextensions$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Lbrouteextensions$List, + params?: Params$Resource$Projects$Locations$Lbedgeextensions$List, options?: MethodOptions - ): Promise>; + ): Promise>; list( - params: Params$Resource$Projects$Locations$Lbrouteextensions$List, + params: Params$Resource$Projects$Locations$Lbedgeextensions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Lbrouteextensions$List, + params: Params$Resource$Projects$Locations$Lbedgeextensions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Lbrouteextensions$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Lbedgeextensions$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbrouteextensions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lbedgeextensions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbrouteextensions$List; + {}) as Params$Resource$Projects$Locations$Lbedgeextensions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lbrouteextensions$List; + params = {} as Params$Resource$Projects$Locations$Lbedgeextensions$List; options = {}; } @@ -9188,7 +9251,7 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/lbRouteExtensions').replace( + url: (rootUrl + '/v1/{+parent}/lbEdgeExtensions').replace( /([^:]\/)\/+/g, '$1' ), @@ -9203,19 +9266,19 @@ export namespace networkservices_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates the parameters of the specified `LbRouteExtension` resource. + * Updates the parameters of the specified `LbEdgeExtension` resource. * @example * ```js * // Before running the sample: @@ -9244,12 +9307,12 @@ export namespace networkservices_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await networkservices.projects.locations.lbRouteExtensions.patch({ - * // Required. Identifier. Name of the `LbRouteExtension` resource in the following format: `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. - * name: 'projects/my-project/locations/my-location/lbRouteExtensions/my-lbRouteExtension', + * const res = await networkservices.projects.locations.lbEdgeExtensions.patch({ + * // Required. Identifier. Name of the `LbEdgeExtension` resource in the following format: `projects/{project\}/locations/{location\}/lbEdgeExtensions/{lb_edge_extension\}`. + * name: 'projects/my-project/locations/my-location/lbEdgeExtensions/my-lbEdgeExtension', * // Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server 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). * requestId: 'placeholder-value', - * // Optional. Used to specify the fields to be overwritten in the `LbRouteExtension` resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten. + * // Optional. Used to specify the fields to be overwritten in the `LbEdgeExtension` resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten. * updateMask: 'placeholder-value', * * // Request body metadata @@ -9262,7 +9325,6 @@ export namespace networkservices_v1 { * // "forwardingRules": [], * // "labels": {}, * // "loadBalancingScheme": "my_loadBalancingScheme", - * // "metadata": {}, * // "name": "my_name", * // "updateTime": "my_updateTime" * // } @@ -9293,31 +9355,31 @@ export namespace networkservices_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + params: Params$Resource$Projects$Locations$Lbedgeextensions$Patch, options: StreamMethodOptions ): Promise>; patch( - params?: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + params?: Params$Resource$Projects$Locations$Lbedgeextensions$Patch, options?: MethodOptions ): Promise>; patch( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + params: Params$Resource$Projects$Locations$Lbedgeextensions$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + params: Params$Resource$Projects$Locations$Lbedgeextensions$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + params: Params$Resource$Projects$Locations$Lbedgeextensions$Patch, callback: BodyResponseCallback ): void; patch(callback: BodyResponseCallback): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbrouteextensions$Patch + | Params$Resource$Projects$Locations$Lbedgeextensions$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -9333,13 +9395,13 @@ export namespace networkservices_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Patch; + {}) as Params$Resource$Projects$Locations$Lbedgeextensions$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lbrouteextensions$Patch; + {} as Params$Resource$Projects$Locations$Lbedgeextensions$Patch; options = {}; } @@ -9375,14 +9437,14 @@ export namespace networkservices_v1 { } } - export interface Params$Resource$Projects$Locations$Lbrouteextensions$Create + export interface Params$Resource$Projects$Locations$Lbedgeextensions$Create extends StandardParameters { /** - * Required. User-provided ID of the `LbRouteExtension` resource to be created. + * Required. User-provided ID of the `LbEdgeExtension` resource to be created. */ - lbRouteExtensionId?: string; + lbEdgeExtensionId?: string; /** - * Required. The parent resource of the `LbRouteExtension` resource. Must be in the format `projects/{project\}/locations/{location\}`. + * Required. The parent resource of the `LbEdgeExtension` resource. Must be in the format `projects/{project\}/locations/{location\}`. */ parent?: string; /** @@ -9393,12 +9455,12 @@ export namespace networkservices_v1 { /** * Request body metadata */ - requestBody?: Schema$LbRouteExtension; + requestBody?: Schema$LbEdgeExtension; } - export interface Params$Resource$Projects$Locations$Lbrouteextensions$Delete + export interface Params$Resource$Projects$Locations$Lbedgeextensions$Delete extends StandardParameters { /** - * Required. The name of the `LbRouteExtension` resource to delete. Must be in the format `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + * Required. The name of the `LbEdgeExtension` resource to delete. Must be in the format `projects/{project\}/locations/{location\}/lbEdgeExtensions/{lb_edge_extension\}`. */ name?: string; /** @@ -9406,14 +9468,14 @@ export namespace networkservices_v1 { */ requestId?: string; } - export interface Params$Resource$Projects$Locations$Lbrouteextensions$Get + export interface Params$Resource$Projects$Locations$Lbedgeextensions$Get extends StandardParameters { /** - * Required. A name of the `LbRouteExtension` resource to get. Must be in the format `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + * Required. A name of the `LbEdgeExtension` resource to get. Must be in the format `projects/{project\}/locations/{location\}/lbEdgeExtensions/{lb_edge_extension\}`. */ name?: string; } - export interface Params$Resource$Projects$Locations$Lbrouteextensions$List + export interface Params$Resource$Projects$Locations$Lbedgeextensions$List extends StandardParameters { /** * Optional. Filtering results. @@ -9432,14 +9494,14 @@ export namespace networkservices_v1 { */ pageToken?: string; /** - * Required. The project and location from which the `LbRouteExtension` resources are listed. These values are specified in the following format: `projects/{project\}/locations/{location\}`. + * Required. The project and location from which the `LbEdgeExtension` resources are listed. These values are specified in the following format: `projects/{project\}/locations/{location\}`. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Lbrouteextensions$Patch + export interface Params$Resource$Projects$Locations$Lbedgeextensions$Patch extends StandardParameters { /** - * Required. Identifier. Name of the `LbRouteExtension` resource in the following format: `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + * Required. Identifier. Name of the `LbEdgeExtension` resource in the following format: `projects/{project\}/locations/{location\}/lbEdgeExtensions/{lb_edge_extension\}`. */ name?: string; /** @@ -9447,24 +9509,24 @@ export namespace networkservices_v1 { */ requestId?: string; /** - * Optional. Used to specify the fields to be overwritten in the `LbRouteExtension` resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten. + * Optional. Used to specify the fields to be overwritten in the `LbEdgeExtension` resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$LbRouteExtension; + requestBody?: Schema$LbEdgeExtension; } - export class Resource$Projects$Locations$Lbtrafficextensions { + export class Resource$Projects$Locations$Lbrouteextensions { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates a new `LbTrafficExtension` resource in a given project and location. + * Creates a new `LbRouteExtension` resource in a given project and location. * @example * ```js * // Before running the sample: @@ -9493,11 +9555,11 @@ export namespace networkservices_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await networkservices.projects.locations.lbTrafficExtensions.create({ - * // Required. User-provided ID of the `LbTrafficExtension` resource to be created. - * lbTrafficExtensionId: 'placeholder-value', - * // Required. The parent resource of the `LbTrafficExtension` resource. Must be in the format `projects/{project\}/locations/{location\}`. + * const res = await networkservices.projects.locations.lbRouteExtensions.create( + * { + * // Required. User-provided ID of the `LbRouteExtension` resource to be created. + * lbRouteExtensionId: 'placeholder-value', + * // Required. The parent resource of the `LbRouteExtension` resource. Must be in the format `projects/{project\}/locations/{location\}`. * parent: 'projects/my-project/locations/my-location', * // Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server 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). * requestId: 'placeholder-value', @@ -9517,7 +9579,8 @@ export namespace networkservices_v1 { * // "updateTime": "my_updateTime" * // } * }, - * }); + * }, + * ); * console.log(res.data); * * // Example response @@ -9543,31 +9606,31 @@ export namespace networkservices_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, options: StreamMethodOptions ): Promise>; create( - params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + params?: Params$Resource$Projects$Locations$Lbrouteextensions$Create, options?: MethodOptions ): Promise>; create( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, callback: BodyResponseCallback ): void; create(callback: BodyResponseCallback): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbtrafficextensions$Create + | Params$Resource$Projects$Locations$Lbrouteextensions$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -9583,13 +9646,13 @@ export namespace networkservices_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Create; + {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Create; + {} as Params$Resource$Projects$Locations$Lbrouteextensions$Create; options = {}; } @@ -9603,7 +9666,7 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/lbTrafficExtensions').replace( + url: (rootUrl + '/v1/{+parent}/lbRouteExtensions').replace( /([^:]\/)\/+/g, '$1' ), @@ -9628,7 +9691,7 @@ export namespace networkservices_v1 { } /** - * Deletes the specified `LbTrafficExtension` resource. + * Deletes the specified `LbRouteExtension` resource. * @example * ```js * // Before running the sample: @@ -9657,13 +9720,14 @@ export namespace networkservices_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await networkservices.projects.locations.lbTrafficExtensions.delete({ - * // Required. The name of the `LbTrafficExtension` resource to delete. Must be in the format `projects/{project\}/locations/{location\}/lbTrafficExtensions/{lb_traffic_extension\}`. - * name: 'projects/my-project/locations/my-location/lbTrafficExtensions/my-lbTrafficExtension', + * const res = await networkservices.projects.locations.lbRouteExtensions.delete( + * { + * // Required. The name of the `LbRouteExtension` resource to delete. Must be in the format `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + * name: 'projects/my-project/locations/my-location/lbRouteExtensions/my-lbRouteExtension', * // Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server 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). * requestId: 'placeholder-value', - * }); + * }, + * ); * console.log(res.data); * * // Example response @@ -9689,15 +9753,869 @@ export namespace networkservices_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, + params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, + params?: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, + params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Lbrouteextensions$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Lbrouteextensions$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of the specified `LbRouteExtension` resource. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/networkservices.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const networkservices = google.networkservices('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await networkservices.projects.locations.lbRouteExtensions.get({ + * // Required. A name of the `LbRouteExtension` resource to get. Must be in the format `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + * name: 'projects/my-project/locations/my-location/lbRouteExtensions/my-lbRouteExtension', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "extensionChains": [], + * // "forwardingRules": [], + * // "labels": {}, + * // "loadBalancingScheme": "my_loadBalancingScheme", + * // "metadata": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Lbrouteextensions$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Lbrouteextensions$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Lbrouteextensions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists `LbRouteExtension` resources in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/networkservices.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const networkservices = google.networkservices('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await networkservices.projects.locations.lbRouteExtensions.list({ + * // Optional. Filtering results. + * filter: 'placeholder-value', + * // Optional. Hint about how to order the results. + * orderBy: 'placeholder-value', + * // Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results that the server returns. + * pageToken: 'placeholder-value', + * // Required. The project and location from which the `LbRouteExtension` resources are listed. These values are specified in the following format: `projects/{project\}/locations/{location\}`. + * parent: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "lbRouteExtensions": [], + * // "nextPageToken": "my_nextPageToken", + * // "unreachable": [] + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Lbrouteextensions$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Lbrouteextensions$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Projects$Locations$Lbrouteextensions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Lbrouteextensions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Lbrouteextensions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Lbrouteextensions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Lbrouteextensions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Lbrouteextensions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/lbRouteExtensions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates the parameters of the specified `LbRouteExtension` resource. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/networkservices.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const networkservices = google.networkservices('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await networkservices.projects.locations.lbRouteExtensions.patch({ + * // Required. Identifier. Name of the `LbRouteExtension` resource in the following format: `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + * name: 'projects/my-project/locations/my-location/lbRouteExtensions/my-lbRouteExtension', + * // Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server 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). + * requestId: 'placeholder-value', + * // Optional. Used to specify the fields to be overwritten in the `LbRouteExtension` resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "extensionChains": [], + * // "forwardingRules": [], + * // "labels": {}, + * // "loadBalancingScheme": "my_loadBalancingScheme", + * // "metadata": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Lbrouteextensions$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Lbrouteextensions$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Lbrouteextensions$Create + extends StandardParameters { + /** + * Required. User-provided ID of the `LbRouteExtension` resource to be created. + */ + lbRouteExtensionId?: string; + /** + * Required. The parent resource of the `LbRouteExtension` resource. Must be in the format `projects/{project\}/locations/{location\}`. + */ + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server 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). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LbRouteExtension; + } + export interface Params$Resource$Projects$Locations$Lbrouteextensions$Delete + extends StandardParameters { + /** + * Required. The name of the `LbRouteExtension` resource to delete. Must be in the format `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server 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). + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Lbrouteextensions$Get + extends StandardParameters { + /** + * Required. A name of the `LbRouteExtension` resource to get. Must be in the format `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Lbrouteextensions$List + extends StandardParameters { + /** + * Optional. Filtering results. + */ + filter?: string; + /** + * Optional. Hint about how to order the results. + */ + orderBy?: string; + /** + * Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results that the server returns. + */ + pageToken?: string; + /** + * Required. The project and location from which the `LbRouteExtension` resources are listed. These values are specified in the following format: `projects/{project\}/locations/{location\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Lbrouteextensions$Patch + extends StandardParameters { + /** + * Required. Identifier. Name of the `LbRouteExtension` resource in the following format: `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server 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). + */ + requestId?: string; + /** + * Optional. Used to specify the fields to be overwritten in the `LbRouteExtension` resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LbRouteExtension; + } + + export class Resource$Projects$Locations$Lbtrafficextensions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new `LbTrafficExtension` resource in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/networkservices.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const networkservices = google.networkservices('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await networkservices.projects.locations.lbTrafficExtensions.create({ + * // Required. User-provided ID of the `LbTrafficExtension` resource to be created. + * lbTrafficExtensionId: 'placeholder-value', + * // Required. The parent resource of the `LbTrafficExtension` resource. Must be in the format `projects/{project\}/locations/{location\}`. + * parent: 'projects/my-project/locations/my-location', + * // Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server 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). + * requestId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "extensionChains": [], + * // "forwardingRules": [], + * // "labels": {}, + * // "loadBalancingScheme": "my_loadBalancingScheme", + * // "metadata": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Lbtrafficextensions$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/lbTrafficExtensions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes the specified `LbTrafficExtension` resource. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/networkservices.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const networkservices = google.networkservices('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await networkservices.projects.locations.lbTrafficExtensions.delete({ + * // Required. The name of the `LbTrafficExtension` resource to delete. Must be in the format `projects/{project\}/locations/{location\}/lbTrafficExtensions/{lb_traffic_extension\}`. + * name: 'projects/my-project/locations/my-location/lbTrafficExtensions/my-lbTrafficExtension', + * // Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server 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). + * requestId: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; @@ -11908,13 +12826,16 @@ export namespace networkservices_v1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -12061,6 +12982,10 @@ export namespace networkservices_v1 { * The standard list page token. */ pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Servicebindings { diff --git a/src/apis/networkservices/v1beta1.ts b/src/apis/networkservices/v1beta1.ts index 9e1b2af346..238643603f 100644 --- a/src/apis/networkservices/v1beta1.ts +++ b/src/apis/networkservices/v1beta1.ts @@ -273,7 +273,7 @@ export namespace networkservices_v1beta1 { */ export interface Schema$ExtensionChainExtension { /** - * Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions. Setting it results in a validation error. + * Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. */ allowDynamicForwarding?: boolean | null; /** @@ -289,11 +289,11 @@ export namespace networkservices_v1beta1 { */ forwardHeaders?: string[] | null; /** - * Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id\}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings. + * Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. For `AuthzExtension` resources, the metadata is available under the namespace `com.google.authz_extension.`. For other types of extensions, the metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id\}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings. */ metadata?: {[key: string]: any} | null; /** - * Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. + * Optional. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. This field is required except for AuthzExtension. */ name?: string | null; /** @@ -301,7 +301,7 @@ export namespace networkservices_v1beta1 { */ requestBodySendMode?: string | null; /** - * Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. + * Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. */ responseBodySendMode?: string | null; /** @@ -309,7 +309,7 @@ export namespace networkservices_v1beta1 { */ service?: string | null; /** - * Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. + * Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. */ supportedEvents?: string[] | null; /** @@ -1456,6 +1456,10 @@ export namespace networkservices_v1beta1 { * A list of operations that matches the specified filter in the request. */ operations?: Schema$Operation[]; + /** + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; } /** * Response returned by the ListServiceBindings method. @@ -2458,7 +2462,7 @@ export namespace networkservices_v1beta1 { * * // Do the magic * const res = await networkservices.projects.locations.list({ - * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -2587,7 +2591,7 @@ export namespace networkservices_v1beta1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. + * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */ extraLocationTypes?: string[]; /** @@ -12121,13 +12125,16 @@ export namespace networkservices_v1beta1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -12274,6 +12281,10 @@ export namespace networkservices_v1beta1 { * The standard list page token. */ pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Servicebindings { diff --git a/src/apis/observability/v1.ts b/src/apis/observability/v1.ts index 3a82712a2c..832d86ea77 100644 --- a/src/apis/observability/v1.ts +++ b/src/apis/observability/v1.ts @@ -517,7 +517,7 @@ export namespace observability_v1 { * * // Do the magic * const res = await observability.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -646,7 +646,7 @@ export namespace observability_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/oracledatabase/v1.ts b/src/apis/oracledatabase/v1.ts index 3826024176..aaef6361d8 100644 --- a/src/apis/oracledatabase/v1.ts +++ b/src/apis/oracledatabase/v1.ts @@ -3147,7 +3147,7 @@ export namespace oracledatabase_v1 { * * // Do the magic * const res = await oracledatabase.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -3276,7 +3276,7 @@ export namespace oracledatabase_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/parametermanager/v1.ts b/src/apis/parametermanager/v1.ts index 4e71b0ca71..f26c4053c3 100644 --- a/src/apis/parametermanager/v1.ts +++ b/src/apis/parametermanager/v1.ts @@ -491,7 +491,7 @@ export namespace parametermanager_v1 { * * // Do the magic * const res = await parametermanager.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -620,7 +620,7 @@ export namespace parametermanager_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/paymentsresellersubscription/v1.ts b/src/apis/paymentsresellersubscription/v1.ts index 02986e0304..4b5782075e 100644 --- a/src/apis/paymentsresellersubscription/v1.ts +++ b/src/apis/paymentsresellersubscription/v1.ts @@ -163,6 +163,10 @@ export namespace paymentsresellersubscription_v1 { * Intent message for creating a Subscription resource. */ export interface Schema$CreateSubscriptionIntent { + /** + * Optional. The cycle options for the subscription. + */ + cycleOptions?: Schema$CycleOptions; /** * Required. The parent resource name, which is the identifier of the partner. */ @@ -401,6 +405,19 @@ export namespace paymentsresellersubscription_v1 { * The request to entitle a subscription. */ entitleIntent?: Schema$EntitleSubscriptionIntent; + /** + * Optional. The additional features for the intent. + */ + intentOptions?: Schema$IntentPayloadIntentOptions; + } + /** + * The options for the intent. + */ + export interface Schema$IntentPayloadIntentOptions { + /** + * Optional. If true, Google may use a different product and promotion id from the ones in the `create_intent` based on the user's eligibility. Only applicable for certain YouTube free trial offers. + */ + enableOfferOverride?: boolean | null; } /** * Response that contains the products. diff --git a/src/apis/places/v1.ts b/src/apis/places/v1.ts index 7d20e865c7..573d61c9e7 100644 --- a/src/apis/places/v1.ts +++ b/src/apis/places/v1.ts @@ -749,6 +749,14 @@ export namespace places_v1 { * Place has a children's menu. */ menuForChildren?: boolean | null; + /** + * If this Place is permanently closed and has moved to a new Place, this field contains the new Place's resource name, in `places/{place_id\}` format. If this Place moved multiple times, this field will represent the first moved place. This field will not be populated if this Place has not moved. + */ + movedPlace?: string | null; + /** + * If this Place is permanently closed and has moved to a new Place, this field contains the new Place's place ID. If this Place moved multiple times, this field will represent the first moved Place. This field will not be populated if this Place has not moved. + */ + movedPlaceId?: string | null; /** * This Place's resource name, in `places/{place_id\}` format. Can be used to look up the Place. */ @@ -970,7 +978,7 @@ export namespace places_v1 { */ export interface Schema$GoogleMapsPlacesV1PlaceConsumerAlert { /** - * The details of the consumer alert message.ƒ + * The details of the consumer alert message. */ details?: Schema$GoogleMapsPlacesV1PlaceConsumerAlertDetails; /** @@ -1361,7 +1369,7 @@ export namespace places_v1 { */ text?: Schema$GoogleTypeLocalizedText; /** - * The date when the author visited the place. This is trucated to the year and month of the visit. + * The date when the author visited the place. This is truncated to the year and month of the visit. */ visitDate?: Schema$GoogleTypeDate; } @@ -2025,6 +2033,8 @@ export namespace places_v1 { * // "liveMusic": false, * // "location": {}, * // "menuForChildren": false, + * // "movedPlace": "my_movedPlace", + * // "movedPlaceId": "my_movedPlaceId", * // "name": "my_name", * // "nationalPhoneNumber": "my_nationalPhoneNumber", * // "neighborhoodSummary": {}, diff --git a/src/apis/privateca/v1.ts b/src/apis/privateca/v1.ts index 82bf861f3d..b964395912 100644 --- a/src/apis/privateca/v1.ts +++ b/src/apis/privateca/v1.ts @@ -1672,7 +1672,7 @@ export namespace privateca_v1 { * * // Do the magic * const res = await privateca.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -1800,7 +1800,7 @@ export namespace privateca_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/privateca/v1beta1.ts b/src/apis/privateca/v1beta1.ts index e706fd0cb1..6d31c1e6bd 100644 --- a/src/apis/privateca/v1beta1.ts +++ b/src/apis/privateca/v1beta1.ts @@ -541,7 +541,7 @@ export namespace privateca_v1beta1 { * * // Do the magic * const res = await privateca.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -669,7 +669,7 @@ export namespace privateca_v1beta1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/recaptchaenterprise/v1.ts b/src/apis/recaptchaenterprise/v1.ts index 82182b7f85..a12ae3526e 100644 --- a/src/apis/recaptchaenterprise/v1.ts +++ b/src/apis/recaptchaenterprise/v1.ts @@ -192,9 +192,6 @@ export namespace recaptchaenterprise_v1 { * Optional. A stable account identifier to apply to the assessment. This is an alternative to setting `account_id` in `CreateAssessment`, for example when a stable account identifier is not yet known in the initial request. */ accountId?: string | null; - /** - * Optional. The annotation that is assigned to the Event. This field can be left empty to provide reasons that apply to an event without concluding whether the event is legitimate or fraudulent. - */ annotation?: string | null; /** * Optional. A stable hashed account identifier to apply to the assessment. This is an alternative to setting `hashed_account_id` in `CreateAssessment`, for example when a stable account identifier is not yet known in the initial request. @@ -204,9 +201,6 @@ export namespace recaptchaenterprise_v1 { * Optional. If using an external multi-factor authentication provider, provide phone authentication details for fraud detection purposes. */ phoneAuthenticationEvent?: Schema$GoogleCloudRecaptchaenterpriseV1PhoneAuthenticationEvent; - /** - * Optional. Reasons for the annotation that are assigned to the event. - */ reasons?: string[] | null; /** * Optional. If the assessment is part of a payment transaction, provide details on payment lifecycle events that occur in the transaction. @@ -292,7 +286,7 @@ export namespace recaptchaenterprise_v1 { */ export interface Schema$GoogleCloudRecaptchaenterpriseV1AssessmentEnvironment { /** - * Optional. Identifies the client module initiating the CreateAssessment request. This can be the link to the client module's project. Examples include: - "github.com/GoogleCloudPlatform/recaptcha-enterprise-google-tag-manager" - "cloud.google.com/recaptcha/docs/implement-waf-akamai" - "cloud.google.com/recaptcha/docs/implement-waf-cloudflare" - "wordpress.org/plugins/recaptcha-something" + * Optional. Identifies the client module initiating the CreateAssessment request. This can be the link to the client module's project. Examples include: - "github.com/GoogleCloudPlatform/recaptcha-enterprise-google-tag-manager" - "wordpress.org/plugins/recaptcha-something" */ client?: string | null; /** diff --git a/src/apis/recommender/v1beta1.ts b/src/apis/recommender/v1beta1.ts index 5ca3b31fbe..1e49814720 100644 --- a/src/apis/recommender/v1beta1.ts +++ b/src/apis/recommender/v1beta1.ts @@ -780,7 +780,7 @@ export namespace recommender_v1beta1 { * * // Do the magic * const res = await recommender.billingAccounts.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -909,7 +909,7 @@ export namespace recommender_v1beta1 { export interface Params$Resource$Billingaccounts$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** @@ -3327,7 +3327,7 @@ export namespace recommender_v1beta1 { * * // Do the magic * const res = await recommender.folders.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -3456,7 +3456,7 @@ export namespace recommender_v1beta1 { export interface Params$Resource$Folders$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** @@ -5334,7 +5334,7 @@ export namespace recommender_v1beta1 { * * // Do the magic * const res = await recommender.organizations.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -5463,7 +5463,7 @@ export namespace recommender_v1beta1 { export interface Params$Resource$Organizations$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** @@ -7877,7 +7877,7 @@ export namespace recommender_v1beta1 { * * // Do the magic * const res = await recommender.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -8006,7 +8006,7 @@ export namespace recommender_v1beta1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/redis/v1.ts b/src/apis/redis/v1.ts index e39f60ffb3..e82d685ec8 100644 --- a/src/apis/redis/v1.ts +++ b/src/apis/redis/v1.ts @@ -1987,17 +1987,13 @@ export namespace redis_v1 { */ day?: string | null; /** - * Optional. Phase of the maintenance window. This is to capture order of maintenance. For example, for Cloud SQL resources, this can be used to capture if the maintenance window is in Week1, Week2, Week5, etc. Non production resources are usually part of early phase. For more details, refer to Cloud SQL resources - https://cloud.google.com/sql/docs/mysql/maintenance Deprecated. Use phase instead. + * Optional. Phase of the maintenance window. This is to capture order of maintenance. For example, for Cloud SQL resources, this can be used to capture if the maintenance window is in Week1, Week2, Week5, etc. Non production resources are usually part of early phase. For more details, refer to Cloud SQL resources - https://cloud.google.com/sql/docs/mysql/maintenance */ phase?: string | null; /** * Optional. Preferred time to start the maintenance operation on the specified day. */ time?: Schema$TimeOfDay; - /** - * Optional. Phase of the maintenance window. This is to capture order of maintenance. For example, for Cloud SQL resources, this can be used to capture if the maintenance window is in Week1, Week2, Week5, etc. Non production resources are usually part of early phase. For more details, refer to Cloud SQL resources - https://cloud.google.com/sql/docs/mysql/maintenance - */ - week?: string | null; } export interface Schema$RetentionSettings { /** @@ -2375,7 +2371,7 @@ export namespace redis_v1 { * * // Do the magic * const res = await redis.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -2503,7 +2499,7 @@ export namespace redis_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/redis/v1beta1.ts b/src/apis/redis/v1beta1.ts index f3b0a6cd2d..1fc681039b 100644 --- a/src/apis/redis/v1beta1.ts +++ b/src/apis/redis/v1beta1.ts @@ -1987,17 +1987,13 @@ export namespace redis_v1beta1 { */ day?: string | null; /** - * Optional. Phase of the maintenance window. This is to capture order of maintenance. For example, for Cloud SQL resources, this can be used to capture if the maintenance window is in Week1, Week2, Week5, etc. Non production resources are usually part of early phase. For more details, refer to Cloud SQL resources - https://cloud.google.com/sql/docs/mysql/maintenance Deprecated. Use phase instead. + * Optional. Phase of the maintenance window. This is to capture order of maintenance. For example, for Cloud SQL resources, this can be used to capture if the maintenance window is in Week1, Week2, Week5, etc. Non production resources are usually part of early phase. For more details, refer to Cloud SQL resources - https://cloud.google.com/sql/docs/mysql/maintenance */ phase?: string | null; /** * Optional. Preferred time to start the maintenance operation on the specified day. */ time?: Schema$TimeOfDay; - /** - * Optional. Phase of the maintenance window. This is to capture order of maintenance. For example, for Cloud SQL resources, this can be used to capture if the maintenance window is in Week1, Week2, Week5, etc. Non production resources are usually part of early phase. For more details, refer to Cloud SQL resources - https://cloud.google.com/sql/docs/mysql/maintenance - */ - week?: string | null; } export interface Schema$RetentionSettings { /** @@ -2375,7 +2371,7 @@ export namespace redis_v1beta1 { * * // Do the magic * const res = await redis.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -2503,7 +2499,7 @@ export namespace redis_v1beta1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/retail/v2alpha.ts b/src/apis/retail/v2alpha.ts index f998e09492..3346cdfcf7 100644 --- a/src/apis/retail/v2alpha.ts +++ b/src/apis/retail/v2alpha.ts @@ -1318,7 +1318,7 @@ export namespace retail_v2alpha { */ export interface Schema$GoogleCloudRetailV2alphaExportProductsRequest { /** - * A filtering expression to specify restrictions on returned events. The expression is a sequence of terms. Each term applies a restriction to the returned products. Use this expression to restrict results to a specific time range, tag, or stock state or to filter products by product type. For example, `lastModifiedTime \> "2012-04-23T18:25:43.511Z" lastModifiedTime<"2012-04-23T18:25:43.511Z" productType=primary` We expect only four types of fields: * `lastModifiedTime`: This can be specified twice, once with a less than operator and once with a greater than operator. The `lastModifiedTime` restriction should result in one, contiguous, valid, last-modified, time range. * `productType`: Supported values are `primary` and `variant`. The Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and must be separated from the `productType` values by a space. * `availability`: Supported values are `IN_STOCK`, `OUT_OF_STOCK`, `PREORDER`, and `BACKORDER`. Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and must be separated from the `availability` values by a space. * `Tag expressions`: Restricts output to products that match all of the specified tags. Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and the operators are separated from the tag values by a space. Also supported is '`-"tagA"`', which is equivalent to '`NOT "tagA"`'. Tag values must be double-quoted, UTF-8 encoded strings and have a size limit of 1,000 characters. Some examples of valid filters expressions: * Example 1: `lastModifiedTime \> "2012-04-23T18:25:43.511Z" lastModifiedTime < "2012-04-23T18:30:43.511Z"` * Example 2: `lastModifiedTime \> "2012-04-23T18:25:43.511Z" productType = "variant"` * Example 3: `tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional") productType = "primary" lastModifiedTime < "2018-04-23T18:30:43.511Z"` * Example 4: `lastModifiedTime \> "2012-04-23T18:25:43.511Z"` * Example 5: `availability = (IN_STOCK OR BACKORDER)` + * This field is deprecated. Any filter provided will be ignored. */ filter?: string | null; /** diff --git a/src/apis/retail/v2beta.ts b/src/apis/retail/v2beta.ts index 7e8efbcb90..0f2248dfb2 100644 --- a/src/apis/retail/v2beta.ts +++ b/src/apis/retail/v2beta.ts @@ -1768,7 +1768,7 @@ export namespace retail_v2beta { */ export interface Schema$GoogleCloudRetailV2betaExportProductsRequest { /** - * A filtering expression to specify restrictions on returned events. The expression is a sequence of terms. Each term applies a restriction to the returned products. Use this expression to restrict results to a specific time range, tag, or stock state or to filter products by product type. For example, `lastModifiedTime \> "2012-04-23T18:25:43.511Z" lastModifiedTime<"2012-04-23T18:25:43.511Z" productType=primary` We expect only four types of fields: * `lastModifiedTime`: This can be specified twice, once with a less than operator and once with a greater than operator. The `lastModifiedTime` restriction should result in one, contiguous, valid, last-modified, time range. * `productType`: Supported values are `primary` and `variant`. The Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and must be separated from the `productType` values by a space. * `availability`: Supported values are `IN_STOCK`, `OUT_OF_STOCK`, `PREORDER`, and `BACKORDER`. Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and must be separated from the `availability` values by a space. * `Tag expressions`: Restricts output to products that match all of the specified tags. Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and the operators are separated from the tag values by a space. Also supported is '`-"tagA"`', which is equivalent to '`NOT "tagA"`'. Tag values must be double-quoted, UTF-8 encoded strings and have a size limit of 1,000 characters. Some examples of valid filters expressions: * Example 1: `lastModifiedTime \> "2012-04-23T18:25:43.511Z" lastModifiedTime < "2012-04-23T18:30:43.511Z"` * Example 2: `lastModifiedTime \> "2012-04-23T18:25:43.511Z" productType = "variant"` * Example 3: `tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional") productType = "primary" lastModifiedTime < "2018-04-23T18:30:43.511Z"` * Example 4: `lastModifiedTime \> "2012-04-23T18:25:43.511Z"` * Example 5: `availability = (IN_STOCK OR BACKORDER)` + * This field is deprecated. Any filter provided will be ignored. */ filter?: string | null; /** diff --git a/src/apis/run/v2.ts b/src/apis/run/v2.ts index 72ef38fd1a..dcf1898e0a 100644 --- a/src/apis/run/v2.ts +++ b/src/apis/run/v2.ts @@ -335,6 +335,10 @@ export namespace run_v2 { * Compute Resource requirements by this container. */ resources?: Schema$GoogleCloudRunV2ResourceRequirements; + /** + * Optional. Location of the source .tar.gz file in Cloud Storage. examples: - gs://bucket/object.tar.gz. - gs://bucket/object.tar.gz#1234567890 (with object generation) + */ + source?: string | null; /** * Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails. */ diff --git a/src/apis/securitycenter/v1.ts b/src/apis/securitycenter/v1.ts index 645d9191ff..ce6c6e3242 100644 --- a/src/apis/securitycenter/v1.ts +++ b/src/apis/securitycenter/v1.ts @@ -4115,11 +4115,67 @@ export namespace securitycenter_v1 { * The AppHub application associated with the resource, if any. */ export interface Schema$GoogleCloudSecuritycenterV2IssueResourceApplication { + /** + * Consumer provided attributes for the application + */ + attributes?: Schema$GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes; /** * The resource name of an Application. Format: `projects/{host-project-id\}/locations/{location\}/applications/{application-id\}` */ name?: string | null; } + /** + * Consumer provided attributes for the application + */ + export interface Schema$GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes { + /** + * Business team that ensures user needs are met and value is delivered + */ + businessOwners?: Schema$GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo[]; + /** + * User-defined criticality information. + */ + criticality?: Schema$GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesCriticality; + /** + * Developer team that owns development and coding. + */ + developerOwners?: Schema$GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo[]; + /** + * User-defined environment information. + */ + environment?: Schema$GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesEnvironment; + /** + * Operator team that ensures runtime and operations. + */ + operatorOwners?: Schema$GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo[]; + } + /** + * Contact information of stakeholders. + */ + export interface Schema$GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo { + /** + * Email address of the contacts. + */ + email?: string | null; + } + /** + * Criticality of the Application, Service, or Workload + */ + export interface Schema$GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesCriticality { + /** + * Criticality Type. + */ + type?: string | null; + } + /** + * Environment of the Application, Service, or Workload + */ + export interface Schema$GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesEnvironment { + /** + * Environment Type. + */ + type?: string | null; + } /** * The AWS metadata of a resource associated with an issue. */ diff --git a/src/apis/securitycenter/v1beta1.ts b/src/apis/securitycenter/v1beta1.ts index 4ca66ecb8a..beacbe9b38 100644 --- a/src/apis/securitycenter/v1beta1.ts +++ b/src/apis/securitycenter/v1beta1.ts @@ -3921,11 +3921,67 @@ export namespace securitycenter_v1beta1 { * The AppHub application associated with the resource, if any. */ export interface Schema$GoogleCloudSecuritycenterV2IssueResourceApplication { + /** + * Consumer provided attributes for the application + */ + attributes?: Schema$GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes; /** * The resource name of an Application. Format: `projects/{host-project-id\}/locations/{location\}/applications/{application-id\}` */ name?: string | null; } + /** + * Consumer provided attributes for the application + */ + export interface Schema$GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes { + /** + * Business team that ensures user needs are met and value is delivered + */ + businessOwners?: Schema$GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo[]; + /** + * User-defined criticality information. + */ + criticality?: Schema$GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesCriticality; + /** + * Developer team that owns development and coding. + */ + developerOwners?: Schema$GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo[]; + /** + * User-defined environment information. + */ + environment?: Schema$GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesEnvironment; + /** + * Operator team that ensures runtime and operations. + */ + operatorOwners?: Schema$GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo[]; + } + /** + * Contact information of stakeholders. + */ + export interface Schema$GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo { + /** + * Email address of the contacts. + */ + email?: string | null; + } + /** + * Criticality of the Application, Service, or Workload + */ + export interface Schema$GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesCriticality { + /** + * Criticality Type. + */ + type?: string | null; + } + /** + * Environment of the Application, Service, or Workload + */ + export interface Schema$GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesEnvironment { + /** + * Environment Type. + */ + type?: string | null; + } /** * The AWS metadata of a resource associated with an issue. */ diff --git a/src/apis/securitycenter/v1beta2.ts b/src/apis/securitycenter/v1beta2.ts index ceda0c48b2..c7bdf60762 100644 --- a/src/apis/securitycenter/v1beta2.ts +++ b/src/apis/securitycenter/v1beta2.ts @@ -3832,11 +3832,67 @@ export namespace securitycenter_v1beta2 { * The AppHub application associated with the resource, if any. */ export interface Schema$GoogleCloudSecuritycenterV2IssueResourceApplication { + /** + * Consumer provided attributes for the application + */ + attributes?: Schema$GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes; /** * The resource name of an Application. Format: `projects/{host-project-id\}/locations/{location\}/applications/{application-id\}` */ name?: string | null; } + /** + * Consumer provided attributes for the application + */ + export interface Schema$GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes { + /** + * Business team that ensures user needs are met and value is delivered + */ + businessOwners?: Schema$GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo[]; + /** + * User-defined criticality information. + */ + criticality?: Schema$GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesCriticality; + /** + * Developer team that owns development and coding. + */ + developerOwners?: Schema$GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo[]; + /** + * User-defined environment information. + */ + environment?: Schema$GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesEnvironment; + /** + * Operator team that ensures runtime and operations. + */ + operatorOwners?: Schema$GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo[]; + } + /** + * Contact information of stakeholders. + */ + export interface Schema$GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo { + /** + * Email address of the contacts. + */ + email?: string | null; + } + /** + * Criticality of the Application, Service, or Workload + */ + export interface Schema$GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesCriticality { + /** + * Criticality Type. + */ + type?: string | null; + } + /** + * Environment of the Application, Service, or Workload + */ + export interface Schema$GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesEnvironment { + /** + * Environment Type. + */ + type?: string | null; + } /** * The AWS metadata of a resource associated with an issue. */ diff --git a/src/apis/securityposture/v1.ts b/src/apis/securityposture/v1.ts index 0913b15888..0a0e78c689 100644 --- a/src/apis/securityposture/v1.ts +++ b/src/apis/securityposture/v1.ts @@ -392,6 +392,10 @@ export namespace securityposture_v1 { * A list of operations that matches the specified filter in the request. */ operations?: Schema$Operation[]; + /** + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; } /** * Response message for ListPostureDeployments. @@ -1437,13 +1441,16 @@ export namespace securityposture_v1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -1590,6 +1597,10 @@ export namespace securityposture_v1 { * The standard list page token. */ pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Organizations$Locations$Posturedeployments { diff --git a/src/apis/serviceconsumermanagement/v1.ts b/src/apis/serviceconsumermanagement/v1.ts index 49037c558b..adc9bfbef8 100644 --- a/src/apis/serviceconsumermanagement/v1.ts +++ b/src/apis/serviceconsumermanagement/v1.ts @@ -1009,6 +1009,10 @@ export namespace serviceconsumermanagement_v1 { * A list of operations that matches the specified filter in the request. */ operations?: Schema$Operation[]; + /** + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; } /** * Response for the list request. @@ -2067,6 +2071,10 @@ export namespace serviceconsumermanagement_v1 { * P4 service identity resource name. An example name would be: `services/serviceconsumermanagement.googleapis.com/projects/123/serviceIdentities/default` */ name?: string | null; + /** + * The project-level IAM role defined in the service agent's grant configuration. This is the standard role intended for this service agent. This field is populated regardless of the `skip_role_attach` option in the request. If `skip_role_attach` is true, the caller can use this value to know which role they are responsible for granting. + */ + projectRole?: string | null; /** * The P4 service identity configuration tag. This must be defined in activation_grants. If not specified when creating the account, the tag is set to "default". */ @@ -2625,13 +2633,16 @@ export namespace serviceconsumermanagement_v1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -2772,6 +2783,10 @@ export namespace serviceconsumermanagement_v1 { * The standard list page token. */ pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Services { diff --git a/src/apis/serviceconsumermanagement/v1beta1.ts b/src/apis/serviceconsumermanagement/v1beta1.ts index b68188389e..a2d4c3c7c1 100644 --- a/src/apis/serviceconsumermanagement/v1beta1.ts +++ b/src/apis/serviceconsumermanagement/v1beta1.ts @@ -2130,6 +2130,10 @@ export namespace serviceconsumermanagement_v1beta1 { * P4 service identity resource name. An example name would be: `services/serviceconsumermanagement.googleapis.com/projects/123/serviceIdentities/default` */ name?: string | null; + /** + * The project-level IAM role defined in the service agent's grant configuration. This is the standard role intended for this service agent. This field is populated regardless of the `skip_role_attach` option in the request. If `skip_role_attach` is true, the caller can use this value to know which role they are responsible for granting. + */ + projectRole?: string | null; /** * The P4 service identity configuration tag. This must be defined in activation_grants. If not specified when creating the account, the tag is set to "default". */ diff --git a/src/apis/servicenetworking/v1.ts b/src/apis/servicenetworking/v1.ts index 171b9dc7f2..d638704510 100644 --- a/src/apis/servicenetworking/v1.ts +++ b/src/apis/servicenetworking/v1.ts @@ -786,7 +786,7 @@ export namespace servicenetworking_v1 { */ export interface Schema$Control { /** - * The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com + * The service controller environment to use. If empty, no control plane features (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com. */ environment?: string | null; /** diff --git a/src/apis/servicenetworking/v1beta.ts b/src/apis/servicenetworking/v1beta.ts index 54adffad80..6ec0f270cc 100644 --- a/src/apis/servicenetworking/v1beta.ts +++ b/src/apis/servicenetworking/v1beta.ts @@ -678,7 +678,7 @@ export namespace servicenetworking_v1beta { */ export interface Schema$Control { /** - * The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com + * The service controller environment to use. If empty, no control plane features (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com. */ environment?: string | null; /** diff --git a/src/apis/serviceusage/v1.ts b/src/apis/serviceusage/v1.ts index 26cfc1919c..e01e879010 100644 --- a/src/apis/serviceusage/v1.ts +++ b/src/apis/serviceusage/v1.ts @@ -645,6 +645,19 @@ export namespace serviceusage_v1 { */ contentSecurityProviders?: Schema$ContentSecurityProvider[]; } + /** + * Content Security Policy contains the content security related policy of a resource. + */ + export interface Schema$ContentSecurityPolicy { + /** + * mcp_content_security contains the content security related settings at resource level for MCP traffic. + */ + mcpContentSecurity?: Schema$ContentSecurity; + /** + * Output only. The resource name of the policy. Only the `default` policy is supported. We allow the following formats: `projects/{PROJECT_NUMBER\}/contentSecurityPolicies/default`, `projects/{PROJECT_ID\}/contentSecurityPolicies/default`, We only support project level content security policy for now. + */ + name?: string | null; + } /** * ContentSecurityProvider contains the name of content security provider. */ @@ -1395,10 +1408,6 @@ export namespace serviceusage_v1 { * Consumer Policy is a set of rules that define what services or service groups can be used for a cloud resource hierarchy. */ export interface Schema$GoogleApiServiceusageV2betaConsumerPolicy { - /** - * Optional. Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. [AIP-128](https://google.aip.dev/128#annotations) - */ - annotations?: {[key: string]: string} | null; /** * Output only. The time the policy was created. For singleton policies, this is the first touch of the policy. */ @@ -1644,6 +1653,10 @@ export namespace serviceusage_v1 { * A list of operations that matches the specified filter in the request. */ operations?: Schema$Operation[]; + /** + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; } /** * Response message for the `ListServices` method. @@ -1739,10 +1752,6 @@ export namespace serviceusage_v1 { * MCP Consumer Policy is a set of rules that define MCP related policy for a cloud resource hierarchy. */ export interface Schema$McpPolicy { - /** - * ContentSecurity contains the content security related fields of a MCP policy. - */ - contentSecurity?: Schema$ContentSecurity; /** * Output only. The time the policy was created. For singleton policies (such as the `default` policy), this is the first touch of the policy. */ @@ -2406,6 +2415,10 @@ export namespace serviceusage_v1 { * Metadata for the `UpdateConsumerPolicy` method. */ export interface Schema$UpdateConsumerPolicyMetadata {} + /** + * Metadata for the `UpdateContentSecurityPolicy` method. + */ + export interface Schema$UpdateContentSecurityPolicyMetadata {} /** * Metadata for the `UpdateMcpPolicy` method. */ @@ -2909,13 +2922,16 @@ export namespace serviceusage_v1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -3055,6 +3071,10 @@ export namespace serviceusage_v1 { * The standard list page token. */ pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Services { diff --git a/src/apis/serviceusage/v1beta1.ts b/src/apis/serviceusage/v1beta1.ts index 8323a2b838..1ca21379eb 100644 --- a/src/apis/serviceusage/v1beta1.ts +++ b/src/apis/serviceusage/v1beta1.ts @@ -694,6 +694,19 @@ export namespace serviceusage_v1beta1 { */ contentSecurityProviders?: Schema$ContentSecurityProvider[]; } + /** + * Content Security Policy contains the content security related policy of a resource. + */ + export interface Schema$ContentSecurityPolicy { + /** + * mcp_content_security contains the content security related settings at resource level for MCP traffic. + */ + mcpContentSecurity?: Schema$ContentSecurity; + /** + * Output only. The resource name of the policy. Only the `default` policy is supported. We allow the following formats: `projects/{PROJECT_NUMBER\}/contentSecurityPolicies/default`, `projects/{PROJECT_ID\}/contentSecurityPolicies/default`, We only support project level content security policy for now. + */ + name?: string | null; + } /** * ContentSecurityProvider contains the name of content security provider. */ @@ -1435,10 +1448,6 @@ export namespace serviceusage_v1beta1 { * Consumer Policy is a set of rules that define what services or service groups can be used for a cloud resource hierarchy. */ export interface Schema$GoogleApiServiceusageV2betaConsumerPolicy { - /** - * Optional. Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. [AIP-128](https://google.aip.dev/128#annotations) - */ - annotations?: {[key: string]: string} | null; /** * Output only. The time the policy was created. For singleton policies, this is the first touch of the policy. */ @@ -1757,6 +1766,10 @@ export namespace serviceusage_v1beta1 { * A list of operations that matches the specified filter in the request. */ operations?: Schema$Operation[]; + /** + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; } /** * Response message for the `ListServices` method. @@ -1852,10 +1865,6 @@ export namespace serviceusage_v1beta1 { * MCP Consumer Policy is a set of rules that define MCP related policy for a cloud resource hierarchy. */ export interface Schema$McpPolicy { - /** - * ContentSecurity contains the content security related fields of a MCP policy. - */ - contentSecurity?: Schema$ContentSecurity; /** * Output only. The time the policy was created. For singleton policies (such as the `default` policy), this is the first touch of the policy. */ @@ -2669,6 +2678,10 @@ export namespace serviceusage_v1beta1 { * Metadata for the `UpdateConsumerPolicy` method. */ export interface Schema$UpdateConsumerPolicyMetadata {} + /** + * Metadata for the `UpdateContentSecurityPolicy` method. + */ + export interface Schema$UpdateContentSecurityPolicyMetadata {} /** * Metadata for the `UpdateMcpPolicy` method. */ @@ -2896,13 +2909,16 @@ export namespace serviceusage_v1beta1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -3026,6 +3042,10 @@ export namespace serviceusage_v1beta1 { * The standard list page token. */ pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Services { diff --git a/src/apis/solar/v1.ts b/src/apis/solar/v1.ts index b57e830a6f..5041d0c9e4 100644 --- a/src/apis/solar/v1.ts +++ b/src/apis/solar/v1.ts @@ -681,6 +681,8 @@ export namespace solar_v1 { * * // Do the magic * const res = await solar.buildingInsights.findClosest({ + * // Optional. Whether to require exact quality of the imagery. If set to false, the `required_quality` field is interpreted as the minimum required quality, such that HIGH quality imagery may be returned when `required_quality` is set to MEDIUM. If set to true, `required_quality` is interpreted as the exact required quality and only `MEDIUM` quality imagery is returned if `required_quality` is set to `MEDIUM`. + * exactQualityRequired: 'placeholder-value', * // Optional. Specifies the pre-GA features to enable. * experiments: 'placeholder-value', * // The latitude in degrees. It must be in the range [-90.0, +90.0]. @@ -806,6 +808,10 @@ export namespace solar_v1 { export interface Params$Resource$Buildinginsights$Findclosest extends StandardParameters { + /** + * Optional. Whether to require exact quality of the imagery. If set to false, the `required_quality` field is interpreted as the minimum required quality, such that HIGH quality imagery may be returned when `required_quality` is set to MEDIUM. If set to true, `required_quality` is interpreted as the exact required quality and only `MEDIUM` quality imagery is returned if `required_quality` is set to `MEDIUM`. + */ + exactQualityRequired?: boolean; /** * Optional. Specifies the pre-GA features to enable. */ diff --git a/src/apis/sqladmin/v1.ts b/src/apis/sqladmin/v1.ts index c380e632bc..166b7ec03b 100644 --- a/src/apis/sqladmin/v1.ts +++ b/src/apis/sqladmin/v1.ts @@ -550,7 +550,7 @@ export namespace sqladmin_v1 { */ databaseNames?: string[] | null; /** - * Name of the Cloud SQL instance to be created as a clone. + * Required. Name of the Cloud SQL instance to be created as a clone. */ destinationInstanceName?: string | null; /** @@ -1512,7 +1512,7 @@ export namespace sqladmin_v1 { */ export interface Schema$InstancesCloneRequest { /** - * Contains details about the clone operation. + * Required. Contains details about the clone operation. */ cloneContext?: Schema$CloneContext; } @@ -2532,6 +2532,10 @@ export namespace sqladmin_v1 { * Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances. */ crashSafeReplicationEnabled?: boolean | null; + /** + * This parameter controls whether to allow using Data API to connect to the instance. Not allowed by default. + */ + dataApiAccess?: string | null; /** * The database flags passed to the instance at startup. */ @@ -7029,9 +7033,9 @@ export namespace sqladmin_v1 { * * // Do the magic * const res = await sql.instances.clone({ - * // The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID. + * // Required. The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID. * instance: 'placeholder-value', - * // Project ID of the source as well as the clone Cloud SQL instance. + * // Required. Project ID of the source as well as the clone Cloud SQL instance. * project: 'placeholder-value', * * // Request body metadata @@ -11976,11 +11980,11 @@ export namespace sqladmin_v1 { } export interface Params$Resource$Instances$Clone extends StandardParameters { /** - * The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID. + * Required. The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID. */ instance?: string; /** - * Project ID of the source as well as the clone Cloud SQL instance. + * Required. Project ID of the source as well as the clone Cloud SQL instance. */ project?: string; diff --git a/src/apis/sqladmin/v1beta4.ts b/src/apis/sqladmin/v1beta4.ts index 98bb56ef69..656f7b0663 100644 --- a/src/apis/sqladmin/v1beta4.ts +++ b/src/apis/sqladmin/v1beta4.ts @@ -2535,6 +2535,10 @@ export namespace sqladmin_v1beta4 { * Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances. */ crashSafeReplicationEnabled?: boolean | null; + /** + * This parameter controls whether to allow using Data API to connect to the instance. Not allowed by default. + */ + dataApiAccess?: string | null; /** * The database flags passed to the instance at startup. */ diff --git a/src/apis/storagebatchoperations/v1.ts b/src/apis/storagebatchoperations/v1.ts index d09e8bd0ca..da07ea8f8c 100644 --- a/src/apis/storagebatchoperations/v1.ts +++ b/src/apis/storagebatchoperations/v1.ts @@ -726,7 +726,7 @@ export namespace storagebatchoperations_v1 { * * // Do the magic * const res = await storagebatchoperations.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -855,7 +855,7 @@ export namespace storagebatchoperations_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/storagetransfer/v1.ts b/src/apis/storagetransfer/v1.ts index cae5b4a552..aba88ae557 100644 --- a/src/apis/storagetransfer/v1.ts +++ b/src/apis/storagetransfer/v1.ts @@ -297,7 +297,7 @@ export namespace storagetransfer_v1 { */ export interface Schema$Empty {} /** - * An entry describing an error that has occurred. + * LINT.IfChange An entry describing an error that has occurred. */ export interface Schema$ErrorLogEntry { /** @@ -429,6 +429,10 @@ export namespace storagetransfer_v1 { * A list of operations that matches the specified filter in the request. */ operations?: Schema$Operation[]; + /** + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; } /** * Response from ListTransferJobs. @@ -3281,13 +3285,16 @@ export namespace storagetransfer_v1 { * pageSize: 'placeholder-value', * // The list page token. * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -3702,6 +3709,10 @@ export namespace storagetransfer_v1 { * The list page token. */ pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export interface Params$Resource$Transferoperations$Pause extends StandardParameters { diff --git a/src/apis/vmmigration/v1.ts b/src/apis/vmmigration/v1.ts index fc4df2bed6..b26630a3df 100644 --- a/src/apis/vmmigration/v1.ts +++ b/src/apis/vmmigration/v1.ts @@ -3109,7 +3109,7 @@ export namespace vmmigration_v1 { * * // Do the magic * const res = await vmmigration.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -3237,7 +3237,7 @@ export namespace vmmigration_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/vmmigration/v1alpha1.ts b/src/apis/vmmigration/v1alpha1.ts index 0b924ec0f7..a396ba4878 100644 --- a/src/apis/vmmigration/v1alpha1.ts +++ b/src/apis/vmmigration/v1alpha1.ts @@ -3275,7 +3275,7 @@ export namespace vmmigration_v1alpha1 { * * // Do the magic * const res = await vmmigration.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -3403,7 +3403,7 @@ export namespace vmmigration_v1alpha1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** diff --git a/src/apis/vpcaccess/v1.ts b/src/apis/vpcaccess/v1.ts index 9ffbf91d5c..0194e9969d 100644 --- a/src/apis/vpcaccess/v1.ts +++ b/src/apis/vpcaccess/v1.ts @@ -211,6 +211,10 @@ export namespace vpcaccess_v1 { * A list of operations that matches the specified filter in the request. */ operations?: Schema$Operation[]; + /** + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; } /** * A resource that represents a Google Cloud location. @@ -410,7 +414,7 @@ export namespace vpcaccess_v1 { * * // Do the magic * const res = await vpcaccess.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -531,7 +535,7 @@ export namespace vpcaccess_v1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** @@ -1549,13 +1553,16 @@ export namespace vpcaccess_v1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -1682,5 +1689,9 @@ export namespace vpcaccess_v1 { * The standard list page token. */ pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } } diff --git a/src/apis/vpcaccess/v1beta1.ts b/src/apis/vpcaccess/v1beta1.ts index c98c08da1e..1af9a5ceda 100644 --- a/src/apis/vpcaccess/v1beta1.ts +++ b/src/apis/vpcaccess/v1beta1.ts @@ -219,6 +219,10 @@ export namespace vpcaccess_v1beta1 { * A list of operations that matches the specified filter in the request. */ operations?: Schema$Operation[]; + /** + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; } /** * A resource that represents a Google Cloud location. @@ -418,7 +422,7 @@ export namespace vpcaccess_v1beta1 { * * // Do the magic * const res = await vpcaccess.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', @@ -539,7 +543,7 @@ export namespace vpcaccess_v1beta1 { export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** @@ -1563,13 +1567,16 @@ export namespace vpcaccess_v1beta1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -1696,5 +1703,9 @@ export namespace vpcaccess_v1beta1 { * The standard list page token. */ pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } } diff --git a/src/apis/workflows/v1.ts b/src/apis/workflows/v1.ts index fff0785a3e..bd15f04637 100644 --- a/src/apis/workflows/v1.ts +++ b/src/apis/workflows/v1.ts @@ -153,6 +153,10 @@ export namespace workflows_v1 { * A list of operations that matches the specified filter in the request. */ operations?: Schema$Operation[]; + /** + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; } /** * Response for the ListWorkflowRevisions method. @@ -1025,13 +1029,16 @@ export namespace workflows_v1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -1165,6 +1172,10 @@ export namespace workflows_v1 { * The standard list page token. */ pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Workflows { diff --git a/src/apis/workflows/v1beta.ts b/src/apis/workflows/v1beta.ts index 5fb9b900b1..3bc805c97c 100644 --- a/src/apis/workflows/v1beta.ts +++ b/src/apis/workflows/v1beta.ts @@ -153,6 +153,10 @@ export namespace workflows_v1beta { * A list of operations that matches the specified filter in the request. */ operations?: Schema$Operation[]; + /** + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + */ + unreachable?: string[] | null; } /** * Response for the ListWorkflows method. @@ -963,13 +967,16 @@ export namespace workflows_v1beta { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -1103,6 +1110,10 @@ export namespace workflows_v1beta { * The standard list page token. */ pageToken?: string; + /** + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; } export class Resource$Projects$Locations$Workflows { diff --git a/src/index.ts b/src/index.ts index 936a7b1de1..e2a59922bf 100644 --- a/src/index.ts +++ b/src/index.ts @@ -121,6 +121,7 @@ export {chromemanagement_v1} from './apis/chromemanagement/v1'; export {chromepolicy_v1} from './apis/chromepolicy/v1'; export {chromeuxreport_v1} from './apis/chromeuxreport/v1'; export {chromewebstore_v1_1} from './apis/chromewebstore/v1.1'; +export {chromewebstore_v2} from './apis/chromewebstore/v2'; export {civicinfo_v2} from './apis/civicinfo/v2'; export {classroom_v1} from './apis/classroom/v1'; export {cloudasset_v1} from './apis/cloudasset/v1'; @@ -196,6 +197,7 @@ export {customsearch_v1} from './apis/customsearch/v1'; export {datacatalog_v1} from './apis/datacatalog/v1'; export {datacatalog_v1beta1} from './apis/datacatalog/v1beta1'; export {dataflow_v1b3} from './apis/dataflow/v1b3'; +export {dataform_v1} from './apis/dataform/v1'; export {dataform_v1beta1} from './apis/dataform/v1beta1'; export {datafusion_v1} from './apis/datafusion/v1'; export {datafusion_v1beta1} from './apis/datafusion/v1beta1';